Language API - Revision history

Mudrd8mz: Redirected page to String API

2015-10-16T08:37:01Z

Redirected page to String API

← Older revision		Revision as of 08:37, 16 October 2015
Line 1:		Line 1:
	~~TODO: describe class string_manager here and how to use it~~		#REDIRECT [[String API]]

	* See MDL-18776

	~~== See also ==~~

	* [[~~Places to search for lang strings~~]].

Mudrd8mz: Replacing page with 'TODO: describe class string_manager here and how to use it * See MDL-18776 == See also == * Places to search for lang strings.'

2009-04-07T18:31:46Z

Replacing page with 'TODO: describe class string_manager here and how to use it * See MDL-18776 == See also == * Places to search for lang strings.'

@@ Line 1: / Line 1: @@
-''This is a draft of a document that should define data structures and API to manipulate Moodle lang files.''
+TODO: describe class string_manager here and how to use it
-==Motivation==
+* See MDL-18776
 == See also ==
 *  [[Places to search for lang strings]].

Mudrd8mz: more intro info based on the talk page

2008-11-20T23:22:02Z

more intro info based on the talk page

← Older revision		Revision as of 23:22, 20 November 2008
Line 4:		Line 4:

	Moodle uses its own mechanism of translated strings and files storage. Other ways of handling localization files are sometimes requested. Some translators want to use gettext library (which is using .po files), some might want to export Moodle strings into custom format (eg. XML) to translate them with an external tool and import them back to Moodle. The Moodle Language API should enable to write additional plugins of strings and help files storage.		Moodle uses its own mechanism of translated strings and files storage. Other ways of handling localization files are sometimes requested. Some translators want to use gettext library (which is using .po files), some might want to export Moodle strings into custom format (eg. XML) to translate them with an external tool and import them back to Moodle. The Moodle Language API should enable to write additional plugins of strings and help files storage.

			This Language API should provide common interface for all future ''translation tools'' - it does not change the Moodle core itself. Current get_text() implementation is pretty well tuned, caching is supported and it is hopefully debugged. The work on this API started during the developement of several Moodle language tools - langchecker (searches for no-longer used strings in the English pack), langstats (translation progress monitor) and the new version of admin/lang.php interface.

	==Language pack URL==		==Language pack URL==

Mudrd8mz at 11:45, 18 November 2008

2008-11-18T11:45:45Z

@@ Line 1: / Line 1: @@
-''This is a draft of Language API proposal that should define data structures and API to manipulate Moodle lang files.''
+''This is a draft of a document that should define data structures and API to manipulate Moodle lang files.''
 [[Image:lang_api_classes.png|thumb|UML diagram of Language API classes]]
-From the conceptual point of view, the Language API consists of three hierarchical layers. These layers are abstracted as three object classes - see the attached UML diagram.
+The Language API is defined as interface. Every plugin must implement this interface. The internal plugin (representing traditional way) will be implemented first.
-; language_pack : This represents the whole pack with its own repository, maintainer etc. At the moment, it is implemented as a directory - e.g. $CFG->dirroot/lang/en_utf8 or $CFG->dataroot/lang/cs_utf8 etc. Other implementations should be possible in the future.
-* public '''$id''' - lang pack code, e.g. 'en_utf8'
+===Internal===
-* public '''$name''' - human readable pack name, e.g. 'English with my customizations'
-* public '''$location''' - where the lang pack is saved. Currently this will be the full path to the root directory. Might be some general URI format in the future, e.g. filesystem://path/to/the/directory or dbstorage://database.server/user/password or git://git.repository/lang etc.
+The internal plugin is defined as
-* public '''load_modules()''' - initializes all modules included in the language pack
-; language_module : represents a single module of a given pack, defines the sub-context of translated texts. At the moment, it is implemented as a file - e.g. moodle.php or qtype_multichoice.php. Other implementations should be possible in the future.
+The internal plugin will use sevaral classes:
-; language_string : represents a single unit of text (word, sentence or whole page) that can be translated and then used in the UI. At the moment, this is either one $string[] definition or a help file content.
 == See also ==
 *  [[Places to search for lang strings]].

Mudrd8mz: New page: ''This is a draft of Language API proposal that should define data structures and API to manipulate Moodle lang files.'' [[Image:lang_api_classes.png|thumb|UML diagram of Language API cla...

2008-11-17T16:46:01Z

New page: ''This is a draft of Language API proposal that should define data structures and API to manipulate Moodle lang files.'' [[Image:lang_api_classes.png|thumb|UML diagram of Language API cla...

New page

''This is a draft of Language API proposal that should define data structures and API to manipulate Moodle lang files.''

[[Image:lang_api_classes.png|thumb|UML diagram of Language API classes]]
From the conceptual point of view, the Language API consists of three hierarchical layers. These layers are abstracted as three object classes - see the attached UML diagram.
; language_pack : This represents the whole pack with its own repository, maintainer etc. At the moment, it is implemented as a directory - e.g. $CFG->dirroot/lang/en_utf8 or $CFG->dataroot/lang/cs_utf8 etc. Other implementations should be possible in the future.
* public '''$id''' - lang pack code, e.g. 'en_utf8'
* public '''$name''' - human readable pack name, e.g. 'English with my customizations'
* public '''$location''' - where the lang pack is saved. Currently this will be the full path to the root directory. Might be some general URI format in the future, e.g. filesystem://path/to/the/directory or dbstorage://database.server/user/password or git://git.repository/lang etc.
* public '''load_modules()''' - initializes all modules included in the language pack

; language_module : represents a single module of a given pack, defines the sub-context of translated texts. At the moment, it is implemented as a file - e.g. moodle.php or qtype_multichoice.php. Other implementations should be possible in the future.
; language_string : represents a single unit of text (word, sentence or whole page) that can be translated and then used in the UI. At the moment, this is either one $string[] definition or a help file content.

== See also ==
* [[Places to search for lang strings]].