Become a language pair developer for Apertium - Revision history

Daedalus at 17:46, 13 January 2020

2020-01-13T17:46:19Z

Daedalus: GitHub migration complete and 2 letter langauge codes replaced by 3 letter langauge codes.

2020-01-13T16:53:52Z

GitHub migration complete and 2 letter langauge codes replaced by 3 letter langauge codes.

Daedalus: Improved the language and changed all references to sourceforge and wrote links for GitHub instead

2020-01-12T18:00:49Z

Improved the language and changed all references to sourceforge and wrote links for GitHub instead

Sushain at 19:04, 22 January 2019

2019-01-22T19:04:59Z

TommiPirinen at 15:22, 15 March 2018

2018-03-15T15:22:52Z

Rcrowther: hack install instructions...

2017-04-27T16:45:10Z

hack install instructions...

TommiPirinen: /* Errors */ fixöimk IRC

2015-02-19T04:11:38Z

Errors: fixöimk IRC

Tunedal at 07:25, 16 February 2015

2015-02-16T07:25:47Z

Bech: Link to French page

2014-10-07T14:37:43Z

Link to French page

Ilnar.salimzyan: /* Changing Things Around */ s/make -j3/make/ (make -j3 doesn't work in all pairs)

2014-06-20T22:19:53Z

Changing Things Around: s/make -j3/make/ (make -j3 doesn't work in all pairs)

@@ Line 172: / Line 172: @@
 Remember to include a log message detailing what was changed or added.
+The  'git commit' command may be used multiple times, even when the system is offline.
+All the commits can then be pushed together online using:
+<pre>
+git push
+</pre>
+To see other people's changes, use the following command:
+<pre>
+git pull
+</pre>
 It is also possible that ''git commit'' may be followed by -m "message”. That is sometimes easier than having an editor opened automatically.

@@ Line 1: / Line 1: @@
 [[Devenir un développeur de paire de langues pour Apertium|En français]]
-{{TOCD}}
-{{Github-migration-check}}
 This is a step-by-step guide on how to use a development version of Apertium to make a change in a language pair.
@@ Line 8: / Line 6: @@
 You will need:
-* a text editor, preferably with good XML highlighting – see [[XML editors]] for some popular choices,
+* A text editor, preferably with good XML highlighting – see [[XML editors]] for some popular choices.
-* a thorough understanding of the languages you wish to develop for,
+* A thorough understanding of the languages you wish to develop.
-* an [[IRC]] client so you can ask for help when you get into trouble,
+* An [[IRC]] client so you can ask for help when you get into trouble.
 If you wish to contribute to the main repository, you will also have to ask for commit access on [https://github.com/apertium GitHub]
 == Getting Ready ==
-The first thing you need to do is install the Apertium core modules. The [[Installation]] page shows you how to do this.
+The first thing you need to do is to install the Apertium core modules. The [[Installation]] page shows you how to do this.
-The [[Install language data by compiling]] page shows how to install an example language pair, e.g. apertium-eo-enor apertium en-ca, both of which are known and stable. You should try this to make sure things work before you move on to whatever language pair you plan on working on.
+The [[Install language data by compiling]] page shows how to install an example language pair, e.g. apertium-spa-ita(Spanish to Italian) or apertium eng-cat(English to Catalan), both of which are known and stable. You should try this to make sure things work before you move on to whatever language pair you plan on working on.
-Note that some existing language pairs have external dependencies, like HFST or Constraint Grammar. The [[Installation]] page links to their installation procedures (If you are using packaging or a virtual environment, then they are either a one-click install, or pre-installed).
+Note that some existing language pairs have external dependencies, like HFST or Constraint Grammar. The [[Installation]] page demonstrates the installation procedures (If you are using packaging or a virtual environment, then they are either a one-click install, or pre-installed).
@@ Line 27: / Line 25: @@
 Using the same terminal, you can easily download and add the language pairs you want using a command like:
 <pre>
+git clone https://github.com/apertium/apertium-(Language code or pair).git
-svn checkout svn://svn.code.sf.net/p/apertium/svn/SVN_MODULE/PAIR_NAME
 </pre>
-Replace SVN_MODULE with the the name of the svn subdirectory where the chosen language pair is.
+Replace (Language code or pair) with the appropriate language code.
+For example, if you wanted to retrieve the language pair Spanish/English (which is in trunk) and French/Portuguese (which is in staging as of January 2020) you should type:
-Replace PAIR_NAME with the name of the chosen language pair.
-For example, if you wanted to retrieve the language pair Spanish/English (which is in trunk) and French/Portuguese (which was in staging as of June 2012) you should type:
 <pre>
-svn checkout svn://svn.code.sf.net/p/apertium/svn/trunk/apertium-en-es
+git clone https://github.com/apertium/apertium-spa-ita.git
-svn checkout svn://svn.code.sf.net/p/apertium/svn/staging/apertium-fr-pt
+git clone https://github.com/apertium/apertium-fra-por.git
 </pre>
-You can go to [[https://apertium.svn.sourceforge.net/svnroot/apertium/]] to see a list of SVN modules, clicking on each shows a list of language pairs. Language pairs are sorted into SVN modules based on how "complete" they are, where [[trunk]] is release-quality, [[staging]] is very close to release-quality, [[nursery]] is for stuff that's 1-3 months of concentrated work from release quality, and [[incubator]] is fragments and anything not complete enough to live in the other modules.
+You can go [https://github.com/apertium/apertium-all here] to see a list of modules, clicking on each shows a list of language pairs. Language pairs are sorted into modules based on how "complete" they are, where [[trunk]] is release-quality, [[staging]] is very close to release-quality, [[nursery]] is for stuff that's 1-3 months of concentrated work from release quality, and [[incubator]] is fragments and anything not complete enough to live in the other modules.
@@ Line 71: / Line 67: @@
 '''3.''' Add an entry to the dictionary for the second language that will be used.
-You will need to find the module you want to work with on your computer and open the three dictionaries; for example: apertium-es-ca.es.dix,
+You will need to find the module you want to work with on your computer and open the three dictionaries; for example: apertium-spa-cat.spa.dix,
-apertium-es-ca.es-ca.dix, and apertium-es-ca.ca.dix. ''Note: Each dictionary will have the suffix ".dix"'' You should open these files in a text editor or specialized XML editor.
+apertium-spa-cat.spa-cat.dix, and apertium-spa-cat.cat.dix. ''Note: Each dictionary will have the suffix ".dix"'' You should open these files in a text editor or specialized XML editor.
 === Step 1: Adding to the First Dictionary ===
@@ Line 91: / Line 87: @@
 </pre>
-Start by opening your first language's dictionary file. For example: apertium-en-es.es.dix (an XML file).
+Start by opening your first language's dictionary file. For example: apertium-eng-spa.spa.dix (an XML file).
 Then, create a new entry with the basic structure next to a similar entry in the dictionary. The order of entries doesn't matter.
@@ Line 109: / Line 105: @@
 Using the same structure, you can create the entry in your second language's dictionary that is the equivalent to your entry in the first dictionary.
-The second language dictionary file name should be something like ''apertium-en-es.en.dix''.
+The second language dictionary file name should be something like ''apertium-eng-spa.eng.dix''.
 Save your changes and recompile the module.
@@ Line 137: / Line 133: @@
 To know how a word is analysed by the translator and find an error, type the following in the terminal (example from [[Contributing_to_an_existing_pair#Detecting_errors|Contributing to an existing pair. Follow link for more help.]]):
 <pre>
-$ echo "gener" | apertium-destxt | lt-proc ca-es.automorf.bin
+$ echo "gener" | apertium-destxt | lt-proc cat-spa.automorf.bin
 </pre>
@@ Line 168: / Line 164: @@
 Now that you have added to a language pair you have the option to commit your changes to GitHub(We have now moved to GitHub). Committing a change to a language pair is even easier than making the change.
-Firstly, you need to register for a free GitHub account. Then, contact an Apertium administrator [https://github.com/orgs/apertium/people here] and request access to commit to SVN on GitHub.
+Firstly, you need to register for a free GitHub account. Then, contact an Apertium administrator [https://github.com/orgs/apertium/people here] and request access to commit to GitHub.
 Once granted access, simply open the terminal, navigate to your language pair that was changed, and enter:
 <pre>
-svn commit
+git commit
 </pre>
 Remember to include a log message detailing what was changed or added.
-It is also possible that ''svn commit'' may be followed by -m "message”. That is sometimes easier than having an editor opened automatically.
+It is also possible that ''git commit'' may be followed by -m "message”. That is sometimes easier than having an editor opened automatically.
 You have now become a language pair developer for Apertium!

@@ Line 12: / Line 12: @@
 * an [[IRC]] client so you can ask for help when you get into trouble,
-If you wish to contribute to the main repository, you will also have to ask for commit access on [http://sourceforge.net/projects/apertium/ SourceForge]
+If you wish to contribute to the main repository, you will also have to ask for commit access on [https://github.com/apertium GitHub]
 == Getting Ready ==
-The first thing you need to do is install the Apertium core modules. The page [[Installation]] shows how to do this, usually by packaging (non-Apple Unix based operating systems), or a virtual environment (Apple/Windows operating systems).
+The first thing you need to do is install the Apertium core modules. The [[Installation]] page shows you how to do this.
-The [[Install language data by compiling]] page shows how to install an example language pair, e.g. apertium-eo-enor apertium en-ca, both of which are known and stable. You should probably try this to make sure things work before you move on to whatever language pair you plan on working on.
+The [[Install language data by compiling]] page shows how to install an example language pair, e.g. apertium-eo-enor apertium en-ca, both of which are known and stable. You should try this to make sure things work before you move on to whatever language pair you plan on working on.
-Note that some existing language pairs have external dependencies, like HFST or Constraint Grammar. The [[Installation]] page links to their installation procedures (if using packaging or a virtual environment, they are either a one-click install, or pre-installed).
+Note that some existing language pairs have external dependencies, like HFST or Constraint Grammar. The [[Installation]] page links to their installation procedures (If you are using packaging or a virtual environment, then they are either a one-click install, or pre-installed).
@@ Line 30: / Line 30: @@
 </pre>
-In the area where it says SVN_MODULE, replace this with the the name of the svn subdirectory where the chosen language pair is.
+Replace SVN_MODULE with the the name of the svn subdirectory where the chosen language pair is.
-In the area where it says PAIR_NAME, replace this with the name of the chosen language pair.
+Replace PAIR_NAME with the name of the chosen language pair.
-For example, if you wanted to retrieve the language pair Spanish/English (which is in trunk) and French/Portuguese (which was in staging as of June 2012) you could type:
+For example, if you wanted to retrieve the language pair Spanish/English (which is in trunk) and French/Portuguese (which was in staging as of June 2012) you should type:
 <pre>
 svn checkout svn://svn.code.sf.net/p/apertium/svn/trunk/apertium-en-es
@@ Line 40: / Line 40: @@
 </pre>
-You can go to [https://apertium.svn.sourceforge.net/svnroot/apertium/] to see a list of SVN modules, clicking on each shows a list of language pairs. Language pairs are sorted into SVN modules based on how "complete" they are, where [[trunk]] is release-quality, [[staging]] is very close to release-quality, [[nursery]] is for stuff that's 1-3 months of concentrated work from release quality, and [[incubator]] is fragments and anything not complete enough to live in the other modules.
+You can go to [[https://apertium.svn.sourceforge.net/svnroot/apertium/]] to see a list of SVN modules, clicking on each shows a list of language pairs. Language pairs are sorted into SVN modules based on how "complete" they are, where [[trunk]] is release-quality, [[staging]] is very close to release-quality, [[nursery]] is for stuff that's 1-3 months of concentrated work from release quality, and [[incubator]] is fragments and anything not complete enough to live in the other modules.
@@ Line 54: / Line 54: @@
 </pre>
-for each language pair, replacing the text PAIR_NAME by the appropriate name.
+for each language pair, replace the text PAIR_NAME by the appropriate name.
 == Changing Things Around ==
@@ Line 109: / Line 109: @@
 Using the same structure, you can create the entry in your second language's dictionary that is the equivalent to your entry in the first dictionary.
-The second language dictionary file name should be something such as ''apertium-en-es.en.dix''.
+The second language dictionary file name should be something like ''apertium-en-es.en.dix''.
 Save your changes and recompile the module.
@@ Line 166: / Line 166: @@
 == Show it to the World ==
-Now that you have added to a language pair you have the option to commit your changes to SourceForge. Committing a change to a language pair is even easier than making the change.
+Now that you have added to a language pair you have the option to commit your changes to GitHub(We have now moved to GitHub). Committing a change to a language pair is even easier than making the change.
-Firstly, you need to register for a free SourceForge account. Then, contact an Apertium administrator [http://sourceforge.net/project/memberlist.php?group_id=143781 here] and request access to commit to SVN on SourceForge.
+Firstly, you need to register for a free GitHub account. Then, contact an Apertium administrator [https://github.com/orgs/apertium/people here] and request access to commit to SVN on GitHub.
 Once granted access, simply open the terminal, navigate to your language pair that was changed, and enter:

@@ Line 1: / Line 1: @@
 [[Devenir un développeur de paire de langues pour Apertium|En français]]
-This page is outdated with SVN stuff instead of git stuff!
 {{TOCD}}
+{{Github-migration-check}}
 This is a step-by-step guide on how to use a development version of Apertium to make a change in a language pair.

@@ Line 1: / Line 1: @@
 [[Devenir un développeur de paire de langues pour Apertium|En français]]
+This page is outdated with SVN stuff instead of git stuff!
 {{TOCD}}

@@ Line 135: / Line 135: @@
 It is very possible that you may encounter an error in you changes.
-To know how a word is analysed by the translator and find an error, type the following in the terminal (example from [http://wiki.apertium.orgContributing_to_an_existing_pair#Detecting_errors Contributing to an existing pair. Follow link for more help.]):
+To know how a word is analysed by the translator and find an error, type the following in the terminal (example from [[Contributing_to_an_existing_pair#Detecting_errors|Contributing to an existing pair. Follow link for more help.]]):
 <pre>
 $ echo "gener" | apertium-destxt | lt-proc ca-es.automorf.bin

@@ Line 20: / Line 20: @@
 Note that some existing language pairs have external dependencies, like HFST or Constraint Grammar, the [[Installation]] page links to their installation procedures. (Again, the Virtualbox has them preinstalled.)
@@ Line 179: / Line 180: @@
 You have now become a language pair developer for Apertium!
+==See also==
+*[[Building dictionaries]]
+*[[Contributing to an existing pair]]
+*[[Finding_errors_in_dictionaries]]
+*[[Apertium_New_Language_Pair_HOWTO]]
+*[[Cookbook]]
+*[[Chunking]]
 [[Category:Documentation in English]]
+[[Category:Documentation]]
+[[Category:HOWTO]]
+[[Category:Writing dictionaries]]
+[[Category:Quickstart]]

← Older revision		Revision as of 22:19, 20 June 2014
Line 57:		Line 57:
	When you want to make a change in Apertium, you more than likely want to add a word to an existing language pair. For a full explanation go to [[Contributing to an existing pair]]. You can also check out the [[Contact]] page for Apertium mailing lists and live help through IRC.		When you want to make a change in Apertium, you more than likely want to add a word to an existing language pair. For a full explanation go to [[Contributing to an existing pair]]. You can also check out the [[Contact]] page for Apertium mailing lists and live help through IRC.

	'''IMPORTANT: Adding a word won't do you any good if you don't recompile the modules after the change is made. Simply use the terminal like before and enter:''' ''make ~~-j3~~'' ''' and press the "Enter" key and your computer will create the new files necessary.'''		'''IMPORTANT: Adding a word won't do you any good if you don't recompile the modules after the change is made. Simply use the terminal like before and enter:''' ''make'' ''' and press the "Enter" key and your computer will create the new files necessary.'''