Internationalization/class structure - Revision history

Leo at 00:24, 16 August 2006

2006-08-16T00:24:23Z

← Older revision		Revision as of 00:24, 16 August 2006
Line 1:		Line 1:
	[[Category:Internationalization ~~SA project~~]]		[[Category:Internationalization]]

	''TODO: upload semesterproject UML diagam''		''TODO: upload semesterproject UML diagam''

Leo at 00:21, 16 August 2006

2006-08-16T00:21:12Z

← Older revision		Revision as of 00:21, 16 August 2006
Line 1:		Line 1:
	[[Category:Internationalization SA project]]		[[Category:Internationalization SA project]]

	~~== Class structure ==~~		''TODO: upload semesterproject UML diagam''

	~~[[Image~~:~~Internationalization-ClassDiagram.png\|Class Diagram]]~~


	~~== Class description ==~~

	~~{{Warning\|The information below is not up-to-date, revision coming soon.}}~~

	~~That~~'~~s the actual structure of the whole thing:~~


	~~SHARED_I18N_LOCALIZATOR => I18N_LOCALIZATOR => I18N_TEMPLATE_FORMATTER, (I18N_DATASTRUCTURE => I18N_MO_PARSER, I18N_PLURAL_FORMS)~~
	~~::^~~
	~~::\|~~
	~~CLASS_TO_LOCALIZE~~


	~~The CLASS_TO_LOCALIZE simply inherits from our SHARED_I18N_LOCALIZATOR, which only purpose is to return always the same "localizator: I18N_LOCALIZATOR".~~

	~~This class will in turn ask the archive for the translated strings and then pass it, along with all the arguments, to the template formatter, which will produce the final displayable string.~~

	The datastructure will use the mo_parser for the initial filling of the datastructure (proposal: do it incrementally); the plural forms resolver will be used to find out which plural form should be used.


	~~All this structure is already in place; we don~~'~~t know yet how to open the right file, should be implemented by an environment variable or for example with a drop-down menu in the configuration dialog?~~


	~~SHARED_I18N_LOCALIZATOR~~

	* translator: I18N_LOCALIZATOR
	* i18n(string): STRING
	* i18n_comp(string, args): STRING (or what you want)
	~~i18n (i18n_pl) and i18n_comp (i18n_comp_pl) are interfaces to the translator~~


	~~I18N_LOCALIZATOR~~
	* archive: I18N_DATASTRUCTURE
	* ask(string): STRING (simple interface to ask the archive)
	* solve_template(string, args): STRING (function that compose a string from template+arguments)


	~~I18N_DATASCTRUCTURE~~
	* mo_parser: I18N_MO_PARSER
	* load(n) (interface to the parser)
	* translate(STRING): STRING (interface to the I18N_LOCALIZATOR)
	* data_structure: HASH\|ARRAY (where the strings are effectively stored)


	~~I18N_MO_PARSER~~
	* open(file)
	* load(n): STRING
	* load_translated(n): STRING
	* load_hash_entry(n): STRING


	~~I18N_PLURAL_FORMS (more on this [[Internationalization/plural_forms\|here]])~~
	* get_plural_form(n): INTEGER (interface to the datastructure)


	~~I18N_TEMPLATE_FORMATTER~~
	* solve_template(a_template: STRING_32; a_args: TUPLE): STRING_32 (interface to the localizator)

Leo at 17:28, 15 August 2006

2006-08-15T17:28:39Z

← Older revision		Revision as of 17:28, 15 August 2006
Line 1:		Line 1:
	[[Category:Internationalization SA ~~Project~~]]		[[Category:Internationalization SA project]]

	== Class structure ==		== Class structure ==

Leo at 17:28, 15 August 2006

2006-08-15T17:28:21Z

← Older revision		Revision as of 17:28, 15 August 2006
Line 1:		Line 1:
	[[Category:Internationalization]]		[[Category:Internationalization SA Project]]

	== Class structure ==		== Class structure ==

Trosim: /* Class structure */

2006-06-16T11:41:42Z

Class structure

← Older revision		Revision as of 11:41, 16 June 2006
Line 3:		Line 3:
	== Class structure ==		== Class structure ==

	{{Warning\|~~We are refactoring the whole thing~~, ~~more infos~~ coming soon.}}		[[Image:Internationalization-ClassDiagram.png\|Class Diagram]]


			== Class description ==

			{{Warning\|The information below is not up-to-date, revision coming soon.}}

	That's the actual structure of the whole thing:		That's the actual structure of the whole thing:

Trosim: /* Class structure */

2006-06-14T21:43:56Z

Class structure

← Older revision		Revision as of 21:43, 14 June 2006
Line 2:		Line 2:

	== Class structure ==		== Class structure ==

			{{Warning\|We are refactoring the whole thing, more infos coming soon.}}

	That's the actual structure of the whole thing:		That's the actual structure of the whole thing:

Trosim: /* Class structure */

2006-06-06T20:18:08Z

Class structure

← Older revision		Revision as of 20:18, 6 June 2006
Line 50:		Line 50:


	I18N_PLURAL_FORMS		I18N_PLURAL_FORMS (more on this [[Internationalization/plural_forms\|here]])
	* get_plural_form(n): INTEGER (interface to the datastructure)		* get_plural_form(n): INTEGER (interface to the datastructure)

Trosim at 14:11, 6 June 2006

2006-06-06T14:11:49Z

← Older revision		Revision as of 14:11, 6 June 2006
Line 17:		Line 17:

	The datastructure will use the mo_parser for the initial filling of the datastructure (proposal: do it incrementally); the plural forms resolver will be used to find out which plural form should be used.		The datastructure will use the mo_parser for the initial filling of the datastructure (proposal: do it incrementally); the plural forms resolver will be used to find out which plural form should be used.


	All this structure is already in place; we don't know yet how to open the right file, should be implemented by an environment variable or for example with a drop-down menu in the configuration dialog?		All this structure is already in place; we don't know yet how to open the right file, should be implemented by an environment variable or for example with a drop-down menu in the configuration dialog?
Line 51:		Line 52:
	I18N_PLURAL_FORMS		I18N_PLURAL_FORMS
	* get_plural_form(n): INTEGER (interface to the datastructure)		* get_plural_form(n): INTEGER (interface to the datastructure)


	I18N_TEMPLATE_FORMATTER		I18N_TEMPLATE_FORMATTER
	* solve_template(a_template: STRING_32; a_args: TUPLE): STRING_32 (interface to the localizator)		* solve_template(a_template: STRING_32; a_args: TUPLE): STRING_32 (interface to the localizator)

Trosim: /* Class structure */ Added template formatter

2006-06-06T14:11:08Z

Class structure: Added template formatter

← Older revision		Revision as of 14:11, 6 June 2006
Line 3:		Line 3:
	== Class structure ==		== Class structure ==

	That's ~~a possible~~ structure of the whole thing:		That's the actual structure of the whole thing:


	SHARED_I18N_LOCALIZATOR => I18N_LOCALIZATOR => I18N_DATASTRUCTURE => I18N_MO_PARSER, I18N_PLURAL_FORMS		SHARED_I18N_LOCALIZATOR => I18N_LOCALIZATOR => I18N_TEMPLATE_FORMATTER, (I18N_DATASTRUCTURE => I18N_MO_PARSER, I18N_PLURAL_FORMS)
	::^		::^
	::\|		::\|
Line 14:		Line 14:
	The CLASS_TO_LOCALIZE simply inherits from our SHARED_I18N_LOCALIZATOR, which only purpose is to return always the same "localizator: I18N_LOCALIZATOR".		The CLASS_TO_LOCALIZE simply inherits from our SHARED_I18N_LOCALIZATOR, which only purpose is to return always the same "localizator: I18N_LOCALIZATOR".

	This class will in turn ask the archive for the translated strings, ~~and at~~ the ~~end~~ the ~~mo_parser~~ will ~~be used if~~ the string ~~is not already in memory (actually for the initial filling of the datastructure); the plural forms resolver will be used to find out which plural form should be used~~.		This class will in turn ask the archive for the translated strings and then pass it, along with all the arguments, to the template formatter, which will produce the final displayable string.

			The datastructure will use the mo_parser for the initial filling of the datastructure (proposal: do it incrementally); the plural forms resolver will be used to find out which plural form should be used.

	~~SHARED_I18N_LOCALIZATOR (~~already in place)		All this structure is already in place; we don't know yet how to open the right file, should be implemented by an environment variable or for example with a drop-down menu in the configuration dialog?


			SHARED_I18N_LOCALIZATOR

	* translator: I18N_LOCALIZATOR		* translator: I18N_LOCALIZATOR
Line 25:		Line 29:


	I18N_LOCALIZATOR ~~(skeleton already in place)~~		I18N_LOCALIZATOR
	* archive: I18N_DATASTRUCTURE		* archive: I18N_DATASTRUCTURE
	* ask(string): STRING (simple interface to ask the archive)		* ask(string): STRING (simple interface to ask the archive)
Line 31:		Line 35:


	I18N_DATASCTRUCTURE ~~(already in place)~~		I18N_DATASCTRUCTURE
	* mo_parser: I18N_MO_PARSER		* mo_parser: I18N_MO_PARSER
	* load(n) (interface to the parser)		* load(n) (interface to the parser)
Line 38:		Line 42:


	I18N_MO_PARSER ~~(already in place)~~		I18N_MO_PARSER
	* open(file)		* open(file)
	* load(n): STRING		* load(n): STRING
Line 45:		Line 49:


	I18N_PLURAL_FORMS ~~(already in place)~~		I18N_PLURAL_FORMS
	* get_plural_form(n): INTEGER		* get_plural_form(n): INTEGER (interface to the datastructure)

			I18N_TEMPLATE_FORMATTER
			* solve_template(a_template: STRING_32; a_args: TUPLE): STRING_32 (interface to the localizator)

Trosim at 17:01, 3 June 2006

2006-06-03T17:01:53Z

← Older revision		Revision as of 17:01, 3 June 2006
Line 20:		Line 20:

	* translator: I18N_LOCALIZATOR		* translator: I18N_LOCALIZATOR
	* t(string): STRING		* i18n(string): STRING
	* tn(string, args): STRING (or what you want)		* i18n_comp(string, args): STRING (or what you want)
			i18n (i18n_pl) and i18n_comp (i18n_comp_pl) are interfaces to the translator
	t and tn are interfaces to the translator