Development:Languages/AMOS - Revision history

Mudrd8mz: Text replacement - "class="nicetable"" to "class="wikitable""

2021-07-14T13:24:09Z

Text replacement - "class="nicetable"" to "class="wikitable""

← Older revision		Revision as of 13:24, 14 July 2021
Line 75:		Line 75:
	Contains all Moodle strings and their history		Contains all Moodle strings and their history

	{\| class="~~nicetable~~"		{\| class="wikitable"
	! Field		! Field
	! Type		! Type
Line 148:		Line 148:
	==== Keys ====		==== Keys ====

	{\| class="~~nicetable~~"		{\| class="wikitable"
	! Name		! Name
	! Type		! Type
Line 169:		Line 169:
	==== Indexes ====		==== Indexes ====

	{\| class="~~nicetable~~"		{\| class="wikitable"
	! Name		! Name
	! Type		! Type
Line 233:		Line 233:
	'''Beware:''' Every string is referenced as [stringid,component] '''but the component is different from what we use in get_string()'''. All components use fully normalized plugintype_pluginname syntax (see normalize_component() function in moodlelib). If plugintype === core and pluginname is empty (component 'core'), the strings are stored in moodle.php.		'''Beware:''' Every string is referenced as [stringid,component] '''but the component is different from what we use in get_string()'''. All components use fully normalized plugintype_pluginname syntax (see normalize_component() function in moodlelib). If plugintype === core and pluginname is empty (component 'core'), the strings are stored in moodle.php.

	{\| class="~~nicetable~~"		{\| class="wikitable"
	! String identification in get_string()		! String identification in get_string()
	! String identification in AMOS		! String identification in AMOS

Mudrd8mz: Project state set to Production

2010-12-21T17:47:30Z

Project state set to Production

← Older revision		Revision as of 17:47, 21 December 2010
Line 1:		Line 1:
	{{Infobox Project		{{Infobox Project
	\|name = Automated manipulation of strings		\|name = Automated manipulation of strings
	\|state = ~~Preview~~		\|state = Production
	\|tracker = MDL-18797		\|tracker = MDL-18797
	\|discussion = [http://moodle.org/mod/forum/discuss.php?d=118707#p542197]		\|discussion = [http://moodle.org/mod/forum/discuss.php?d=118707#p542197]

Mudrd8mz: Improved doc on AMOS script in commit messages

2010-05-18T07:14:53Z

Improved doc on AMOS script in commit messages

← Older revision		Revision as of 07:14, 18 May 2010
Line 204:		Line 204:
	AMOS uses its own git clone of Moodle repository. It runs 'git whatchanged' to see what files were affected by every single commit ever. Once it detects a change in a valid English string file, it checks out that revision of the file and compares its content with the current snapshot of the strings database. New record is added into the strings table for every new, modified or removed string in the checked out file. The commit hash of the last fully processed commit is stored in $CFG->dataroot/amos/var/MOODLE_xx.startat so that next time AMOS analyzes just new commits.		AMOS uses its own git clone of Moodle repository. It runs 'git whatchanged' to see what files were affected by every single commit ever. Once it detects a change in a valid English string file, it checks out that revision of the file and compares its content with the current snapshot of the strings database. New record is added into the strings table for every new, modified or removed string in the checked out file. The commit hash of the last fully processed commit is stored in $CFG->dataroot/amos/var/MOODLE_xx.startat so that next time AMOS analyzes just new commits.

	=== ~~Propagating changes in the English language pack into other languages~~ ===		=== AMOS script ===

	~~To be implemented yet~~		AMOS script allows us to propagate changes in the English language pack into other languages.

	Sometimes we want to reorganize the English language pack - for example split a component into subcomponents (as happened with auth.php), rename string identifiers, fork a string according the meaning (e.g. 'fullname' may be different when talking about a human and about a course) etc. Such a change can be easily done in English by direct editing and committing the lang/en/*.php files. But the translation would get lost and our poor translators would have to translate such strings again.		Sometimes we want to reorganize the English language pack - for example split a component into subcomponents (as happened with auth.php), rename string identifiers, fork a string according the meaning (e.g. 'fullname' may be different when talking about a human and about a course) etc. Such a change can be easily done in English by direct editing and committing the lang/en/*.php files. But the translation would get lost and our poor translators would have to translate such strings again.

	There is a way how to instruct AMOS to propagate a change in the English lang pack into all other languages at the given branch. We call that AMOS script (or amosbler for the syntax similarity with the assembly language - assembler). Such a script can be uploaded or pasted into a page at AMOS portal and it will just follow the instructions provided. Or - which is more interesting - such a script can be put directly into the commit message of the commit that does the change in the English language pack. In that case, AMOS will automatically run the script right after it process the commit.		There is a way how to instruct AMOS to propagate a change in the English lang pack into all other languages at the given branch. We call that AMOS script (or amosbler for the syntax similarity with the assembly language - assembler). Such a script can be uploaded or pasted into a page at AMOS portal and it will just follow the instructions provided. Or - which is more interesting - such a script can be put directly into the commit message of the commit that does the change in the English language pack. In that case, AMOS will automatically run the script right after it process the commit.

	~~=== AMOS script ===~~

	~~To be implemented yet~~

	Here is an example of a script that instruct AMOS to process a set of bulk operations over language packages:		Here is an example of a script that instruct AMOS to process a set of bulk operations over language packages:
Line 235:		Line 231:
	In human language, this roughly means: the script is a block of lines starting with 'AMOS BEGIN' or 'AMOS START' and ending with 'AMOS END' lines. Every instruction is on its own line. Instruction has its name (three capital letters like MOV, CPY, HLP, RPL, SMS or GRR) followed by comma-separated parameters.		In human language, this roughly means: the script is a block of lines starting with 'AMOS BEGIN' or 'AMOS START' and ending with 'AMOS END' lines. Every instruction is on its own line. Instruction has its name (three capital letters like MOV, CPY, HLP, RPL, SMS or GRR) followed by comma-separated parameters.

	Every string is referenced as [stringid,component] ~~with~~ the ~~similar meaning as~~ in get_string(). ~~Component uses the~~ plugintype_pluginname syntax. If plugintype === core and pluginname is empty (component 'core'), the strings are stored in moodle.php. ~~Examples:~~ [~~groupmode~~,~~core_group~~], [~~edit~~,~~core~~], [~~submission~~,~~mod_workshop~~]		'''Beware:''' Every string is referenced as [stringid,component] '''but the component is different from what we use in get_string()'''. All components use fully normalized plugintype_pluginname syntax (see normalize_component() function in moodlelib). If plugintype === core and pluginname is empty (component 'core'), the strings are stored in moodle.php.

			{\| class="nicetable"
			! String identification in get_string()
			! String identification in AMOS

			\|-
			\| get_string('edit', 'moodle')
			\| [edit,core]

			\|-
			\| get_string('submit', 'assignment')
			\| [submit,mod_assignment]

			\|-
			\| get_string('grade_help', 'grades')
			\| [grade_help,core_grades]

			\|-
			\| get_string('send', 'message')
			\| [send,core_message]

			\|-
			\| get_string('hello', 'block_greetings')
			\| [hello,block_greetings]

			\|}

	Currently planned/implemented AMOS script instructions are:		Currently planned/implemented AMOS script instructions are:
Line 244:		Line 266:
	; REM text : Allows to put a remark (comment), for example to describe a required operation that can't be achieved by current instruction set.		; REM text : Allows to put a remark (comment), for example to describe a required operation that can't be achieved by current instruction set.

	Ideas for other future instructions: RPL for replace (forced MOV), SMS for sending a message, GRR for something unknown yet but must be there.		Ideas for other future instructions: RPL for replace (forced MOV), SMS for sending a message, GRR for something unknown yet but such instruction just must be there ;-)

	Note there are no instructions DEL or ADD. AMOS automatically recognized new strings as well as their removal from the commit diffs.		Note there are no instructions DEL or ADD. AMOS automatically recognized new strings as well as their removal from the commit diffs.

			'''Summary of using AMOS script in commit messages:'''

			# The commit must modify some string file, AMOS would ignore the commit completely otherwise
			# The script must be properly formatted as block of lines
			# The strings must be identified in normalized syntax - the main difference is using core for moodle.php and core_* prefix for components in lang/en/*.php
			# Note that it may take up to an hour that your CVS commit is mirrored into git and then processed by AMOS

	=== Generating installer files ===		=== Generating installer files ===

Mudrd8mz: Added database structure

2010-05-11T00:00:32Z

Added database structure

@@ Line 65: / Line 65: @@
 ## packages are regenerated automatically as they are at the moment, with the only difference that the database and not CVS is used as their source
 # ''Contributors'' [must think about this yet] - their plugins in CONTRIB can be mirrored into git (one day this will happend anyway ;-)) and then AMOS can process them easily. Or we could add a feature that the contributor can upload the file with English strings definition manually and "register" the strings this way.
 == Features ==

Mudrd8mz: /* Deployment settings */

2010-05-04T09:18:48Z

Deployment settings

← Older revision		Revision as of 09:18, 4 May 2010
Line 141:		Line 141:
	PHP=/usr/bin/php		PHP=/usr/bin/php

	cd $AMOSREPOCORE && /usr/local/bin/git --quiet ~~pull~~		cd $AMOSREPOCORE && /usr/local/bin/git pull --quiet
	cd $AMOSREPOLANG && /usr/local/bin/git --quiet ~~pull~~		cd $AMOSREPOLANG && /usr/local/bin/git pull --quiet

	$PHP $AMOSCLIDIR/parse-core.php && $PHP $AMOSCLIDIR/parse-lang.php && $PHP $AMOSCLIDIR/rev-clean.php		$PHP $AMOSCLIDIR/parse-core.php && $PHP $AMOSCLIDIR/parse-lang.php && $PHP $AMOSCLIDIR/rev-clean.php

Mudrd8mz: /* AMOS script */

2010-05-03T20:09:00Z

AMOS script

← Older revision		Revision as of 20:09, 3 May 2010
Line 105:		Line 105:
	In human language, this roughly means: the script is a block of lines starting with 'AMOS BEGIN' or 'AMOS START' and ending with 'AMOS END' lines. Every instruction is on its own line. Instruction has its name (three capital letters like MOV, CPY, HLP, RPL, SMS or GRR) followed by comma-separated parameters.		In human language, this roughly means: the script is a block of lines starting with 'AMOS BEGIN' or 'AMOS START' and ending with 'AMOS END' lines. Every instruction is on its own line. Instruction has its name (three capital letters like MOV, CPY, HLP, RPL, SMS or GRR) followed by comma-separated parameters.

	Every string is referenced as [stringid,component] with the similar meaning as in get_string(). Component uses the plugintype_pluginname syntax. If plugintype === core and pluginname is empty (component 'core'), the strings are stored in moodle.php.		Every string is referenced as [stringid,component] with the similar meaning as in get_string(). Component uses the plugintype_pluginname syntax. If plugintype === core and pluginname is empty (component 'core'), the strings are stored in moodle.php. Examples: [groupmode,core_group], [edit,core], [submission,mod_workshop]

	Currently planned/implemented AMOS script instructions are:		Currently planned/implemented AMOS script instructions are:

Mudrd8mz: Just a backup of the environment scripts to keep AMOS up to date

2010-04-30T14:15:17Z

Just a backup of the environment scripts to keep AMOS up to date

@@ Line 1: / Line 1: @@
 {{Infobox Project
 |name = Automated manipulation of strings
-|state = In progress
+|state = Preview
 |tracker = MDL-18797
 |discussion = [http://moodle.org/mod/forum/discuss.php?d=118707#p542197]
@@ Line 123: / Line 123: @@
 See cli/export-installer.php.
 [[Category:Language]]

Mudrd8mz at 16:54, 11 April 2010

2010-04-11T16:54:14Z

← Older revision		Revision as of 16:54, 11 April 2010
Line 112:		Line 112:
	; CPY [source],[target] : Copy the string. Works as MOV but the source string is not touched.		; CPY [source],[target] : Copy the string. Works as MOV but the source string is not touched.
	; HLP component/helpfile.html,[string] : Convert legacy HTML help file to the string		; HLP component/helpfile.html,[string] : Convert legacy HTML help file to the string
			; REM text : Allows to put a remark (comment), for example to describe a required operation that can't be achieved by current instruction set.

	Ideas for other future instructions: RPL for replace (forced MOV), SMS for sending a message, GRR for something unknown yet but must be there.		Ideas for other future instructions: RPL for replace (forced MOV), SMS for sending a message, GRR for something unknown yet but must be there.

	Note there are no instructions DEL or ADD. AMOS automatically recognized new strings as well as their removal from the commit diffs.		Note there are no instructions DEL or ADD. AMOS automatically recognized new strings as well as their removal from the commit diffs.

			=== Generating installer files ===

			Implemented, not automated yet

			See cli/export-installer.php.

	[[Category:Language]]		[[Category:Language]]

Mudrd8mz: Dropping wildcard support from AMOS script, adding an alias for AMOS BEGIN

2010-04-11T16:49:58Z

Dropping wildcard support from AMOS script, adding an alias for AMOS BEGIN

← Older revision		Revision as of 16:49, 11 April 2010
Line 103:		Line 103:
	^[:blank:]AMOS END[:blank:]$		^[:blank:]AMOS END[:blank:]$

	In human language, this roughly means: the script is a block of lines starting with 'AMOS BEGIN' and ending with 'AMOS END' lines. Every instruction is on its own line. Instruction has its name (three capital letters like MOV, CPY, HLP, RPL, SMS or GRR) followed by comma-separated parameters.		In human language, this roughly means: the script is a block of lines starting with 'AMOS BEGIN' or 'AMOS START' and ending with 'AMOS END' lines. Every instruction is on its own line. Instruction has its name (three capital letters like MOV, CPY, HLP, RPL, SMS or GRR) followed by comma-separated parameters.

	Every string is referenced as [stringid,component] with the similar meaning as in get_string()~~. [*,component] represents all strings in the component~~. Component uses the plugintype_pluginname syntax. If plugintype === core and pluginname is empty (component 'core'), the strings are stored in moodle.php.		Every string is referenced as [stringid,component] with the similar meaning as in get_string(). Component uses the plugintype_pluginname syntax. If plugintype === core and pluginname is empty (component 'core'), the strings are stored in moodle.php.

	Currently planned/implemented AMOS script instructions are:		Currently planned/implemented AMOS script instructions are:

Mudrd8mz: /* AMOS script */ Frankenstyle used when referencing components

2010-04-10T20:25:11Z

AMOS script: Frankenstyle used when referencing components

← Older revision		Revision as of 20:25, 10 April 2010
Line 89:		Line 89:

	AMOS BEGIN		AMOS BEGIN
	MOV [description,~~workshop~~],[intro,~~workshop~~]		MOV [description,mod_workshop],[intro,mod_workshop]
	CPY [submission,~~assignment~~],[submission,~~workshop~~]		CPY [submission,mod_assignment],[submission,mod_workshop]
	HLP forum/forumtype.html,[forumtype_hlp,~~forum~~]		HLP forum/forumtype.html,[forumtype_hlp,mod_forum]
	AMOS END		AMOS END

Line 105:		Line 105:
	In human language, this roughly means: the script is a block of lines starting with 'AMOS BEGIN' and ending with 'AMOS END' lines. Every instruction is on its own line. Instruction has its name (three capital letters like MOV, CPY, HLP, RPL, SMS or GRR) followed by comma-separated parameters.		In human language, this roughly means: the script is a block of lines starting with 'AMOS BEGIN' and ending with 'AMOS END' lines. Every instruction is on its own line. Instruction has its name (three capital letters like MOV, CPY, HLP, RPL, SMS or GRR) followed by comma-separated parameters.

	Every string is referenced as [stringid,component] with the similar meaning as in get_string(). [*,component] represents all strings in the component.		Every string is referenced as [stringid,component] with the similar meaning as in get_string(). [*,component] represents all strings in the component. Component uses the plugintype_pluginname syntax. If plugintype === core and pluginname is empty (component 'core'), the strings are stored in moodle.php.

	Currently planned/implemented AMOS script instructions are:		Currently planned/implemented AMOS script instructions are: