Contributing to an existing pair - Revision history

Firespeaker: /* Consider contributing your improved lexical data */

2019-03-10T00:04:38Z

Consider contributing your improved lexical data

Francis Tyers: /* Consider contributing your improved lexical data */

2018-03-09T09:12:14Z

Consider contributing your improved lexical data

Shardulc at 04:52, 9 March 2018

2018-03-09T04:52:06Z

Shardulc: GitHub migration

2018-03-09T04:51:13Z

GitHub migration

Francis Tyers at 22:06, 7 March 2018

2018-03-07T22:06:31Z

Firespeaker: /* Adding structural transfer (grammar) rules */

2017-03-25T05:53:12Z

Adding structural transfer (grammar) rules

Firespeaker: /* Adding structural transfer (grammar) rules */

2017-03-25T05:37:19Z

Adding structural transfer (grammar) rules

SilentFlame at 10:22, 9 November 2016

2016-11-09T10:22:32Z

Unhammer: shouldn't this be upfront?

2015-09-24T13:03:15Z

shouldn't this be upfront?

Unhammer: /* Consider contributing your improved lexical data */

2015-09-24T13:01:57Z

Consider contributing your improved lexical data

@@ Line 12: / Line 12: @@
 == Consider contributing your improved lexical data ==
-If you have successfully added general-purpose lexical data to any of the Apertium language pairs, please consider contributing it to the project so that we can offer a better toolbox to the community. You can e-mail your data (typically three XML files, one for each monolingual dictionary and another one for the bilingual dictionary) to the maintainer of the language data, or to the public [[Contact|apertium-stuff mailing list]].
+If you have successfully added general-purpose lexical data to any of the Apertium language pairs, please consider contributing it to the project so that we can offer a better toolbox to the community.  The current preferred way of doing this is by pull request on GitHub.
+Alternatively, you can e-mail your data (typically three XML files, one for each monolingual dictionary and another one for the bilingual dictionary) to the maintainer of the language data, or to the public [[Contact|apertium-stuff mailing list]].
 The maintainer of a language pair is typically listed in one of the files in that pair, do
@@ Line 29: / Line 31: @@
 (For more details, see our page on [[repository permissions]]).
-You should be aware that the data you contribute to the project, once added, will be freely distributed under the current license (GNU General Public License 2+). Make sure the data you contribute is not affected by any kind of license which may be incompatible with the licenses used in this project. No kind of agreement or contract is created between you and the developers. If you have any doubt, or you plan to make a massive contribution, contact [[User:Mlforcada|Mikel L. Forcada]].
+You should be aware that the data you contribute to the project, once added, will be freely distributed under the current license (GNU General Public License 2+). Make sure the data you contribute is not affected by any kind of license which may be incompatible with the licenses used in this project.  No kind of agreement or contract is created between you and the developers.  If you have any doubt, or you plan to make a massive contribution, contact [[User:Mlforcada|Mikel L. Forcada]].
 ==Example file layout==

@@ Line 27: / Line 27: @@
 # Eventually, you can request write access for those repositories, or become a member of https://github.com/apertium.
+(For more details, see our page on [[repository permissions]]).
-(For more details, see [https://github.com/apertium/apertium-on-github/blob/master/perms-use-cases.md#proposed-github-permissions-model-use-cases this friendly documentation].
-<!--
-The addition of simple lexical contributions has recently been made simpler by means of web forms at http://xixona.dlsi.ua.es/prototype/webform/, so that contributors do not have to deal directly with XML.
--->
 You should be aware that the data you contribute to the project, once added, will be freely distributed under the current license (GNU General Public License 2+). Make sure the data you contribute is not affected by any kind of license which may be incompatible with the licenses used in this project. No kind of agreement or contract is created between you and the developers. If you have any doubt, or you plan to make a massive contribution, contact [[User:Mlforcada|Mikel L. Forcada]].

@@ Line 1: / Line 1: @@
 [[Comment contribuer à une paire de langues existante|En français]]
-{{Github-migration-check}}
 {{TOCD}}
 This is a guide on how to add linguistic data directly to an existing language pair in Apertium. It gets a bit technical – if you just want to notify us of some errors or pass along a word list, please see [[Contributing]]. If you get stuck while going through this guide, please get in touch on IRC or the mailing list (see [[Contact]] for how to do that).
@@ Line 7: / Line 6: @@
 Apertium has data for many languages pairs. These linguistic data include mainly dictionaries (monolingual and bilingual), structural transfer rules that perform grammatical and other transformations between the two languages involved, and lexical data for the part-of-speech tagger, which is in charge of the disambiguation of the source language text.
-For most older released language pairs (the ones in trunk/ in svn), all the linguistic data are contained in a single directory. For example, <code>apertium-es-ca</code> for the Spanish-Catalan pair. For newer language pairs, we separate out the monolingual data (analysers/generators/disambiguators) into individual modules, and keep only the bilingual data (lexical selection, bilingual transfer and transfer rules) in the "pair" directory.
+For most older released language pairs (the ones in 'trunk'), all the linguistic data are contained in a single directory. For example, <code>apertium-es-ca</code> for the Spanish-Catalan pair. For newer language pairs, we separate out the monolingual data (analysers/generators/disambiguators) into individual modules, and keep only the bilingual data (lexical selection, bilingual transfer and transfer rules) in the "pair" directory.
 It's also possible that only one side of the pair has been split out into a monolingual directory. When you type "./autogen.sh" in the pair directory, it should tell you if you need to use a monolingual package.

@@ Line 22: / Line 22: @@
+If you believe you are going to contribute more heavily to the project:
-If you believe you are going to contribute more heavily to the project, you can join the development team. Make an account at www.sourceforge.net if you don't already have one, subscribe to the mailing list and introduce yourself there (and preferably also on [[IRC]]). The usual way to contribute is to use SVN; as a project member, you will be able to commit your changes to dictionaries directly.
+# Join [[IRC]] and introduce yourself on the [[Mailing list|mailing list]]! Existing Apertium developers can guide you.
+# If you're new to git/GitHub, take a look at the resources on [[Using Git]].
+# Otherwise, create forks of the GitHub repositories you are developing, and submit pull requests.
+# Eventually, you can request write access for those repositories, or become a member of https://github.com/apertium.
+(For more details, see [https://github.com/apertium/apertium-on-github/blob/master/perms-use-cases.md#proposed-github-permissions-model-use-cases this friendly documentation].
 <!--

@@ Line 1: / Line 1: @@
 [[Comment contribuer à une paire de langues existante|En français]]
+{{Github-migration-check}}
 {{TOCD}}
 This is a guide on how to add linguistic data directly to an existing language pair in Apertium. It gets a bit technical – if you just want to notify us of some errors or pass along a word list, please see [[Contributing]]. If you get stuck while going through this guide, please get in touch on IRC or the mailing list (see [[Contact]] for how to do that).

@@ Line 565: / Line 565: @@
 * side: indicates if the lexical form is in the source language ("sl") or in the target language ("tl"). Of course, words are sent out always in the target language; source language lexical forms may be needed inside of a rule, when testing its attributes or characteristics.
 * part: indicates which part of the lexical form is referred to in the 'clip'. You can use some predefined values:
-                         -whole: the whole lexical form (lemma and grammatical symbols). Used only when sending out the lexical unit (inside an <out> element).
+** <code>whole</code>: the whole lexical form (lemma and grammatical symbols). Used only when sending out the lexical unit (inside an <out> element).
-                         -lem: the lemma of the lexical unit
+** <code>lem</code>: the lemma of the lexical unit
-                         -lemh: the head of the lemma of a multiword with inner inflection
+** <code>lemh</code>: the head of the lemma of a multiword with inner inflection
-                         -lemq: the queue of a lemma of a multiword with inner inflection
+** <code>lemq</code>: the queue of a lemma of a multiword with inner inflection
 As well as these predefined values, you can use any of the attributes defined in <section-def-attrs> (for example "gen" or "a_det").

@@ Line 481: / Line 481: @@
 The structural transfer module (generated from the structural transfer rules file) calls the lexical transfer module (generated from the bilingual dictionary) all through the process to determine the target language equivalents of the source language lexical forms.
-The structural transfer rules are contained in a XML file, one for each translation direction (for example, for the translation from Spanish to Catalan, the file is apertium-es-ca.trules-es-ca.xml). You need to edit this file if you want to add or change transfer rules.
+The structural transfer rules are contained in an XML file, one for each translation direction (for example, for the translation from Spanish to Catalan, the file is apertium-es-ca.trules-es-ca.xml). You need to edit this file if you want to add or change transfer rules.
 Rules have a pattern and an action part. The pattern specifies which sequences of lexical forms have to be detected and processed. The action describes the verifications and transformations that need to be done on its constituents. Usual transformation operations (such as gender and number agreement) are defined inside a macroinstruction which is called inside the rule. At the end of the action part of the rule, the resulting lexical forms in the target language are sent out so that they are processed by the next modules in the translation system.

@@ Line 710: / Line 710: @@
 <pre>
-$ echo "gener" | apertium-destxt | lt-proc ca-es.automorf.bin | apertium-tagger -g ca-es.prob | apertium-pretransfer | apertium-transfer trules-ca-es.xml trules-ca-es.bin ca-es.autobil.bin
+$ echo "gener" | apertium-destxt | lt-proc ca-es.automorf.bin | apertium-tagger -g ca-es.prob | apertium-pretransfer \
+| apertium-transfer trules-ca-es.xml trules-ca-es.bin ca-es.autobil.bin
 </pre>
@@ Line 726: / Line 727: @@
 <pre>
-$ echo "gener" | apertium-destxt | lt-proc ca-es.automorf.bin | apertium-tagger -g ca-es.prob | apertium-pretransfer | apertium-transfer trules-ca-es.xml trules-ca-es.bin ca-es.autobil.bin | lt-proc -g ca-es.autogen.bin
+$ echo "gener" | apertium-destxt | lt-proc ca-es.automorf.bin | apertium-tagger -g ca-es.prob | apertium-pretransfer \
+| apertium-transfer trules-ca-es.xml trules-ca-es.bin ca-es.autobil.bin | lt-proc -g ca-es.autogen.bin
 </pre>
@@ Line 741: / Line 743: @@
 It is not very usual to have errors due to the postgenerator, because of its generally small size and the fact that it is seldom changed after adding usual combinations, but you can also test how a source language text comes out of this module, by typing:
 <pre>
-$ echo "gener" | apertium-destxt | lt-proc ca-es.automorf.bin | apertium-tagger -g ca-es.prob | apertium-pretransfer | apertium-transfer trules-ca-es.xml trules-ca-es.bin ca-es.autobil.bin | lt-proc -g ca-es.autogen.bin | lt-proc -p ca-es.autopgen.bin
+$ echo "gener" | apertium-destxt | lt-proc ca-es.automorf.bin | apertium-tagger -g ca-es.prob | apertium-pretransfer \
+| apertium-transfer trules-ca-es.xml trules-ca-es.bin ca-es.autobil.bin | lt-proc -g ca-es.autogen.bin | lt-proc -p ca-es.autopgen.bin
 </pre>
@@ Line 749: / Line 752: @@
 <pre>
-$ echo "gener" | apertium-destxt | lt-proc ca-es.automorf.bin | apertium-tagger -g ca-es.prob | apertium-pretransfer | apertium-transfer trules-ca-es.xml trules-ca-es.bin ca-es.autobil.bin | lt-proc -g ca-es.autogen.bin | lt-proc -p ca-es.autopgen.bin | apertium-retxt
+$ echo "gener" | apertium-destxt | lt-proc ca-es.automorf.bin | apertium-tagger -g ca-es.prob | apertium-pretransfer \
+| apertium-transfer trules-ca-es.xml trules-ca-es.bin ca-es.autobil.bin | lt-proc -g ca-es.autogen.bin | lt-proc -p ca-es.autopgen.bin | apertium-retxt
 </pre>

@@ Line 466: / Line 466: @@
 </pre>
 to look for e-mail addresses. Alternatively, just send it to [[Contact|apertium-stuff]].
 If you believe you are going to contribute more heavily to the project, you can join the development team. Make an account at www.sourceforge.net if you don't already have one, subscribe to the mailing list and introduce yourself there (and preferably also on [[IRC]]). The usual way to contribute is to use SVN; as a project member, you will be able to commit your changes to dictionaries directly.