https://wiki.apertium.org/w/api.php?action=feedcontributions&user=Alessio&feedformat=atomApertium - User contributions [en]2024-03-28T18:26:22ZUser contributionsMediaWiki 1.34.1https://wiki.apertium.org/w/index.php?title=Ideas_for_Google_Summer_of_Code&diff=71117Ideas for Google Summer of Code2020-02-02T15:09:47Z<p>Alessio: /* List */</p>
<hr />
<div>{{TOCD}}<br />
This is the ideas page for [[Google Summer of Code]], here you can find ideas on interesting projects that would make Apertium more useful for people and improve or expand our functionality. If you have an idea please add it below, if you think you could mentor someone in a particular area, add your name to "Interested mentors" using <nowiki>~~~</nowiki> <br />
<br />
The page is intended as an overview of the kind of projects we have in mind. If one of them particularly piques your interest, please come and discuss with us on <code>#apertium</code> on <code>irc.freenode.net</code>, mail the [[Contact|mailing list]], or draw attention to yourself in some other way. <br />
<br />
Note that, if you have an idea that isn't mentioned here, we would be very interested to hear about it.<br />
<br />
Here are some more things you could look at:<br />
<br />
* [[Top tips for GSOC applications]] <br />
* Get in contact with one of our long-serving [[List of Apertium mentors|mentors]] &mdash; they are nice, honest!<br />
* Pages in the [[:Category:Development|development category]]<br />
* Resources that could be converted or expanded in the [[incubator]]. Consider doing or improving a language pair (see [[incubator]], [[nursery]] and [[staging]] for pairs that need work)<br />
* Unhammer's [[User:Unhammer/wishlist|wishlist]]<br />
* The open issues [https://github.com/search?q=org%3Aapertium&state=open&type=Issues on Github] (or [http://sourceforge.net/p/apertium/tickets/search/?q=!status%3Awont-fix+%26%26+!status%3Aclosed on Sourceforge]). The latter are probably out of date now since migrating to Github.<br />
<br />
__TOC__<br />
<br />
== List ==<br />
<br />
{{IdeaSummary<br />
| name = Anaphora resolution for machine translation<br />
| difficulty = hard<br />
| skills = C++, XML, Python<br />
| description = Write a program to resolve anaphora and include it in the Apertium translation pipeline.<br />
| rationale = Apertium has a problem with long distance dependencies in terms of agreement and co-reference. For example, deciding which determiner to use when translating from Spanish "su" to English "his, her, its". The objective of this task is to make a system to resolve anaphora and integrate it into a translation pipeline.<br />
| mentors = [[User:Francis Tyers|Francis Tyers]]<br />
| more = /Anaphora resolution<br />
}}<br />
<br />
<div style="background-color: #f9f9f9; border: 1px solid black; padding: 1ex; margin-bottom: 2ex;"><br />
<br />
=== <u>Bring a released language pair up to state-of-the-art quality</u> ===<br />
* '''Difficulty''':<br><span style="background-color: #cdefcd">2. Medium</span><br />
* '''Required skills''':<br>XML, a scripting language (Python, Perl), good knowledge of the language pair adopted.<br />
* '''Description''':<br>Take a released language pair, and drastically improve the performance both in terms of coverage, and in terms of translation quality. This will involve working with dictionaries, transfer rules, scripting, corpora. The objective is to make an Apertium language pair state-of-the-art, or close to state-of-the-art in terms of translation quality. This will involve improving coverage to 95-98% on a range of corpora and decreasing [[word error rate]] by 30-50%. For example if the current word error rate is 30%, then it should be reduced to 15-20%.<br />
* '''Rationale''':<br>Apertium has quite a broad coverage of language pairs, but few of these pairs offer state-of-the-art translation quality. We think broad is important, but deep coverage is important too.<br />
* '''Mentors''':<br>[[User:Francis Tyers|Francis Tyers]], [[User:Mlforcada|Mikel Forcada]], [[User:Xavivars|Xavi Ivars]], [[User:Ilnar.salimzyan|Ilnar Salimzianov]], [[User:Memduh|Memduh Gokirmak]]<br />
* '''[[/Make a language pair state-of-the-art|read more...]]'''<br />
</div><br />
<br />
<div style="background-color: #f9f9f9; border: 1px solid black; padding: 1ex; margin-bottom: 2ex;"><br />
<br />
=== <u>Robust tokenisation in lttoolbox</u> ===<br />
* '''Difficulty''':<br><span style="background-color: #cdefcd">2. Medium</span><br />
* '''Required skills''':<br>C++, XML, Python<br />
* '''Description''':<br>Improve the longest-match left-to-right tokenisation strategy in [[lttoolbox]] to be fully Unicode compliant.<br />
* '''Rationale''':<br>One of the most frustrating things about working with Apertium on texts "in the wild" is the way that the tokenisation works. If a letter is not specified in the alphabet, it is dealt with as whitespace, so e.g. you get unknown words split in two so you can end up with stuff like ^G$ö^k$ı^rmak$ which is terrible for further processing. <br />
* '''Mentors''':<br>[[User:Francis Tyers|Francis Tyers]], [[User:TommiPirinen|Flammie]]<br />
* '''[[/Robust tokenisation|read more...]]'''<br />
</div><br />
<br />
<div style="background-color: #f9f9f9; border: 1px solid black; padding: 1ex; margin-bottom: 2ex;"><br />
<br />
=== <u>Adopt an unreleased language pair</u> ===<br />
* '''Difficulty''':<br><span style="background-color: #cdcdef">3. Entry level</span><br />
* '''Required skills''':<br>XML, a scripting language (Python, Perl), good knowledge of the language pair adopted.<br />
* '''Description''':<br>Take on an orphaned unreleased language pair, and bring it up to release quality results. What this quality will be will depend on the language pair adopted, and will need to be discussed with the prospective mentor. This will involve writing linguistic data (including morphological rules and transfer rules &mdash; which are specified in a declarative language &mdash; and possibly [[Constraint Grammar]] rules if that is relevant)<br />
* '''Rationale''':<br>Apertium has a few pairs of languages (e.g. mt-he, ga-gd, ur-hi, pl-cs, sh-ru, etc...) that are orphaned, they don't have active maintainers. A lot of these pairs have a lot of work already put in, just need another few months to get them to release quality. See also [[Incubator]]<br />
* '''Mentors''':<br>[[User:Francis Tyers|Francis Tyers]], [[User:Jimregan|Jimregan]], [[User:Kevin Scannell|Kevin Scannell]], [[User:Trondtr|Trondtr]], [[User:Unhammer|Unhammer]], [[User:Darthxaher|Darthxaher]], [[User:Firespeaker|Firespeaker]], [[User:Hectoralos|Hectoralos]], [[User:Krvoje|Hrvoje Peradin]], [[User:Jacob Nordfalk|Jacob Nordfalk]], [[User:Mlforcada|Mikel Forcada]], [[User:Vin-ivar|Vinit Ravishankar]], [[User:Aida|Aida Sundetova]], [[User:Xavivars|Xavi Ivars]], [[User:Ilnar.salimzyan|Ilnar Salimzianov]], [[User:Sevilay bayatlı|Sevilay Bayatlı]], [[User:Memduh|Memduh Gokirmak]]<br />
* '''[[/Adopt a language pair|read more...]]'''<br />
</div><br />
<br />
<div style="background-color: #f9f9f9; border: 1px solid black; padding: 1ex; margin-bottom: 2ex;"><br />
<br />
=== <u>Extend lttoolbox to have the power of HFST</u> ===<br />
* '''Difficulty''':<br><span style="background-color: #efcdcd">1. Hard</span><br />
* '''Required skills''':<br>C++, XSLT, XML<br />
* '''Description''':<br>Extend lttoolbox (perhaps writing a preprocessor for it) so that it can be used to do the morphological transformations currently done with HFST. And yes, of course, writing something that translates the current HFST format to the new lttolbox format. Proof of concept: Come up with a new format that can express all of the features found in the Kazakh transducer; implement this format in Apertium; Implement the Kazakh transducer in this format and integrate it in the English--Kazakh pair.<br />
* '''Rationale''':<br>Some language pairs in Apertium use HFST where most language pairs use Apertium's own lttoolbox. This is due to the fact that writing morphologies for languages that have features such as the vowel harmony found in Turkic languages is very hard with the current format supported by lttoolbox. The mixture of HFST and lttoolbox makes it harder for people to develop some language pairs.<br />
* '''Mentors''':<br>[[User:Mlforcada|Mikel Forcada]], [[User:TommiPirinen|Tommi A Pirinen]], [[User:Unhammer]], mentors wanted<br />
* '''[[/Extend lttoolbox to have the power of HFST|read more...]]'''<br />
</div><br />
<br />
<!--<br />
<br />
DANGER TERROR HORROR !!!!!!<br />
<br />
The task above has subsumed these two<br />
<br />
<div style="background-color: #f9f9f9; border: 1px solid black; padding: 1ex; margin-bottom: 2ex;"><br />
=== <u>Flag diacritics in lttoolbox</u> ===<br />
* '''Difficulty''':<br><span style="background-color: #efcdcd">1. Hard</span><br />
* '''Required skills''':<br>C++ or Java, XML, Knowledge of FSTs<br />
* '''Description''':<br>Adapt [[lttoolbox]] to elegantly use flag diacritics. Flag diacritics are a way of avoiding transducer size blow-up by discarding impossible paths at runtime as opposed to compile time. Some work has already been done, see [[Flag diacritics]].<br />
* '''Rationale''':<br>This will involve designing some changes to our XML dictionary format (see [[lttoolbox]], and implementing the associated changes in the FST compiling processing code. The reason behind this is that many languages have prefix inflection, and we cannot currently deal with this without either making paradigms useless, or overanalysing (e.g. returning analyses where none exist). Flag diacritics (or constraints) would allow us to restrict overanalysis without blowing up the size of our dictionaries.<br />
* '''Mentors''':<br>[[User:Francis Tyers|Francis Tyers]] (C++), [[User:Jacob Nordfalk|Jacob Nordfalk]] (Java)<br />
* '''[[/Flag diacritics in lttoolbox|read more...]]'''<br />
</div><br />
<br />
<br />
<div style="background-color: #f9f9f9; border: 1px solid black; padding: 1ex; margin-bottom: 2ex;"><br />
=== <u>Weights in lttoolbox</u> ===<br />
* '''Difficulty''':<br><span style="background-color: #cdefcd">2. Medium</span><br />
* '''Required skills''':<br>C++, XML, FSTs<br />
* '''Description''':<br>[[lttoolbox]] is a set of tools for building finite-state transducers. As part of Apertium's long-term strategy we would like to include probabilistic information into more stages of the pipeline to allow generic tools to be optimised for machine translation. This task involves adding the possibility of weighting lexemes and analyses in our finite-state transducer toolbox.<br />
* '''Rationale''':<br>Weighting information for lexical forms will be useful for morphological disambiguation, and for work on [[spellchecking]].<br />
* '''Mentors''':<br>[[User:Francis Tyers|Francis Tyers]], [[User:TommiPirinen|Tommi Pirinen]]<br />
* '''[[/Add weights to lttoolbox|read more...]]'''<br />
</div><br />
--><br />
<br />
<br />
<div style="background-color: #f9f9f9; border: 1px solid black; padding: 1ex; margin-bottom: 2ex;"><br />
<br />
=== <u>Robust recursive transfer</u> ===<br />
* '''Difficulty''':<br><span style="background-color: #efcdcd">1. Hard</span><br />
* '''Required skills''':<br>Python, XML, linguistics<br />
* '''Description''':<br>The purpose of this task would be to create a module to replace the apertium-transfer module(s) which will parse and allow transfer operations on an input.<br />
* '''Rationale''':<br>Currently we have a problem with very distantly related languages that have long-distance constituent reordering, because we can only do finite-state chunking.<br />
* '''Mentors''':<br>[[User:Francis Tyers|Francis Tyers]], [[User:Sortiz|Sortiz]], [[User:Mlforcada|Mikel Forcada]], [[User:Japerez|Juan Antonio Pérez]]<br />
* '''[[/Robust recursive transfer|read more...]]'''<br />
</div><br />
<br />
<div style="background-color: #f9f9f9; border: 1px solid black; padding: 1ex; margin-bottom: 2ex;"><br />
=== <u>Extend weighted transfer rules</u> ===<br />
* '''Difficulty''':<br><span style="background-color: #efcdcd">1. Hard</span><br />
* '''Required skills''':<br>Python, C++, linguistics<br />
* '''Description''':<br>The purpose of this task is to extend weighted transfer rules to all transfer files and to allow conflicting rule patterns to be handled by combining (lexicalised) weights.<br />
* '''Rationale''':<br>Currently our transfer rules are applied longest-match left-to-right ([[LRLM]]). When two rule patterns conflict the first one is chosen. We have a prototype for selecting based on lexicalised weights, but it only applies to the first stage of transfer.<br />
* '''Mentors''':<br>[[User:Francis Tyers|Francis Tyers]], [[User:TommiPirinen|Tommi Pirinen]], [[User:Sevilay Bayatlı|Sevilay Bayatlı]], [[User:Memduh|Memduh Gokirmak]]<br />
* '''[[/Weighted transfer rules|read more...]]'''<br />
</div><br />
<br />
<div style="background-color: #f9f9f9; border: 1px solid black; padding: 1ex; margin-bottom: 2ex;"><br />
<br />
=== <u>Improvements to the Apertium website</u> ===<br />
* '''Difficulty''':<br><span style="background-color: #cdcdef">3. Entry level</span><br />
* '''Required skills''':<br>Python, HTML, JS<br />
* '''Description''':<br>Our web site is pretty cool already, but it's missing things like dictionary/synonym lookup, support for several variants of one language, reliability visualisation, (reliable) webpage translation, feedback, etc.<br />
* '''Rationale''':<br>[https://apertium.org https://apertium.org] / [http://beta.apertium.org http://beta.apertium.org] is what most people know us by, it should show off more of the things we are capable of :-)<br />
* '''Mentors''':<br>[[User:Firespeaker|Jonathan]], [[User:Sushain|Sushain]]<br />
* '''[[/Apertium website improvements|read more...]]'''<br />
</div><br />
<br />
<div style="background-color: #f9f9f9; border: 1px solid black; padding: 1ex; margin-bottom: 2ex;"><br />
<br />
=== <u>User-friendly lexical selection training</u> ===<br />
* '''Difficulty''':<br><span style="background-color: #cdefcd">2. Medium</span><br />
* '''Required skills''':<br>Python, C++, shell scripting<br />
* '''Description''':<br>Make it so that training/inference of lexical selection rules is a more user-friendly process<br />
* '''Rationale''':<br>Our lexical selection module allows for inferring rules from corpora and word alignments, but the procedure is currently a bit messy, with various scripts involved that require lots of manual tweaking, and many third party tools to be installed. The goal of this task is to make the procedure as user-friendly as possible, so that ideally only a simple config file would be needed, and a driver script would take care of the rest.<br />
* '''Mentors''':<br>[[User:Unhammer|Unhammer]], [[User:Mlforcada|Mikel Forcada]]<br />
* '''[[/User-friendly lexical selection training|read more...]]'''<br />
</div><br />
<br />
<div style="background-color: #f9f9f9; border: 1px solid black; padding: 1ex; margin-bottom: 2ex;"><br />
<br />
=== <u>Light alternative format for all XML files in an Apertium language pair</u> ===<br />
* '''Difficulty''':<br><span style="background-color: #efcdcd">1. Hard</span><br />
* '''Required skills''':<br>Python, C++, shell scripting, XSLT, flex<br />
* '''Description''':<br>Make it possible to edit and develop language data using a format that is lighter than XML<br />
* '''Rationale''':<br>In most Apertium language pairs, monolingual dictionaries, bilingual dictionaries, post-generation rule files and structural transfer rule files are all written in XML. While XML is easy to process due to explicit tagging of every element, it is tedious to deal with, particularly when it comes to structural transfer rules. Apertium's precursor, interNOSTRUM, had lighter text based formats. The task involves: (a) designing and documenting an interNOSTRUM-style format for all of the XML language data files in a language pair; (b) writing converters to XML and from XML that are fully roundtrip-compliant: (c) designing a way to synchronize changes when both the XML and the non-XML format are used simultaneously in a specific language pair.<br />
* '''Mentors''':<br>[[User:Mlforcada|Mikel Forcada]], [[User:Japerez|Juan Antonio Pérez]], pair.<br />
* '''[[/Plain-text_formats_for_Apertium_data|read more...]]'''<br />
</div><br />
<br />
<!--<div style="background-color: #f9f9f9; border: 1px solid black; padding: 1ex; margin-bottom: 2ex;"><br />
=== <u>Eliminate dictionary trimming</u> ===<br />
* '''Difficulty''':<br><span style="background-color: #ffbdbd">0. Very Hard</span><br />
* '''Required skills''':<br>C++, Finite-State Transducers<br />
* '''Description''':<br>Eliminate the need for trimming the monolingual dictionaries, in order to preserve and take advantage of maximal source language analysis.<br />
* '''Rationale''':<br>[[Why we trim]] mentions several technical reasons for why trimming away monolingual information is currently needed. Unfortunately, this limitation means that a lot of useful contextual information is lost. It would be ideal if the source language could be fully analyzed independent of target language, with any untranslated part fed back into the source language generator.<br />
* '''Mentors''':<br> [[User:TommiPirinen|Tommi Pirinen a.k.a. Flammie]]<br />
* '''Work around everything in [[Why we trim]]'''<br />
</div>--><br />
<br />
<div style="background-color: #f9f9f9; border: 1px solid black; padding: 1ex; margin-bottom: 2ex;"><br />
<br />
=== <u>Bilingual dictionary enrichment via graph completion</u> ===<br />
* '''Difficulty''':<br><span style="background-color: #ffbdbd">0. Very hard</span><br />
* '''Required skills''':<br>shell scripting, python, XSLT, XML<br />
* '''Description''':<br>Generate new entries for existing or new bilingual dictionaries using graphic representations of bilingual correspondences as found in all existing dictionaries (note that this idea defines a rather open-ended task to be discussed in detail with mentors).<br />
* '''Rationale''':<br>Apertium bilingual dictionaries establish correspondences between lexical forms in a number of language pairs. Connections among them may be used to infer new entries for existing or new language pairs using graphs. The graphs may be directly generated from Apertium bidixes and exploiting using [[Bilingual_dictionary_discovery|ideas that had already been proposed in Apertium]] or using existing [http://linguistic.linkeddata.es/apertium/ RDF representations] of parts of their content, which may benefit from the information coming from being linked to other resources.<br />
* '''Mentors''':<br>[[User:Mlforcada|Mikel Forcada]], [[User:Francis Tyers|Francis Tyers]], [[User:Jorge Gracia|Jorge Gracia]]<br />
* '''[[Bilingual_dictionary_discovery|read more...]]''' '''[[/Bilingual_dictionary_enrichment_via_graph_completion|read even more...]]'''<br />
</div><br />
<br />
<!--<div style="background-color: #f9f9f9; border: 1px solid black; padding: 1ex; margin-bottom: 2ex;"><br />
<br />
=== <u>Transfer rule induction from comparable parsed corpora</u> ===<br />
* '''Difficulty''':<br><span style="background-color: #ffbdbd">1. Hard</span><br />
* '''Required skills''':<br>shell scripting, python, XSLT, XML<br />
* '''Description''':<br>A system to infer transfer rules from comparable corpora that have both been deeply parsed (with e.g. CG)<br />
* '''Rationale''':<br>Many languages have good CG's and fairly large monolingual corpora, but little parallel material. Given a small bidix, fairly large monolingual corpora and good analysers/CG's, we should be able to parse both corpora, translate lemmas and look for similar sentences, turning the differences in their parses into transfer rules. <br />
* '''Mentors''':<br>[[User:Unhammer]]<br />
* '''[[Transfer_induction_from_comparable_parsed_corpora|read more...]]''' <br />
</div>--><br />
<br />
<div style="background-color: #f9f9f9; border: 1px solid black; padding: 1ex; margin-bottom: 2ex;"><br />
<br />
=== <u>UD and Apertium integration</u> ===<br />
* '''Difficulty''':<br><span style="background-color: #cdcdef">3. Entry level</span><br />
* '''Required skills''':<br>python, javascript, HTML, (C++)<br />
* '''Description''':<br>Create a range of tools for making Apertium compatible with Universal Dependencies<br />
* '''Rationale''':<br>Universal dependencies is a fast growing project aimed at creating a unified annotation scheme for treebanks. This includes both part-of-speech and morphological features. Their annotated corpora could be extremely useful for Apertium for training models for translation. In addition, Apertium's rule-based morphological descriptions could be useful for software that relies on Universal dependencies.<br />
* '''Mentors''':<br>[[User:Francis Tyers]] [[User:Firespeaker]], [[User:Memduh|Memduh Gokirmak]]<br />
* '''[[/UD and Apertium integration|read more...]]''' <br />
</div><br />
<br />
<div style="background-color: #f9f9f9; border: 1px solid black; padding: 1ex; margin-bottom: 2ex;"><br />
<br />
=== <u>Add weights to lttoolbox</u> ===<br />
* '''Difficulty''':<br><span style="background-color: #ffbdbd">1. Hard</span><br />
* '''Required skills''':<br>c++<br />
* '''Description''':<br>Add support for weighted transducers to lttoolbox<br />
* '''Rationale''':<br>This will either involve implementing it from scratch or adding OpenFST as a backend. We would like to be able to use it both in the bilingual dictionaries, and in the morphological analysers, to be able to order analyses/translations by their probability/weight instead of by the random topological order. <br />
* '''Mentors''':<br>[[User:Francis Tyers]] [[User:Unhammer]]<br />
* '''[[/Add weights to lttoolbox|read more...]]''' <br />
</div><br />
<br />
<div style="background-color: #f9f9f9; border: 1px solid black; padding: 1ex; margin-bottom: 2ex;"><br />
<br />
=== <u>Improving language pairs mining Mediawiki Content Translation postedits</u> ===<br />
* '''Difficulty''':<br><span style="background-color: #ffbdbd">1. Hard</span><br />
* '''Required skills''':<br>Python, shell scripting, some statistics<br />
* '''Description''':<br>Implement a toolkit that allows mining existing machine translation postediting data in [Mediawiki Content Translation https://www.mediawiki.org/wiki/Content_translation] to generate (as automatically as possible, and as complete as possible) monodix and bidix entries to improve the performance of an Apertium language pair. Data is available from Wikimedia content translation through an [API https://www.mediawiki.org/wiki/Content_translation/Published_translations#API] or in the form of [Dumps https://dumps.wikimedia.org/other/contenttranslation/] available in JSON and TMX format. This project is rather experimental and involves some research in addition to coding.<br />
* '''Rationale''':<br>Apertium is used to generate new Wikipedia content: machine-translated content is postedited (and perhaps adapted) before publishing. Postediting information may contain information that can be used to help improve the lexical components of an Apertium language pair. <br />
* '''Mentors''':<br> [[User:Mlforcada|Mikel Forcada]], (more mentors to be added)<br />
* '''[[/automatic-postediting|read more...]]''' <br />
</div><br />
<br />
<br />
<div style="background-color: #f9f9f9; border: 1px solid black; padding: 1ex; margin-bottom: 2ex;"><br />
<br />
=== <u>Unsupervised weighting of automata</u> ===<br />
* '''Difficulty''':<br><span style="background-color: #cdefcd">2. Medium</span><br />
* '''Required skills''':<br>Python, shell scripting, statistics, finite-state transducers<br />
* '''Description''':<br>Implement a collection of methods for weighting finite-state transducers, the methods should include an implementation of a simple method of supervised training, and a number of methods for unsupervised training. The objective being to get the analysis ranking given a set of a analyses for a given surface form as close to the result given by supervised training as possible.<br />
* '''Rationale''':<br>Apertium struggles with ambiguity, we have had many attempts to write better part of speech taggers. This would complement those attempts by providing a generic method to weight automata.<br />
* '''Mentors''':<br> [[User:Francis Tyers|Francis Tyers]], [[User:TommiPirinen|Flammie]], [[User:Unhammer|Unhammer]]<br />
* '''[[/Unsupervised weighting of automata|read more...]]'''<br />
</div><br />
<br />
<div style="background-color: #f9f9f9; border: 1px solid black; padding: 1ex; margin-bottom: 2ex;"><br />
=== <u>Improvements to UD Annotatrix</u> ===<br />
* '''Difficulty''':<br><span style="background-color: #cdefcd">2. Medium</span><br />
* '''Required skills''':<br>JavaScript, Jquery, HTML, Python<br />
* '''Description''':<br>UD Annotatrix is an interface by Apertium for annotating dependency trees in CoNLL-U format. The system is currently in beta, but is getting traction as more people start using it.<br />
* '''Rationale''':<br>Universal Dependencies is a very widely used standard for annotating data, the kind of annotated data that can be used to train part of speech taggers. There is still a lot of work that could be done to improve it.<br />
* '''Mentors''':<br> [[User:Francis Tyers|Francis Tyers]], [[User:Firespeaker]]<br />
* '''[[/UD Annotatrix|read more...]]'''<br />
</div><br />
<br />
<div style="background-color: #f9f9f9; border: 1px solid black; padding: 1ex; margin-bottom: 2ex;"><br />
=== <u>apertium-separable language-pair integration</u> ===<br />
* '''Difficulty''':<br><span style="background-color: #cdefcd">2. Medium</span><br />
* '''Required skills''':<br>XML, a scripting language (Python, Perl), some knowledge of linguistics and/or at least one relevant natural language<br />
* '''Description''':<br>Choose a language you can identify as having a good number of "multiwords" in the lexicon. Modify all language pairs in Apertium to use the [[Apertium-separable]] module to process the multiwords, and clean up the dictionaries accordingly.<br />
* '''Rationale''':<br>Apertium-separable is a newly developed module to process lexical items with discontinguous dependencies, an area where Apertium has traditionally fallen short. Despite all the module has to offer, it has only been put to use in small test cases, and hasn't been integrated into any translation pair's development cycle.<br />
* '''Mentors''':<br> [[User:Francis Tyers|Francis Tyers]], [[User:Firespeaker]]<br />
* '''[[/Apertium separable|read more...]]'''<br />
</div><br />
<br />
{{IdeaSummary<br />
| name = Create FST-based module for disambiguating<br />
| difficulty = medium<br />
| skills = XML, a scripting language (Python, Perl), C++, finite-state transducers<br />
| description = Implement a [[Constraint Grammar]]-like module based on finite-state transducers.<br />
| rationale = Currently, many language pairs use [[Constraint grammar]] as a pre-disambiguator for the Apertium tagger, allowing the imposition of more fine grained constraints than would be otherwise possible. However, current implementation of CG is much slower than most of the other modules in the Apertium pipeline, and it's also very different in terms of syntax to other Apertium modules (dictionaries, lexical selection, transfer rules, etc). There have been a few attempts to create FST versions of CG (see [[User:David_Nemeskey/GSOC_progress_2013]]), but they haven't succeeded. The hypothesis is that a simpler version of CG that supports the main features that CG support (no need to feature parity) would have better adoption and integration within the Apertium pipeline.<br />
| mentors = [[User:Xavivars|Xavi Ivars]], [[User:Francis Tyers|Francis Tyers]]<br />
| more = /Apertium FST GC<br />
}}<br />
<br />
{{IdeaSummary<br />
| name = Python API/library for Apertium<br />
| difficulty = medium<br />
| skills = Python, C++, SWIG<br />
| description = Implement a Python library for Apertium and Lttoolbox.<br />
| rationale = Lots of people use Python, they like to use it in their Jupyter notebooks and on Microsoft Windows™. Apertium is really hard to get going in these kind of environments. So it would be cool if we could make Apertium work for them too. It has a lot of nice language processing tools that we would like more people to use. I'm sure people would love to "pip install apertium" or "pip install apertium-ava". The API/implementation should be pythonistic and should use C++ bindings to directly perform morphological functions, avoiding the overhead of a separate process. Prior GSoC project work is available on [https://github.com/apertium/apertium-python GitHub].<br />
| mentors = [[User:Sushain|Sushain]], [[User:Francis Tyers|Francis Tyers]], [[User:Unhammer|Unhammer]], [[User:Xavivars|Xavi Ivars]], [[User:Memduh|Memduh Gokirmak]]<br />
| more = /Python library<br />
}}<br />
<br />
{{IdeaSummary<br />
| name = TIPP functionality for Apertium<br />
| difficulty = medium<br />
| skills = Python, C++, XML, XLIFF (a subset called XLIFF:doc)<br />
| description = TIPP, the TMS Interoperability Protocol Package (where TMS means translation management system), [https://github.com/tingley/interoperability-now/blob/master/releases/tipp/1.5/The_TMS_Interoperability_Protocol_Package-1.5.pdf], currently in version 1.5 but being upgraded to 2.0, specifies a container (package format) that allows the interchange of information along a translation value chain. There are various container varieties for different tasks. One such variety, called Translate-Strict-Bitext, represents a bilingual translation job. The 'request' TIPP would contain an XLIFF:doc ([https://github.com/tingley/interoperability-now/tree/master/releases/xliffdoc/1.0.1], a subset of XLIFF 1 [http://docs.oasis-open.org/xliff/v1.2/os/xliff-core.html]) file with the document to be translated and the corresponding metadata, and the corresponding 'response' TIPP would contain the results of Apertium MT applied to it, but taking into account the translation memory provided in the TIPP, if any (using Apertium's -m switch). Apertium should be endowed with the capacity to manage TIPP packages: unpack the request package, parse it, process it, and repack it.<br />
| mentors = [[User:Mlforcada|Mikel Forcada]]<br />
| more = /Apertium_TIPP<br />
}}<br />
<br />
<br />
{{IdeaSummary<br />
| name = Bring Apertium Occitan--French closer to posteditable quality.<br />
| difficulty = medium<br />
| skills = GNU/Linux advanced user, bash, git, XML editing, standard Occitan, French.<br />
| description = The idea is to make Occitan output easier to postedit and French output easier to understand. This entails increasing the monolingual and bilingual dictionaries, improving disambiguation, and writing new structural transfer rules.<br />
| rationale = The [https://github.com/apertium/apertium-oci-fra Occitan--French language pair] has been recently published. This language pair is of strategic importance for the Occitan language, as Apertium offers the only machine translation system for this language pair. <br />
| mentors = [[User:Mlforcada|Mikel Forcada]], [[User:Memduh|Memduh Gokirmak]], mentors welcome.<br />
| more = /Apertium_Occitan_French<br />
}}<br />
<br />
<br />
<br />
<br />
{{IdeaSummary<br />
| name = Create a usable version of one of these language pairs: English--Igbo, English--Yoruba, English--Tigrinya, English--Swahili, English-Hausa<br />
| difficulty = medium<br />
| skills = GNU/Linux advanced user, bash, git, XML editing, English, Igbo/Yoruba/Tigrinya/Swahili/Hausa<br />
| description = The objective is to start these language pairs (which haven't been started or have currentlu very little data in Apertium) and write an usable version which provides intelligible output.<br />
| rationale = African languages are not particularly well served by Apertium. The four languages listed are quite important, and are only currently served by commercial machine translation companies such as Google, which makes these language communities dependent on a specific commercial provider.<br />
| mentors = [[User:Mlforcada|Mikel Forcada]], [[User:Memduh|Memduh Gokirmak]], mentors welcome.<br />
| more = /Apertium_African<br />
}}<br />
<br />
{{IdeaSummary<br />
| name = Set up gap-filling machine-translation-for-gisting evaluation on a recent version of Appraise<br />
| difficulty = hard<br />
| skills = python, bash, git, XML editing.<br />
| description = [http://github.com/mlforcada/Appraise http://github.com/mlforcada/Appraise], in turn forked from [http://github.com/mlforcada/Appraise http://github.com/mlforcada/Appraise], the work of a GSoC student, contains an adaptation of an old (2014) version of [http://github.com/cfedermann/Appraise http://github.com/cfedermann/Appraise] to implement gap-filling evaluation as described in [https://export.arxiv.org/pdf/1809.00315 this WMT2018 paper]. The objective is to bring the gap-filling functionality in [http://github.com/mlforcada/Appraise] to be compatible with the latest versions of Appraise.<br />
| rationale = Many language pairs in Apertium are unique, such as Breton-French, and many of them are used for gisting (understanding) purposes. Gap-filling provides a simple way to evaluate the usefulness of machine translation for gisting. The implementation used in recent experiments is based on an outdated version of the Appraise platform. <br />
| mentors = [[User:Mlforcada|Mikel Forcada]], mentors welcome.<br />
| more = /Appraise_gisting<br />
}}<br />
<br />
{{IdeaSummary<br />
| name = A Web Interface to expanding dictionary lemmas integrate with GitLab/GitHub<br />
| difficulty = hard<br />
| skills = java, git, XML, nodeJs, Angular 8.<br />
| description = Given that Apertium has a few dozen contributors and thousands of users, we propose a web graphical user interface (GUI) that enables the lay users to contribute to the expansion of the dictionaries that makeup the knowledge base of Apertium. <br />
The main premise of the solution is that users with minimal knowledge of thelanguage can contribute easily and that it must be integrated with the currentform of development of expert users.<br />
| rationale = . <br />
| mentors = [[User:Alessio|Aléssio Jr.]], mentors welcome.<br />
| more = /Easy_dictionary_maintenance, https://web-dix-maintenance.appspot.com/<br />
}}<br />
<br />
<br />
<br />
[[Category:Development]]<br />
[[Category:Google Summer of Code]]</div>Alessiohttps://wiki.apertium.org/w/index.php?title=Ideas_for_Google_Summer_of_Code&diff=71116Ideas for Google Summer of Code2020-02-02T14:50:22Z<p>Alessio: /* List */</p>
<hr />
<div>{{TOCD}}<br />
This is the ideas page for [[Google Summer of Code]], here you can find ideas on interesting projects that would make Apertium more useful for people and improve or expand our functionality. If you have an idea please add it below, if you think you could mentor someone in a particular area, add your name to "Interested mentors" using <nowiki>~~~</nowiki> <br />
<br />
The page is intended as an overview of the kind of projects we have in mind. If one of them particularly piques your interest, please come and discuss with us on <code>#apertium</code> on <code>irc.freenode.net</code>, mail the [[Contact|mailing list]], or draw attention to yourself in some other way. <br />
<br />
Note that, if you have an idea that isn't mentioned here, we would be very interested to hear about it.<br />
<br />
Here are some more things you could look at:<br />
<br />
* [[Top tips for GSOC applications]] <br />
* Get in contact with one of our long-serving [[List of Apertium mentors|mentors]] &mdash; they are nice, honest!<br />
* Pages in the [[:Category:Development|development category]]<br />
* Resources that could be converted or expanded in the [[incubator]]. Consider doing or improving a language pair (see [[incubator]], [[nursery]] and [[staging]] for pairs that need work)<br />
* Unhammer's [[User:Unhammer/wishlist|wishlist]]<br />
* The open issues [https://github.com/search?q=org%3Aapertium&state=open&type=Issues on Github] (or [http://sourceforge.net/p/apertium/tickets/search/?q=!status%3Awont-fix+%26%26+!status%3Aclosed on Sourceforge]). The latter are probably out of date now since migrating to Github.<br />
<br />
__TOC__<br />
<br />
== List ==<br />
<br />
{{IdeaSummary<br />
| name = Anaphora resolution for machine translation<br />
| difficulty = hard<br />
| skills = C++, XML, Python<br />
| description = Write a program to resolve anaphora and include it in the Apertium translation pipeline.<br />
| rationale = Apertium has a problem with long distance dependencies in terms of agreement and co-reference. For example, deciding which determiner to use when translating from Spanish "su" to English "his, her, its". The objective of this task is to make a system to resolve anaphora and integrate it into a translation pipeline.<br />
| mentors = [[User:Francis Tyers|Francis Tyers]]<br />
| more = /Anaphora resolution<br />
}}<br />
<br />
<div style="background-color: #f9f9f9; border: 1px solid black; padding: 1ex; margin-bottom: 2ex;"><br />
<br />
=== <u>Bring a released language pair up to state-of-the-art quality</u> ===<br />
* '''Difficulty''':<br><span style="background-color: #cdefcd">2. Medium</span><br />
* '''Required skills''':<br>XML, a scripting language (Python, Perl), good knowledge of the language pair adopted.<br />
* '''Description''':<br>Take a released language pair, and drastically improve the performance both in terms of coverage, and in terms of translation quality. This will involve working with dictionaries, transfer rules, scripting, corpora. The objective is to make an Apertium language pair state-of-the-art, or close to state-of-the-art in terms of translation quality. This will involve improving coverage to 95-98% on a range of corpora and decreasing [[word error rate]] by 30-50%. For example if the current word error rate is 30%, then it should be reduced to 15-20%.<br />
* '''Rationale''':<br>Apertium has quite a broad coverage of language pairs, but few of these pairs offer state-of-the-art translation quality. We think broad is important, but deep coverage is important too.<br />
* '''Mentors''':<br>[[User:Francis Tyers|Francis Tyers]], [[User:Mlforcada|Mikel Forcada]], [[User:Xavivars|Xavi Ivars]], [[User:Ilnar.salimzyan|Ilnar Salimzianov]], [[User:Memduh|Memduh Gokirmak]]<br />
* '''[[/Make a language pair state-of-the-art|read more...]]'''<br />
</div><br />
<br />
<div style="background-color: #f9f9f9; border: 1px solid black; padding: 1ex; margin-bottom: 2ex;"><br />
<br />
=== <u>Robust tokenisation in lttoolbox</u> ===<br />
* '''Difficulty''':<br><span style="background-color: #cdefcd">2. Medium</span><br />
* '''Required skills''':<br>C++, XML, Python<br />
* '''Description''':<br>Improve the longest-match left-to-right tokenisation strategy in [[lttoolbox]] to be fully Unicode compliant.<br />
* '''Rationale''':<br>One of the most frustrating things about working with Apertium on texts "in the wild" is the way that the tokenisation works. If a letter is not specified in the alphabet, it is dealt with as whitespace, so e.g. you get unknown words split in two so you can end up with stuff like ^G$ö^k$ı^rmak$ which is terrible for further processing. <br />
* '''Mentors''':<br>[[User:Francis Tyers|Francis Tyers]], [[User:TommiPirinen|Flammie]]<br />
* '''[[/Robust tokenisation|read more...]]'''<br />
</div><br />
<br />
<div style="background-color: #f9f9f9; border: 1px solid black; padding: 1ex; margin-bottom: 2ex;"><br />
<br />
=== <u>Adopt an unreleased language pair</u> ===<br />
* '''Difficulty''':<br><span style="background-color: #cdcdef">3. Entry level</span><br />
* '''Required skills''':<br>XML, a scripting language (Python, Perl), good knowledge of the language pair adopted.<br />
* '''Description''':<br>Take on an orphaned unreleased language pair, and bring it up to release quality results. What this quality will be will depend on the language pair adopted, and will need to be discussed with the prospective mentor. This will involve writing linguistic data (including morphological rules and transfer rules &mdash; which are specified in a declarative language &mdash; and possibly [[Constraint Grammar]] rules if that is relevant)<br />
* '''Rationale''':<br>Apertium has a few pairs of languages (e.g. mt-he, ga-gd, ur-hi, pl-cs, sh-ru, etc...) that are orphaned, they don't have active maintainers. A lot of these pairs have a lot of work already put in, just need another few months to get them to release quality. See also [[Incubator]]<br />
* '''Mentors''':<br>[[User:Francis Tyers|Francis Tyers]], [[User:Jimregan|Jimregan]], [[User:Kevin Scannell|Kevin Scannell]], [[User:Trondtr|Trondtr]], [[User:Unhammer|Unhammer]], [[User:Darthxaher|Darthxaher]], [[User:Firespeaker|Firespeaker]], [[User:Hectoralos|Hectoralos]], [[User:Krvoje|Hrvoje Peradin]], [[User:Jacob Nordfalk|Jacob Nordfalk]], [[User:Mlforcada|Mikel Forcada]], [[User:Vin-ivar|Vinit Ravishankar]], [[User:Aida|Aida Sundetova]], [[User:Xavivars|Xavi Ivars]], [[User:Ilnar.salimzyan|Ilnar Salimzianov]], [[User:Sevilay bayatlı|Sevilay Bayatlı]], [[User:Memduh|Memduh Gokirmak]]<br />
* '''[[/Adopt a language pair|read more...]]'''<br />
</div><br />
<br />
<div style="background-color: #f9f9f9; border: 1px solid black; padding: 1ex; margin-bottom: 2ex;"><br />
<br />
=== <u>Extend lttoolbox to have the power of HFST</u> ===<br />
* '''Difficulty''':<br><span style="background-color: #efcdcd">1. Hard</span><br />
* '''Required skills''':<br>C++, XSLT, XML<br />
* '''Description''':<br>Extend lttoolbox (perhaps writing a preprocessor for it) so that it can be used to do the morphological transformations currently done with HFST. And yes, of course, writing something that translates the current HFST format to the new lttolbox format. Proof of concept: Come up with a new format that can express all of the features found in the Kazakh transducer; implement this format in Apertium; Implement the Kazakh transducer in this format and integrate it in the English--Kazakh pair.<br />
* '''Rationale''':<br>Some language pairs in Apertium use HFST where most language pairs use Apertium's own lttoolbox. This is due to the fact that writing morphologies for languages that have features such as the vowel harmony found in Turkic languages is very hard with the current format supported by lttoolbox. The mixture of HFST and lttoolbox makes it harder for people to develop some language pairs.<br />
* '''Mentors''':<br>[[User:Mlforcada|Mikel Forcada]], [[User:TommiPirinen|Tommi A Pirinen]], [[User:Unhammer]], mentors wanted<br />
* '''[[/Extend lttoolbox to have the power of HFST|read more...]]'''<br />
</div><br />
<br />
<!--<br />
<br />
DANGER TERROR HORROR !!!!!!<br />
<br />
The task above has subsumed these two<br />
<br />
<div style="background-color: #f9f9f9; border: 1px solid black; padding: 1ex; margin-bottom: 2ex;"><br />
=== <u>Flag diacritics in lttoolbox</u> ===<br />
* '''Difficulty''':<br><span style="background-color: #efcdcd">1. Hard</span><br />
* '''Required skills''':<br>C++ or Java, XML, Knowledge of FSTs<br />
* '''Description''':<br>Adapt [[lttoolbox]] to elegantly use flag diacritics. Flag diacritics are a way of avoiding transducer size blow-up by discarding impossible paths at runtime as opposed to compile time. Some work has already been done, see [[Flag diacritics]].<br />
* '''Rationale''':<br>This will involve designing some changes to our XML dictionary format (see [[lttoolbox]], and implementing the associated changes in the FST compiling processing code. The reason behind this is that many languages have prefix inflection, and we cannot currently deal with this without either making paradigms useless, or overanalysing (e.g. returning analyses where none exist). Flag diacritics (or constraints) would allow us to restrict overanalysis without blowing up the size of our dictionaries.<br />
* '''Mentors''':<br>[[User:Francis Tyers|Francis Tyers]] (C++), [[User:Jacob Nordfalk|Jacob Nordfalk]] (Java)<br />
* '''[[/Flag diacritics in lttoolbox|read more...]]'''<br />
</div><br />
<br />
<br />
<div style="background-color: #f9f9f9; border: 1px solid black; padding: 1ex; margin-bottom: 2ex;"><br />
=== <u>Weights in lttoolbox</u> ===<br />
* '''Difficulty''':<br><span style="background-color: #cdefcd">2. Medium</span><br />
* '''Required skills''':<br>C++, XML, FSTs<br />
* '''Description''':<br>[[lttoolbox]] is a set of tools for building finite-state transducers. As part of Apertium's long-term strategy we would like to include probabilistic information into more stages of the pipeline to allow generic tools to be optimised for machine translation. This task involves adding the possibility of weighting lexemes and analyses in our finite-state transducer toolbox.<br />
* '''Rationale''':<br>Weighting information for lexical forms will be useful for morphological disambiguation, and for work on [[spellchecking]].<br />
* '''Mentors''':<br>[[User:Francis Tyers|Francis Tyers]], [[User:TommiPirinen|Tommi Pirinen]]<br />
* '''[[/Add weights to lttoolbox|read more...]]'''<br />
</div><br />
--><br />
<br />
<br />
<div style="background-color: #f9f9f9; border: 1px solid black; padding: 1ex; margin-bottom: 2ex;"><br />
<br />
=== <u>Robust recursive transfer</u> ===<br />
* '''Difficulty''':<br><span style="background-color: #efcdcd">1. Hard</span><br />
* '''Required skills''':<br>Python, XML, linguistics<br />
* '''Description''':<br>The purpose of this task would be to create a module to replace the apertium-transfer module(s) which will parse and allow transfer operations on an input.<br />
* '''Rationale''':<br>Currently we have a problem with very distantly related languages that have long-distance constituent reordering, because we can only do finite-state chunking.<br />
* '''Mentors''':<br>[[User:Francis Tyers|Francis Tyers]], [[User:Sortiz|Sortiz]], [[User:Mlforcada|Mikel Forcada]], [[User:Japerez|Juan Antonio Pérez]]<br />
* '''[[/Robust recursive transfer|read more...]]'''<br />
</div><br />
<br />
<div style="background-color: #f9f9f9; border: 1px solid black; padding: 1ex; margin-bottom: 2ex;"><br />
=== <u>Extend weighted transfer rules</u> ===<br />
* '''Difficulty''':<br><span style="background-color: #efcdcd">1. Hard</span><br />
* '''Required skills''':<br>Python, C++, linguistics<br />
* '''Description''':<br>The purpose of this task is to extend weighted transfer rules to all transfer files and to allow conflicting rule patterns to be handled by combining (lexicalised) weights.<br />
* '''Rationale''':<br>Currently our transfer rules are applied longest-match left-to-right ([[LRLM]]). When two rule patterns conflict the first one is chosen. We have a prototype for selecting based on lexicalised weights, but it only applies to the first stage of transfer.<br />
* '''Mentors''':<br>[[User:Francis Tyers|Francis Tyers]], [[User:TommiPirinen|Tommi Pirinen]], [[User:Sevilay Bayatlı|Sevilay Bayatlı]], [[User:Memduh|Memduh Gokirmak]]<br />
* '''[[/Weighted transfer rules|read more...]]'''<br />
</div><br />
<br />
<div style="background-color: #f9f9f9; border: 1px solid black; padding: 1ex; margin-bottom: 2ex;"><br />
<br />
=== <u>Improvements to the Apertium website</u> ===<br />
* '''Difficulty''':<br><span style="background-color: #cdcdef">3. Entry level</span><br />
* '''Required skills''':<br>Python, HTML, JS<br />
* '''Description''':<br>Our web site is pretty cool already, but it's missing things like dictionary/synonym lookup, support for several variants of one language, reliability visualisation, (reliable) webpage translation, feedback, etc.<br />
* '''Rationale''':<br>[https://apertium.org https://apertium.org] / [http://beta.apertium.org http://beta.apertium.org] is what most people know us by, it should show off more of the things we are capable of :-)<br />
* '''Mentors''':<br>[[User:Firespeaker|Jonathan]], [[User:Sushain|Sushain]]<br />
* '''[[/Apertium website improvements|read more...]]'''<br />
</div><br />
<br />
<div style="background-color: #f9f9f9; border: 1px solid black; padding: 1ex; margin-bottom: 2ex;"><br />
<br />
=== <u>User-friendly lexical selection training</u> ===<br />
* '''Difficulty''':<br><span style="background-color: #cdefcd">2. Medium</span><br />
* '''Required skills''':<br>Python, C++, shell scripting<br />
* '''Description''':<br>Make it so that training/inference of lexical selection rules is a more user-friendly process<br />
* '''Rationale''':<br>Our lexical selection module allows for inferring rules from corpora and word alignments, but the procedure is currently a bit messy, with various scripts involved that require lots of manual tweaking, and many third party tools to be installed. The goal of this task is to make the procedure as user-friendly as possible, so that ideally only a simple config file would be needed, and a driver script would take care of the rest.<br />
* '''Mentors''':<br>[[User:Unhammer|Unhammer]], [[User:Mlforcada|Mikel Forcada]]<br />
* '''[[/User-friendly lexical selection training|read more...]]'''<br />
</div><br />
<br />
<div style="background-color: #f9f9f9; border: 1px solid black; padding: 1ex; margin-bottom: 2ex;"><br />
<br />
=== <u>Light alternative format for all XML files in an Apertium language pair</u> ===<br />
* '''Difficulty''':<br><span style="background-color: #efcdcd">1. Hard</span><br />
* '''Required skills''':<br>Python, C++, shell scripting, XSLT, flex<br />
* '''Description''':<br>Make it possible to edit and develop language data using a format that is lighter than XML<br />
* '''Rationale''':<br>In most Apertium language pairs, monolingual dictionaries, bilingual dictionaries, post-generation rule files and structural transfer rule files are all written in XML. While XML is easy to process due to explicit tagging of every element, it is tedious to deal with, particularly when it comes to structural transfer rules. Apertium's precursor, interNOSTRUM, had lighter text based formats. The task involves: (a) designing and documenting an interNOSTRUM-style format for all of the XML language data files in a language pair; (b) writing converters to XML and from XML that are fully roundtrip-compliant: (c) designing a way to synchronize changes when both the XML and the non-XML format are used simultaneously in a specific language pair.<br />
* '''Mentors''':<br>[[User:Mlforcada|Mikel Forcada]], [[User:Japerez|Juan Antonio Pérez]], pair.<br />
* '''[[/Plain-text_formats_for_Apertium_data|read more...]]'''<br />
</div><br />
<br />
<!--<div style="background-color: #f9f9f9; border: 1px solid black; padding: 1ex; margin-bottom: 2ex;"><br />
=== <u>Eliminate dictionary trimming</u> ===<br />
* '''Difficulty''':<br><span style="background-color: #ffbdbd">0. Very Hard</span><br />
* '''Required skills''':<br>C++, Finite-State Transducers<br />
* '''Description''':<br>Eliminate the need for trimming the monolingual dictionaries, in order to preserve and take advantage of maximal source language analysis.<br />
* '''Rationale''':<br>[[Why we trim]] mentions several technical reasons for why trimming away monolingual information is currently needed. Unfortunately, this limitation means that a lot of useful contextual information is lost. It would be ideal if the source language could be fully analyzed independent of target language, with any untranslated part fed back into the source language generator.<br />
* '''Mentors''':<br> [[User:TommiPirinen|Tommi Pirinen a.k.a. Flammie]]<br />
* '''Work around everything in [[Why we trim]]'''<br />
</div>--><br />
<br />
<div style="background-color: #f9f9f9; border: 1px solid black; padding: 1ex; margin-bottom: 2ex;"><br />
<br />
=== <u>Bilingual dictionary enrichment via graph completion</u> ===<br />
* '''Difficulty''':<br><span style="background-color: #ffbdbd">0. Very hard</span><br />
* '''Required skills''':<br>shell scripting, python, XSLT, XML<br />
* '''Description''':<br>Generate new entries for existing or new bilingual dictionaries using graphic representations of bilingual correspondences as found in all existing dictionaries (note that this idea defines a rather open-ended task to be discussed in detail with mentors).<br />
* '''Rationale''':<br>Apertium bilingual dictionaries establish correspondences between lexical forms in a number of language pairs. Connections among them may be used to infer new entries for existing or new language pairs using graphs. The graphs may be directly generated from Apertium bidixes and exploiting using [[Bilingual_dictionary_discovery|ideas that had already been proposed in Apertium]] or using existing [http://linguistic.linkeddata.es/apertium/ RDF representations] of parts of their content, which may benefit from the information coming from being linked to other resources.<br />
* '''Mentors''':<br>[[User:Mlforcada|Mikel Forcada]], [[User:Francis Tyers|Francis Tyers]], [[User:Jorge Gracia|Jorge Gracia]]<br />
* '''[[Bilingual_dictionary_discovery|read more...]]''' '''[[/Bilingual_dictionary_enrichment_via_graph_completion|read even more...]]'''<br />
</div><br />
<br />
<!--<div style="background-color: #f9f9f9; border: 1px solid black; padding: 1ex; margin-bottom: 2ex;"><br />
<br />
=== <u>Transfer rule induction from comparable parsed corpora</u> ===<br />
* '''Difficulty''':<br><span style="background-color: #ffbdbd">1. Hard</span><br />
* '''Required skills''':<br>shell scripting, python, XSLT, XML<br />
* '''Description''':<br>A system to infer transfer rules from comparable corpora that have both been deeply parsed (with e.g. CG)<br />
* '''Rationale''':<br>Many languages have good CG's and fairly large monolingual corpora, but little parallel material. Given a small bidix, fairly large monolingual corpora and good analysers/CG's, we should be able to parse both corpora, translate lemmas and look for similar sentences, turning the differences in their parses into transfer rules. <br />
* '''Mentors''':<br>[[User:Unhammer]]<br />
* '''[[Transfer_induction_from_comparable_parsed_corpora|read more...]]''' <br />
</div>--><br />
<br />
<div style="background-color: #f9f9f9; border: 1px solid black; padding: 1ex; margin-bottom: 2ex;"><br />
<br />
=== <u>UD and Apertium integration</u> ===<br />
* '''Difficulty''':<br><span style="background-color: #cdcdef">3. Entry level</span><br />
* '''Required skills''':<br>python, javascript, HTML, (C++)<br />
* '''Description''':<br>Create a range of tools for making Apertium compatible with Universal Dependencies<br />
* '''Rationale''':<br>Universal dependencies is a fast growing project aimed at creating a unified annotation scheme for treebanks. This includes both part-of-speech and morphological features. Their annotated corpora could be extremely useful for Apertium for training models for translation. In addition, Apertium's rule-based morphological descriptions could be useful for software that relies on Universal dependencies.<br />
* '''Mentors''':<br>[[User:Francis Tyers]] [[User:Firespeaker]], [[User:Memduh|Memduh Gokirmak]]<br />
* '''[[/UD and Apertium integration|read more...]]''' <br />
</div><br />
<br />
<div style="background-color: #f9f9f9; border: 1px solid black; padding: 1ex; margin-bottom: 2ex;"><br />
<br />
=== <u>Add weights to lttoolbox</u> ===<br />
* '''Difficulty''':<br><span style="background-color: #ffbdbd">1. Hard</span><br />
* '''Required skills''':<br>c++<br />
* '''Description''':<br>Add support for weighted transducers to lttoolbox<br />
* '''Rationale''':<br>This will either involve implementing it from scratch or adding OpenFST as a backend. We would like to be able to use it both in the bilingual dictionaries, and in the morphological analysers, to be able to order analyses/translations by their probability/weight instead of by the random topological order. <br />
* '''Mentors''':<br>[[User:Francis Tyers]] [[User:Unhammer]]<br />
* '''[[/Add weights to lttoolbox|read more...]]''' <br />
</div><br />
<br />
<div style="background-color: #f9f9f9; border: 1px solid black; padding: 1ex; margin-bottom: 2ex;"><br />
<br />
=== <u>Improving language pairs mining Mediawiki Content Translation postedits</u> ===<br />
* '''Difficulty''':<br><span style="background-color: #ffbdbd">1. Hard</span><br />
* '''Required skills''':<br>Python, shell scripting, some statistics<br />
* '''Description''':<br>Implement a toolkit that allows mining existing machine translation postediting data in [Mediawiki Content Translation https://www.mediawiki.org/wiki/Content_translation] to generate (as automatically as possible, and as complete as possible) monodix and bidix entries to improve the performance of an Apertium language pair. Data is available from Wikimedia content translation through an [API https://www.mediawiki.org/wiki/Content_translation/Published_translations#API] or in the form of [Dumps https://dumps.wikimedia.org/other/contenttranslation/] available in JSON and TMX format. This project is rather experimental and involves some research in addition to coding.<br />
* '''Rationale''':<br>Apertium is used to generate new Wikipedia content: machine-translated content is postedited (and perhaps adapted) before publishing. Postediting information may contain information that can be used to help improve the lexical components of an Apertium language pair. <br />
* '''Mentors''':<br> [[User:Mlforcada|Mikel Forcada]], (more mentors to be added)<br />
* '''[[/automatic-postediting|read more...]]''' <br />
</div><br />
<br />
<br />
<div style="background-color: #f9f9f9; border: 1px solid black; padding: 1ex; margin-bottom: 2ex;"><br />
<br />
=== <u>Unsupervised weighting of automata</u> ===<br />
* '''Difficulty''':<br><span style="background-color: #cdefcd">2. Medium</span><br />
* '''Required skills''':<br>Python, shell scripting, statistics, finite-state transducers<br />
* '''Description''':<br>Implement a collection of methods for weighting finite-state transducers, the methods should include an implementation of a simple method of supervised training, and a number of methods for unsupervised training. The objective being to get the analysis ranking given a set of a analyses for a given surface form as close to the result given by supervised training as possible.<br />
* '''Rationale''':<br>Apertium struggles with ambiguity, we have had many attempts to write better part of speech taggers. This would complement those attempts by providing a generic method to weight automata.<br />
* '''Mentors''':<br> [[User:Francis Tyers|Francis Tyers]], [[User:TommiPirinen|Flammie]], [[User:Unhammer|Unhammer]]<br />
* '''[[/Unsupervised weighting of automata|read more...]]'''<br />
</div><br />
<br />
<div style="background-color: #f9f9f9; border: 1px solid black; padding: 1ex; margin-bottom: 2ex;"><br />
=== <u>Improvements to UD Annotatrix</u> ===<br />
* '''Difficulty''':<br><span style="background-color: #cdefcd">2. Medium</span><br />
* '''Required skills''':<br>JavaScript, Jquery, HTML, Python<br />
* '''Description''':<br>UD Annotatrix is an interface by Apertium for annotating dependency trees in CoNLL-U format. The system is currently in beta, but is getting traction as more people start using it.<br />
* '''Rationale''':<br>Universal Dependencies is a very widely used standard for annotating data, the kind of annotated data that can be used to train part of speech taggers. There is still a lot of work that could be done to improve it.<br />
* '''Mentors''':<br> [[User:Francis Tyers|Francis Tyers]], [[User:Firespeaker]]<br />
* '''[[/UD Annotatrix|read more...]]'''<br />
</div><br />
<br />
<div style="background-color: #f9f9f9; border: 1px solid black; padding: 1ex; margin-bottom: 2ex;"><br />
=== <u>apertium-separable language-pair integration</u> ===<br />
* '''Difficulty''':<br><span style="background-color: #cdefcd">2. Medium</span><br />
* '''Required skills''':<br>XML, a scripting language (Python, Perl), some knowledge of linguistics and/or at least one relevant natural language<br />
* '''Description''':<br>Choose a language you can identify as having a good number of "multiwords" in the lexicon. Modify all language pairs in Apertium to use the [[Apertium-separable]] module to process the multiwords, and clean up the dictionaries accordingly.<br />
* '''Rationale''':<br>Apertium-separable is a newly developed module to process lexical items with discontinguous dependencies, an area where Apertium has traditionally fallen short. Despite all the module has to offer, it has only been put to use in small test cases, and hasn't been integrated into any translation pair's development cycle.<br />
* '''Mentors''':<br> [[User:Francis Tyers|Francis Tyers]], [[User:Firespeaker]]<br />
* '''[[/Apertium separable|read more...]]'''<br />
</div><br />
<br />
{{IdeaSummary<br />
| name = Create FST-based module for disambiguating<br />
| difficulty = medium<br />
| skills = XML, a scripting language (Python, Perl), C++, finite-state transducers<br />
| description = Implement a [[Constraint Grammar]]-like module based on finite-state transducers.<br />
| rationale = Currently, many language pairs use [[Constraint grammar]] as a pre-disambiguator for the Apertium tagger, allowing the imposition of more fine grained constraints than would be otherwise possible. However, current implementation of CG is much slower than most of the other modules in the Apertium pipeline, and it's also very different in terms of syntax to other Apertium modules (dictionaries, lexical selection, transfer rules, etc). There have been a few attempts to create FST versions of CG (see [[User:David_Nemeskey/GSOC_progress_2013]]), but they haven't succeeded. The hypothesis is that a simpler version of CG that supports the main features that CG support (no need to feature parity) would have better adoption and integration within the Apertium pipeline.<br />
| mentors = [[User:Xavivars|Xavi Ivars]], [[User:Francis Tyers|Francis Tyers]]<br />
| more = /Apertium FST GC<br />
}}<br />
<br />
{{IdeaSummary<br />
| name = Python API/library for Apertium<br />
| difficulty = medium<br />
| skills = Python, C++, SWIG<br />
| description = Implement a Python library for Apertium and Lttoolbox.<br />
| rationale = Lots of people use Python, they like to use it in their Jupyter notebooks and on Microsoft Windows™. Apertium is really hard to get going in these kind of environments. So it would be cool if we could make Apertium work for them too. It has a lot of nice language processing tools that we would like more people to use. I'm sure people would love to "pip install apertium" or "pip install apertium-ava". The API/implementation should be pythonistic and should use C++ bindings to directly perform morphological functions, avoiding the overhead of a separate process. Prior GSoC project work is available on [https://github.com/apertium/apertium-python GitHub].<br />
| mentors = [[User:Sushain|Sushain]], [[User:Francis Tyers|Francis Tyers]], [[User:Unhammer|Unhammer]], [[User:Xavivars|Xavi Ivars]], [[User:Memduh|Memduh Gokirmak]]<br />
| more = /Python library<br />
}}<br />
<br />
{{IdeaSummary<br />
| name = TIPP functionality for Apertium<br />
| difficulty = medium<br />
| skills = Python, C++, XML, XLIFF (a subset called XLIFF:doc)<br />
| description = TIPP, the TMS Interoperability Protocol Package (where TMS means translation management system), [https://github.com/tingley/interoperability-now/blob/master/releases/tipp/1.5/The_TMS_Interoperability_Protocol_Package-1.5.pdf], currently in version 1.5 but being upgraded to 2.0, specifies a container (package format) that allows the interchange of information along a translation value chain. There are various container varieties for different tasks. One such variety, called Translate-Strict-Bitext, represents a bilingual translation job. The 'request' TIPP would contain an XLIFF:doc ([https://github.com/tingley/interoperability-now/tree/master/releases/xliffdoc/1.0.1], a subset of XLIFF 1 [http://docs.oasis-open.org/xliff/v1.2/os/xliff-core.html]) file with the document to be translated and the corresponding metadata, and the corresponding 'response' TIPP would contain the results of Apertium MT applied to it, but taking into account the translation memory provided in the TIPP, if any (using Apertium's -m switch). Apertium should be endowed with the capacity to manage TIPP packages: unpack the request package, parse it, process it, and repack it.<br />
| mentors = [[User:Mlforcada|Mikel Forcada]]<br />
| more = /Apertium_TIPP<br />
}}<br />
<br />
<br />
{{IdeaSummary<br />
| name = Bring Apertium Occitan--French closer to posteditable quality.<br />
| difficulty = medium<br />
| skills = GNU/Linux advanced user, bash, git, XML editing, standard Occitan, French.<br />
| description = The idea is to make Occitan output easier to postedit and French output easier to understand. This entails increasing the monolingual and bilingual dictionaries, improving disambiguation, and writing new structural transfer rules.<br />
| rationale = The [https://github.com/apertium/apertium-oci-fra Occitan--French language pair] has been recently published. This language pair is of strategic importance for the Occitan language, as Apertium offers the only machine translation system for this language pair. <br />
| mentors = [[User:Mlforcada|Mikel Forcada]], [[User:Memduh|Memduh Gokirmak]], mentors welcome.<br />
| more = /Apertium_Occitan_French<br />
}}<br />
<br />
<br />
<br />
<br />
{{IdeaSummary<br />
| name = Create a usable version of one of these language pairs: English--Igbo, English--Yoruba, English--Tigrinya, English--Swahili, English-Hausa<br />
| difficulty = medium<br />
| skills = GNU/Linux advanced user, bash, git, XML editing, English, Igbo/Yoruba/Tigrinya/Swahili/Hausa<br />
| description = The objective is to start these language pairs (which haven't been started or have currentlu very little data in Apertium) and write an usable version which provides intelligible output.<br />
| rationale = African languages are not particularly well served by Apertium. The four languages listed are quite important, and are only currently served by commercial machine translation companies such as Google, which makes these language communities dependent on a specific commercial provider.<br />
| mentors = [[User:Mlforcada|Mikel Forcada]], [[User:Memduh|Memduh Gokirmak]], mentors welcome.<br />
| more = /Apertium_African<br />
}}<br />
<br />
{{IdeaSummary<br />
| name = Set up gap-filling machine-translation-for-gisting evaluation on a recent version of Appraise<br />
| difficulty = hard<br />
| skills = python, bash, git, XML editing.<br />
| description = [http://github.com/mlforcada/Appraise http://github.com/mlforcada/Appraise], in turn forked from [http://github.com/mlforcada/Appraise http://github.com/mlforcada/Appraise], the work of a GSoC student, contains an adaptation of an old (2014) version of [http://github.com/cfedermann/Appraise http://github.com/cfedermann/Appraise] to implement gap-filling evaluation as described in [https://export.arxiv.org/pdf/1809.00315 this WMT2018 paper]. The objective is to bring the gap-filling functionality in [http://github.com/mlforcada/Appraise] to be compatible with the latest versions of Appraise.<br />
| rationale = Many language pairs in Apertium are unique, such as Breton-French, and many of them are used for gisting (understanding) purposes. Gap-filling provides a simple way to evaluate the usefulness of machine translation for gisting. The implementation used in recent experiments is based on an outdated version of the Appraise platform. <br />
| mentors = [[User:Mlforcada|Mikel Forcada]], mentors welcome.<br />
| more = /Appraise_gisting<br />
}}<br />
<br />
{{IdeaSummary<br />
| name = A Web Interface to expanding dictionary lemmas integrate with GitLab/GitHub<br />
| difficulty = hard<br />
| skills = java, git, XML, nodeJs, Angular 8.<br />
| description = Given that Apertium has a few dozen contributors and thousands of users, we propose a web graphical user interface (GUI) that enables the lay users to contribute to the expansion of the dictionaries that makeup the knowledge base of Apertium. <br />
The main premise of the solution is that users with minimal knowledge of thelanguage can contribute easily and that it must be integrated with the currentform of development of expert users.<br />
| rationale = . <br />
| mentors = [[User:Alessio|Aléssio Jr.]], mentors welcome.<br />
| more = /Easy_dictionary_maintenance, https://apertium-wdm.appspot.com/<br />
}}<br />
<br />
<br />
<br />
[[Category:Development]]<br />
[[Category:Google Summer of Code]]</div>Alessiohttps://wiki.apertium.org/w/index.php?title=Ideas_for_Google_Summer_of_Code&diff=71115Ideas for Google Summer of Code2020-02-02T14:46:14Z<p>Alessio: /* List */</p>
<hr />
<div>{{TOCD}}<br />
This is the ideas page for [[Google Summer of Code]], here you can find ideas on interesting projects that would make Apertium more useful for people and improve or expand our functionality. If you have an idea please add it below, if you think you could mentor someone in a particular area, add your name to "Interested mentors" using <nowiki>~~~</nowiki> <br />
<br />
The page is intended as an overview of the kind of projects we have in mind. If one of them particularly piques your interest, please come and discuss with us on <code>#apertium</code> on <code>irc.freenode.net</code>, mail the [[Contact|mailing list]], or draw attention to yourself in some other way. <br />
<br />
Note that, if you have an idea that isn't mentioned here, we would be very interested to hear about it.<br />
<br />
Here are some more things you could look at:<br />
<br />
* [[Top tips for GSOC applications]] <br />
* Get in contact with one of our long-serving [[List of Apertium mentors|mentors]] &mdash; they are nice, honest!<br />
* Pages in the [[:Category:Development|development category]]<br />
* Resources that could be converted or expanded in the [[incubator]]. Consider doing or improving a language pair (see [[incubator]], [[nursery]] and [[staging]] for pairs that need work)<br />
* Unhammer's [[User:Unhammer/wishlist|wishlist]]<br />
* The open issues [https://github.com/search?q=org%3Aapertium&state=open&type=Issues on Github] (or [http://sourceforge.net/p/apertium/tickets/search/?q=!status%3Awont-fix+%26%26+!status%3Aclosed on Sourceforge]). The latter are probably out of date now since migrating to Github.<br />
<br />
__TOC__<br />
<br />
== List ==<br />
<br />
{{IdeaSummary<br />
| name = Anaphora resolution for machine translation<br />
| difficulty = hard<br />
| skills = C++, XML, Python<br />
| description = Write a program to resolve anaphora and include it in the Apertium translation pipeline.<br />
| rationale = Apertium has a problem with long distance dependencies in terms of agreement and co-reference. For example, deciding which determiner to use when translating from Spanish "su" to English "his, her, its". The objective of this task is to make a system to resolve anaphora and integrate it into a translation pipeline.<br />
| mentors = [[User:Francis Tyers|Francis Tyers]]<br />
| more = /Anaphora resolution<br />
}}<br />
<br />
<div style="background-color: #f9f9f9; border: 1px solid black; padding: 1ex; margin-bottom: 2ex;"><br />
<br />
=== <u>Bring a released language pair up to state-of-the-art quality</u> ===<br />
* '''Difficulty''':<br><span style="background-color: #cdefcd">2. Medium</span><br />
* '''Required skills''':<br>XML, a scripting language (Python, Perl), good knowledge of the language pair adopted.<br />
* '''Description''':<br>Take a released language pair, and drastically improve the performance both in terms of coverage, and in terms of translation quality. This will involve working with dictionaries, transfer rules, scripting, corpora. The objective is to make an Apertium language pair state-of-the-art, or close to state-of-the-art in terms of translation quality. This will involve improving coverage to 95-98% on a range of corpora and decreasing [[word error rate]] by 30-50%. For example if the current word error rate is 30%, then it should be reduced to 15-20%.<br />
* '''Rationale''':<br>Apertium has quite a broad coverage of language pairs, but few of these pairs offer state-of-the-art translation quality. We think broad is important, but deep coverage is important too.<br />
* '''Mentors''':<br>[[User:Francis Tyers|Francis Tyers]], [[User:Mlforcada|Mikel Forcada]], [[User:Xavivars|Xavi Ivars]], [[User:Ilnar.salimzyan|Ilnar Salimzianov]], [[User:Memduh|Memduh Gokirmak]]<br />
* '''[[/Make a language pair state-of-the-art|read more...]]'''<br />
</div><br />
<br />
<div style="background-color: #f9f9f9; border: 1px solid black; padding: 1ex; margin-bottom: 2ex;"><br />
<br />
=== <u>Robust tokenisation in lttoolbox</u> ===<br />
* '''Difficulty''':<br><span style="background-color: #cdefcd">2. Medium</span><br />
* '''Required skills''':<br>C++, XML, Python<br />
* '''Description''':<br>Improve the longest-match left-to-right tokenisation strategy in [[lttoolbox]] to be fully Unicode compliant.<br />
* '''Rationale''':<br>One of the most frustrating things about working with Apertium on texts "in the wild" is the way that the tokenisation works. If a letter is not specified in the alphabet, it is dealt with as whitespace, so e.g. you get unknown words split in two so you can end up with stuff like ^G$ö^k$ı^rmak$ which is terrible for further processing. <br />
* '''Mentors''':<br>[[User:Francis Tyers|Francis Tyers]], [[User:TommiPirinen|Flammie]]<br />
* '''[[/Robust tokenisation|read more...]]'''<br />
</div><br />
<br />
<div style="background-color: #f9f9f9; border: 1px solid black; padding: 1ex; margin-bottom: 2ex;"><br />
<br />
=== <u>Adopt an unreleased language pair</u> ===<br />
* '''Difficulty''':<br><span style="background-color: #cdcdef">3. Entry level</span><br />
* '''Required skills''':<br>XML, a scripting language (Python, Perl), good knowledge of the language pair adopted.<br />
* '''Description''':<br>Take on an orphaned unreleased language pair, and bring it up to release quality results. What this quality will be will depend on the language pair adopted, and will need to be discussed with the prospective mentor. This will involve writing linguistic data (including morphological rules and transfer rules &mdash; which are specified in a declarative language &mdash; and possibly [[Constraint Grammar]] rules if that is relevant)<br />
* '''Rationale''':<br>Apertium has a few pairs of languages (e.g. mt-he, ga-gd, ur-hi, pl-cs, sh-ru, etc...) that are orphaned, they don't have active maintainers. A lot of these pairs have a lot of work already put in, just need another few months to get them to release quality. See also [[Incubator]]<br />
* '''Mentors''':<br>[[User:Francis Tyers|Francis Tyers]], [[User:Jimregan|Jimregan]], [[User:Kevin Scannell|Kevin Scannell]], [[User:Trondtr|Trondtr]], [[User:Unhammer|Unhammer]], [[User:Darthxaher|Darthxaher]], [[User:Firespeaker|Firespeaker]], [[User:Hectoralos|Hectoralos]], [[User:Krvoje|Hrvoje Peradin]], [[User:Jacob Nordfalk|Jacob Nordfalk]], [[User:Mlforcada|Mikel Forcada]], [[User:Vin-ivar|Vinit Ravishankar]], [[User:Aida|Aida Sundetova]], [[User:Xavivars|Xavi Ivars]], [[User:Ilnar.salimzyan|Ilnar Salimzianov]], [[User:Sevilay bayatlı|Sevilay Bayatlı]], [[User:Memduh|Memduh Gokirmak]]<br />
* '''[[/Adopt a language pair|read more...]]'''<br />
</div><br />
<br />
<div style="background-color: #f9f9f9; border: 1px solid black; padding: 1ex; margin-bottom: 2ex;"><br />
<br />
=== <u>Extend lttoolbox to have the power of HFST</u> ===<br />
* '''Difficulty''':<br><span style="background-color: #efcdcd">1. Hard</span><br />
* '''Required skills''':<br>C++, XSLT, XML<br />
* '''Description''':<br>Extend lttoolbox (perhaps writing a preprocessor for it) so that it can be used to do the morphological transformations currently done with HFST. And yes, of course, writing something that translates the current HFST format to the new lttolbox format. Proof of concept: Come up with a new format that can express all of the features found in the Kazakh transducer; implement this format in Apertium; Implement the Kazakh transducer in this format and integrate it in the English--Kazakh pair.<br />
* '''Rationale''':<br>Some language pairs in Apertium use HFST where most language pairs use Apertium's own lttoolbox. This is due to the fact that writing morphologies for languages that have features such as the vowel harmony found in Turkic languages is very hard with the current format supported by lttoolbox. The mixture of HFST and lttoolbox makes it harder for people to develop some language pairs.<br />
* '''Mentors''':<br>[[User:Mlforcada|Mikel Forcada]], [[User:TommiPirinen|Tommi A Pirinen]], [[User:Unhammer]], mentors wanted<br />
* '''[[/Extend lttoolbox to have the power of HFST|read more...]]'''<br />
</div><br />
<br />
<!--<br />
<br />
DANGER TERROR HORROR !!!!!!<br />
<br />
The task above has subsumed these two<br />
<br />
<div style="background-color: #f9f9f9; border: 1px solid black; padding: 1ex; margin-bottom: 2ex;"><br />
=== <u>Flag diacritics in lttoolbox</u> ===<br />
* '''Difficulty''':<br><span style="background-color: #efcdcd">1. Hard</span><br />
* '''Required skills''':<br>C++ or Java, XML, Knowledge of FSTs<br />
* '''Description''':<br>Adapt [[lttoolbox]] to elegantly use flag diacritics. Flag diacritics are a way of avoiding transducer size blow-up by discarding impossible paths at runtime as opposed to compile time. Some work has already been done, see [[Flag diacritics]].<br />
* '''Rationale''':<br>This will involve designing some changes to our XML dictionary format (see [[lttoolbox]], and implementing the associated changes in the FST compiling processing code. The reason behind this is that many languages have prefix inflection, and we cannot currently deal with this without either making paradigms useless, or overanalysing (e.g. returning analyses where none exist). Flag diacritics (or constraints) would allow us to restrict overanalysis without blowing up the size of our dictionaries.<br />
* '''Mentors''':<br>[[User:Francis Tyers|Francis Tyers]] (C++), [[User:Jacob Nordfalk|Jacob Nordfalk]] (Java)<br />
* '''[[/Flag diacritics in lttoolbox|read more...]]'''<br />
</div><br />
<br />
<br />
<div style="background-color: #f9f9f9; border: 1px solid black; padding: 1ex; margin-bottom: 2ex;"><br />
=== <u>Weights in lttoolbox</u> ===<br />
* '''Difficulty''':<br><span style="background-color: #cdefcd">2. Medium</span><br />
* '''Required skills''':<br>C++, XML, FSTs<br />
* '''Description''':<br>[[lttoolbox]] is a set of tools for building finite-state transducers. As part of Apertium's long-term strategy we would like to include probabilistic information into more stages of the pipeline to allow generic tools to be optimised for machine translation. This task involves adding the possibility of weighting lexemes and analyses in our finite-state transducer toolbox.<br />
* '''Rationale''':<br>Weighting information for lexical forms will be useful for morphological disambiguation, and for work on [[spellchecking]].<br />
* '''Mentors''':<br>[[User:Francis Tyers|Francis Tyers]], [[User:TommiPirinen|Tommi Pirinen]]<br />
* '''[[/Add weights to lttoolbox|read more...]]'''<br />
</div><br />
--><br />
<br />
<br />
<div style="background-color: #f9f9f9; border: 1px solid black; padding: 1ex; margin-bottom: 2ex;"><br />
<br />
=== <u>Robust recursive transfer</u> ===<br />
* '''Difficulty''':<br><span style="background-color: #efcdcd">1. Hard</span><br />
* '''Required skills''':<br>Python, XML, linguistics<br />
* '''Description''':<br>The purpose of this task would be to create a module to replace the apertium-transfer module(s) which will parse and allow transfer operations on an input.<br />
* '''Rationale''':<br>Currently we have a problem with very distantly related languages that have long-distance constituent reordering, because we can only do finite-state chunking.<br />
* '''Mentors''':<br>[[User:Francis Tyers|Francis Tyers]], [[User:Sortiz|Sortiz]], [[User:Mlforcada|Mikel Forcada]], [[User:Japerez|Juan Antonio Pérez]]<br />
* '''[[/Robust recursive transfer|read more...]]'''<br />
</div><br />
<br />
<div style="background-color: #f9f9f9; border: 1px solid black; padding: 1ex; margin-bottom: 2ex;"><br />
=== <u>Extend weighted transfer rules</u> ===<br />
* '''Difficulty''':<br><span style="background-color: #efcdcd">1. Hard</span><br />
* '''Required skills''':<br>Python, C++, linguistics<br />
* '''Description''':<br>The purpose of this task is to extend weighted transfer rules to all transfer files and to allow conflicting rule patterns to be handled by combining (lexicalised) weights.<br />
* '''Rationale''':<br>Currently our transfer rules are applied longest-match left-to-right ([[LRLM]]). When two rule patterns conflict the first one is chosen. We have a prototype for selecting based on lexicalised weights, but it only applies to the first stage of transfer.<br />
* '''Mentors''':<br>[[User:Francis Tyers|Francis Tyers]], [[User:TommiPirinen|Tommi Pirinen]], [[User:Sevilay Bayatlı|Sevilay Bayatlı]], [[User:Memduh|Memduh Gokirmak]]<br />
* '''[[/Weighted transfer rules|read more...]]'''<br />
</div><br />
<br />
<div style="background-color: #f9f9f9; border: 1px solid black; padding: 1ex; margin-bottom: 2ex;"><br />
<br />
=== <u>Improvements to the Apertium website</u> ===<br />
* '''Difficulty''':<br><span style="background-color: #cdcdef">3. Entry level</span><br />
* '''Required skills''':<br>Python, HTML, JS<br />
* '''Description''':<br>Our web site is pretty cool already, but it's missing things like dictionary/synonym lookup, support for several variants of one language, reliability visualisation, (reliable) webpage translation, feedback, etc.<br />
* '''Rationale''':<br>[https://apertium.org https://apertium.org] / [http://beta.apertium.org http://beta.apertium.org] is what most people know us by, it should show off more of the things we are capable of :-)<br />
* '''Mentors''':<br>[[User:Firespeaker|Jonathan]], [[User:Sushain|Sushain]]<br />
* '''[[/Apertium website improvements|read more...]]'''<br />
</div><br />
<br />
<div style="background-color: #f9f9f9; border: 1px solid black; padding: 1ex; margin-bottom: 2ex;"><br />
<br />
=== <u>User-friendly lexical selection training</u> ===<br />
* '''Difficulty''':<br><span style="background-color: #cdefcd">2. Medium</span><br />
* '''Required skills''':<br>Python, C++, shell scripting<br />
* '''Description''':<br>Make it so that training/inference of lexical selection rules is a more user-friendly process<br />
* '''Rationale''':<br>Our lexical selection module allows for inferring rules from corpora and word alignments, but the procedure is currently a bit messy, with various scripts involved that require lots of manual tweaking, and many third party tools to be installed. The goal of this task is to make the procedure as user-friendly as possible, so that ideally only a simple config file would be needed, and a driver script would take care of the rest.<br />
* '''Mentors''':<br>[[User:Unhammer|Unhammer]], [[User:Mlforcada|Mikel Forcada]]<br />
* '''[[/User-friendly lexical selection training|read more...]]'''<br />
</div><br />
<br />
<div style="background-color: #f9f9f9; border: 1px solid black; padding: 1ex; margin-bottom: 2ex;"><br />
<br />
=== <u>Light alternative format for all XML files in an Apertium language pair</u> ===<br />
* '''Difficulty''':<br><span style="background-color: #efcdcd">1. Hard</span><br />
* '''Required skills''':<br>Python, C++, shell scripting, XSLT, flex<br />
* '''Description''':<br>Make it possible to edit and develop language data using a format that is lighter than XML<br />
* '''Rationale''':<br>In most Apertium language pairs, monolingual dictionaries, bilingual dictionaries, post-generation rule files and structural transfer rule files are all written in XML. While XML is easy to process due to explicit tagging of every element, it is tedious to deal with, particularly when it comes to structural transfer rules. Apertium's precursor, interNOSTRUM, had lighter text based formats. The task involves: (a) designing and documenting an interNOSTRUM-style format for all of the XML language data files in a language pair; (b) writing converters to XML and from XML that are fully roundtrip-compliant: (c) designing a way to synchronize changes when both the XML and the non-XML format are used simultaneously in a specific language pair.<br />
* '''Mentors''':<br>[[User:Mlforcada|Mikel Forcada]], [[User:Japerez|Juan Antonio Pérez]], pair.<br />
* '''[[/Plain-text_formats_for_Apertium_data|read more...]]'''<br />
</div><br />
<br />
<!--<div style="background-color: #f9f9f9; border: 1px solid black; padding: 1ex; margin-bottom: 2ex;"><br />
=== <u>Eliminate dictionary trimming</u> ===<br />
* '''Difficulty''':<br><span style="background-color: #ffbdbd">0. Very Hard</span><br />
* '''Required skills''':<br>C++, Finite-State Transducers<br />
* '''Description''':<br>Eliminate the need for trimming the monolingual dictionaries, in order to preserve and take advantage of maximal source language analysis.<br />
* '''Rationale''':<br>[[Why we trim]] mentions several technical reasons for why trimming away monolingual information is currently needed. Unfortunately, this limitation means that a lot of useful contextual information is lost. It would be ideal if the source language could be fully analyzed independent of target language, with any untranslated part fed back into the source language generator.<br />
* '''Mentors''':<br> [[User:TommiPirinen|Tommi Pirinen a.k.a. Flammie]]<br />
* '''Work around everything in [[Why we trim]]'''<br />
</div>--><br />
<br />
<div style="background-color: #f9f9f9; border: 1px solid black; padding: 1ex; margin-bottom: 2ex;"><br />
<br />
=== <u>Bilingual dictionary enrichment via graph completion</u> ===<br />
* '''Difficulty''':<br><span style="background-color: #ffbdbd">0. Very hard</span><br />
* '''Required skills''':<br>shell scripting, python, XSLT, XML<br />
* '''Description''':<br>Generate new entries for existing or new bilingual dictionaries using graphic representations of bilingual correspondences as found in all existing dictionaries (note that this idea defines a rather open-ended task to be discussed in detail with mentors).<br />
* '''Rationale''':<br>Apertium bilingual dictionaries establish correspondences between lexical forms in a number of language pairs. Connections among them may be used to infer new entries for existing or new language pairs using graphs. The graphs may be directly generated from Apertium bidixes and exploiting using [[Bilingual_dictionary_discovery|ideas that had already been proposed in Apertium]] or using existing [http://linguistic.linkeddata.es/apertium/ RDF representations] of parts of their content, which may benefit from the information coming from being linked to other resources.<br />
* '''Mentors''':<br>[[User:Mlforcada|Mikel Forcada]], [[User:Francis Tyers|Francis Tyers]], [[User:Jorge Gracia|Jorge Gracia]]<br />
* '''[[Bilingual_dictionary_discovery|read more...]]''' '''[[/Bilingual_dictionary_enrichment_via_graph_completion|read even more...]]'''<br />
</div><br />
<br />
<!--<div style="background-color: #f9f9f9; border: 1px solid black; padding: 1ex; margin-bottom: 2ex;"><br />
<br />
=== <u>Transfer rule induction from comparable parsed corpora</u> ===<br />
* '''Difficulty''':<br><span style="background-color: #ffbdbd">1. Hard</span><br />
* '''Required skills''':<br>shell scripting, python, XSLT, XML<br />
* '''Description''':<br>A system to infer transfer rules from comparable corpora that have both been deeply parsed (with e.g. CG)<br />
* '''Rationale''':<br>Many languages have good CG's and fairly large monolingual corpora, but little parallel material. Given a small bidix, fairly large monolingual corpora and good analysers/CG's, we should be able to parse both corpora, translate lemmas and look for similar sentences, turning the differences in their parses into transfer rules. <br />
* '''Mentors''':<br>[[User:Unhammer]]<br />
* '''[[Transfer_induction_from_comparable_parsed_corpora|read more...]]''' <br />
</div>--><br />
<br />
<div style="background-color: #f9f9f9; border: 1px solid black; padding: 1ex; margin-bottom: 2ex;"><br />
<br />
=== <u>UD and Apertium integration</u> ===<br />
* '''Difficulty''':<br><span style="background-color: #cdcdef">3. Entry level</span><br />
* '''Required skills''':<br>python, javascript, HTML, (C++)<br />
* '''Description''':<br>Create a range of tools for making Apertium compatible with Universal Dependencies<br />
* '''Rationale''':<br>Universal dependencies is a fast growing project aimed at creating a unified annotation scheme for treebanks. This includes both part-of-speech and morphological features. Their annotated corpora could be extremely useful for Apertium for training models for translation. In addition, Apertium's rule-based morphological descriptions could be useful for software that relies on Universal dependencies.<br />
* '''Mentors''':<br>[[User:Francis Tyers]] [[User:Firespeaker]], [[User:Memduh|Memduh Gokirmak]]<br />
* '''[[/UD and Apertium integration|read more...]]''' <br />
</div><br />
<br />
<div style="background-color: #f9f9f9; border: 1px solid black; padding: 1ex; margin-bottom: 2ex;"><br />
<br />
=== <u>Add weights to lttoolbox</u> ===<br />
* '''Difficulty''':<br><span style="background-color: #ffbdbd">1. Hard</span><br />
* '''Required skills''':<br>c++<br />
* '''Description''':<br>Add support for weighted transducers to lttoolbox<br />
* '''Rationale''':<br>This will either involve implementing it from scratch or adding OpenFST as a backend. We would like to be able to use it both in the bilingual dictionaries, and in the morphological analysers, to be able to order analyses/translations by their probability/weight instead of by the random topological order. <br />
* '''Mentors''':<br>[[User:Francis Tyers]] [[User:Unhammer]]<br />
* '''[[/Add weights to lttoolbox|read more...]]''' <br />
</div><br />
<br />
<div style="background-color: #f9f9f9; border: 1px solid black; padding: 1ex; margin-bottom: 2ex;"><br />
<br />
=== <u>Improving language pairs mining Mediawiki Content Translation postedits</u> ===<br />
* '''Difficulty''':<br><span style="background-color: #ffbdbd">1. Hard</span><br />
* '''Required skills''':<br>Python, shell scripting, some statistics<br />
* '''Description''':<br>Implement a toolkit that allows mining existing machine translation postediting data in [Mediawiki Content Translation https://www.mediawiki.org/wiki/Content_translation] to generate (as automatically as possible, and as complete as possible) monodix and bidix entries to improve the performance of an Apertium language pair. Data is available from Wikimedia content translation through an [API https://www.mediawiki.org/wiki/Content_translation/Published_translations#API] or in the form of [Dumps https://dumps.wikimedia.org/other/contenttranslation/] available in JSON and TMX format. This project is rather experimental and involves some research in addition to coding.<br />
* '''Rationale''':<br>Apertium is used to generate new Wikipedia content: machine-translated content is postedited (and perhaps adapted) before publishing. Postediting information may contain information that can be used to help improve the lexical components of an Apertium language pair. <br />
* '''Mentors''':<br> [[User:Mlforcada|Mikel Forcada]], (more mentors to be added)<br />
* '''[[/automatic-postediting|read more...]]''' <br />
</div><br />
<br />
<br />
<div style="background-color: #f9f9f9; border: 1px solid black; padding: 1ex; margin-bottom: 2ex;"><br />
<br />
=== <u>Unsupervised weighting of automata</u> ===<br />
* '''Difficulty''':<br><span style="background-color: #cdefcd">2. Medium</span><br />
* '''Required skills''':<br>Python, shell scripting, statistics, finite-state transducers<br />
* '''Description''':<br>Implement a collection of methods for weighting finite-state transducers, the methods should include an implementation of a simple method of supervised training, and a number of methods for unsupervised training. The objective being to get the analysis ranking given a set of a analyses for a given surface form as close to the result given by supervised training as possible.<br />
* '''Rationale''':<br>Apertium struggles with ambiguity, we have had many attempts to write better part of speech taggers. This would complement those attempts by providing a generic method to weight automata.<br />
* '''Mentors''':<br> [[User:Francis Tyers|Francis Tyers]], [[User:TommiPirinen|Flammie]], [[User:Unhammer|Unhammer]]<br />
* '''[[/Unsupervised weighting of automata|read more...]]'''<br />
</div><br />
<br />
<div style="background-color: #f9f9f9; border: 1px solid black; padding: 1ex; margin-bottom: 2ex;"><br />
=== <u>Improvements to UD Annotatrix</u> ===<br />
* '''Difficulty''':<br><span style="background-color: #cdefcd">2. Medium</span><br />
* '''Required skills''':<br>JavaScript, Jquery, HTML, Python<br />
* '''Description''':<br>UD Annotatrix is an interface by Apertium for annotating dependency trees in CoNLL-U format. The system is currently in beta, but is getting traction as more people start using it.<br />
* '''Rationale''':<br>Universal Dependencies is a very widely used standard for annotating data, the kind of annotated data that can be used to train part of speech taggers. There is still a lot of work that could be done to improve it.<br />
* '''Mentors''':<br> [[User:Francis Tyers|Francis Tyers]], [[User:Firespeaker]]<br />
* '''[[/UD Annotatrix|read more...]]'''<br />
</div><br />
<br />
<div style="background-color: #f9f9f9; border: 1px solid black; padding: 1ex; margin-bottom: 2ex;"><br />
=== <u>apertium-separable language-pair integration</u> ===<br />
* '''Difficulty''':<br><span style="background-color: #cdefcd">2. Medium</span><br />
* '''Required skills''':<br>XML, a scripting language (Python, Perl), some knowledge of linguistics and/or at least one relevant natural language<br />
* '''Description''':<br>Choose a language you can identify as having a good number of "multiwords" in the lexicon. Modify all language pairs in Apertium to use the [[Apertium-separable]] module to process the multiwords, and clean up the dictionaries accordingly.<br />
* '''Rationale''':<br>Apertium-separable is a newly developed module to process lexical items with discontinguous dependencies, an area where Apertium has traditionally fallen short. Despite all the module has to offer, it has only been put to use in small test cases, and hasn't been integrated into any translation pair's development cycle.<br />
* '''Mentors''':<br> [[User:Francis Tyers|Francis Tyers]], [[User:Firespeaker]]<br />
* '''[[/Apertium separable|read more...]]'''<br />
</div><br />
<br />
{{IdeaSummary<br />
| name = Create FST-based module for disambiguating<br />
| difficulty = medium<br />
| skills = XML, a scripting language (Python, Perl), C++, finite-state transducers<br />
| description = Implement a [[Constraint Grammar]]-like module based on finite-state transducers.<br />
| rationale = Currently, many language pairs use [[Constraint grammar]] as a pre-disambiguator for the Apertium tagger, allowing the imposition of more fine grained constraints than would be otherwise possible. However, current implementation of CG is much slower than most of the other modules in the Apertium pipeline, and it's also very different in terms of syntax to other Apertium modules (dictionaries, lexical selection, transfer rules, etc). There have been a few attempts to create FST versions of CG (see [[User:David_Nemeskey/GSOC_progress_2013]]), but they haven't succeeded. The hypothesis is that a simpler version of CG that supports the main features that CG support (no need to feature parity) would have better adoption and integration within the Apertium pipeline.<br />
| mentors = [[User:Xavivars|Xavi Ivars]], [[User:Francis Tyers|Francis Tyers]]<br />
| more = /Apertium FST GC<br />
}}<br />
<br />
{{IdeaSummary<br />
| name = Python API/library for Apertium<br />
| difficulty = medium<br />
| skills = Python, C++, SWIG<br />
| description = Implement a Python library for Apertium and Lttoolbox.<br />
| rationale = Lots of people use Python, they like to use it in their Jupyter notebooks and on Microsoft Windows™. Apertium is really hard to get going in these kind of environments. So it would be cool if we could make Apertium work for them too. It has a lot of nice language processing tools that we would like more people to use. I'm sure people would love to "pip install apertium" or "pip install apertium-ava". The API/implementation should be pythonistic and should use C++ bindings to directly perform morphological functions, avoiding the overhead of a separate process. Prior GSoC project work is available on [https://github.com/apertium/apertium-python GitHub].<br />
| mentors = [[User:Sushain|Sushain]], [[User:Francis Tyers|Francis Tyers]], [[User:Unhammer|Unhammer]], [[User:Xavivars|Xavi Ivars]], [[User:Memduh|Memduh Gokirmak]]<br />
| more = /Python library<br />
}}<br />
<br />
{{IdeaSummary<br />
| name = TIPP functionality for Apertium<br />
| difficulty = medium<br />
| skills = Python, C++, XML, XLIFF (a subset called XLIFF:doc)<br />
| description = TIPP, the TMS Interoperability Protocol Package (where TMS means translation management system), [https://github.com/tingley/interoperability-now/blob/master/releases/tipp/1.5/The_TMS_Interoperability_Protocol_Package-1.5.pdf], currently in version 1.5 but being upgraded to 2.0, specifies a container (package format) that allows the interchange of information along a translation value chain. There are various container varieties for different tasks. One such variety, called Translate-Strict-Bitext, represents a bilingual translation job. The 'request' TIPP would contain an XLIFF:doc ([https://github.com/tingley/interoperability-now/tree/master/releases/xliffdoc/1.0.1], a subset of XLIFF 1 [http://docs.oasis-open.org/xliff/v1.2/os/xliff-core.html]) file with the document to be translated and the corresponding metadata, and the corresponding 'response' TIPP would contain the results of Apertium MT applied to it, but taking into account the translation memory provided in the TIPP, if any (using Apertium's -m switch). Apertium should be endowed with the capacity to manage TIPP packages: unpack the request package, parse it, process it, and repack it.<br />
| mentors = [[User:Mlforcada|Mikel Forcada]]<br />
| more = /Apertium_TIPP<br />
}}<br />
<br />
<br />
{{IdeaSummary<br />
| name = Bring Apertium Occitan--French closer to posteditable quality.<br />
| difficulty = medium<br />
| skills = GNU/Linux advanced user, bash, git, XML editing, standard Occitan, French.<br />
| description = The idea is to make Occitan output easier to postedit and French output easier to understand. This entails increasing the monolingual and bilingual dictionaries, improving disambiguation, and writing new structural transfer rules.<br />
| rationale = The [https://github.com/apertium/apertium-oci-fra Occitan--French language pair] has been recently published. This language pair is of strategic importance for the Occitan language, as Apertium offers the only machine translation system for this language pair. <br />
| mentors = [[User:Mlforcada|Mikel Forcada]], [[User:Memduh|Memduh Gokirmak]], mentors welcome.<br />
| more = /Apertium_Occitan_French<br />
}}<br />
<br />
<br />
<br />
<br />
{{IdeaSummary<br />
| name = Create a usable version of one of these language pairs: English--Igbo, English--Yoruba, English--Tigrinya, English--Swahili, English-Hausa<br />
| difficulty = medium<br />
| skills = GNU/Linux advanced user, bash, git, XML editing, English, Igbo/Yoruba/Tigrinya/Swahili/Hausa<br />
| description = The objective is to start these language pairs (which haven't been started or have currentlu very little data in Apertium) and write an usable version which provides intelligible output.<br />
| rationale = African languages are not particularly well served by Apertium. The four languages listed are quite important, and are only currently served by commercial machine translation companies such as Google, which makes these language communities dependent on a specific commercial provider.<br />
| mentors = [[User:Mlforcada|Mikel Forcada]], [[User:Memduh|Memduh Gokirmak]], mentors welcome.<br />
| more = /Apertium_African<br />
}}<br />
<br />
{{IdeaSummary<br />
| name = Set up gap-filling machine-translation-for-gisting evaluation on a recent version of Appraise<br />
| difficulty = hard<br />
| skills = python, bash, git, XML editing.<br />
| description = [http://github.com/mlforcada/Appraise http://github.com/mlforcada/Appraise], in turn forked from [http://github.com/mlforcada/Appraise http://github.com/mlforcada/Appraise], the work of a GSoC student, contains an adaptation of an old (2014) version of [http://github.com/cfedermann/Appraise http://github.com/cfedermann/Appraise] to implement gap-filling evaluation as described in [https://export.arxiv.org/pdf/1809.00315 this WMT2018 paper]. The objective is to bring the gap-filling functionality in [http://github.com/mlforcada/Appraise] to be compatible with the latest versions of Appraise.<br />
| rationale = Many language pairs in Apertium are unique, such as Breton-French, and many of them are used for gisting (understanding) purposes. Gap-filling provides a simple way to evaluate the usefulness of machine translation for gisting. The implementation used in recent experiments is based on an outdated version of the Appraise platform. <br />
| mentors = [[User:Mlforcada|Mikel Forcada]], mentors welcome.<br />
| more = /Appraise_gisting<br />
}}<br />
<br />
{{IdeaSummary<br />
| name = A Web Interface to expanding dictionary lemmas integrate with GitLab/GitHub<br />
| difficulty = hard<br />
| skills = java, git, XML, nodeJs, Angular 8.<br />
| description = Given that Apertium has a few dozen contributors and thousands of users, we propose a web graphical user interface (GUI) that enables the lay users to contribute to the expansion of the dictionaries that makeup the knowledge base of Apertium. <br />
The main premise of the solution is that users with minimal knowledge of thelanguage can contribute easily and that it must be integrated with the currentform of development of expert users.<br />
| rationale = . <br />
| mentors = [[User:Alessio|Aléssio Jr.]], mentors welcome.<br />
| more = /Easy_dictionary_maintenance<br />
}}<br />
<br />
<br />
<br />
[[Category:Development]]<br />
[[Category:Google Summer of Code]]</div>Alessiohttps://wiki.apertium.org/w/index.php?title=Web_Dictionary_Maintenance&diff=69399Web Dictionary Maintenance2019-04-06T21:41:43Z<p>Alessio: /* Components ans Technologies */</p>
<hr />
<div>{{TOCD}}<br />
<br />
[https://translate.google.com/translate?sl=en&tl=pt-br&prev=_t&hl=en&u=http://wiki.apertium.org/wiki/Web_Dictionary_Maintenance Translate to PT-BR with Google Tradução]<br />
<br />
= Introduction =<br />
<br />
Apertium over the years still has deficiencies so that lay people can contribute to increase the base of words in dictionaries, even with simple contributions. Collaboration is the key to developing a tool that serves a huge range of users throughout the world. We believe that it is possible to engage more users and thus give greater impact to the tool within the communities where there is involvement. We will deal in this document with requirements on non-functional and technical objectives regarding the tool proposal.<br />
<br />
;Original Ideias<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code/Easy_dictionary_maintenance<br />
<br />
;Original GSOC2019 Application<br />
: http://wiki.apertium.org/wiki/User:Alessiojr/Easy_dictionary_-_Application-GSOC2019<br />
<br />
;Studant Information<br />
: '''Student:''' Vinícius Silva Nogueira <br /><br />
: '''Unofficial Mentor:''' Alessio Miranda Junior<br /><br />
: '''Telegram/Whatsapp:''' Alessio: +55 (31) 9.8888-7770<br /><br />
: '''E-mail:''' alessio@cefetmg.br or vinicius_snogueira@hotmail.com / viniciussnogueira13@gmail.com<br /><br />
: '''IRC:''' viniciussn or AlessioJr<br /><br />
: '''GTalk:''' alessiojunin@gmail.com<br />
<br />
=Description=<br />
==Abstract:==<br />
The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps away potential contributors. A tool that facilitates the work of dictionaries developers, eliminate computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
Even with several tools that help the way you manage and create dictionaries, Apertium is far from the normal users, who have a huge contribution potential. Or even create a simple way to create contributions to recurring users with advanced knowledge. Although it is a bold plan, and there are several possible and desirable requirements, we will describe some basic premises for this step and that must be respected and aligned with the apertium developer community.<br />
<br />
==Definitions==<br />
:* Lay users do not need to know Apertium's internal structure.<br />
:* Intermediate users need to have a knowledge of dictionary management methodology. <br />
:* Advanced users are those who know the structure of Apertium.<br />
:* Communities are user groups that merge characteristics to the database extension of a dictionary of a specific language.<br />
:* Official dictionaries are dictionaries managed and with seal of the apertium community.<br />
:* Unofficial dictionaries are dictionaries run by an independent community.<br />
:* Test dictionaries are deprived of users to test their contributions.<br />
<br />
==Objectives:==<br />
:* The major goal of the project is to develop a web tool to facilitate the management of the Apertium (XML's) database of integrators for novice and advanced users.<br />
:* New communities of contributions should be able to organize independently of a central command. The command exists but will be distributed.<br />
:* Lay users who feel motivated to contribute, should have an interface that promotes ease in contributing even with limited possibilities.<br />
:* The development of dictionaries should be collaborative and distributed. Each dictionary should have a management community, but a user may have the freedom to disagree and create a new version maintaining a history of the author.<br />
:* Any tool should maintain the traditional Apertium structure and not be interoperable between existing tools.<br />
:* There must be a methodology for communities to maintain the quality of their dictionaries. Although they are distributed the goal is to create a unified and mature dictionary.<br />
<br />
==Questions:==<br />
:* Dixtools is available? Problems?<br />
:* Any Problem to use Gitlab (OpenSource) Like projetos.a2portais.com.br or gitlab<br />
:* Gitlab api? free version?<br />
<br />
=Technical Objectives:=<br />
:* Develop, initially, monolingual dictionaries but keeping the particular format of each file.<br />
:* Minimize the direct manipulation of XML files, providing features that reduce this need.<br />
:* Making use of GitLab as an administrative and control tool.<br />
<br />
== Git, GitLab and Apertium ==<br />
[[File:Git_flow_demonstration.jpg|thumb|250px|right|Git Flow demonstration]]<br />
As the Apertium files are textual, we had the idea of seeking productivity and using existing and consolidated tools in the world.<br />
The proposal is to create a friendly web interface for lay users, but use git's Back-End as version control and do dictionary management in GitLab as it is an administrative tool that already guarantees incredible power for remote collaboration.<br />
<br />
To demonstrate this relationship we will highlight some concepts of Git. Over time there may be several TimeLines:<br />
:* The Official Branch (Master) has the official version of the apertium managed by official developers or maintainers.<br />
:* Users have the power to create new Branches and develop unofficial dictionaries in parallel, creating communities that may from time to time suggest modifications to Brach Master.<br />
:* These requests can be accepted or rejected by maintainers, and this format is recursive and other developers can create unofficial copies of unofficial ones.<br />
:* Integration requests will use the Merge Request concepts present in tools such as GitLab that will be the BackEnd for advanced users.<br />
<br />
=Application-GSOC2019=<br />
===Abstract:===<br />
The idea is to develop the Web tool so that lay users contribute to dictionaries and use Git management with GitLab to manage these changes.<br />
* The focus will be on monolingual dictionaries and bilingual direct relationships.<br />
* Use the Git methodology and propose a guideline or flow for collaborative dictionary management.<br />
* Do not change the current XML format of dictionaries.<br />
<br />
===Why is it you are interested in machine translation and Apertium?===<br />
<br />
During the graduation course, Professor Aléssio demonstrated the need and opportunity to contribute with open source projects. <br />
He introduced me to Apertium and in my final graduation work I started reading and talking about it. <br />
We started discussing techniques for managing collaboration with the community and currently do not have <br />
as much knowledge about machine translation machines but I have experience in developing applications <br />
and web using collaboration with Git and GitLab.<br />
<br />
===Which of the published tasks are you interested in?===<br />
<br />
[http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code/Easy_dictionary_maintenance Easy dictionary maintenance]<br />
<br />
===Why should Google and Apertium sponsor it?===<br />
<br />
This project will have an impact in all languages. Facilitating dictionary manipulation will benefit everyone,<br />
allowing a wider range of people to contribute to existing dictionaries and start new language projects.<br />
<br />
===How and who will it benefit in society?===<br />
This application will benefit the entire Apertium community.<br />
Dictionary developers will have a tool to speed up their work and an easy-to-use tool will attract new contributors.<br />
As a result, Apertium's translation capacity will be increased, bringing better results to the end user.<br />
<br />
===What do you plan to do?===<br />
We are planning to create a web GUI that will facilitate common tasks of creating/modifying dictionaries and allow lay users to contribute to a dictionary.<br />
The application will be connected to a Git repository, which will be used as an administrative and version control tool.<br />
<br />
<br />
<br />
'''Program Language:''' Java, JavaScript<br /><br />
'''Persistence:''' XML (Apertium XML Files)<br /><br />
'''Framworks:''' Angular<br /><br />
<br />
===Stages/Milestones===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Week<br />
! Stage<br />
! Description<br />
|-<br />
| Community Bonding Period<br />
| Technology analysis<br />
|Analyze and find a good way to manipulate XML in a database.<br />
Testing and choosing the best alternative.<br />
<br />
UML diagrams of the project.<br />
|-<br />
| 1, 2<br />
| --<br />
|Database modeling and creation.<br />
<br />
Implementation of GitConnector.<br />
<br />
|-<br />
| 2, 3<br />
| --<br />
| WebAPI development.<br />
<br />
GUI prototype developement for monolingual dictionary: Symbols, Paradigms and Lemmas.<br />
|-<br />
| 3, 4<br />
| --<br />
| GUI prototype developement for bilingual dictionary.<br />
|-<br />
| '''Prototype'''<br />
| Milestone 1<br />
| First version of GUI for community analysis.<br />
|-<br />
| 5, 6<br />
| --<br />
| Development of WebDictionaryController (monolingual and bilingual dictionary).<br />
|-<br />
| 7, 8<br />
| --<br />
| Adjustments and adding new features with community feedback.<br />
|-<br />
| 9<br />
| --<br />
| Functionalities integrations, test and fixes.<br />
|-<br />
| '''Prototype'''<br />
| Milestone 2<br />
| First functional release for community analysis.<br />
|-<br />
| 10, 11<br />
| --<br />
| Adjustments and adding new features with community feedback.<br />
|-<br />
| 12<br />
| Pré-Release<br />
| Fix remain bugs, final adjustments and documentation in Wiki<br />
|-<br />
| <br />
| '''Final Release'''<br />
|Final version realease.<br />
|}<br />
<br />
===Presentation===<br />
<br />
My name is Vinicius, a Brazilian Student at Federal Center for Technological Education of Minas Gerais - Brazil.<br />
<br />
===Resume of Skills===<br />
<br />
Apertium Knowledge:<br />
<br />
* Study to develop a collaborative tool for apertium.<br />
* A study of actual Apertium process about creating a language pair by the user point of view.<br />
* Analysis of the characteristics of the 2010 project of Aléssio and adaptation to current times.<br />
<br />
Academic Skills:<br />
<br />
* Graduating in Computer Engineering- Federal Center for Technological Education of Minas Gerais – Brazil<br />
<br />
Professional Skills:<br />
<br />
* Language developer: C, Java, JavaScript, PHP, Phyton, PL/SQL.<br />
<br />
Projects for Summer:<br />
<br />
* No professional activities planned.<br />
* Planning to work in GSOC<br />
<br />
=Project=<br />
==Why?==<br />
:* The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps potential contributors away. A tool that facilitates the work of dictionaries developers, eliminate the need of computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
==What its the plan?==<br />
:* We are planning to create a web GUI that allows the user to develop the basic tasks of dictionaries and translation pairs manipulation in an easy and practical way.<br />
:* We will use Git as an administrative and control tool, allowing the user to contribute to the work of other community members or start your own project.<br />
<br />
==Components ans Technologies==<br />
[[File:ComponentDiagramWebDictionary.jpg|thumb|700px|right|Components Diagram]]<br />
* Actors<br />
** Lay User <br />
** Dictionary Admin <br />
<br />
* UserBrowser <br />
** WebInterface with AngularJS - GUI to easily manipulate the dictionary XML file.<br />
<br />
* Web Dicionary Maintence (APP)<br />
** WebAPI - Interface between user's GUI and server. See: [LINK]<br />
***<br />
** Temporary Database - Temporary database in which the XML file will be loaded with the crosses made.<br />
** JavaGit Connector - API to execute necessary Git functions.<br />
** WebDictionary Controller <br />
<br />
* Git <br />
** GitRepository - Repository containing the dictionaries<br />
** GitLab - Repository management tool<br />
** GitHub - Repository management tool<br />
<br />
[[File:SequenceDiagramWebDictionary.jpg|thumb|700px|right|Components Diagram]]<br />
<br />
==How it Works?==<br />
We will develop a WebInterface to lay users add words or suggest modifications.<br />
We are planning to use Git as an administrative and version control tool.<br />
<br />
* All dictionaries releases will be in a single repository and available to any member of the community to continue the work.<br />
* Each user will have your own branch to work on.<br />
* The users will be able to make merge requests with the official branch.<br />
* At first, we will use GitLab (or similar tool) to manage this merges requests. The team who maintain each dictionary will judge if the modifications are valid or not.<br />
<br />
=Example of Interaction - Adding new lemma to a dictionary=<br />
<br /><br />
<br /><br />
<br /><br />
<br /><br />
{| class="wikitable" border="1"<br />
|-<br />
! Stage<br />
! Description<br />
! Image<br />
|-<br />
| 1<br />
| ''' Choosing an official dictionary and importing it ''' <br />
The Official Dictionaries page display all available dictionaries in the git repository. <br />
<br />
Each version correspond to a tag in the master branch. <br />
<br />
Once imported, the user will name this dictionary and it will appear on the My Dictionaries page.<br />
| [[File:Prototype1.png|thumb|600px|center|Choosing an official dictionary and importing it]] <br />
[[File:Git1.png|thumb|600px|center|Master branch]]<br />
[[File:Prototype2.png|thumb|600px|center|My Dictionaries page]]<br />
|-<br />
| 2<br />
| ''' Loading the dictionary file ''' , <br />
On the Language File page, the user selects one of their dictionaries and the dictionary XML will be formatted to be temporarily saved to a database. Also on this page, the user can edit the dictionary alphabet and see some statistics about it.<br />
The Symbols, Paradigms, and Lemmas pages refer to the dictionary selected here.<br />
| [[File:Prototype3.png|thumb|600px|center|Loading the dictionary file]] <br />
|-<br />
| 3<br />
| '''Verifying if the lemmas already exists''' <br />
On the Lemmas - Search page, the user will be able to see all the inflections of the dictionary lemmas and check if the lemma he wants to add already exists.<br />
| [[File:Prototype4.png|thumb|600px|center|Verifying if the lemmas already exists]]<br />
|-<br />
| 4.1<br />
| ''' Creating the new lemma - Step 1 ''' <br />
In the Lemmas - Create page, the user will follow three steps to add a new lemma.<br />
<br />
In the first step, the user will define the lemma and the lemma root. In addition, he will give some examples of inflections and symbols to receive suggestions on which paradigm to use.<br />
| [[File:Prototype5.png|thumb|600px|center|text-top|Creating the new lemma - Step 1]]<br />
|-<br />
| 4.2<br />
| ''' Creating the new lemma - Step 2 ''' <br />
<br />
In the second step, the user will see paradigm suggestions (or can see all paradigms). When a paradigm is selected, all inflections of the created lemma will be shown to the user. If none of the paradigms fit, the user will be directed to create a new paradigm. <br />
| [[File:Prototype6.png|thumb|600px|center|Creating the new lemma - Step 2]]<br />
|-<br />
| 4.3<br />
| ''' Creating the new lemma - Step 3 ''' <br />
<br />
In the third and last step, the user will confirm and save the change. At this point, a branch will be create for this dictionary in the git repository (if she doesn’t already exists) and a commit with this changes will be done. <br />
| [[File:Prototype7.png|thumb|600px|right|Creating the new lemma - Step 3]]<br />
[[File:Git2.png|thumb|600px|center|New branch created in Git]]<br />
|-<br />
| 5<br />
| '''Merge Request''' <br />
<br />
On My Dictionaries page, the user can create a merge request that will be judge by the master branch maintainer.<br />
<br />
| [[File:Prototype8.png|thumb|600px|center|Merge Request]]<br />
|-<br />
| 6<br />
| '''Official dictionary keeper judges the merge request'''<br />
In GitLab (or similar tool), the dictionary maintainer will see the list of merge requests.<br />
<br />
At each request, the maintainer can view all commits and accepts only a few of them.<br />
<br />
At each commit, he will judge the changes.<br />
<br />
When he accepts the merge request, the user's branch is deleted.<br />
<br />
|[[File:Git5.png|thumb|600px|center|Merge request list]]<br />
<br />
[[File:Git6.png|thumb|600px|center|Commits from current merge request]]<br />
<br />
[[File:Git7.png|thumb|600px|center|Changes]]<br />
<br />
[[File:Git4.png|thumb|600px|center|GitLab Graph]]<br />
|-<br />
| 7<br />
| '''Feedback''' <br />
<br />
On Merge Requests page, the user can see all request he have made and their status.<br />
| [[File:Prototype9.png|thumb|600px|center|Feedback]]<br />
|-<br />
| <br />
| '''Final Release'''<br />
|<br />
|}<br />
<br />
[[Category:GSoC 2019 student proposals]]</div>Alessiohttps://wiki.apertium.org/w/index.php?title=Web_Dictionary_Maintenance&diff=69396Web Dictionary Maintenance2019-04-06T20:23:11Z<p>Alessio: /* Components ans Technologies */</p>
<hr />
<div>{{TOCD}}<br />
<br />
[https://translate.google.com/translate?sl=en&tl=pt-br&prev=_t&hl=en&u=http://wiki.apertium.org/wiki/Web_Dictionary_Maintenance Translate to PT-BR with Google Tradução]<br />
<br />
= Introduction =<br />
<br />
Apertium over the years still has deficiencies so that lay people can contribute to increase the base of words in dictionaries, even with simple contributions. Collaboration is the key to developing a tool that serves a huge range of users throughout the world. We believe that it is possible to engage more users and thus give greater impact to the tool within the communities where there is involvement. We will deal in this document with requirements on non-functional and technical objectives regarding the tool proposal.<br />
<br />
;Original Ideias<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code/Easy_dictionary_maintenance<br />
<br />
;Original GSOC2019 Application<br />
: http://wiki.apertium.org/wiki/User:Alessiojr/Easy_dictionary_-_Application-GSOC2019<br />
<br />
;Studant Information<br />
: '''Student:''' Vinícius Silva Nogueira <br /><br />
: '''Unofficial Mentor:''' Alessio Miranda Junior<br /><br />
: '''Telegram/Whatsapp:''' Alessio: +55 (31) 9.8888-7770<br /><br />
: '''E-mail:''' alessio@cefetmg.br or vinicius_snogueira@hotmail.com / viniciussnogueira13@gmail.com<br /><br />
: '''IRC:''' viniciussn or AlessioJr<br /><br />
: '''GTalk:''' alessiojunin@gmail.com<br />
<br />
=Description=<br />
==Abstract:==<br />
The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps away potential contributors. A tool that facilitates the work of dictionaries developers, eliminate computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
Even with several tools that help the way you manage and create dictionaries, Apertium is far from the normal users, who have a huge contribution potential. Or even create a simple way to create contributions to recurring users with advanced knowledge. Although it is a bold plan, and there are several possible and desirable requirements, we will describe some basic premises for this step and that must be respected and aligned with the apertium developer community.<br />
<br />
==Definitions==<br />
:* Lay users do not need to know Apertium's internal structure.<br />
:* Intermediate users need to have a knowledge of dictionary management methodology. <br />
:* Advanced users are those who know the structure of Apertium.<br />
:* Communities are user groups that merge characteristics to the database extension of a dictionary of a specific language.<br />
:* Official dictionaries are dictionaries managed and with seal of the apertium community.<br />
:* Unofficial dictionaries are dictionaries run by an independent community.<br />
:* Test dictionaries are deprived of users to test their contributions.<br />
<br />
==Objectives:==<br />
:* The major goal of the project is to develop a web tool to facilitate the management of the Apertium (XML's) database of integrators for novice and advanced users.<br />
:* New communities of contributions should be able to organize independently of a central command. The command exists but will be distributed.<br />
:* Lay users who feel motivated to contribute, should have an interface that promotes ease in contributing even with limited possibilities.<br />
:* The development of dictionaries should be collaborative and distributed. Each dictionary should have a management community, but a user may have the freedom to disagree and create a new version maintaining a history of the author.<br />
:* Any tool should maintain the traditional Apertium structure and not be interoperable between existing tools.<br />
:* There must be a methodology for communities to maintain the quality of their dictionaries. Although they are distributed the goal is to create a unified and mature dictionary.<br />
<br />
==Questions:==<br />
:* Dixtools is available? Problems?<br />
:* Any Problem to use Gitlab (OpenSource) Like projetos.a2portais.com.br or gitlab<br />
:* Gitlab api? free version?<br />
<br />
=Technical Objectives:=<br />
:* Develop, initially, monolingual dictionaries but keeping the particular format of each file.<br />
:* Minimize the direct manipulation of XML files, providing features that reduce this need.<br />
:* Making use of GitLab as an administrative and control tool.<br />
<br />
== Git, GitLab and Apertium ==<br />
[[File:Git_flow_demonstration.jpg|thumb|250px|right|Git Flow demonstration]]<br />
As the Apertium files are textual, we had the idea of seeking productivity and using existing and consolidated tools in the world.<br />
The proposal is to create a friendly web interface for lay users, but use git's Back-End as version control and do dictionary management in GitLab as it is an administrative tool that already guarantees incredible power for remote collaboration.<br />
<br />
To demonstrate this relationship we will highlight some concepts of Git. Over time there may be several TimeLines:<br />
:* The Official Branch (Master) has the official version of the apertium managed by official developers or maintainers.<br />
:* Users have the power to create new Branches and develop unofficial dictionaries in parallel, creating communities that may from time to time suggest modifications to Brach Master.<br />
:* These requests can be accepted or rejected by maintainers, and this format is recursive and other developers can create unofficial copies of unofficial ones.<br />
:* Integration requests will use the Merge Request concepts present in tools such as GitLab that will be the BackEnd for advanced users.<br />
<br />
=Application-GSOC2019=<br />
===Abstract:===<br />
The idea is to develop the Web tool so that lay users contribute to dictionaries and use Git management with GitLab to manage these changes.<br />
* The focus will be on monolingual dictionaries and bilingual direct relationships.<br />
* Use the Git methodology and propose a guideline or flow for collaborative dictionary management.<br />
* Do not change the current XML format of dictionaries.<br />
<br />
===Why is it you are interested in machine translation and Apertium?===<br />
<br />
During the graduation course, Professor Aléssio demonstrated the need and opportunity to contribute with open source projects. <br />
He introduced me to Apertium and in my final graduation work I started reading and talking about it. <br />
We started discussing techniques for managing collaboration with the community and currently do not have <br />
as much knowledge about machine translation machines but I have experience in developing applications <br />
and web using collaboration with Git and GitLab.<br />
<br />
===Which of the published tasks are you interested in?===<br />
<br />
[http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code/Easy_dictionary_maintenance Easy dictionary maintenance]<br />
<br />
===Why should Google and Apertium sponsor it?===<br />
<br />
This project will have an impact in all languages. Facilitating dictionary manipulation will benefit everyone,<br />
allowing a wider range of people to contribute to existing dictionaries and start new language projects.<br />
<br />
===How and who will it benefit in society?===<br />
This application will benefit the entire Apertium community.<br />
Dictionary developers will have a tool to speed up their work and an easy-to-use tool will attract new contributors.<br />
As a result, Apertium's translation capacity will be increased, bringing better results to the end user.<br />
<br />
===What do you plan to do?===<br />
We are planning to create a web GUI that will facilitate common tasks of creating/modifying dictionaries and allow lay users to contribute to a dictionary.<br />
The application will be connected to a Git repository, which will be used as an administrative and version control tool.<br />
<br />
<br />
<br />
'''Program Language:''' Java, JavaScript<br /><br />
'''Persistence:''' XML (Apertium XML Files)<br /><br />
'''Framworks:''' Angular<br /><br />
<br />
===Stages/Milestones===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Week<br />
! Stage<br />
! Description<br />
|-<br />
| Community Bonding Period<br />
| Technology analysis<br />
|Analyze and find a good way to manipulate XML in a database.<br />
Testing and choosing the best alternative.<br />
<br />
UML diagrams of the project.<br />
|-<br />
| 1, 2<br />
| --<br />
|Database modeling and creation.<br />
<br />
Implementation of GitConnector.<br />
<br />
|-<br />
| 2, 3<br />
| --<br />
| WebAPI development.<br />
<br />
GUI prototype developement for monolingual dictionary: Symbols, Paradigms and Lemmas.<br />
|-<br />
| 3, 4<br />
| --<br />
| GUI prototype developement for bilingual dictionary.<br />
|-<br />
| '''Prototype'''<br />
| Milestone 1<br />
| First version of GUI for community analysis.<br />
|-<br />
| 5, 6<br />
| --<br />
| Development of WebDictionaryController (monolingual and bilingual dictionary).<br />
|-<br />
| 7, 8<br />
| --<br />
| Adjustments and adding new features with community feedback.<br />
|-<br />
| 9<br />
| --<br />
| Functionalities integrations, test and fixes.<br />
|-<br />
| '''Prototype'''<br />
| Milestone 2<br />
| First functional release for community analysis.<br />
|-<br />
| 10, 11<br />
| --<br />
| Adjustments and adding new features with community feedback.<br />
|-<br />
| 12<br />
| Pré-Release<br />
| Fix remain bugs, final adjustments and documentation in Wiki<br />
|-<br />
| <br />
| '''Final Release'''<br />
|Final version realease.<br />
|}<br />
<br />
===Presentation===<br />
<br />
My name is Vinicius, a Brazilian Student at Federal Center for Technological Education of Minas Gerais - Brazil.<br />
<br />
===Resume of Skills===<br />
<br />
Apertium Knowledge:<br />
<br />
* Study to develop a collaborative tool for apertium.<br />
* A study of actual Apertium process about creating a language pair by the user point of view.<br />
* Analysis of the characteristics of the 2010 project of Aléssio and adaptation to current times.<br />
<br />
Academic Skills:<br />
<br />
* Graduating in Computer Engineering- Federal Center for Technological Education of Minas Gerais – Brazil<br />
<br />
Professional Skills:<br />
<br />
* Language developer: C, Java, JavaScript, PHP, Phyton, PL/SQL.<br />
<br />
Projects for Summer:<br />
<br />
* No professional activities planned.<br />
* Planning to work in GSOC<br />
<br />
=Project=<br />
==Why?==<br />
:* The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps potential contributors away. A tool that facilitates the work of dictionaries developers, eliminate the need of computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
==What its the plan?==<br />
:* We are planning to create a web GUI that allows the user to develop the basic tasks of dictionaries and translation pairs manipulation in an easy and practical way.<br />
:* We will use Git as an administrative and control tool, allowing the user to contribute to the work of other community members or start your own project.<br />
<br />
==Components ans Technologies==<br />
[[File:ComponentDiagramWebDictionary.jpg|thumb|700px|right|Components Diagram]]<br />
* Actors<br />
** Lay User <br />
** Dictionary Admin <br />
<br />
* UserBrowser <br />
** WebInterface with AngularJS - GUI to easily manipulate the dictionary XML file.<br />
<br />
* Web Dicionary Maintence (APP)<br />
** WebAPI - Interface between user's GUI and server. See: [LINK]<br />
** Temporary Database - Temporary database in which the XML file will be loaded with the crosses made.<br />
** JavaGit Connector - API to execute necessary Git functions.<br />
** WebDictionary Controller <br />
<br />
* Git <br />
** GitRepository - Repository containing the dictionaries<br />
** GitLab - Repository management tool<br />
** GitHub - Repository management tool<br />
<br />
[[File:SequenceDiagramWebDictionary.jpg|thumb|700px|right|Components Diagram]]<br />
<br />
==How it Works?==<br />
We will develop a WebInterface to lay users add words or suggest modifications.<br />
We are planning to use Git as an administrative and version control tool.<br />
<br />
* All dictionaries releases will be in a single repository and available to any member of the community to continue the work.<br />
* Each user will have your own branch to work on.<br />
* The users will be able to make merge requests with the official branch.<br />
* At first, we will use GitLab (or similar tool) to manage this merges requests. The team who maintain each dictionary will judge if the modifications are valid or not.<br />
<br />
=Example of Interaction - Adding new lemma to a dictionary=<br />
<br /><br />
<br /><br />
<br /><br />
<br /><br />
{| class="wikitable" border="1"<br />
|-<br />
! Stage<br />
! Description<br />
! Image<br />
|-<br />
| 1<br />
| ''' Choosing an official dictionary and importing it ''' <br />
The Official Dictionaries page display all available dictionaries in the git repository. <br />
<br />
Each version correspond to a tag in the master branch. <br />
<br />
Once imported, the user will name this dictionary and it will appear on the My Dictionaries page.<br />
| [[File:Prototype1.png|thumb|600px|center|Choosing an official dictionary and importing it]] <br />
[[File:Git1.png|thumb|600px|center|Master branch]]<br />
[[File:Prototype2.png|thumb|600px|center|My Dictionaries page]]<br />
|-<br />
| 2<br />
| ''' Loading the dictionary file ''' , <br />
On the Language File page, the user selects one of their dictionaries and the dictionary XML will be formatted to be temporarily saved to a database. Also on this page, the user can edit the dictionary alphabet and see some statistics about it.<br />
The Symbols, Paradigms, and Lemmas pages refer to the dictionary selected here.<br />
| [[File:Prototype3.png|thumb|600px|center|Loading the dictionary file]] <br />
|-<br />
| 3<br />
| '''Verifying if the lemmas already exists''' <br />
On the Lemmas - Search page, the user will be able to see all the inflections of the dictionary lemmas and check if the lemma he wants to add already exists.<br />
| [[File:Prototype4.png|thumb|600px|center|Verifying if the lemmas already exists]]<br />
|-<br />
| 4.1<br />
| ''' Creating the new lemma - Step 1 ''' <br />
In the Lemmas - Create page, the user will follow three steps to add a new lemma.<br />
<br />
In the first step, the user will define the lemma and the lemma root. In addition, he will give some examples of inflections and symbols to receive suggestions on which paradigm to use.<br />
| [[File:Prototype5.png|thumb|600px|center|text-top|Creating the new lemma - Step 1]]<br />
|-<br />
| 4.2<br />
| ''' Creating the new lemma - Step 2 ''' <br />
<br />
In the second step, the user will see paradigm suggestions (or can see all paradigms). When a paradigm is selected, all inflections of the created lemma will be shown to the user. If none of the paradigms fit, the user will be directed to create a new paradigm. <br />
| [[File:Prototype6.png|thumb|600px|center|Creating the new lemma - Step 2]]<br />
|-<br />
| 4.3<br />
| ''' Creating the new lemma - Step 3 ''' <br />
<br />
In the third and last step, the user will confirm and save the change. At this point, a branch will be create for this dictionary in the git repository (if she doesn’t already exists) and a commit with this changes will be done. <br />
| [[File:Prototype7.png|thumb|600px|right|Creating the new lemma - Step 3]]<br />
[[File:Git2.png|thumb|600px|center|New branch created in Git]]<br />
|-<br />
| 5<br />
| '''Merge Request''' <br />
<br />
On My Dictionaries page, the user can create a merge request that will be judge by the master branch maintainer.<br />
<br />
| [[File:Prototype8.png|thumb|600px|center|Merge Request]]<br />
|-<br />
| 6<br />
| '''Official dictionary keeper judges the merge request'''<br />
In GitLab (or similar tool), the dictionary maintainer will see the list of merge requests.<br />
<br />
At each request, the maintainer can view all commits and accepts only a few of them.<br />
<br />
At each commit, he will judge the changes.<br />
<br />
When he accepts the merge request, the user's branch is deleted.<br />
<br />
|[[File:Git5.png|thumb|600px|center|Merge request list]]<br />
<br />
[[File:Git6.png|thumb|600px|center|Commits from current merge request]]<br />
<br />
[[File:Git7.png|thumb|600px|center|Changes]]<br />
<br />
[[File:Git4.png|thumb|600px|center|GitLab Graph]]<br />
|-<br />
| 7<br />
| '''Feedback''' <br />
<br />
On Merge Requests page, the user can see all request he have made and their status.<br />
| [[File:Prototype9.png|thumb|600px|center|Feedback]]<br />
|-<br />
| <br />
| '''Final Release'''<br />
|<br />
|}<br />
<br />
[[Category:GSoC 2019 student proposals]]</div>Alessiohttps://wiki.apertium.org/w/index.php?title=Web_Dictionary_Maintenance&diff=69387Web Dictionary Maintenance2019-04-06T19:21:11Z<p>Alessio: /* Git, GitLab and Apertium */</p>
<hr />
<div>{{TOCD}}<br />
<br />
[https://translate.google.com/translate?sl=en&tl=pt-br&prev=_t&hl=en&u=http://wiki.apertium.org/wiki/Web_Dictionary_Maintenance Translate to PT-BR with Google Tradução]<br />
<br />
= Introduction =<br />
<br />
Apertium over the years still has deficiencies so that lay people can contribute to increase the base of words in dictionaries, even with simple contributions. Collaboration is the key to developing a tool that serves a huge range of users throughout the world. We believe that it is possible to engage more users and thus give greater impact to the tool within the communities where there is involvement. We will deal in this document with requirements on non-functional and technical objectives regarding the tool proposal.<br />
<br />
;Original Ideias<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code/Easy_dictionary_maintenance<br />
<br />
;Original GSOC2019 Application<br />
: http://wiki.apertium.org/wiki/User:Alessiojr/Easy_dictionary_-_Application-GSOC2019<br />
<br />
;Studant Information<br />
: '''Student:''' Vinícius Silva Nogueira <br /><br />
: '''Unofficial Mentor:''' Alessio Miranda Junior<br /><br />
: '''Telegram/Whatsapp:''' Alessio: +55 (31) 9.8888-7770<br /><br />
: '''E-mail:''' alessio@cefetmg.br or vinicius_snogueira@hotmail.com / viniciussnogueira13@gmail.com<br /><br />
: '''IRC:''' viniciussn or AlessioJr<br /><br />
: '''GTalk:''' alessiojunin@gmail.com<br />
<br />
=Description=<br />
==Abstract:==<br />
The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps away potential contributors. A tool that facilitates the work of dictionaries developers, eliminate computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
Even with several tools that help the way you manage and create dictionaries, Apertium is far from the normal users, who have a huge contribution potential. Or even create a simple way to create contributions to recurring users with advanced knowledge. Although it is a bold plan, and there are several possible and desirable requirements, we will describe some basic premises for this step and that must be respected and aligned with the apertium developer community.<br />
<br />
==Definitions==<br />
:* Lay users do not need to know Apertium's internal structure.<br />
:* Intermediate users need to have a knowledge of dictionary management methodology. <br />
:* Advanced users are those who know the structure of Apertium.<br />
:* Communities are user groups that merge characteristics to the database extension of a dictionary of a specific language.<br />
:* Official dictionaries are dictionaries managed and with seal of the apertium community.<br />
:* Unofficial dictionaries are dictionaries run by an independent community.<br />
:* Test dictionaries are deprived of users to test their contributions.<br />
<br />
==Objectives:==<br />
:* The major goal of the project is to develop a web tool to facilitate the management of the Apertium (XML's) database of integrators for novice and advanced users.<br />
:* New communities of contributions should be able to organize independently of a central command. The command exists but will be distributed.<br />
:* Lay users who feel motivated to contribute, should have an interface that promotes ease in contributing even with limited possibilities.<br />
:* The development of dictionaries should be collaborative and distributed. Each dictionary should have a management community, but a user may have the freedom to disagree and create a new version maintaining a history of the author.<br />
:* Any tool should maintain the traditional Apertium structure and not be interoperable between existing tools.<br />
:* There must be a methodology for communities to maintain the quality of their dictionaries. Although they are distributed the goal is to create a unified and mature dictionary.<br />
<br />
==Questions:==<br />
:* Dixtools is available? Problems?<br />
:* Any Problem to use Gitlab (OpenSource) Like projetos.a2portais.com.br or gitlab<br />
:* Gitlab api? free version?<br />
<br />
=Technical Objectives:=<br />
:* Develop, initially, monolingual dictionaries but keeping the particular format of each file.<br />
:* Minimize the direct manipulation of XML files, providing features that reduce this need.<br />
:* Making use of GitLab as an administrative and control tool.<br />
<br />
== Git, GitLab and Apertium ==<br />
[[File:Git_flow_demonstration.jpg|thumb|250px|right|Git Flow demonstration]]<br />
As the Apertium files are textual, we had the idea of seeking productivity and using existing and consolidated tools in the world.<br />
The proposal is to create a friendly web interface for lay users, but use git's Back-End as version control and do dictionary management in GitLab as it is an administrative tool that already guarantees incredible power for remote collaboration.<br />
<br />
To demonstrate this relationship we will highlight some concepts of Git. Over time there may be several TimeLines:<br />
:* The Official Branch (Master) has the official version of the apertium managed by official developers or maintainers.<br />
:* Users have the power to create new Branches and develop unofficial dictionaries in parallel, creating communities that may from time to time suggest modifications to Brach Master.<br />
:* These requests can be accepted or rejected by maintainers, and this format is recursive and other developers can create unofficial copies of unofficial ones.<br />
:* Integration requests will use the Merge Request concepts present in tools such as GitLab that will be the BackEnd for advanced users.<br />
<br />
=Application-GSOC2019=<br />
===Abstract:===<br />
The idea is to develop the Web tool so that lay users contribute to dictionaries and use Git management with GitLab to manage these changes.<br />
* The focus will be on monolingual dictionaries and bilingual direct relationships.<br />
* Use the Git methodology and propose a guideline or flow for collaborative dictionary management.<br />
* Do not change the current XML format of dictionaries.<br />
<br />
===Why is it you are interested in machine translation and Apertium?===<br />
<br />
During the graduation course, Professor Aléssio demonstrated the need and opportunity to contribute with open source projects. <br />
He introduced me to Apertium and in my final graduation work I started reading and talking about it. <br />
We started discussing techniques for managing collaboration with the community and currently do not have <br />
as much knowledge about machine translation machines but I have experience in developing applications <br />
and web using collaboration with Git and GitLab.<br />
<br />
===Which of the published tasks are you interested in?===<br />
<br />
[http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code/Easy_dictionary_maintenance Easy dictionary maintenance]<br />
<br />
===Why should Google and Apertium sponsor it?===<br />
<br />
This project will have an impact in all languages. Facilitating dictionary manipulation will benefit everyone,<br />
allowing a wider range of people to contribute to existing dictionaries and start new language projects.<br />
<br />
===How and who will it benefit in society?===<br />
This application will benefit the entire Apertium community.<br />
Dictionary developers will have a tool to speed up their work and an easy-to-use tool will attract new contributors.<br />
As a result, Apertium's translation capacity will be increased, bringing better results to the end user.<br />
<br />
===What do you plan to do?===<br />
We are planning to create a web GUI that will facilitate common tasks of creating/modifying dictionaries and allow lay users to contribute to a dictionary.<br />
The application will be connected to a Git repository, which will be used as an administrative and version control tool.<br />
<br />
<br />
<br />
'''Program Language:''' Java, JavaScript<br /><br />
'''Persistence:''' XML (Apertium XML Files)<br /><br />
'''Framworks:''' Angular<br /><br />
<br />
===Stages/Milestones===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Week<br />
! Stage<br />
! Description<br />
|-<br />
| Community Bonding Period<br />
| Technology analysis<br />
|Analyze and find a good way to manipulate XML in a database.<br />
Testing and choosing the best alternative.<br />
<br />
UML diagrams of the project.<br />
|-<br />
| 1, 2<br />
| --<br />
|Database modeling and creation.<br />
<br />
Implementation of GitConnector.<br />
<br />
|-<br />
| 2, 3<br />
| --<br />
| WebAPI development.<br />
<br />
GUI prototype developement for monolingual dictionary: Symbols, Paradigms and Lemmas.<br />
|-<br />
| 3, 4<br />
| --<br />
| GUI prototype developement for bilingual dictionary.<br />
|-<br />
| '''Prototype'''<br />
| Milestone 1<br />
| First version of GUI for community analysis.<br />
|-<br />
| 5, 6<br />
| --<br />
| Development of WebDictionaryController (monolingual and bilingual dictionary).<br />
|-<br />
| 7, 8<br />
| --<br />
| Adjustments and adding new features with community feedback.<br />
|-<br />
| 9<br />
| --<br />
| Functionalities integrations, test and fixes.<br />
|-<br />
| '''Prototype'''<br />
| Milestone 2<br />
| First functional release for community analysis.<br />
|-<br />
| 10, 11<br />
| --<br />
| Adjustments and adding new features with community feedback.<br />
|-<br />
| 12<br />
| Pré-Release<br />
| Fix remain bugs, final adjustments and documentation in Wiki<br />
|-<br />
| <br />
| '''Final Release'''<br />
|Final version realease.<br />
|}<br />
<br />
===Presentation===<br />
<br />
My name is Vinicius, a Brazilian Student at Federal Center for Technological Education of Minas Gerais - Brazil.<br />
<br />
===Resume of Skills===<br />
<br />
Apertium Knowledge:<br />
<br />
* Study to develop a collaborative tool for apertium.<br />
* A study of actual Apertium process about creating a language pair by the user point of view.<br />
* Analysis of the characteristics of the 2010 project of Aléssio and adaptation to current times.<br />
<br />
Academic Skills:<br />
<br />
* Graduating in Computer Engineering- Federal Center for Technological Education of Minas Gerais – Brazil<br />
<br />
Professional Skills:<br />
<br />
* Language developer: C, Java, JavaScript, PHP, Phyton, PL/SQL.<br />
<br />
Projects for Summer:<br />
<br />
* No professional activities planned.<br />
* Planning to work in GSOC<br />
<br />
=Project=<br />
==Why?==<br />
:* The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps potential contributors away. A tool that facilitates the work of dictionaries developers, eliminate the need of computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
==What its the plan?==<br />
:* We are planning to create a web GUI that allows the user to develop the basic tasks of dictionaries and translation pairs manipulation in an easy and practical way.<br />
:* We will use Git as an administrative and control tool, allowing the user to contribute to the work of other community members or start your own project.<br />
<br />
==Components ans Technologies==<br />
[[File:ComponentDiagramWebDictionary.jpg|thumb|700px|right|Components Diagram]]<br />
* Actors<br />
** Lay User <br />
** Dictionary Admin <br />
<br />
* UserBrowser <br />
** WebInterface with AngularJS - GUI to easily manipulate the dictionary XML file.<br />
<br />
* Web Dicionary Maintence (APP)<br />
** WebAPI - Interface between user's GUI and server.<br />
** Temporary Database - Temporary database in which the XML file will be loaded with the crosses made.<br />
** JavaGit Connector - API to execute necessary Git functions.<br />
** WebDictionary Controller <br />
<br />
* Git <br />
** GitRepository - Repository containing the dictionaries<br />
** GitLab - Repository management tool<br />
** GitHub - Repository management tool<br />
<br />
[[File:SequenceDiagramWebDictionary.jpg|thumb|700px|right|Components Diagram]]<br />
<br />
==How it Works?==<br />
We will develop a WebInterface to lay users add words or suggest modifications.<br />
We are planning to use Git as an administrative and version control tool.<br />
<br />
* All dictionaries releases will be in a single repository and available to any member of the community to continue the work.<br />
* Each user will have your own branch to work on.<br />
* The users will be able to make merge requests with the official branch.<br />
* At first, we will use GitLab (or similar tool) to manage this merges requests. The team who maintain each dictionary will judge if the modifications are valid or not.<br />
<br />
=Example of Interaction - Adding new lemma to a dictionary=<br />
<br /><br />
<br /><br />
<br /><br />
<br /><br />
{| class="wikitable" border="1"<br />
|-<br />
! Stage<br />
! Description<br />
! Image<br />
|-<br />
| 1<br />
| ''' Choosing an official dictionary and importing it ''' <br />
The Official Dictionaries page display all available dictionaries in the git repository. <br />
<br />
Each version correspond to a tag in the master branch. <br />
<br />
Once imported, the user will name this dictionary and it will appear on the My Dictionaries page.<br />
| [[File:Prototype1.png|thumb|600px|center|Choosing an official dictionary and importing it]] <br />
[[File:Git1.png|thumb|600px|center|Master branch]]<br />
[[File:Prototype2.png|thumb|600px|center|My Dictionaries page]]<br />
|-<br />
| 2<br />
| ''' Loading the dictionary file ''' , <br />
On the Language File page, the user selects one of their dictionaries and the dictionary XML will be formatted to be temporarily saved to a database. Also on this page, the user can edit the dictionary alphabet and see some statistics about it.<br />
The Symbols, Paradigms, and Lemmas pages refer to the dictionary selected here.<br />
| [[File:Prototype3.png|thumb|600px|center|Loading the dictionary file]] <br />
|-<br />
| 3<br />
| '''Verifying if the lemmas already exists''' <br />
On the Lemmas - Search page, the user will be able to see all the inflections of the dictionary lemmas and check if the lemma he wants to add already exists.<br />
| [[File:Prototype4.png|thumb|600px|center|Verifying if the lemmas already exists]]<br />
|-<br />
| 4.1<br />
| ''' Creating the new lemma - Step 1 ''' <br />
In the Lemmas - Create page, the user will follow three steps to add a new lemma.<br />
<br />
In the first step, the user will define the lemma and the lemma root. In addition, he will give some examples of inflections and symbols to receive suggestions on which paradigm to use.<br />
| [[File:Prototype5.png|thumb|600px|center|text-top|Creating the new lemma - Step 1]]<br />
|-<br />
| 4.2<br />
| ''' Creating the new lemma - Step 2 ''' <br />
<br />
In the second step, the user will see paradigm suggestions (or can see all paradigms). When a paradigm is selected, all inflections of the created lemma will be shown to the user. If none of the paradigms fit, the user will be directed to create a new paradigm. <br />
| [[File:Prototype6.png|thumb|600px|center|Creating the new lemma - Step 2]]<br />
|-<br />
| 4.3<br />
| ''' Creating the new lemma - Step 3 ''' <br />
<br />
In the third and last step, the user will confirm and save the change. At this point, a branch will be create for this dictionary in the git repository (if she doesn’t already exists) and a commit with this changes will be done. <br />
| [[File:Prototype7.png|thumb|600px|right|Creating the new lemma - Step 3]]<br />
[[File:Git2.png|thumb|600px|center|New branch created in Git]]<br />
|-<br />
| 5<br />
| '''Merge Request''' <br />
<br />
On My Dictionaries page, the user can create a merge request that will be judge by the master branch maintainer.<br />
<br />
| [[File:Prototype8.png|thumb|600px|center|Merge Request]]<br />
|-<br />
| 6<br />
| '''Official dictionary keeper judges the merge request'''<br />
In GitLab (or similar tool), the dictionary maintainer will see the list of merge requests.<br />
<br />
At each request, the maintainer can view all commits and accepts only a few of them.<br />
<br />
At each commit, he will judge the changes.<br />
<br />
When he accepts the merge request, the user's branch is deleted.<br />
<br />
|[[File:Git5.png|thumb|600px|center|Merge request list]]<br />
<br />
[[File:Git6.png|thumb|600px|center|Commits from current merge request]]<br />
<br />
[[File:Git7.png|thumb|600px|center|Changes]]<br />
<br />
[[File:Git4.png|thumb|600px|center|GitLab Graph]]<br />
|-<br />
| 7<br />
| '''Feedback''' <br />
<br />
On Merge Requests page, the user can see all request he have made and their status.<br />
| [[File:Prototype9.png|thumb|600px|center|Feedback]]<br />
|-<br />
| <br />
| '''Final Release'''<br />
|<br />
|}<br />
<br />
[[Category:GSoC 2019 student proposals]]</div>Alessiohttps://wiki.apertium.org/w/index.php?title=Web_Dictionary_Maintenance&diff=69386Web Dictionary Maintenance2019-04-06T19:13:55Z<p>Alessio: /* Questions: */</p>
<hr />
<div>{{TOCD}}<br />
<br />
[https://translate.google.com/translate?sl=en&tl=pt-br&prev=_t&hl=en&u=http://wiki.apertium.org/wiki/Web_Dictionary_Maintenance Translate to PT-BR with Google Tradução]<br />
<br />
= Introduction =<br />
<br />
Apertium over the years still has deficiencies so that lay people can contribute to increase the base of words in dictionaries, even with simple contributions. Collaboration is the key to developing a tool that serves a huge range of users throughout the world. We believe that it is possible to engage more users and thus give greater impact to the tool within the communities where there is involvement. We will deal in this document with requirements on non-functional and technical objectives regarding the tool proposal.<br />
<br />
;Original Ideias<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code/Easy_dictionary_maintenance<br />
<br />
;Original GSOC2019 Application<br />
: http://wiki.apertium.org/wiki/User:Alessiojr/Easy_dictionary_-_Application-GSOC2019<br />
<br />
;Studant Information<br />
: '''Student:''' Vinícius Silva Nogueira <br /><br />
: '''Unofficial Mentor:''' Alessio Miranda Junior<br /><br />
: '''Telegram/Whatsapp:''' Alessio: +55 (31) 9.8888-7770<br /><br />
: '''E-mail:''' alessio@cefetmg.br or vinicius_snogueira@hotmail.com / viniciussnogueira13@gmail.com<br /><br />
: '''IRC:''' viniciussn or AlessioJr<br /><br />
: '''GTalk:''' alessiojunin@gmail.com<br />
<br />
=Description=<br />
==Abstract:==<br />
The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps away potential contributors. A tool that facilitates the work of dictionaries developers, eliminate computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
Even with several tools that help the way you manage and create dictionaries, Apertium is far from the normal users, who have a huge contribution potential. Or even create a simple way to create contributions to recurring users with advanced knowledge. Although it is a bold plan, and there are several possible and desirable requirements, we will describe some basic premises for this step and that must be respected and aligned with the apertium developer community.<br />
<br />
==Definitions==<br />
:* Lay users do not need to know Apertium's internal structure.<br />
:* Intermediate users need to have a knowledge of dictionary management methodology. <br />
:* Advanced users are those who know the structure of Apertium.<br />
:* Communities are user groups that merge characteristics to the database extension of a dictionary of a specific language.<br />
:* Official dictionaries are dictionaries managed and with seal of the apertium community.<br />
:* Unofficial dictionaries are dictionaries run by an independent community.<br />
:* Test dictionaries are deprived of users to test their contributions.<br />
<br />
==Objectives:==<br />
:* The major goal of the project is to develop a web tool to facilitate the management of the Apertium (XML's) database of integrators for novice and advanced users.<br />
:* New communities of contributions should be able to organize independently of a central command. The command exists but will be distributed.<br />
:* Lay users who feel motivated to contribute, should have an interface that promotes ease in contributing even with limited possibilities.<br />
:* The development of dictionaries should be collaborative and distributed. Each dictionary should have a management community, but a user may have the freedom to disagree and create a new version maintaining a history of the author.<br />
:* Any tool should maintain the traditional Apertium structure and not be interoperable between existing tools.<br />
:* There must be a methodology for communities to maintain the quality of their dictionaries. Although they are distributed the goal is to create a unified and mature dictionary.<br />
<br />
==Questions:==<br />
:* Dixtools is available? Problems?<br />
:* Any Problem to use Gitlab (OpenSource) Like projetos.a2portais.com.br or gitlab<br />
:* Gitlab api? free version?<br />
<br />
=Technical Objectives:=<br />
:* Develop, initially, monolingual dictionaries but keeping the particular format of each file.<br />
:* Minimize the direct manipulation of XML files, providing features that reduce this need.<br />
:* Making use of GitLab as an administrative and control tool.<br />
<br />
== Git, GitLab and Apertium ==<br />
[[File:Git_flow_demonstration.jpg|thumb|250px|right|Git Flow demonstration]]<br />
As the Apertium files are textual, we had the idea of seeking productivity and using existing and consolidated tools in the world.<br />
The proposal is to build a friendly web interface for lay users, but use git's own Back-End as version control and to make dictionary management GitLab as an administrative tool that already guarantees incredible power for remote collaboration.<br />
<br />
To demonstrate this relationship we will highlight some concepts of Git. Over time there may be several TimeLines:<br />
:* The Official Branch (Master) has the official version of the apertium managed by official developers or maintainers.<br />
:* Users have the power to create new Branches and develop unofficial dictionaries in parallel, creating communities that may from time to time suggest modifications to Brach Master.<br />
:* These requests can be accepted or rejected by maintainers, and this format is recursive and other developers can create unofficial copies of unofficial ones.<br />
:* Integration requests will use the Merge Request concepts present in tools such as GitLab that will be the BackEnd for advanced users.<br />
<br />
=Application-GSOC2019=<br />
===Abstract:===<br />
The idea is to develop the Web tool so that lay users contribute to dictionaries and use Git management with GitLab to manage these changes.<br />
* The focus will be on monolingual dictionaries and bilingual direct relationships.<br />
* Use the Git methodology and propose a guideline or flow for collaborative dictionary management.<br />
* Do not change the current XML format of dictionaries.<br />
<br />
===Why is it you are interested in machine translation and Apertium?===<br />
<br />
During the graduation course, Professor Aléssio demonstrated the need and opportunity to contribute with open source projects. <br />
He introduced me to Apertium and in my final graduation work I started reading and talking about it. <br />
We started discussing techniques for managing collaboration with the community and currently do not have <br />
as much knowledge about machine translation machines but I have experience in developing applications <br />
and web using collaboration with Git and GitLab.<br />
<br />
===Which of the published tasks are you interested in?===<br />
<br />
[http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code/Easy_dictionary_maintenance Easy dictionary maintenance]<br />
<br />
===Why should Google and Apertium sponsor it?===<br />
<br />
This project will have an impact in all languages. Facilitating dictionary manipulation will benefit everyone,<br />
allowing a wider range of people to contribute to existing dictionaries and start new language projects.<br />
<br />
===How and who will it benefit in society?===<br />
This application will benefit the entire Apertium community.<br />
Dictionary developers will have a tool to speed up their work and an easy-to-use tool will attract new contributors.<br />
As a result, Apertium's translation capacity will be increased, bringing better results to the end user.<br />
<br />
===What do you plan to do?===<br />
We are planning to create a web GUI that will facilitate common tasks of creating/modifying dictionaries and allow lay users to contribute to a dictionary.<br />
The application will be connected to a Git repository, which will be used as an administrative and version control tool.<br />
<br />
<br />
<br />
'''Program Language:''' Java, JavaScript<br /><br />
'''Persistence:''' XML (Apertium XML Files)<br /><br />
'''Framworks:''' Angular<br /><br />
<br />
===Stages/Milestones===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Week<br />
! Stage<br />
! Description<br />
|-<br />
| Community Bonding Period<br />
| Technology analysis<br />
|Analyze and find a good way to manipulate XML in a database.<br />
Testing and choosing the best alternative.<br />
<br />
UML diagrams of the project.<br />
|-<br />
| 1, 2<br />
| --<br />
|Database modeling and creation.<br />
<br />
Implementation of GitConnector.<br />
<br />
|-<br />
| 2, 3<br />
| --<br />
| WebAPI development.<br />
<br />
GUI prototype developement for monolingual dictionary: Symbols, Paradigms and Lemmas.<br />
|-<br />
| 3, 4<br />
| --<br />
| GUI prototype developement for bilingual dictionary.<br />
|-<br />
| '''Prototype'''<br />
| Milestone 1<br />
| First version of GUI for community analysis.<br />
|-<br />
| 5, 6<br />
| --<br />
| Development of WebDictionaryController (monolingual and bilingual dictionary).<br />
|-<br />
| 7, 8<br />
| --<br />
| Adjustments and adding new features with community feedback.<br />
|-<br />
| 9<br />
| --<br />
| Functionalities integrations, test and fixes.<br />
|-<br />
| '''Prototype'''<br />
| Milestone 2<br />
| First functional release for community analysis.<br />
|-<br />
| 10, 11<br />
| --<br />
| Adjustments and adding new features with community feedback.<br />
|-<br />
| 12<br />
| Pré-Release<br />
| Fix remain bugs, final adjustments and documentation in Wiki<br />
|-<br />
| <br />
| '''Final Release'''<br />
|Final version realease.<br />
|}<br />
<br />
===Presentation===<br />
<br />
My name is Vinicius, a Brazilian Student at Federal Center for Technological Education of Minas Gerais - Brazil.<br />
<br />
===Resume of Skills===<br />
<br />
Apertium Knowledge:<br />
<br />
* Study to develop a collaborative tool for apertium.<br />
* A study of actual Apertium process about creating a language pair by the user point of view.<br />
* Analysis of the characteristics of the 2010 project of Aléssio and adaptation to current times.<br />
<br />
Academic Skills:<br />
<br />
* Graduating in Computer Engineering- Federal Center for Technological Education of Minas Gerais – Brazil<br />
<br />
Professional Skills:<br />
<br />
* Language developer: C, Java, JavaScript, PHP, Phyton, PL/SQL.<br />
<br />
Projects for Summer:<br />
<br />
* No professional activities planned.<br />
* Planning to work in GSOC<br />
<br />
=Project=<br />
==Why?==<br />
:* The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps potential contributors away. A tool that facilitates the work of dictionaries developers, eliminate the need of computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
==What its the plan?==<br />
:* We are planning to create a web GUI that allows the user to develop the basic tasks of dictionaries and translation pairs manipulation in an easy and practical way.<br />
:* We will use Git as an administrative and control tool, allowing the user to contribute to the work of other community members or start your own project.<br />
<br />
==Components ans Technologies==<br />
[[File:ComponentDiagramWebDictionary.jpg|thumb|700px|right|Components Diagram]]<br />
* Actors<br />
** Lay User <br />
** Dictionary Admin <br />
<br />
* UserBrowser <br />
** WebInterface with AngularJS - GUI to easily manipulate the dictionary XML file.<br />
<br />
* Web Dicionary Maintence (APP)<br />
** WebAPI - Interface between user's GUI and server.<br />
** Temporary Database - Temporary database in which the XML file will be loaded with the crosses made.<br />
** JavaGit Connector - API to execute necessary Git functions.<br />
** WebDictionary Controller <br />
<br />
* Git <br />
** GitRepository - Repository containing the dictionaries<br />
** GitLab - Repository management tool<br />
** GitHub - Repository management tool<br />
<br />
[[File:SequenceDiagramWebDictionary.jpg|thumb|700px|right|Components Diagram]]<br />
<br />
==How it Works?==<br />
We will develop a WebInterface to lay users add words or suggest modifications.<br />
We are planning to use Git as an administrative and version control tool.<br />
<br />
* All dictionaries releases will be in a single repository and available to any member of the community to continue the work.<br />
* Each user will have your own branch to work on.<br />
* The users will be able to make merge requests with the official branch.<br />
* At first, we will use GitLab (or similar tool) to manage this merges requests. The team who maintain each dictionary will judge if the modifications are valid or not.<br />
<br />
=Example of Interaction - Adding new lemma to a dictionary=<br />
<br /><br />
<br /><br />
<br /><br />
<br /><br />
{| class="wikitable" border="1"<br />
|-<br />
! Stage<br />
! Description<br />
! Image<br />
|-<br />
| 1<br />
| ''' Choosing an official dictionary and importing it ''' <br />
The Official Dictionaries page display all available dictionaries in the git repository. <br />
<br />
Each version correspond to a tag in the master branch. <br />
<br />
Once imported, the user will name this dictionary and it will appear on the My Dictionaries page.<br />
| [[File:Prototype1.png|thumb|600px|center|Choosing an official dictionary and importing it]] <br />
[[File:Git1.png|thumb|600px|center|Master branch]]<br />
[[File:Prototype2.png|thumb|600px|center|My Dictionaries page]]<br />
|-<br />
| 2<br />
| ''' Loading the dictionary file ''' , <br />
On the Language File page, the user selects one of their dictionaries and the dictionary XML will be formatted to be temporarily saved to a database. Also on this page, the user can edit the dictionary alphabet and see some statistics about it.<br />
The Symbols, Paradigms, and Lemmas pages refer to the dictionary selected here.<br />
| [[File:Prototype3.png|thumb|600px|center|Loading the dictionary file]] <br />
|-<br />
| 3<br />
| '''Verifying if the lemmas already exists''' <br />
On the Lemmas - Search page, the user will be able to see all the inflections of the dictionary lemmas and check if the lemma he wants to add already exists.<br />
| [[File:Prototype4.png|thumb|600px|center|Verifying if the lemmas already exists]]<br />
|-<br />
| 4.1<br />
| ''' Creating the new lemma - Step 1 ''' <br />
In the Lemmas - Create page, the user will follow three steps to add a new lemma.<br />
<br />
In the first step, the user will define the lemma and the lemma root. In addition, he will give some examples of inflections and symbols to receive suggestions on which paradigm to use.<br />
| [[File:Prototype5.png|thumb|600px|center|text-top|Creating the new lemma - Step 1]]<br />
|-<br />
| 4.2<br />
| ''' Creating the new lemma - Step 2 ''' <br />
<br />
In the second step, the user will see paradigm suggestions (or can see all paradigms). When a paradigm is selected, all inflections of the created lemma will be shown to the user. If none of the paradigms fit, the user will be directed to create a new paradigm. <br />
| [[File:Prototype6.png|thumb|600px|center|Creating the new lemma - Step 2]]<br />
|-<br />
| 4.3<br />
| ''' Creating the new lemma - Step 3 ''' <br />
<br />
In the third and last step, the user will confirm and save the change. At this point, a branch will be create for this dictionary in the git repository (if she doesn’t already exists) and a commit with this changes will be done. <br />
| [[File:Prototype7.png|thumb|600px|right|Creating the new lemma - Step 3]]<br />
[[File:Git2.png|thumb|600px|center|New branch created in Git]]<br />
|-<br />
| 5<br />
| '''Merge Request''' <br />
<br />
On My Dictionaries page, the user can create a merge request that will be judge by the master branch maintainer.<br />
<br />
| [[File:Prototype8.png|thumb|600px|center|Merge Request]]<br />
|-<br />
| 6<br />
| '''Official dictionary keeper judges the merge request'''<br />
In GitLab (or similar tool), the dictionary maintainer will see the list of merge requests.<br />
<br />
At each request, the maintainer can view all commits and accepts only a few of them.<br />
<br />
At each commit, he will judge the changes.<br />
<br />
When he accepts the merge request, the user's branch is deleted.<br />
<br />
|[[File:Git5.png|thumb|600px|center|Merge request list]]<br />
<br />
[[File:Git6.png|thumb|600px|center|Commits from current merge request]]<br />
<br />
[[File:Git7.png|thumb|600px|center|Changes]]<br />
<br />
[[File:Git4.png|thumb|600px|center|GitLab Graph]]<br />
|-<br />
| 7<br />
| '''Feedback''' <br />
<br />
On Merge Requests page, the user can see all request he have made and their status.<br />
| [[File:Prototype9.png|thumb|600px|center|Feedback]]<br />
|-<br />
| <br />
| '''Final Release'''<br />
|<br />
|}<br />
<br />
[[Category:GSoC 2019 student proposals]]</div>Alessiohttps://wiki.apertium.org/w/index.php?title=Web_Dictionary_Maintenance&diff=69381Web Dictionary Maintenance2019-04-06T18:55:20Z<p>Alessio: /* Introduction */</p>
<hr />
<div>{{TOCD}}<br />
<br />
[https://translate.google.com/translate?sl=en&tl=pt-br&prev=_t&hl=en&u=http://wiki.apertium.org/wiki/Web_Dictionary_Maintenance Translate to PT-BR with Google Tradução]<br />
<br />
= Introduction =<br />
<br />
Apertium over the years still has deficiencies so that lay people can contribute to increase the base of words in dictionaries, even with simple contributions. Collaboration is the key to developing a tool that serves a huge range of users throughout the world. We believe that it is possible to engage more users and thus give greater impact to the tool within the communities where there is involvement. We will deal in this document with requirements on non-functional and technical objectives regarding the tool proposal.<br />
<br />
;Original Ideias<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code/Easy_dictionary_maintenance<br />
<br />
;Original GSOC2019 Application<br />
: http://wiki.apertium.org/wiki/User:Alessiojr/Easy_dictionary_-_Application-GSOC2019<br />
<br />
;Studant Information<br />
: '''Student:''' Vinícius Silva Nogueira <br /><br />
: '''Unofficial Mentor:''' Alessio Miranda Junior<br /><br />
: '''Telegram/Whatsapp:''' Alessio: +55 (31) 9.8888-7770<br /><br />
: '''E-mail:''' alessio@cefetmg.br or vinicius_snogueira@hotmail.com / viniciussnogueira13@gmail.com<br /><br />
: '''IRC:''' viniciussn or AlessioJr<br /><br />
: '''GTalk:''' alessiojunin@gmail.com<br />
<br />
=Description=<br />
==Abstract:==<br />
The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps away potential contributors. A tool that facilitates the work of dictionaries developers, eliminate computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
Even with several tools that help the way you manage and create dictionaries, Apertium is far from the normal users, who have a huge contribution potential. Or even create a simple way to create contributions to recurring users with advanced knowledge. Although it is a bold plan, and there are several possible and desirable requirements, we will describe some basic premises for this step and that must be respected and aligned with the apertium developer community.<br />
<br />
==Definitions==<br />
:* Lay users do not need to know Apertium's internal structure.<br />
:* Intermediate users need to have a knowledge of dictionary management methodology. <br />
:* Advanced users are those who know the structure of Apertium.<br />
:* Communities are user groups that merge characteristics to the database extension of a dictionary of a specific language.<br />
:* Official dictionaries are dictionaries managed and with seal of the apertium community.<br />
:* Unofficial dictionaries are dictionaries run by an independent community.<br />
:* Test dictionaries are deprived of users to test their contributions.<br />
<br />
==Objectives:==<br />
:* The major goal of the project is to develop a web tool to facilitate the management of the Apertium (XML's) database of integrators for novice and advanced users.<br />
:* New communities of contributions should be able to organize independently of a central command. The command exists but will be distributed.<br />
:* Lay users who feel motivated to contribute, should have an interface that promotes ease in contributing even with limited possibilities.<br />
:* The development of dictionaries should be collaborative and distributed. Each dictionary should have a management community, but a user may have the freedom to disagree and create a new version maintaining a history of the author.<br />
:* Any tool should maintain the traditional Apertium structure and not be interoperable between existing tools.<br />
:* There must be a methodology for communities to maintain the quality of their dictionaries. Although they are distributed the goal is to create a unified and mature dictionary.<br />
<br />
==Questions:==<br />
:* Dixtools is avaliable? Problems?<br />
:* Any Problem to use Gitlab (OpenSource) Like projetos.a2portais.com.br or gitlab<br />
:* Gitlab api? free version?<br />
<br />
=Technical Objectives:=<br />
:* Develop, initially, monolingual dictionaries but keeping the particular format of each file.<br />
:* Minimize the direct manipulation of XML files, providing features that reduce this need.<br />
:* Making use of GitLab as an administrative and control tool.<br />
<br />
== Git, GitLab and Apertium ==<br />
[[File:Git_flow_demonstration.jpg|thumb|250px|right|Git Flow demonstration]]<br />
As the Apertium files are textual, we had the idea of seeking productivity and using existing and consolidated tools in the world.<br />
The proposal is to build a friendly web interface for lay users, but use git's own Back-End as version control and to make dictionary management GitLab as an administrative tool that already guarantees incredible power for remote collaboration.<br />
<br />
To demonstrate this relationship we will highlight some concepts of Git. Over time there may be several TimeLines:<br />
:* The Official Branch (Master) has the official version of the apertium managed by official developers or maintainers.<br />
:* Users have the power to create new Branches and develop unofficial dictionaries in parallel, creating communities that may from time to time suggest modifications to Brach Master.<br />
:* These requests can be accepted or rejected by maintainers, and this format is recursive and other developers can create unofficial copies of unofficial ones.<br />
:* Integration requests will use the Merge Request concepts present in tools such as GitLab that will be the BackEnd for advanced users.<br />
<br />
=Application-GSOC2019=<br />
===Abstract:===<br />
The idea is to develop the Web tool so that lay users contribute to dictionaries and use Git management with GitLab to manage these changes.<br />
* The focus will be on monolingual dictionaries and bilingual direct relationships.<br />
* Use the Git methodology and propose a guideline or flow for collaborative dictionary management.<br />
* Do not change the current XML format of dictionaries.<br />
<br />
===Why is it you are interested in machine translation and Apertium?===<br />
<br />
During the graduation course, Professor Aléssio demonstrated the need and opportunity to contribute with open source projects. <br />
He introduced me to Apertium and in my final graduation work I started reading and talking about it. <br />
We started discussing techniques for managing collaboration with the community and currently do not have <br />
as much knowledge about machine translation machines but I have experience in developing applications <br />
and web using collaboration with Git and GitLab.<br />
<br />
===Which of the published tasks are you interested in?===<br />
<br />
[http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code/Easy_dictionary_maintenance Easy dictionary maintenance]<br />
<br />
===Why should Google and Apertium sponsor it?===<br />
<br />
This project will have an impact in all languages. Facilitating dictionary manipulation will benefit everyone,<br />
allowing a wider range of people to contribute to existing dictionaries and start new language projects.<br />
<br />
===How and who will it benefit in society?===<br />
This application will benefit the entire Apertium community.<br />
Dictionary developers will have a tool to speed up their work and an easy-to-use tool will attract new contributors.<br />
As a result, Apertium's translation capacity will be increased, bringing better results to the end user.<br />
<br />
===What do you plan to do?===<br />
We are planning to create a web GUI that will facilitate common tasks of creating/modifying dictionaries and allow lay users to contribute to a dictionary.<br />
The application will be connected to a Git repository, which will be used as an administrative and version control tool.<br />
<br />
<br />
<br />
'''Program Language:''' Java, JavaScript<br /><br />
'''Persistence:''' XML (Apertium XML Files)<br /><br />
'''Framworks:''' Angular<br /><br />
<br />
===Stages/Milestones===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Week<br />
! Stage<br />
! Description<br />
|-<br />
| Community Bonding Period<br />
| Technology analysis<br />
|Analyze and find a good way to manipulate XML in a database.<br />
Testing and choosing the best alternative.<br />
<br />
UML diagrams of the project.<br />
|-<br />
| 1, 2<br />
| --<br />
|Database modeling and creation.<br />
<br />
Implementation of GitConnector.<br />
<br />
|-<br />
| 2, 3<br />
| --<br />
| WebAPI development.<br />
<br />
GUI prototype developement for monolingual dictionary: Symbols, Paradigms and Lemmas.<br />
|-<br />
| 3, 4<br />
| --<br />
| GUI prototype developement for bilingual dictionary.<br />
|-<br />
| '''Prototype'''<br />
| Milestone 1<br />
| First version of GUI for community analysis.<br />
|-<br />
| 5, 6<br />
| --<br />
| Development of WebDictionaryController (monolingual and bilingual dictionary).<br />
|-<br />
| 7, 8<br />
| --<br />
| Adjustments and adding new features with community feedback.<br />
|-<br />
| 9<br />
| --<br />
| Functionalities integrations, test and fixes.<br />
|-<br />
| '''Prototype'''<br />
| Milestone 2<br />
| First functional release for community analysis.<br />
|-<br />
| 10, 11<br />
| --<br />
| Adjustments and adding new features with community feedback.<br />
|-<br />
| 12<br />
| Pré-Release<br />
| Fix remain bugs, final adjustments and documentation in Wiki<br />
|-<br />
| <br />
| '''Final Release'''<br />
|Final version realease.<br />
|}<br />
<br />
===Presentation===<br />
<br />
My name is Vinicius, a Brazilian Student at Federal Center for Technological Education of Minas Gerais - Brazil.<br />
<br />
===Resume of Skills===<br />
<br />
Apertium Knowledge:<br />
<br />
* Study to develop a collaborative tool for apertium.<br />
* A study of actual Apertium process about creating a language pair by the user point of view.<br />
* Analysis of the characteristics of the 2010 project of Aléssio and adaptation to current times.<br />
<br />
Academic Skills:<br />
<br />
* Graduating in Computer Engineering- Federal Center for Technological Education of Minas Gerais – Brazil<br />
<br />
Professional Skills:<br />
<br />
* Language developer: C, Java, JavaScript, PHP, Phyton, PL/SQL.<br />
<br />
Projects for Summer:<br />
<br />
* No professional activities planned.<br />
* Planning to work in GSOC<br />
<br />
=Project=<br />
==Why?==<br />
:* The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps potential contributors away. A tool that facilitates the work of dictionaries developers, eliminate the need of computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
==What its the plan?==<br />
:* We are planning to create a web GUI that allows the user to develop the basic tasks of dictionaries and translation pairs manipulation in an easy and practical way.<br />
:* We will use Git as an administrative and control tool, allowing the user to contribute to the work of other community members or start your own project.<br />
<br />
==Components ans Technologies==<br />
[[File:ComponentDiagramWebDictionary.jpg|thumb|700px|right|Components Diagram]]<br />
* Actors<br />
** Lay User <br />
** Dictionary Admin <br />
<br />
* UserBrowser <br />
** WebInterface with AngularJS - GUI to easily manipulate the dictionary XML file.<br />
<br />
* Web Dicionary Maintence (APP)<br />
** WebAPI - Interface between user's GUI and server.<br />
** Temporary Database - Temporary database in which the XML file will be loaded with the crosses made.<br />
** JavaGit Connector - API to execute necessary Git functions.<br />
** WebDictionary Controller <br />
<br />
* Git <br />
** GitRepository - Repository containing the dictionaries<br />
** GitLab - Repository management tool<br />
** GitHub - Repository management tool<br />
<br />
[[File:SequenceDiagramWebDictionary.jpg|thumb|700px|right|Components Diagram]]<br />
<br />
==How it Works?==<br />
We will develop a WebInterface to lay users add words or suggest modifications.<br />
We are planning to use Git as an administrative and version control tool.<br />
<br />
* All dictionaries releases will be in a single repository and available to any member of the community to continue the work.<br />
* Each user will have your own branch to work on.<br />
* The users will be able to make merge requests with the official branch.<br />
* At first, we will use GitLab (or similar tool) to manage this merges requests. The team who maintain each dictionary will judge if the modifications are valid or not.<br />
<br />
=Example of Interaction - Adding new lemma to a dictionary=<br />
<br /><br />
<br /><br />
<br /><br />
<br /><br />
{| class="wikitable" border="1"<br />
|-<br />
! Stage<br />
! Description<br />
! Image<br />
|-<br />
| 1<br />
| ''' Choosing an official dictionary and importing it ''' <br />
The Official Dictionaries page display all available dictionaries in the git repository. <br />
<br />
Each version correspond to a tag in the master branch. <br />
<br />
Once imported, the user will name this dictionary and it will appear on the My Dictionaries page.<br />
| [[File:Prototype1.png|thumb|600px|center|Choosing an official dictionary and importing it]] <br />
[[File:Git1.png|thumb|600px|center|Master branch]]<br />
[[File:Prototype2.png|thumb|600px|center|My Dictionaries page]]<br />
|-<br />
| 2<br />
| ''' Loading the dictionary file ''' , <br />
On the Language File page, the user selects one of their dictionaries and the dictionary XML will be formatted to be temporarily saved to a database. Also on this page, the user can edit the dictionary alphabet and see some statistics about it.<br />
The Symbols, Paradigms, and Lemmas pages refer to the dictionary selected here.<br />
| [[File:Prototype3.png|thumb|600px|center|Loading the dictionary file]] <br />
|-<br />
| 3<br />
| '''Verifying if the lemmas already exists''' <br />
On the Lemmas - Search page, the user will be able to see all the inflections of the dictionary lemmas and check if the lemma he wants to add already exists.<br />
| [[File:Prototype4.png|thumb|600px|center|Verifying if the lemmas already exists]]<br />
|-<br />
| 4.1<br />
| ''' Creating the new lemma - Step 1 ''' <br />
In the Lemmas - Create page, the user will follow three steps to add a new lemma.<br />
<br />
In the first step, the user will define the lemma and the lemma root. In addition, he will give some examples of inflections and symbols to receive suggestions on which paradigm to use.<br />
| [[File:Prototype5.png|thumb|600px|center|text-top|Creating the new lemma - Step 1]]<br />
|-<br />
| 4.2<br />
| ''' Creating the new lemma - Step 2 ''' <br />
<br />
In the second step, the user will see paradigm suggestions (or can see all paradigms). When a paradigm is selected, all inflections of the created lemma will be shown to the user. If none of the paradigms fit, the user will be directed to create a new paradigm. <br />
| [[File:Prototype6.png|thumb|600px|center|Creating the new lemma - Step 2]]<br />
|-<br />
| 4.3<br />
| ''' Creating the new lemma - Step 3 ''' <br />
<br />
In the third and last step, the user will confirm and save the change. At this point, a branch will be create for this dictionary in the git repository (if she doesn’t already exists) and a commit with this changes will be done. <br />
| [[File:Prototype7.png|thumb|600px|right|Creating the new lemma - Step 3]]<br />
[[File:Git2.png|thumb|600px|center|New branch created in Git]]<br />
|-<br />
| 5<br />
| '''Merge Request''' <br />
<br />
On My Dictionaries page, the user can create a merge request that will be judge by the master branch maintainer.<br />
<br />
| [[File:Prototype8.png|thumb|600px|center|Merge Request]]<br />
|-<br />
| 6<br />
| '''Official dictionary keeper judges the merge request'''<br />
In GitLab (or similar tool), the dictionary maintainer will see the list of merge requests.<br />
<br />
At each request, the maintainer can view all commits and accepts only a few of them.<br />
<br />
At each commit, he will judge the changes.<br />
<br />
When he accepts the merge request, the user's branch is deleted.<br />
<br />
|[[File:Git5.png|thumb|600px|center|Merge request list]]<br />
<br />
[[File:Git6.png|thumb|600px|center|Commits from current merge request]]<br />
<br />
[[File:Git7.png|thumb|600px|center|Changes]]<br />
<br />
[[File:Git4.png|thumb|600px|center|GitLab Graph]]<br />
|-<br />
| 7<br />
| '''Feedback''' <br />
<br />
On Merge Requests page, the user can see all request he have made and their status.<br />
| [[File:Prototype9.png|thumb|600px|center|Feedback]]<br />
|-<br />
| <br />
| '''Final Release'''<br />
|<br />
|}<br />
<br />
[[Category:GSoC 2019 student proposals]]</div>Alessiohttps://wiki.apertium.org/w/index.php?title=Web_Dictionary_Maintenance&diff=69222Web Dictionary Maintenance2019-04-04T18:21:19Z<p>Alessio: /* Questions: */</p>
<hr />
<div>{{TOCD}}<br />
<br />
[https://translate.google.com/translate?sl=en&tl=pt-br&prev=_t&hl=en&u=http://wiki.apertium.org/wiki/Web_Dictionary_Maintenance Translate to PT-BR with Google Tradução]<br />
<br />
= Introduction =<br />
<br />
Apertium over the years still has deficiencies so that lay people can contribute to increase the base of words in dictionaries, even with simple contributions. Collaboration is the key to developing a tool that serves a huge range of users throughout the world. We believe that it is possible to engage more users and thus give greater impact to the tool within the communities where there is involvement. We will deal in this document with requirements on non-functional and technical objectives regarding the tool proposal.<br />
<br />
;Original Ideias<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code/Easy_dictionary_maintenance<br />
<br />
;Original GSOC2019 Application<br />
: http://wiki.apertium.org/wiki/User:Alessiojr/Easy_dictionary_-_Application-GSOC2019<br />
<br />
;Studant Information<br />
: '''Student:''' Vinícius Silva Nogueira <br /><br />
: '''Unofficial Mentor:''' Alessio Miranda Junior<br /><br />
: '''Telegram/Whatsapp:''' Alessio: +55 (31) 9.8888-7770<br /><br />
: '''E-mail:''' alessio@cefetmg.br or vinicius_snogueira@hotmail.com / viniciussnogueira13@gmail.com<br /><br />
: '''IRC:''' Viniciussn or AlessioJr<br /><br />
: '''GTalk:''' alessiojunin@gmail.com<br />
<br />
=Description=<br />
==Abstract:==<br />
The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps away potential contributors. A tool that facilitates the work of dictionaries developers, eliminate computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
Even with several tools that help the way you manage and create dictionaries, Apertium is far from the normal users, who have a huge contribution potential. Or even create a simple way to create contributions to recurring users with advanced knowledge. Although it is a bold plan, and there are several possible and desirable requirements, we will describe some basic premises for this step and that must be respected and aligned with the apertium developer community.<br />
<br />
==Definitions==<br />
:* Lay users do not need to know Apertium's internal structure.<br />
:* Intermediate users need to have a knowledge of dictionary management methodology. <br />
:* Advanced users are those who know the structure of Apertium.<br />
:* Communities are user groups that merge characteristics to the database extension of a dictionary of a specific language.<br />
:* Official dictionaries are dictionaries managed and with seal of the apertium community.<br />
:* Unofficial dictionaries are dictionaries run by an independent community.<br />
:* Test dictionaries are deprived of users to test their contributions.<br />
<br />
==Objectives:==<br />
:* The major goal of the project is to develop a web tool to facilitate the management of the Apertium (XML's) database of integrators for novice and advanced users.<br />
:* New communities of contributions should be able to organize independently of a central command. The command exists but will be distributed.<br />
:* Lay users who feel motivated to contribute, should have an interface that promotes ease in contributing even with limited possibilities.<br />
:* The development of dictionaries should be collaborative and distributed. Each dictionary should have a management community, but a user may have the freedom to disagree and create a new version maintaining a history of the author.<br />
:* Any tool should maintain the traditional Apertium structure and not be interoperable between existing tools.<br />
:* There must be a methodology for communities to maintain the quality of their dictionaries. Although they are distributed the goal is to create a unified and mature dictionary.<br />
<br />
==Questions:==<br />
:* Dixtools is avaliable? Problems?<br />
:* Any Problem to use Gitlab (OpenSource) Like projetos.a2portais.com.br or gitlab<br />
:* Gitlab api? free version?<br />
<br />
=Technical Objectives:=<br />
:* Develop, initially, monolingual dictionaries but keeping the particular format of each file.<br />
:* Minimize the direct manipulation of XML files, providing features that reduce this need.<br />
:* Making use of GitLab as an administrative and control tool.<br />
<br />
== Git, GitLab and Apertium ==<br />
[[File:Git_flow_demonstration.jpg|thumb|250px|right|Git Flow demonstration]]<br />
As the Apertium files are textual, we had the idea of seeking productivity and using existing and consolidated tools in the world.<br />
The proposal is to build a friendly web interface for lay users, but use git's own Back-End as version control and to make dictionary management GitLab as an administrative tool that already guarantees incredible power for remote collaboration.<br />
<br />
To demonstrate this relationship we will highlight some concepts of Git. Over time there may be several TimeLines:<br />
:* The Official Branch (Master) has the official version of the apertium managed by official developers or maintainers.<br />
:* Users have the power to create new Branches and develop unofficial dictionaries in parallel, creating communities that may from time to time suggest modifications to Brach Master.<br />
:* These requests can be accepted or rejected by maintainers, and this format is recursive and other developers can create unofficial copies of unofficial ones.<br />
:* Integration requests will use the Merge Request concepts present in tools such as GitLab that will be the BackEnd for advanced users.<br />
<br />
=Application-GSOC2019=<br />
===Abstract:===<br />
The idea is to develop the Web tool so that lay users contribute to dictionaries and use Git management with GitLab to manage these changes.<br />
* The focus will be on monolingual dictionaries and bilingual direct relationships.<br />
* Use the Git methodology and propose a guideline or flow for collaborative dictionary management.<br />
* Do not change the current XML format of dictionaries.<br />
<br />
===Why is it you are interested in machine translation and Apertium?===<br />
<br />
During the graduation course, Professor Aléssio demonstrated the need and opportunity to contribute with open source projects. <br />
He introduced me to Apertium and in my final graduation work I started reading and talking about it. <br />
We started discussing techniques for managing collaboration with the community and currently do not have <br />
as much knowledge about machine translation machines but I have experience in developing applications <br />
and web using collaboration with Git and GitLab.<br />
<br />
===Which of the published tasks are you interested in?===<br />
<br />
[http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code/Easy_dictionary_maintenance Easy dictionary maintenance]<br />
<br />
===Why should Google and Apertium sponsor it?===<br />
<br />
This project will have an impact in all languages. Facilitating dictionary manipulation will benefit everyone,<br />
allowing a wider range of people to contribute to existing dictionaries and start new language projects.<br />
<br />
===How and who will it benefit in society?===<br />
This application will benefit the entire Apertium community.<br />
Dictionary developers will have a tool to speed up their work and an easy-to-use tool will attract new contributors.<br />
As a result, Apertium's translation capacity will be increased, bringing better results to the end user.<br />
<br />
===What do you plan to do?===<br />
We are planning to create a web GUI that will facilitate common tasks of creating/modifying dictionaries and allow lay users to contribute to a dictionary.<br />
The application will be connected to a Git repository, which will be used as an administrative and version control tool.<br />
<br />
<br />
<br />
'''Program Language:''' Java, JavaScript<br /><br />
'''Persistence:''' XML (Apertium XML Files)<br /><br />
'''Framworks:''' Angular<br /><br />
<br />
===Stages/Milestones===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Week<br />
! Stage<br />
! Description<br />
|-<br />
| Community Bonding Period<br />
| Technology analysis<br />
|Analyze and find a good way to manipulate XML in a database.<br />
Testing and choosing the best alternative.<br />
<br />
UML diagrams of the project.<br />
|-<br />
| 1, 2<br />
| --<br />
|Database modeling and creation.<br />
<br />
Implementation of GitConnector.<br />
<br />
|-<br />
| 2, 3<br />
| --<br />
| WebAPI development.<br />
<br />
GUI prototype developement for monolingual dictionary: Symbols, Paradigms and Lemmas.<br />
|-<br />
| 3, 4<br />
| --<br />
| GUI prototype developement for bilingual dictionary.<br />
|-<br />
| '''Prototype'''<br />
| Milestone 1<br />
| First version of GUI for community analysis.<br />
|-<br />
| 5, 6<br />
| --<br />
| Development of WebDictionaryController (monolingual and bilingual dictionary).<br />
|-<br />
| 7, 8<br />
| --<br />
| Adjustments and adding new features with community feedback.<br />
|-<br />
| 9<br />
| --<br />
| Functionalities integrations, test and fixes.<br />
|-<br />
| '''Prototype'''<br />
| Milestone 2<br />
| First functional release for community analysis.<br />
|-<br />
| 10, 11<br />
| --<br />
| Adjustments and adding new features with community feedback.<br />
|-<br />
| 12<br />
| Pré-Release<br />
| Fix remain bugs, final adjustments and documentation in Wiki<br />
|-<br />
| <br />
| '''Final Release'''<br />
|Final version realease.<br />
|}<br />
<br />
===Presentation===<br />
<br />
My name is Vinicius, a Brazilian Student at Federal Center for Technological Education of Minas Gerais - Brazil.<br />
<br />
===Resume of Skills===<br />
<br />
Apertium Knowledge:<br />
<br />
* Study to develop a collaborative tool for apertium.<br />
* A study of actual Apertium process about creating a language pair by the user point of view.<br />
* Analysis of the characteristics of the 2010 project of Aléssio and adaptation to current times.<br />
<br />
Academic Skills:<br />
<br />
* Graduating in Computer Engineering- Federal Center for Technological Education of Minas Gerais – Brazil<br />
<br />
Professional Skills:<br />
<br />
* Language developer: C, Java, JavaScript, PHP, Phyton, PL/SQL.<br />
<br />
Projects for Summer:<br />
<br />
* No professional activities planned.<br />
* Planning to work in GSOC<br />
<br />
=Project=<br />
==Why?==<br />
:* The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps potential contributors away. A tool that facilitates the work of dictionaries developers, eliminate the need of computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
==What its the plan?==<br />
:* We are planning to create a web GUI that allows the user to develop the basic tasks of dictionaries and translation pairs manipulation in an easy and practical way.<br />
:* We will use Git as an administrative and control tool, allowing the user to contribute to the work of other community members or start your own project.<br />
<br />
==Components ans Technologies==<br />
[[File:ComponentDiagramWebDictionary.jpg|thumb|700px|right|Components Diagram]]<br />
* Actors<br />
** Lay User <br />
** Dictionary Admin <br />
<br />
* UserBrowser <br />
** WebInterface with AngularJS - GUI to easily manipulate the dictionary XML file.<br />
<br />
* Web Dicionary Maintence (APP)<br />
** WebAPI - Interface between user's GUI and server.<br />
** Temporary Database - Temporary database in which the XML file will be loaded with the crosses made.<br />
** JavaGit Connector - API to execute necessary Git functions.<br />
** WebDictionary Controller <br />
<br />
* Git <br />
** GitRepository - Repository containing the dictionaries<br />
** GitLab - Repository management tool<br />
** GitHub - Repository management tool<br />
<br />
[[File:SequenceDiagramWebDictionary.jpg|thumb|700px|right|Components Diagram]]<br />
<br />
==How it Works?==<br />
We will develop a WebInterface to lay users add words or suggest modifications.<br />
We are planning to use Git as an administrative and version control tool.<br />
<br />
* All dictionaries releases will be in a single repository and available to any member of the community to continue the work.<br />
* Each user will have your own branch to work on.<br />
* The users will be able to make merge requests with the official branch.<br />
* At first, we will use GitLab (or similar tool) to manage this merges requests. The team who maintain each dictionary will judge if the modifications are valid or not.<br />
<br />
=Example of Interaction - Adding new lemma to a dictionary=<br />
<br /><br />
<br /><br />
<br /><br />
<br /><br />
{| class="wikitable" border="1"<br />
|-<br />
! Stage<br />
! Description<br />
! Image<br />
|-<br />
| 1<br />
| ''' Choosing an official dictionary and importing it ''' <br />
The Official Dictionaries page display all available dictionaries in the git repository. <br />
<br />
Each version correspond to a tag in the master branch. <br />
<br />
Once imported, the user will name this dictionary and it will appear on the My Dictionaries page.<br />
| [[File:Prototype1.png|thumb|600px|center|Choosing an official dictionary and importing it]] <br />
[[File:Git1.png|thumb|600px|center|Master branch]]<br />
[[File:Prototype2.png|thumb|600px|center|My Dictionaries page]]<br />
|-<br />
| 2<br />
| ''' Loading the dictionary file ''' , <br />
On the Language File page, the user selects one of their dictionaries and the dictionary XML will be formatted to be temporarily saved to a database. Also on this page, the user can edit the dictionary alphabet and see some statistics about it.<br />
The Symbols, Paradigms, and Lemmas pages refer to the dictionary selected here.<br />
| [[File:Prototype3.png|thumb|600px|center|Loading the dictionary file]] <br />
|-<br />
| 3<br />
| '''Verifying if the lemmas already exists''' <br />
On the Lemmas - Search page, the user will be able to see all the inflections of the dictionary lemmas and check if the lemma he wants to add already exists.<br />
| [[File:Prototype4.png|thumb|600px|center|Verifying if the lemmas already exists]]<br />
|-<br />
| 4.1<br />
| ''' Creating the new lemma - Step 1 ''' <br />
In the Lemmas - Create page, the user will follow three steps to add a new lemma.<br />
<br />
In the first step, the user will define the lemma and the lemma root. In addition, he will give some examples of inflections and symbols to receive suggestions on which paradigm to use.<br />
| [[File:Prototype5.png|thumb|600px|center|text-top|Creating the new lemma - Step 1]]<br />
|-<br />
| 4.2<br />
| ''' Creating the new lemma - Step 2 ''' <br />
<br />
In the second step, the user will see paradigm suggestions (or can see all paradigms). When a paradigm is selected, all inflections of the created lemma will be shown to the user. If none of the paradigms fit, the user will be directed to create a new paradigm. <br />
| [[File:Prototype6.png|thumb|600px|center|Creating the new lemma - Step 2]]<br />
|-<br />
| 4.3<br />
| ''' Creating the new lemma - Step 3 ''' <br />
<br />
In the third and last step, the user will confirm and save the change. At this point, a branch will be create for this dictionary in the git repository (if she doesn’t already exists) and a commit with this changes will be done. <br />
| [[File:Prototype7.png|thumb|600px|right|Creating the new lemma - Step 3]]<br />
[[File:Git2.png|thumb|600px|center|New branch created in Git]]<br />
|-<br />
| 5<br />
| '''Merge Request''' <br />
<br />
On My Dictionaries page, the user can create a merge request that will be judge by the master branch maintainer.<br />
<br />
| [[File:Prototype8.png|thumb|600px|center|Merge Request]]<br />
|-<br />
| 6<br />
| '''Official dictionary keeper judges the merge request'''<br />
In GitLab (or similar tool), the dictionary maintainer will see the list of merge requests.<br />
<br />
At each request, the maintainer can view all commits and accepts only a few of them.<br />
<br />
At each commit, he will judge the changes.<br />
<br />
When he accepts the merge request, the user's branch is deleted.<br />
<br />
|[[File:Git5.png|thumb|600px|center|Merge request list]]<br />
<br />
[[File:Git6.png|thumb|600px|center|Commits from current merge request]]<br />
<br />
[[File:Git7.png|thumb|600px|center|Changes]]<br />
<br />
[[File:Git4.png|thumb|600px|center|GitLab Graph]]<br />
|-<br />
| 7<br />
| '''Feedback''' <br />
<br />
On Merge Requests page, the user can see all request he have made and their status.<br />
| [[File:Prototype9.png|thumb|600px|center|Feedback]]<br />
|-<br />
| <br />
| '''Final Release'''<br />
|<br />
|}<br />
<br />
[[Category:GSoC 2019 student proposals]]</div>Alessiohttps://wiki.apertium.org/w/index.php?title=Web_Dictionary_Maintenance&diff=69221Web Dictionary Maintenance2019-04-04T18:15:20Z<p>Alessio: /* Description */</p>
<hr />
<div>{{TOCD}}<br />
<br />
[https://translate.google.com/translate?sl=en&tl=pt-br&prev=_t&hl=en&u=http://wiki.apertium.org/wiki/Web_Dictionary_Maintenance Translate to PT-BR with Google Tradução]<br />
<br />
= Introduction =<br />
<br />
Apertium over the years still has deficiencies so that lay people can contribute to increase the base of words in dictionaries, even with simple contributions. Collaboration is the key to developing a tool that serves a huge range of users throughout the world. We believe that it is possible to engage more users and thus give greater impact to the tool within the communities where there is involvement. We will deal in this document with requirements on non-functional and technical objectives regarding the tool proposal.<br />
<br />
;Original Ideias<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code/Easy_dictionary_maintenance<br />
<br />
;Original GSOC2019 Application<br />
: http://wiki.apertium.org/wiki/User:Alessiojr/Easy_dictionary_-_Application-GSOC2019<br />
<br />
;Studant Information<br />
: '''Student:''' Vinícius Silva Nogueira <br /><br />
: '''Unofficial Mentor:''' Alessio Miranda Junior<br /><br />
: '''Telegram/Whatsapp:''' Alessio: +55 (31) 9.8888-7770<br /><br />
: '''E-mail:''' alessio@cefetmg.br or vinicius_snogueira@hotmail.com / viniciussnogueira13@gmail.com<br /><br />
: '''IRC:''' Viniciussn or AlessioJr<br /><br />
: '''GTalk:''' alessiojunin@gmail.com<br />
<br />
=Description=<br />
==Abstract:==<br />
The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps away potential contributors. A tool that facilitates the work of dictionaries developers, eliminate computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
Even with several tools that help the way you manage and create dictionaries, Apertium is far from the normal users, who have a huge contribution potential. Or even create a simple way to create contributions to recurring users with advanced knowledge. Although it is a bold plan, and there are several possible and desirable requirements, we will describe some basic premises for this step and that must be respected and aligned with the apertium developer community.<br />
<br />
==Definitions==<br />
:* Lay users do not need to know Apertium's internal structure.<br />
:* Intermediate users need to have a knowledge of dictionary management methodology. <br />
:* Advanced users are those who know the structure of Apertium.<br />
:* Communities are user groups that merge characteristics to the database extension of a dictionary of a specific language.<br />
:* Official dictionaries are dictionaries managed and with seal of the apertium community.<br />
:* Unofficial dictionaries are dictionaries run by an independent community.<br />
:* Test dictionaries are deprived of users to test their contributions.<br />
<br />
==Objectives:==<br />
:* The major goal of the project is to develop a web tool to facilitate the management of the Apertium (XML's) database of integrators for novice and advanced users.<br />
:* New communities of contributions should be able to organize independently of a central command. The command exists but will be distributed.<br />
:* Lay users who feel motivated to contribute, should have an interface that promotes ease in contributing even with limited possibilities.<br />
:* The development of dictionaries should be collaborative and distributed. Each dictionary should have a management community, but a user may have the freedom to disagree and create a new version maintaining a history of the author.<br />
:* Any tool should maintain the traditional Apertium structure and not be interoperable between existing tools.<br />
:* There must be a methodology for communities to maintain the quality of their dictionaries. Although they are distributed the goal is to create a unified and mature dictionary.<br />
<br />
==Questions:==<br />
:* Dixtools is avaliable? Problems?<br />
:* Any Problem to use Gitlab (OpenSource) Like projetos.a2portais.com.br or gitlab<br />
<br />
=Technical Objectives:=<br />
:* Develop, initially, monolingual dictionaries but keeping the particular format of each file.<br />
:* Minimize the direct manipulation of XML files, providing features that reduce this need.<br />
:* Making use of GitLab as an administrative and control tool.<br />
<br />
== Git, GitLab and Apertium ==<br />
[[File:Git_flow_demonstration.jpg|thumb|250px|right|Git Flow demonstration]]<br />
As the Apertium files are textual, we had the idea of seeking productivity and using existing and consolidated tools in the world.<br />
The proposal is to build a friendly web interface for lay users, but use git's own Back-End as version control and to make dictionary management GitLab as an administrative tool that already guarantees incredible power for remote collaboration.<br />
<br />
To demonstrate this relationship we will highlight some concepts of Git. Over time there may be several TimeLines:<br />
:* The Official Branch (Master) has the official version of the apertium managed by official developers or maintainers.<br />
:* Users have the power to create new Branches and develop unofficial dictionaries in parallel, creating communities that may from time to time suggest modifications to Brach Master.<br />
:* These requests can be accepted or rejected by maintainers, and this format is recursive and other developers can create unofficial copies of unofficial ones.<br />
:* Integration requests will use the Merge Request concepts present in tools such as GitLab that will be the BackEnd for advanced users.<br />
<br />
=Application-GSOC2019=<br />
===Abstract:===<br />
The idea is to develop the Web tool so that lay users contribute to dictionaries and use Git management with GitLab to manage these changes.<br />
* The focus will be on monolingual dictionaries and bilingual direct relationships.<br />
* Use the Git methodology and propose a guideline or flow for collaborative dictionary management.<br />
* Do not change the current XML format of dictionaries.<br />
<br />
===Why is it you are interested in machine translation and Apertium?===<br />
<br />
During the graduation course, Professor Aléssio demonstrated the need and opportunity to contribute with open source projects. <br />
He introduced me to Apertium and in my final graduation work I started reading and talking about it. <br />
We started discussing techniques for managing collaboration with the community and currently do not have <br />
as much knowledge about machine translation machines but I have experience in developing applications <br />
and web using collaboration with Git and GitLab.<br />
<br />
===Which of the published tasks are you interested in?===<br />
<br />
[http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code/Easy_dictionary_maintenance Easy dictionary maintenance]<br />
<br />
===Why should Google and Apertium sponsor it?===<br />
<br />
This project will have an impact in all languages. Facilitating dictionary manipulation will benefit everyone,<br />
allowing a wider range of people to contribute to existing dictionaries and start new language projects.<br />
<br />
===How and who will it benefit in society?===<br />
This application will benefit the entire Apertium community.<br />
Dictionary developers will have a tool to speed up their work and an easy-to-use tool will attract new contributors.<br />
As a result, Apertium's translation capacity will be increased, bringing better results to the end user.<br />
<br />
===What do you plan to do?===<br />
We are planning to create a web GUI that will facilitate common tasks of creating/modifying dictionaries and allow lay users to contribute to a dictionary.<br />
The application will be connected to a Git repository, which will be used as an administrative and version control tool.<br />
<br />
<br />
<br />
'''Program Language:''' Java, JavaScript<br /><br />
'''Persistence:''' XML (Apertium XML Files)<br /><br />
'''Framworks:''' Angular<br /><br />
<br />
===Stages/Milestones===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Week<br />
! Stage<br />
! Description<br />
|-<br />
| Community Bonding Period<br />
| Technology analysis<br />
|Analyze and find a good way to manipulate XML in a database.<br />
Testing and choosing the best alternative.<br />
<br />
UML diagrams of the project.<br />
|-<br />
| 1, 2<br />
| --<br />
|Database modeling and creation.<br />
<br />
Implementation of GitConnector.<br />
<br />
|-<br />
| 2, 3<br />
| --<br />
| WebAPI development.<br />
<br />
GUI prototype developement for monolingual dictionary: Symbols, Paradigms and Lemmas.<br />
|-<br />
| 3, 4<br />
| --<br />
| GUI prototype developement for bilingual dictionary.<br />
|-<br />
| '''Prototype'''<br />
| Milestone 1<br />
| First version of GUI for community analysis.<br />
|-<br />
| 5, 6<br />
| --<br />
| Development of WebDictionaryController (monolingual and bilingual dictionary).<br />
|-<br />
| 7, 8<br />
| --<br />
| Adjustments and adding new features with community feedback.<br />
|-<br />
| 9<br />
| --<br />
| Functionalities integrations, test and fixes.<br />
|-<br />
| '''Prototype'''<br />
| Milestone 2<br />
| First functional release for community analysis.<br />
|-<br />
| 10, 11<br />
| --<br />
| Adjustments and adding new features with community feedback.<br />
|-<br />
| 12<br />
| Pré-Release<br />
| Fix remain bugs, final adjustments and documentation in Wiki<br />
|-<br />
| <br />
| '''Final Release'''<br />
|Final version realease.<br />
|}<br />
<br />
===Presentation===<br />
<br />
My name is Vinicius, a Brazilian Student at Federal Center for Technological Education of Minas Gerais - Brazil.<br />
<br />
===Resume of Skills===<br />
<br />
Apertium Knowledge:<br />
<br />
* Study to develop a collaborative tool for apertium.<br />
* A study of actual Apertium process about creating a language pair by the user point of view.<br />
* Analysis of the characteristics of the 2010 project of Aléssio and adaptation to current times.<br />
<br />
Academic Skills:<br />
<br />
* Graduating in Computer Engineering- Federal Center for Technological Education of Minas Gerais – Brazil<br />
<br />
Professional Skills:<br />
<br />
* Language developer: C, Java, JavaScript, PHP, Phyton, PL/SQL.<br />
<br />
Projects for Summer:<br />
<br />
* No professional activities planned.<br />
* Planning to work in GSOC<br />
<br />
=Project=<br />
==Why?==<br />
:* The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps potential contributors away. A tool that facilitates the work of dictionaries developers, eliminate the need of computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
==What its the plan?==<br />
:* We are planning to create a web GUI that allows the user to develop the basic tasks of dictionaries and translation pairs manipulation in an easy and practical way.<br />
:* We will use Git as an administrative and control tool, allowing the user to contribute to the work of other community members or start your own project.<br />
<br />
==Components ans Technologies==<br />
[[File:ComponentDiagramWebDictionary.jpg|thumb|700px|right|Components Diagram]]<br />
* Actors<br />
** Lay User <br />
** Dictionary Admin <br />
<br />
* UserBrowser <br />
** WebInterface with AngularJS - GUI to easily manipulate the dictionary XML file.<br />
<br />
* Web Dicionary Maintence (APP)<br />
** WebAPI - Interface between user's GUI and server.<br />
** Temporary Database - Temporary database in which the XML file will be loaded with the crosses made.<br />
** JavaGit Connector - API to execute necessary Git functions.<br />
** WebDictionary Controller <br />
<br />
* Git <br />
** GitRepository - Repository containing the dictionaries<br />
** GitLab - Repository management tool<br />
** GitHub - Repository management tool<br />
<br />
[[File:SequenceDiagramWebDictionary.jpg|thumb|700px|right|Components Diagram]]<br />
<br />
==How it Works?==<br />
We will develop a WebInterface to lay users add words or suggest modifications.<br />
We are planning to use Git as an administrative and version control tool.<br />
<br />
* All dictionaries releases will be in a single repository and available to any member of the community to continue the work.<br />
* Each user will have your own branch to work on.<br />
* The users will be able to make merge requests with the official branch.<br />
* At first, we will use GitLab (or similar tool) to manage this merges requests. The team who maintain each dictionary will judge if the modifications are valid or not.<br />
<br />
=Example of Interaction - Adding new lemma to a dictionary=<br />
<br /><br />
<br /><br />
<br /><br />
<br /><br />
{| class="wikitable" border="1"<br />
|-<br />
! Stage<br />
! Description<br />
! Image<br />
|-<br />
| 1<br />
| ''' Choosing an official dictionary and importing it ''' <br />
The Official Dictionaries page display all available dictionaries in the git repository. <br />
<br />
Each version correspond to a tag in the master branch. <br />
<br />
Once imported, the user will name this dictionary and it will appear on the My Dictionaries page.<br />
| [[File:Prototype1.png|thumb|600px|center|Choosing an official dictionary and importing it]] <br />
[[File:Git1.png|thumb|600px|center|Master branch]]<br />
[[File:Prototype2.png|thumb|600px|center|My Dictionaries page]]<br />
|-<br />
| 2<br />
| ''' Loading the dictionary file ''' , <br />
On the Language File page, the user selects one of their dictionaries and the dictionary XML will be formatted to be temporarily saved to a database. Also on this page, the user can edit the dictionary alphabet and see some statistics about it.<br />
The Symbols, Paradigms, and Lemmas pages refer to the dictionary selected here.<br />
| [[File:Prototype3.png|thumb|600px|center|Loading the dictionary file]] <br />
|-<br />
| 3<br />
| '''Verifying if the lemmas already exists''' <br />
On the Lemmas - Search page, the user will be able to see all the inflections of the dictionary lemmas and check if the lemma he wants to add already exists.<br />
| [[File:Prototype4.png|thumb|600px|center|Verifying if the lemmas already exists]]<br />
|-<br />
| 4.1<br />
| ''' Creating the new lemma - Step 1 ''' <br />
In the Lemmas - Create page, the user will follow three steps to add a new lemma.<br />
<br />
In the first step, the user will define the lemma and the lemma root. In addition, he will give some examples of inflections and symbols to receive suggestions on which paradigm to use.<br />
| [[File:Prototype5.png|thumb|600px|center|text-top|Creating the new lemma - Step 1]]<br />
|-<br />
| 4.2<br />
| ''' Creating the new lemma - Step 2 ''' <br />
<br />
In the second step, the user will see paradigm suggestions (or can see all paradigms). When a paradigm is selected, all inflections of the created lemma will be shown to the user. If none of the paradigms fit, the user will be directed to create a new paradigm. <br />
| [[File:Prototype6.png|thumb|600px|center|Creating the new lemma - Step 2]]<br />
|-<br />
| 4.3<br />
| ''' Creating the new lemma - Step 3 ''' <br />
<br />
In the third and last step, the user will confirm and save the change. At this point, a branch will be create for this dictionary in the git repository (if she doesn’t already exists) and a commit with this changes will be done. <br />
| [[File:Prototype7.png|thumb|600px|right|Creating the new lemma - Step 3]]<br />
[[File:Git2.png|thumb|600px|center|New branch created in Git]]<br />
|-<br />
| 5<br />
| '''Merge Request''' <br />
<br />
On My Dictionaries page, the user can create a merge request that will be judge by the master branch maintainer.<br />
<br />
| [[File:Prototype8.png|thumb|600px|center|Merge Request]]<br />
|-<br />
| 6<br />
| '''Official dictionary keeper judges the merge request'''<br />
In GitLab (or similar tool), the dictionary maintainer will see the list of merge requests.<br />
<br />
At each request, the maintainer can view all commits and accepts only a few of them.<br />
<br />
At each commit, he will judge the changes.<br />
<br />
When he accepts the merge request, the user's branch is deleted.<br />
<br />
|[[File:Git5.png|thumb|600px|center|Merge request list]]<br />
<br />
[[File:Git6.png|thumb|600px|center|Commits from current merge request]]<br />
<br />
[[File:Git7.png|thumb|600px|center|Changes]]<br />
<br />
[[File:Git4.png|thumb|600px|center|GitLab Graph]]<br />
|-<br />
| 7<br />
| '''Feedback''' <br />
<br />
On Merge Requests page, the user can see all request he have made and their status.<br />
| [[File:Prototype9.png|thumb|600px|center|Feedback]]<br />
|-<br />
| <br />
| '''Final Release'''<br />
|<br />
|}<br />
<br />
[[Category:GSoC 2019 student proposals]]</div>Alessiohttps://wiki.apertium.org/w/index.php?title=Web_Dictionary_Maintenance&diff=69197Web Dictionary Maintenance2019-04-03T01:31:19Z<p>Alessio: /* Introduction */</p>
<hr />
<div>{{TOCD}}<br />
<br />
[https://translate.google.com/translate?sl=en&tl=pt-br&prev=_t&hl=en&u=http://wiki.apertium.org/wiki/Web_Dictionary_Maintenance Translate to PT-BR with Google Tradução]<br />
<br />
= Introduction =<br />
<br />
Apertium over the years still has deficiencies so that lay people can contribute to increase the base of words in dictionaries, even with simple contributions. Collaboration is the key to developing a tool that serves a huge range of users throughout the world. We believe that it is possible to engage more users and thus give greater impact to the tool within the communities where there is involvement. We will deal in this document with requirements on non-functional and technical objectives regarding the tool proposal.<br />
<br />
;Original Ideias<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code/Easy_dictionary_maintenance<br />
<br />
;Original GSOC2019 Application<br />
: http://wiki.apertium.org/wiki/User:Alessiojr/Easy_dictionary_-_Application-GSOC2019<br />
<br />
;Studant Information<br />
: '''Student:''' Vinícius Silva Nogueira <br /><br />
: '''Unofficial Mentor:''' Alessio Miranda Junior<br /><br />
: '''Telegram/Whatsapp:''' Alessio: +55 (31) 9.8888-7770<br /><br />
: '''E-mail:''' alessio@cefetmg.br or vinicius_snogueira@hotmail.com / viniciussnogueira13@gmail.com<br /><br />
: '''IRC:''' Viniciussn or AlessioJr<br /><br />
: '''GTalk:''' alessiojunin@gmail.com<br />
<br />
=Description=<br />
==Abstract:==<br />
The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps away potential contributors. A tool that facilitates the work of dictionaries developers, eliminate computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
Even with several tools that help the way you manage and create dictionaries, Apertium is far from the normal users, who have a huge contribution potential. Or even create a simple way to create contributions to recurring users with advanced knowledge. Although it is a bold plan, and there are several possible and desirable requirements, we will describe some basic premises for this step and that must be respected and aligned with the apertium developer community.<br />
<br />
==Definitions==<br />
:* Lay users do not need to know Apertium's internal structure.<br />
:* Intermediate users need to have a knowledge of dictionary management methodology. <br />
:* Advanced users are those who know the structure of Apertium.<br />
:* Communities are user groups that merge characteristics to the database extension of a dictionary of a specific language.<br />
:* Official dictionaries are dictionaries managed and with seal of the apertium community.<br />
:* Unofficial dictionaries are dictionaries run by an independent community.<br />
:* Test dictionaries are deprived of users to test their contributions.<br />
<br />
==Objectives:==<br />
:* The major goal of the project is to develop a web tool to facilitate the management of the Apertium (XML's) database of integrators for novice and advanced users.<br />
:* New communities of contributions should be able to organize independently of a central command. The command exists but will be distributed.<br />
:* Lay users who feel motivated to contribute, should have an interface that promotes ease in contributing even with limited possibilities.<br />
:* The development of dictionaries should be collaborative and distributed. Each dictionary should have a management community, but a user may have the freedom to disagree and create a new version maintaining a history of the author.<br />
:* Any tool should maintain the traditional Apertium structure and not be interoperable between existing tools.<br />
:* There must be a methodology for communities to maintain the quality of their dictionaries. Although they are distributed the goal is to create a unified and mature dictionary.<br />
<br />
=Technical Objectives:=<br />
:* Develop, initially, monolingual dictionaries but keeping the particular format of each file.<br />
:* Minimize the direct manipulation of XML files, providing features that reduce this need.<br />
:* Making use of GitLab as an administrative and control tool.<br />
<br />
== Git, GitLab and Apertium ==<br />
[[File:Git_flow_demonstration.jpg|thumb|250px|right|Git Flow demonstration]]<br />
As the Apertium files are textual, we had the idea of seeking productivity and using existing and consolidated tools in the world.<br />
The proposal is to build a friendly web interface for lay users, but use git's own Back-End as version control and to make dictionary management GitLab as an administrative tool that already guarantees incredible power for remote collaboration.<br />
<br />
To demonstrate this relationship we will highlight some concepts of Git. Over time there may be several TimeLines:<br />
:* The Official Branch (Master) has the official version of the apertium managed by official developers or maintainers.<br />
:* Users have the power to create new Branches and develop unofficial dictionaries in parallel, creating communities that may from time to time suggest modifications to Brach Master.<br />
:* These requests can be accepted or rejected by maintainers, and this format is recursive and other developers can create unofficial copies of unofficial ones.<br />
:* Integration requests will use the Merge Request concepts present in tools such as GitLab that will be the BackEnd for advanced users.<br />
<br />
=Application-GSOC2019=<br />
===Abstract:===<br />
The idea is to develop the Web tool so that lay users contribute to dictionaries and use Git management with GitLab to manage these changes.<br />
* The focus will be on monolingual dictionaries and bilingual direct relationships.<br />
* Use the Git methodology and propose a guideline or flow for collaborative dictionary management.<br />
* Do not change the current XML format of dictionaries.<br />
<br />
===Why is it you are interested in machine translation and Apertium?===<br />
<br />
During the graduation course, Professor Aléssio demonstrated the need and opportunity to contribute with open source projects. <br />
He introduced me to Apertium and in my final graduation work I started reading and talking about it. <br />
We started discussing techniques for managing collaboration with the community and currently do not have <br />
as much knowledge about machine translation machines but I have experience in developing applications <br />
and web using collaboration with Git and GitLab.<br />
<br />
===Which of the published tasks are you interested in?===<br />
<br />
[http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code/Easy_dictionary_maintenance Easy dictionary maintenance]<br />
<br />
===Why should Google and Apertium sponsor it?===<br />
<br />
This project will have an impact in all languages. Facilitating dictionary manipulation will benefit everyone,<br />
allowing a wider range of people to contribute to existing dictionaries and start new language projects.<br />
<br />
===How and who will it benefit in society?===<br />
This application will benefit the entire Apertium community.<br />
Dictionary developers will have a tool to speed up their work and an easy-to-use tool will attract new contributors.<br />
As a result, Apertium's translation capacity will be increased, bringing better results to the end user.<br />
<br />
===What do you plan to do?===<br />
We are planning to create a web GUI that will facilitate common tasks of creating/modifying dictionaries and allow lay users to contribute to a dictionary.<br />
The application will be connected to a Git repository, which will be used as an administrative and version control tool.<br />
<br />
<br />
<br />
'''Program Language:''' Java, JavaScript<br /><br />
'''Persistence:''' XML (Apertium XML Files)<br /><br />
'''Framworks:''' Angular<br /><br />
<br />
===Stages/Milestones===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Week<br />
! Stage<br />
! Description<br />
|-<br />
| Community Bonding Period<br />
| Technology analysis<br />
|Analyze and find a good way to manipulate XML in a database.<br />
Testing and choosing the best alternative.<br />
<br />
UML diagrams of the project.<br />
|-<br />
| 1, 2<br />
| --<br />
|Database modeling and creation.<br />
<br />
Implementation of GitConnector.<br />
<br />
|-<br />
| 2, 3<br />
| --<br />
| WebAPI development.<br />
<br />
GUI prototype developement for monolingual dictionary: Symbols, Paradigms and Lemmas.<br />
|-<br />
| 3, 4<br />
| --<br />
| GUI prototype developement for bilingual dictionary.<br />
|-<br />
| '''Prototype'''<br />
| Milestone 1<br />
| First version of GUI for community analysis.<br />
|-<br />
| 5, 6<br />
| --<br />
| Development of WebDictionaryController (monolingual and bilingual dictionary).<br />
|-<br />
| 7, 8<br />
| --<br />
| Adjustments and adding new features with community feedback.<br />
|-<br />
| 9<br />
| --<br />
| Functionalities integrations, test and fixes.<br />
|-<br />
| '''Prototype'''<br />
| Milestone 2<br />
| First functional release for community analysis.<br />
|-<br />
| 10, 11<br />
| --<br />
| Adjustments and adding new features with community feedback.<br />
|-<br />
| 12<br />
| Pré-Release<br />
| Fix remain bugs, final adjustments and documentation in Wiki<br />
|-<br />
| <br />
| '''Final Release'''<br />
|Final version realease.<br />
|}<br />
<br />
===Presentation===<br />
<br />
My name is Vinicius, a Brazilian Student at Federal Center for Technological Education of Minas Gerais - Brazil.<br />
<br />
===Resume of Skills===<br />
<br />
Apertium Knowledge:<br />
<br />
* Study to develop a collaborative tool for apertium.<br />
* A study of actual Apertium process about creating a language pair by the user point of view.<br />
* Analysis of the characteristics of the 2010 project of Aléssio and adaptation to current times.<br />
<br />
Academic Skills:<br />
<br />
* Graduating in Computer Engineering- Federal Center for Technological Education of Minas Gerais – Brazil<br />
<br />
Professional Skills:<br />
<br />
* Language developer: C, Java, JavaScript, PHP, Phyton, PL/SQL.<br />
<br />
Projects for Summer:<br />
<br />
* No professional activities planned.<br />
* Planning to work in GSOC<br />
<br />
=Project=<br />
==Why?==<br />
:* The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps potential contributors away. A tool that facilitates the work of dictionaries developers, eliminate the need of computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
==What its the plan?==<br />
:* We are planning to create a web GUI that allows the user to develop the basic tasks of dictionaries and translation pairs manipulation in an easy and practical way.<br />
:* We will use Git as an administrative and control tool, allowing the user to contribute to the work of other community members or start your own project.<br />
<br />
==Components ans Technologies==<br />
[[File:ComponentDiagramWebDictionary.jpg|thumb|700px|right|Components Diagram]]<br />
* Actors<br />
** Lay User <br />
** Dictionary Admin <br />
<br />
* UserBrowser <br />
** WebInterface with AngularJS - GUI to easily manipulate the dictionary XML file.<br />
<br />
* Web Dicionary Maintence (APP)<br />
** WebAPI - Interface between user's GUI and server.<br />
** Temporary Database - Temporary database in which the XML file will be loaded with the crosses made.<br />
** JavaGit Connector - API to execute necessary Git functions.<br />
** WebDictionary Controller <br />
<br />
* Git <br />
** GitRepository - Repository containing the dictionaries<br />
** GitLab - Repository management tool<br />
** GitHub - Repository management tool<br />
<br />
[[File:SequenceDiagramWebDictionary.jpg|thumb|700px|right|Components Diagram]]<br />
<br />
==How it Works?==<br />
We will develop a WebInterface to lay users add words or suggest modifications.<br />
We are planning to use Git as an administrative and version control tool.<br />
<br />
* All dictionaries releases will be in a single repository and available to any member of the community to continue the work.<br />
* Each user will have your own branch to work on.<br />
* The users will be able to make merge requests with the official branch.<br />
* At first, we will use GitLab (or similar tool) to manage this merges requests. The team who maintain each dictionary will judge if the modifications are valid or not.<br />
<br />
=Example of Interaction - Adding new lemma to a dictionary=<br />
<br /><br />
<br /><br />
<br /><br />
<br /><br />
{| class="wikitable" border="1"<br />
|-<br />
! Stage<br />
! Description<br />
! Image<br />
|-<br />
| 1<br />
| ''' Choosing an official dictionary and importing it ''' <br />
The Official Dictionaries page display all available dictionaries in the git repository. <br />
<br />
Each version correspond to a tag in the master branch. <br />
<br />
Once imported, the user will name this dictionary and it will appear on the My Dictionaries page.<br />
| [[File:Prototype1.png|thumb|600px|center|Choosing an official dictionary and importing it]] <br />
[[File:Git1.png|thumb|600px|center|Master branch]]<br />
[[File:Prototype2.png|thumb|600px|center|My Dictionaries page]]<br />
|-<br />
| 2<br />
| ''' Loading the dictionary file ''' , <br />
On the Language File page, the user selects one of their dictionaries and the dictionary XML will be formatted to be temporarily saved to a database. Also on this page, the user can edit the dictionary alphabet and see some statistics about it.<br />
The Symbols, Paradigms, and Lemmas pages refer to the dictionary selected here.<br />
| [[File:Prototype3.png|thumb|600px|center|Loading the dictionary file]] <br />
|-<br />
| 3<br />
| '''Verifying if the lemmas already exists''' <br />
On the Lemmas - Search page, the user will be able to see all the inflections of the dictionary lemmas and check if the lemma he wants to add already exists.<br />
| [[File:Prototype4.png|thumb|600px|center|Verifying if the lemmas already exists]]<br />
|-<br />
| 4.1<br />
| ''' Creating the new lemma - Step 1 ''' <br />
In the Lemmas - Create page, the user will follow three steps to add a new lemma.<br />
<br />
In the first step, the user will define the lemma and the lemma root. In addition, he will give some examples of inflections and symbols to receive suggestions on which paradigm to use.<br />
| [[File:Prototype5.png|thumb|600px|center|text-top|Creating the new lemma - Step 1]]<br />
|-<br />
| 4.2<br />
| ''' Creating the new lemma - Step 2 ''' <br />
<br />
In the second step, the user will see paradigm suggestions (or can see all paradigms). When a paradigm is selected, all inflections of the created lemma will be shown to the user. If none of the paradigms fit, the user will be directed to create a new paradigm. <br />
| [[File:Prototype6.png|thumb|600px|center|Creating the new lemma - Step 2]]<br />
|-<br />
| 4.3<br />
| ''' Creating the new lemma - Step 3 ''' <br />
<br />
In the third and last step, the user will confirm and save the change. At this point, a branch will be create for this dictionary in the git repository (if she doesn’t already exists) and a commit with this changes will be done. <br />
| [[File:Prototype7.png|thumb|600px|right|Creating the new lemma - Step 3]]<br />
[[File:Git2.png|thumb|600px|center|New branch created in Git]]<br />
|-<br />
| 5<br />
| '''Merge Request''' <br />
<br />
On My Dictionaries page, the user can create a merge request that will be judge by the master branch maintainer.<br />
<br />
| [[File:Prototype8.png|thumb|600px|center|Merge Request]]<br />
|-<br />
| 6<br />
| '''Official dictionary keeper judges the merge request'''<br />
In GitLab (or similar tool), the dictionary maintainer will see the list of merge requests.<br />
<br />
At each request, the maintainer can view all commits and accepts only a few of them.<br />
<br />
At each commit, he will judge the changes.<br />
<br />
When he accepts the merge request, the user's branch is deleted.<br />
<br />
|[[File:Git5.png|thumb|600px|center|Merge request list]]<br />
<br />
[[File:Git6.png|thumb|600px|center|Commits from current merge request]]<br />
<br />
[[File:Git7.png|thumb|600px|center|Changes]]<br />
<br />
[[File:Git4.png|thumb|600px|center|GitLab Graph]]<br />
|-<br />
| 7<br />
| '''Feedback''' <br />
<br />
On Merge Requests page, the user can see all request he have made and their status.<br />
| [[File:Prototype9.png|thumb|600px|center|Feedback]]<br />
|-<br />
| <br />
| '''Final Release'''<br />
|<br />
|}<br />
<br />
[[Category:GSoC 2019 student proposals]]</div>Alessiohttps://wiki.apertium.org/w/index.php?title=Web_Dictionary_Maintenance&diff=69192Web Dictionary Maintenance2019-04-02T19:42:07Z<p>Alessio: /* Components ans Technologies */</p>
<hr />
<div>{{TOCD}}<br />
<br />
[https://translate.google.com/translate?sl=en&tl=pt-br&prev=_t&hl=en&u=http://wiki.apertium.org/wiki/Web_Dictionary_Maintenance Translate to PT-BR with Google Tradução]<br />
<br />
= Introduction =<br />
<br />
Apertium over the years still has deficiencies so that lay people can contribute to increase the base of words in dictionaries, even with simple contributions. Collaboration is the key to developing a tool that serves a huge range of users throughout the world. We believe that it is possible to engage more users and thus give greater impact to the tool within the communities where there is involvement. We will deal in this document with requirements on non-functional and technical objectives regarding the tool proposal.<br />
<br />
;Original Ideias<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code/Easy_dictionary_maintenance<br />
<br />
;Original GSOC2019 Application<br />
: http://wiki.apertium.org/wiki/User:Alessiojr/Easy_dictionary_-_Application-GSOC2019<br />
<br />
;Studant Information<br />
: '''Student:''' Vinícius Silva Nogueira <br /><br />
: '''Unofficial Mentor:''' Alessio Miranda Junior<br /><br />
: '''Telegram/Whatsapp:''' Alessio: +55 (31) 9.8888-7770<br /><br />
: '''E-mail:''' alessio@cefetmg.br or vinicius_snogueira@hotmail.com / viniciussnogueira13@gmail.com<br /><br />
: '''IRC:''' AlessioJr<br /><br />
: '''GTalk:''' alessiojunin@gmail.com<br />
<br />
=Description=<br />
==Abstract:==<br />
The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps away potential contributors. A tool that facilitates the work of dictionaries developers, eliminate computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
Even with several tools that help the way you manage and create dictionaries, Apertium is far from the normal users, who have a huge contribution potential. Or even create a simple way to create contributions to recurring users with advanced knowledge. Although it is a bold plan, and there are several possible and desirable requirements, we will describe some basic premises for this step and that must be respected and aligned with the apertium developer community.<br />
<br />
==Definitions==<br />
:* Lay users do not need to know Apertium's internal structure.<br />
:* Intermediate users need to have a knowledge of dictionary management methodology. <br />
:* Advanced users are those who know the structure of Apertium.<br />
:* Communities are user groups that merge characteristics to the database extension of a dictionary of a specific language.<br />
:* Official dictionaries are dictionaries managed and with seal of the apertium community.<br />
:* Unofficial dictionaries are dictionaries run by an independent community.<br />
:* Test dictionaries are deprived of users to test their contributions.<br />
<br />
==Objectives:==<br />
:* The major goal of the project is to develop a web tool to facilitate the management of the Apertium (XML's) database of integrators for novice and advanced users.<br />
:* New communities of contributions should be able to organize independently of a central command. The command exists but will be distributed.<br />
:* Lay users who feel motivated to contribute, should have an interface that promotes ease in contributing even with limited possibilities.<br />
:* The development of dictionaries should be collaborative and distributed. Each dictionary should have a management community, but a user may have the freedom to disagree and create a new version maintaining a history of the author.<br />
:* Any tool should maintain the traditional Apertium structure and not be interoperable between existing tools.<br />
:* There must be a methodology for communities to maintain the quality of their dictionaries. Although they are distributed the goal is to create a unified and mature dictionary.<br />
<br />
=Technical Objectives:=<br />
:* Develop, initially, monolingual dictionaries but keeping the particular format of each file.<br />
:* Minimize the direct manipulation of XML files, providing features that reduce this need.<br />
:* Making use of GitLab as an administrative and control tool.<br />
<br />
== Git, GitLab and Apertium ==<br />
[[File:Git_flow_demonstration.jpg|thumb|250px|right|Git Flow demonstration]]<br />
As the Apertium files are textual, we had the idea of seeking productivity and using existing and consolidated tools in the world.<br />
The proposal is to build a friendly web interface for lay users, but use git's own Back-End as version control and to make dictionary management GitLab as an administrative tool that already guarantees incredible power for remote collaboration.<br />
<br />
To demonstrate this relationship we will highlight some concepts of Git. Over time there may be several TimeLines:<br />
:* The Official Branch (Master) has the official version of the apertium managed by official developers or maintainers.<br />
:* Users have the power to create new Branches and develop unofficial dictionaries in parallel, creating communities that may from time to time suggest modifications to Brach Master.<br />
:* These requests can be accepted or rejected by maintainers, and this format is recursive and other developers can create unofficial copies of unofficial ones.<br />
:* Integration requests will use the Merge Request concepts present in tools such as GitLab that will be the BackEnd for advanced users.<br />
<br />
=Application-GSOC2019=<br />
===Abstract:===<br />
The idea is to develop the Web tool so that lay users contribute to dictionaries and use Git management with GitLab to manage these changes.<br />
* The focus will be on monolingual dictionaries and bilingual direct relationships.<br />
* Use the Git methodology and propose a guideline or flow for collaborative dictionary management.<br />
* Do not change the current XML format of dictionaries.<br />
<br />
===Why is it you are interested in machine translation and Apertium?===<br />
<br />
During the graduation course, Professor Aléssio demonstrated the need and opportunity to contribute with open source projects. <br />
He introduced me to Apertium and in my final graduation work I started reading and talking about it. <br />
We started discussing techniques for managing collaboration with the community and currently do not have <br />
as much knowledge about machine translation machines but I have experience in developing applications <br />
and web using collaboration with Git and GitLab.<br />
<br />
===Which of the published tasks are you interested in?===<br />
<br />
[http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code/Easy_dictionary_maintenance Easy dictionary maintenance]<br />
<br />
===Why should Google and Apertium sponsor it?===<br />
<br />
This project will have an impact in all languages. Facilitating dictionary manipulation will benefit everyone,<br />
allowing a wider range of people to contribute to existing dictionaries and start new language projects.<br />
<br />
===How and who will it benefit in society?===<br />
This application will benefit the entire Apertium community.<br />
Dictionary developers will have a tool to speed up their work and an easy-to-use tool will attract new contributors.<br />
As a result, Apertium's translation capacity will be increased, bringing better results to the end user.<br />
<br />
===What do you plan to do?===<br />
We are planning to create a web GUI that will facilitate common tasks of creating/modifying dictionaries and allow lay users to contribute to a dictionary.<br />
The application will be connected to a Git repository, which will be used as an administrative and version control tool.<br />
<br />
<br />
<br />
'''Program Language:''' Java, JavaScript<br /><br />
'''Persistence:''' XML (Apertium XML Files)<br /><br />
'''Framworks:''' Angular<br /><br />
<br />
===Stages/Milestones===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Week<br />
! Stage<br />
! Description<br />
|-<br />
| Community Bonding Period<br />
| Technology analysis<br />
|Analyze and find a good way to manipulate XML in a database.<br />
Testing and choosing the best alternative.<br />
<br />
UML diagrams of the project.<br />
|-<br />
| 1, 2<br />
| --<br />
|Database modeling and creation.<br />
<br />
Implementation of GitConnector.<br />
<br />
|-<br />
| 2, 3<br />
| --<br />
| WebAPI development.<br />
<br />
GUI prototype developement for monolingual dictionary: Symbols, Paradigms and Lemmas.<br />
|-<br />
| 3, 4<br />
| --<br />
| GUI prototype developement for bilingual dictionary.<br />
|-<br />
| '''Prototype'''<br />
| Milestone 1<br />
| First version of GUI for community analysis.<br />
|-<br />
| 5, 6<br />
| --<br />
| Development of WebDictionaryController (monolingual and bilingual dictionary).<br />
|-<br />
| 7, 8<br />
| --<br />
| Adjustments and adding new features with community feedback.<br />
|-<br />
| 9<br />
| --<br />
| Functionalities integrations, test and fixes.<br />
|-<br />
| '''Prototype'''<br />
| Milestone 2<br />
| First functional release for community analysis.<br />
|-<br />
| 10, 11<br />
| --<br />
| Adjustments and adding new features with community feedback.<br />
|-<br />
| 12<br />
| Pré-Release<br />
| Fix remain bugs, final adjustments and documentation in Wiki<br />
|-<br />
| <br />
| '''Final Release'''<br />
|Final version realease.<br />
|}<br />
<br />
===Presentation===<br />
<br />
My name is Vinicius, a Brazilian Student at Federal Center for Technological Education of Minas Gerais - Brazil.<br />
<br />
===Resume of Skills===<br />
<br />
Apertium Knowledge:<br />
<br />
* Study to develop a collaborative tool for apertium.<br />
* A study of actual Apertium process about creating a language pair by the user point of view.<br />
* Analysis of the characteristics of the 2010 project of Aléssio and adaptation to current times.<br />
<br />
Academic Skills:<br />
<br />
* Graduating in Computer Engineering- Federal Center for Technological Education of Minas Gerais – Brazil<br />
<br />
Professional Skills:<br />
<br />
* Language developer: C, Java, JavaScript, PHP, Phyton, PL/SQL.<br />
<br />
Projects for Summer:<br />
<br />
* No professional activities planned.<br />
* Planning to work in GSOC<br />
<br />
=Project=<br />
==Why?==<br />
:* The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps potential contributors away. A tool that facilitates the work of dictionaries developers, eliminate the need of computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
==What its the plan?==<br />
:* We are planning to create a web GUI that allows the user to develop the basic tasks of dictionaries and translation pairs manipulation in an easy and practical way.<br />
:* We will use Git as an administrative and control tool, allowing the user to contribute to the work of other community members or start your own project.<br />
<br />
==Components ans Technologies==<br />
[[File:ComponentDiagramWebDictionary.jpg|thumb|700px|right|Components Diagram]]<br />
* Actors<br />
** Lay User <br />
** Dictionary Admin <br />
<br />
* UserBrowser <br />
** WebInterface with AngularJS - GUI to easily manipulate the dictionary XML file.<br />
<br />
* Web Dicionary Maintence (APP)<br />
** WebAPI - Interface between user's GUI and server.<br />
** Temporary Database - Temporary database in which the XML file will be loaded with the crosses made.<br />
** JavaGit Connector - API to execute necessary Git functions.<br />
** WebDictionary Controller <br />
<br />
* Git <br />
** GitRepository - Repository containing the dictionaries<br />
** GitLab - Repository management tool<br />
** GitHub - Repository management tool<br />
<br />
[[File:SequenceDiagramWebDictionary.jpg|thumb|700px|right|Components Diagram]]<br />
<br />
==How it Works?==<br />
We will develop a WebInterface to lay users add words or suggest modifications.<br />
We are planning to use Git as an administrative and version control tool.<br />
<br />
* All dictionaries releases will be in a single repository and available to any member of the community to continue the work.<br />
* Each user will have your own branch to work on.<br />
* The users will be able to make merge requests with the official branch.<br />
* At first, we will use GitLab (or similar tool) to manage this merges requests. The team who maintain each dictionary will judge if the modifications are valid or not.<br />
<br />
=Example of Interaction - Adding new lemma to a dictionary=<br />
<br /><br />
<br /><br />
<br /><br />
<br /><br />
{| class="wikitable" border="1"<br />
|-<br />
! Stage<br />
! Description<br />
! Image<br />
|-<br />
| 1<br />
| ''' Choosing an official dictionary and importing it ''' <br />
The Official Dictionaries page display all available dictionaries in the git repository. <br />
<br />
Each version correspond to a tag in the master branch. <br />
<br />
Once imported, the user will name this dictionary and it will appear on the My Dictionaries page.<br />
| [[File:Prototype1.png|thumb|600px|center|Choosing an official dictionary and importing it]] <br />
[[File:Git1.png|thumb|600px|center|Master branch]]<br />
[[File:Prototype2.png|thumb|600px|center|My Dictionaries page]]<br />
|-<br />
| 2<br />
| ''' Loading the dictionary file ''' , <br />
On the Language File page, the user selects one of their dictionaries and the dictionary XML will be formatted to be temporarily saved to a database. Also on this page, the user can edit the dictionary alphabet and see some statistics about it.<br />
The Symbols, Paradigms, and Lemmas pages refer to the dictionary selected here.<br />
| [[File:Prototype3.png|thumb|600px|center|Loading the dictionary file]] <br />
|-<br />
| 3<br />
| '''Verifying if the lemmas already exists''' <br />
On the Lemmas - Search page, the user will be able to see all the inflections of the dictionary lemmas and check if the lemma he wants to add already exists.<br />
| [[File:Prototype4.png|thumb|600px|center|Verifying if the lemmas already exists]]<br />
|-<br />
| 4.1<br />
| ''' Creating the new lemma - Step 1 ''' <br />
In the Lemmas - Create page, the user will follow three steps to add a new lemma.<br />
<br />
In the first step, the user will define the lemma and the lemma root. In addition, he will give some examples of inflections and symbols to receive suggestions on which paradigm to use.<br />
| [[File:Prototype5.png|thumb|600px|center|text-top|Creating the new lemma - Step 1]]<br />
|-<br />
| 4.2<br />
| ''' Creating the new lemma - Step 2 ''' <br />
<br />
In the second step, the user will see paradigm suggestions (or can see all paradigms). When a paradigm is selected, all inflections of the created lemma will be shown to the user. If none of the paradigms fit, the user will be directed to create a new paradigm. <br />
| [[File:Prototype6.png|thumb|600px|center|Creating the new lemma - Step 2]]<br />
|-<br />
| 4.3<br />
| ''' Creating the new lemma - Step 3 ''' <br />
<br />
In the third and last step, the user will confirm and save the change. At this point, a branch will be create for this dictionary in the git repository (if she doesn’t already exists) and a commit with this changes will be done. <br />
| [[File:Prototype7.png|thumb|600px|right|Creating the new lemma - Step 3]]<br />
[[File:Git2.png|thumb|600px|center|New branch created in Git]]<br />
|-<br />
| 5<br />
| '''Merge Request''' <br />
<br />
On My Dictionaries page, the user can create a merge request that will be judge by the master branch maintainer.<br />
<br />
| [[File:Prototype8.png|thumb|600px|center|Merge Request]]<br />
|-<br />
| 6<br />
| '''Official dictionary keeper judges the merge request'''<br />
In GitLab (or similar tool), the dictionary maintainer will see the list of merge requests.<br />
<br />
At each request, the maintainer can view all commits and accepts only a few of them.<br />
<br />
At each commit, he will judge the changes.<br />
<br />
When he accepts the merge request, the user's branch is deleted.<br />
<br />
|[[File:Git5.png|thumb|600px|center|Merge request list]]<br />
<br />
[[File:Git6.png|thumb|600px|center|Commits from current merge request]]<br />
<br />
[[File:Git7.png|thumb|600px|center|Changes]]<br />
<br />
[[File:Git4.png|thumb|600px|center|GitLab Graph]]<br />
|-<br />
| 7<br />
| '''Feedback''' <br />
<br />
On Merge Requests page, the user can see all request he have made and their status.<br />
| [[File:Prototype9.png|thumb|600px|center|Feedback]]<br />
|-<br />
| <br />
| '''Final Release'''<br />
|<br />
|}<br />
<br />
[[Category:GSoC 2019 student proposals]]</div>Alessiohttps://wiki.apertium.org/w/index.php?title=Web_Dictionary_Maintenance&diff=69067Web Dictionary Maintenance2019-03-27T13:51:59Z<p>Alessio: /* Example of Interaction - Adding new lemma to a dictionary */</p>
<hr />
<div>{{TOCD}}<br />
<br />
[https://translate.google.com/translate?sl=en&tl=pt-br&prev=_t&hl=en&u=http://wiki.apertium.org/wiki/Web_Dictionary_Maintenance Translate to PT-BR with Google Tradução]<br />
<br />
= Introduction =<br />
<br />
Apertium over the years still has deficiencies so that lay people can contribute to increase the base of words in dictionaries, even with simple contributions. Collaboration is the key to developing a tool that serves a huge range of users throughout the world. We believe that it is possible to engage more users and thus give greater impact to the tool within the communities where there is involvement. We will deal in this document with requirements on non-functional and technical objectives regarding the tool proposal.<br />
<br />
;Original Ideias<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code/Easy_dictionary_maintenance<br />
<br />
;Original GSOC2019 Application<br />
: http://wiki.apertium.org/wiki/User:Alessiojr/Easy_dictionary_-_Application-GSOC2019<br />
<br />
;Studant Information<br />
: '''Student:''' Vinícius Silva Nogueira <br /><br />
: '''Unofficial Mentor:''' Alessio Miranda Junior<br /><br />
: '''Telegram/Whatsapp:''' Alessio: +55 (31) 9.8888-7770<br /><br />
: '''E-mail:''' alessio@cefetmg.br or vinicius_snogueira@hotmail.com / viniciussnogueira13@gmail.com<br /><br />
: '''IRC:''' AlessioJr<br /><br />
: '''GTalk:''' alessiojunin@gmail.com<br />
<br />
=Description=<br />
==Abstract:==<br />
The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps away potential contributors. A tool that facilitates the work of dictionaries developers, eliminate computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
Even with several tools that help the way you manage and create dictionaries, Apertium is far from the normal users, who have a huge contribution potential. Or even create a simple way to create contributions to recurring users with advanced knowledge. Although it is a bold plan, and there are several possible and desirable requirements, we will describe some basic premises for this step and that must be respected and aligned with the apertium developer community.<br />
<br />
==Definitions==<br />
:* Lay users do not need to know Apertium's internal structure.<br />
:* Intermediate users need to have a knowledge of dictionary management methodology. <br />
:* Advanced users are those who know the structure of Apertium.<br />
:* Communities are user groups that merge characteristics to the database extension of a dictionary of a specific language.<br />
:* Official dictionaries are dictionaries managed and with seal of the apertium community.<br />
:* Unofficial dictionaries are dictionaries run by an independent community.<br />
:* Test dictionaries are deprived of users to test their contributions.<br />
<br />
==Objectives:==<br />
:* The major goal of the project is to develop a web tool to facilitate the management of the Apertium (XML's) database of integrators for novice and advanced users.<br />
:* New communities of contributions should be able to organize independently of a central command. The command exists but will be distributed.<br />
:* Lay users who feel motivated to contribute, should have an interface that promotes ease in contributing even with limited possibilities.<br />
:* The development of dictionaries should be collaborative and distributed. Each dictionary should have a management community, but a user may have the freedom to disagree and create a new version maintaining a history of the author.<br />
:* Any tool should maintain the traditional Apertium structure and not be interoperable between existing tools.<br />
:* There must be a methodology for communities to maintain the quality of their dictionaries. Although they are distributed the goal is to create a unified and mature dictionary.<br />
<br />
=Technical Objectives:=<br />
:* Develop, initially, monolingual dictionaries but keeping the particular format of each file.<br />
:* Minimize the direct manipulation of XML files, providing features that reduce this need.<br />
:* Making use of GitLab as an administrative and control tool.<br />
<br />
== Git, GitLab and Apertium ==<br />
[[File:Git_flow_demonstration.jpg|thumb|250px|right|Git Flow demonstration]]<br />
As the Apertium files are textual, we had the idea of seeking productivity and using existing and consolidated tools in the world.<br />
The proposal is to build a friendly web interface for lay users, but use git's own Back-End as version control and to make dictionary management GitLab as an administrative tool that already guarantees incredible power for remote collaboration.<br />
<br />
To demonstrate this relationship we will highlight some concepts of Git. Over time there may be several TimeLines:<br />
:* The Official Branch (Master) has the official version of the apertium managed by official developers or maintainers.<br />
:* Users have the power to create new Branches and develop unofficial dictionaries in parallel, creating communities that may from time to time suggest modifications to Brach Master.<br />
:* These requests can be accepted or rejected by maintainers, and this format is recursive and other developers can create unofficial copies of unofficial ones.<br />
:* Integration requests will use the Merge Request concepts present in tools such as GitLab that will be the BackEnd for advanced users.<br />
<br />
=Application-GSOC2019=<br />
===Abstract:===<br />
The idea is to develop the Web tool so that lay users contribute to dictionaries and use Git management with GitLab to manage these changes.<br />
* The focus will be on monolingual dictionaries and bilingual direct relationships.<br />
* Use the Git methodology and propose a guideline or flow for collaborative dictionary management.<br />
* Do not change the current XML format of dictionaries.<br />
<br />
===Why is it you are interested in machine translation and Apertium?===<br />
<br />
During the graduation course, Professor Aléssio demonstrated the need and opportunity to contribute with open source projects. <br />
He introduced me to Apertium and in my final graduation work I started reading and talking about it. <br />
We started discussing techniques for managing collaboration with the community and currently do not have <br />
as much knowledge about machine translation machines but I have experience in developing applications <br />
and web using collaboration with Git and GitLab.<br />
<br />
===Which of the published tasks are you interested in?===<br />
<br />
[http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code/Easy_dictionary_maintenance Easy dictionary maintenance]<br />
<br />
===Why should Google and Apertium sponsor it?===<br />
<br />
This project will have an impact in all languages. Facilitating dictionary manipulation will benefit everyone,<br />
allowing a wider range of people to contribute to existing dictionaries and start new language projects.<br />
<br />
===How and who will it benefit in society?===<br />
This application will benefit the entire Apertium community.<br />
Dictionary developers will have a tool to speed up their work and an easy-to-use tool will attract new contributors.<br />
As a result, Apertium's translation capacity will be increased, bringing better results to the end user.<br />
<br />
===What do you plan to do?===<br />
We are planning to create a web GUI that will facilitate common tasks of creating/modifying dictionaries and allow lay users to contribute to a dictionary.<br />
The application will be connected to a Git repository, which will be used as an administrative and version control tool.<br />
<br />
<br />
<br />
'''Program Language:''' Java, JavaScript<br /><br />
'''Persistence:''' XML (Apertium XML Files)<br /><br />
'''Framworks:''' Angular<br /><br />
<br />
===Stages/Milestones===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Week<br />
! Stage<br />
! Description<br />
|-<br />
| Community Bonding Period<br />
| Technology analysis<br />
|Analyze and find a good way to manipulate XML in a database.<br />
Testing and choosing the best alternative.<br />
<br />
UML diagrams of the project.<br />
|-<br />
| 1, 2<br />
| --<br />
|Database modeling and creation.<br />
<br />
Implementation of GitConnector.<br />
<br />
|-<br />
| 2, 3<br />
| --<br />
| WebAPI development.<br />
<br />
GUI prototype developement for monolingual dictionary: Symbols, Paradigms and Lemmas.<br />
|-<br />
| 3, 4<br />
| --<br />
| GUI prototype developement for bilingual dictionary.<br />
|-<br />
| '''Prototype'''<br />
| Milestone 1<br />
| First version of GUI for community analysis.<br />
|-<br />
| 5, 6<br />
| --<br />
| Development of WebDictionaryController (monolingual and bilingual dictionary).<br />
|-<br />
| 7, 8<br />
| --<br />
| Adjustments and adding new features with community feedback.<br />
|-<br />
| 9<br />
| --<br />
| Functionalities integrations, test and fixes.<br />
|-<br />
| '''Prototype'''<br />
| Milestone 2<br />
| First functional release for community analysis.<br />
|-<br />
| 10, 11<br />
| --<br />
| Adjustments and adding new features with community feedback.<br />
|-<br />
| 12<br />
| Pré-Release<br />
| Fix remain bugs, final adjustments and documentation in Wiki<br />
|-<br />
| <br />
| '''Final Release'''<br />
|Final version realease.<br />
|}<br />
<br />
===Presentation===<br />
<br />
My name is Vinicius, a Brazilian Student at Federal Center for Technological Education of Minas Gerais - Brazil.<br />
<br />
===Resume of Skills===<br />
<br />
Apertium Knowledge:<br />
<br />
* Study to develop a collaborative tool for apertium.<br />
* A study of actual Apertium process about creating a language pair by the user point of view.<br />
* Analysis of the characteristics of the 2010 project of Aléssio and adaptation to current times.<br />
<br />
Academic Skills:<br />
<br />
* Graduating in Computer Engineering- Federal Center for Technological Education of Minas Gerais – Brazil<br />
<br />
Professional Skills:<br />
<br />
* Language developer: C, Java, JavaScript, PHP, Phyton, PL/SQL.<br />
<br />
Projects for Summer:<br />
<br />
* No professional activities planned.<br />
* Planning to work in GSOC<br />
<br />
=Project=<br />
==Why?==<br />
:* The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps potential contributors away. A tool that facilitates the work of dictionaries developers, eliminate the need of computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
==What its the plan?==<br />
:* We are planning to create a web GUI that allows the user to develop the basic tasks of dictionaries and translation pairs manipulation in an easy and practical way.<br />
:* We will use Git as an administrative and control tool, allowing the user to contribute to the work of other community members or start your own project.<br />
<br />
==Components ans Technologies==<br />
[[File:ComponentDiagramWebDictionary.jpg|thumb|700px|right|Components Diagram]]<br />
* Actors<br />
** Lay User <br />
** Dictionary Admin <br />
<br />
* UserBrowser <br />
** WebInterface with AngularJS - GUI to easily manipulate the dictionary XML file.<br />
<br />
* Web Dicionary Maintence (APP)<br />
** WebAPI - Interface between user's GUI and server.<br />
** Temporary Database - Temporary database in which the XML file will be loaded with the crosses made.<br />
** JavaGit Connector - API to execute necessary Git functions.<br />
** WebDictionary Controller <br />
<br />
* Git <br />
** GitRepository - Repository containing the dictionaries<br />
** GitLab - Repository management tool<br />
** GitHub - Repository management tool<br />
<br />
==How it Works?==<br />
We will develop a WebInterface to lay users add words or suggest modifications.<br />
We are planning to use Git as an administrative and version control tool.<br />
<br />
* All dictionaries releases will be in a single repository and available to any member of the community to continue the work.<br />
* Each user will have your own branch to work on.<br />
* The users will be able to make merge requests with the official branch.<br />
* At first, we will use GitLab (or similar tool) to manage this merges requests. The team who maintain each dictionary will judge if the modifications are valid or not.<br />
<br />
=Example of Interaction - Adding new lemma to a dictionary=<br />
<br /><br />
<br /><br />
<br /><br />
<br /><br />
{| class="wikitable" border="1"<br />
|-<br />
! Stage<br />
! Description<br />
! Image<br />
|-<br />
| 1<br />
| ''' Choosing an official dictionary and importing it ''' <br />
The Official Dictionaries page display all available dictionaries in the git repository. <br />
<br />
Each version correspond to a tag in the master branch. <br />
<br />
Once imported, the user will name this dictionary and it will appear on the My Dictionaries page.<br />
| [[File:Prototype1.png|thumb|600px|center|Choosing an official dictionary and importing it]] <br />
[[File:Git1.png|thumb|600px|center|Master branch]]<br />
[[File:Prototype2.png|thumb|600px|center|My Dictionaries page]]<br />
|-<br />
| 2<br />
| ''' Loading the dictionary file ''' , <br />
On the Language File page, the user selects one of their dictionaries and the dictionary XML will be formatted to be temporarily saved to a database. Also on this page, the user can edit the dictionary alphabet and see some statistics about it.<br />
The Symbols, Paradigms, and Lemmas pages refer to the dictionary selected here.<br />
| [[File:Prototype3.png|thumb|600px|center|Loading the dictionary file]] <br />
|-<br />
| 3<br />
| '''Verifying if the lemmas already exists''' <br />
On the Lemmas - Search page, the user will be able to see all the inflections of the dictionary lemmas and check if the lemma he wants to add already exists.<br />
| [[File:Prototype4.png|thumb|600px|center|Verifying if the lemmas already exists]]<br />
|-<br />
| 4.1<br />
| ''' Creating the new lemma - Step 1 ''' <br />
In the Lemmas - Create page, the user will follow three steps to add a new lemma.<br />
<br />
In the first step, the user will define the lemma and the lemma root. In addition, he will give some examples of inflections and symbols to receive suggestions on which paradigm to use.<br />
| [[File:Prototype5.png|thumb|600px|center|text-top|Creating the new lemma - Step 1]]<br />
|-<br />
| 4.2<br />
| ''' Creating the new lemma - Step 2 ''' <br />
<br />
In the second step, the user will see paradigm suggestions (or can see all paradigms). When a paradigm is selected, all inflections of the created lemma will be shown to the user. If none of the paradigms fit, the user will be directed to create a new paradigm. <br />
| [[File:Prototype6.png|thumb|600px|center|Creating the new lemma - Step 2]]<br />
|-<br />
| 4.3<br />
| ''' Creating the new lemma - Step 3 ''' <br />
<br />
In the third and last step, the user will confirm and save the change. At this point, a branch will be create for this dictionary in the git repository (if she doesn’t already exists) and a commit with this changes will be done. <br />
| [[File:Prototype7.png|thumb|600px|right|Creating the new lemma - Step 3]]<br />
[[File:Git2.png|thumb|600px|center|New branch created in Git]]<br />
|-<br />
| 5<br />
| '''Merge Request''' <br />
<br />
On My Dictionaries page, the user can create a merge request that will be judge by the master branch maintainer.<br />
<br />
| [[File:Prototype8.png|thumb|600px|center|Merge Request]]<br />
|-<br />
| 6<br />
| '''Official dictionary keeper judges the merge request'''<br />
In GitLab (or similar tool), the dictionary maintainer will see the list of merge requests.<br />
<br />
At each request, the maintainer can view all commits and accepts only a few of them.<br />
<br />
At each commit, he will judge the changes.<br />
<br />
When he accepts the merge request, the user's branch is deleted.<br />
<br />
|[[File:Git5.png|thumb|600px|center|Merge request list]]<br />
<br />
[[File:Git6.png|thumb|600px|center|Commits from current merge request]]<br />
<br />
[[File:Git7.png|thumb|600px|center|Changes]]<br />
<br />
[[File:Git4.png|thumb|600px|center|GitLab Graph]]<br />
|-<br />
| 7<br />
| '''Feedback''' <br />
<br />
On Merge Requests page, the user can see all request he have made and their status.<br />
| [[File:Prototype9.png|thumb|600px|center|Feedback]]<br />
|-<br />
| <br />
| '''Final Release'''<br />
|<br />
|}</div>Alessiohttps://wiki.apertium.org/w/index.php?title=Web_Dictionary_Maintenance&diff=69066Web Dictionary Maintenance2019-03-27T13:50:34Z<p>Alessio: /* Example of Interaction - Adding new lemma to a dictionary */</p>
<hr />
<div>{{TOCD}}<br />
<br />
[https://translate.google.com/translate?sl=en&tl=pt-br&prev=_t&hl=en&u=http://wiki.apertium.org/wiki/Web_Dictionary_Maintenance Translate to PT-BR with Google Tradução]<br />
<br />
= Introduction =<br />
<br />
Apertium over the years still has deficiencies so that lay people can contribute to increase the base of words in dictionaries, even with simple contributions. Collaboration is the key to developing a tool that serves a huge range of users throughout the world. We believe that it is possible to engage more users and thus give greater impact to the tool within the communities where there is involvement. We will deal in this document with requirements on non-functional and technical objectives regarding the tool proposal.<br />
<br />
;Original Ideias<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code/Easy_dictionary_maintenance<br />
<br />
;Original GSOC2019 Application<br />
: http://wiki.apertium.org/wiki/User:Alessiojr/Easy_dictionary_-_Application-GSOC2019<br />
<br />
;Studant Information<br />
: '''Student:''' Vinícius Silva Nogueira <br /><br />
: '''Unofficial Mentor:''' Alessio Miranda Junior<br /><br />
: '''Telegram/Whatsapp:''' Alessio: +55 (31) 9.8888-7770<br /><br />
: '''E-mail:''' alessio@cefetmg.br or vinicius_snogueira@hotmail.com / viniciussnogueira13@gmail.com<br /><br />
: '''IRC:''' AlessioJr<br /><br />
: '''GTalk:''' alessiojunin@gmail.com<br />
<br />
=Description=<br />
==Abstract:==<br />
The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps away potential contributors. A tool that facilitates the work of dictionaries developers, eliminate computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
Even with several tools that help the way you manage and create dictionaries, Apertium is far from the normal users, who have a huge contribution potential. Or even create a simple way to create contributions to recurring users with advanced knowledge. Although it is a bold plan, and there are several possible and desirable requirements, we will describe some basic premises for this step and that must be respected and aligned with the apertium developer community.<br />
<br />
==Definitions==<br />
:* Lay users do not need to know Apertium's internal structure.<br />
:* Intermediate users need to have a knowledge of dictionary management methodology. <br />
:* Advanced users are those who know the structure of Apertium.<br />
:* Communities are user groups that merge characteristics to the database extension of a dictionary of a specific language.<br />
:* Official dictionaries are dictionaries managed and with seal of the apertium community.<br />
:* Unofficial dictionaries are dictionaries run by an independent community.<br />
:* Test dictionaries are deprived of users to test their contributions.<br />
<br />
==Objectives:==<br />
:* The major goal of the project is to develop a web tool to facilitate the management of the Apertium (XML's) database of integrators for novice and advanced users.<br />
:* New communities of contributions should be able to organize independently of a central command. The command exists but will be distributed.<br />
:* Lay users who feel motivated to contribute, should have an interface that promotes ease in contributing even with limited possibilities.<br />
:* The development of dictionaries should be collaborative and distributed. Each dictionary should have a management community, but a user may have the freedom to disagree and create a new version maintaining a history of the author.<br />
:* Any tool should maintain the traditional Apertium structure and not be interoperable between existing tools.<br />
:* There must be a methodology for communities to maintain the quality of their dictionaries. Although they are distributed the goal is to create a unified and mature dictionary.<br />
<br />
=Technical Objectives:=<br />
:* Develop, initially, monolingual dictionaries but keeping the particular format of each file.<br />
:* Minimize the direct manipulation of XML files, providing features that reduce this need.<br />
:* Making use of GitLab as an administrative and control tool.<br />
<br />
== Git, GitLab and Apertium ==<br />
[[File:Git_flow_demonstration.jpg|thumb|250px|right|Git Flow demonstration]]<br />
As the Apertium files are textual, we had the idea of seeking productivity and using existing and consolidated tools in the world.<br />
The proposal is to build a friendly web interface for lay users, but use git's own Back-End as version control and to make dictionary management GitLab as an administrative tool that already guarantees incredible power for remote collaboration.<br />
<br />
To demonstrate this relationship we will highlight some concepts of Git. Over time there may be several TimeLines:<br />
:* The Official Branch (Master) has the official version of the apertium managed by official developers or maintainers.<br />
:* Users have the power to create new Branches and develop unofficial dictionaries in parallel, creating communities that may from time to time suggest modifications to Brach Master.<br />
:* These requests can be accepted or rejected by maintainers, and this format is recursive and other developers can create unofficial copies of unofficial ones.<br />
:* Integration requests will use the Merge Request concepts present in tools such as GitLab that will be the BackEnd for advanced users.<br />
<br />
=Application-GSOC2019=<br />
===Abstract:===<br />
The idea is to develop the Web tool so that lay users contribute to dictionaries and use Git management with GitLab to manage these changes.<br />
* The focus will be on monolingual dictionaries and bilingual direct relationships.<br />
* Use the Git methodology and propose a guideline or flow for collaborative dictionary management.<br />
* Do not change the current XML format of dictionaries.<br />
<br />
===Why is it you are interested in machine translation and Apertium?===<br />
<br />
During the graduation course, Professor Aléssio demonstrated the need and opportunity to contribute with open source projects. <br />
He introduced me to Apertium and in my final graduation work I started reading and talking about it. <br />
We started discussing techniques for managing collaboration with the community and currently do not have <br />
as much knowledge about machine translation machines but I have experience in developing applications <br />
and web using collaboration with Git and GitLab.<br />
<br />
===Which of the published tasks are you interested in?===<br />
<br />
[http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code/Easy_dictionary_maintenance Easy dictionary maintenance]<br />
<br />
===Why should Google and Apertium sponsor it?===<br />
<br />
This project will have an impact in all languages. Facilitating dictionary manipulation will benefit everyone,<br />
allowing a wider range of people to contribute to existing dictionaries and start new language projects.<br />
<br />
===How and who will it benefit in society?===<br />
This application will benefit the entire Apertium community.<br />
Dictionary developers will have a tool to speed up their work and an easy-to-use tool will attract new contributors.<br />
As a result, Apertium's translation capacity will be increased, bringing better results to the end user.<br />
<br />
===What do you plan to do?===<br />
We are planning to create a web GUI that will facilitate common tasks of creating/modifying dictionaries and allow lay users to contribute to a dictionary.<br />
The application will be connected to a Git repository, which will be used as an administrative and version control tool.<br />
<br />
<br />
<br />
'''Program Language:''' Java, JavaScript<br /><br />
'''Persistence:''' XML (Apertium XML Files)<br /><br />
'''Framworks:''' Angular<br /><br />
<br />
===Stages/Milestones===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Week<br />
! Stage<br />
! Description<br />
|-<br />
| Community Bonding Period<br />
| Technology analysis<br />
|Analyze and find a good way to manipulate XML in a database.<br />
Testing and choosing the best alternative.<br />
<br />
UML diagrams of the project.<br />
|-<br />
| 1, 2<br />
| --<br />
|Database modeling and creation.<br />
<br />
Implementation of GitConnector.<br />
<br />
|-<br />
| 2, 3<br />
| --<br />
| WebAPI development.<br />
<br />
GUI prototype developement for monolingual dictionary: Symbols, Paradigms and Lemmas.<br />
|-<br />
| 3, 4<br />
| --<br />
| GUI prototype developement for bilingual dictionary.<br />
|-<br />
| '''Prototype'''<br />
| Milestone 1<br />
| First version of GUI for community analysis.<br />
|-<br />
| 5, 6<br />
| --<br />
| Development of WebDictionaryController (monolingual and bilingual dictionary).<br />
|-<br />
| 7, 8<br />
| --<br />
| Adjustments and adding new features with community feedback.<br />
|-<br />
| 9<br />
| --<br />
| Functionalities integrations, test and fixes.<br />
|-<br />
| '''Prototype'''<br />
| Milestone 2<br />
| First functional release for community analysis.<br />
|-<br />
| 10, 11<br />
| --<br />
| Adjustments and adding new features with community feedback.<br />
|-<br />
| 12<br />
| Pré-Release<br />
| Fix remain bugs, final adjustments and documentation in Wiki<br />
|-<br />
| <br />
| '''Final Release'''<br />
|Final version realease.<br />
|}<br />
<br />
===Presentation===<br />
<br />
My name is Vinicius, a Brazilian Student at Federal Center for Technological Education of Minas Gerais - Brazil.<br />
<br />
===Resume of Skills===<br />
<br />
Apertium Knowledge:<br />
<br />
* Study to develop a collaborative tool for apertium.<br />
* A study of actual Apertium process about creating a language pair by the user point of view.<br />
* Analysis of the characteristics of the 2010 project of Aléssio and adaptation to current times.<br />
<br />
Academic Skills:<br />
<br />
* Graduating in Computer Engineering- Federal Center for Technological Education of Minas Gerais – Brazil<br />
<br />
Professional Skills:<br />
<br />
* Language developer: C, Java, JavaScript, PHP, Phyton, PL/SQL.<br />
<br />
Projects for Summer:<br />
<br />
* No professional activities planned.<br />
* Planning to work in GSOC<br />
<br />
=Project=<br />
==Why?==<br />
:* The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps potential contributors away. A tool that facilitates the work of dictionaries developers, eliminate the need of computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
==What its the plan?==<br />
:* We are planning to create a web GUI that allows the user to develop the basic tasks of dictionaries and translation pairs manipulation in an easy and practical way.<br />
:* We will use Git as an administrative and control tool, allowing the user to contribute to the work of other community members or start your own project.<br />
<br />
==Components ans Technologies==<br />
[[File:ComponentDiagramWebDictionary.jpg|thumb|700px|right|Components Diagram]]<br />
* Actors<br />
** Lay User <br />
** Dictionary Admin <br />
<br />
* UserBrowser <br />
** WebInterface with AngularJS - GUI to easily manipulate the dictionary XML file.<br />
<br />
* Web Dicionary Maintence (APP)<br />
** WebAPI - Interface between user's GUI and server.<br />
** Temporary Database - Temporary database in which the XML file will be loaded with the crosses made.<br />
** JavaGit Connector - API to execute necessary Git functions.<br />
** WebDictionary Controller <br />
<br />
* Git <br />
** GitRepository - Repository containing the dictionaries<br />
** GitLab - Repository management tool<br />
** GitHub - Repository management tool<br />
<br />
==How it Works?==<br />
We will develop a WebInterface to lay users add words or suggest modifications.<br />
We are planning to use Git as an administrative and version control tool.<br />
<br />
* All dictionaries releases will be in a single repository and available to any member of the community to continue the work.<br />
* Each user will have your own branch to work on.<br />
* The users will be able to make merge requests with the official branch.<br />
* At first, we will use GitLab (or similar tool) to manage this merges requests. The team who maintain each dictionary will judge if the modifications are valid or not.<br />
<br />
=Example of Interaction - Adding new lemma to a dictionary=<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Stage<br />
! Description<br />
! Image<br />
|-<br />
| 1<br />
| ''' Choosing an official dictionary and importing it ''' <br />
The Official Dictionaries page display all available dictionaries in the git repository. <br />
<br />
Each version correspond to a tag in the master branch. <br />
<br />
Once imported, the user will name this dictionary and it will appear on the My Dictionaries page.<br />
| [[File:Prototype1.png|thumb|600px|center|Choosing an official dictionary and importing it]] <br />
[[File:Git1.png|thumb|600px|center|Master branch]]<br />
[[File:Prototype2.png|thumb|600px|center|My Dictionaries page]]<br />
|-<br />
| 2<br />
| ''' Loading the dictionary file ''' , <br />
On the Language File page, the user selects one of their dictionaries and the dictionary XML will be formatted to be temporarily saved to a database. Also on this page, the user can edit the dictionary alphabet and see some statistics about it.<br />
The Symbols, Paradigms, and Lemmas pages refer to the dictionary selected here.<br />
| [[File:Prototype3.png|thumb|600px|center|Loading the dictionary file]] <br />
|-<br />
| 3<br />
| '''Verifying if the lemmas already exists''' <br />
On the Lemmas - Search page, the user will be able to see all the inflections of the dictionary lemmas and check if the lemma he wants to add already exists.<br />
| [[File:Prototype4.png|thumb|600px|center|Verifying if the lemmas already exists]]<br />
|-<br />
| 4.1<br />
| ''' Creating the new lemma - Step 1 ''' <br />
In the Lemmas - Create page, the user will follow three steps to add a new lemma.<br />
<br />
In the first step, the user will define the lemma and the lemma root. In addition, he will give some examples of inflections and symbols to receive suggestions on which paradigm to use.<br />
| [[File:Prototype5.png|thumb|600px|center|text-top|Creating the new lemma - Step 1]]<br />
|-<br />
| 4.2<br />
| ''' Creating the new lemma - Step 2 ''' <br />
<br />
In the second step, the user will see paradigm suggestions (or can see all paradigms). When a paradigm is selected, all inflections of the created lemma will be shown to the user. If none of the paradigms fit, the user will be directed to create a new paradigm. <br />
| [[File:Prototype6.png|thumb|600px|center|Creating the new lemma - Step 2]]<br />
|-<br />
| 4.3<br />
| ''' Creating the new lemma - Step 3 ''' <br />
<br />
In the third and last step, the user will confirm and save the change. At this point, a branch will be create for this dictionary in the git repository (if she doesn’t already exists) and a commit with this changes will be done. <br />
| [[File:Prototype7.png|thumb|600px|right|Creating the new lemma - Step 3]]<br />
[[File:Git2.png|thumb|600px|center|New branch created in Git]]<br />
|-<br />
| 5<br />
| '''Merge Request''' <br />
<br />
On My Dictionaries page, the user can create a merge request that will be judge by the master branch maintainer.<br />
<br />
| [[File:Prototype8.png|thumb|600px|center|Merge Request]]<br />
|-<br />
| 6<br />
| '''Official dictionary keeper judges the merge request'''<br />
In GitLab (or similar tool), the dictionary maintainer will see the list of merge requests.<br />
<br />
At each request, the maintainer can view all commits and accepts only a few of them.<br />
<br />
At each commit, he will judge the changes.<br />
<br />
When he accepts the merge request, the user's branch is deleted.<br />
<br />
|[[File:Git5.png|thumb|600px|center|Merge request list]]<br />
<br />
[[File:Git6.png|thumb|600px|center|Commits from current merge request]]<br />
<br />
[[File:Git7.png|thumb|600px|center|Changes]]<br />
<br />
[[File:Git4.png|thumb|600px|center|GitLab Graph]]<br />
|-<br />
| 7<br />
| '''Feedback''' <br />
<br />
On Merge Requests page, the user can see all request he have made and their status.<br />
| [[File:Prototype9.png|thumb|600px|center|Feedback]]<br />
|-<br />
| <br />
| '''Final Release'''<br />
|<br />
|}</div>Alessiohttps://wiki.apertium.org/w/index.php?title=Web_Dictionary_Maintenance&diff=69063Web Dictionary Maintenance2019-03-27T03:21:38Z<p>Alessio: /* Example of Interaction - Adding new lemma to a dictionary */</p>
<hr />
<div>{{TOCD}}<br />
<br />
[https://translate.google.com/translate?sl=en&tl=pt-br&prev=_t&hl=en&u=http://wiki.apertium.org/wiki/Web_Dictionary_Maintenance Translate to PT-BR with Google Tradução]<br />
<br />
= Introduction =<br />
<br />
Apertium over the years still has deficiencies so that lay people can contribute to increase the base of words in dictionaries, even with simple contributions. Collaboration is the key to developing a tool that serves a huge range of users throughout the world. We believe that it is possible to engage more users and thus give greater impact to the tool within the communities where there is involvement. We will deal in this document with requirements on non-functional and technical objectives regarding the tool proposal.<br />
<br />
;Original Ideias<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code/Easy_dictionary_maintenance<br />
<br />
;Original GSOC2019 Application<br />
: http://wiki.apertium.org/wiki/User:Alessiojr/Easy_dictionary_-_Application-GSOC2019<br />
<br />
;Studant Information<br />
: '''Student:''' Vinícius Silva Nogueira <br /><br />
: '''Unofficial Mentor:''' Alessio Miranda Junior<br /><br />
: '''Telegram/Whatsapp:''' Alessio: +55 (31) 9.8888-7770<br /><br />
: '''E-mail:''' alessio@cefetmg.br or vinicius_snogueira@hotmail.com / viniciussnogueira13@gmail.com<br /><br />
: '''IRC:''' AlessioJr<br /><br />
: '''GTalk:''' alessiojunin@gmail.com<br />
<br />
=Description=<br />
==Abstract:==<br />
The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps away potential contributors. A tool that facilitates the work of dictionaries developers, eliminate computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
Even with several tools that help the way you manage and create dictionaries, Apertium is far from the normal users, who have a huge contribution potential. Or even create a simple way to create contributions to recurring users with advanced knowledge. Although it is a bold plan, and there are several possible and desirable requirements, we will describe some basic premises for this step and that must be respected and aligned with the apertium developer community.<br />
<br />
==Definitions==<br />
:* Lay users do not need to know Apertium's internal structure.<br />
:* Intermediate users need to have a knowledge of dictionary management methodology. <br />
:* Advanced users are those who know the structure of Apertium.<br />
:* Communities are user groups that merge characteristics to the database extension of a dictionary of a specific language.<br />
:* Official dictionaries are dictionaries managed and with seal of the apertium community.<br />
:* Unofficial dictionaries are dictionaries run by an independent community.<br />
:* Test dictionaries are deprived of users to test their contributions.<br />
<br />
==Objectives:==<br />
:* The major goal of the project is to develop a web tool to facilitate the management of the Apertium (XML's) database of integrators for novice and advanced users.<br />
:* New communities of contributions should be able to organize independently of a central command. The command exists but will be distributed.<br />
:* Lay users who feel motivated to contribute, should have an interface that promotes ease in contributing even with limited possibilities.<br />
:* The development of dictionaries should be collaborative and distributed. Each dictionary should have a management community, but a user may have the freedom to disagree and create a new version maintaining a history of the author.<br />
:* Any tool should maintain the traditional Apertium structure and not be interoperable between existing tools.<br />
:* There must be a methodology for communities to maintain the quality of their dictionaries. Although they are distributed the goal is to create a unified and mature dictionary.<br />
<br />
=Technical Objectives:=<br />
:* Develop, initially, monolingual dictionaries but keeping the particular format of each file.<br />
:* Minimize the direct manipulation of XML files, providing features that reduce this need.<br />
:* Making use of GitLab as an administrative and control tool.<br />
<br />
== Git, GitLab and Apertium ==<br />
[[File:Git_flow_demonstration.jpg|thumb|250px|right|Git Flow demonstration]]<br />
As the Apertium files are textual, we had the idea of seeking productivity and using existing and consolidated tools in the world.<br />
The proposal is to build a friendly web interface for lay users, but use git's own Back-End as version control and to make dictionary management GitLab as an administrative tool that already guarantees incredible power for remote collaboration.<br />
<br />
To demonstrate this relationship we will highlight some concepts of Git. Over time there may be several TimeLines:<br />
:* The Official Branch (Master) has the official version of the apertium managed by official developers or maintainers.<br />
:* Users have the power to create new Branches and develop unofficial dictionaries in parallel, creating communities that may from time to time suggest modifications to Brach Master.<br />
:* These requests can be accepted or rejected by maintainers, and this format is recursive and other developers can create unofficial copies of unofficial ones.<br />
:* Integration requests will use the Merge Request concepts present in tools such as GitLab that will be the BackEnd for advanced users.<br />
<br />
=Application-GSOC2019=<br />
===Abstract:===<br />
The idea is to develop the Web tool so that lay users contribute to dictionaries and use Git management with GitLab to manage these changes.<br />
* The focus will be on monolingual dictionaries and bilingual direct relationships.<br />
* Use the Git methodology and propose a guideline or flow for collaborative dictionary management.<br />
* Do not change the current XML format of dictionaries.<br />
<br />
===Why is it you are interested in machine translation and Apertium?===<br />
<br />
During the graduation course, Professor Aléssio demonstrated the need and opportunity to contribute with open source projects. <br />
He introduced me to Apertium and in my final graduation work I started reading and talking about it. <br />
We started discussing techniques for managing collaboration with the community and currently do not have <br />
as much knowledge about machine translation machines but I have experience in developing applications <br />
and web using collaboration with Git and GitLab.<br />
<br />
===Which of the published tasks are you interested in?===<br />
<br />
[http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code/Easy_dictionary_maintenance Easy dictionary maintenance]<br />
<br />
===Why should Google and Apertium sponsor it?===<br />
<br />
This project will have an impact in all languages. Facilitating dictionary manipulation will benefit everyone,<br />
allowing a wider range of people to contribute to existing dictionaries and start new language projects.<br />
<br />
===How and who will it benefit in society?===<br />
This application will benefit the entire Apertium community.<br />
Dictionary developers will have a tool to speed up their work and an easy-to-use tool will attract new contributors.<br />
As a result, Apertium's translation capacity will be increased, bringing better results to the end user.<br />
<br />
===What do you plan to do?===<br />
We are planning to create a web GUI that will facilitate common tasks of creating/modifying dictionaries and allow lay users to contribute to a dictionary.<br />
The application will be connected to a Git repository, which will be used as an administrative and version control tool.<br />
<br />
<br />
<br />
'''Program Language:''' Java, JavaScript<br /><br />
'''Persistence:''' XML (Apertium XML Files)<br /><br />
'''Framworks:''' Angular<br /><br />
<br />
===Stages/Milestones===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Week<br />
! Stage<br />
! Description<br />
|-<br />
| Community Bonding Period<br />
| Technology analysis<br />
|Analyze and find a good way to manipulate XML in a database.<br />
Testing and choosing the best alternative.<br />
<br />
UML diagrams of the project.<br />
|-<br />
| 1, 2<br />
| --<br />
|Database modeling and creation.<br />
<br />
Implementation of GitConnector.<br />
<br />
|-<br />
| 2, 3<br />
| --<br />
| WebAPI development.<br />
<br />
GUI prototype developement for monolingual dictionary: Symbols, Paradigms and Lemmas.<br />
|-<br />
| 3, 4<br />
| --<br />
| GUI prototype developement for bilingual dictionary.<br />
|-<br />
| '''Prototype'''<br />
| Milestone 1<br />
| First version of GUI for community analysis.<br />
|-<br />
| 5, 6<br />
| --<br />
| Development of WebDictionaryController (monolingual and bilingual dictionary).<br />
|-<br />
| 7, 8<br />
| --<br />
| Adjustments and adding new features with community feedback.<br />
|-<br />
| 9<br />
| --<br />
| Functionalities integrations, test and fixes.<br />
|-<br />
| '''Prototype'''<br />
| Milestone 2<br />
| First functional release for community analysis.<br />
|-<br />
| 10, 11<br />
| --<br />
| Adjustments and adding new features with community feedback.<br />
|-<br />
| 12<br />
| Pré-Release<br />
| Fix remain bugs, final adjustments and documentation in Wiki<br />
|-<br />
| <br />
| '''Final Release'''<br />
|Final version realease.<br />
|}<br />
<br />
===Presentation===<br />
<br />
My name is Vinicius, a Brazilian Student at Federal Center for Technological Education of Minas Gerais - Brazil.<br />
<br />
===Resume of Skills===<br />
<br />
Apertium Knowledge:<br />
<br />
* Study to develop a collaborative tool for apertium.<br />
* A study of actual Apertium process about creating a language pair by the user point of view.<br />
* Analysis of the characteristics of the 2010 project of Aléssio and adaptation to current times.<br />
<br />
Academic Skills:<br />
<br />
* Graduating in Computer Engineering- Federal Center for Technological Education of Minas Gerais – Brazil<br />
<br />
Professional Skills:<br />
<br />
* Language developer: C, Java, JavaScript, PHP, Phyton, PL/SQL.<br />
<br />
Projects for Summer:<br />
<br />
* No professional activities planned.<br />
* Planning to work in GSOC<br />
<br />
=Project=<br />
==Why?==<br />
:* The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps potential contributors away. A tool that facilitates the work of dictionaries developers, eliminate the need of computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
==What its the plan?==<br />
:* We are planning to create a web GUI that allows the user to develop the basic tasks of dictionaries and translation pairs manipulation in an easy and practical way.<br />
:* We will use Git as an administrative and control tool, allowing the user to contribute to the work of other community members or start your own project.<br />
<br />
==Components ans Technologies==<br />
[[File:ComponentDiagramWebDictionary.jpg|thumb|700px|right|Components Diagram]]<br />
* Actors<br />
** Lay User <br />
** Dictionary Admin <br />
<br />
* UserBrowser <br />
** WebInterface with AngularJS - GUI to easily manipulate the dictionary XML file.<br />
<br />
* Web Dicionary Maintence (APP)<br />
** WebAPI - Interface between user's GUI and server.<br />
** Temporary Database - Temporary database in which the XML file will be loaded with the crosses made.<br />
** JavaGit Connector - API to execute necessary Git functions.<br />
** WebDictionary Controller <br />
<br />
* Git <br />
** GitRepository - Repository containing the dictionaries<br />
** GitLab - Repository management tool<br />
** GitHub - Repository management tool<br />
<br />
==How it Works?==<br />
We will develop a WebInterface to lay users add words or suggest modifications.<br />
We are planning to use Git as an administrative and version control tool.<br />
<br />
* All dictionaries releases will be in a single repository and available to any member of the community to continue the work.<br />
* Each user will have your own branch to work on.<br />
* The users will be able to make merge requests with the official branch.<br />
* At first, we will use GitLab (or similar tool) to manage this merges requests. The team who maintain each dictionary will judge if the modifications are valid or not.<br />
<br />
=Example of Interaction - Adding new lemma to a dictionary=<br />
<br />
===Stages/Milestones===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Stage<br />
! Description<br />
! Image<br />
|-<br />
| 1<br />
| ''' Choosing an official dictionary and importing it ''' <br />
The Official Dictionaries page display all available dictionaries in the git repository. <br />
Each version correspond to a tag in the master branch. [[File:Git1.png|thumb|400px|none|Master branch]]<br />
Once imported, the user will name this dictionary and it will appear on the My Dictionaries page.<br />
| [[File:Prototype1.png|thumb|400px|none|Choosing an official dictionary and importing it]] <br />
[[File:Prototype2.png|thumb|400px|none|My Dictionaries page]]<br />
|-<br />
| 2<br />
| ''' Loading the dictionary file On the Language File page''' , <br />
the user selects one of their dictionaries and the dictionary XML will be formatted to be temporarily saved to a database. Also on this page, the user can edit the dictionary alphabet and see some statistics about it.<br />
The Symbols, Paradigms, and Lemmas pages refer to the dictionary selected here.<br />
| [[File:Prototype3.png|thumb|600px|right|Loading the dictionary file]] <br />
|-<br />
| 3<br />
| '''Verifying if the lemmas already exists''' <br />
On the Lemmas - Search page, the user will be able to see all the inflections of the dictionary lemmas and check if the lemma he wants to add already exists.<br />
| [[File:Prototype4.png|thumb|600px|right|Verifying if the lemmas already exists]]<br />
|-<br />
| 4.1<br />
| ''' In the Lemmas ''' - Create page, the user will follow three steps to add a new lemma.<br />
In the first step, the user will define the lemma and the lemma root. In addition, he will give some examples of inflections and symbols to receive suggestions on which paradigm to use.<br />
| [[File:Prototype5.png|thumb|600px|right|text-top|Creating the new lemma - Step 1]]<br />
|-<br />
| 4.2<br />
| ''' In the second step, the user will see paradigm suggestions (or can see all paradigms). When a paradigm is selected, all inflections of the created lemma will be shown to the user. If none of the paradigms fit, the user will be directed to create a new paradigm. ''' <br />
| [[File:Prototype6.png|thumb|600px|right|Creating the new lemma - Step 2]]<br />
|-<br />
| 4.3<br />
| ''' In the third and last step, the user will confirm and save the change. At this point, a branch will be create for this dictionary in the git repository (if she doesn’t already exists) and a commit with this changes will be done. ''' <br />
| [[File:Prototype7.png|thumb|600px|right|Creating the new lemma - Step 3]]<br />
|-<br />
| 5<br />
| '''Merge Request''' On My Dictionaries page, the user can create a merge request that will be judge by the master branch maintainer.<br />
[[File:Git2.png|thumb|600px|right|New branch created in Git]]<br />
| [[File:Prototype8.png|thumb|600px|right|Merge Request]]<br />
|-<br />
| 6<br />
| '''Official dictionary keeper judges the merge request'''<br />
In GitLab (or similar tool), the dictionary maintainer will see the list of merge requests.<br />
[[File:Git5.png|thumb|600px|right|Merge request list]]<br />
At each request, the maintainer can view all commits and accepts only a few of them.<br />
[[File:Git6.png|thumb|600px|right|Commits from current merge request]]<br />
| At each commit, he will judge the changes.<br />
[[File:Git7.png|thumb|250px|none|Changes]]<br />
When he accepts the merge request, the user's branch is deleted.<br />
[[File:Git4.png|thumb|250px|none|GitLab Graph]]<br />
|-<br />
| 7<br />
| '''Feedback''' On Merge Requests page, the user can see all request he have made and their status.<br />
| [[File:Prototype9.png|thumb|250px|none|Feedback]]<br />
|-<br />
| <br />
| '''Final Release'''<br />
|<br />
|}</div>Alessiohttps://wiki.apertium.org/w/index.php?title=Web_Dictionary_Maintenance&diff=69062Web Dictionary Maintenance2019-03-27T03:20:33Z<p>Alessio: /* Stages/Milestones */</p>
<hr />
<div>{{TOCD}}<br />
<br />
[https://translate.google.com/translate?sl=en&tl=pt-br&prev=_t&hl=en&u=http://wiki.apertium.org/wiki/Web_Dictionary_Maintenance Translate to PT-BR with Google Tradução]<br />
<br />
= Introduction =<br />
<br />
Apertium over the years still has deficiencies so that lay people can contribute to increase the base of words in dictionaries, even with simple contributions. Collaboration is the key to developing a tool that serves a huge range of users throughout the world. We believe that it is possible to engage more users and thus give greater impact to the tool within the communities where there is involvement. We will deal in this document with requirements on non-functional and technical objectives regarding the tool proposal.<br />
<br />
;Original Ideias<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code/Easy_dictionary_maintenance<br />
<br />
;Original GSOC2019 Application<br />
: http://wiki.apertium.org/wiki/User:Alessiojr/Easy_dictionary_-_Application-GSOC2019<br />
<br />
;Studant Information<br />
: '''Student:''' Vinícius Silva Nogueira <br /><br />
: '''Unofficial Mentor:''' Alessio Miranda Junior<br /><br />
: '''Telegram/Whatsapp:''' Alessio: +55 (31) 9.8888-7770<br /><br />
: '''E-mail:''' alessio@cefetmg.br or vinicius_snogueira@hotmail.com / viniciussnogueira13@gmail.com<br /><br />
: '''IRC:''' AlessioJr<br /><br />
: '''GTalk:''' alessiojunin@gmail.com<br />
<br />
=Description=<br />
==Abstract:==<br />
The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps away potential contributors. A tool that facilitates the work of dictionaries developers, eliminate computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
Even with several tools that help the way you manage and create dictionaries, Apertium is far from the normal users, who have a huge contribution potential. Or even create a simple way to create contributions to recurring users with advanced knowledge. Although it is a bold plan, and there are several possible and desirable requirements, we will describe some basic premises for this step and that must be respected and aligned with the apertium developer community.<br />
<br />
==Definitions==<br />
:* Lay users do not need to know Apertium's internal structure.<br />
:* Intermediate users need to have a knowledge of dictionary management methodology. <br />
:* Advanced users are those who know the structure of Apertium.<br />
:* Communities are user groups that merge characteristics to the database extension of a dictionary of a specific language.<br />
:* Official dictionaries are dictionaries managed and with seal of the apertium community.<br />
:* Unofficial dictionaries are dictionaries run by an independent community.<br />
:* Test dictionaries are deprived of users to test their contributions.<br />
<br />
==Objectives:==<br />
:* The major goal of the project is to develop a web tool to facilitate the management of the Apertium (XML's) database of integrators for novice and advanced users.<br />
:* New communities of contributions should be able to organize independently of a central command. The command exists but will be distributed.<br />
:* Lay users who feel motivated to contribute, should have an interface that promotes ease in contributing even with limited possibilities.<br />
:* The development of dictionaries should be collaborative and distributed. Each dictionary should have a management community, but a user may have the freedom to disagree and create a new version maintaining a history of the author.<br />
:* Any tool should maintain the traditional Apertium structure and not be interoperable between existing tools.<br />
:* There must be a methodology for communities to maintain the quality of their dictionaries. Although they are distributed the goal is to create a unified and mature dictionary.<br />
<br />
=Technical Objectives:=<br />
:* Develop, initially, monolingual dictionaries but keeping the particular format of each file.<br />
:* Minimize the direct manipulation of XML files, providing features that reduce this need.<br />
:* Making use of GitLab as an administrative and control tool.<br />
<br />
== Git, GitLab and Apertium ==<br />
[[File:Git_flow_demonstration.jpg|thumb|250px|right|Git Flow demonstration]]<br />
As the Apertium files are textual, we had the idea of seeking productivity and using existing and consolidated tools in the world.<br />
The proposal is to build a friendly web interface for lay users, but use git's own Back-End as version control and to make dictionary management GitLab as an administrative tool that already guarantees incredible power for remote collaboration.<br />
<br />
To demonstrate this relationship we will highlight some concepts of Git. Over time there may be several TimeLines:<br />
:* The Official Branch (Master) has the official version of the apertium managed by official developers or maintainers.<br />
:* Users have the power to create new Branches and develop unofficial dictionaries in parallel, creating communities that may from time to time suggest modifications to Brach Master.<br />
:* These requests can be accepted or rejected by maintainers, and this format is recursive and other developers can create unofficial copies of unofficial ones.<br />
:* Integration requests will use the Merge Request concepts present in tools such as GitLab that will be the BackEnd for advanced users.<br />
<br />
=Application-GSOC2019=<br />
===Abstract:===<br />
The idea is to develop the Web tool so that lay users contribute to dictionaries and use Git management with GitLab to manage these changes.<br />
* The focus will be on monolingual dictionaries and bilingual direct relationships.<br />
* Use the Git methodology and propose a guideline or flow for collaborative dictionary management.<br />
* Do not change the current XML format of dictionaries.<br />
<br />
===Why is it you are interested in machine translation and Apertium?===<br />
<br />
During the graduation course, Professor Aléssio demonstrated the need and opportunity to contribute with open source projects. <br />
He introduced me to Apertium and in my final graduation work I started reading and talking about it. <br />
We started discussing techniques for managing collaboration with the community and currently do not have <br />
as much knowledge about machine translation machines but I have experience in developing applications <br />
and web using collaboration with Git and GitLab.<br />
<br />
===Which of the published tasks are you interested in?===<br />
<br />
[http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code/Easy_dictionary_maintenance Easy dictionary maintenance]<br />
<br />
===Why should Google and Apertium sponsor it?===<br />
<br />
This project will have an impact in all languages. Facilitating dictionary manipulation will benefit everyone,<br />
allowing a wider range of people to contribute to existing dictionaries and start new language projects.<br />
<br />
===How and who will it benefit in society?===<br />
This application will benefit the entire Apertium community.<br />
Dictionary developers will have a tool to speed up their work and an easy-to-use tool will attract new contributors.<br />
As a result, Apertium's translation capacity will be increased, bringing better results to the end user.<br />
<br />
===What do you plan to do?===<br />
We are planning to create a web GUI that will facilitate common tasks of creating/modifying dictionaries and allow lay users to contribute to a dictionary.<br />
The application will be connected to a Git repository, which will be used as an administrative and version control tool.<br />
<br />
<br />
<br />
'''Program Language:''' Java, JavaScript<br /><br />
'''Persistence:''' XML (Apertium XML Files)<br /><br />
'''Framworks:''' Angular<br /><br />
<br />
===Stages/Milestones===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Week<br />
! Stage<br />
! Description<br />
|-<br />
| Community Bonding Period<br />
| Technology analysis<br />
|Analyze and find a good way to manipulate XML in a database.<br />
Testing and choosing the best alternative.<br />
<br />
UML diagrams of the project.<br />
|-<br />
| 1, 2<br />
| --<br />
|Database modeling and creation.<br />
<br />
Implementation of GitConnector.<br />
<br />
|-<br />
| 2, 3<br />
| --<br />
| WebAPI development.<br />
<br />
GUI prototype developement for monolingual dictionary: Symbols, Paradigms and Lemmas.<br />
|-<br />
| 3, 4<br />
| --<br />
| GUI prototype developement for bilingual dictionary.<br />
|-<br />
| '''Prototype'''<br />
| Milestone 1<br />
| First version of GUI for community analysis.<br />
|-<br />
| 5, 6<br />
| --<br />
| Development of WebDictionaryController (monolingual and bilingual dictionary).<br />
|-<br />
| 7, 8<br />
| --<br />
| Adjustments and adding new features with community feedback.<br />
|-<br />
| 9<br />
| --<br />
| Functionalities integrations, test and fixes.<br />
|-<br />
| '''Prototype'''<br />
| Milestone 2<br />
| First functional release for community analysis.<br />
|-<br />
| 10, 11<br />
| --<br />
| Adjustments and adding new features with community feedback.<br />
|-<br />
| 12<br />
| Pré-Release<br />
| Fix remain bugs, final adjustments and documentation in Wiki<br />
|-<br />
| <br />
| '''Final Release'''<br />
|Final version realease.<br />
|}<br />
<br />
===Presentation===<br />
<br />
My name is Vinicius, a Brazilian Student at Federal Center for Technological Education of Minas Gerais - Brazil.<br />
<br />
===Resume of Skills===<br />
<br />
Apertium Knowledge:<br />
<br />
* Study to develop a collaborative tool for apertium.<br />
* A study of actual Apertium process about creating a language pair by the user point of view.<br />
* Analysis of the characteristics of the 2010 project of Aléssio and adaptation to current times.<br />
<br />
Academic Skills:<br />
<br />
* Graduating in Computer Engineering- Federal Center for Technological Education of Minas Gerais – Brazil<br />
<br />
Professional Skills:<br />
<br />
* Language developer: C, Java, JavaScript, PHP, Phyton, PL/SQL.<br />
<br />
Projects for Summer:<br />
<br />
* No professional activities planned.<br />
* Planning to work in GSOC<br />
<br />
=Project=<br />
==Why?==<br />
:* The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps potential contributors away. A tool that facilitates the work of dictionaries developers, eliminate the need of computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
==What its the plan?==<br />
:* We are planning to create a web GUI that allows the user to develop the basic tasks of dictionaries and translation pairs manipulation in an easy and practical way.<br />
:* We will use Git as an administrative and control tool, allowing the user to contribute to the work of other community members or start your own project.<br />
<br />
==Components ans Technologies==<br />
[[File:ComponentDiagramWebDictionary.jpg|thumb|700px|right|Components Diagram]]<br />
* Actors<br />
** Lay User <br />
** Dictionary Admin <br />
<br />
* UserBrowser <br />
** WebInterface with AngularJS - GUI to easily manipulate the dictionary XML file.<br />
<br />
* Web Dicionary Maintence (APP)<br />
** WebAPI - Interface between user's GUI and server.<br />
** Temporary Database - Temporary database in which the XML file will be loaded with the crosses made.<br />
** JavaGit Connector - API to execute necessary Git functions.<br />
** WebDictionary Controller <br />
<br />
* Git <br />
** GitRepository - Repository containing the dictionaries<br />
** GitLab - Repository management tool<br />
** GitHub - Repository management tool<br />
<br />
==How it Works?==<br />
We will develop a WebInterface to lay users add words or suggest modifications.<br />
We are planning to use Git as an administrative and version control tool.<br />
<br />
* All dictionaries releases will be in a single repository and available to any member of the community to continue the work.<br />
* Each user will have your own branch to work on.<br />
* The users will be able to make merge requests with the official branch.<br />
* At first, we will use GitLab (or similar tool) to manage this merges requests. The team who maintain each dictionary will judge if the modifications are valid or not.<br />
<br />
=Example of Interaction - Adding new lemma to a dictionary=<br />
<br />
===1. Choosing an official dictionary and importing it===<br />
The Official Dictionaries page display all available dictionaries in the git repository. Each version correspond to a tag in the master branch.<br />
[[File:Prototype1.png|thumb|600px|right|Choosing an official dictionary and importing it]]<br />
<br />
[[File:Git1.png|thumb|250px|none|Master branch]]<br />
Once imported, the user will name this dictionary and it will appear on the My Dictionaries page.<br />
[[File:Prototype2.png|thumb|600px|right|My Dictionaries page]]<br />
<br />
===2. Loading the dictionary file===<br />
On the Language File page, the user selects one of their dictionaries and the dictionary XML will be formatted to be temporarily saved to a database. Also on this page, the user can edit the dictionary alphabet and see some statistics about it.<br />
<br />
The Symbols, Paradigms, and Lemmas pages refer to the dictionary selected here.<br />
<br />
[[File:Prototype3.png|thumb|600px|right|Loading the dictionary file]]<br />
===3. Verifying if the lemmas already exists===<br />
On the Lemmas - Search page, the user will be able to see all the inflections of the dictionary lemmas and check if the lemma he wants to add already exists.<br />
<br />
[[File:Prototype4.png|thumb|600px|right|Verifying if the lemmas already exists]]<br />
===4. Creating the new lemma===<br />
In the Lemmas - Create page, the user will follow three steps to add a new lemma.<br />
<br />
In the first step, the user will define the lemma and the lemma root. In addition, he will give some examples of inflections and symbols to receive suggestions on which paradigm to use.<br />
<br />
[[File:Prototype5.png|thumb|600px|right|text-top|Creating the new lemma - Step 1]]<br />
In the second step, the user will see paradigm suggestions (or can see all paradigms). When a paradigm is selected, all inflections of the created lemma will be shown to the user. If none of the paradigms fit, the user will be directed to create a new paradigm.<br />
<br />
[[File:Prototype6.png|thumb|600px|right|Creating the new lemma - Step 2]]<br />
In the third and last step, the user will confirm and save the change. At this point, a branch will be create for this dictionary in the git repository (if she doesn’t already exists) and a commit with this changes will be done.<br />
<br />
[[File:Prototype7.png|thumb|600px|right|Creating the new lemma - Step 3]]<br />
===5. Merge Request===<br />
On My Dictionaries page, the user can create a merge request that will be judge by the master branch maintainer.<br />
<br />
[[File:Prototype8.png|thumb|600px|right|Merge Request]]<br />
[[File:Git2.png|thumb|600px|right|New branch created in Git]]<br />
<br />
===6. Official dictionary keeper judges the merge request===<br />
In GitLab (or similar tool), the dictionary maintainer will see the list of merge requests.<br />
[[File:Git5.png|thumb|600px|right|Merge request list]]<br />
At each request, the maintainer can view all commits and accepts only a few of them.<br />
[[File:Git6.png|thumb|600px|right|Commits from current merge request]]<br />
At each commit, he will judge the changes.<br />
[[File:Git7.png|thumb|250px|none|Changes]]<br />
When he accepts the merge request, the user's branch is deleted.<br />
[[File:Git4.png|thumb|250px|none|GitLab Graph]]<br />
<br />
===7. Feedback===<br />
On Merge Requests page, the user can see all request he have made and their status.<br />
<br />
<br />
[[File:Prototype9.png|thumb|250px|none|Feedback]]<br />
<br />
[[Category:GSoC 2019 student proposals|Alessio]]</div>Alessiohttps://wiki.apertium.org/w/index.php?title=Web_Dictionary_Maintenance&diff=69061Web Dictionary Maintenance2019-03-27T02:52:39Z<p>Alessio: /* Example of Interaction - Adding new lemma to a dictionary */</p>
<hr />
<div>{{TOCD}}<br />
<br />
[https://translate.google.com/translate?sl=en&tl=pt-br&prev=_t&hl=en&u=http://wiki.apertium.org/wiki/Web_Dictionary_Maintenance Translate to PT-BR with Google Tradução]<br />
<br />
= Introduction =<br />
<br />
Apertium over the years still has deficiencies so that lay people can contribute to increase the base of words in dictionaries, even with simple contributions. Collaboration is the key to developing a tool that serves a huge range of users throughout the world. We believe that it is possible to engage more users and thus give greater impact to the tool within the communities where there is involvement. We will deal in this document with requirements on non-functional and technical objectives regarding the tool proposal.<br />
<br />
;Original Ideias<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code/Easy_dictionary_maintenance<br />
<br />
;Original GSOC2019 Application<br />
: http://wiki.apertium.org/wiki/User:Alessiojr/Easy_dictionary_-_Application-GSOC2019<br />
<br />
;Studant Information<br />
: '''Student:''' Vinícius Silva Nogueira <br /><br />
: '''Unofficial Mentor:''' Alessio Miranda Junior<br /><br />
: '''Telegram/Whatsapp:''' Alessio: +55 (31) 9.8888-7770<br /><br />
: '''E-mail:''' alessio@cefetmg.br or vinicius_snogueira@hotmail.com / viniciussnogueira13@gmail.com<br /><br />
: '''IRC:''' AlessioJr<br /><br />
: '''GTalk:''' alessiojunin@gmail.com<br />
<br />
=Description=<br />
==Abstract:==<br />
The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps away potential contributors. A tool that facilitates the work of dictionaries developers, eliminate computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
Even with several tools that help the way you manage and create dictionaries, Apertium is far from the normal users, who have a huge contribution potential. Or even create a simple way to create contributions to recurring users with advanced knowledge. Although it is a bold plan, and there are several possible and desirable requirements, we will describe some basic premises for this step and that must be respected and aligned with the apertium developer community.<br />
<br />
==Definitions==<br />
:* Lay users do not need to know Apertium's internal structure.<br />
:* Intermediate users need to have a knowledge of dictionary management methodology. <br />
:* Advanced users are those who know the structure of Apertium.<br />
:* Communities are user groups that merge characteristics to the database extension of a dictionary of a specific language.<br />
:* Official dictionaries are dictionaries managed and with seal of the apertium community.<br />
:* Unofficial dictionaries are dictionaries run by an independent community.<br />
:* Test dictionaries are deprived of users to test their contributions.<br />
<br />
==Objectives:==<br />
:* The major goal of the project is to develop a web tool to facilitate the management of the Apertium (XML's) database of integrators for novice and advanced users.<br />
:* New communities of contributions should be able to organize independently of a central command. The command exists but will be distributed.<br />
:* Lay users who feel motivated to contribute, should have an interface that promotes ease in contributing even with limited possibilities.<br />
:* The development of dictionaries should be collaborative and distributed. Each dictionary should have a management community, but a user may have the freedom to disagree and create a new version maintaining a history of the author.<br />
:* Any tool should maintain the traditional Apertium structure and not be interoperable between existing tools.<br />
:* There must be a methodology for communities to maintain the quality of their dictionaries. Although they are distributed the goal is to create a unified and mature dictionary.<br />
<br />
=Technical Objectives:=<br />
:* Develop, initially, monolingual dictionaries but keeping the particular format of each file.<br />
:* Minimize the direct manipulation of XML files, providing features that reduce this need.<br />
:* Making use of GitLab as an administrative and control tool.<br />
<br />
== Git, GitLab and Apertium ==<br />
[[File:Git_flow_demonstration.jpg|thumb|250px|right|Git Flow demonstration]]<br />
As the Apertium files are textual, we had the idea of seeking productivity and using existing and consolidated tools in the world.<br />
The proposal is to build a friendly web interface for lay users, but use git's own Back-End as version control and to make dictionary management GitLab as an administrative tool that already guarantees incredible power for remote collaboration.<br />
<br />
To demonstrate this relationship we will highlight some concepts of Git. Over time there may be several TimeLines:<br />
:* The Official Branch (Master) has the official version of the apertium managed by official developers or maintainers.<br />
:* Users have the power to create new Branches and develop unofficial dictionaries in parallel, creating communities that may from time to time suggest modifications to Brach Master.<br />
:* These requests can be accepted or rejected by maintainers, and this format is recursive and other developers can create unofficial copies of unofficial ones.<br />
:* Integration requests will use the Merge Request concepts present in tools such as GitLab that will be the BackEnd for advanced users.<br />
<br />
=Application-GSOC2019=<br />
===Abstract:===<br />
The idea is to develop the Web tool so that lay users contribute to dictionaries and use Git management with GitLab to manage these changes.<br />
* The focus will be on monolingual dictionaries and bilingual direct relationships.<br />
* Use the Git methodology and propose a guideline or flow for collaborative dictionary management.<br />
* Do not change the current XML format of dictionaries.<br />
<br />
===Why is it you are interested in machine translation and Apertium?===<br />
<br />
During the graduation course, Professor Aléssio demonstrated the need and opportunity to contribute with open source projects. <br />
He introduced me to Apertium and in my final graduation work I started reading and talking about it. <br />
We started discussing techniques for managing collaboration with the community and currently do not have <br />
as much knowledge about machine translation machines but I have experience in developing applications <br />
and web using collaboration with Git and GitLab.<br />
<br />
===Which of the published tasks are you interested in?===<br />
<br />
[http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code/Easy_dictionary_maintenance Easy dictionary maintenance]<br />
<br />
===Why should Google and Apertium sponsor it?===<br />
<br />
This project will have an impact in all languages. Facilitating dictionary manipulation will benefit everyone,<br />
allowing a wider range of people to contribute to existing dictionaries and start new language projects.<br />
<br />
===How and who will it benefit in society?===<br />
This application will benefit the entire Apertium community.<br />
Dictionary developers will have a tool to speed up their work and an easy-to-use tool will attract new contributors.<br />
As a result, Apertium's translation capacity will be increased, bringing better results to the end user.<br />
<br />
===What do you plan to do?===<br />
We are planning to create a web GUI that will facilitate common tasks of creating/modifying dictionaries and allow lay users to contribute to a dictionary.<br />
The application will be connected to a Git repository, which will be used as an administrative and version control tool.<br />
<br />
<br />
<br />
'''Program Language:''' Java, JavaScript<br /><br />
'''Persistence:''' XML (Apertium XML Files)<br /><br />
'''Framworks:''' Angular<br /><br />
<br />
===Stages/Milestones===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Week<br />
! Stage<br />
! Description<br />
|-<br />
| 1, 2<br />
| --<br />
| --.<br />
|-<br />
| 2, 3<br />
| --<br />
| --.|<br />
|-<br />
| '''Prototype'''<br />
| Milestone 1<br />
| --<br />
|-<br />
| 5, 6<br />
| --<br />
| --.<br />
|-<br />
| 7<br />
| --<br />
| --.<br />
|-<br />
| 8<br />
| --<br />
| --.<br />
|-<br />
| '''Prototype'''<br />
| Milestone 2<br />
| --<br />
|-<br />
| 9<br />
| --<br />
| --.<br />
|-<br />
| 10<br />
| --<br />
| --.<br />
|-<br />
| 11<br />
| Pré-Release<br />
| --<br />
|-<br />
| '''Prototype'''<br />
| --<br />
| <br />
|-<br />
| 12<br />
| Makeup<br />
| --<br />
|-<br />
| <br />
| '''Final Release'''<br />
|<br />
|}<br />
<br />
===Presentation===<br />
<br />
My name is Vinicius, a Brazilian Student at Federal Center for Technological Education of Minas Gerais - Brazil.<br />
<br />
===Resume of Skills===<br />
<br />
Apertium Knowledge:<br />
<br />
* Study to develop a collaborative tool for apertium.<br />
* A study of actual Apertium process about creating a language pair by the user point of view.<br />
* Analysis of the characteristics of the 2010 project of Aléssio and adaptation to current times.<br />
<br />
Academic Skills:<br />
<br />
* Graduating in Computer Engineering- Federal Center for Technological Education of Minas Gerais – Brazil<br />
<br />
Professional Skills:<br />
<br />
* Language developer: C, Java, JavaScript, PHP, Phyton, PL/SQL.<br />
<br />
Projects for Summer:<br />
<br />
* No professional activities planned.<br />
* Planning to work in GSOC<br />
<br />
=Project=<br />
==Why?==<br />
:* The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps potential contributors away. A tool that facilitates the work of dictionaries developers, eliminate the need of computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
==What its the plan?==<br />
:* We are planning to create a web GUI that allows the user to develop the basic tasks of dictionaries and translation pairs manipulation in an easy and practical way.<br />
:* We will use Git as an administrative and control tool, allowing the user to contribute to the work of other community members or start your own project.<br />
<br />
==Components ans Technologies==<br />
[[File:ComponentDiagramWebDictionary.jpg|thumb|700px|right|Components Diagram]]<br />
* Actors<br />
** Lay User <br />
** Dictionary Admin <br />
<br />
* UserBrowser <br />
** WebInterface with AngularJS - GUI to easily manipulate the dictionary XML file.<br />
<br />
* Web Dicionary Maintence (APP)<br />
** WebAPI - Interface between user's GUI and server.<br />
** Temporary Database - Temporary database in which the XML file will be loaded with the crosses made.<br />
** JavaGit Connector - API to execute necessary Git functions.<br />
** WebDictionary Controller <br />
<br />
* Git <br />
** GitRepository - Repository containing the dictionaries<br />
** GitLab - Repository management tool<br />
** GitHub - Repository management tool<br />
<br />
==How it Works?==<br />
We will develop a WebInterface to lay users add words or suggest modifications.<br />
We are planning to use Git as an administrative and version control tool.<br />
<br />
* All dictionaries releases will be in a single repository and available to any member of the community to continue the work.<br />
* Each user will have your own branch to work on.<br />
* The users will be able to make merge requests with the official branch.<br />
* At first, we will use GitLab (or similar tool) to manage this merges requests. The team who maintain each dictionary will judge if the modifications are valid or not.<br />
<br />
=Example of Interaction - Adding new lemma to a dictionary=<br />
<br />
===1. Choosing an official dictionary and importing it===<br />
The Official Dictionaries page display all available dictionaries in the git repository. Each version correspond to a tag in the master branch.<br />
[[File:Prototype1.png|thumb|600px|right|Choosing an official dictionary and importing it]]<br />
<br />
[[File:Git1.png|thumb|250px|none|Master branch]]<br />
Once imported, the user will name this dictionary and it will appear on the My Dictionaries page.<br />
[[File:Prototype2.png|thumb|600px|right|My Dictionaries page]]<br />
<br />
===2. Loading the dictionary file===<br />
On the Language File page, the user selects one of their dictionaries and the dictionary XML will be formatted to be temporarily saved to a database. Also on this page, the user can edit the dictionary alphabet and see some statistics about it.<br />
<br />
The Symbols, Paradigms, and Lemmas pages refer to the dictionary selected here.<br />
<br />
[[File:Prototype3.png|thumb|600px|right|Loading the dictionary file]]<br />
===3. Verifying if the lemmas already exists===<br />
On the Lemmas - Search page, the user will be able to see all the inflections of the dictionary lemmas and check if the lemma he wants to add already exists.<br />
<br />
[[File:Prototype4.png|thumb|600px|right|Verifying if the lemmas already exists]]<br />
===4. Creating the new lemma===<br />
In the Lemmas - Create page, the user will follow three steps to add a new lemma.<br />
<br />
In the first step, the user will define the lemma and the lemma root. In addition, he will give some examples of inflections and symbols to receive suggestions on which paradigm to use.<br />
<br />
[[File:Prototype5.png|thumb|600px|right|text-top|Creating the new lemma - Step 1]]<br />
In the second step, the user will see paradigm suggestions (or can see all paradigms). When a paradigm is selected, all inflections of the created lemma will be shown to the user. If none of the paradigms fit, the user will be directed to create a new paradigm.<br />
<br />
[[File:Prototype6.png|thumb|600px|right|Creating the new lemma - Step 2]]<br />
In the third and last step, the user will confirm and save the change. At this point, a branch will be create for this dictionary in the git repository (if she doesn’t already exists) and a commit with this changes will be done.<br />
<br />
[[File:Prototype7.png|thumb|600px|right|Creating the new lemma - Step 3]]<br />
===5. Merge Request===<br />
On My Dictionaries page, the user can create a merge request that will be judge by the master branch maintainer.<br />
<br />
[[File:Prototype8.png|thumb|600px|right|Merge Request]]<br />
[[File:Git2.png|thumb|600px|right|New branch created in Git]]<br />
<br />
===6. Official dictionary keeper judges the merge request===<br />
In GitLab (or similar tool), the dictionary maintainer will see the list of merge requests.<br />
[[File:Git5.png|thumb|600px|right|Merge request list]]<br />
At each request, the maintainer can view all commits and accepts only a few of them.<br />
[[File:Git6.png|thumb|600px|right|Commits from current merge request]]<br />
At each commit, he will judge the changes.<br />
[[File:Git7.png|thumb|250px|none|Changes]]<br />
When he accepts the merge request, the user's branch is deleted.<br />
[[File:Git4.png|thumb|250px|none|GitLab Graph]]<br />
<br />
===7. Feedback===<br />
On Merge Requests page, the user can see all request he have made and their status.<br />
<br />
<br />
[[File:Prototype9.png|thumb|250px|none|Feedback]]<br />
<br />
[[Category:GSoC 2019 student proposals|Alessio]]</div>Alessiohttps://wiki.apertium.org/w/index.php?title=Web_Dictionary_Maintenance&diff=69046Web Dictionary Maintenance2019-03-26T19:22:04Z<p>Alessio: /* Project */</p>
<hr />
<div>{{TOCD}}<br />
<br />
[https://translate.google.com/translate?sl=en&tl=pt-br&prev=_t&hl=en&u=http://wiki.apertium.org/wiki/Web_Dictionary_Maintenance Translate to PT-BR with Google Tradução]<br />
<br />
= Introduction =<br />
<br />
Apertium over the years still has deficiencies so that lay people can contribute to increase the base of words in dictionaries, even with simple contributions. Collaboration is the key to developing a tool that serves a huge range of users throughout the world. We believe that it is possible to engage more users and thus give greater impact to the tool within the communities where there is involvement. We will deal in this document with requirements on non-functional and technical objectives regarding the tool proposal.<br />
<br />
;Original Ideias<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code/Easy_dictionary_maintenance<br />
<br />
;Original GSOC2019 Application<br />
: http://wiki.apertium.org/wiki/User:Alessiojr/Easy_dictionary_-_Application-GSOC2019<br />
<br />
;Studant Information<br />
: '''Student:''' Vinícius Silva Nogueira <br /><br />
: '''Unofficial Mentor:''' Alessio Miranda Junior<br /><br />
: '''Telegram/Whatsapp:''' Alessio: +55 (31) 9.8888-7770<br /><br />
: '''E-mail:''' alessio@cefetmg.br or vinicius_snogueira@hotmail.com / viniciussnogueira13@gmail.com<br /><br />
: '''IRC:''' AlessioJr<br /><br />
: '''GTalk:''' alessiojunin@gmail.com<br />
<br />
=Description=<br />
==Abstract:==<br />
The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps away potential contributors. A tool that facilitates the work of dictionaries developers, eliminate computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
Even with several tools that help the way you manage and create dictionaries, Apertium is far from the normal users, who have a huge contribution potential. Or even create a simple way to create contributions to recurring users with advanced knowledge. Although it is a bold plan, and there are several possible and desirable requirements, we will describe some basic premises for this step and that must be respected and aligned with the apertium developer community.<br />
<br />
==Definitions==<br />
:* Lay users do not need to know Apertium's internal structure.<br />
:* Intermediate users need to have a knowledge of dictionary management methodology. <br />
:* Advanced users are those who know the structure of Apertium.<br />
:* Communities are user groups that merge characteristics to the database extension of a dictionary of a specific language.<br />
:* Official dictionaries are dictionaries managed and with seal of the apertium community.<br />
:* Unofficial dictionaries are dictionaries run by an independent community.<br />
:* Test dictionaries are deprived of users to test their contributions.<br />
<br />
==Objectives:==<br />
:* The major goal of the project is to develop a web tool to facilitate the management of the Apertium (XML's) database of integrators for novice and advanced users.<br />
:* New communities of contributions should be able to organize independently of a central command. The command exists but will be distributed.<br />
:* Lay users who feel motivated to contribute, should have an interface that promotes ease in contributing even with limited possibilities.<br />
:* The development of dictionaries should be collaborative and distributed. Each dictionary should have a management community, but a user may have the freedom to disagree and create a new version maintaining a history of the author.<br />
:* Any tool should maintain the traditional Apertium structure and not be interoperable between existing tools.<br />
:* There must be a methodology for communities to maintain the quality of their dictionaries. Although they are distributed the goal is to create a unified and mature dictionary.<br />
<br />
=Technical Objectives:=<br />
:* Develop, initially, monolingual dictionaries but keeping the particular format of each file.<br />
:* Minimize the direct manipulation of XML files, providing features that reduce this need.<br />
:* Making use of GitLab as an administrative and control tool.<br />
<br />
== Git, GitLab and Apertium ==<br />
[[File:Git_flow_demonstration.jpg|thumb|250px|right|Git Flow demonstration]]<br />
As the Apertium files are textual, we had the idea of seeking productivity and using existing and consolidated tools in the world.<br />
The proposal is to build a friendly web interface for lay users, but use git's own Back-End as version control and to make dictionary management GitLab as an administrative tool that already guarantees incredible power for remote collaboration.<br />
<br />
To demonstrate this relationship we will highlight some concepts of Git. Over time there may be several TimeLines:<br />
:* The Official Branch (Master) has the official version of the apertium managed by official developers or maintainers.<br />
:* Users have the power to create new Branches and develop unofficial dictionaries in parallel, creating communities that may from time to time suggest modifications to Brach Master.<br />
:* These requests can be accepted or rejected by maintainers, and this format is recursive and other developers can create unofficial copies of unofficial ones.<br />
:* Integration requests will use the Merge Request concepts present in tools such as GitLab that will be the BackEnd for advanced users.<br />
<br />
=Application-GSOC2019=<br />
===Abstract:===<br />
The idea is to develop the Web tool so that lay users contribute to dictionaries and use Git management with GitLab to manage these changes.<br />
* The focus will be on monolingual dictionaries and bilingual direct relationships.<br />
* Use the Git methodology and propose a guideline or flow for collaborative dictionary management.<br />
* Do not change the current XML format of dictionaries.<br />
<br />
===Why is it you are interested in machine translation and Apertium?===<br />
<br />
During the graduation course, Professor Aléssio demonstrated the need and opportunity to contribute with open source projects. <br />
He introduced me to Apertium and in my final graduation work I started reading and talking about it. <br />
We started discussing techniques for managing collaboration with the community and currently do not have <br />
as much knowledge about machine translation machines but I have experience in developing applications <br />
and web using collaboration with Git and GitLab.<br />
<br />
===Which of the published tasks are you interested in?===<br />
<br />
[http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code/Easy_dictionary_maintenance Easy dictionary maintenance]<br />
<br />
===Why should Google and Apertium sponsor it?===<br />
<br />
This project will have an impact in all languages. Facilitating dictionary manipulation will benefit everyone,<br />
allowing a wider range of people to contribute to existing dictionaries and start new language projects.<br />
<br />
===How and who will it benefit in society?===<br />
This application will benefit the entire Apertium community.<br />
Dictionary developers will have a tool to speed up their work and an easy-to-use tool will attract new contributors.<br />
As a result, Apertium's translation capacity will be increased, bringing better results to the end user.<br />
<br />
===What do you plan to do?===<br />
We are planning to create a web GUI that will facilitate common tasks of creating/modifying dictionaries and allow lay users to contribute to a dictionary.<br />
The application will be connected to a Git repository, which will be used as an administrative and version control tool.<br />
<br />
<br />
<br />
'''Program Language:''' Java, JavaScript<br /><br />
'''Persistence:''' XML (Apertium XML Files)<br /><br />
'''Framworks:''' Angular<br /><br />
<br />
===Stages/Milestones===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Week<br />
! Stage<br />
! Description<br />
|-<br />
| 1, 2<br />
| --<br />
| --.<br />
|-<br />
| 2, 3<br />
| --<br />
| --.|<br />
|-<br />
| '''Prototype'''<br />
| Milestone 1<br />
| --<br />
|-<br />
| 5, 6<br />
| --<br />
| --.<br />
|-<br />
| 7<br />
| --<br />
| --.<br />
|-<br />
| 8<br />
| --<br />
| --.<br />
|-<br />
| '''Prototype'''<br />
| Milestone 2<br />
| --<br />
|-<br />
| 9<br />
| --<br />
| --.<br />
|-<br />
| 10<br />
| --<br />
| --.<br />
|-<br />
| 11<br />
| Pré-Release<br />
| --<br />
|-<br />
| '''Prototype'''<br />
| --<br />
| <br />
|-<br />
| 12<br />
| Makeup<br />
| --<br />
|-<br />
| <br />
| '''Final Release'''<br />
|<br />
|}<br />
<br />
===Presentation===<br />
<br />
My name is Vinicius, a Brazilian Student at Federal Center for Technological Education of Minas Gerais - Brazil.<br />
<br />
===Resume of Skills===<br />
<br />
Apertium Knowledge:<br />
<br />
* Study to develop a collaborative tool for apertium.<br />
* A study of actual Apertium process about creating a language pair by the user point of view.<br />
* Analysis of the characteristics of the 2010 project of Aléssio and adaptation to current times.<br />
<br />
Academic Skills:<br />
<br />
* Graduating in Computer Engineering- Federal Center for Technological Education of Minas Gerais – Brazil<br />
<br />
Professional Skills:<br />
<br />
* Language developer: C, Java, JavaScript, PHP, Phyton, PL/SQL.<br />
<br />
Projects for Summer:<br />
<br />
* No professional activities planned.<br />
* Planning to work in GSOC<br />
<br />
=Project=<br />
==Why?==<br />
:* The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps potential contributors away. A tool that facilitates the work of dictionaries developers, eliminate the need of computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
==What its the plan?==<br />
:* We are planning to create a web GUI that allows the user to develop the basic tasks of dictionaries and translation pairs manipulation in an easy and practical way.<br />
:* We will use Git as an administrative and control tool, allowing the user to contribute to the work of other community members or start your own project.<br />
<br />
==Components ans Technologies==<br />
[[File:ComponentDiagramWebDictionary.jpg|thumb|700px|right|Components Diagram]]<br />
* Actors<br />
** Lay User <br />
** Dictionary Admin <br />
<br />
* UserBrowser <br />
** WebInterface with AngularJS - GUI to easily manipulate the dictionary XML file.<br />
<br />
* Web Dicionary Maintence (APP)<br />
** WebAPI - Interface between user's GUI and server.<br />
** Temporary Database - Temporary database in which the XML file will be loaded with the crosses made.<br />
** JavaGit Connector - API to execute necessary Git functions.<br />
** WebDictionary Controller <br />
<br />
* Git <br />
** GitRepository - Repository containing the dictionaries<br />
** GitLab - Repository management tool<br />
** GitHub - Repository management tool<br />
<br />
==How it Works?==<br />
We will develop a WebInterface to lay users add words or suggest modifications.<br />
We are planning to use Git as an administrative and version control tool.<br />
<br />
* All dictionaries releases will be in a single repository and available to any member of the community to continue the work.<br />
* Each user will have your own branch to work on.<br />
* The users will be able to make merge requests with the official branch.<br />
* At first, we will use GitLab (or similar tool) to manage this merges requests. The team who maintain each dictionary will judge if the modifications are valid or not.<br />
<br />
==Example of Interaction - Adding new lemma to a dictionary==<br />
<br />
===1. Choosing an official dictionary and importing it===<br />
The Official Dictionaries page display all available dictionaries in the git repository. Each version correspond to a tag in the master branch.<br />
[[File:Prototype1.png|thumb|250px|none|Choosing an official dictionary and importing it]]<br />
<br />
[[File:Git1.png|thumb|250px|none|Master branch]]<br />
Once imported, the user will name this dictionary and it will appear on the My Dictionaries page.<br />
[[File:Prototype2.png|thumb|250px|none|My Dictionaries page]]<br />
<br />
===2. Loading the dictionary file===<br />
On the Language File page, the user selects one of their dictionaries and the dictionary XML will be formatted to be temporarily saved to a database. Also on this page, the user can edit the dictionary alphabet and see some statistics about it.<br />
<br />
The Symbols, Paradigms, and Lemmas pages refer to the dictionary selected here.<br />
<br />
[[File:Prototype3.png|thumb|250px|none|Loading the dictionary file]]<br />
===3. Verifying if the lemmas already exists===<br />
On the Lemmas - Search page, the user will be able to see all the inflections of the dictionary lemmas and check if the lemma he wants to add already exists.<br />
<br />
[[File:Prototype4.png|thumb|250px|none|Verifying if the lemmas already exists]]<br />
===4. Creating the new lemma===<br />
In the Lemmas - Create page, the user will follow three steps to add a new lemma.<br />
<br />
In the first step, the user will define the lemma and the lemma root. In addition, he will give some examples of inflections and symbols to receive suggestions on which paradigm to use.<br />
<br />
[[File:Prototype5.png|thumb|250px|none|text-top|Creating the new lemma - Step 1]]<br />
In the second step, the user will see paradigm suggestions (or can see all paradigms). When a paradigm is selected, all inflections of the created lemma will be shown to the user. If none of the paradigms fit, the user will be directed to create a new paradigm.<br />
<br />
[[File:Prototype6.png|thumb|250px|none|Creating the new lemma - Step 2]]<br />
In the third and last step, the user will confirm and save the change. At this point, a branch will be create for this dictionary in the git repository (if she doesn’t already exists) and a commit with this changes will be done.<br />
<br />
[[File:Prototype7.png|thumb|250px|none|Creating the new lemma - Step 3]]<br />
===5. Merge Request===<br />
On My Dictionaries page, the user can create a merge request that will be judge by the master branch maintainer.<br />
<br />
[[File:Prototype8.png|thumb|250px|none|Merge Request]]<br />
[[File:Git2.png|thumb|250px|none|New branch created in Git]]<br />
<br />
===6. Official dictionary keeper judges the merge request===<br />
In GitLab (or similar tool), the dictionary maintainer will see the list of merge requests.<br />
[[File:Git5.png|thumb|250px|none|Merge request list]]<br />
At each request, the maintainer can view all commits and accepts only a few of them.<br />
[[File:Git6.png|thumb|250px|none|Commits from current merge request]]<br />
At each commit, he will judge the changes.<br />
[[File:Git7.png|thumb|250px|none|Changes]]<br />
When he accepts the merge request, the user's branch is deleted.<br />
[[File:Git4.png|thumb|250px|none|GitLab Graph]]<br />
<br />
===7. Feedback===<br />
On Merge Requests page, the user can see all request he have made and their status.<br />
<br />
<br />
[[File:Prototype9.png|thumb|250px|none|Feedback]]<br />
<br />
[[Category:GSoC 2019 student proposals|Alessio]]</div>Alessiohttps://wiki.apertium.org/w/index.php?title=Web_Dictionary_Maintenance&diff=69045Web Dictionary Maintenance2019-03-26T19:20:51Z<p>Alessio: /* What do you plan to do? */</p>
<hr />
<div>{{TOCD}}<br />
<br />
[https://translate.google.com/translate?sl=en&tl=pt-br&prev=_t&hl=en&u=http://wiki.apertium.org/wiki/Web_Dictionary_Maintenance Translate to PT-BR with Google Tradução]<br />
<br />
= Introduction =<br />
<br />
Apertium over the years still has deficiencies so that lay people can contribute to increase the base of words in dictionaries, even with simple contributions. Collaboration is the key to developing a tool that serves a huge range of users throughout the world. We believe that it is possible to engage more users and thus give greater impact to the tool within the communities where there is involvement. We will deal in this document with requirements on non-functional and technical objectives regarding the tool proposal.<br />
<br />
;Original Ideias<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code/Easy_dictionary_maintenance<br />
<br />
;Original GSOC2019 Application<br />
: http://wiki.apertium.org/wiki/User:Alessiojr/Easy_dictionary_-_Application-GSOC2019<br />
<br />
;Studant Information<br />
: '''Student:''' Vinícius Silva Nogueira <br /><br />
: '''Unofficial Mentor:''' Alessio Miranda Junior<br /><br />
: '''Telegram/Whatsapp:''' Alessio: +55 (31) 9.8888-7770<br /><br />
: '''E-mail:''' alessio@cefetmg.br or vinicius_snogueira@hotmail.com / viniciussnogueira13@gmail.com<br /><br />
: '''IRC:''' AlessioJr<br /><br />
: '''GTalk:''' alessiojunin@gmail.com<br />
<br />
=Description=<br />
==Abstract:==<br />
The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps away potential contributors. A tool that facilitates the work of dictionaries developers, eliminate computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
Even with several tools that help the way you manage and create dictionaries, Apertium is far from the normal users, who have a huge contribution potential. Or even create a simple way to create contributions to recurring users with advanced knowledge. Although it is a bold plan, and there are several possible and desirable requirements, we will describe some basic premises for this step and that must be respected and aligned with the apertium developer community.<br />
<br />
==Definitions==<br />
:* Lay users do not need to know Apertium's internal structure.<br />
:* Intermediate users need to have a knowledge of dictionary management methodology. <br />
:* Advanced users are those who know the structure of Apertium.<br />
:* Communities are user groups that merge characteristics to the database extension of a dictionary of a specific language.<br />
:* Official dictionaries are dictionaries managed and with seal of the apertium community.<br />
:* Unofficial dictionaries are dictionaries run by an independent community.<br />
:* Test dictionaries are deprived of users to test their contributions.<br />
<br />
==Objectives:==<br />
:* The major goal of the project is to develop a web tool to facilitate the management of the Apertium (XML's) database of integrators for novice and advanced users.<br />
:* New communities of contributions should be able to organize independently of a central command. The command exists but will be distributed.<br />
:* Lay users who feel motivated to contribute, should have an interface that promotes ease in contributing even with limited possibilities.<br />
:* The development of dictionaries should be collaborative and distributed. Each dictionary should have a management community, but a user may have the freedom to disagree and create a new version maintaining a history of the author.<br />
:* Any tool should maintain the traditional Apertium structure and not be interoperable between existing tools.<br />
:* There must be a methodology for communities to maintain the quality of their dictionaries. Although they are distributed the goal is to create a unified and mature dictionary.<br />
<br />
=Technical Objectives:=<br />
:* Develop, initially, monolingual dictionaries but keeping the particular format of each file.<br />
:* Minimize the direct manipulation of XML files, providing features that reduce this need.<br />
:* Making use of GitLab as an administrative and control tool.<br />
<br />
== Git, GitLab and Apertium ==<br />
[[File:Git_flow_demonstration.jpg|thumb|250px|right|Git Flow demonstration]]<br />
As the Apertium files are textual, we had the idea of seeking productivity and using existing and consolidated tools in the world.<br />
The proposal is to build a friendly web interface for lay users, but use git's own Back-End as version control and to make dictionary management GitLab as an administrative tool that already guarantees incredible power for remote collaboration.<br />
<br />
To demonstrate this relationship we will highlight some concepts of Git. Over time there may be several TimeLines:<br />
:* The Official Branch (Master) has the official version of the apertium managed by official developers or maintainers.<br />
:* Users have the power to create new Branches and develop unofficial dictionaries in parallel, creating communities that may from time to time suggest modifications to Brach Master.<br />
:* These requests can be accepted or rejected by maintainers, and this format is recursive and other developers can create unofficial copies of unofficial ones.<br />
:* Integration requests will use the Merge Request concepts present in tools such as GitLab that will be the BackEnd for advanced users.<br />
<br />
=Application-GSOC2019=<br />
===Abstract:===<br />
The idea is to develop the Web tool so that lay users contribute to dictionaries and use Git management with GitLab to manage these changes.<br />
* The focus will be on monolingual dictionaries and bilingual direct relationships.<br />
* Use the Git methodology and propose a guideline or flow for collaborative dictionary management.<br />
* Do not change the current XML format of dictionaries.<br />
<br />
===Why is it you are interested in machine translation and Apertium?===<br />
<br />
During the graduation course, Professor Aléssio demonstrated the need and opportunity to contribute with open source projects. <br />
He introduced me to Apertium and in my final graduation work I started reading and talking about it. <br />
We started discussing techniques for managing collaboration with the community and currently do not have <br />
as much knowledge about machine translation machines but I have experience in developing applications <br />
and web using collaboration with Git and GitLab.<br />
<br />
===Which of the published tasks are you interested in?===<br />
<br />
[http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code/Easy_dictionary_maintenance Easy dictionary maintenance]<br />
<br />
===Why should Google and Apertium sponsor it?===<br />
<br />
This project will have an impact in all languages. Facilitating dictionary manipulation will benefit everyone,<br />
allowing a wider range of people to contribute to existing dictionaries and start new language projects.<br />
<br />
===How and who will it benefit in society?===<br />
This application will benefit the entire Apertium community.<br />
Dictionary developers will have a tool to speed up their work and an easy-to-use tool will attract new contributors.<br />
As a result, Apertium's translation capacity will be increased, bringing better results to the end user.<br />
<br />
===What do you plan to do?===<br />
We are planning to create a web GUI that will facilitate common tasks of creating/modifying dictionaries and allow lay users to contribute to a dictionary.<br />
The application will be connected to a Git repository, which will be used as an administrative and version control tool.<br />
<br />
<br />
<br />
'''Program Language:''' Java, JavaScript<br /><br />
'''Persistence:''' XML (Apertium XML Files)<br /><br />
'''Framworks:''' Angular<br /><br />
<br />
===Stages/Milestones===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Week<br />
! Stage<br />
! Description<br />
|-<br />
| 1, 2<br />
| --<br />
| --.<br />
|-<br />
| 2, 3<br />
| --<br />
| --.|<br />
|-<br />
| '''Prototype'''<br />
| Milestone 1<br />
| --<br />
|-<br />
| 5, 6<br />
| --<br />
| --.<br />
|-<br />
| 7<br />
| --<br />
| --.<br />
|-<br />
| 8<br />
| --<br />
| --.<br />
|-<br />
| '''Prototype'''<br />
| Milestone 2<br />
| --<br />
|-<br />
| 9<br />
| --<br />
| --.<br />
|-<br />
| 10<br />
| --<br />
| --.<br />
|-<br />
| 11<br />
| Pré-Release<br />
| --<br />
|-<br />
| '''Prototype'''<br />
| --<br />
| <br />
|-<br />
| 12<br />
| Makeup<br />
| --<br />
|-<br />
| <br />
| '''Final Release'''<br />
|<br />
|}<br />
<br />
===Presentation===<br />
<br />
My name is Vinicius, a Brazilian Student at Federal Center for Technological Education of Minas Gerais - Brazil.<br />
<br />
===Resume of Skills===<br />
<br />
Apertium Knowledge:<br />
<br />
* Study to develop a collaborative tool for apertium.<br />
* A study of actual Apertium process about creating a language pair by the user point of view.<br />
* Analysis of the characteristics of the 2010 project of Aléssio and adaptation to current times.<br />
<br />
Academic Skills:<br />
<br />
* Graduating in Computer Engineering- Federal Center for Technological Education of Minas Gerais – Brazil<br />
<br />
Professional Skills:<br />
<br />
* Language developer: C, Java, JavaScript, PHP, Phyton, PL/SQL.<br />
<br />
Projects for Summer:<br />
<br />
* No professional activities planned.<br />
* Planning to work in GSOC<br />
<br />
=Project=<br />
==Why?==<br />
:* The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps potential contributors away. A tool that facilitates the work of dictionaries developers, eliminate the need of computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
==How can use?==<br />
:* --.<br />
:* --.<br />
:* --.<br />
:* --.<br />
<br />
==What its the plan?==<br />
:* We are planning to create a web GUI that allows the user to develop the basic tasks of dictionaries and translation pairs manipulation in an easy and practical way.<br />
:* We will use Git as an administrative and control tool, allowing the user to contribute to the work of other community members or start your own project.<br />
<br />
==Components ans Technologies==<br />
[[File:ComponentDiagramWebDictionary.jpg|thumb|700px|right|Components Diagram]]<br />
* Actors<br />
** Lay User <br />
** Dictionary Admin <br />
<br />
* UserBrowser <br />
** WebInterface with AngularJS - GUI to easily manipulate the dictionary XML file.<br />
<br />
* Web Dicionary Maintence (APP)<br />
** WebAPI - Interface between user's GUI and server.<br />
** Temporary Database - Temporary database in which the XML file will be loaded with the crosses made.<br />
** JavaGit Connector - API to execute necessary Git functions.<br />
** WebDictionary Controller <br />
<br />
* Git <br />
** GitRepository - Repository containing the dictionaries<br />
** GitLab - Repository management tool<br />
** GitHub - Repository management tool<br />
<br />
==How it Works?==<br />
We will develop a WebInterface to lay users add words or suggest modifications.<br />
We are planning to use Git as an administrative and version control tool.<br />
<br />
* All dictionaries releases will be in a single repository and available to any member of the community to continue the work.<br />
* Each user will have your own branch to work on.<br />
* The users will be able to make merge requests with the official branch.<br />
* At first, we will use GitLab (or similar tool) to manage this merges requests. The team who maintain each dictionary will judge if the modifications are valid or not.<br />
<br />
==Example of Interaction - Adding new lemma to a dictionary==<br />
<br />
===1. Choosing an official dictionary and importing it===<br />
The Official Dictionaries page display all available dictionaries in the git repository. Each version correspond to a tag in the master branch.<br />
[[File:Prototype1.png|thumb|250px|none|Choosing an official dictionary and importing it]]<br />
<br />
[[File:Git1.png|thumb|250px|none|Master branch]]<br />
Once imported, the user will name this dictionary and it will appear on the My Dictionaries page.<br />
[[File:Prototype2.png|thumb|250px|none|My Dictionaries page]]<br />
<br />
===2. Loading the dictionary file===<br />
On the Language File page, the user selects one of their dictionaries and the dictionary XML will be formatted to be temporarily saved to a database. Also on this page, the user can edit the dictionary alphabet and see some statistics about it.<br />
<br />
The Symbols, Paradigms, and Lemmas pages refer to the dictionary selected here.<br />
<br />
[[File:Prototype3.png|thumb|250px|none|Loading the dictionary file]]<br />
===3. Verifying if the lemmas already exists===<br />
On the Lemmas - Search page, the user will be able to see all the inflections of the dictionary lemmas and check if the lemma he wants to add already exists.<br />
<br />
[[File:Prototype4.png|thumb|250px|none|Verifying if the lemmas already exists]]<br />
===4. Creating the new lemma===<br />
In the Lemmas - Create page, the user will follow three steps to add a new lemma.<br />
<br />
In the first step, the user will define the lemma and the lemma root. In addition, he will give some examples of inflections and symbols to receive suggestions on which paradigm to use.<br />
<br />
[[File:Prototype5.png|thumb|250px|none|text-top|Creating the new lemma - Step 1]]<br />
In the second step, the user will see paradigm suggestions (or can see all paradigms). When a paradigm is selected, all inflections of the created lemma will be shown to the user. If none of the paradigms fit, the user will be directed to create a new paradigm.<br />
<br />
[[File:Prototype6.png|thumb|250px|none|Creating the new lemma - Step 2]]<br />
In the third and last step, the user will confirm and save the change. At this point, a branch will be create for this dictionary in the git repository (if she doesn’t already exists) and a commit with this changes will be done.<br />
<br />
[[File:Prototype7.png|thumb|250px|none|Creating the new lemma - Step 3]]<br />
===5. Merge Request===<br />
On My Dictionaries page, the user can create a merge request that will be judge by the master branch maintainer.<br />
<br />
[[File:Prototype8.png|thumb|250px|none|Merge Request]]<br />
[[File:Git2.png|thumb|250px|none|New branch created in Git]]<br />
<br />
===6. Official dictionary keeper judges the merge request===<br />
In GitLab (or similar tool), the dictionary maintainer will see the list of merge requests.<br />
[[File:Git5.png|thumb|250px|none|Merge request list]]<br />
At each request, the maintainer can view all commits and accepts only a few of them.<br />
[[File:Git6.png|thumb|250px|none|Commits from current merge request]]<br />
At each commit, he will judge the changes.<br />
[[File:Git7.png|thumb|250px|none|Changes]]<br />
When he accepts the merge request, the user's branch is deleted.<br />
[[File:Git4.png|thumb|250px|none|GitLab Graph]]<br />
<br />
===7. Feedback===<br />
On Merge Requests page, the user can see all request he have made and their status.<br />
<br />
<br />
[[File:Prototype9.png|thumb|250px|none|Feedback]]<br />
<br />
[[Category:GSoC 2019 student proposals|Alessio]]</div>Alessiohttps://wiki.apertium.org/w/index.php?title=Web_Dictionary_Maintenance&diff=69044Web Dictionary Maintenance2019-03-26T19:18:26Z<p>Alessio: /* How it Works? */</p>
<hr />
<div>{{TOCD}}<br />
<br />
[https://translate.google.com/translate?sl=en&tl=pt-br&prev=_t&hl=en&u=http://wiki.apertium.org/wiki/Web_Dictionary_Maintenance Translate to PT-BR with Google Tradução]<br />
<br />
= Introduction =<br />
<br />
Apertium over the years still has deficiencies so that lay people can contribute to increase the base of words in dictionaries, even with simple contributions. Collaboration is the key to developing a tool that serves a huge range of users throughout the world. We believe that it is possible to engage more users and thus give greater impact to the tool within the communities where there is involvement. We will deal in this document with requirements on non-functional and technical objectives regarding the tool proposal.<br />
<br />
;Original Ideias<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code/Easy_dictionary_maintenance<br />
<br />
;Original GSOC2019 Application<br />
: http://wiki.apertium.org/wiki/User:Alessiojr/Easy_dictionary_-_Application-GSOC2019<br />
<br />
;Studant Information<br />
: '''Student:''' Vinícius Silva Nogueira <br /><br />
: '''Unofficial Mentor:''' Alessio Miranda Junior<br /><br />
: '''Telegram/Whatsapp:''' Alessio: +55 (31) 9.8888-7770<br /><br />
: '''E-mail:''' alessio@cefetmg.br or vinicius_snogueira@hotmail.com / viniciussnogueira13@gmail.com<br /><br />
: '''IRC:''' AlessioJr<br /><br />
: '''GTalk:''' alessiojunin@gmail.com<br />
<br />
=Description=<br />
==Abstract:==<br />
The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps away potential contributors. A tool that facilitates the work of dictionaries developers, eliminate computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
Even with several tools that help the way you manage and create dictionaries, Apertium is far from the normal users, who have a huge contribution potential. Or even create a simple way to create contributions to recurring users with advanced knowledge. Although it is a bold plan, and there are several possible and desirable requirements, we will describe some basic premises for this step and that must be respected and aligned with the apertium developer community.<br />
<br />
==Definitions==<br />
:* Lay users do not need to know Apertium's internal structure.<br />
:* Intermediate users need to have a knowledge of dictionary management methodology. <br />
:* Advanced users are those who know the structure of Apertium.<br />
:* Communities are user groups that merge characteristics to the database extension of a dictionary of a specific language.<br />
:* Official dictionaries are dictionaries managed and with seal of the apertium community.<br />
:* Unofficial dictionaries are dictionaries run by an independent community.<br />
:* Test dictionaries are deprived of users to test their contributions.<br />
<br />
==Objectives:==<br />
:* The major goal of the project is to develop a web tool to facilitate the management of the Apertium (XML's) database of integrators for novice and advanced users.<br />
:* New communities of contributions should be able to organize independently of a central command. The command exists but will be distributed.<br />
:* Lay users who feel motivated to contribute, should have an interface that promotes ease in contributing even with limited possibilities.<br />
:* The development of dictionaries should be collaborative and distributed. Each dictionary should have a management community, but a user may have the freedom to disagree and create a new version maintaining a history of the author.<br />
:* Any tool should maintain the traditional Apertium structure and not be interoperable between existing tools.<br />
:* There must be a methodology for communities to maintain the quality of their dictionaries. Although they are distributed the goal is to create a unified and mature dictionary.<br />
<br />
=Technical Objectives:=<br />
:* Develop, initially, monolingual dictionaries but keeping the particular format of each file.<br />
:* Minimize the direct manipulation of XML files, providing features that reduce this need.<br />
:* Making use of GitLab as an administrative and control tool.<br />
<br />
== Git, GitLab and Apertium ==<br />
[[File:Git_flow_demonstration.jpg|thumb|250px|right|Git Flow demonstration]]<br />
As the Apertium files are textual, we had the idea of seeking productivity and using existing and consolidated tools in the world.<br />
The proposal is to build a friendly web interface for lay users, but use git's own Back-End as version control and to make dictionary management GitLab as an administrative tool that already guarantees incredible power for remote collaboration.<br />
<br />
To demonstrate this relationship we will highlight some concepts of Git. Over time there may be several TimeLines:<br />
:* The Official Branch (Master) has the official version of the apertium managed by official developers or maintainers.<br />
:* Users have the power to create new Branches and develop unofficial dictionaries in parallel, creating communities that may from time to time suggest modifications to Brach Master.<br />
:* These requests can be accepted or rejected by maintainers, and this format is recursive and other developers can create unofficial copies of unofficial ones.<br />
:* Integration requests will use the Merge Request concepts present in tools such as GitLab that will be the BackEnd for advanced users.<br />
<br />
=Application-GSOC2019=<br />
===Abstract:===<br />
The idea is to develop the Web tool so that lay users contribute to dictionaries and use Git management with GitLab to manage these changes.<br />
* The focus will be on monolingual dictionaries and bilingual direct relationships.<br />
* Use the Git methodology and propose a guideline or flow for collaborative dictionary management.<br />
* Do not change the current XML format of dictionaries.<br />
<br />
===Why is it you are interested in machine translation and Apertium?===<br />
<br />
During the graduation course, Professor Aléssio demonstrated the need and opportunity to contribute with open source projects. <br />
He introduced me to Apertium and in my final graduation work I started reading and talking about it. <br />
We started discussing techniques for managing collaboration with the community and currently do not have <br />
as much knowledge about machine translation machines but I have experience in developing applications <br />
and web using collaboration with Git and GitLab.<br />
<br />
===Which of the published tasks are you interested in?===<br />
<br />
[http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code/Easy_dictionary_maintenance Easy dictionary maintenance]<br />
<br />
===Why should Google and Apertium sponsor it?===<br />
<br />
This project will have an impact in all languages. Facilitating dictionary manipulation will benefit everyone,<br />
allowing a wider range of people to contribute to existing dictionaries and start new language projects.<br />
<br />
===How and who will it benefit in society?===<br />
This application will benefit the entire Apertium community.<br />
Dictionary developers will have a tool to speed up their work and an easy-to-use tool will attract new contributors.<br />
As a result, Apertium's translation capacity will be increased, bringing better results to the end user.<br />
<br />
===What do you plan to do?===<br />
We are planning to create a web GUI that will facilitate common tasks of creating/modifying dictionaries and allow lay users to contribute to a dictionary.<br />
The application will be connected to a Git repository, which will be used as an administrative and version control tool.<br />
<br />
<br />
<br />
'''Development Paradigm:''' MVC Paradigm<br /><br />
'''Program Language:''' Java, JavaScript<br /><br />
'''Persistence:''' XML (Apertium XML Files)<br /><br />
'''Framworks:''' Angular<br /><br />
<br />
===Stages/Milestones===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Week<br />
! Stage<br />
! Description<br />
|-<br />
| 1, 2<br />
| --<br />
| --.<br />
|-<br />
| 2, 3<br />
| --<br />
| --.|<br />
|-<br />
| '''Prototype'''<br />
| Milestone 1<br />
| --<br />
|-<br />
| 5, 6<br />
| --<br />
| --.<br />
|-<br />
| 7<br />
| --<br />
| --.<br />
|-<br />
| 8<br />
| --<br />
| --.<br />
|-<br />
| '''Prototype'''<br />
| Milestone 2<br />
| --<br />
|-<br />
| 9<br />
| --<br />
| --.<br />
|-<br />
| 10<br />
| --<br />
| --.<br />
|-<br />
| 11<br />
| Pré-Release<br />
| --<br />
|-<br />
| '''Prototype'''<br />
| --<br />
| <br />
|-<br />
| 12<br />
| Makeup<br />
| --<br />
|-<br />
| <br />
| '''Final Release'''<br />
|<br />
|}<br />
<br />
===Presentation===<br />
<br />
My name is Vinicius, a Brazilian Student at Federal Center for Technological Education of Minas Gerais - Brazil.<br />
<br />
===Resume of Skills===<br />
<br />
Apertium Knowledge:<br />
<br />
* Study to develop a collaborative tool for apertium.<br />
* A study of actual Apertium process about creating a language pair by the user point of view.<br />
* Analysis of the characteristics of the 2010 project of Aléssio and adaptation to current times.<br />
<br />
Academic Skills:<br />
<br />
* Graduating in Computer Engineering- Federal Center for Technological Education of Minas Gerais – Brazil<br />
<br />
Professional Skills:<br />
<br />
* Language developer: C, Java, JavaScript, PHP, Phyton, PL/SQL.<br />
<br />
Projects for Summer:<br />
<br />
* No professional activities planned.<br />
* Planning to work in GSOC<br />
<br />
=Project=<br />
==Why?==<br />
:* The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps potential contributors away. A tool that facilitates the work of dictionaries developers, eliminate the need of computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
==How can use?==<br />
:* --.<br />
:* --.<br />
:* --.<br />
:* --.<br />
<br />
==What its the plan?==<br />
:* We are planning to create a web GUI that allows the user to develop the basic tasks of dictionaries and translation pairs manipulation in an easy and practical way.<br />
:* We will use Git as an administrative and control tool, allowing the user to contribute to the work of other community members or start your own project.<br />
<br />
==Components ans Technologies==<br />
[[File:ComponentDiagramWebDictionary.jpg|thumb|700px|right|Components Diagram]]<br />
* Actors<br />
** Lay User <br />
** Dictionary Admin <br />
<br />
* UserBrowser <br />
** WebInterface with AngularJS - GUI to easily manipulate the dictionary XML file.<br />
<br />
* Web Dicionary Maintence (APP)<br />
** WebAPI - Interface between user's GUI and server.<br />
** Temporary Database - Temporary database in which the XML file will be loaded with the crosses made.<br />
** JavaGit Connector - API to execute necessary Git functions.<br />
** WebDictionary Controller <br />
<br />
* Git <br />
** GitRepository - Repository containing the dictionaries<br />
** GitLab - Repository management tool<br />
** GitHub - Repository management tool<br />
<br />
==How it Works?==<br />
We will develop a WebInterface to lay users add words or suggest modifications.<br />
We are planning to use Git as an administrative and version control tool.<br />
<br />
* All dictionaries releases will be in a single repository and available to any member of the community to continue the work.<br />
* Each user will have your own branch to work on.<br />
* The users will be able to make merge requests with the official branch.<br />
* At first, we will use GitLab (or similar tool) to manage this merges requests. The team who maintain each dictionary will judge if the modifications are valid or not.<br />
<br />
==Example of Interaction - Adding new lemma to a dictionary==<br />
<br />
===1. Choosing an official dictionary and importing it===<br />
The Official Dictionaries page display all available dictionaries in the git repository. Each version correspond to a tag in the master branch.<br />
[[File:Prototype1.png|thumb|250px|none|Choosing an official dictionary and importing it]]<br />
<br />
[[File:Git1.png|thumb|250px|none|Master branch]]<br />
Once imported, the user will name this dictionary and it will appear on the My Dictionaries page.<br />
[[File:Prototype2.png|thumb|250px|none|My Dictionaries page]]<br />
<br />
===2. Loading the dictionary file===<br />
On the Language File page, the user selects one of their dictionaries and the dictionary XML will be formatted to be temporarily saved to a database. Also on this page, the user can edit the dictionary alphabet and see some statistics about it.<br />
<br />
The Symbols, Paradigms, and Lemmas pages refer to the dictionary selected here.<br />
<br />
[[File:Prototype3.png|thumb|250px|none|Loading the dictionary file]]<br />
===3. Verifying if the lemmas already exists===<br />
On the Lemmas - Search page, the user will be able to see all the inflections of the dictionary lemmas and check if the lemma he wants to add already exists.<br />
<br />
[[File:Prototype4.png|thumb|250px|none|Verifying if the lemmas already exists]]<br />
===4. Creating the new lemma===<br />
In the Lemmas - Create page, the user will follow three steps to add a new lemma.<br />
<br />
In the first step, the user will define the lemma and the lemma root. In addition, he will give some examples of inflections and symbols to receive suggestions on which paradigm to use.<br />
<br />
[[File:Prototype5.png|thumb|250px|none|text-top|Creating the new lemma - Step 1]]<br />
In the second step, the user will see paradigm suggestions (or can see all paradigms). When a paradigm is selected, all inflections of the created lemma will be shown to the user. If none of the paradigms fit, the user will be directed to create a new paradigm.<br />
<br />
[[File:Prototype6.png|thumb|250px|none|Creating the new lemma - Step 2]]<br />
In the third and last step, the user will confirm and save the change. At this point, a branch will be create for this dictionary in the git repository (if she doesn’t already exists) and a commit with this changes will be done.<br />
<br />
[[File:Prototype7.png|thumb|250px|none|Creating the new lemma - Step 3]]<br />
===5. Merge Request===<br />
On My Dictionaries page, the user can create a merge request that will be judge by the master branch maintainer.<br />
<br />
[[File:Prototype8.png|thumb|250px|none|Merge Request]]<br />
[[File:Git2.png|thumb|250px|none|New branch created in Git]]<br />
<br />
===6. Official dictionary keeper judges the merge request===<br />
In GitLab (or similar tool), the dictionary maintainer will see the list of merge requests.<br />
[[File:Git5.png|thumb|250px|none|Merge request list]]<br />
At each request, the maintainer can view all commits and accepts only a few of them.<br />
[[File:Git6.png|thumb|250px|none|Commits from current merge request]]<br />
At each commit, he will judge the changes.<br />
[[File:Git7.png|thumb|250px|none|Changes]]<br />
When he accepts the merge request, the user's branch is deleted.<br />
[[File:Git4.png|thumb|250px|none|GitLab Graph]]<br />
<br />
===7. Feedback===<br />
On Merge Requests page, the user can see all request he have made and their status.<br />
<br />
<br />
[[File:Prototype9.png|thumb|250px|none|Feedback]]<br />
<br />
[[Category:GSoC 2019 student proposals|Alessio]]</div>Alessiohttps://wiki.apertium.org/w/index.php?title=Web_Dictionary_Maintenance&diff=69043Web Dictionary Maintenance2019-03-26T19:17:49Z<p>Alessio: /* How it Works? */</p>
<hr />
<div>{{TOCD}}<br />
<br />
[https://translate.google.com/translate?sl=en&tl=pt-br&prev=_t&hl=en&u=http://wiki.apertium.org/wiki/Web_Dictionary_Maintenance Translate to PT-BR with Google Tradução]<br />
<br />
= Introduction =<br />
<br />
Apertium over the years still has deficiencies so that lay people can contribute to increase the base of words in dictionaries, even with simple contributions. Collaboration is the key to developing a tool that serves a huge range of users throughout the world. We believe that it is possible to engage more users and thus give greater impact to the tool within the communities where there is involvement. We will deal in this document with requirements on non-functional and technical objectives regarding the tool proposal.<br />
<br />
;Original Ideias<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code/Easy_dictionary_maintenance<br />
<br />
;Original GSOC2019 Application<br />
: http://wiki.apertium.org/wiki/User:Alessiojr/Easy_dictionary_-_Application-GSOC2019<br />
<br />
;Studant Information<br />
: '''Student:''' Vinícius Silva Nogueira <br /><br />
: '''Unofficial Mentor:''' Alessio Miranda Junior<br /><br />
: '''Telegram/Whatsapp:''' Alessio: +55 (31) 9.8888-7770<br /><br />
: '''E-mail:''' alessio@cefetmg.br or vinicius_snogueira@hotmail.com / viniciussnogueira13@gmail.com<br /><br />
: '''IRC:''' AlessioJr<br /><br />
: '''GTalk:''' alessiojunin@gmail.com<br />
<br />
=Description=<br />
==Abstract:==<br />
The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps away potential contributors. A tool that facilitates the work of dictionaries developers, eliminate computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
Even with several tools that help the way you manage and create dictionaries, Apertium is far from the normal users, who have a huge contribution potential. Or even create a simple way to create contributions to recurring users with advanced knowledge. Although it is a bold plan, and there are several possible and desirable requirements, we will describe some basic premises for this step and that must be respected and aligned with the apertium developer community.<br />
<br />
==Definitions==<br />
:* Lay users do not need to know Apertium's internal structure.<br />
:* Intermediate users need to have a knowledge of dictionary management methodology. <br />
:* Advanced users are those who know the structure of Apertium.<br />
:* Communities are user groups that merge characteristics to the database extension of a dictionary of a specific language.<br />
:* Official dictionaries are dictionaries managed and with seal of the apertium community.<br />
:* Unofficial dictionaries are dictionaries run by an independent community.<br />
:* Test dictionaries are deprived of users to test their contributions.<br />
<br />
==Objectives:==<br />
:* The major goal of the project is to develop a web tool to facilitate the management of the Apertium (XML's) database of integrators for novice and advanced users.<br />
:* New communities of contributions should be able to organize independently of a central command. The command exists but will be distributed.<br />
:* Lay users who feel motivated to contribute, should have an interface that promotes ease in contributing even with limited possibilities.<br />
:* The development of dictionaries should be collaborative and distributed. Each dictionary should have a management community, but a user may have the freedom to disagree and create a new version maintaining a history of the author.<br />
:* Any tool should maintain the traditional Apertium structure and not be interoperable between existing tools.<br />
:* There must be a methodology for communities to maintain the quality of their dictionaries. Although they are distributed the goal is to create a unified and mature dictionary.<br />
<br />
=Technical Objectives:=<br />
:* Develop, initially, monolingual dictionaries but keeping the particular format of each file.<br />
:* Minimize the direct manipulation of XML files, providing features that reduce this need.<br />
:* Making use of GitLab as an administrative and control tool.<br />
<br />
== Git, GitLab and Apertium ==<br />
[[File:Git_flow_demonstration.jpg|thumb|250px|right|Git Flow demonstration]]<br />
As the Apertium files are textual, we had the idea of seeking productivity and using existing and consolidated tools in the world.<br />
The proposal is to build a friendly web interface for lay users, but use git's own Back-End as version control and to make dictionary management GitLab as an administrative tool that already guarantees incredible power for remote collaboration.<br />
<br />
To demonstrate this relationship we will highlight some concepts of Git. Over time there may be several TimeLines:<br />
:* The Official Branch (Master) has the official version of the apertium managed by official developers or maintainers.<br />
:* Users have the power to create new Branches and develop unofficial dictionaries in parallel, creating communities that may from time to time suggest modifications to Brach Master.<br />
:* These requests can be accepted or rejected by maintainers, and this format is recursive and other developers can create unofficial copies of unofficial ones.<br />
:* Integration requests will use the Merge Request concepts present in tools such as GitLab that will be the BackEnd for advanced users.<br />
<br />
=Application-GSOC2019=<br />
===Abstract:===<br />
The idea is to develop the Web tool so that lay users contribute to dictionaries and use Git management with GitLab to manage these changes.<br />
* The focus will be on monolingual dictionaries and bilingual direct relationships.<br />
* Use the Git methodology and propose a guideline or flow for collaborative dictionary management.<br />
* Do not change the current XML format of dictionaries.<br />
<br />
===Why is it you are interested in machine translation and Apertium?===<br />
<br />
During the graduation course, Professor Aléssio demonstrated the need and opportunity to contribute with open source projects. <br />
He introduced me to Apertium and in my final graduation work I started reading and talking about it. <br />
We started discussing techniques for managing collaboration with the community and currently do not have <br />
as much knowledge about machine translation machines but I have experience in developing applications <br />
and web using collaboration with Git and GitLab.<br />
<br />
===Which of the published tasks are you interested in?===<br />
<br />
[http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code/Easy_dictionary_maintenance Easy dictionary maintenance]<br />
<br />
===Why should Google and Apertium sponsor it?===<br />
<br />
This project will have an impact in all languages. Facilitating dictionary manipulation will benefit everyone,<br />
allowing a wider range of people to contribute to existing dictionaries and start new language projects.<br />
<br />
===How and who will it benefit in society?===<br />
This application will benefit the entire Apertium community.<br />
Dictionary developers will have a tool to speed up their work and an easy-to-use tool will attract new contributors.<br />
As a result, Apertium's translation capacity will be increased, bringing better results to the end user.<br />
<br />
===What do you plan to do?===<br />
We are planning to create a web GUI that will facilitate common tasks of creating/modifying dictionaries and allow lay users to contribute to a dictionary.<br />
The application will be connected to a Git repository, which will be used as an administrative and version control tool.<br />
<br />
<br />
<br />
'''Development Paradigm:''' MVC Paradigm<br /><br />
'''Program Language:''' Java, JavaScript<br /><br />
'''Persistence:''' XML (Apertium XML Files)<br /><br />
'''Framworks:''' Angular<br /><br />
<br />
===Stages/Milestones===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Week<br />
! Stage<br />
! Description<br />
|-<br />
| 1, 2<br />
| --<br />
| --.<br />
|-<br />
| 2, 3<br />
| --<br />
| --.|<br />
|-<br />
| '''Prototype'''<br />
| Milestone 1<br />
| --<br />
|-<br />
| 5, 6<br />
| --<br />
| --.<br />
|-<br />
| 7<br />
| --<br />
| --.<br />
|-<br />
| 8<br />
| --<br />
| --.<br />
|-<br />
| '''Prototype'''<br />
| Milestone 2<br />
| --<br />
|-<br />
| 9<br />
| --<br />
| --.<br />
|-<br />
| 10<br />
| --<br />
| --.<br />
|-<br />
| 11<br />
| Pré-Release<br />
| --<br />
|-<br />
| '''Prototype'''<br />
| --<br />
| <br />
|-<br />
| 12<br />
| Makeup<br />
| --<br />
|-<br />
| <br />
| '''Final Release'''<br />
|<br />
|}<br />
<br />
===Presentation===<br />
<br />
My name is Vinicius, a Brazilian Student at Federal Center for Technological Education of Minas Gerais - Brazil.<br />
<br />
===Resume of Skills===<br />
<br />
Apertium Knowledge:<br />
<br />
* Study to develop a collaborative tool for apertium.<br />
* A study of actual Apertium process about creating a language pair by the user point of view.<br />
* Analysis of the characteristics of the 2010 project of Aléssio and adaptation to current times.<br />
<br />
Academic Skills:<br />
<br />
* Graduating in Computer Engineering- Federal Center for Technological Education of Minas Gerais – Brazil<br />
<br />
Professional Skills:<br />
<br />
* Language developer: C, Java, JavaScript, PHP, Phyton, PL/SQL.<br />
<br />
Projects for Summer:<br />
<br />
* No professional activities planned.<br />
* Planning to work in GSOC<br />
<br />
=Project=<br />
==Why?==<br />
:* The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps potential contributors away. A tool that facilitates the work of dictionaries developers, eliminate the need of computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
==How can use?==<br />
:* --.<br />
:* --.<br />
:* --.<br />
:* --.<br />
<br />
==What its the plan?==<br />
:* We are planning to create a web GUI that allows the user to develop the basic tasks of dictionaries and translation pairs manipulation in an easy and practical way.<br />
:* We will use Git as an administrative and control tool, allowing the user to contribute to the work of other community members or start your own project.<br />
<br />
==Components ans Technologies==<br />
[[File:ComponentDiagramWebDictionary.jpg|thumb|700px|right|Components Diagram]]<br />
* Actors<br />
** Lay User <br />
** Dictionary Admin <br />
<br />
* UserBrowser <br />
** WebInterface with AngularJS - GUI to easily manipulate the dictionary XML file.<br />
<br />
* Web Dicionary Maintence (APP)<br />
** WebAPI - Interface between user's GUI and server.<br />
** Temporary Database - Temporary database in which the XML file will be loaded with the crosses made.<br />
** JavaGit Connector - API to execute necessary Git functions.<br />
** WebDictionary Controller <br />
<br />
* Git <br />
** GitRepository - Repository containing the dictionaries<br />
** GitLab - Repository management tool<br />
** GitHub - Repository management tool<br />
<br />
==How it Works?==<br />
We will develop a WebInterface to lay users add words or sugest modifiations.<br />
<br />
*<br />
*<br />
<br />
We are planning to use Git as an administrative and version control tool.<br />
<br />
* All dictionaries releases will be in a single repository and available to any member of the community to continue the work.<br />
* Each user will have your own branch to work on.<br />
* The users will be able to make merge requests with the official branch.<br />
* At first, we will use GitLab (or similar tool) to manage this merges requests. The team who maintain each dictionary will judge if the modifications are valid or not.<br />
<br />
==Example of Interaction - Adding new lemma to a dictionary==<br />
<br />
===1. Choosing an official dictionary and importing it===<br />
The Official Dictionaries page display all available dictionaries in the git repository. Each version correspond to a tag in the master branch.<br />
[[File:Prototype1.png|thumb|250px|none|Choosing an official dictionary and importing it]]<br />
<br />
[[File:Git1.png|thumb|250px|none|Master branch]]<br />
Once imported, the user will name this dictionary and it will appear on the My Dictionaries page.<br />
[[File:Prototype2.png|thumb|250px|none|My Dictionaries page]]<br />
<br />
===2. Loading the dictionary file===<br />
On the Language File page, the user selects one of their dictionaries and the dictionary XML will be formatted to be temporarily saved to a database. Also on this page, the user can edit the dictionary alphabet and see some statistics about it.<br />
<br />
The Symbols, Paradigms, and Lemmas pages refer to the dictionary selected here.<br />
<br />
[[File:Prototype3.png|thumb|250px|none|Loading the dictionary file]]<br />
===3. Verifying if the lemmas already exists===<br />
On the Lemmas - Search page, the user will be able to see all the inflections of the dictionary lemmas and check if the lemma he wants to add already exists.<br />
<br />
[[File:Prototype4.png|thumb|250px|none|Verifying if the lemmas already exists]]<br />
===4. Creating the new lemma===<br />
In the Lemmas - Create page, the user will follow three steps to add a new lemma.<br />
<br />
In the first step, the user will define the lemma and the lemma root. In addition, he will give some examples of inflections and symbols to receive suggestions on which paradigm to use.<br />
<br />
[[File:Prototype5.png|thumb|250px|none|text-top|Creating the new lemma - Step 1]]<br />
In the second step, the user will see paradigm suggestions (or can see all paradigms). When a paradigm is selected, all inflections of the created lemma will be shown to the user. If none of the paradigms fit, the user will be directed to create a new paradigm.<br />
<br />
[[File:Prototype6.png|thumb|250px|none|Creating the new lemma - Step 2]]<br />
In the third and last step, the user will confirm and save the change. At this point, a branch will be create for this dictionary in the git repository (if she doesn’t already exists) and a commit with this changes will be done.<br />
<br />
[[File:Prototype7.png|thumb|250px|none|Creating the new lemma - Step 3]]<br />
===5. Merge Request===<br />
On My Dictionaries page, the user can create a merge request that will be judge by the master branch maintainer.<br />
<br />
[[File:Prototype8.png|thumb|250px|none|Merge Request]]<br />
[[File:Git2.png|thumb|250px|none|New branch created in Git]]<br />
<br />
===6. Official dictionary keeper judges the merge request===<br />
In GitLab (or similar tool), the dictionary maintainer will see the list of merge requests.<br />
[[File:Git5.png|thumb|250px|none|Merge request list]]<br />
At each request, the maintainer can view all commits and accepts only a few of them.<br />
[[File:Git6.png|thumb|250px|none|Commits from current merge request]]<br />
At each commit, he will judge the changes.<br />
[[File:Git7.png|thumb|250px|none|Changes]]<br />
When he accepts the merge request, the user's branch is deleted.<br />
[[File:Git4.png|thumb|250px|none|GitLab Graph]]<br />
<br />
===7. Feedback===<br />
On Merge Requests page, the user can see all request he have made and their status.<br />
<br />
<br />
[[File:Prototype9.png|thumb|250px|none|Feedback]]<br />
<br />
[[Category:GSoC 2019 student proposals|Alessio]]</div>Alessiohttps://wiki.apertium.org/w/index.php?title=Web_Dictionary_Maintenance&diff=69042Web Dictionary Maintenance2019-03-26T19:17:13Z<p>Alessio: /* Components ans Technologies */</p>
<hr />
<div>{{TOCD}}<br />
<br />
[https://translate.google.com/translate?sl=en&tl=pt-br&prev=_t&hl=en&u=http://wiki.apertium.org/wiki/Web_Dictionary_Maintenance Translate to PT-BR with Google Tradução]<br />
<br />
= Introduction =<br />
<br />
Apertium over the years still has deficiencies so that lay people can contribute to increase the base of words in dictionaries, even with simple contributions. Collaboration is the key to developing a tool that serves a huge range of users throughout the world. We believe that it is possible to engage more users and thus give greater impact to the tool within the communities where there is involvement. We will deal in this document with requirements on non-functional and technical objectives regarding the tool proposal.<br />
<br />
;Original Ideias<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code/Easy_dictionary_maintenance<br />
<br />
;Original GSOC2019 Application<br />
: http://wiki.apertium.org/wiki/User:Alessiojr/Easy_dictionary_-_Application-GSOC2019<br />
<br />
;Studant Information<br />
: '''Student:''' Vinícius Silva Nogueira <br /><br />
: '''Unofficial Mentor:''' Alessio Miranda Junior<br /><br />
: '''Telegram/Whatsapp:''' Alessio: +55 (31) 9.8888-7770<br /><br />
: '''E-mail:''' alessio@cefetmg.br or vinicius_snogueira@hotmail.com / viniciussnogueira13@gmail.com<br /><br />
: '''IRC:''' AlessioJr<br /><br />
: '''GTalk:''' alessiojunin@gmail.com<br />
<br />
=Description=<br />
==Abstract:==<br />
The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps away potential contributors. A tool that facilitates the work of dictionaries developers, eliminate computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
Even with several tools that help the way you manage and create dictionaries, Apertium is far from the normal users, who have a huge contribution potential. Or even create a simple way to create contributions to recurring users with advanced knowledge. Although it is a bold plan, and there are several possible and desirable requirements, we will describe some basic premises for this step and that must be respected and aligned with the apertium developer community.<br />
<br />
==Definitions==<br />
:* Lay users do not need to know Apertium's internal structure.<br />
:* Intermediate users need to have a knowledge of dictionary management methodology. <br />
:* Advanced users are those who know the structure of Apertium.<br />
:* Communities are user groups that merge characteristics to the database extension of a dictionary of a specific language.<br />
:* Official dictionaries are dictionaries managed and with seal of the apertium community.<br />
:* Unofficial dictionaries are dictionaries run by an independent community.<br />
:* Test dictionaries are deprived of users to test their contributions.<br />
<br />
==Objectives:==<br />
:* The major goal of the project is to develop a web tool to facilitate the management of the Apertium (XML's) database of integrators for novice and advanced users.<br />
:* New communities of contributions should be able to organize independently of a central command. The command exists but will be distributed.<br />
:* Lay users who feel motivated to contribute, should have an interface that promotes ease in contributing even with limited possibilities.<br />
:* The development of dictionaries should be collaborative and distributed. Each dictionary should have a management community, but a user may have the freedom to disagree and create a new version maintaining a history of the author.<br />
:* Any tool should maintain the traditional Apertium structure and not be interoperable between existing tools.<br />
:* There must be a methodology for communities to maintain the quality of their dictionaries. Although they are distributed the goal is to create a unified and mature dictionary.<br />
<br />
=Technical Objectives:=<br />
:* Develop, initially, monolingual dictionaries but keeping the particular format of each file.<br />
:* Minimize the direct manipulation of XML files, providing features that reduce this need.<br />
:* Making use of GitLab as an administrative and control tool.<br />
<br />
== Git, GitLab and Apertium ==<br />
[[File:Git_flow_demonstration.jpg|thumb|250px|right|Git Flow demonstration]]<br />
As the Apertium files are textual, we had the idea of seeking productivity and using existing and consolidated tools in the world.<br />
The proposal is to build a friendly web interface for lay users, but use git's own Back-End as version control and to make dictionary management GitLab as an administrative tool that already guarantees incredible power for remote collaboration.<br />
<br />
To demonstrate this relationship we will highlight some concepts of Git. Over time there may be several TimeLines:<br />
:* The Official Branch (Master) has the official version of the apertium managed by official developers or maintainers.<br />
:* Users have the power to create new Branches and develop unofficial dictionaries in parallel, creating communities that may from time to time suggest modifications to Brach Master.<br />
:* These requests can be accepted or rejected by maintainers, and this format is recursive and other developers can create unofficial copies of unofficial ones.<br />
:* Integration requests will use the Merge Request concepts present in tools such as GitLab that will be the BackEnd for advanced users.<br />
<br />
=Application-GSOC2019=<br />
===Abstract:===<br />
The idea is to develop the Web tool so that lay users contribute to dictionaries and use Git management with GitLab to manage these changes.<br />
* The focus will be on monolingual dictionaries and bilingual direct relationships.<br />
* Use the Git methodology and propose a guideline or flow for collaborative dictionary management.<br />
* Do not change the current XML format of dictionaries.<br />
<br />
===Why is it you are interested in machine translation and Apertium?===<br />
<br />
During the graduation course, Professor Aléssio demonstrated the need and opportunity to contribute with open source projects. <br />
He introduced me to Apertium and in my final graduation work I started reading and talking about it. <br />
We started discussing techniques for managing collaboration with the community and currently do not have <br />
as much knowledge about machine translation machines but I have experience in developing applications <br />
and web using collaboration with Git and GitLab.<br />
<br />
===Which of the published tasks are you interested in?===<br />
<br />
[http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code/Easy_dictionary_maintenance Easy dictionary maintenance]<br />
<br />
===Why should Google and Apertium sponsor it?===<br />
<br />
This project will have an impact in all languages. Facilitating dictionary manipulation will benefit everyone,<br />
allowing a wider range of people to contribute to existing dictionaries and start new language projects.<br />
<br />
===How and who will it benefit in society?===<br />
This application will benefit the entire Apertium community.<br />
Dictionary developers will have a tool to speed up their work and an easy-to-use tool will attract new contributors.<br />
As a result, Apertium's translation capacity will be increased, bringing better results to the end user.<br />
<br />
===What do you plan to do?===<br />
We are planning to create a web GUI that will facilitate common tasks of creating/modifying dictionaries and allow lay users to contribute to a dictionary.<br />
The application will be connected to a Git repository, which will be used as an administrative and version control tool.<br />
<br />
<br />
<br />
'''Development Paradigm:''' MVC Paradigm<br /><br />
'''Program Language:''' Java, JavaScript<br /><br />
'''Persistence:''' XML (Apertium XML Files)<br /><br />
'''Framworks:''' Angular<br /><br />
<br />
===Stages/Milestones===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Week<br />
! Stage<br />
! Description<br />
|-<br />
| 1, 2<br />
| --<br />
| --.<br />
|-<br />
| 2, 3<br />
| --<br />
| --.|<br />
|-<br />
| '''Prototype'''<br />
| Milestone 1<br />
| --<br />
|-<br />
| 5, 6<br />
| --<br />
| --.<br />
|-<br />
| 7<br />
| --<br />
| --.<br />
|-<br />
| 8<br />
| --<br />
| --.<br />
|-<br />
| '''Prototype'''<br />
| Milestone 2<br />
| --<br />
|-<br />
| 9<br />
| --<br />
| --.<br />
|-<br />
| 10<br />
| --<br />
| --.<br />
|-<br />
| 11<br />
| Pré-Release<br />
| --<br />
|-<br />
| '''Prototype'''<br />
| --<br />
| <br />
|-<br />
| 12<br />
| Makeup<br />
| --<br />
|-<br />
| <br />
| '''Final Release'''<br />
|<br />
|}<br />
<br />
===Presentation===<br />
<br />
My name is Vinicius, a Brazilian Student at Federal Center for Technological Education of Minas Gerais - Brazil.<br />
<br />
===Resume of Skills===<br />
<br />
Apertium Knowledge:<br />
<br />
* Study to develop a collaborative tool for apertium.<br />
* A study of actual Apertium process about creating a language pair by the user point of view.<br />
* Analysis of the characteristics of the 2010 project of Aléssio and adaptation to current times.<br />
<br />
Academic Skills:<br />
<br />
* Graduating in Computer Engineering- Federal Center for Technological Education of Minas Gerais – Brazil<br />
<br />
Professional Skills:<br />
<br />
* Language developer: C, Java, JavaScript, PHP, Phyton, PL/SQL.<br />
<br />
Projects for Summer:<br />
<br />
* No professional activities planned.<br />
* Planning to work in GSOC<br />
<br />
=Project=<br />
==Why?==<br />
:* The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps potential contributors away. A tool that facilitates the work of dictionaries developers, eliminate the need of computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
==How can use?==<br />
:* --.<br />
:* --.<br />
:* --.<br />
:* --.<br />
<br />
==What its the plan?==<br />
:* We are planning to create a web GUI that allows the user to develop the basic tasks of dictionaries and translation pairs manipulation in an easy and practical way.<br />
:* We will use Git as an administrative and control tool, allowing the user to contribute to the work of other community members or start your own project.<br />
<br />
==Components ans Technologies==<br />
[[File:ComponentDiagramWebDictionary.jpg|thumb|700px|right|Components Diagram]]<br />
* Actors<br />
** Lay User <br />
** Dictionary Admin <br />
<br />
* UserBrowser <br />
** WebInterface with AngularJS - GUI to easily manipulate the dictionary XML file.<br />
<br />
* Web Dicionary Maintence (APP)<br />
** WebAPI - Interface between user's GUI and server.<br />
** Temporary Database - Temporary database in which the XML file will be loaded with the crosses made.<br />
** JavaGit Connector - API to execute necessary Git functions.<br />
** WebDictionary Controller <br />
<br />
* Git <br />
** GitRepository - Repository containing the dictionaries<br />
** GitLab - Repository management tool<br />
** GitHub - Repository management tool<br />
<br />
==How it Works?==<br />
We will develop a WebInterface to LayUser add words or sugest modifiations.<br />
<br />
*<br />
*<br />
<br />
We are planning to use Git as an administrative and version control tool.<br />
<br />
* All dictionaries releases will be in a single repository and available to any member of the community to continue the work.<br />
* Each user will have your own branch to work on.<br />
* The users will be able to make merge requests with the official branch.<br />
* At first, we will use GitLab (or similar tool) to manage this merges requests. The team who maintain each dictionary will judge if the modifications are valid or not.<br />
<br />
==Example of Interaction - Adding new lemma to a dictionary==<br />
<br />
===1. Choosing an official dictionary and importing it===<br />
The Official Dictionaries page display all available dictionaries in the git repository. Each version correspond to a tag in the master branch.<br />
[[File:Prototype1.png|thumb|250px|none|Choosing an official dictionary and importing it]]<br />
<br />
[[File:Git1.png|thumb|250px|none|Master branch]]<br />
Once imported, the user will name this dictionary and it will appear on the My Dictionaries page.<br />
[[File:Prototype2.png|thumb|250px|none|My Dictionaries page]]<br />
<br />
===2. Loading the dictionary file===<br />
On the Language File page, the user selects one of their dictionaries and the dictionary XML will be formatted to be temporarily saved to a database. Also on this page, the user can edit the dictionary alphabet and see some statistics about it.<br />
<br />
The Symbols, Paradigms, and Lemmas pages refer to the dictionary selected here.<br />
<br />
[[File:Prototype3.png|thumb|250px|none|Loading the dictionary file]]<br />
===3. Verifying if the lemmas already exists===<br />
On the Lemmas - Search page, the user will be able to see all the inflections of the dictionary lemmas and check if the lemma he wants to add already exists.<br />
<br />
[[File:Prototype4.png|thumb|250px|none|Verifying if the lemmas already exists]]<br />
===4. Creating the new lemma===<br />
In the Lemmas - Create page, the user will follow three steps to add a new lemma.<br />
<br />
In the first step, the user will define the lemma and the lemma root. In addition, he will give some examples of inflections and symbols to receive suggestions on which paradigm to use.<br />
<br />
[[File:Prototype5.png|thumb|250px|none|text-top|Creating the new lemma - Step 1]]<br />
In the second step, the user will see paradigm suggestions (or can see all paradigms). When a paradigm is selected, all inflections of the created lemma will be shown to the user. If none of the paradigms fit, the user will be directed to create a new paradigm.<br />
<br />
[[File:Prototype6.png|thumb|250px|none|Creating the new lemma - Step 2]]<br />
In the third and last step, the user will confirm and save the change. At this point, a branch will be create for this dictionary in the git repository (if she doesn’t already exists) and a commit with this changes will be done.<br />
<br />
[[File:Prototype7.png|thumb|250px|none|Creating the new lemma - Step 3]]<br />
===5. Merge Request===<br />
On My Dictionaries page, the user can create a merge request that will be judge by the master branch maintainer.<br />
<br />
[[File:Prototype8.png|thumb|250px|none|Merge Request]]<br />
[[File:Git2.png|thumb|250px|none|New branch created in Git]]<br />
<br />
===6. Official dictionary keeper judges the merge request===<br />
In GitLab (or similar tool), the dictionary maintainer will see the list of merge requests.<br />
[[File:Git5.png|thumb|250px|none|Merge request list]]<br />
At each request, the maintainer can view all commits and accepts only a few of them.<br />
[[File:Git6.png|thumb|250px|none|Commits from current merge request]]<br />
At each commit, he will judge the changes.<br />
[[File:Git7.png|thumb|250px|none|Changes]]<br />
When he accepts the merge request, the user's branch is deleted.<br />
[[File:Git4.png|thumb|250px|none|GitLab Graph]]<br />
<br />
===7. Feedback===<br />
On Merge Requests page, the user can see all request he have made and their status.<br />
<br />
<br />
[[File:Prototype9.png|thumb|250px|none|Feedback]]<br />
<br />
[[Category:GSoC 2019 student proposals|Alessio]]</div>Alessiohttps://wiki.apertium.org/w/index.php?title=Web_Dictionary_Maintenance&diff=69039Web Dictionary Maintenance2019-03-26T16:35:50Z<p>Alessio: /* Why should Google and Apertium sponsor it? */</p>
<hr />
<div>{{TOCD}}<br />
<br />
[https://translate.google.com/translate?sl=en&tl=pt-br&prev=_t&hl=en&u=http://wiki.apertium.org/wiki/Web_Dictionary_Maintenance Translate to PT-BR with Google Tradução]<br />
<br />
= Introduction =<br />
<br />
Apertium over the years still has deficiencies so that lay people can contribute to increase the base of words in dictionaries, even with simple contributions. Collaboration is the key to developing a tool that serves a huge range of users throughout the world. We believe that it is possible to engage more users and thus give greater impact to the tool within the communities where there is involvement. We will deal in this document with requirements on non-functional and technical objectives regarding the tool proposal.<br />
<br />
;Original Ideias<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code/Easy_dictionary_maintenance<br />
<br />
;Original GSOC2019 Application<br />
: http://wiki.apertium.org/wiki/User:Alessiojr/Easy_dictionary_-_Application-GSOC2019<br />
<br />
;Studant Information<br />
: '''Student:''' Vinícius Silva Nogueira <br /><br />
: '''Unofficial Mentor:''' Alessio Miranda Junior<br /><br />
: '''Telegram/Whatsapp:''' Alessio: +55 (31) 9.8888-7770<br /><br />
: '''E-mail:''' alessio@cefetmg.br or vinicius_snogueira@hotmail.com / viniciussnogueira13@gmail.com<br /><br />
: '''IRC:''' AlessioJr<br /><br />
: '''GTalk:''' alessiojunin@gmail.com<br />
<br />
=Description=<br />
==Abstract:==<br />
The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps away potential contributors. A tool that facilitates the work of dictionaries developers, eliminate computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
Even with several tools that help the way you manage and create dictionaries, Apertium is far from the normal users, who have a huge contribution potential. Or even create a simple way to create contributions to recurring users with advanced knowledge. Although it is a bold plan, and there are several possible and desirable requirements, we will describe some basic premises for this step and that must be respected and aligned with the apertium developer community.<br />
<br />
==Definitions==<br />
:* Lay users do not need to know Apertium's internal structure.<br />
:* Intermediate users need to have a knowledge of dictionary management methodology. <br />
:* Advanced users are those who know the structure of Apertium.<br />
:* Communities are user groups that merge characteristics to the database extension of a dictionary of a specific language.<br />
:* Official dictionaries are dictionaries managed and with seal of the apertium community.<br />
:* Unofficial dictionaries are dictionaries run by an independent community.<br />
:* Test dictionaries are deprived of users to test their contributions.<br />
<br />
==Objectives:==<br />
:* The major goal of the project is to develop a web tool to facilitate the management of the Apertium (XML's) database of integrators for novice and advanced users.<br />
:* New communities of contributions should be able to organize independently of a central command. The command exists but will be distributed.<br />
:* Lay users who feel motivated to contribute, should have an interface that promotes ease in contributing even with limited possibilities.<br />
:* The development of dictionaries should be collaborative and distributed. Each dictionary should have a management community, but a user may have the freedom to disagree and create a new version maintaining a history of the author.<br />
:* Any tool should maintain the traditional Apertium structure and not be interoperable between existing tools.<br />
:* There must be a methodology for communities to maintain the quality of their dictionaries. Although they are distributed the goal is to create a unified and mature dictionary.<br />
<br />
=Technical Objectives:=<br />
:* Develop, initially, monolingual dictionaries but keeping the particular format of each file.<br />
:* Minimize the direct manipulation of XML files, providing features that reduce this need.<br />
:* Making use of GitLab as an administrative and control tool.<br />
<br />
== Git, GitLab and Apertium ==<br />
[[File:Git_flow_demonstration.jpg|thumb|250px|right|Git Flow demonstration]]<br />
As the Apertium files are textual, we had the idea of seeking productivity and using existing and consolidated tools in the world.<br />
The proposal is to build a friendly web interface for lay users, but use git's own Back-End as version control and to make dictionary management GitLab as an administrative tool that already guarantees incredible power for remote collaboration.<br />
<br />
To demonstrate this relationship we will highlight some concepts of Git. Over time there may be several TimeLines:<br />
:* The Official Branch (Master) has the official version of the apertium managed by official developers or maintainers.<br />
:* Users have the power to create new Branches and develop unofficial dictionaries in parallel, creating communities that may from time to time suggest modifications to Brach Master.<br />
:* These requests can be accepted or rejected by maintainers, and this format is recursive and other developers can create unofficial copies of unofficial ones.<br />
:* Integration requests will use the Merge Request concepts present in tools such as GitLab that will be the BackEnd for advanced users.<br />
<br />
=Application-GSOC2019=<br />
===Abstract:===<br />
The idea is to develop the Web tool so that lay users contribute to dictionaries and use Git management with GitLab to manage these changes.<br />
* The focus will be on monolingual dictionaries and bilingual direct relationships.<br />
* Use the Git methodology and propose a guideline or flow for collaborative dictionary management.<br />
* Do not change the current XML format of dictionaries.<br />
<br />
===Why is it you are interested in machine translation and Apertium?===<br />
<br />
During the graduation course, Professor Aléssio demonstrated the need and opportunity to contribute with open source projects. <br />
He introduced me to Apertium and in my final graduation work I started reading and talking about it. <br />
We started discussing techniques for managing collaboration with the community and currently do not have <br />
as much knowledge about machine translation machines but I have experience in developing applications <br />
and web using collaboration with Git and GitLab.<br />
<br />
===Which of the published tasks are you interested in?===<br />
<br />
[http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code/Easy_dictionary_maintenance Easy dictionary maintenance]<br />
<br />
===Why should Google and Apertium sponsor it?===<br />
<br />
This project will have an impact in all languages. Facilitating dictionary manipulation will benefit everyone,<br />
allowing a wider range of people to contribute to existing dictionaries and start new language projects.<br />
<br />
===How and who will it benefit in society?===<br />
This application will benefit the entire Apertium community.<br />
Dictionary developers will have a tool to speed up their work and an easy-to-use tool will attract new contributors.<br />
As a result, Apertium's translation capacity will be increased, bringing better results to the end user.<br />
<br />
===What do you plan to do?===<br />
We are planning to create a web GUI that will facilitate common tasks of creating/modifying dictionaries and allow lay users to contribute to a dictionary.<br />
The application will be connected to a Git repository, which will be used as an administrative and version control tool.<br />
<br />
<br />
<br />
'''Development Paradigm:''' MVC Paradigm<br /><br />
'''Program Language:''' Java, JavaScript<br /><br />
'''Persistence:''' XML (Apertium XML Files)<br /><br />
'''Framworks:''' Angular<br /><br />
<br />
===Stages/Milestones===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Week<br />
! Stage<br />
! Description<br />
|-<br />
| 1, 2<br />
| --<br />
| --.<br />
|-<br />
| 2, 3<br />
| --<br />
| --.|<br />
|-<br />
| '''Prototype'''<br />
| Milestone 1<br />
| --<br />
|-<br />
| 5, 6<br />
| --<br />
| --.<br />
|-<br />
| 7<br />
| --<br />
| --.<br />
|-<br />
| 8<br />
| --<br />
| --.<br />
|-<br />
| '''Prototype'''<br />
| Milestone 2<br />
| --<br />
|-<br />
| 9<br />
| --<br />
| --.<br />
|-<br />
| 10<br />
| --<br />
| --.<br />
|-<br />
| 11<br />
| Pré-Release<br />
| --<br />
|-<br />
| '''Prototype'''<br />
| --<br />
| <br />
|-<br />
| 12<br />
| Makeup<br />
| --<br />
|-<br />
| <br />
| '''Final Release'''<br />
|<br />
|}<br />
<br />
===Presentation===<br />
<br />
My name is Vinicius, a Brazilian Student at Federal Center for Technological Education of Minas Gerais - Brazil.<br />
<br />
===Resume of Skills===<br />
<br />
Apertium Knowledge:<br />
<br />
* Study to develop a collaborative tool for apertium.<br />
* A study of actual Apertium process about creating a language pair by the user point of view.<br />
* Analysis of the characteristics of the 2010 project of Aléssio and adaptation to current times.<br />
<br />
Academic Skills:<br />
<br />
* Graduating in Computer Engineering- Federal Center for Technological Education of Minas Gerais – Brazil<br />
<br />
Professional Skills:<br />
<br />
* Language developer: C, Java, JavaScript, PHP, Phyton, PL/SQL.<br />
<br />
Projects for Summer:<br />
<br />
* No professional activities planned.<br />
* Planning to work in GSOC<br />
<br />
=Project=<br />
==Why?==<br />
:* The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps potential contributors away. A tool that facilitates the work of dictionaries developers, eliminate the need of computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
==How can use?==<br />
:* --.<br />
:* --.<br />
:* --.<br />
:* --.<br />
<br />
==What its the plan?==<br />
:* We are planning to create a web GUI that allows the user to develop the basic tasks of dictionaries and translation pairs manipulation in an easy and practical way.<br />
:* We will use Git as an administrative and control tool, allowing the user to contribute to the work of other community members or start your own project.<br />
<br />
==Components ans Technologies==<br />
[[File:ComponentDiagramWebDictionary.jpg|thumb|700px|right|Components Diagram]]<br />
* Actors<br />
** Lay User <br />
** Dictionary Admin <br />
<br />
* UserBrowser <br />
** WebInterface with AngularJS - GUI to easily manipulate the dictionary XML file.<br />
<br />
* Web Dicionary Maintence (APP)<br />
** WebAPI - <br />
** Temporary Database - Temporary database in which the XML file will be loaded with the crosses made.<br />
** JavaGit Connector - <br />
** WebDictionary Controller - <br />
<br />
* Git - <br />
** GitRepository - <br />
** GitLab - <br />
** GitHub -<br />
<br />
==How it Works?==<br />
We will develop a WebInterface to LayUser add words or sugest modifiations.<br />
<br />
*<br />
*<br />
<br />
We are planning to use Git as an administrative and version control tool.<br />
<br />
* All dictionaries releases will be in a single repository and available to any member of the community to continue the work.<br />
* Each user will have your own branch to work on.<br />
* The users will be able to make merge requests with the official branch.<br />
* At first, we will use GitLab (or similar tool) to manage this merges requests. The team who maintain each dictionary will judge if the modifications are valid or not.<br />
<br />
==Example of Interaction - Adding new lemma to a dictionary==<br />
<br />
===1. Choosing an official dictionary and importing it===<br />
The Official Dictionaries page display all available dictionaries in the git repository. Each version correspond to a tag in the master branch.<br />
[[File:Prototype1.png|thumb|250px|none|Choosing an official dictionary and importing it]]<br />
<br />
[[File:Git1.png|thumb|250px|none|Master branch]]<br />
Once imported, the user will name this dictionary and it will appear on the My Dictionaries page.<br />
[[File:Prototype2.png|thumb|250px|none|My Dictionaries page]]<br />
<br />
===2. Loading the dictionary file===<br />
On the Language File page, the user selects one of their dictionaries and the dictionary XML will be formatted to be temporarily saved to a database. Also on this page, the user can edit the dictionary alphabet and see some statistics about it.<br />
<br />
The Symbols, Paradigms, and Lemmas pages refer to the dictionary selected here.<br />
<br />
[[File:Prototype3.png|thumb|250px|none|Loading the dictionary file]]<br />
===3. Verifying if the lemmas already exists===<br />
On the Lemmas - Search page, the user will be able to see all the inflections of the dictionary lemmas and check if the lemma he wants to add already exists.<br />
<br />
[[File:Prototype4.png|thumb|250px|none|Verifying if the lemmas already exists]]<br />
===4. Creating the new lemma===<br />
In the Lemmas - Create page, the user will follow three steps to add a new lemma.<br />
<br />
In the first step, the user will define the lemma and the lemma root. In addition, he will give some examples of inflections and symbols to receive suggestions on which paradigm to use.<br />
<br />
[[File:Prototype5.png|thumb|250px|none|text-top|Creating the new lemma - Step 1]]<br />
In the second step, the user will see paradigm suggestions (or can see all paradigms). When a paradigm is selected, all inflections of the created lemma will be shown to the user. If none of the paradigms fit, the user will be directed to create a new paradigm.<br />
<br />
[[File:Prototype6.png|thumb|250px|none|Creating the new lemma - Step 2]]<br />
In the third and last step, the user will confirm and save the change. At this point, a branch will be create for this dictionary in the git repository (if she doesn’t already exists) and a commit with this changes will be done.<br />
<br />
[[File:Prototype7.png|thumb|250px|none|Creating the new lemma - Step 3]]<br />
===5. Merge Request===<br />
On My Dictionaries page, the user can create a merge request that will be judge by the master branch maintainer.<br />
<br />
[[File:Prototype8.png|thumb|250px|none|Merge Request]]<br />
[[File:Git2.png|thumb|250px|none|New branch created in Git]]<br />
<br />
===6. Official dictionary keeper judges the merge request===<br />
In GitLab (or similar tool), the dictionary maintainer will see the list of merge requests.<br />
[[File:Git5.png|thumb|250px|none|Merge request list]]<br />
At each request, the maintainer can view all commits and accepts only a few of them.<br />
[[File:Git6.png|thumb|250px|none|Commits from current merge request]]<br />
At each commit, he will judge the changes.<br />
[[File:Git7.png|thumb|250px|none|Changes]]<br />
When he accepts the merge request, the user's branch is deleted.<br />
[[File:Git4.png|thumb|250px|none|GitLab Graph]]<br />
<br />
===7. Feedback===<br />
On Merge Requests page, the user can see all request he have made and their status.<br />
<br />
<br />
[[File:Prototype9.png|thumb|250px|none|Feedback]]<br />
<br />
[[Category:GSoC 2019 student proposals|Alessio]]</div>Alessiohttps://wiki.apertium.org/w/index.php?title=Web_Dictionary_Maintenance&diff=69029Web Dictionary Maintenance2019-03-26T15:08:09Z<p>Alessio: /* Application-GSOC2019 */</p>
<hr />
<div>{{TOCD}}<br />
<br />
[https://translate.google.com/translate?sl=en&tl=pt-br&prev=_t&hl=en&u=http://wiki.apertium.org/wiki/Web_Dictionary_Maintenance Translate to PT-BR with Google Tradução]<br />
<br />
= Introduction =<br />
<br />
Apertium over the years still has deficiencies so that lay people can contribute to increase the base of words in dictionaries, even with simple contributions. Collaboration is the key to developing a tool that serves a huge range of users throughout the world. We believe that it is possible to engage more users and thus give greater impact to the tool within the communities where there is involvement. We will deal in this document with requirements on non-functional and technical objectives regarding the tool proposal.<br />
<br />
;Original Ideias<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code/Easy_dictionary_maintenance<br />
<br />
;Original GSOC2019 Application<br />
: http://wiki.apertium.org/wiki/User:Alessiojr/Easy_dictionary_-_Application-GSOC2019<br />
<br />
;Studant Information<br />
: '''Student:''' Vinícius Silva Nogueira <br /><br />
: '''Unofficial Mentor:''' Alessio Miranda Junior<br /><br />
: '''Telegram/Whatsapp:''' Alessio: +55 (31) 9.8888-7770<br /><br />
: '''E-mail:''' alessio@cefetmg.br or vinicius_snogueira@hotmail.com / viniciussnogueira13@gmail.com<br /><br />
: '''IRC:''' AlessioJr<br /><br />
: '''GTalk:''' alessiojunin@gmail.com<br />
<br />
=Description=<br />
==Abstract:==<br />
The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps away potential contributors. A tool that facilitates the work of dictionaries developers, eliminate computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
Even with several tools that help the way you manage and create dictionaries, Apertium is far from the normal users, who have a huge contribution potential. Or even create a simple way to create contributions to recurring users with advanced knowledge. Although it is a bold plan, and there are several possible and desirable requirements, we will describe some basic premises for this step and that must be respected and aligned with the apertium developer community.<br />
<br />
==Definitions==<br />
:* Lay users do not need to know Apertium's internal structure.<br />
:* Intermediate users need to have a knowledge of dictionary management methodology. <br />
:* Advanced users are those who know the structure of Apertium.<br />
:* Communities are user groups that merge characteristics to the database extension of a dictionary of a specific language.<br />
:* Official dictionaries are dictionaries managed and with seal of the apertium community.<br />
:* Unofficial dictionaries are dictionaries run by an independent community.<br />
:* Test dictionaries are deprived of users to test their contributions.<br />
<br />
==Objectives:==<br />
:* The major goal of the project is to develop a web tool to facilitate the management of the Apertium (XML's) database of integrators for novice and advanced users.<br />
:* New communities of contributions should be able to organize independently of a central command. The command exists but will be distributed.<br />
:* Lay users who feel motivated to contribute, should have an interface that promotes ease in contributing even with limited possibilities.<br />
:* The development of dictionaries should be collaborative and distributed. Each dictionary should have a management community, but a user may have the freedom to disagree and create a new version maintaining a history of the author.<br />
:* Any tool should maintain the traditional Apertium structure and not be interoperable between existing tools.<br />
:* There must be a methodology for communities to maintain the quality of their dictionaries. Although they are distributed the goal is to create a unified and mature dictionary.<br />
<br />
=Technical Objectives:=<br />
:* Develop, initially, monolingual dictionaries but keeping the particular format of each file.<br />
:* Minimize the direct manipulation of XML files, providing features that reduce this need.<br />
:* Making use of GitLab as an administrative and control tool.<br />
<br />
== Git, GitLab and Apertium ==<br />
[[File:Git_flow_demonstration.jpg|thumb|250px|right|Git Flow demonstration]]<br />
As the Apertium files are textual, we had the idea of seeking productivity and using existing and consolidated tools in the world.<br />
The proposal is to build a friendly web interface for lay users, but use git's own Back-End as version control and to make dictionary management GitLab as an administrative tool that already guarantees incredible power for remote collaboration.<br />
<br />
To demonstrate this relationship we will highlight some concepts of Git. Over time there may be several TimeLines:<br />
:* The Official Branch (Master) has the official version of the apertium managed by official developers or maintainers.<br />
:* Users have the power to create new Branches and develop unofficial dictionaries in parallel, creating communities that may from time to time suggest modifications to Brach Master.<br />
:* These requests can be accepted or rejected by maintainers, and this format is recursive and other developers can create unofficial copies of unofficial ones.<br />
:* Integration requests will use the Merge Request concepts present in tools such as GitLab that will be the BackEnd for advanced users.<br />
<br />
=Application-GSOC2019=<br />
===Abstract:===<br />
The idea is to develop the Web tool so that lay users contribute to dictionaries and use Git management with GitLab to manage these changes.<br />
* The focus will be on monolingual dictionaries and bilingual direct relationships.<br />
* Use the Git methodology and propose a guideline or flow for collaborative dictionary management.<br />
* Do not change the current XML format of dictionaries.<br />
<br />
===Why is it you are interested in machine translation and Apertium?===<br />
<br />
During the graduation course, Professor Aléssio demonstrated the need and opportunity to contribute with open source projects. <br />
He introduced me to Apertium and in my final graduation work I started reading and talking about it. <br />
We started discussing techniques for managing collaboration with the community and currently do not have <br />
as much knowledge about machine translation machines but I have experience in developing applications <br />
and web using collaboration with Git and GitLab.<br />
<br />
===Which of the published tasks are you interested in?===<br />
<br />
[http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code/Easy_dictionary_maintenance Easy dictionary maintenance]<br />
<br />
===Why should Google and Apertium sponsor it?===<br />
<br />
I .<br />
<br />
===How and who will it benefit in society?===<br />
This application will benefit the entire Apertium community.<br />
Dictionary developers will have a tool to speed up their work and an easy-to-use tool will attract new contributors.<br />
As a result, Apertium's translation capacity will be increased, bringing better results to the end user.<br />
<br />
===What do you plan to do?===<br />
We are planning to create a web GUI that will facilitate common tasks of creating/modifying dictionaries and allow lay users to contribute to a dictionary.<br />
The application will be connected to a Git repository, which will be used as an administrative and version control tool.<br />
<br />
<br />
<br />
'''Development Paradigm:''' MVC Paradigm<br /><br />
'''Program Language:''' Java, JavaScript<br /><br />
'''Persistence:''' XML (Apertium XML Files)<br /><br />
'''Framworks:''' Angular<br /><br />
<br />
===Stages/Milestones===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Week<br />
! Stage<br />
! Description<br />
|-<br />
| 1, 2<br />
| --<br />
| --.<br />
|-<br />
| 2, 3<br />
| --<br />
| --.|<br />
|-<br />
| '''Prototype'''<br />
| Milestone 1<br />
| --<br />
|-<br />
| 5, 6<br />
| --<br />
| --.<br />
|-<br />
| 7<br />
| --<br />
| --.<br />
|-<br />
| 8<br />
| --<br />
| --.<br />
|-<br />
| '''Prototype'''<br />
| Milestone 2<br />
| --<br />
|-<br />
| 9<br />
| --<br />
| --.<br />
|-<br />
| 10<br />
| --<br />
| --.<br />
|-<br />
| 11<br />
| Pré-Release<br />
| --<br />
|-<br />
| '''Prototype'''<br />
| --<br />
| <br />
|-<br />
| 12<br />
| Makeup<br />
| --<br />
|-<br />
| <br />
| '''Final Release'''<br />
|<br />
|}<br />
<br />
===Presentation===<br />
<br />
My name is Vinicius, a Brazilian Student at Federal Center for Technological Education of Minas Gerais - Brazil.<br />
<br />
===Resume of Skills===<br />
<br />
Apertium Knowledge:<br />
<br />
* Study to develop a collaborative tool for apertium.<br />
* A study of actual Apertium process about creating a language pair by the user point of view.<br />
* Analysis of the characteristics of the 2010 project of Aléssio and adaptation to current times.<br />
<br />
Academic Skills:<br />
<br />
* Graduating in Computer Engineering- Federal Center for Technological Education of Minas Gerais – Brazil<br />
<br />
Professional Skills:<br />
<br />
* Language developer: C, Java, JavaScript, PHP, Phyton, PL/SQL.<br />
<br />
Projects for Summer:<br />
<br />
* No professional activities planned.<br />
* Planning to work in GSOC<br />
<br />
=Project=<br />
==Why?==<br />
:* The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps potential contributors away. A tool that facilitates the work of dictionaries developers, eliminate the need of computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
==How can use?==<br />
:* --.<br />
:* --.<br />
:* --.<br />
:* --.<br />
<br />
==What its the plan?==<br />
:* We are planning to create a web GUI that allows the user to develop the basic tasks of dictionaries and translation pairs manipulation in an easy and practical way.<br />
:* We will use Git as an administrative and control tool, allowing the user to contribute to the work of other community members or start your own project.<br />
<br />
==Components ans Technologies==<br />
[[File:ComponentDiagramWebDictionary.jpg|thumb|700px|right|Components Diagram]]<br />
* Actors<br />
** Lay User <br />
** Dictionary Admin <br />
<br />
* UserBrowser <br />
** WebInterface with AngularJS - GUI to easily manipulate the dictionary XML file.<br />
<br />
* Web Dicionary Maintence (APP)<br />
** WebAPI - <br />
** Temporary Database - Temporary database in which the XML file will be loaded with the crosses made.<br />
** JavaGit Connector - <br />
** WebDictionary Controller - <br />
<br />
* Git - <br />
** GitRepository - <br />
** GitLab - <br />
** GitHub -<br />
<br />
==How it Works?==<br />
We will develop a WebInterface to LayUser add words or sugest modifiations.<br />
<br />
*<br />
*<br />
<br />
We are planning to use Git as an administrative and version control tool.<br />
<br />
* All dictionaries releases will be in a single repository and available to any member of the community to continue the work.<br />
* Each user will have your own branch to work on.<br />
* The users will be able to make merge requests with the official branch.<br />
* At first, we will use GitLab (or similar tool) to manage this merges requests. The team who maintain each dictionary will judge if the modifications are valid or not.<br />
<br />
==Example of Interaction - Adding new lemma to a dictionary==<br />
<br />
===1. Choosing an official dictionary and importing it===<br />
The Official Dictionaries page display all available dictionaries in the git repository. Each version correspond to a tag in the master branch.<br />
[[File:Prototype1.png|thumb|250px|none|Choosing an official dictionary and importing it]]<br />
<br />
[[File:Git1.png|thumb|250px|none|Master branch]]<br />
Once imported, the user will name this dictionary and it will appear on the My Dictionaries page.<br />
[[File:Prototype2.png|thumb|250px|none|My Dictionaries page]]<br />
<br />
===2. Loading the dictionary file===<br />
On the Language File page, the user selects one of their dictionaries and the dictionary XML will be formatted to be temporarily saved to a database. Also on this page, the user can edit the dictionary alphabet and see some statistics about it.<br />
<br />
The Symbols, Paradigms, and Lemmas pages refer to the dictionary selected here.<br />
<br />
[[File:Prototype3.png|thumb|250px|none|Loading the dictionary file]]<br />
===3. Verifying if the lemmas already exists===<br />
On the Lemmas - Search page, the user will be able to see all the inflections of the dictionary lemmas and check if the lemma he wants to add already exists.<br />
<br />
[[File:Prototype4.png|thumb|250px|none|Verifying if the lemmas already exists]]<br />
===4. Creating the new lemma===<br />
In the Lemmas - Create page, the user will follow three steps to add a new lemma.<br />
<br />
In the first step, the user will define the lemma and the lemma root. In addition, he will give some examples of inflections and symbols to receive suggestions on which paradigm to use.<br />
<br />
[[File:Prototype5.png|thumb|250px|none|text-top|Creating the new lemma - Step 1]]<br />
In the second step, the user will see paradigm suggestions (or can see all paradigms). When a paradigm is selected, all inflections of the created lemma will be shown to the user. If none of the paradigms fit, the user will be directed to create a new paradigm.<br />
<br />
[[File:Prototype6.png|thumb|250px|none|Creating the new lemma - Step 2]]<br />
In the third and last step, the user will confirm and save the change. At this point, a branch will be create for this dictionary in the git repository (if she doesn’t already exists) and a commit with this changes will be done.<br />
<br />
[[File:Prototype7.png|thumb|250px|none|Creating the new lemma - Step 3]]<br />
===5. Merge Request===<br />
On My Dictionaries page, the user can create a merge request that will be judge by the master branch maintainer.<br />
<br />
[[File:Prototype8.png|thumb|250px|none|Merge Request]]<br />
[[File:Git2.png|thumb|250px|none|New branch created in Git]]<br />
<br />
===6. Official dictionary keeper judges the merge request===<br />
In GitLab (or similar tool), the dictionary maintainer will see the list of merge requests.<br />
[[File:Git5.png|thumb|250px|none|Merge request list]]<br />
At each request, the maintainer can view all commits and accepts only a few of them.<br />
[[File:Git6.png|thumb|250px|none|Commits from current merge request]]<br />
At each commit, he will judge the changes.<br />
[[File:Git7.png|thumb|250px|none|Changes]]<br />
When he accepts the merge request, the user's branch is deleted.<br />
[[File:Git4.png|thumb|250px|none|GitLab Graph]]<br />
<br />
===7. Feedback===<br />
On Merge Requests page, the user can see all request he have made and their status.<br />
<br />
<br />
[[File:Prototype9.png|thumb|250px|none|Feedback]]<br />
<br />
[[Category:GSoC 2019 student proposals|Alessio]]</div>Alessiohttps://wiki.apertium.org/w/index.php?title=Web_Dictionary_Maintenance&diff=69028Web Dictionary Maintenance2019-03-26T15:06:06Z<p>Alessio: /* Why is it you are interested in machine translation? */</p>
<hr />
<div>{{TOCD}}<br />
<br />
[https://translate.google.com/translate?sl=en&tl=pt-br&prev=_t&hl=en&u=http://wiki.apertium.org/wiki/Web_Dictionary_Maintenance Translate to PT-BR with Google Tradução]<br />
<br />
= Introduction =<br />
<br />
Apertium over the years still has deficiencies so that lay people can contribute to increase the base of words in dictionaries, even with simple contributions. Collaboration is the key to developing a tool that serves a huge range of users throughout the world. We believe that it is possible to engage more users and thus give greater impact to the tool within the communities where there is involvement. We will deal in this document with requirements on non-functional and technical objectives regarding the tool proposal.<br />
<br />
;Original Ideias<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code/Easy_dictionary_maintenance<br />
<br />
;Original GSOC2019 Application<br />
: http://wiki.apertium.org/wiki/User:Alessiojr/Easy_dictionary_-_Application-GSOC2019<br />
<br />
;Studant Information<br />
: '''Student:''' Vinícius Silva Nogueira <br /><br />
: '''Unofficial Mentor:''' Alessio Miranda Junior<br /><br />
: '''Telegram/Whatsapp:''' Alessio: +55 (31) 9.8888-7770<br /><br />
: '''E-mail:''' alessio@cefetmg.br or vinicius_snogueira@hotmail.com / viniciussnogueira13@gmail.com<br /><br />
: '''IRC:''' AlessioJr<br /><br />
: '''GTalk:''' alessiojunin@gmail.com<br />
<br />
=Description=<br />
==Abstract:==<br />
The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps away potential contributors. A tool that facilitates the work of dictionaries developers, eliminate computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
Even with several tools that help the way you manage and create dictionaries, Apertium is far from the normal users, who have a huge contribution potential. Or even create a simple way to create contributions to recurring users with advanced knowledge. Although it is a bold plan, and there are several possible and desirable requirements, we will describe some basic premises for this step and that must be respected and aligned with the apertium developer community.<br />
<br />
==Definitions==<br />
:* Lay users do not need to know Apertium's internal structure.<br />
:* Intermediate users need to have a knowledge of dictionary management methodology. <br />
:* Advanced users are those who know the structure of Apertium.<br />
:* Communities are user groups that merge characteristics to the database extension of a dictionary of a specific language.<br />
:* Official dictionaries are dictionaries managed and with seal of the apertium community.<br />
:* Unofficial dictionaries are dictionaries run by an independent community.<br />
:* Test dictionaries are deprived of users to test their contributions.<br />
<br />
==Objectives:==<br />
:* The major goal of the project is to develop a web tool to facilitate the management of the Apertium (XML's) database of integrators for novice and advanced users.<br />
:* New communities of contributions should be able to organize independently of a central command. The command exists but will be distributed.<br />
:* Lay users who feel motivated to contribute, should have an interface that promotes ease in contributing even with limited possibilities.<br />
:* The development of dictionaries should be collaborative and distributed. Each dictionary should have a management community, but a user may have the freedom to disagree and create a new version maintaining a history of the author.<br />
:* Any tool should maintain the traditional Apertium structure and not be interoperable between existing tools.<br />
:* There must be a methodology for communities to maintain the quality of their dictionaries. Although they are distributed the goal is to create a unified and mature dictionary.<br />
<br />
=Technical Objectives:=<br />
:* Develop, initially, monolingual dictionaries but keeping the particular format of each file.<br />
:* Minimize the direct manipulation of XML files, providing features that reduce this need.<br />
:* Making use of GitLab as an administrative and control tool.<br />
<br />
== Git, GitLab and Apertium ==<br />
[[File:Git_flow_demonstration.jpg|thumb|250px|right|Git Flow demonstration]]<br />
As the Apertium files are textual, we had the idea of seeking productivity and using existing and consolidated tools in the world.<br />
The proposal is to build a friendly web interface for lay users, but use git's own Back-End as version control and to make dictionary management GitLab as an administrative tool that already guarantees incredible power for remote collaboration.<br />
<br />
To demonstrate this relationship we will highlight some concepts of Git. Over time there may be several TimeLines:<br />
:* The Official Branch (Master) has the official version of the apertium managed by official developers or maintainers.<br />
:* Users have the power to create new Branches and develop unofficial dictionaries in parallel, creating communities that may from time to time suggest modifications to Brach Master.<br />
:* These requests can be accepted or rejected by maintainers, and this format is recursive and other developers can create unofficial copies of unofficial ones.<br />
:* Integration requests will use the Merge Request concepts present in tools such as GitLab that will be the BackEnd for advanced users.<br />
<br />
=Application-GSOC2019=<br />
===Abstract:===<br />
The idea is to develop the Web tool so that lay users contribute to dictionaries and use Git management with GitLab to manage these changes.<br />
* The focus will be on monolingual dictionaries and bilingual direct relationships.<br />
* Use the Git methodology and propose a guideline or flow for collaborative dictionary management.<br />
* Do not change the current XML format of dictionaries.<br />
<br />
===Why is it you are interested in machine translation and Apertium?===<br />
<br />
During the graduation course, Professor Aléssio demonstrated the need and opportunity to contribute with open source projects. <br />
He introduced me to Apertium and in my final graduation work I started reading and talking about it. <br />
We started discussing techniques for managing collaboration with the community and currently do not have <br />
as much knowledge about machine translation machines but I have experience in developing applications <br />
and web using collaboration with Git and GitLab.<br />
<br />
===Why are they interested in the Apertium project?===<br />
<br />
I’ve .<br />
<br />
===Which of the published tasks are you interested in?===<br />
<br />
[http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code/Easy_dictionary_maintenance Easy dictionary maintenance]<br />
<br />
===Why should Google and Apertium sponsor it?===<br />
<br />
I .<br />
<br />
===How and who will it benefit in society?===<br />
This application will benefit the entire Apertium community.<br />
Dictionary developers will have a tool to speed up their work and an easy-to-use tool will attract new contributors.<br />
As a result, Apertium's translation capacity will be increased, bringing better results to the end user.<br />
<br />
===What do you plan to do?===<br />
We are planning to create a web GUI that will facilitate common tasks of creating/modifying dictionaries and allow lay users to contribute to a dictionary.<br />
The application will be connected to a Git repository, which will be used as an administrative and version control tool.<br />
<br />
<br />
<br />
'''Development Paradigm:''' MVC Paradigm<br /><br />
'''Program Language:''' Java, JavaScript<br /><br />
'''Persistence:''' XML (Apertium XML Files)<br /><br />
'''Framworks:''' Angular<br /><br />
<br />
===Stages/Milestones===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Week<br />
! Stage<br />
! Description<br />
|-<br />
| 1, 2<br />
| --<br />
| --.<br />
|-<br />
| 2, 3<br />
| --<br />
| --.|<br />
|-<br />
| '''Prototype'''<br />
| Milestone 1<br />
| --<br />
|-<br />
| 5, 6<br />
| --<br />
| --.<br />
|-<br />
| 7<br />
| --<br />
| --.<br />
|-<br />
| 8<br />
| --<br />
| --.<br />
|-<br />
| '''Prototype'''<br />
| Milestone 2<br />
| --<br />
|-<br />
| 9<br />
| --<br />
| --.<br />
|-<br />
| 10<br />
| --<br />
| --.<br />
|-<br />
| 11<br />
| Pré-Release<br />
| --<br />
|-<br />
| '''Prototype'''<br />
| --<br />
| <br />
|-<br />
| 12<br />
| Makeup<br />
| --<br />
|-<br />
| <br />
| '''Final Release'''<br />
|<br />
|}<br />
<br />
===Presentation===<br />
<br />
My name is Vinicius, a Brazilian Student at Federal Center for Technological Education of Minas Gerais - Brazil.<br />
<br />
===Resume of Skills===<br />
<br />
Apertium Knowledge:<br />
<br />
* Study to develop a collaborative tool for apertium.<br />
* A study of actual Apertium process about creating a language pair by the user point of view.<br />
* Analysis of the characteristics of the 2010 project of Aléssio and adaptation to current times.<br />
<br />
Academic Skills:<br />
<br />
* Graduating in Computer Engineering- Federal Center for Technological Education of Minas Gerais – Brazil<br />
<br />
Professional Skills:<br />
<br />
* Language developer: C, Java, JavaScript, PHP, Phyton, PL/SQL.<br />
<br />
Projects for Summer:<br />
<br />
* No professional activities planned.<br />
* Planning to work in GSOC<br />
<br />
=Project=<br />
==Why?==<br />
:* The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps potential contributors away. A tool that facilitates the work of dictionaries developers, eliminate the need of computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
==How can use?==<br />
:* --.<br />
:* --.<br />
:* --.<br />
:* --.<br />
<br />
==What its the plan?==<br />
:* We are planning to create a web GUI that allows the user to develop the basic tasks of dictionaries and translation pairs manipulation in an easy and practical way.<br />
:* We will use Git as an administrative and control tool, allowing the user to contribute to the work of other community members or start your own project.<br />
<br />
==Components ans Technologies==<br />
[[File:ComponentDiagramWebDictionary.jpg|thumb|700px|right|Components Diagram]]<br />
* Actors<br />
** Lay User <br />
** Dictionary Admin <br />
<br />
* UserBrowser <br />
** WebInterface with AngularJS - GUI to easily manipulate the dictionary XML file.<br />
<br />
* Web Dicionary Maintence (APP)<br />
** WebAPI - <br />
** Temporary Database - Temporary database in which the XML file will be loaded with the crosses made.<br />
** JavaGit Connector - <br />
** WebDictionary Controller - <br />
<br />
* Git - <br />
** GitRepository - <br />
** GitLab - <br />
** GitHub -<br />
<br />
==How it Works?==<br />
We will develop a WebInterface to LayUser add words or sugest modifiations.<br />
<br />
*<br />
*<br />
<br />
We are planning to use Git as an administrative and version control tool.<br />
<br />
* All dictionaries releases will be in a single repository and available to any member of the community to continue the work.<br />
* Each user will have your own branch to work on.<br />
* The users will be able to make merge requests with the official branch.<br />
* At first, we will use GitLab (or similar tool) to manage this merges requests. The team who maintain each dictionary will judge if the modifications are valid or not.<br />
<br />
==Example of Interaction - Adding new lemma to a dictionary==<br />
<br />
===1. Choosing an official dictionary and importing it===<br />
The Official Dictionaries page display all available dictionaries in the git repository. Each version correspond to a tag in the master branch.<br />
[[File:Prototype1.png|thumb|250px|none|Choosing an official dictionary and importing it]]<br />
<br />
[[File:Git1.png|thumb|250px|none|Master branch]]<br />
Once imported, the user will name this dictionary and it will appear on the My Dictionaries page.<br />
[[File:Prototype2.png|thumb|250px|none|My Dictionaries page]]<br />
<br />
===2. Loading the dictionary file===<br />
On the Language File page, the user selects one of their dictionaries and the dictionary XML will be formatted to be temporarily saved to a database. Also on this page, the user can edit the dictionary alphabet and see some statistics about it.<br />
<br />
The Symbols, Paradigms, and Lemmas pages refer to the dictionary selected here.<br />
<br />
[[File:Prototype3.png|thumb|250px|none|Loading the dictionary file]]<br />
===3. Verifying if the lemmas already exists===<br />
On the Lemmas - Search page, the user will be able to see all the inflections of the dictionary lemmas and check if the lemma he wants to add already exists.<br />
<br />
[[File:Prototype4.png|thumb|250px|none|Verifying if the lemmas already exists]]<br />
===4. Creating the new lemma===<br />
In the Lemmas - Create page, the user will follow three steps to add a new lemma.<br />
<br />
In the first step, the user will define the lemma and the lemma root. In addition, he will give some examples of inflections and symbols to receive suggestions on which paradigm to use.<br />
<br />
[[File:Prototype5.png|thumb|250px|none|text-top|Creating the new lemma - Step 1]]<br />
In the second step, the user will see paradigm suggestions (or can see all paradigms). When a paradigm is selected, all inflections of the created lemma will be shown to the user. If none of the paradigms fit, the user will be directed to create a new paradigm.<br />
<br />
[[File:Prototype6.png|thumb|250px|none|Creating the new lemma - Step 2]]<br />
In the third and last step, the user will confirm and save the change. At this point, a branch will be create for this dictionary in the git repository (if she doesn’t already exists) and a commit with this changes will be done.<br />
<br />
[[File:Prototype7.png|thumb|250px|none|Creating the new lemma - Step 3]]<br />
===5. Merge Request===<br />
On My Dictionaries page, the user can create a merge request that will be judge by the master branch maintainer.<br />
<br />
[[File:Prototype8.png|thumb|250px|none|Merge Request]]<br />
[[File:Git2.png|thumb|250px|none|New branch created in Git]]<br />
<br />
===6. Official dictionary keeper judges the merge request===<br />
In GitLab (or similar tool), the dictionary maintainer will see the list of merge requests.<br />
[[File:Git5.png|thumb|250px|none|Merge request list]]<br />
At each request, the maintainer can view all commits and accepts only a few of them.<br />
[[File:Git6.png|thumb|250px|none|Commits from current merge request]]<br />
At each commit, he will judge the changes.<br />
[[File:Git7.png|thumb|250px|none|Changes]]<br />
When he accepts the merge request, the user's branch is deleted.<br />
[[File:Git4.png|thumb|250px|none|GitLab Graph]]<br />
<br />
===7. Feedback===<br />
On Merge Requests page, the user can see all request he have made and their status.<br />
<br />
<br />
[[File:Prototype9.png|thumb|250px|none|Feedback]]<br />
<br />
[[Category:GSoC 2019 student proposals|Alessio]]</div>Alessiohttps://wiki.apertium.org/w/index.php?title=Web_Dictionary_Maintenance&diff=69026Web Dictionary Maintenance2019-03-26T15:03:18Z<p>Alessio: /* Which of the published tasks are you interested in? */</p>
<hr />
<div>{{TOCD}}<br />
<br />
[https://translate.google.com/translate?sl=en&tl=pt-br&prev=_t&hl=en&u=http://wiki.apertium.org/wiki/Web_Dictionary_Maintenance Translate to PT-BR with Google Tradução]<br />
<br />
= Introduction =<br />
<br />
Apertium over the years still has deficiencies so that lay people can contribute to increase the base of words in dictionaries, even with simple contributions. Collaboration is the key to developing a tool that serves a huge range of users throughout the world. We believe that it is possible to engage more users and thus give greater impact to the tool within the communities where there is involvement. We will deal in this document with requirements on non-functional and technical objectives regarding the tool proposal.<br />
<br />
;Original Ideias<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code/Easy_dictionary_maintenance<br />
<br />
;Original GSOC2019 Application<br />
: http://wiki.apertium.org/wiki/User:Alessiojr/Easy_dictionary_-_Application-GSOC2019<br />
<br />
;Studant Information<br />
: '''Student:''' Vinícius Silva Nogueira <br /><br />
: '''Unofficial Mentor:''' Alessio Miranda Junior<br /><br />
: '''Telegram/Whatsapp:''' Alessio: +55 (31) 9.8888-7770<br /><br />
: '''E-mail:''' alessio@cefetmg.br or vinicius_snogueira@hotmail.com / viniciussnogueira13@gmail.com<br /><br />
: '''IRC:''' AlessioJr<br /><br />
: '''GTalk:''' alessiojunin@gmail.com<br />
<br />
=Description=<br />
==Abstract:==<br />
The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps away potential contributors. A tool that facilitates the work of dictionaries developers, eliminate computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
Even with several tools that help the way you manage and create dictionaries, Apertium is far from the normal users, who have a huge contribution potential. Or even create a simple way to create contributions to recurring users with advanced knowledge. Although it is a bold plan, and there are several possible and desirable requirements, we will describe some basic premises for this step and that must be respected and aligned with the apertium developer community.<br />
<br />
==Definitions==<br />
:* Lay users do not need to know Apertium's internal structure.<br />
:* Intermediate users need to have a knowledge of dictionary management methodology. <br />
:* Advanced users are those who know the structure of Apertium.<br />
:* Communities are user groups that merge characteristics to the database extension of a dictionary of a specific language.<br />
:* Official dictionaries are dictionaries managed and with seal of the apertium community.<br />
:* Unofficial dictionaries are dictionaries run by an independent community.<br />
:* Test dictionaries are deprived of users to test their contributions.<br />
<br />
==Objectives:==<br />
:* The major goal of the project is to develop a web tool to facilitate the management of the Apertium (XML's) database of integrators for novice and advanced users.<br />
:* New communities of contributions should be able to organize independently of a central command. The command exists but will be distributed.<br />
:* Lay users who feel motivated to contribute, should have an interface that promotes ease in contributing even with limited possibilities.<br />
:* The development of dictionaries should be collaborative and distributed. Each dictionary should have a management community, but a user may have the freedom to disagree and create a new version maintaining a history of the author.<br />
:* Any tool should maintain the traditional Apertium structure and not be interoperable between existing tools.<br />
:* There must be a methodology for communities to maintain the quality of their dictionaries. Although they are distributed the goal is to create a unified and mature dictionary.<br />
<br />
=Technical Objectives:=<br />
:* Develop, initially, monolingual dictionaries but keeping the particular format of each file.<br />
:* Minimize the direct manipulation of XML files, providing features that reduce this need.<br />
:* Making use of GitLab as an administrative and control tool.<br />
<br />
== Git, GitLab and Apertium ==<br />
[[File:Git_flow_demonstration.jpg|thumb|250px|right|Git Flow demonstration]]<br />
As the Apertium files are textual, we had the idea of seeking productivity and using existing and consolidated tools in the world.<br />
The proposal is to build a friendly web interface for lay users, but use git's own Back-End as version control and to make dictionary management GitLab as an administrative tool that already guarantees incredible power for remote collaboration.<br />
<br />
To demonstrate this relationship we will highlight some concepts of Git. Over time there may be several TimeLines:<br />
:* The Official Branch (Master) has the official version of the apertium managed by official developers or maintainers.<br />
:* Users have the power to create new Branches and develop unofficial dictionaries in parallel, creating communities that may from time to time suggest modifications to Brach Master.<br />
:* These requests can be accepted or rejected by maintainers, and this format is recursive and other developers can create unofficial copies of unofficial ones.<br />
:* Integration requests will use the Merge Request concepts present in tools such as GitLab that will be the BackEnd for advanced users.<br />
<br />
=Application-GSOC2019=<br />
===Abstract:===<br />
The idea is to develop the Web tool so that lay users contribute to dictionaries and use Git management with GitLab to manage these changes.<br />
* The focus will be on monolingual dictionaries and bilingual direct relationships.<br />
* Use the Git methodology and propose a guideline or flow for collaborative dictionary management.<br />
* Do not change the current XML format of dictionaries.<br />
<br />
===Why is it you are interested in machine translation?===<br />
<br />
During the graduation course, Professor Aléssio demonstrated the need and opportunity to contribute with open source projects. <br />
He introduced me to Apertium and in my final graduation work I started reading and talking about it. <br />
We started discussing techniques for managing collaboration with the community and currently do not have <br />
as much knowledge about machine translation machines but I have experience in developing applications <br />
and web using collaboration with Git and GitLab.<br />
<br />
===Why are they interested in the Apertium project?===<br />
<br />
I’ve .<br />
<br />
===Which of the published tasks are you interested in?===<br />
<br />
[http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code/Easy_dictionary_maintenance Easy dictionary maintenance]<br />
<br />
===Why should Google and Apertium sponsor it?===<br />
<br />
I .<br />
<br />
===How and who will it benefit in society?===<br />
This application will benefit the entire Apertium community.<br />
Dictionary developers will have a tool to speed up their work and an easy-to-use tool will attract new contributors.<br />
As a result, Apertium's translation capacity will be increased, bringing better results to the end user.<br />
<br />
===What do you plan to do?===<br />
We are planning to create a web GUI that will facilitate common tasks of creating/modifying dictionaries and allow lay users to contribute to a dictionary.<br />
The application will be connected to a Git repository, which will be used as an administrative and version control tool.<br />
<br />
<br />
<br />
'''Development Paradigm:''' MVC Paradigm<br /><br />
'''Program Language:''' Java, JavaScript<br /><br />
'''Persistence:''' XML (Apertium XML Files)<br /><br />
'''Framworks:''' Angular<br /><br />
<br />
===Stages/Milestones===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Week<br />
! Stage<br />
! Description<br />
|-<br />
| 1, 2<br />
| --<br />
| --.<br />
|-<br />
| 2, 3<br />
| --<br />
| --.|<br />
|-<br />
| '''Prototype'''<br />
| Milestone 1<br />
| --<br />
|-<br />
| 5, 6<br />
| --<br />
| --.<br />
|-<br />
| 7<br />
| --<br />
| --.<br />
|-<br />
| 8<br />
| --<br />
| --.<br />
|-<br />
| '''Prototype'''<br />
| Milestone 2<br />
| --<br />
|-<br />
| 9<br />
| --<br />
| --.<br />
|-<br />
| 10<br />
| --<br />
| --.<br />
|-<br />
| 11<br />
| Pré-Release<br />
| --<br />
|-<br />
| '''Prototype'''<br />
| --<br />
| <br />
|-<br />
| 12<br />
| Makeup<br />
| --<br />
|-<br />
| <br />
| '''Final Release'''<br />
|<br />
|}<br />
<br />
===Presentation===<br />
<br />
My name is Vinicius, a Brazilian Student at Federal Center for Technological Education of Minas Gerais - Brazil.<br />
<br />
===Resume of Skills===<br />
<br />
Apertium Knowledge:<br />
<br />
* Study to develop a collaborative tool for apertium.<br />
* A study of actual Apertium process about creating a language pair by the user point of view.<br />
* Analysis of the characteristics of the 2010 project of Aléssio and adaptation to current times.<br />
<br />
Academic Skills:<br />
<br />
* Graduating in Computer Engineering- Federal Center for Technological Education of Minas Gerais – Brazil<br />
<br />
Professional Skills:<br />
<br />
* Language developer: C, Java, JavaScript, PHP, Phyton, PL/SQL.<br />
<br />
Projects for Summer:<br />
<br />
* No professional activities planned.<br />
* Planning to work in GSOC<br />
<br />
=Project=<br />
==Why?==<br />
:* The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps potential contributors away. A tool that facilitates the work of dictionaries developers, eliminate the need of computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
==How can use?==<br />
:* --.<br />
:* --.<br />
:* --.<br />
:* --.<br />
<br />
==What its the plan?==<br />
:* We are planning to create a web GUI that allows the user to develop the basic tasks of dictionaries and translation pairs manipulation in an easy and practical way.<br />
:* We will use Git as an administrative and control tool, allowing the user to contribute to the work of other community members or start your own project.<br />
<br />
==Components ans Technologies==<br />
[[File:ComponentDiagramWebDictionary.jpg|thumb|700px|right|Components Diagram]]<br />
* Actors<br />
** Lay User <br />
** Dictionary Admin <br />
<br />
* UserBrowser <br />
** WebInterface with AngularJS - GUI to easily manipulate the dictionary XML file.<br />
<br />
* Web Dicionary Maintence (APP)<br />
** WebAPI - <br />
** Temporary Database - Temporary database in which the XML file will be loaded with the crosses made.<br />
** JavaGit Connector - <br />
** WebDictionary Controller - <br />
<br />
* Git - <br />
** GitRepository - <br />
** GitLab - <br />
** GitHub -<br />
<br />
==How it Works?==<br />
We will develop a WebInterface to LayUser add words or sugest modifiations.<br />
<br />
*<br />
*<br />
<br />
We are planning to use Git as an administrative and version control tool.<br />
<br />
* All dictionaries releases will be in a single repository and available to any member of the community to continue the work.<br />
* Each user will have your own branch to work on.<br />
* The users will be able to make merge requests with the official branch.<br />
* At first, we will use GitLab (or similar tool) to manage this merges requests. The team who maintain each dictionary will judge if the modifications are valid or not.<br />
<br />
==Example of Interaction - Adding new lemma to a dictionary==<br />
<br />
===1. Choosing an official dictionary and importing it===<br />
The Official Dictionaries page display all available dictionaries in the git repository. Each version correspond to a tag in the master branch.<br />
[[File:Prototype1.png|thumb|250px|none|Choosing an official dictionary and importing it]]<br />
<br />
[[File:Git1.png|thumb|250px|none|Master branch]]<br />
Once imported, the user will name this dictionary and it will appear on the My Dictionaries page.<br />
[[File:Prototype2.png|thumb|250px|none|My Dictionaries page]]<br />
<br />
===2. Loading the dictionary file===<br />
On the Language File page, the user selects one of their dictionaries and the dictionary XML will be formatted to be temporarily saved to a database. Also on this page, the user can edit the dictionary alphabet and see some statistics about it.<br />
<br />
The Symbols, Paradigms, and Lemmas pages refer to the dictionary selected here.<br />
<br />
[[File:Prototype3.png|thumb|250px|none|Loading the dictionary file]]<br />
===3. Verifying if the lemmas already exists===<br />
On the Lemmas - Search page, the user will be able to see all the inflections of the dictionary lemmas and check if the lemma he wants to add already exists.<br />
<br />
[[File:Prototype4.png|thumb|250px|none|Verifying if the lemmas already exists]]<br />
===4. Creating the new lemma===<br />
In the Lemmas - Create page, the user will follow three steps to add a new lemma.<br />
<br />
In the first step, the user will define the lemma and the lemma root. In addition, he will give some examples of inflections and symbols to receive suggestions on which paradigm to use.<br />
<br />
[[File:Prototype5.png|thumb|250px|none|text-top|Creating the new lemma - Step 1]]<br />
In the second step, the user will see paradigm suggestions (or can see all paradigms). When a paradigm is selected, all inflections of the created lemma will be shown to the user. If none of the paradigms fit, the user will be directed to create a new paradigm.<br />
<br />
[[File:Prototype6.png|thumb|250px|none|Creating the new lemma - Step 2]]<br />
In the third and last step, the user will confirm and save the change. At this point, a branch will be create for this dictionary in the git repository (if she doesn’t already exists) and a commit with this changes will be done.<br />
<br />
[[File:Prototype7.png|thumb|250px|none|Creating the new lemma - Step 3]]<br />
===5. Merge Request===<br />
On My Dictionaries page, the user can create a merge request that will be judge by the master branch maintainer.<br />
<br />
[[File:Prototype8.png|thumb|250px|none|Merge Request]]<br />
[[File:Git2.png|thumb|250px|none|New branch created in Git]]<br />
<br />
===6. Official dictionary keeper judges the merge request===<br />
In GitLab (or similar tool), the dictionary maintainer will see the list of merge requests.<br />
[[File:Git5.png|thumb|250px|none|Merge request list]]<br />
At each request, the maintainer can view all commits and accepts only a few of them.<br />
[[File:Git6.png|thumb|250px|none|Commits from current merge request]]<br />
At each commit, he will judge the changes.<br />
[[File:Git7.png|thumb|250px|none|Changes]]<br />
When he accepts the merge request, the user's branch is deleted.<br />
[[File:Git4.png|thumb|250px|none|GitLab Graph]]<br />
<br />
===7. Feedback===<br />
On Merge Requests page, the user can see all request he have made and their status.<br />
<br />
<br />
[[File:Prototype9.png|thumb|250px|none|Feedback]]<br />
<br />
[[Category:GSoC 2019 student proposals|Alessio]]</div>Alessiohttps://wiki.apertium.org/w/index.php?title=Web_Dictionary_Maintenance&diff=69013Web Dictionary Maintenance2019-03-26T02:18:39Z<p>Alessio: /* How and who will it benefit in society? */</p>
<hr />
<div>{{TOCD}}<br />
<br />
[https://translate.google.com/translate?sl=en&tl=pt-br&prev=_t&hl=en&u=http://wiki.apertium.org/wiki/Web_Dictionary_Maintenance Translate to PT-BR with Google Tradução]<br />
<br />
= Introduction =<br />
<br />
Apertium over the years still has deficiencies so that lay people can contribute to increase the base of words in dictionaries, even with simple contributions. Collaboration is the key to developing a tool that serves a huge range of users throughout the world. We believe that it is possible to engage more users and thus give greater impact to the tool within the communities where there is involvement. We will deal in this document with requirements on non-functional and technical objectives regarding the tool proposal.<br />
<br />
;Original Ideias<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code/Easy_dictionary_maintenance<br />
<br />
;Original GSOC2019 Application<br />
: http://wiki.apertium.org/wiki/User:Alessiojr/Easy_dictionary_-_Application-GSOC2019<br />
<br />
;Studant Information<br />
: '''Student:''' Vinícius Silva Nogueira <br /><br />
: '''Unofficial Mentor:''' Alessio Miranda Junior<br /><br />
: '''Telegram/Whatsapp:''' Alessio: +55 (31) 9.8888-7770<br /><br />
: '''E-mail:''' alessio@cefetmg.br or vinicius_snogueira@hotmail.com / viniciussnogueira13@gmail.com<br /><br />
: '''IRC:''' AlessioJr<br /><br />
: '''GTalk:''' alessiojunin@gmail.com<br />
<br />
=Description=<br />
==Abstract:==<br />
The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps away potential contributors. A tool that facilitates the work of dictionaries developers, eliminate computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
Even with several tools that help the way you manage and create dictionaries, Apertium is far from the normal users, who have a huge contribution potential. Or even create a simple way to create contributions to recurring users with advanced knowledge. Although it is a bold plan, and there are several possible and desirable requirements, we will describe some basic premises for this step and that must be respected and aligned with the apertium developer community.<br />
<br />
==Definitions==<br />
:* Lay users do not need to know Apertium's internal structure.<br />
:* Intermediate users need to have a knowledge of dictionary management methodology. <br />
:* Advanced users are those who know the structure of Apertium.<br />
:* Communities are user groups that merge characteristics to the database extension of a dictionary of a specific language.<br />
:* Official dictionaries are dictionaries managed and with seal of the apertium community.<br />
:* Unofficial dictionaries are dictionaries run by an independent community.<br />
:* Test dictionaries are deprived of users to test their contributions.<br />
<br />
==Objectives:==<br />
:* The major goal of the project is to develop a web tool to facilitate the management of the Apertium (XML's) database of integrators for novice and advanced users.<br />
:* New communities of contributions should be able to organize independently of a central command. The command exists but will be distributed.<br />
:* Lay users who feel motivated to contribute, should have an interface that promotes ease in contributing even with limited possibilities.<br />
:* The development of dictionaries should be collaborative and distributed. Each dictionary should have a management community, but a user may have the freedom to disagree and create a new version maintaining a history of the author.<br />
:* Any tool should maintain the traditional Apertium structure and not be interoperable between existing tools.<br />
:* There must be a methodology for communities to maintain the quality of their dictionaries. Although they are distributed the goal is to create a unified and mature dictionary.<br />
<br />
=Technical Objectives:=<br />
:* Develop, initially, monolingual dictionaries but keeping the particular format of each file.<br />
:* Minimize the direct manipulation of XML files, providing features that reduce this need.<br />
:* Making use of GitLab as an administrative and control tool.<br />
<br />
== Git, GitLab and Apertium ==<br />
[[File:Git_flow_demonstration.jpg|thumb|250px|right|Git Flow demonstration]]<br />
As the Apertium files are textual, we had the idea of seeking productivity and using existing and consolidated tools in the world.<br />
The proposal is to build a friendly web interface for lay users, but use git's own Back-End as version control and to make dictionary management GitLab as an administrative tool that already guarantees incredible power for remote collaboration.<br />
<br />
To demonstrate this relationship we will highlight some concepts of Git. Over time there may be several TimeLines:<br />
:* The Official Branch (Master) has the official version of the apertium managed by official developers or maintainers.<br />
:* Users have the power to create new Branches and develop unofficial dictionaries in parallel, creating communities that may from time to time suggest modifications to Brach Master.<br />
:* These requests can be accepted or rejected by maintainers, and this format is recursive and other developers can create unofficial copies of unofficial ones.<br />
:* Integration requests will use the Merge Request concepts present in tools such as GitLab that will be the BackEnd for advanced users.<br />
<br />
=Application-GSOC2019=<br />
===Abstract:===<br />
The idea is to develop the Web tool so that lay users contribute to dictionaries and use Git management with GitLab to manage these changes.<br />
* The focus will be on monolingual dictionaries and bilingual direct relationships.<br />
* Use the Git methodology and propose a guideline or flow for collaborative dictionary management.<br />
* Do not change the current XML format of dictionaries.<br />
<br />
===Why is it you are interested in machine translation?===<br />
<br />
During the graduation course, Professor Aléssio demonstrated the need and opportunity to contribute with open source projects. <br />
He introduced me to Apertium and in my final graduation work I started reading and talking about it. <br />
We started discussing techniques for managing collaboration with the community and currently do not have <br />
as much knowledge about machine translation machines but I have experience in developing applications <br />
and web using collaboration with Git and GitLab.<br />
<br />
===Why are they interested in the Apertium project?===<br />
<br />
I’ve .<br />
<br />
===Which of the published tasks are you interested in?===<br />
<br />
Easy dictionary maintenance.<br />
<br />
===Why should Google and Apertium sponsor it?===<br />
<br />
I .<br />
<br />
===How and who will it benefit in society?===<br />
This application will benefit the entire Apertium community.<br />
Dictionary developers will have a tool to speed up their work and an easy-to-use tool will attract new contributors.<br />
As a result, Apertium's translation capacity will be increased, bringing better results to the end user.<br />
<br />
===What do you plan to do?===<br />
We are planning to create a web GUI that will facilitate common tasks of creating/modifying dictionaries and allow lay users to contribute to a dictionary.<br />
The application will be connected to a Git repository, which will be used as an administrative and version control tool.<br />
<br />
<br />
<br />
'''Development Paradigm:''' MVC Paradigm<br /><br />
'''Program Language:''' Java, JavaScript<br /><br />
'''Persistence:''' XML (Apertium XML Files)<br /><br />
'''Framworks:''' Angular<br /><br />
<br />
===Stages/Milestones===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Week<br />
! Stage<br />
! Description<br />
|-<br />
| 1, 2<br />
| --<br />
| --.<br />
|-<br />
| 2, 3<br />
| --<br />
| --.|<br />
|-<br />
| '''Prototype'''<br />
| Milestone 1<br />
| --<br />
|-<br />
| 5, 6<br />
| --<br />
| --.<br />
|-<br />
| 7<br />
| --<br />
| --.<br />
|-<br />
| 8<br />
| --<br />
| --.<br />
|-<br />
| '''Prototype'''<br />
| Milestone 2<br />
| --<br />
|-<br />
| 9<br />
| --<br />
| --.<br />
|-<br />
| 10<br />
| --<br />
| --.<br />
|-<br />
| 11<br />
| Pré-Release<br />
| --<br />
|-<br />
| '''Prototype'''<br />
| --<br />
| <br />
|-<br />
| 12<br />
| Makeup<br />
| --<br />
|-<br />
| <br />
| '''Final Release'''<br />
|<br />
|}<br />
<br />
===Presentation===<br />
<br />
My name is Vinicius, a Brazilian Student at Federal Center for Technological Education of Minas Gerais - Brazil.<br />
<br />
===Resume of Skills===<br />
<br />
Apertium Knowledge:<br />
<br />
* Study to develop a collaborative tool for apertium.<br />
* A study of actual Apertium process about creating a language pair by the user point of view.<br />
* Analysis of the characteristics of the 2010 project of Aléssio and adaptation to current times.<br />
<br />
Academic Skills:<br />
<br />
* Graduating in Computer Engineering- Federal Center for Technological Education of Minas Gerais – Brazil<br />
<br />
Professional Skills:<br />
<br />
* Language developer: C, Java, JavaScript, PHP, Phyton, PL/SQL.<br />
<br />
Projects for Summer:<br />
<br />
* No professional activities planned.<br />
* Planning to work in GSOC<br />
<br />
=Project=<br />
==Why?==<br />
:* The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps potential contributors away. A tool that facilitates the work of dictionaries developers, eliminate the need of computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
==How can use?==<br />
:* --.<br />
:* --.<br />
:* --.<br />
:* --.<br />
<br />
==What its the plan?==<br />
:* We are planning to create a web GUI that allows the user to develop the basic tasks of dictionaries and translation pairs manipulation in an easy and practical way.<br />
:* We will use Git as an administrative and control tool, allowing the user to contribute to the work of other community members or start your own project.<br />
<br />
==Components ans Technologies==<br />
[[File:ComponentDiagramWebDictionary.jpg|thumb|700px|right|Components Diagram]]<br />
* Actors<br />
** Lay User <br />
** Dictionary Admin <br />
<br />
* UserBrowser <br />
** WebInterface with AngularJS - GUI to easily manipulate the dictionary XML file.<br />
<br />
* Web Dicionary Maintence (APP)<br />
** WebAPI - <br />
** Temporary Database - Temporary database in which the XML file will be loaded with the crosses made.<br />
** JavaGit Connector - <br />
** WebDictionary Controller - <br />
<br />
* Git - <br />
** GitRepository - <br />
** GitLab - <br />
** GitHub -<br />
<br />
==How it Works?==<br />
We will develop a WebInterface to LayUser add words or sugest modifiations.<br />
<br />
*<br />
*<br />
<br />
We are planning to use Git as an administrative and version control tool.<br />
<br />
* All dictionaries releases will be in a single repository and available to any member of the community to continue the work.<br />
* Each user will have your own branch to work on.<br />
* The users will be able to make merge requests with the official branch.<br />
* At first, we will use GitLab (or similar tool) to manage this merges requests. The team who maintain each dictionary will judge if the modifications are valid or not.<br />
<br />
==Example of Interaction - Adding new lemma to a dictionary==<br />
<br />
===1. Choosing an official dictionary and importing it===<br />
The Official Dictionaries page display all available dictionaries in the git repository. Each version correspond to a tag in the master branch.<br />
[[File:Prototype1.png|thumb|250px|none|Choosing an official dictionary and importing it]]<br />
<br />
[[File:Git1.png|thumb|250px|none|Master branch]]<br />
Once imported, the user will name this dictionary and it will appear on the My Dictionaries page.<br />
[[File:Prototype2.png|thumb|250px|none|My Dictionaries page]]<br />
<br />
===2. Loading the dictionary file===<br />
On the Language File page, the user selects one of their dictionaries and the dictionary XML will be formatted to be temporarily saved to a database. Also on this page, the user can edit the dictionary alphabet and see some statistics about it.<br />
<br />
The Symbols, Paradigms, and Lemmas pages refer to the dictionary selected here.<br />
<br />
[[File:Prototype3.png|thumb|250px|none|Loading the dictionary file]]<br />
===3. Verifying if the lemmas already exists===<br />
On the Lemmas - Search page, the user will be able to see all the inflections of the dictionary lemmas and check if the lemma he wants to add already exists.<br />
<br />
[[File:Prototype4.png|thumb|250px|none|Verifying if the lemmas already exists]]<br />
===4. Creating the new lemma===<br />
In the Lemmas - Create page, the user will follow three steps to add a new lemma.<br />
<br />
In the first step, the user will define the lemma and the lemma root. In addition, he will give some examples of inflections and symbols to receive suggestions on which paradigm to use.<br />
<br />
[[File:Prototype5.png|thumb|250px|none|text-top|Creating the new lemma - Step 1]]<br />
In the second step, the user will see paradigm suggestions (or can see all paradigms). When a paradigm is selected, all inflections of the created lemma will be shown to the user. If none of the paradigms fit, the user will be directed to create a new paradigm.<br />
<br />
[[File:Prototype6.png|thumb|250px|none|Creating the new lemma - Step 2]]<br />
In the third and last step, the user will confirm and save the change. At this point, a branch will be create for this dictionary in the git repository (if she doesn’t already exists) and a commit with this changes will be done.<br />
<br />
[[File:Prototype7.png|thumb|250px|none|Creating the new lemma - Step 3]]<br />
===5. Merge Request===<br />
On My Dictionaries page, the user can create a merge request that will be judge by the master branch maintainer.<br />
<br />
[[File:Prototype8.png|thumb|250px|none|Merge Request]]<br />
[[File:Git2.png|thumb|250px|none|New branch created in Git]]<br />
<br />
===6. Official dictionary keeper judges the merge request===<br />
In GitLab (or similar tool), the dictionary maintainer will see the list of merge requests.<br />
[[File:Git5.png|thumb|250px|none|Merge request list]]<br />
At each request, the maintainer can view all commits and accepts only a few of them.<br />
[[File:Git6.png|thumb|250px|none|Commits from current merge request]]<br />
At each commit, he will judge the changes.<br />
[[File:Git7.png|thumb|250px|none|Changes]]<br />
When he accepts the merge request, the user's branch is deleted.<br />
[[File:Git4.png|thumb|250px|none|GitLab Graph]]<br />
<br />
===7. Feedback===<br />
On Merge Requests page, the user can see all request he have made and their status.<br />
<br />
<br />
[[File:Prototype9.png|thumb|250px|none|Feedback]]<br />
<br />
[[Category:GSoC 2019 student proposals|Alessio]]</div>Alessiohttps://wiki.apertium.org/w/index.php?title=Web_Dictionary_Maintenance&diff=69012Web Dictionary Maintenance2019-03-26T02:00:57Z<p>Alessio: /* What do you plan to do? */</p>
<hr />
<div>{{TOCD}}<br />
<br />
[https://translate.google.com/translate?sl=en&tl=pt-br&prev=_t&hl=en&u=http://wiki.apertium.org/wiki/Web_Dictionary_Maintenance Translate to PT-BR with Google Tradução]<br />
<br />
= Introduction =<br />
<br />
Apertium over the years still has deficiencies so that lay people can contribute to increase the base of words in dictionaries, even with simple contributions. Collaboration is the key to developing a tool that serves a huge range of users throughout the world. We believe that it is possible to engage more users and thus give greater impact to the tool within the communities where there is involvement. We will deal in this document with requirements on non-functional and technical objectives regarding the tool proposal.<br />
<br />
;Original Ideias<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code/Easy_dictionary_maintenance<br />
<br />
;Original GSOC2019 Application<br />
: http://wiki.apertium.org/wiki/User:Alessiojr/Easy_dictionary_-_Application-GSOC2019<br />
<br />
;Studant Information<br />
: '''Student:''' Vinícius Silva Nogueira <br /><br />
: '''Unofficial Mentor:''' Alessio Miranda Junior<br /><br />
: '''Telegram/Whatsapp:''' Alessio: +55 (31) 9.8888-7770<br /><br />
: '''E-mail:''' alessio@cefetmg.br or vinicius_snogueira@hotmail.com / viniciussnogueira13@gmail.com<br /><br />
: '''IRC:''' AlessioJr<br /><br />
: '''GTalk:''' alessiojunin@gmail.com<br />
<br />
=Description=<br />
==Abstract:==<br />
The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps away potential contributors. A tool that facilitates the work of dictionaries developers, eliminate computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
Even with several tools that help the way you manage and create dictionaries, Apertium is far from the normal users, who have a huge contribution potential. Or even create a simple way to create contributions to recurring users with advanced knowledge. Although it is a bold plan, and there are several possible and desirable requirements, we will describe some basic premises for this step and that must be respected and aligned with the apertium developer community.<br />
<br />
==Definitions==<br />
:* Lay users do not need to know Apertium's internal structure.<br />
:* Intermediate users need to have a knowledge of dictionary management methodology. <br />
:* Advanced users are those who know the structure of Apertium.<br />
:* Communities are user groups that merge characteristics to the database extension of a dictionary of a specific language.<br />
:* Official dictionaries are dictionaries managed and with seal of the apertium community.<br />
:* Unofficial dictionaries are dictionaries run by an independent community.<br />
:* Test dictionaries are deprived of users to test their contributions.<br />
<br />
==Objectives:==<br />
:* The major goal of the project is to develop a web tool to facilitate the management of the Apertium (XML's) database of integrators for novice and advanced users.<br />
:* New communities of contributions should be able to organize independently of a central command. The command exists but will be distributed.<br />
:* Lay users who feel motivated to contribute, should have an interface that promotes ease in contributing even with limited possibilities.<br />
:* The development of dictionaries should be collaborative and distributed. Each dictionary should have a management community, but a user may have the freedom to disagree and create a new version maintaining a history of the author.<br />
:* Any tool should maintain the traditional Apertium structure and not be interoperable between existing tools.<br />
:* There must be a methodology for communities to maintain the quality of their dictionaries. Although they are distributed the goal is to create a unified and mature dictionary.<br />
<br />
=Technical Objectives:=<br />
:* Develop, initially, monolingual dictionaries but keeping the particular format of each file.<br />
:* Minimize the direct manipulation of XML files, providing features that reduce this need.<br />
:* Making use of GitLab as an administrative and control tool.<br />
<br />
== Git, GitLab and Apertium ==<br />
[[File:Git_flow_demonstration.jpg|thumb|250px|right|Git Flow demonstration]]<br />
As the Apertium files are textual, we had the idea of seeking productivity and using existing and consolidated tools in the world.<br />
The proposal is to build a friendly web interface for lay users, but use git's own Back-End as version control and to make dictionary management GitLab as an administrative tool that already guarantees incredible power for remote collaboration.<br />
<br />
To demonstrate this relationship we will highlight some concepts of Git. Over time there may be several TimeLines:<br />
:* The Official Branch (Master) has the official version of the apertium managed by official developers or maintainers.<br />
:* Users have the power to create new Branches and develop unofficial dictionaries in parallel, creating communities that may from time to time suggest modifications to Brach Master.<br />
:* These requests can be accepted or rejected by maintainers, and this format is recursive and other developers can create unofficial copies of unofficial ones.<br />
:* Integration requests will use the Merge Request concepts present in tools such as GitLab that will be the BackEnd for advanced users.<br />
<br />
=Application-GSOC2019=<br />
===Abstract:===<br />
The idea is to develop the Web tool so that lay users contribute to dictionaries and use Git management with GitLab to manage these changes.<br />
* The focus will be on monolingual dictionaries and bilingual direct relationships.<br />
* Use the Git methodology and propose a guideline or flow for collaborative dictionary management.<br />
* Do not change the current XML format of dictionaries.<br />
<br />
===Why is it you are interested in machine translation?===<br />
<br />
During the graduation course, Professor Aléssio demonstrated the need and opportunity to contribute with open source projects. <br />
He introduced me to Apertium and in my final graduation work I started reading and talking about it. <br />
We started discussing techniques for managing collaboration with the community and currently do not have <br />
as much knowledge about machine translation machines but I have experience in developing applications <br />
and web using collaboration with Git and GitLab.<br />
<br />
===Why are they interested in the Apertium project?===<br />
<br />
I’ve .<br />
<br />
===Which of the published tasks are you interested in?===<br />
<br />
Easy dictionary maintenance.<br />
<br />
===Why should Google and Apertium sponsor it?===<br />
<br />
I .<br />
<br />
===How and who will it benefit in society?===<br />
I .<br />
<br />
===What do you plan to do?===<br />
We are planning to create a web GUI that will facilitate common tasks of creating/modifying dictionaries and allow lay users to contribute to a dictionary.<br />
The application will be connected to a Git repository, which will be used as an administrative and version control tool.<br />
<br />
<br />
<br />
'''Development Paradigm:''' MVC Paradigm<br /><br />
'''Program Language:''' Java, JavaScript<br /><br />
'''Persistence:''' XML (Apertium XML Files)<br /><br />
'''Framworks:''' Angular<br /><br />
<br />
===Stages/Milestones===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Week<br />
! Stage<br />
! Description<br />
|-<br />
| 1, 2<br />
| --<br />
| --.<br />
|-<br />
| 2, 3<br />
| --<br />
| --.|<br />
|-<br />
| '''Prototype'''<br />
| Milestone 1<br />
| --<br />
|-<br />
| 5, 6<br />
| --<br />
| --.<br />
|-<br />
| 7<br />
| --<br />
| --.<br />
|-<br />
| 8<br />
| --<br />
| --.<br />
|-<br />
| '''Prototype'''<br />
| Milestone 2<br />
| --<br />
|-<br />
| 9<br />
| --<br />
| --.<br />
|-<br />
| 10<br />
| --<br />
| --.<br />
|-<br />
| 11<br />
| Pré-Release<br />
| --<br />
|-<br />
| '''Prototype'''<br />
| --<br />
| <br />
|-<br />
| 12<br />
| Makeup<br />
| --<br />
|-<br />
| <br />
| '''Final Release'''<br />
|<br />
|}<br />
<br />
===Presentation===<br />
<br />
My name is Vinicius, a Brazilian Student at Federal Center for Technological Education of Minas Gerais - Brazil.<br />
<br />
===Resume of Skills===<br />
<br />
Apertium Knowledge:<br />
<br />
* Study to develop a collaborative tool for apertium.<br />
* A study of actual Apertium process about creating a language pair by the user point of view.<br />
* Analysis of the characteristics of the 2010 project of Aléssio and adaptation to current times.<br />
<br />
Academic Skills:<br />
<br />
* Graduating in Computer Engineering- Federal Center for Technological Education of Minas Gerais – Brazil<br />
<br />
Professional Skills:<br />
<br />
* Language developer: C, Java, JavaScript, PHP, Phyton, PL/SQL.<br />
<br />
Projects for Summer:<br />
<br />
* No professional activities planned.<br />
* Planning to work in GSOC<br />
<br />
=Project=<br />
==Why?==<br />
:* The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps potential contributors away. A tool that facilitates the work of dictionaries developers, eliminate the need of computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
==How can use?==<br />
:* --.<br />
:* --.<br />
:* --.<br />
:* --.<br />
<br />
==What its the plan?==<br />
:* We are planning to create a web GUI that allows the user to develop the basic tasks of dictionaries and translation pairs manipulation in an easy and practical way.<br />
:* We will use Git as an administrative and control tool, allowing the user to contribute to the work of other community members or start your own project.<br />
<br />
==Components ans Technologies==<br />
[[File:ComponentDiagramWebDictionary.jpg|thumb|700px|right|Components Diagram]]<br />
* Actors<br />
** Lay User <br />
** Dictionary Admin <br />
<br />
* UserBrowser <br />
** WebInterface with AngularJS - GUI to easily manipulate the dictionary XML file.<br />
<br />
* Web Dicionary Maintence (APP)<br />
** WebAPI - <br />
** Temporary Database - Temporary database in which the XML file will be loaded with the crosses made.<br />
** JavaGit Connector - <br />
** WebDictionary Controller - <br />
<br />
* Git - <br />
** GitRepository - <br />
** GitLab - <br />
** GitHub -<br />
<br />
==How it Works?==<br />
We will develop a WebInterface to LayUser add words or sugest modifiations.<br />
<br />
*<br />
*<br />
<br />
We are planning to use Git as an administrative and version control tool.<br />
<br />
* All dictionaries releases will be in a single repository and available to any member of the community to continue the work.<br />
* Each user will have your own branch to work on.<br />
* The users will be able to make merge requests with the official branch.<br />
* At first, we will use GitLab (or similar tool) to manage this merges requests. The team who maintain each dictionary will judge if the modifications are valid or not.<br />
<br />
==Example of Interaction - Adding new lemma to a dictionary==<br />
<br />
===1. Choosing an official dictionary and importing it===<br />
The Official Dictionaries page display all available dictionaries in the git repository. Each version correspond to a tag in the master branch.<br />
[[File:Prototype1.png|thumb|250px|none|Choosing an official dictionary and importing it]]<br />
<br />
[[File:Git1.png|thumb|250px|none|Master branch]]<br />
Once imported, the user will name this dictionary and it will appear on the My Dictionaries page.<br />
[[File:Prototype2.png|thumb|250px|none|My Dictionaries page]]<br />
<br />
===2. Loading the dictionary file===<br />
On the Language File page, the user selects one of their dictionaries and the dictionary XML will be formatted to be temporarily saved to a database. Also on this page, the user can edit the dictionary alphabet and see some statistics about it.<br />
<br />
The Symbols, Paradigms, and Lemmas pages refer to the dictionary selected here.<br />
<br />
[[File:Prototype3.png|thumb|250px|none|Loading the dictionary file]]<br />
===3. Verifying if the lemmas already exists===<br />
On the Lemmas - Search page, the user will be able to see all the inflections of the dictionary lemmas and check if the lemma he wants to add already exists.<br />
<br />
[[File:Prototype4.png|thumb|250px|none|Verifying if the lemmas already exists]]<br />
===4. Creating the new lemma===<br />
In the Lemmas - Create page, the user will follow three steps to add a new lemma.<br />
<br />
In the first step, the user will define the lemma and the lemma root. In addition, he will give some examples of inflections and symbols to receive suggestions on which paradigm to use.<br />
<br />
[[File:Prototype5.png|thumb|250px|none|text-top|Creating the new lemma - Step 1]]<br />
In the second step, the user will see paradigm suggestions (or can see all paradigms). When a paradigm is selected, all inflections of the created lemma will be shown to the user. If none of the paradigms fit, the user will be directed to create a new paradigm.<br />
<br />
[[File:Prototype6.png|thumb|250px|none|Creating the new lemma - Step 2]]<br />
In the third and last step, the user will confirm and save the change. At this point, a branch will be create for this dictionary in the git repository (if she doesn’t already exists) and a commit with this changes will be done.<br />
<br />
[[File:Prototype7.png|thumb|250px|none|Creating the new lemma - Step 3]]<br />
===5. Merge Request===<br />
On My Dictionaries page, the user can create a merge request that will be judge by the master branch maintainer.<br />
<br />
[[File:Prototype8.png|thumb|250px|none|Merge Request]]<br />
[[File:Git2.png|thumb|250px|none|New branch created in Git]]<br />
<br />
===6. Official dictionary keeper judges the merge request===<br />
In GitLab (or similar tool), the dictionary maintainer will see the list of merge requests.<br />
[[File:Git5.png|thumb|250px|none|Merge request list]]<br />
At each request, the maintainer can view all commits and accepts only a few of them.<br />
[[File:Git6.png|thumb|250px|none|Commits from current merge request]]<br />
At each commit, he will judge the changes.<br />
[[File:Git7.png|thumb|250px|none|Changes]]<br />
When he accepts the merge request, the user's branch is deleted.<br />
[[File:Git4.png|thumb|250px|none|GitLab Graph]]<br />
<br />
===7. Feedback===<br />
On Merge Requests page, the user can see all request he have made and their status.<br />
<br />
<br />
[[File:Prototype9.png|thumb|250px|none|Feedback]]<br />
<br />
[[Category:GSoC 2019 student proposals|Alessio]]</div>Alessiohttps://wiki.apertium.org/w/index.php?title=Web_Dictionary_Maintenance&diff=69011Web Dictionary Maintenance2019-03-26T01:59:20Z<p>Alessio: /* What do you plan to do? */</p>
<hr />
<div>{{TOCD}}<br />
<br />
[https://translate.google.com/translate?sl=en&tl=pt-br&prev=_t&hl=en&u=http://wiki.apertium.org/wiki/Web_Dictionary_Maintenance Translate to PT-BR with Google Tradução]<br />
<br />
= Introduction =<br />
<br />
Apertium over the years still has deficiencies so that lay people can contribute to increase the base of words in dictionaries, even with simple contributions. Collaboration is the key to developing a tool that serves a huge range of users throughout the world. We believe that it is possible to engage more users and thus give greater impact to the tool within the communities where there is involvement. We will deal in this document with requirements on non-functional and technical objectives regarding the tool proposal.<br />
<br />
;Original Ideias<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code/Easy_dictionary_maintenance<br />
<br />
;Original GSOC2019 Application<br />
: http://wiki.apertium.org/wiki/User:Alessiojr/Easy_dictionary_-_Application-GSOC2019<br />
<br />
;Studant Information<br />
: '''Student:''' Vinícius Silva Nogueira <br /><br />
: '''Unofficial Mentor:''' Alessio Miranda Junior<br /><br />
: '''Telegram/Whatsapp:''' Alessio: +55 (31) 9.8888-7770<br /><br />
: '''E-mail:''' alessio@cefetmg.br or vinicius_snogueira@hotmail.com / viniciussnogueira13@gmail.com<br /><br />
: '''IRC:''' AlessioJr<br /><br />
: '''GTalk:''' alessiojunin@gmail.com<br />
<br />
=Description=<br />
==Abstract:==<br />
The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps away potential contributors. A tool that facilitates the work of dictionaries developers, eliminate computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
Even with several tools that help the way you manage and create dictionaries, Apertium is far from the normal users, who have a huge contribution potential. Or even create a simple way to create contributions to recurring users with advanced knowledge. Although it is a bold plan, and there are several possible and desirable requirements, we will describe some basic premises for this step and that must be respected and aligned with the apertium developer community.<br />
<br />
==Definitions==<br />
:* Lay users do not need to know Apertium's internal structure.<br />
:* Intermediate users need to have a knowledge of dictionary management methodology. <br />
:* Advanced users are those who know the structure of Apertium.<br />
:* Communities are user groups that merge characteristics to the database extension of a dictionary of a specific language.<br />
:* Official dictionaries are dictionaries managed and with seal of the apertium community.<br />
:* Unofficial dictionaries are dictionaries run by an independent community.<br />
:* Test dictionaries are deprived of users to test their contributions.<br />
<br />
==Objectives:==<br />
:* The major goal of the project is to develop a web tool to facilitate the management of the Apertium (XML's) database of integrators for novice and advanced users.<br />
:* New communities of contributions should be able to organize independently of a central command. The command exists but will be distributed.<br />
:* Lay users who feel motivated to contribute, should have an interface that promotes ease in contributing even with limited possibilities.<br />
:* The development of dictionaries should be collaborative and distributed. Each dictionary should have a management community, but a user may have the freedom to disagree and create a new version maintaining a history of the author.<br />
:* Any tool should maintain the traditional Apertium structure and not be interoperable between existing tools.<br />
:* There must be a methodology for communities to maintain the quality of their dictionaries. Although they are distributed the goal is to create a unified and mature dictionary.<br />
<br />
=Technical Objectives:=<br />
:* Develop, initially, monolingual dictionaries but keeping the particular format of each file.<br />
:* Minimize the direct manipulation of XML files, providing features that reduce this need.<br />
:* Making use of GitLab as an administrative and control tool.<br />
<br />
== Git, GitLab and Apertium ==<br />
[[File:Git_flow_demonstration.jpg|thumb|250px|right|Git Flow demonstration]]<br />
As the Apertium files are textual, we had the idea of seeking productivity and using existing and consolidated tools in the world.<br />
The proposal is to build a friendly web interface for lay users, but use git's own Back-End as version control and to make dictionary management GitLab as an administrative tool that already guarantees incredible power for remote collaboration.<br />
<br />
To demonstrate this relationship we will highlight some concepts of Git. Over time there may be several TimeLines:<br />
:* The Official Branch (Master) has the official version of the apertium managed by official developers or maintainers.<br />
:* Users have the power to create new Branches and develop unofficial dictionaries in parallel, creating communities that may from time to time suggest modifications to Brach Master.<br />
:* These requests can be accepted or rejected by maintainers, and this format is recursive and other developers can create unofficial copies of unofficial ones.<br />
:* Integration requests will use the Merge Request concepts present in tools such as GitLab that will be the BackEnd for advanced users.<br />
<br />
=Application-GSOC2019=<br />
===Abstract:===<br />
The idea is to develop the Web tool so that lay users contribute to dictionaries and use Git management with GitLab to manage these changes.<br />
* The focus will be on monolingual dictionaries and bilingual direct relationships.<br />
* Use the Git methodology and propose a guideline or flow for collaborative dictionary management.<br />
* Do not change the current XML format of dictionaries.<br />
<br />
===Why is it you are interested in machine translation?===<br />
<br />
During the graduation course, Professor Aléssio demonstrated the need and opportunity to contribute with open source projects. <br />
He introduced me to Apertium and in my final graduation work I started reading and talking about it. <br />
We started discussing techniques for managing collaboration with the community and currently do not have <br />
as much knowledge about machine translation machines but I have experience in developing applications <br />
and web using collaboration with Git and GitLab.<br />
<br />
===Why are they interested in the Apertium project?===<br />
<br />
I’ve .<br />
<br />
===Which of the published tasks are you interested in?===<br />
<br />
Easy dictionary maintenance.<br />
<br />
===Why should Google and Apertium sponsor it?===<br />
<br />
I .<br />
<br />
===How and who will it benefit in society?===<br />
I .<br />
<br />
===What do you plan to do?===<br />
We are planning to create a web GUI that will facilitate common tasks of creating/modifying dictionaries.<br />
The application will be connected to a Git repository, which will be used as an administrative and version control tool.<br />
<br />
<br />
<br />
'''Development Paradigm:''' MVC Paradigm<br /><br />
'''Program Language:''' Java, JavaScript<br /><br />
'''Persistence:''' XML (Apertium XML Files)<br /><br />
'''Framworks:''' Angular<br /><br />
<br />
===Stages/Milestones===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Week<br />
! Stage<br />
! Description<br />
|-<br />
| 1, 2<br />
| --<br />
| --.<br />
|-<br />
| 2, 3<br />
| --<br />
| --.|<br />
|-<br />
| '''Prototype'''<br />
| Milestone 1<br />
| --<br />
|-<br />
| 5, 6<br />
| --<br />
| --.<br />
|-<br />
| 7<br />
| --<br />
| --.<br />
|-<br />
| 8<br />
| --<br />
| --.<br />
|-<br />
| '''Prototype'''<br />
| Milestone 2<br />
| --<br />
|-<br />
| 9<br />
| --<br />
| --.<br />
|-<br />
| 10<br />
| --<br />
| --.<br />
|-<br />
| 11<br />
| Pré-Release<br />
| --<br />
|-<br />
| '''Prototype'''<br />
| --<br />
| <br />
|-<br />
| 12<br />
| Makeup<br />
| --<br />
|-<br />
| <br />
| '''Final Release'''<br />
|<br />
|}<br />
<br />
===Presentation===<br />
<br />
My name is Vinicius, a Brazilian Student at Federal Center for Technological Education of Minas Gerais - Brazil.<br />
<br />
===Resume of Skills===<br />
<br />
Apertium Knowledge:<br />
<br />
* Study to develop a collaborative tool for apertium.<br />
* A study of actual Apertium process about creating a language pair by the user point of view.<br />
* Analysis of the characteristics of the 2010 project of Aléssio and adaptation to current times.<br />
<br />
Academic Skills:<br />
<br />
* Graduating in Computer Engineering- Federal Center for Technological Education of Minas Gerais – Brazil<br />
<br />
Professional Skills:<br />
<br />
* Language developer: C, Java, JavaScript, PHP, Phyton, PL/SQL.<br />
<br />
Projects for Summer:<br />
<br />
* No professional activities planned.<br />
* Planning to work in GSOC<br />
<br />
=Project=<br />
==Why?==<br />
:* The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps potential contributors away. A tool that facilitates the work of dictionaries developers, eliminate the need of computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
==How can use?==<br />
:* --.<br />
:* --.<br />
:* --.<br />
:* --.<br />
<br />
==What its the plan?==<br />
:* We are planning to create a web GUI that allows the user to develop the basic tasks of dictionaries and translation pairs manipulation in an easy and practical way.<br />
:* We will use Git as an administrative and control tool, allowing the user to contribute to the work of other community members or start your own project.<br />
<br />
==Components ans Technologies==<br />
[[File:ComponentDiagramWebDictionary.jpg|thumb|700px|right|Components Diagram]]<br />
* Actors<br />
** Lay User <br />
** Dictionary Admin <br />
<br />
* UserBrowser <br />
** WebInterface with AngularJS - GUI to easily manipulate the dictionary XML file.<br />
<br />
* Web Dicionary Maintence (APP)<br />
** WebAPI - <br />
** Temporary Database - Temporary database in which the XML file will be loaded with the crosses made.<br />
** JavaGit Connector - <br />
** WebDictionary Controller - <br />
<br />
* Git - <br />
** GitRepository - <br />
** GitLab - <br />
** GitHub -<br />
<br />
==How it Works?==<br />
We will develop a WebInterface to LayUser add words or sugest modifiations.<br />
<br />
*<br />
*<br />
<br />
We are planning to use Git as an administrative and version control tool.<br />
<br />
* All dictionaries releases will be in a single repository and available to any member of the community to continue the work.<br />
* Each user will have your own branch to work on.<br />
* The users will be able to make merge requests with the official branch.<br />
* At first, we will use GitLab (or similar tool) to manage this merges requests. The team who maintain each dictionary will judge if the modifications are valid or not.<br />
<br />
==Example of Interaction - Adding new lemma to a dictionary==<br />
<br />
===1. Choosing an official dictionary and importing it===<br />
The Official Dictionaries page display all available dictionaries in the git repository. Each version correspond to a tag in the master branch.<br />
[[File:Prototype1.png|thumb|250px|none|Choosing an official dictionary and importing it]]<br />
<br />
[[File:Git1.png|thumb|250px|none|Master branch]]<br />
Once imported, the user will name this dictionary and it will appear on the My Dictionaries page.<br />
[[File:Prototype2.png|thumb|250px|none|My Dictionaries page]]<br />
<br />
===2. Loading the dictionary file===<br />
On the Language File page, the user selects one of their dictionaries and the dictionary XML will be formatted to be temporarily saved to a database. Also on this page, the user can edit the dictionary alphabet and see some statistics about it.<br />
<br />
The Symbols, Paradigms, and Lemmas pages refer to the dictionary selected here.<br />
<br />
[[File:Prototype3.png|thumb|250px|none|Loading the dictionary file]]<br />
===3. Verifying if the lemmas already exists===<br />
On the Lemmas - Search page, the user will be able to see all the inflections of the dictionary lemmas and check if the lemma he wants to add already exists.<br />
<br />
[[File:Prototype4.png|thumb|250px|none|Verifying if the lemmas already exists]]<br />
===4. Creating the new lemma===<br />
In the Lemmas - Create page, the user will follow three steps to add a new lemma.<br />
<br />
In the first step, the user will define the lemma and the lemma root. In addition, he will give some examples of inflections and symbols to receive suggestions on which paradigm to use.<br />
<br />
[[File:Prototype5.png|thumb|250px|none|text-top|Creating the new lemma - Step 1]]<br />
In the second step, the user will see paradigm suggestions (or can see all paradigms). When a paradigm is selected, all inflections of the created lemma will be shown to the user. If none of the paradigms fit, the user will be directed to create a new paradigm.<br />
<br />
[[File:Prototype6.png|thumb|250px|none|Creating the new lemma - Step 2]]<br />
In the third and last step, the user will confirm and save the change. At this point, a branch will be create for this dictionary in the git repository (if she doesn’t already exists) and a commit with this changes will be done.<br />
<br />
[[File:Prototype7.png|thumb|250px|none|Creating the new lemma - Step 3]]<br />
===5. Merge Request===<br />
On My Dictionaries page, the user can create a merge request that will be judge by the master branch maintainer.<br />
<br />
[[File:Prototype8.png|thumb|250px|none|Merge Request]]<br />
[[File:Git2.png|thumb|250px|none|New branch created in Git]]<br />
<br />
===6. Official dictionary keeper judges the merge request===<br />
In GitLab (or similar tool), the dictionary maintainer will see the list of merge requests.<br />
[[File:Git5.png|thumb|250px|none|Merge request list]]<br />
At each request, the maintainer can view all commits and accepts only a few of them.<br />
[[File:Git6.png|thumb|250px|none|Commits from current merge request]]<br />
At each commit, he will judge the changes.<br />
[[File:Git7.png|thumb|250px|none|Changes]]<br />
When he accepts the merge request, the user's branch is deleted.<br />
[[File:Git4.png|thumb|250px|none|GitLab Graph]]<br />
<br />
===7. Feedback===<br />
On Merge Requests page, the user can see all request he have made and their status.<br />
<br />
<br />
[[File:Prototype9.png|thumb|250px|none|Feedback]]<br />
<br />
[[Category:GSoC 2019 student proposals|Alessio]]</div>Alessiohttps://wiki.apertium.org/w/index.php?title=Web_Dictionary_Maintenance&diff=69010Web Dictionary Maintenance2019-03-26T01:58:54Z<p>Alessio: /* What do you plan to do? */</p>
<hr />
<div>{{TOCD}}<br />
<br />
[https://translate.google.com/translate?sl=en&tl=pt-br&prev=_t&hl=en&u=http://wiki.apertium.org/wiki/Web_Dictionary_Maintenance Translate to PT-BR with Google Tradução]<br />
<br />
= Introduction =<br />
<br />
Apertium over the years still has deficiencies so that lay people can contribute to increase the base of words in dictionaries, even with simple contributions. Collaboration is the key to developing a tool that serves a huge range of users throughout the world. We believe that it is possible to engage more users and thus give greater impact to the tool within the communities where there is involvement. We will deal in this document with requirements on non-functional and technical objectives regarding the tool proposal.<br />
<br />
;Original Ideias<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code/Easy_dictionary_maintenance<br />
<br />
;Original GSOC2019 Application<br />
: http://wiki.apertium.org/wiki/User:Alessiojr/Easy_dictionary_-_Application-GSOC2019<br />
<br />
;Studant Information<br />
: '''Student:''' Vinícius Silva Nogueira <br /><br />
: '''Unofficial Mentor:''' Alessio Miranda Junior<br /><br />
: '''Telegram/Whatsapp:''' Alessio: +55 (31) 9.8888-7770<br /><br />
: '''E-mail:''' alessio@cefetmg.br or vinicius_snogueira@hotmail.com / viniciussnogueira13@gmail.com<br /><br />
: '''IRC:''' AlessioJr<br /><br />
: '''GTalk:''' alessiojunin@gmail.com<br />
<br />
=Description=<br />
==Abstract:==<br />
The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps away potential contributors. A tool that facilitates the work of dictionaries developers, eliminate computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
Even with several tools that help the way you manage and create dictionaries, Apertium is far from the normal users, who have a huge contribution potential. Or even create a simple way to create contributions to recurring users with advanced knowledge. Although it is a bold plan, and there are several possible and desirable requirements, we will describe some basic premises for this step and that must be respected and aligned with the apertium developer community.<br />
<br />
==Definitions==<br />
:* Lay users do not need to know Apertium's internal structure.<br />
:* Intermediate users need to have a knowledge of dictionary management methodology. <br />
:* Advanced users are those who know the structure of Apertium.<br />
:* Communities are user groups that merge characteristics to the database extension of a dictionary of a specific language.<br />
:* Official dictionaries are dictionaries managed and with seal of the apertium community.<br />
:* Unofficial dictionaries are dictionaries run by an independent community.<br />
:* Test dictionaries are deprived of users to test their contributions.<br />
<br />
==Objectives:==<br />
:* The major goal of the project is to develop a web tool to facilitate the management of the Apertium (XML's) database of integrators for novice and advanced users.<br />
:* New communities of contributions should be able to organize independently of a central command. The command exists but will be distributed.<br />
:* Lay users who feel motivated to contribute, should have an interface that promotes ease in contributing even with limited possibilities.<br />
:* The development of dictionaries should be collaborative and distributed. Each dictionary should have a management community, but a user may have the freedom to disagree and create a new version maintaining a history of the author.<br />
:* Any tool should maintain the traditional Apertium structure and not be interoperable between existing tools.<br />
:* There must be a methodology for communities to maintain the quality of their dictionaries. Although they are distributed the goal is to create a unified and mature dictionary.<br />
<br />
=Technical Objectives:=<br />
:* Develop, initially, monolingual dictionaries but keeping the particular format of each file.<br />
:* Minimize the direct manipulation of XML files, providing features that reduce this need.<br />
:* Making use of GitLab as an administrative and control tool.<br />
<br />
== Git, GitLab and Apertium ==<br />
[[File:Git_flow_demonstration.jpg|thumb|250px|right|Git Flow demonstration]]<br />
As the Apertium files are textual, we had the idea of seeking productivity and using existing and consolidated tools in the world.<br />
The proposal is to build a friendly web interface for lay users, but use git's own Back-End as version control and to make dictionary management GitLab as an administrative tool that already guarantees incredible power for remote collaboration.<br />
<br />
To demonstrate this relationship we will highlight some concepts of Git. Over time there may be several TimeLines:<br />
:* The Official Branch (Master) has the official version of the apertium managed by official developers or maintainers.<br />
:* Users have the power to create new Branches and develop unofficial dictionaries in parallel, creating communities that may from time to time suggest modifications to Brach Master.<br />
:* These requests can be accepted or rejected by maintainers, and this format is recursive and other developers can create unofficial copies of unofficial ones.<br />
:* Integration requests will use the Merge Request concepts present in tools such as GitLab that will be the BackEnd for advanced users.<br />
<br />
=Application-GSOC2019=<br />
===Abstract:===<br />
The idea is to develop the Web tool so that lay users contribute to dictionaries and use Git management with GitLab to manage these changes.<br />
* The focus will be on monolingual dictionaries and bilingual direct relationships.<br />
* Use the Git methodology and propose a guideline or flow for collaborative dictionary management.<br />
* Do not change the current XML format of dictionaries.<br />
<br />
===Why is it you are interested in machine translation?===<br />
<br />
During the graduation course, Professor Aléssio demonstrated the need and opportunity to contribute with open source projects. <br />
He introduced me to Apertium and in my final graduation work I started reading and talking about it. <br />
We started discussing techniques for managing collaboration with the community and currently do not have <br />
as much knowledge about machine translation machines but I have experience in developing applications <br />
and web using collaboration with Git and GitLab.<br />
<br />
===Why are they interested in the Apertium project?===<br />
<br />
I’ve .<br />
<br />
===Which of the published tasks are you interested in?===<br />
<br />
Easy dictionary maintenance.<br />
<br />
===Why should Google and Apertium sponsor it?===<br />
<br />
I .<br />
<br />
===How and who will it benefit in society?===<br />
I .<br />
<br />
===What do you plan to do?===<br />
We are planning to create a web GUI that will facilitate common tasks of creating/modifying dictionaries. The application will be connected to a Git repository, which will be used as an administrative<br />
and version control tool.<br />
<br />
<br />
<br />
'''Development Paradigm:''' MVC Paradigm<br /><br />
'''Program Language:''' Java, JavaScript<br /><br />
'''Persistence:''' XML (Apertium XML Files)<br /><br />
'''Framworks:''' Angular<br /><br />
<br />
===Stages/Milestones===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Week<br />
! Stage<br />
! Description<br />
|-<br />
| 1, 2<br />
| --<br />
| --.<br />
|-<br />
| 2, 3<br />
| --<br />
| --.|<br />
|-<br />
| '''Prototype'''<br />
| Milestone 1<br />
| --<br />
|-<br />
| 5, 6<br />
| --<br />
| --.<br />
|-<br />
| 7<br />
| --<br />
| --.<br />
|-<br />
| 8<br />
| --<br />
| --.<br />
|-<br />
| '''Prototype'''<br />
| Milestone 2<br />
| --<br />
|-<br />
| 9<br />
| --<br />
| --.<br />
|-<br />
| 10<br />
| --<br />
| --.<br />
|-<br />
| 11<br />
| Pré-Release<br />
| --<br />
|-<br />
| '''Prototype'''<br />
| --<br />
| <br />
|-<br />
| 12<br />
| Makeup<br />
| --<br />
|-<br />
| <br />
| '''Final Release'''<br />
|<br />
|}<br />
<br />
===Presentation===<br />
<br />
My name is Vinicius, a Brazilian Student at Federal Center for Technological Education of Minas Gerais - Brazil.<br />
<br />
===Resume of Skills===<br />
<br />
Apertium Knowledge:<br />
<br />
* Study to develop a collaborative tool for apertium.<br />
* A study of actual Apertium process about creating a language pair by the user point of view.<br />
* Analysis of the characteristics of the 2010 project of Aléssio and adaptation to current times.<br />
<br />
Academic Skills:<br />
<br />
* Graduating in Computer Engineering- Federal Center for Technological Education of Minas Gerais – Brazil<br />
<br />
Professional Skills:<br />
<br />
* Language developer: C, Java, JavaScript, PHP, Phyton, PL/SQL.<br />
<br />
Projects for Summer:<br />
<br />
* No professional activities planned.<br />
* Planning to work in GSOC<br />
<br />
=Project=<br />
==Why?==<br />
:* The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps potential contributors away. A tool that facilitates the work of dictionaries developers, eliminate the need of computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
==How can use?==<br />
:* --.<br />
:* --.<br />
:* --.<br />
:* --.<br />
<br />
==What its the plan?==<br />
:* We are planning to create a web GUI that allows the user to develop the basic tasks of dictionaries and translation pairs manipulation in an easy and practical way.<br />
:* We will use Git as an administrative and control tool, allowing the user to contribute to the work of other community members or start your own project.<br />
<br />
==Components ans Technologies==<br />
[[File:ComponentDiagramWebDictionary.jpg|thumb|700px|right|Components Diagram]]<br />
* Actors<br />
** Lay User <br />
** Dictionary Admin <br />
<br />
* UserBrowser <br />
** WebInterface with AngularJS - GUI to easily manipulate the dictionary XML file.<br />
<br />
* Web Dicionary Maintence (APP)<br />
** WebAPI - <br />
** Temporary Database - Temporary database in which the XML file will be loaded with the crosses made.<br />
** JavaGit Connector - <br />
** WebDictionary Controller - <br />
<br />
* Git - <br />
** GitRepository - <br />
** GitLab - <br />
** GitHub -<br />
<br />
==How it Works?==<br />
We will develop a WebInterface to LayUser add words or sugest modifiations.<br />
<br />
*<br />
*<br />
<br />
We are planning to use Git as an administrative and version control tool.<br />
<br />
* All dictionaries releases will be in a single repository and available to any member of the community to continue the work.<br />
* Each user will have your own branch to work on.<br />
* The users will be able to make merge requests with the official branch.<br />
* At first, we will use GitLab (or similar tool) to manage this merges requests. The team who maintain each dictionary will judge if the modifications are valid or not.<br />
<br />
==Example of Interaction - Adding new lemma to a dictionary==<br />
<br />
===1. Choosing an official dictionary and importing it===<br />
The Official Dictionaries page display all available dictionaries in the git repository. Each version correspond to a tag in the master branch.<br />
[[File:Prototype1.png|thumb|250px|none|Choosing an official dictionary and importing it]]<br />
<br />
[[File:Git1.png|thumb|250px|none|Master branch]]<br />
Once imported, the user will name this dictionary and it will appear on the My Dictionaries page.<br />
[[File:Prototype2.png|thumb|250px|none|My Dictionaries page]]<br />
<br />
===2. Loading the dictionary file===<br />
On the Language File page, the user selects one of their dictionaries and the dictionary XML will be formatted to be temporarily saved to a database. Also on this page, the user can edit the dictionary alphabet and see some statistics about it.<br />
<br />
The Symbols, Paradigms, and Lemmas pages refer to the dictionary selected here.<br />
<br />
[[File:Prototype3.png|thumb|250px|none|Loading the dictionary file]]<br />
===3. Verifying if the lemmas already exists===<br />
On the Lemmas - Search page, the user will be able to see all the inflections of the dictionary lemmas and check if the lemma he wants to add already exists.<br />
<br />
[[File:Prototype4.png|thumb|250px|none|Verifying if the lemmas already exists]]<br />
===4. Creating the new lemma===<br />
In the Lemmas - Create page, the user will follow three steps to add a new lemma.<br />
<br />
In the first step, the user will define the lemma and the lemma root. In addition, he will give some examples of inflections and symbols to receive suggestions on which paradigm to use.<br />
<br />
[[File:Prototype5.png|thumb|250px|none|text-top|Creating the new lemma - Step 1]]<br />
In the second step, the user will see paradigm suggestions (or can see all paradigms). When a paradigm is selected, all inflections of the created lemma will be shown to the user. If none of the paradigms fit, the user will be directed to create a new paradigm.<br />
<br />
[[File:Prototype6.png|thumb|250px|none|Creating the new lemma - Step 2]]<br />
In the third and last step, the user will confirm and save the change. At this point, a branch will be create for this dictionary in the git repository (if she doesn’t already exists) and a commit with this changes will be done.<br />
<br />
[[File:Prototype7.png|thumb|250px|none|Creating the new lemma - Step 3]]<br />
===5. Merge Request===<br />
On My Dictionaries page, the user can create a merge request that will be judge by the master branch maintainer.<br />
<br />
[[File:Prototype8.png|thumb|250px|none|Merge Request]]<br />
[[File:Git2.png|thumb|250px|none|New branch created in Git]]<br />
<br />
===6. Official dictionary keeper judges the merge request===<br />
In GitLab (or similar tool), the dictionary maintainer will see the list of merge requests.<br />
[[File:Git5.png|thumb|250px|none|Merge request list]]<br />
At each request, the maintainer can view all commits and accepts only a few of them.<br />
[[File:Git6.png|thumb|250px|none|Commits from current merge request]]<br />
At each commit, he will judge the changes.<br />
[[File:Git7.png|thumb|250px|none|Changes]]<br />
When he accepts the merge request, the user's branch is deleted.<br />
[[File:Git4.png|thumb|250px|none|GitLab Graph]]<br />
<br />
===7. Feedback===<br />
On Merge Requests page, the user can see all request he have made and their status.<br />
<br />
<br />
[[File:Prototype9.png|thumb|250px|none|Feedback]]<br />
<br />
[[Category:GSoC 2019 student proposals|Alessio]]</div>Alessiohttps://wiki.apertium.org/w/index.php?title=Web_Dictionary_Maintenance&diff=69009Web Dictionary Maintenance2019-03-26T01:57:03Z<p>Alessio: /* Application-GSOC2019 */</p>
<hr />
<div>{{TOCD}}<br />
<br />
[https://translate.google.com/translate?sl=en&tl=pt-br&prev=_t&hl=en&u=http://wiki.apertium.org/wiki/Web_Dictionary_Maintenance Translate to PT-BR with Google Tradução]<br />
<br />
= Introduction =<br />
<br />
Apertium over the years still has deficiencies so that lay people can contribute to increase the base of words in dictionaries, even with simple contributions. Collaboration is the key to developing a tool that serves a huge range of users throughout the world. We believe that it is possible to engage more users and thus give greater impact to the tool within the communities where there is involvement. We will deal in this document with requirements on non-functional and technical objectives regarding the tool proposal.<br />
<br />
;Original Ideias<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code/Easy_dictionary_maintenance<br />
<br />
;Original GSOC2019 Application<br />
: http://wiki.apertium.org/wiki/User:Alessiojr/Easy_dictionary_-_Application-GSOC2019<br />
<br />
;Studant Information<br />
: '''Student:''' Vinícius Silva Nogueira <br /><br />
: '''Unofficial Mentor:''' Alessio Miranda Junior<br /><br />
: '''Telegram/Whatsapp:''' Alessio: +55 (31) 9.8888-7770<br /><br />
: '''E-mail:''' alessio@cefetmg.br or vinicius_snogueira@hotmail.com / viniciussnogueira13@gmail.com<br /><br />
: '''IRC:''' AlessioJr<br /><br />
: '''GTalk:''' alessiojunin@gmail.com<br />
<br />
=Description=<br />
==Abstract:==<br />
The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps away potential contributors. A tool that facilitates the work of dictionaries developers, eliminate computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
Even with several tools that help the way you manage and create dictionaries, Apertium is far from the normal users, who have a huge contribution potential. Or even create a simple way to create contributions to recurring users with advanced knowledge. Although it is a bold plan, and there are several possible and desirable requirements, we will describe some basic premises for this step and that must be respected and aligned with the apertium developer community.<br />
<br />
==Definitions==<br />
:* Lay users do not need to know Apertium's internal structure.<br />
:* Intermediate users need to have a knowledge of dictionary management methodology. <br />
:* Advanced users are those who know the structure of Apertium.<br />
:* Communities are user groups that merge characteristics to the database extension of a dictionary of a specific language.<br />
:* Official dictionaries are dictionaries managed and with seal of the apertium community.<br />
:* Unofficial dictionaries are dictionaries run by an independent community.<br />
:* Test dictionaries are deprived of users to test their contributions.<br />
<br />
==Objectives:==<br />
:* The major goal of the project is to develop a web tool to facilitate the management of the Apertium (XML's) database of integrators for novice and advanced users.<br />
:* New communities of contributions should be able to organize independently of a central command. The command exists but will be distributed.<br />
:* Lay users who feel motivated to contribute, should have an interface that promotes ease in contributing even with limited possibilities.<br />
:* The development of dictionaries should be collaborative and distributed. Each dictionary should have a management community, but a user may have the freedom to disagree and create a new version maintaining a history of the author.<br />
:* Any tool should maintain the traditional Apertium structure and not be interoperable between existing tools.<br />
:* There must be a methodology for communities to maintain the quality of their dictionaries. Although they are distributed the goal is to create a unified and mature dictionary.<br />
<br />
=Technical Objectives:=<br />
:* Develop, initially, monolingual dictionaries but keeping the particular format of each file.<br />
:* Minimize the direct manipulation of XML files, providing features that reduce this need.<br />
:* Making use of GitLab as an administrative and control tool.<br />
<br />
== Git, GitLab and Apertium ==<br />
[[File:Git_flow_demonstration.jpg|thumb|250px|right|Git Flow demonstration]]<br />
As the Apertium files are textual, we had the idea of seeking productivity and using existing and consolidated tools in the world.<br />
The proposal is to build a friendly web interface for lay users, but use git's own Back-End as version control and to make dictionary management GitLab as an administrative tool that already guarantees incredible power for remote collaboration.<br />
<br />
To demonstrate this relationship we will highlight some concepts of Git. Over time there may be several TimeLines:<br />
:* The Official Branch (Master) has the official version of the apertium managed by official developers or maintainers.<br />
:* Users have the power to create new Branches and develop unofficial dictionaries in parallel, creating communities that may from time to time suggest modifications to Brach Master.<br />
:* These requests can be accepted or rejected by maintainers, and this format is recursive and other developers can create unofficial copies of unofficial ones.<br />
:* Integration requests will use the Merge Request concepts present in tools such as GitLab that will be the BackEnd for advanced users.<br />
<br />
=Application-GSOC2019=<br />
===Abstract:===<br />
The idea is to develop the Web tool so that lay users contribute to dictionaries and use Git management with GitLab to manage these changes.<br />
* The focus will be on monolingual dictionaries and bilingual direct relationships.<br />
* Use the Git methodology and propose a guideline or flow for collaborative dictionary management.<br />
* Do not change the current XML format of dictionaries.<br />
<br />
===Why is it you are interested in machine translation?===<br />
<br />
During the graduation course, Professor Aléssio demonstrated the need and opportunity to contribute with open source projects. <br />
He introduced me to Apertium and in my final graduation work I started reading and talking about it. <br />
We started discussing techniques for managing collaboration with the community and currently do not have <br />
as much knowledge about machine translation machines but I have experience in developing applications <br />
and web using collaboration with Git and GitLab.<br />
<br />
===Why are they interested in the Apertium project?===<br />
<br />
I’ve .<br />
<br />
===Which of the published tasks are you interested in?===<br />
<br />
Easy dictionary maintenance.<br />
<br />
===Why should Google and Apertium sponsor it?===<br />
<br />
I .<br />
<br />
===How and who will it benefit in society?===<br />
I .<br />
<br />
===What do you plan to do?===<br />
We are planning to create a web GUI that will facilitate common tasks of creating/modifying dictionaries. The application will be connected to a Git repository, which will be used as an administration and version control tool.<br />
<br />
<br />
<br />
'''Development Paradigm:''' MVC Paradigm<br /><br />
'''Program Language:''' Java, JavaScript<br /><br />
'''Persistence:''' XML (Apertium XML Files)<br /><br />
'''Framworks:''' Angular<br /><br />
<br />
===Stages/Milestones===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Week<br />
! Stage<br />
! Description<br />
|-<br />
| 1, 2<br />
| --<br />
| --.<br />
|-<br />
| 2, 3<br />
| --<br />
| --.|<br />
|-<br />
| '''Prototype'''<br />
| Milestone 1<br />
| --<br />
|-<br />
| 5, 6<br />
| --<br />
| --.<br />
|-<br />
| 7<br />
| --<br />
| --.<br />
|-<br />
| 8<br />
| --<br />
| --.<br />
|-<br />
| '''Prototype'''<br />
| Milestone 2<br />
| --<br />
|-<br />
| 9<br />
| --<br />
| --.<br />
|-<br />
| 10<br />
| --<br />
| --.<br />
|-<br />
| 11<br />
| Pré-Release<br />
| --<br />
|-<br />
| '''Prototype'''<br />
| --<br />
| <br />
|-<br />
| 12<br />
| Makeup<br />
| --<br />
|-<br />
| <br />
| '''Final Release'''<br />
|<br />
|}<br />
<br />
===Presentation===<br />
<br />
My name is Vinicius, a Brazilian Student at Federal Center for Technological Education of Minas Gerais - Brazil.<br />
<br />
===Resume of Skills===<br />
<br />
Apertium Knowledge:<br />
<br />
* Study to develop a collaborative tool for apertium.<br />
* A study of actual Apertium process about creating a language pair by the user point of view.<br />
* Analysis of the characteristics of the 2010 project of Aléssio and adaptation to current times.<br />
<br />
Academic Skills:<br />
<br />
* Graduating in Computer Engineering- Federal Center for Technological Education of Minas Gerais – Brazil<br />
<br />
Professional Skills:<br />
<br />
* Language developer: C, Java, JavaScript, PHP, Phyton, PL/SQL.<br />
<br />
Projects for Summer:<br />
<br />
* No professional activities planned.<br />
* Planning to work in GSOC<br />
<br />
=Project=<br />
==Why?==<br />
:* The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps potential contributors away. A tool that facilitates the work of dictionaries developers, eliminate the need of computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
==How can use?==<br />
:* --.<br />
:* --.<br />
:* --.<br />
:* --.<br />
<br />
==What its the plan?==<br />
:* We are planning to create a web GUI that allows the user to develop the basic tasks of dictionaries and translation pairs manipulation in an easy and practical way.<br />
:* We will use Git as an administrative and control tool, allowing the user to contribute to the work of other community members or start your own project.<br />
<br />
==Components ans Technologies==<br />
[[File:ComponentDiagramWebDictionary.jpg|thumb|700px|right|Components Diagram]]<br />
* Actors<br />
** Lay User <br />
** Dictionary Admin <br />
<br />
* UserBrowser <br />
** WebInterface with AngularJS - GUI to easily manipulate the dictionary XML file.<br />
<br />
* Web Dicionary Maintence (APP)<br />
** WebAPI - <br />
** Temporary Database - Temporary database in which the XML file will be loaded with the crosses made.<br />
** JavaGit Connector - <br />
** WebDictionary Controller - <br />
<br />
* Git - <br />
** GitRepository - <br />
** GitLab - <br />
** GitHub -<br />
<br />
==How it Works?==<br />
We will develop a WebInterface to LayUser add words or sugest modifiations.<br />
<br />
*<br />
*<br />
<br />
We are planning to use Git as an administrative and version control tool.<br />
<br />
* All dictionaries releases will be in a single repository and available to any member of the community to continue the work.<br />
* Each user will have your own branch to work on.<br />
* The users will be able to make merge requests with the official branch.<br />
* At first, we will use GitLab (or similar tool) to manage this merges requests. The team who maintain each dictionary will judge if the modifications are valid or not.<br />
<br />
==Example of Interaction - Adding new lemma to a dictionary==<br />
<br />
===1. Choosing an official dictionary and importing it===<br />
The Official Dictionaries page display all available dictionaries in the git repository. Each version correspond to a tag in the master branch.<br />
[[File:Prototype1.png|thumb|250px|none|Choosing an official dictionary and importing it]]<br />
<br />
[[File:Git1.png|thumb|250px|none|Master branch]]<br />
Once imported, the user will name this dictionary and it will appear on the My Dictionaries page.<br />
[[File:Prototype2.png|thumb|250px|none|My Dictionaries page]]<br />
<br />
===2. Loading the dictionary file===<br />
On the Language File page, the user selects one of their dictionaries and the dictionary XML will be formatted to be temporarily saved to a database. Also on this page, the user can edit the dictionary alphabet and see some statistics about it.<br />
<br />
The Symbols, Paradigms, and Lemmas pages refer to the dictionary selected here.<br />
<br />
[[File:Prototype3.png|thumb|250px|none|Loading the dictionary file]]<br />
===3. Verifying if the lemmas already exists===<br />
On the Lemmas - Search page, the user will be able to see all the inflections of the dictionary lemmas and check if the lemma he wants to add already exists.<br />
<br />
[[File:Prototype4.png|thumb|250px|none|Verifying if the lemmas already exists]]<br />
===4. Creating the new lemma===<br />
In the Lemmas - Create page, the user will follow three steps to add a new lemma.<br />
<br />
In the first step, the user will define the lemma and the lemma root. In addition, he will give some examples of inflections and symbols to receive suggestions on which paradigm to use.<br />
<br />
[[File:Prototype5.png|thumb|250px|none|text-top|Creating the new lemma - Step 1]]<br />
In the second step, the user will see paradigm suggestions (or can see all paradigms). When a paradigm is selected, all inflections of the created lemma will be shown to the user. If none of the paradigms fit, the user will be directed to create a new paradigm.<br />
<br />
[[File:Prototype6.png|thumb|250px|none|Creating the new lemma - Step 2]]<br />
In the third and last step, the user will confirm and save the change. At this point, a branch will be create for this dictionary in the git repository (if she doesn’t already exists) and a commit with this changes will be done.<br />
<br />
[[File:Prototype7.png|thumb|250px|none|Creating the new lemma - Step 3]]<br />
===5. Merge Request===<br />
On My Dictionaries page, the user can create a merge request that will be judge by the master branch maintainer.<br />
<br />
[[File:Prototype8.png|thumb|250px|none|Merge Request]]<br />
[[File:Git2.png|thumb|250px|none|New branch created in Git]]<br />
<br />
===6. Official dictionary keeper judges the merge request===<br />
In GitLab (or similar tool), the dictionary maintainer will see the list of merge requests.<br />
[[File:Git5.png|thumb|250px|none|Merge request list]]<br />
At each request, the maintainer can view all commits and accepts only a few of them.<br />
[[File:Git6.png|thumb|250px|none|Commits from current merge request]]<br />
At each commit, he will judge the changes.<br />
[[File:Git7.png|thumb|250px|none|Changes]]<br />
When he accepts the merge request, the user's branch is deleted.<br />
[[File:Git4.png|thumb|250px|none|GitLab Graph]]<br />
<br />
===7. Feedback===<br />
On Merge Requests page, the user can see all request he have made and their status.<br />
<br />
<br />
[[File:Prototype9.png|thumb|250px|none|Feedback]]<br />
<br />
[[Category:GSoC 2019 student proposals|Alessio]]</div>Alessiohttps://wiki.apertium.org/w/index.php?title=Web_Dictionary_Maintenance&diff=69008Web Dictionary Maintenance2019-03-26T01:56:07Z<p>Alessio: /* What do you plan to do? */</p>
<hr />
<div>{{TOCD}}<br />
<br />
[https://translate.google.com/translate?sl=en&tl=pt-br&prev=_t&hl=en&u=http://wiki.apertium.org/wiki/Web_Dictionary_Maintenance Translate to PT-BR with Google Tradução]<br />
<br />
= Introduction =<br />
<br />
Apertium over the years still has deficiencies so that lay people can contribute to increase the base of words in dictionaries, even with simple contributions. Collaboration is the key to developing a tool that serves a huge range of users throughout the world. We believe that it is possible to engage more users and thus give greater impact to the tool within the communities where there is involvement. We will deal in this document with requirements on non-functional and technical objectives regarding the tool proposal.<br />
<br />
;Original Ideias<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code/Easy_dictionary_maintenance<br />
<br />
;Original GSOC2019 Application<br />
: http://wiki.apertium.org/wiki/User:Alessiojr/Easy_dictionary_-_Application-GSOC2019<br />
<br />
;Studant Information<br />
: '''Student:''' Vinícius Silva Nogueira <br /><br />
: '''Unofficial Mentor:''' Alessio Miranda Junior<br /><br />
: '''Telegram/Whatsapp:''' Alessio: +55 (31) 9.8888-7770<br /><br />
: '''E-mail:''' alessio@cefetmg.br or vinicius_snogueira@hotmail.com / viniciussnogueira13@gmail.com<br /><br />
: '''IRC:''' AlessioJr<br /><br />
: '''GTalk:''' alessiojunin@gmail.com<br />
<br />
=Description=<br />
==Abstract:==<br />
The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps away potential contributors. A tool that facilitates the work of dictionaries developers, eliminate computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
Even with several tools that help the way you manage and create dictionaries, Apertium is far from the normal users, who have a huge contribution potential. Or even create a simple way to create contributions to recurring users with advanced knowledge. Although it is a bold plan, and there are several possible and desirable requirements, we will describe some basic premises for this step and that must be respected and aligned with the apertium developer community.<br />
<br />
==Definitions==<br />
:* Lay users do not need to know Apertium's internal structure.<br />
:* Intermediate users need to have a knowledge of dictionary management methodology. <br />
:* Advanced users are those who know the structure of Apertium.<br />
:* Communities are user groups that merge characteristics to the database extension of a dictionary of a specific language.<br />
:* Official dictionaries are dictionaries managed and with seal of the apertium community.<br />
:* Unofficial dictionaries are dictionaries run by an independent community.<br />
:* Test dictionaries are deprived of users to test their contributions.<br />
<br />
==Objectives:==<br />
:* The major goal of the project is to develop a web tool to facilitate the management of the Apertium (XML's) database of integrators for novice and advanced users.<br />
:* New communities of contributions should be able to organize independently of a central command. The command exists but will be distributed.<br />
:* Lay users who feel motivated to contribute, should have an interface that promotes ease in contributing even with limited possibilities.<br />
:* The development of dictionaries should be collaborative and distributed. Each dictionary should have a management community, but a user may have the freedom to disagree and create a new version maintaining a history of the author.<br />
:* Any tool should maintain the traditional Apertium structure and not be interoperable between existing tools.<br />
:* There must be a methodology for communities to maintain the quality of their dictionaries. Although they are distributed the goal is to create a unified and mature dictionary.<br />
<br />
=Technical Objectives:=<br />
:* Develop, initially, monolingual dictionaries but keeping the particular format of each file.<br />
:* Minimize the direct manipulation of XML files, providing features that reduce this need.<br />
:* Making use of GitLab as an administrative and control tool.<br />
<br />
== Git, GitLab and Apertium ==<br />
[[File:Git_flow_demonstration.jpg|thumb|250px|right|Git Flow demonstration]]<br />
As the Apertium files are textual, we had the idea of seeking productivity and using existing and consolidated tools in the world.<br />
The proposal is to build a friendly web interface for lay users, but use git's own Back-End as version control and to make dictionary management GitLab as an administrative tool that already guarantees incredible power for remote collaboration.<br />
<br />
To demonstrate this relationship we will highlight some concepts of Git. Over time there may be several TimeLines:<br />
:* The Official Branch (Master) has the official version of the apertium managed by official developers or maintainers.<br />
:* Users have the power to create new Branches and develop unofficial dictionaries in parallel, creating communities that may from time to time suggest modifications to Brach Master.<br />
:* These requests can be accepted or rejected by maintainers, and this format is recursive and other developers can create unofficial copies of unofficial ones.<br />
:* Integration requests will use the Merge Request concepts present in tools such as GitLab that will be the BackEnd for advanced users.<br />
<br />
=Application-GSOC2019=<br />
===Abstract:===<br />
The idea is to develop the Web tool so that lay users contribute to dictionaries and use Git management with GitLab to manage these changes.<br />
* The focus will be on monolingual dictionaries and bilingual direct relationships.<br />
* Use the Git methodology and propose a guideline or flow for collaborative dictionary management.<br />
* Do not change the current XML format of dictionaries.<br />
<br />
===Why is it you are interested in machine translation?===<br />
<br />
During the graduation course, Professor Aléssio demonstrated the need and opportunity to contribute with open source projects. <br />
He introduced me to Apertium and in my final graduation work I started reading and talking about it. <br />
We started discussing techniques for managing collaboration with the community and currently do not have <br />
as much knowledge about machine translation machines but I have experience in developing applications <br />
and web using collaboration with Git and GitLab.<br />
<br />
===Why are they interested in the Apertium project?===<br />
<br />
I’ve .<br />
<br />
===Which of the published tasks are you interested in?===<br />
<br />
Easy dictionary maintenance.<br />
<br />
===Why should Google and Apertium sponsor it?===<br />
<br />
I .<br />
<br />
===How and who will it benefit in society?===<br />
I .<br />
<br />
===What do you plan to do?===<br />
<br />
We are planning to create a web GUI that will facilitate common tasks of creating/modifying dictionaries. The application will be connected to a Git repository, which will be used as an administration and version control tool.<br />
<br />
'''Development Paradigm:''' MVC Paradigm<br /><br />
'''Program Language:''' Java, JavaScript<br /><br />
'''Persistence:''' XML (Apertium XML Files)<br /><br />
'''Framworks:''' Angular<br /><br />
<br />
===Stages/Milestones===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Week<br />
! Stage<br />
! Description<br />
|-<br />
| 1, 2<br />
| --<br />
| --.<br />
|-<br />
| 2, 3<br />
| --<br />
| --.|<br />
|-<br />
| '''Prototype'''<br />
| Milestone 1<br />
| --<br />
|-<br />
| 5, 6<br />
| --<br />
| --.<br />
|-<br />
| 7<br />
| --<br />
| --.<br />
|-<br />
| 8<br />
| --<br />
| --.<br />
|-<br />
| '''Prototype'''<br />
| Milestone 2<br />
| --<br />
|-<br />
| 9<br />
| --<br />
| --.<br />
|-<br />
| 10<br />
| --<br />
| --.<br />
|-<br />
| 11<br />
| Pré-Release<br />
| --<br />
|-<br />
| '''Prototype'''<br />
| --<br />
| <br />
|-<br />
| 12<br />
| Makeup<br />
| --<br />
|-<br />
| <br />
| '''Final Release'''<br />
|<br />
|}<br />
<br />
===Presentation===<br />
<br />
My name is Vinicius, a Brazilian Student at Federal Center for Technological Education of Minas Gerais - Brazil.<br />
<br />
===Resume of Skills===<br />
<br />
Apertium Knowledge:<br />
<br />
* Study to develop a collaborative tool for apertium.<br />
* A study of actual Apertium process about creating a language pair by the user point of view.<br />
* Analysis of the characteristics of the 2010 project of Aléssio and adaptation to current times.<br />
<br />
Academic Skills:<br />
<br />
* Graduating in Computer Engineering- Federal Center for Technological Education of Minas Gerais – Brazil<br />
<br />
Professional Skills:<br />
<br />
* Language developer: C, Java, JavaScript, PHP, Phyton, PL/SQL.<br />
<br />
Projects for Summer:<br />
<br />
* No professional activities planned.<br />
* Planning to work in GSOC<br />
<br />
=Project=<br />
==Why?==<br />
:* The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps potential contributors away. A tool that facilitates the work of dictionaries developers, eliminate the need of computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
==How can use?==<br />
:* --.<br />
:* --.<br />
:* --.<br />
:* --.<br />
<br />
==What its the plan?==<br />
:* We are planning to create a web GUI that allows the user to develop the basic tasks of dictionaries and translation pairs manipulation in an easy and practical way.<br />
:* We will use Git as an administrative and control tool, allowing the user to contribute to the work of other community members or start your own project.<br />
<br />
==Components ans Technologies==<br />
[[File:ComponentDiagramWebDictionary.jpg|thumb|700px|right|Components Diagram]]<br />
* Actors<br />
** Lay User <br />
** Dictionary Admin <br />
<br />
* UserBrowser <br />
** WebInterface with AngularJS - GUI to easily manipulate the dictionary XML file.<br />
<br />
* Web Dicionary Maintence (APP)<br />
** WebAPI - <br />
** Temporary Database - Temporary database in which the XML file will be loaded with the crosses made.<br />
** JavaGit Connector - <br />
** WebDictionary Controller - <br />
<br />
* Git - <br />
** GitRepository - <br />
** GitLab - <br />
** GitHub -<br />
<br />
==How it Works?==<br />
We will develop a WebInterface to LayUser add words or sugest modifiations.<br />
<br />
*<br />
*<br />
<br />
We are planning to use Git as an administrative and version control tool.<br />
<br />
* All dictionaries releases will be in a single repository and available to any member of the community to continue the work.<br />
* Each user will have your own branch to work on.<br />
* The users will be able to make merge requests with the official branch.<br />
* At first, we will use GitLab (or similar tool) to manage this merges requests. The team who maintain each dictionary will judge if the modifications are valid or not.<br />
<br />
==Example of Interaction - Adding new lemma to a dictionary==<br />
<br />
===1. Choosing an official dictionary and importing it===<br />
The Official Dictionaries page display all available dictionaries in the git repository. Each version correspond to a tag in the master branch.<br />
[[File:Prototype1.png|thumb|250px|none|Choosing an official dictionary and importing it]]<br />
<br />
[[File:Git1.png|thumb|250px|none|Master branch]]<br />
Once imported, the user will name this dictionary and it will appear on the My Dictionaries page.<br />
[[File:Prototype2.png|thumb|250px|none|My Dictionaries page]]<br />
<br />
===2. Loading the dictionary file===<br />
On the Language File page, the user selects one of their dictionaries and the dictionary XML will be formatted to be temporarily saved to a database. Also on this page, the user can edit the dictionary alphabet and see some statistics about it.<br />
<br />
The Symbols, Paradigms, and Lemmas pages refer to the dictionary selected here.<br />
<br />
[[File:Prototype3.png|thumb|250px|none|Loading the dictionary file]]<br />
===3. Verifying if the lemmas already exists===<br />
On the Lemmas - Search page, the user will be able to see all the inflections of the dictionary lemmas and check if the lemma he wants to add already exists.<br />
<br />
[[File:Prototype4.png|thumb|250px|none|Verifying if the lemmas already exists]]<br />
===4. Creating the new lemma===<br />
In the Lemmas - Create page, the user will follow three steps to add a new lemma.<br />
<br />
In the first step, the user will define the lemma and the lemma root. In addition, he will give some examples of inflections and symbols to receive suggestions on which paradigm to use.<br />
<br />
[[File:Prototype5.png|thumb|250px|none|text-top|Creating the new lemma - Step 1]]<br />
In the second step, the user will see paradigm suggestions (or can see all paradigms). When a paradigm is selected, all inflections of the created lemma will be shown to the user. If none of the paradigms fit, the user will be directed to create a new paradigm.<br />
<br />
[[File:Prototype6.png|thumb|250px|none|Creating the new lemma - Step 2]]<br />
In the third and last step, the user will confirm and save the change. At this point, a branch will be create for this dictionary in the git repository (if she doesn’t already exists) and a commit with this changes will be done.<br />
<br />
[[File:Prototype7.png|thumb|250px|none|Creating the new lemma - Step 3]]<br />
===5. Merge Request===<br />
On My Dictionaries page, the user can create a merge request that will be judge by the master branch maintainer.<br />
<br />
[[File:Prototype8.png|thumb|250px|none|Merge Request]]<br />
[[File:Git2.png|thumb|250px|none|New branch created in Git]]<br />
<br />
===6. Official dictionary keeper judges the merge request===<br />
In GitLab (or similar tool), the dictionary maintainer will see the list of merge requests.<br />
[[File:Git5.png|thumb|250px|none|Merge request list]]<br />
At each request, the maintainer can view all commits and accepts only a few of them.<br />
[[File:Git6.png|thumb|250px|none|Commits from current merge request]]<br />
At each commit, he will judge the changes.<br />
[[File:Git7.png|thumb|250px|none|Changes]]<br />
When he accepts the merge request, the user's branch is deleted.<br />
[[File:Git4.png|thumb|250px|none|GitLab Graph]]<br />
<br />
===7. Feedback===<br />
On Merge Requests page, the user can see all request he have made and their status.<br />
<br />
<br />
[[File:Prototype9.png|thumb|250px|none|Feedback]]<br />
<br />
[[Category:GSoC 2019 student proposals|Alessio]]</div>Alessiohttps://wiki.apertium.org/w/index.php?title=Web_Dictionary_Maintenance&diff=69007Web Dictionary Maintenance2019-03-26T00:35:36Z<p>Alessio: /* Example of Iteraction - Adding new lemma to a dictionary */</p>
<hr />
<div>{{TOCD}}<br />
<br />
[https://translate.google.com/translate?sl=en&tl=pt-br&prev=_t&hl=en&u=http://wiki.apertium.org/wiki/Web_Dictionary_Maintenance Translate to PT-BR with Google Tradução]<br />
<br />
= Introduction =<br />
<br />
Apertium over the years still has deficiencies so that lay people can contribute to increase the base of words in dictionaries, even with simple contributions. Collaboration is the key to developing a tool that serves a huge range of users throughout the world. We believe that it is possible to engage more users and thus give greater impact to the tool within the communities where there is involvement. We will deal in this document with requirements on non-functional and technical objectives regarding the tool proposal.<br />
<br />
;Original Ideias<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code/Easy_dictionary_maintenance<br />
<br />
;Original GSOC2019 Application<br />
: http://wiki.apertium.org/wiki/User:Alessiojr/Easy_dictionary_-_Application-GSOC2019<br />
<br />
;Studant Information<br />
: '''Student:''' Vinícius Silva Nogueira <br /><br />
: '''Unofficial Mentor:''' Alessio Miranda Junior<br /><br />
: '''Telegram/Whatsapp:''' Alessio: +55 (31) 9.8888-7770<br /><br />
: '''E-mail:''' alessio@cefetmg.br or vinicius_snogueira@hotmail.com / viniciussnogueira13@gmail.com<br /><br />
: '''IRC:''' AlessioJr<br /><br />
: '''GTalk:''' alessiojunin@gmail.com<br />
<br />
=Description=<br />
==Abstract:==<br />
The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps away potential contributors. A tool that facilitates the work of dictionaries developers, eliminate computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
Even with several tools that help the way you manage and create dictionaries, Apertium is far from the normal users, who have a huge contribution potential. Or even create a simple way to create contributions to recurring users with advanced knowledge. Although it is a bold plan, and there are several possible and desirable requirements, we will describe some basic premises for this step and that must be respected and aligned with the apertium developer community.<br />
<br />
==Definitions==<br />
:* Lay users do not need to know Apertium's internal structure.<br />
:* Intermediate users need to have a knowledge of dictionary management methodology. <br />
:* Advanced users are those who know the structure of Apertium.<br />
:* Communities are user groups that merge characteristics to the database extension of a dictionary of a specific language.<br />
:* Official dictionaries are dictionaries managed and with seal of the apertium community.<br />
:* Unofficial dictionaries are dictionaries run by an independent community.<br />
:* Test dictionaries are deprived of users to test their contributions.<br />
<br />
==Objectives:==<br />
:* The major goal of the project is to develop a web tool to facilitate the management of the Apertium (XML's) database of integrators for novice and advanced users.<br />
:* New communities of contributions should be able to organize independently of a central command. The command exists but will be distributed.<br />
:* Lay users who feel motivated to contribute, should have an interface that promotes ease in contributing even with limited possibilities.<br />
:* The development of dictionaries should be collaborative and distributed. Each dictionary should have a management community, but a user may have the freedom to disagree and create a new version maintaining a history of the author.<br />
:* Any tool should maintain the traditional Apertium structure and not be interoperable between existing tools.<br />
:* There must be a methodology for communities to maintain the quality of their dictionaries. Although they are distributed the goal is to create a unified and mature dictionary.<br />
<br />
=Technical Objectives:=<br />
:* Develop, initially, monolingual dictionaries but keeping the particular format of each file.<br />
:* Minimize the direct manipulation of XML files, providing features that reduce this need.<br />
:* Making use of GitLab as an administrative and control tool.<br />
<br />
== Git, GitLab and Apertium ==<br />
[[File:Git_flow_demonstration.jpg|thumb|250px|right|Git Flow demonstration]]<br />
As the Apertium files are textual, we had the idea of seeking productivity and using existing and consolidated tools in the world.<br />
The proposal is to build a friendly web interface for lay users, but use git's own Back-End as version control and to make dictionary management GitLab as an administrative tool that already guarantees incredible power for remote collaboration.<br />
<br />
To demonstrate this relationship we will highlight some concepts of Git. Over time there may be several TimeLines:<br />
:* The Official Branch (Master) has the official version of the apertium managed by official developers or maintainers.<br />
:* Users have the power to create new Branches and develop unofficial dictionaries in parallel, creating communities that may from time to time suggest modifications to Brach Master.<br />
:* These requests can be accepted or rejected by maintainers, and this format is recursive and other developers can create unofficial copies of unofficial ones.<br />
:* Integration requests will use the Merge Request concepts present in tools such as GitLab that will be the BackEnd for advanced users.<br />
<br />
=Application-GSOC2019=<br />
===Abstract:===<br />
The idea is to develop the Web tool so that lay users contribute to dictionaries and use Git management with GitLab to manage these changes.<br />
* The focus will be on monolingual dictionaries and bilingual direct relationships.<br />
* Use the Git methodology and propose a guideline or flow for collaborative dictionary management.<br />
* Do not change the current XML format of dictionaries.<br />
<br />
===Why is it you are interested in machine translation?===<br />
<br />
During the graduation course, Professor Aléssio demonstrated the need and opportunity to contribute with open source projects. <br />
He introduced me to Apertium and in my final graduation work I started reading and talking about it. <br />
We started discussing techniques for managing collaboration with the community and currently do not have <br />
as much knowledge about machine translation machines but I have experience in developing applications <br />
and web using collaboration with Git and GitLab.<br />
<br />
===Why are they interested in the Apertium project?===<br />
<br />
I’ve .<br />
<br />
===Which of the published tasks are you interested in?===<br />
<br />
Easy dictionary maintenance.<br />
<br />
===Why should Google and Apertium sponsor it?===<br />
<br />
I .<br />
<br />
===How and who will it benefit in society?===<br />
I .<br />
<br />
===What do you plan to do?===<br />
<br />
We.<br />
<br />
'''Development Paradigm:''' MVC Paradigm<br /><br />
'''Program Language:''' Java, JavaScript<br /><br />
'''Persistence:''' XML (Apertium XML Files)<br /><br />
'''Framworks:''' Angular<br /><br />
<br />
===Stages/Milestones===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Week<br />
! Stage<br />
! Description<br />
|-<br />
| 1, 2<br />
| --<br />
| --.<br />
|-<br />
| 2, 3<br />
| --<br />
| --.|<br />
|-<br />
| '''Prototype'''<br />
| Milestone 1<br />
| --<br />
|-<br />
| 5, 6<br />
| --<br />
| --.<br />
|-<br />
| 7<br />
| --<br />
| --.<br />
|-<br />
| 8<br />
| --<br />
| --.<br />
|-<br />
| '''Prototype'''<br />
| Milestone 2<br />
| --<br />
|-<br />
| 9<br />
| --<br />
| --.<br />
|-<br />
| 10<br />
| --<br />
| --.<br />
|-<br />
| 11<br />
| Pré-Release<br />
| --<br />
|-<br />
| '''Prototype'''<br />
| --<br />
| <br />
|-<br />
| 12<br />
| Makeup<br />
| --<br />
|-<br />
| <br />
| '''Final Release'''<br />
|<br />
|}<br />
<br />
===Presentation===<br />
<br />
My name is Vinicius, a Brazilian Student at Federal Center for Technological Education of Minas Gerais - Brazil.<br />
<br />
===Resume of Skills===<br />
<br />
Apertium Knowledge:<br />
<br />
* Study to develop a collaborative tool for apertium.<br />
* A study of actual Apertium process about creating a language pair by the user point of view.<br />
* Analysis of the characteristics of the 2010 project of Aléssio and adaptation to current times.<br />
<br />
Academic Skills:<br />
<br />
* Graduating in Computer Engineering- Federal Center for Technological Education of Minas Gerais – Brazil<br />
<br />
Professional Skills:<br />
<br />
* Language developer: C, Java, JavaScript, PHP, Phyton, PL/SQL.<br />
<br />
Projects for Summer:<br />
<br />
* No professional activities planned.<br />
* Planning to work in GSOC<br />
<br />
=Project=<br />
==Why?==<br />
:* The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps potential contributors away. A tool that facilitates the work of dictionaries developers, eliminate the need of computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
==How can use?==<br />
:* --.<br />
:* --.<br />
:* --.<br />
:* --.<br />
<br />
==What its the plan?==<br />
:* We are planning to create a web GUI that allows the user to develop the basic tasks of dictionaries and translation pairs manipulation in an easy and practical way.<br />
:* We will use Git as an administrative and control tool, allowing the user to contribute to the work of other community members or start your own project.<br />
<br />
==Components ans Technologies==<br />
[[File:ComponentDiagramWebDictionary.jpg|thumb|700px|right|Components Diagram]]<br />
* Actors<br />
** Lay User <br />
** Dictionary Admin <br />
<br />
* UserBrowser <br />
** WebInterface with AngularJS - GUI to easily manipulate the dictionary XML file.<br />
<br />
* Web Dicionary Maintence (APP)<br />
** WebAPI - <br />
** Temporary Database - Temporary database in which the XML file will be loaded with the crosses made.<br />
** JavaGit Connector - <br />
** WebDictionary Controller - <br />
<br />
* Git - <br />
** GitRepository - <br />
** GitLab - <br />
** GitHub -<br />
<br />
==How it Works?==<br />
We will develop a WebInterface to LayUser add words or sugest modifiations.<br />
<br />
*<br />
*<br />
<br />
We are planning to use Git as an administrative and version control tool.<br />
<br />
* All dictionaries releases will be in a single repository and available to any member of the community to continue the work.<br />
* Each user will have your own branch to work on.<br />
* The users will be able to make merge requests with the official branch.<br />
* At first, we will use GitLab (or similar tool) to manage this merges requests. The team who maintain each dictionary will judge if the modifications are valid or not.<br />
<br />
==Example of Interaction - Adding new lemma to a dictionary==<br />
<br />
===1. Choosing an official dictionary and importing it===<br />
The Official Dictionaries page display all available dictionaries in the git repository. Each version correspond to a tag in the master branch.<br />
[[File:Prototype1.png|thumb|250px|none|Choosing an official dictionary and importing it]]<br />
<br />
[[File:Git1.png|thumb|250px|none|Master branch]]<br />
Once imported, the user will name this dictionary and it will appear on the My Dictionaries page.<br />
[[File:Prototype2.png|thumb|250px|none|My Dictionaries page]]<br />
<br />
===2. Loading the dictionary file===<br />
On the Language File page, the user selects one of their dictionaries and the dictionary XML will be formatted to be temporarily saved to a database. Also on this page, the user can edit the dictionary alphabet and see some statistics about it.<br />
<br />
The Symbols, Paradigms, and Lemmas pages refer to the dictionary selected here.<br />
<br />
[[File:Prototype3.png|thumb|250px|none|Loading the dictionary file]]<br />
===3. Verifying if the lemmas already exists===<br />
On the Lemmas - Search page, the user will be able to see all the inflections of the dictionary lemmas and check if the lemma he wants to add already exists.<br />
<br />
[[File:Prototype4.png|thumb|250px|none|Verifying if the lemmas already exists]]<br />
===4. Creating the new lemma===<br />
In the Lemmas - Create page, the user will follow three steps to add a new lemma.<br />
<br />
In the first step, the user will define the lemma and the lemma root. In addition, he will give some examples of inflections and symbols to receive suggestions on which paradigm to use.<br />
<br />
[[File:Prototype5.png|thumb|250px|none|text-top|Creating the new lemma - Step 1]]<br />
In the second step, the user will see paradigm suggestions (or can see all paradigms). When a paradigm is selected, all inflections of the created lemma will be shown to the user. If none of the paradigms fit, the user will be directed to create a new paradigm.<br />
<br />
[[File:Prototype6.png|thumb|250px|none|Creating the new lemma - Step 2]]<br />
In the third and last step, the user will confirm and save the change. At this point, a branch will be create for this dictionary in the git repository (if she doesn’t already exists) and a commit with this changes will be done.<br />
<br />
[[File:Prototype7.png|thumb|250px|none|Creating the new lemma - Step 3]]<br />
===5. Merge Request===<br />
On My Dictionaries page, the user can create a merge request that will be judge by the master branch maintainer.<br />
<br />
[[File:Prototype8.png|thumb|250px|none|Merge Request]]<br />
[[File:Git2.png|thumb|250px|none|New branch created in Git]]<br />
<br />
===6. Official dictionary keeper judges the merge request===<br />
In GitLab (or similar tool), the dictionary maintainer will see the list of merge requests.<br />
[[File:Git5.png|thumb|250px|none|Merge request list]]<br />
At each request, the maintainer can view all commits and accepts only a few of them.<br />
[[File:Git6.png|thumb|250px|none|Commits from current merge request]]<br />
At each commit, he will judge the changes.<br />
[[File:Git7.png|thumb|250px|none|Changes]]<br />
When he accepts the merge request, the user's branch is deleted.<br />
[[File:Git4.png|thumb|250px|none|GitLab Graph]]<br />
<br />
===7. Feedback===<br />
On Merge Requests page, the user can see all request he have made and their status.<br />
<br />
<br />
[[File:Prototype9.png|thumb|250px|none|Feedback]]<br />
<br />
[[Category:GSoC 2019 student proposals|Alessio]]</div>Alessiohttps://wiki.apertium.org/w/index.php?title=Web_Dictionary_Maintenance&diff=69006Web Dictionary Maintenance2019-03-26T00:32:27Z<p>Alessio: /* Introduction */</p>
<hr />
<div>{{TOCD}}<br />
<br />
[https://translate.google.com/translate?sl=en&tl=pt-br&prev=_t&hl=en&u=http://wiki.apertium.org/wiki/Web_Dictionary_Maintenance Translate to PT-BR with Google Tradução]<br />
<br />
= Introduction =<br />
<br />
Apertium over the years still has deficiencies so that lay people can contribute to increase the base of words in dictionaries, even with simple contributions. Collaboration is the key to developing a tool that serves a huge range of users throughout the world. We believe that it is possible to engage more users and thus give greater impact to the tool within the communities where there is involvement. We will deal in this document with requirements on non-functional and technical objectives regarding the tool proposal.<br />
<br />
;Original Ideias<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code/Easy_dictionary_maintenance<br />
<br />
;Original GSOC2019 Application<br />
: http://wiki.apertium.org/wiki/User:Alessiojr/Easy_dictionary_-_Application-GSOC2019<br />
<br />
;Studant Information<br />
: '''Student:''' Vinícius Silva Nogueira <br /><br />
: '''Unofficial Mentor:''' Alessio Miranda Junior<br /><br />
: '''Telegram/Whatsapp:''' Alessio: +55 (31) 9.8888-7770<br /><br />
: '''E-mail:''' alessio@cefetmg.br or vinicius_snogueira@hotmail.com / viniciussnogueira13@gmail.com<br /><br />
: '''IRC:''' AlessioJr<br /><br />
: '''GTalk:''' alessiojunin@gmail.com<br />
<br />
=Description=<br />
==Abstract:==<br />
The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps away potential contributors. A tool that facilitates the work of dictionaries developers, eliminate computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
Even with several tools that help the way you manage and create dictionaries, Apertium is far from the normal users, who have a huge contribution potential. Or even create a simple way to create contributions to recurring users with advanced knowledge. Although it is a bold plan, and there are several possible and desirable requirements, we will describe some basic premises for this step and that must be respected and aligned with the apertium developer community.<br />
<br />
==Definitions==<br />
:* Lay users do not need to know Apertium's internal structure.<br />
:* Intermediate users need to have a knowledge of dictionary management methodology. <br />
:* Advanced users are those who know the structure of Apertium.<br />
:* Communities are user groups that merge characteristics to the database extension of a dictionary of a specific language.<br />
:* Official dictionaries are dictionaries managed and with seal of the apertium community.<br />
:* Unofficial dictionaries are dictionaries run by an independent community.<br />
:* Test dictionaries are deprived of users to test their contributions.<br />
<br />
==Objectives:==<br />
:* The major goal of the project is to develop a web tool to facilitate the management of the Apertium (XML's) database of integrators for novice and advanced users.<br />
:* New communities of contributions should be able to organize independently of a central command. The command exists but will be distributed.<br />
:* Lay users who feel motivated to contribute, should have an interface that promotes ease in contributing even with limited possibilities.<br />
:* The development of dictionaries should be collaborative and distributed. Each dictionary should have a management community, but a user may have the freedom to disagree and create a new version maintaining a history of the author.<br />
:* Any tool should maintain the traditional Apertium structure and not be interoperable between existing tools.<br />
:* There must be a methodology for communities to maintain the quality of their dictionaries. Although they are distributed the goal is to create a unified and mature dictionary.<br />
<br />
=Technical Objectives:=<br />
:* Develop, initially, monolingual dictionaries but keeping the particular format of each file.<br />
:* Minimize the direct manipulation of XML files, providing features that reduce this need.<br />
:* Making use of GitLab as an administrative and control tool.<br />
<br />
== Git, GitLab and Apertium ==<br />
[[File:Git_flow_demonstration.jpg|thumb|250px|right|Git Flow demonstration]]<br />
As the Apertium files are textual, we had the idea of seeking productivity and using existing and consolidated tools in the world.<br />
The proposal is to build a friendly web interface for lay users, but use git's own Back-End as version control and to make dictionary management GitLab as an administrative tool that already guarantees incredible power for remote collaboration.<br />
<br />
To demonstrate this relationship we will highlight some concepts of Git. Over time there may be several TimeLines:<br />
:* The Official Branch (Master) has the official version of the apertium managed by official developers or maintainers.<br />
:* Users have the power to create new Branches and develop unofficial dictionaries in parallel, creating communities that may from time to time suggest modifications to Brach Master.<br />
:* These requests can be accepted or rejected by maintainers, and this format is recursive and other developers can create unofficial copies of unofficial ones.<br />
:* Integration requests will use the Merge Request concepts present in tools such as GitLab that will be the BackEnd for advanced users.<br />
<br />
=Application-GSOC2019=<br />
===Abstract:===<br />
The idea is to develop the Web tool so that lay users contribute to dictionaries and use Git management with GitLab to manage these changes.<br />
* The focus will be on monolingual dictionaries and bilingual direct relationships.<br />
* Use the Git methodology and propose a guideline or flow for collaborative dictionary management.<br />
* Do not change the current XML format of dictionaries.<br />
<br />
===Why is it you are interested in machine translation?===<br />
<br />
During the graduation course, Professor Aléssio demonstrated the need and opportunity to contribute with open source projects. <br />
He introduced me to Apertium and in my final graduation work I started reading and talking about it. <br />
We started discussing techniques for managing collaboration with the community and currently do not have <br />
as much knowledge about machine translation machines but I have experience in developing applications <br />
and web using collaboration with Git and GitLab.<br />
<br />
===Why are they interested in the Apertium project?===<br />
<br />
I’ve .<br />
<br />
===Which of the published tasks are you interested in?===<br />
<br />
Easy dictionary maintenance.<br />
<br />
===Why should Google and Apertium sponsor it?===<br />
<br />
I .<br />
<br />
===How and who will it benefit in society?===<br />
I .<br />
<br />
===What do you plan to do?===<br />
<br />
We.<br />
<br />
'''Development Paradigm:''' MVC Paradigm<br /><br />
'''Program Language:''' Java, JavaScript<br /><br />
'''Persistence:''' XML (Apertium XML Files)<br /><br />
'''Framworks:''' Angular<br /><br />
<br />
===Stages/Milestones===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Week<br />
! Stage<br />
! Description<br />
|-<br />
| 1, 2<br />
| --<br />
| --.<br />
|-<br />
| 2, 3<br />
| --<br />
| --.|<br />
|-<br />
| '''Prototype'''<br />
| Milestone 1<br />
| --<br />
|-<br />
| 5, 6<br />
| --<br />
| --.<br />
|-<br />
| 7<br />
| --<br />
| --.<br />
|-<br />
| 8<br />
| --<br />
| --.<br />
|-<br />
| '''Prototype'''<br />
| Milestone 2<br />
| --<br />
|-<br />
| 9<br />
| --<br />
| --.<br />
|-<br />
| 10<br />
| --<br />
| --.<br />
|-<br />
| 11<br />
| Pré-Release<br />
| --<br />
|-<br />
| '''Prototype'''<br />
| --<br />
| <br />
|-<br />
| 12<br />
| Makeup<br />
| --<br />
|-<br />
| <br />
| '''Final Release'''<br />
|<br />
|}<br />
<br />
===Presentation===<br />
<br />
My name is Vinicius, a Brazilian Student at Federal Center for Technological Education of Minas Gerais - Brazil.<br />
<br />
===Resume of Skills===<br />
<br />
Apertium Knowledge:<br />
<br />
* Study to develop a collaborative tool for apertium.<br />
* A study of actual Apertium process about creating a language pair by the user point of view.<br />
* Analysis of the characteristics of the 2010 project of Aléssio and adaptation to current times.<br />
<br />
Academic Skills:<br />
<br />
* Graduating in Computer Engineering- Federal Center for Technological Education of Minas Gerais – Brazil<br />
<br />
Professional Skills:<br />
<br />
* Language developer: C, Java, JavaScript, PHP, Phyton, PL/SQL.<br />
<br />
Projects for Summer:<br />
<br />
* No professional activities planned.<br />
* Planning to work in GSOC<br />
<br />
=Project=<br />
==Why?==<br />
:* The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps potential contributors away. A tool that facilitates the work of dictionaries developers, eliminate the need of computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
==How can use?==<br />
:* --.<br />
:* --.<br />
:* --.<br />
:* --.<br />
<br />
==What its the plan?==<br />
:* We are planning to create a web GUI that allows the user to develop the basic tasks of dictionaries and translation pairs manipulation in an easy and practical way.<br />
:* We will use Git as an administrative and control tool, allowing the user to contribute to the work of other community members or start your own project.<br />
<br />
==Components ans Technologies==<br />
[[File:ComponentDiagramWebDictionary.jpg|thumb|700px|right|Components Diagram]]<br />
* Actors<br />
** Lay User <br />
** Dictionary Admin <br />
<br />
* UserBrowser <br />
** WebInterface with AngularJS - GUI to easily manipulate the dictionary XML file.<br />
<br />
* Web Dicionary Maintence (APP)<br />
** WebAPI - <br />
** Temporary Database - Temporary database in which the XML file will be loaded with the crosses made.<br />
** JavaGit Connector - <br />
** WebDictionary Controller - <br />
<br />
* Git - <br />
** GitRepository - <br />
** GitLab - <br />
** GitHub -<br />
<br />
==How it Works?==<br />
We will develop a WebInterface to LayUser add words or sugest modifiations.<br />
<br />
*<br />
*<br />
<br />
We are planning to use Git as an administrative and version control tool.<br />
<br />
* All dictionaries releases will be in a single repository and available to any member of the community to continue the work.<br />
* Each user will have your own branch to work on.<br />
* The users will be able to make merge requests with the official branch.<br />
* At first, we will use GitLab (or similar tool) to manage this merges requests. The team who maintain each dictionary will judge if the modifications are valid or not.<br />
<br />
==Example of Iteraction - Adding new lemma to a dictionary==<br />
<br />
===1. Choosing an official dictionary and importing it===<br />
The Official Dictionaries page display all available dictionaries in the git repository. Each version correspond to a tag in the master branch.<br />
[[File:Prototype1.png|thumb|250px|none|Choosing an official dictionary and importing it]]<br />
<br />
[[File:Git1.png|thumb|250px|none|Master branch]]<br />
Once imported, the user will name this dictionary and it will appear on the My Dictionaries page.<br />
[[File:Prototype2.png|thumb|250px|none|My Dictionaries page]]<br />
<br />
===2. Loading the dictionary file===<br />
On the Language File page, the user selects one of their dictionaries and the dictionary XML will be formatted to be temporarily saved to a database. Also on this page, the user can edit the dictionary alphabet and see some statistics about it.<br />
<br />
The Symbols, Paradigms, and Lemmas pages refer to the dictionary selected here.<br />
<br />
[[File:Prototype3.png|thumb|250px|none|Loading the dictionary file]]<br />
===3. Verifying if the lemmas already exists===<br />
On the Lemmas - Search page, the user will be able to see all the inflections of the dictionary lemmas and check if the lemma he wants to add already exists.<br />
<br />
[[File:Prototype4.png|thumb|250px|none|Verifying if the lemmas already exists]]<br />
===4. Creating the new lemma===<br />
In the Lemmas - Create page, the user will follow three steps to add a new lemma.<br />
<br />
In the first step, the user will define the lemma and the lemma root. In addition, he will give some examples of inflections and symbols to receive suggestions on which paradigm to use.<br />
<br />
[[File:Prototype5.png|thumb|250px|none|text-top|Creating the new lemma - Step 1]]<br />
In the second step, the user will see paradigm suggestions (or can see all paradigms). When a paradigm is selected, all inflections of the created lemma will be shown to the user. If none of the paradigms fit, the user will be directed to create a new paradigm.<br />
<br />
[[File:Prototype6.png|thumb|250px|none|Creating the new lemma - Step 2]]<br />
In the third and last step, the user will confirm and save the change. At this point, a branch will be create for this dictionary in the git repository (if she doesn’t already exists) and a commit with this changes will be done.<br />
<br />
[[File:Prototype7.png|thumb|250px|none|Creating the new lemma - Step 3]]<br />
===5. Merge Request===<br />
On My Dictionaries page, the user can create a merge request that will be judge by the master branch maintainer.<br />
<br />
[[File:Prototype8.png|thumb|250px|none|Merge Request]]<br />
[[File:Git2.png|thumb|250px|none|New branch created in Git]]<br />
<br />
===6. Official dictionary keeper judges the merge request===<br />
In GitLab (or similar tool), the dictionary maintainer will see the list of merge requests.<br />
[[File:Git5.png|thumb|250px|none|Merge request list]]<br />
At each request, the maintainer can view all commits and accepts only a few of them.<br />
[[File:Git6.png|thumb|250px|none|Commits from current merge request]]<br />
At each commit, he will judge the changes.<br />
[[File:Git7.png|thumb|250px|none|Changes]]<br />
When he accepts the merge request, the user's branch is deleted.<br />
[[File:Git4.png|thumb|250px|none|GitLab Graph]]<br />
<br />
===7. Feedback===<br />
On Merge Requests page, the user can see all request he have made and their status.<br />
<br />
<br />
[[File:Prototype9.png|thumb|250px|none|Feedback]]<br />
<br />
[[Category:GSoC 2019 student proposals|Alessio]]</div>Alessiohttps://wiki.apertium.org/w/index.php?title=Web_Dictionary_Maintenance&diff=69005Web Dictionary Maintenance2019-03-26T00:29:10Z<p>Alessio: /* First Experiments */</p>
<hr />
<div>{{TOCD}}<br />
<br />
[https://translate.google.com/translate?sl=en&tl=pt-br&prev=_t&hl=en&u=http://wiki.apertium.org/wiki/Web_Dictionary_Maintenance Translate to PT-BR with Google Tradução]<br />
<br />
= Introduction =<br />
<br />
Apertium over the years still has deficiencies so that lay people can contribute to increase the base of words in dictionaries, even with simple contributions. Collaboration is the key to developing a tool that serves a huge range of users throughout the world. We believe that it is possible to engage more users and thus give greater impact to the tool within the communities where there is involvement. We will deal in this document with requirements on non-functional and technical objectives regarding the tool proposal.<br />
<br />
;Original Ideias<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code/Easy_dictionary_maintenance<br />
<br />
;Original GSOC2019 Application<br />
: http://wiki.apertium.org/wiki/User:Alessiojr/Easy_dictionary_-_Application-GSOC2019<br />
<br />
;Studant Information<br />
: '''Student:''' Vinícius Silva Nogueira <br /><br />
: '''Unofficial Mentor:''' Alessio Miranda Junior<br /><br />
: '''Telegram/Whatsapp:''' Alessio: +55 (31) 9.8888-7770<br /><br />
: '''E-mail:''' alessio@cefetmg.br or viniciussnogueira13@gmail.com<br /><br />
: '''IRC:''' AlessioJr<br /><br />
: '''GTalk:''' alessiojunin@gmail.com<br />
<br />
=Description=<br />
==Abstract:==<br />
The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps away potential contributors. A tool that facilitates the work of dictionaries developers, eliminate computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
Even with several tools that help the way you manage and create dictionaries, Apertium is far from the normal users, who have a huge contribution potential. Or even create a simple way to create contributions to recurring users with advanced knowledge. Although it is a bold plan, and there are several possible and desirable requirements, we will describe some basic premises for this step and that must be respected and aligned with the apertium developer community.<br />
<br />
==Definitions==<br />
:* Lay users do not need to know Apertium's internal structure.<br />
:* Intermediate users need to have a knowledge of dictionary management methodology. <br />
:* Advanced users are those who know the structure of Apertium.<br />
:* Communities are user groups that merge characteristics to the database extension of a dictionary of a specific language.<br />
:* Official dictionaries are dictionaries managed and with seal of the apertium community.<br />
:* Unofficial dictionaries are dictionaries run by an independent community.<br />
:* Test dictionaries are deprived of users to test their contributions.<br />
<br />
==Objectives:==<br />
:* The major goal of the project is to develop a web tool to facilitate the management of the Apertium (XML's) database of integrators for novice and advanced users.<br />
:* New communities of contributions should be able to organize independently of a central command. The command exists but will be distributed.<br />
:* Lay users who feel motivated to contribute, should have an interface that promotes ease in contributing even with limited possibilities.<br />
:* The development of dictionaries should be collaborative and distributed. Each dictionary should have a management community, but a user may have the freedom to disagree and create a new version maintaining a history of the author.<br />
:* Any tool should maintain the traditional Apertium structure and not be interoperable between existing tools.<br />
:* There must be a methodology for communities to maintain the quality of their dictionaries. Although they are distributed the goal is to create a unified and mature dictionary.<br />
<br />
=Technical Objectives:=<br />
:* Develop, initially, monolingual dictionaries but keeping the particular format of each file.<br />
:* Minimize the direct manipulation of XML files, providing features that reduce this need.<br />
:* Making use of GitLab as an administrative and control tool.<br />
<br />
== Git, GitLab and Apertium ==<br />
[[File:Git_flow_demonstration.jpg|thumb|250px|right|Git Flow demonstration]]<br />
As the Apertium files are textual, we had the idea of seeking productivity and using existing and consolidated tools in the world.<br />
The proposal is to build a friendly web interface for lay users, but use git's own Back-End as version control and to make dictionary management GitLab as an administrative tool that already guarantees incredible power for remote collaboration.<br />
<br />
To demonstrate this relationship we will highlight some concepts of Git. Over time there may be several TimeLines:<br />
:* The Official Branch (Master) has the official version of the apertium managed by official developers or maintainers.<br />
:* Users have the power to create new Branches and develop unofficial dictionaries in parallel, creating communities that may from time to time suggest modifications to Brach Master.<br />
:* These requests can be accepted or rejected by maintainers, and this format is recursive and other developers can create unofficial copies of unofficial ones.<br />
:* Integration requests will use the Merge Request concepts present in tools such as GitLab that will be the BackEnd for advanced users.<br />
<br />
=Application-GSOC2019=<br />
===Abstract:===<br />
The idea is to develop the Web tool so that lay users contribute to dictionaries and use Git management with GitLab to manage these changes.<br />
* The focus will be on monolingual dictionaries and bilingual direct relationships.<br />
* Use the Git methodology and propose a guideline or flow for collaborative dictionary management.<br />
* Do not change the current XML format of dictionaries.<br />
<br />
===Why is it you are interested in machine translation?===<br />
<br />
During the graduation course, Professor Aléssio demonstrated the need and opportunity to contribute with open source projects. <br />
He introduced me to Apertium and in my final graduation work I started reading and talking about it. <br />
We started discussing techniques for managing collaboration with the community and currently do not have <br />
as much knowledge about machine translation machines but I have experience in developing applications <br />
and web using collaboration with Git and GitLab.<br />
<br />
===Why are they interested in the Apertium project?===<br />
<br />
I’ve .<br />
<br />
===Which of the published tasks are you interested in?===<br />
<br />
Easy dictionary maintenance.<br />
<br />
===Why should Google and Apertium sponsor it?===<br />
<br />
I .<br />
<br />
===How and who will it benefit in society?===<br />
I .<br />
<br />
===What do you plan to do?===<br />
<br />
We.<br />
<br />
'''Development Paradigm:''' MVC Paradigm<br /><br />
'''Program Language:''' Java, JavaScript<br /><br />
'''Persistence:''' XML (Apertium XML Files)<br /><br />
'''Framworks:''' Angular<br /><br />
<br />
===Stages/Milestones===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Week<br />
! Stage<br />
! Description<br />
|-<br />
| 1, 2<br />
| --<br />
| --.<br />
|-<br />
| 2, 3<br />
| --<br />
| --.|<br />
|-<br />
| '''Prototype'''<br />
| Milestone 1<br />
| --<br />
|-<br />
| 5, 6<br />
| --<br />
| --.<br />
|-<br />
| 7<br />
| --<br />
| --.<br />
|-<br />
| 8<br />
| --<br />
| --.<br />
|-<br />
| '''Prototype'''<br />
| Milestone 2<br />
| --<br />
|-<br />
| 9<br />
| --<br />
| --.<br />
|-<br />
| 10<br />
| --<br />
| --.<br />
|-<br />
| 11<br />
| Pré-Release<br />
| --<br />
|-<br />
| '''Prototype'''<br />
| --<br />
| <br />
|-<br />
| 12<br />
| Makeup<br />
| --<br />
|-<br />
| <br />
| '''Final Release'''<br />
|<br />
|}<br />
<br />
===Presentation===<br />
<br />
My name is Vinicius, a Brazilian Student at Federal Center for Technological Education of Minas Gerais - Brazil.<br />
<br />
===Resume of Skills===<br />
<br />
Apertium Knowledge:<br />
<br />
* Study to develop a collaborative tool for apertium.<br />
* A study of actual Apertium process about creating a language pair by the user point of view.<br />
* Analysis of the characteristics of the 2010 project of Aléssio and adaptation to current times.<br />
<br />
Academic Skills:<br />
<br />
* Graduating in Computer Engineering- Federal Center for Technological Education of Minas Gerais – Brazil<br />
<br />
Professional Skills:<br />
<br />
* Language developer: C, Java, JavaScript, PHP, Phyton, PL/SQL.<br />
<br />
Projects for Summer:<br />
<br />
* No professional activities planned.<br />
* Planning to work in GSOC<br />
<br />
=Project=<br />
==Why?==<br />
:* The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps potential contributors away. A tool that facilitates the work of dictionaries developers, eliminate the need of computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
==How can use?==<br />
:* --.<br />
:* --.<br />
:* --.<br />
:* --.<br />
<br />
==What its the plan?==<br />
:* We are planning to create a web GUI that allows the user to develop the basic tasks of dictionaries and translation pairs manipulation in an easy and practical way.<br />
:* We will use Git as an administrative and control tool, allowing the user to contribute to the work of other community members or start your own project.<br />
<br />
==Components ans Technologies==<br />
[[File:ComponentDiagramWebDictionary.jpg|thumb|700px|right|Components Diagram]]<br />
* Actors<br />
** Lay User <br />
** Dictionary Admin <br />
<br />
* UserBrowser <br />
** WebInterface with AngularJS - GUI to easily manipulate the dictionary XML file.<br />
<br />
* Web Dicionary Maintence (APP)<br />
** WebAPI - <br />
** Temporary Database - Temporary database in which the XML file will be loaded with the crosses made.<br />
** JavaGit Connector - <br />
** WebDictionary Controller - <br />
<br />
* Git - <br />
** GitRepository - <br />
** GitLab - <br />
** GitHub -<br />
<br />
==How it Works?==<br />
We will develop a WebInterface to LayUser add words or sugest modifiations.<br />
<br />
*<br />
*<br />
<br />
We are planning to use Git as an administrative and version control tool.<br />
<br />
* All dictionaries releases will be in a single repository and available to any member of the community to continue the work.<br />
* Each user will have your own branch to work on.<br />
* The users will be able to make merge requests with the official branch.<br />
* At first, we will use GitLab (or similar tool) to manage this merges requests. The team who maintain each dictionary will judge if the modifications are valid or not.<br />
<br />
==Example of Iteraction - Adding new lemma to a dictionary==<br />
<br />
===1. Choosing an official dictionary and importing it===<br />
The Official Dictionaries page display all available dictionaries in the git repository. Each version correspond to a tag in the master branch.<br />
[[File:Prototype1.png|thumb|250px|none|Choosing an official dictionary and importing it]]<br />
<br />
[[File:Git1.png|thumb|250px|none|Master branch]]<br />
Once imported, the user will name this dictionary and it will appear on the My Dictionaries page.<br />
[[File:Prototype2.png|thumb|250px|none|My Dictionaries page]]<br />
<br />
===2. Loading the dictionary file===<br />
On the Language File page, the user selects one of their dictionaries and the dictionary XML will be formatted to be temporarily saved to a database. Also on this page, the user can edit the dictionary alphabet and see some statistics about it.<br />
<br />
The Symbols, Paradigms, and Lemmas pages refer to the dictionary selected here.<br />
<br />
[[File:Prototype3.png|thumb|250px|none|Loading the dictionary file]]<br />
===3. Verifying if the lemmas already exists===<br />
On the Lemmas - Search page, the user will be able to see all the inflections of the dictionary lemmas and check if the lemma he wants to add already exists.<br />
<br />
[[File:Prototype4.png|thumb|250px|none|Verifying if the lemmas already exists]]<br />
===4. Creating the new lemma===<br />
In the Lemmas - Create page, the user will follow three steps to add a new lemma.<br />
<br />
In the first step, the user will define the lemma and the lemma root. In addition, he will give some examples of inflections and symbols to receive suggestions on which paradigm to use.<br />
<br />
[[File:Prototype5.png|thumb|250px|none|text-top|Creating the new lemma - Step 1]]<br />
In the second step, the user will see paradigm suggestions (or can see all paradigms). When a paradigm is selected, all inflections of the created lemma will be shown to the user. If none of the paradigms fit, the user will be directed to create a new paradigm.<br />
<br />
[[File:Prototype6.png|thumb|250px|none|Creating the new lemma - Step 2]]<br />
In the third and last step, the user will confirm and save the change. At this point, a branch will be create for this dictionary in the git repository (if she doesn’t already exists) and a commit with this changes will be done.<br />
<br />
[[File:Prototype7.png|thumb|250px|none|Creating the new lemma - Step 3]]<br />
===5. Merge Request===<br />
On My Dictionaries page, the user can create a merge request that will be judge by the master branch maintainer.<br />
<br />
[[File:Prototype8.png|thumb|250px|none|Merge Request]]<br />
[[File:Git2.png|thumb|250px|none|New branch created in Git]]<br />
<br />
===6. Official dictionary keeper judges the merge request===<br />
In GitLab (or similar tool), the dictionary maintainer will see the list of merge requests.<br />
[[File:Git5.png|thumb|250px|none|Merge request list]]<br />
At each request, the maintainer can view all commits and accepts only a few of them.<br />
[[File:Git6.png|thumb|250px|none|Commits from current merge request]]<br />
At each commit, he will judge the changes.<br />
[[File:Git7.png|thumb|250px|none|Changes]]<br />
When he accepts the merge request, the user's branch is deleted.<br />
[[File:Git4.png|thumb|250px|none|GitLab Graph]]<br />
<br />
===7. Feedback===<br />
On Merge Requests page, the user can see all request he have made and their status.<br />
<br />
<br />
[[File:Prototype9.png|thumb|250px|none|Feedback]]<br />
<br />
[[Category:GSoC 2019 student proposals|Alessio]]</div>Alessiohttps://wiki.apertium.org/w/index.php?title=Web_Dictionary_Maintenance&diff=69004Web Dictionary Maintenance2019-03-25T23:10:19Z<p>Alessio: /* 6. Official dictionary keeper judges the merge request */</p>
<hr />
<div>{{TOCD}}<br />
<br />
[https://translate.google.com/translate?sl=en&tl=pt-br&prev=_t&hl=en&u=http://wiki.apertium.org/wiki/Web_Dictionary_Maintenance Translate to PT-BR with Google Tradução]<br />
<br />
= Introduction =<br />
<br />
Apertium over the years still has deficiencies so that lay people can contribute to increase the base of words in dictionaries, even with simple contributions. Collaboration is the key to developing a tool that serves a huge range of users throughout the world. We believe that it is possible to engage more users and thus give greater impact to the tool within the communities where there is involvement. We will deal in this document with requirements on non-functional and technical objectives regarding the tool proposal.<br />
<br />
;Original Ideias<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code/Easy_dictionary_maintenance<br />
<br />
;Original GSOC2019 Application<br />
: http://wiki.apertium.org/wiki/User:Alessiojr/Easy_dictionary_-_Application-GSOC2019<br />
<br />
;Studant Information<br />
: '''Student:''' Vinícius Silva Nogueira <br /><br />
: '''Unofficial Mentor:''' Alessio Miranda Junior<br /><br />
: '''Telegram/Whatsapp:''' Alessio: +55 (31) 9.8888-7770<br /><br />
: '''E-mail:''' alessio@cefetmg.br or viniciussnogueira13@gmail.com<br /><br />
: '''IRC:''' AlessioJr<br /><br />
: '''GTalk:''' alessiojunin@gmail.com<br />
<br />
=Description=<br />
==Abstract:==<br />
The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps away potential contributors. A tool that facilitates the work of dictionaries developers, eliminate computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
Even with several tools that help the way you manage and create dictionaries, Apertium is far from the normal users, who have a huge contribution potential. Or even create a simple way to create contributions to recurring users with advanced knowledge. Although it is a bold plan, and there are several possible and desirable requirements, we will describe some basic premises for this step and that must be respected and aligned with the apertium developer community.<br />
<br />
==Definitions==<br />
:* Lay users do not need to know Apertium's internal structure.<br />
:* Intermediate users need to have a knowledge of dictionary management methodology. <br />
:* Advanced users are those who know the structure of Apertium.<br />
:* Communities are user groups that merge characteristics to the database extension of a dictionary of a specific language.<br />
:* Official dictionaries are dictionaries managed and with seal of the apertium community.<br />
:* Unofficial dictionaries are dictionaries run by an independent community.<br />
:* Test dictionaries are deprived of users to test their contributions.<br />
<br />
==Objectives:==<br />
:* The major goal of the project is to develop a web tool to facilitate the management of the Apertium (XML's) database of integrators for novice and advanced users.<br />
:* New communities of contributions should be able to organize independently of a central command. The command exists but will be distributed.<br />
:* Lay users who feel motivated to contribute, should have an interface that promotes ease in contributing even with limited possibilities.<br />
:* The development of dictionaries should be collaborative and distributed. Each dictionary should have a management community, but a user may have the freedom to disagree and create a new version maintaining a history of the author.<br />
:* Any tool should maintain the traditional Apertium structure and not be interoperable between existing tools.<br />
:* There must be a methodology for communities to maintain the quality of their dictionaries. Although they are distributed the goal is to create a unified and mature dictionary.<br />
<br />
=Technical Objectives:=<br />
:* Develop, initially, monolingual dictionaries but keeping the particular format of each file.<br />
:* Minimize the direct manipulation of XML files, providing features that reduce this need.<br />
:* Making use of GitLab as an administrative and control tool.<br />
<br />
== Git, GitLab and Apertium ==<br />
[[File:Git_flow_demonstration.jpg|thumb|250px|right|Git Flow demonstration]]<br />
As the Apertium files are textual, we had the idea of seeking productivity and using existing and consolidated tools in the world.<br />
The proposal is to build a friendly web interface for lay users, but use git's own Back-End as version control and to make dictionary management GitLab as an administrative tool that already guarantees incredible power for remote collaboration.<br />
<br />
To demonstrate this relationship we will highlight some concepts of Git. Over time there may be several TimeLines:<br />
:* The Official Branch (Master) has the official version of the apertium managed by official developers or maintainers.<br />
:* Users have the power to create new Branches and develop unofficial dictionaries in parallel, creating communities that may from time to time suggest modifications to Brach Master.<br />
:* These requests can be accepted or rejected by maintainers, and this format is recursive and other developers can create unofficial copies of unofficial ones.<br />
:* Integration requests will use the Merge Request concepts present in tools such as GitLab that will be the BackEnd for advanced users.<br />
<br />
=Application-GSOC2019=<br />
===Abstract:===<br />
The idea is to develop the Web tool so that lay users contribute to dictionaries and use Git management with GitLab to manage these changes.<br />
* The focus will be on monolingual dictionaries and bilingual direct relationships.<br />
* Use the Git methodology and propose a guideline or flow for collaborative dictionary management.<br />
* Do not change the current XML format of dictionaries.<br />
<br />
===Why is it you are interested in machine translation?===<br />
<br />
During the graduation course, Professor Aléssio demonstrated the need and opportunity to contribute with open source projects. <br />
He introduced me to Apertium and in my final graduation work I started reading and talking about it. <br />
We started discussing techniques for managing collaboration with the community and currently do not have <br />
as much knowledge about machine translation machines but I have experience in developing applications <br />
and web using collaboration with Git and GitLab.<br />
<br />
===Why are they interested in the Apertium project?===<br />
<br />
I’ve .<br />
<br />
===Which of the published tasks are you interested in?===<br />
<br />
Easy dictionary maintenance.<br />
<br />
===Why should Google and Apertium sponsor it?===<br />
<br />
I .<br />
<br />
===How and who will it benefit in society?===<br />
I .<br />
<br />
===What do you plan to do?===<br />
<br />
We.<br />
<br />
'''Development Paradigm:''' MVC Paradigm<br /><br />
'''Program Language:''' Java, JavaScript<br /><br />
'''Persistence:''' XML (Apertium XML Files)<br /><br />
'''Framworks:''' Angular<br /><br />
<br />
===Stages/Milestones===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Week<br />
! Stage<br />
! Description<br />
|-<br />
| 1, 2<br />
| --<br />
| --.<br />
|-<br />
| 2, 3<br />
| --<br />
| --.|<br />
|-<br />
| '''Prototype'''<br />
| Milestone 1<br />
| --<br />
|-<br />
| 5, 6<br />
| --<br />
| --.<br />
|-<br />
| 7<br />
| --<br />
| --.<br />
|-<br />
| 8<br />
| --<br />
| --.<br />
|-<br />
| '''Prototype'''<br />
| Milestone 2<br />
| --<br />
|-<br />
| 9<br />
| --<br />
| --.<br />
|-<br />
| 10<br />
| --<br />
| --.<br />
|-<br />
| 11<br />
| Pré-Release<br />
| --<br />
|-<br />
| '''Prototype'''<br />
| --<br />
| <br />
|-<br />
| 12<br />
| Makeup<br />
| --<br />
|-<br />
| <br />
| '''Final Release'''<br />
|<br />
|}<br />
<br />
===Presentation===<br />
<br />
My name is Vinicius, a Brazilian Student at Federal Center for Technological Education of Minas Gerais - Brazil.<br />
<br />
===Resume of Skills===<br />
<br />
Apertium Knowledge:<br />
<br />
* Study to develop a collaborative tool for apertium.<br />
* A study of actual Apertium process about creating a language pair by the user point of view.<br />
* Analysis of the characteristics of the 2010 project of Aléssio and adaptation to current times.<br />
<br />
Academic Skills:<br />
<br />
* Graduating in Computer Engineering- Federal Center for Technological Education of Minas Gerais – Brazil<br />
<br />
Professional Skills:<br />
<br />
* Language developer: C, Java, JavaScript, PHP, Phyton, PL/SQL.<br />
<br />
Projects for Summer:<br />
<br />
* No professional activities planned.<br />
* Planning to work in GSOC<br />
<br />
=Project=<br />
==Why?==<br />
:* The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps potential contributors away. A tool that facilitates the work of dictionaries developers, eliminate the need of computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
==How can use?==<br />
:* --.<br />
:* --.<br />
:* --.<br />
:* --.<br />
<br />
==What its the plan?==<br />
:* We are planning to create a web GUI that allows the user to develop the basic tasks of dictionaries and translation pairs manipulation in an easy and practical way.<br />
:* We will use Git as an administrative and control tool, allowing the user to contribute to the work of other community members or start your own project.<br />
<br />
==Components ans Technologies==<br />
[[File:ComponentDiagramWebDictionary.jpg|thumb|700px|right|Components Diagram]]<br />
* Actors<br />
** Lay User <br />
** Dictionary Admin <br />
<br />
* UserBrowser <br />
** WebInterface with AngularJS - GUI to easily manipulate the dictionary XML file.<br />
<br />
* Web Dicionary Maintence (APP)<br />
** WebAPI - <br />
** Temporary Database - Temporary database in which the XML file will be loaded with the crosses made.<br />
** JavaGit Connector - <br />
** WebDictionary Controller - <br />
<br />
* Git - <br />
** GitRepository - <br />
** GitLab - <br />
** GitHub -<br />
<br />
==How it Works?==<br />
We will develop a WebInterface to LayUser add words or sugest modifiations.<br />
<br />
*<br />
*<br />
<br />
We are planning to use Git as an administrative and version control tool.<br />
<br />
* All dictionaries releases will be in a single repository and available to any member of the community to continue the work.<br />
* Each user will have your own branch to work on.<br />
* The users will be able to make merge requests with the official branch.<br />
* At first, we will use GitLab (or similar tool) to manage this merges requests. The team who maintain each dictionary will judge if the modifications are valid or not.<br />
<br />
==Example of Iteraction - Adding new lemma to a dictionary==<br />
<br />
===1. Choosing an official dictionary and importing it===<br />
The Official Dictionaries page display all available dictionaries in the git repository. Each version correspond to a tag in the master branch.<br />
[[File:Prototype1.png|thumb|250px|none|Choosing an official dictionary and importing it]]<br />
<br />
[[File:Git1.png|thumb|250px|none|Master branch]]<br />
Once imported, the user will name this dictionary and it will appear on the My Dictionaries page.<br />
[[File:Prototype2.png|thumb|250px|none|My Dictionaries page]]<br />
<br />
===2. Loading the dictionary file===<br />
On the Language File page, the user selects one of their dictionaries and the dictionary XML will be formatted to be temporarily saved to a database. Also on this page, the user can edit the dictionary alphabet and see some statistics about it.<br />
<br />
The Symbols, Paradigms, and Lemmas pages refer to the dictionary selected here.<br />
<br />
[[File:Prototype3.png|thumb|250px|none|Loading the dictionary file]]<br />
===3. Verifying if the lemmas already exists===<br />
On the Lemmas - Search page, the user will be able to see all the inflections of the dictionary lemmas and check if the lemma he wants to add already exists.<br />
<br />
[[File:Prototype4.png|thumb|250px|none|Verifying if the lemmas already exists]]<br />
===4. Creating the new lemma===<br />
In the Lemmas - Create page, the user will follow three steps to add a new lemma.<br />
<br />
In the first step, the user will define the lemma and the lemma root. In addition, he will give some examples of inflections and symbols to receive suggestions on which paradigm to use.<br />
<br />
[[File:Prototype5.png|thumb|250px|none|text-top|Creating the new lemma - Step 1]]<br />
In the second step, the user will see paradigm suggestions (or can see all paradigms). When a paradigm is selected, all inflections of the created lemma will be shown to the user. If none of the paradigms fit, the user will be directed to create a new paradigm.<br />
<br />
[[File:Prototype6.png|thumb|250px|none|Creating the new lemma - Step 2]]<br />
In the third and last step, the user will confirm and save the change. At this point, a branch will be create for this dictionary in the git repository (if she doesn’t already exists) and a commit with this changes will be done.<br />
<br />
[[File:Prototype7.png|thumb|250px|none|Creating the new lemma - Step 3]]<br />
===5. Merge Request===<br />
On My Dictionaries page, the user can create a merge request that will be judge by the master branch maintainer.<br />
<br />
[[File:Prototype8.png|thumb|250px|none|Merge Request]]<br />
[[File:Git2.png|thumb|250px|none|New branch created in Git]]<br />
<br />
===6. Official dictionary keeper judges the merge request===<br />
In GitLab (or similar tool), the dictionary maintainer will see the list of merge requests.<br />
[[File:Git5.png|thumb|250px|none|Merge request list]]<br />
At each request, the maintainer can view all commits and accepts only a few of them.<br />
[[File:Git6.png|thumb|250px|none|Commits from current merge request]]<br />
At each commit, he will judge the changes.<br />
[[File:Git7.png|thumb|250px|none|Changes]]<br />
When he accepts the merge request, the user's branch is deleted.<br />
[[File:Git4.png|thumb|250px|none|GitLab Graph]]<br />
<br />
===7. Feedback===<br />
On Merge Requests page, the user can see all request he have made and their status.<br />
<br />
<br />
[[File:Prototype9.png|thumb|250px|none|Feedback]]<br />
<br />
==First Experiments==<br />
[[File:WebPrototype-1.jpg|thumb|500px|left|Example]]<br />
[[File:WebPrototype-2.jpg|thumb|500px|right|Example]]<br />
<br />
<br />
[[Category:GSoC 2019 student proposals|Alessio]]</div>Alessiohttps://wiki.apertium.org/w/index.php?title=Web_Dictionary_Maintenance&diff=69003Web Dictionary Maintenance2019-03-25T23:07:06Z<p>Alessio: /* 6. Official dictionary keeper judges the merge request */</p>
<hr />
<div>{{TOCD}}<br />
<br />
[https://translate.google.com/translate?sl=en&tl=pt-br&prev=_t&hl=en&u=http://wiki.apertium.org/wiki/Web_Dictionary_Maintenance Translate to PT-BR with Google Tradução]<br />
<br />
= Introduction =<br />
<br />
Apertium over the years still has deficiencies so that lay people can contribute to increase the base of words in dictionaries, even with simple contributions. Collaboration is the key to developing a tool that serves a huge range of users throughout the world. We believe that it is possible to engage more users and thus give greater impact to the tool within the communities where there is involvement. We will deal in this document with requirements on non-functional and technical objectives regarding the tool proposal.<br />
<br />
;Original Ideias<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code/Easy_dictionary_maintenance<br />
<br />
;Original GSOC2019 Application<br />
: http://wiki.apertium.org/wiki/User:Alessiojr/Easy_dictionary_-_Application-GSOC2019<br />
<br />
;Studant Information<br />
: '''Student:''' Vinícius Silva Nogueira <br /><br />
: '''Unofficial Mentor:''' Alessio Miranda Junior<br /><br />
: '''Telegram/Whatsapp:''' Alessio: +55 (31) 9.8888-7770<br /><br />
: '''E-mail:''' alessio@cefetmg.br or viniciussnogueira13@gmail.com<br /><br />
: '''IRC:''' AlessioJr<br /><br />
: '''GTalk:''' alessiojunin@gmail.com<br />
<br />
=Description=<br />
==Abstract:==<br />
The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps away potential contributors. A tool that facilitates the work of dictionaries developers, eliminate computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
Even with several tools that help the way you manage and create dictionaries, Apertium is far from the normal users, who have a huge contribution potential. Or even create a simple way to create contributions to recurring users with advanced knowledge. Although it is a bold plan, and there are several possible and desirable requirements, we will describe some basic premises for this step and that must be respected and aligned with the apertium developer community.<br />
<br />
==Definitions==<br />
:* Lay users do not need to know Apertium's internal structure.<br />
:* Intermediate users need to have a knowledge of dictionary management methodology. <br />
:* Advanced users are those who know the structure of Apertium.<br />
:* Communities are user groups that merge characteristics to the database extension of a dictionary of a specific language.<br />
:* Official dictionaries are dictionaries managed and with seal of the apertium community.<br />
:* Unofficial dictionaries are dictionaries run by an independent community.<br />
:* Test dictionaries are deprived of users to test their contributions.<br />
<br />
==Objectives:==<br />
:* The major goal of the project is to develop a web tool to facilitate the management of the Apertium (XML's) database of integrators for novice and advanced users.<br />
:* New communities of contributions should be able to organize independently of a central command. The command exists but will be distributed.<br />
:* Lay users who feel motivated to contribute, should have an interface that promotes ease in contributing even with limited possibilities.<br />
:* The development of dictionaries should be collaborative and distributed. Each dictionary should have a management community, but a user may have the freedom to disagree and create a new version maintaining a history of the author.<br />
:* Any tool should maintain the traditional Apertium structure and not be interoperable between existing tools.<br />
:* There must be a methodology for communities to maintain the quality of their dictionaries. Although they are distributed the goal is to create a unified and mature dictionary.<br />
<br />
=Technical Objectives:=<br />
:* Develop, initially, monolingual dictionaries but keeping the particular format of each file.<br />
:* Minimize the direct manipulation of XML files, providing features that reduce this need.<br />
:* Making use of GitLab as an administrative and control tool.<br />
<br />
== Git, GitLab and Apertium ==<br />
[[File:Git_flow_demonstration.jpg|thumb|250px|right|Git Flow demonstration]]<br />
As the Apertium files are textual, we had the idea of seeking productivity and using existing and consolidated tools in the world.<br />
The proposal is to build a friendly web interface for lay users, but use git's own Back-End as version control and to make dictionary management GitLab as an administrative tool that already guarantees incredible power for remote collaboration.<br />
<br />
To demonstrate this relationship we will highlight some concepts of Git. Over time there may be several TimeLines:<br />
:* The Official Branch (Master) has the official version of the apertium managed by official developers or maintainers.<br />
:* Users have the power to create new Branches and develop unofficial dictionaries in parallel, creating communities that may from time to time suggest modifications to Brach Master.<br />
:* These requests can be accepted or rejected by maintainers, and this format is recursive and other developers can create unofficial copies of unofficial ones.<br />
:* Integration requests will use the Merge Request concepts present in tools such as GitLab that will be the BackEnd for advanced users.<br />
<br />
=Application-GSOC2019=<br />
===Abstract:===<br />
The idea is to develop the Web tool so that lay users contribute to dictionaries and use Git management with GitLab to manage these changes.<br />
* The focus will be on monolingual dictionaries and bilingual direct relationships.<br />
* Use the Git methodology and propose a guideline or flow for collaborative dictionary management.<br />
* Do not change the current XML format of dictionaries.<br />
<br />
===Why is it you are interested in machine translation?===<br />
<br />
During the graduation course, Professor Aléssio demonstrated the need and opportunity to contribute with open source projects. <br />
He introduced me to Apertium and in my final graduation work I started reading and talking about it. <br />
We started discussing techniques for managing collaboration with the community and currently do not have <br />
as much knowledge about machine translation machines but I have experience in developing applications <br />
and web using collaboration with Git and GitLab.<br />
<br />
===Why are they interested in the Apertium project?===<br />
<br />
I’ve .<br />
<br />
===Which of the published tasks are you interested in?===<br />
<br />
Easy dictionary maintenance.<br />
<br />
===Why should Google and Apertium sponsor it?===<br />
<br />
I .<br />
<br />
===How and who will it benefit in society?===<br />
I .<br />
<br />
===What do you plan to do?===<br />
<br />
We.<br />
<br />
'''Development Paradigm:''' MVC Paradigm<br /><br />
'''Program Language:''' Java, JavaScript<br /><br />
'''Persistence:''' XML (Apertium XML Files)<br /><br />
'''Framworks:''' Angular<br /><br />
<br />
===Stages/Milestones===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Week<br />
! Stage<br />
! Description<br />
|-<br />
| 1, 2<br />
| --<br />
| --.<br />
|-<br />
| 2, 3<br />
| --<br />
| --.|<br />
|-<br />
| '''Prototype'''<br />
| Milestone 1<br />
| --<br />
|-<br />
| 5, 6<br />
| --<br />
| --.<br />
|-<br />
| 7<br />
| --<br />
| --.<br />
|-<br />
| 8<br />
| --<br />
| --.<br />
|-<br />
| '''Prototype'''<br />
| Milestone 2<br />
| --<br />
|-<br />
| 9<br />
| --<br />
| --.<br />
|-<br />
| 10<br />
| --<br />
| --.<br />
|-<br />
| 11<br />
| Pré-Release<br />
| --<br />
|-<br />
| '''Prototype'''<br />
| --<br />
| <br />
|-<br />
| 12<br />
| Makeup<br />
| --<br />
|-<br />
| <br />
| '''Final Release'''<br />
|<br />
|}<br />
<br />
===Presentation===<br />
<br />
My name is Vinicius, a Brazilian Student at Federal Center for Technological Education of Minas Gerais - Brazil.<br />
<br />
===Resume of Skills===<br />
<br />
Apertium Knowledge:<br />
<br />
* Study to develop a collaborative tool for apertium.<br />
* A study of actual Apertium process about creating a language pair by the user point of view.<br />
* Analysis of the characteristics of the 2010 project of Aléssio and adaptation to current times.<br />
<br />
Academic Skills:<br />
<br />
* Graduating in Computer Engineering- Federal Center for Technological Education of Minas Gerais – Brazil<br />
<br />
Professional Skills:<br />
<br />
* Language developer: C, Java, JavaScript, PHP, Phyton, PL/SQL.<br />
<br />
Projects for Summer:<br />
<br />
* No professional activities planned.<br />
* Planning to work in GSOC<br />
<br />
=Project=<br />
==Why?==<br />
:* The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps potential contributors away. A tool that facilitates the work of dictionaries developers, eliminate the need of computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
==How can use?==<br />
:* --.<br />
:* --.<br />
:* --.<br />
:* --.<br />
<br />
==What its the plan?==<br />
:* We are planning to create a web GUI that allows the user to develop the basic tasks of dictionaries and translation pairs manipulation in an easy and practical way.<br />
:* We will use Git as an administrative and control tool, allowing the user to contribute to the work of other community members or start your own project.<br />
<br />
==Components ans Technologies==<br />
[[File:ComponentDiagramWebDictionary.jpg|thumb|700px|right|Components Diagram]]<br />
* Actors<br />
** Lay User <br />
** Dictionary Admin <br />
<br />
* UserBrowser <br />
** WebInterface with AngularJS - GUI to easily manipulate the dictionary XML file.<br />
<br />
* Web Dicionary Maintence (APP)<br />
** WebAPI - <br />
** Temporary Database - Temporary database in which the XML file will be loaded with the crosses made.<br />
** JavaGit Connector - <br />
** WebDictionary Controller - <br />
<br />
* Git - <br />
** GitRepository - <br />
** GitLab - <br />
** GitHub -<br />
<br />
==How it Works?==<br />
We will develop a WebInterface to LayUser add words or sugest modifiations.<br />
<br />
*<br />
*<br />
<br />
We are planning to use Git as an administrative and version control tool.<br />
<br />
* All dictionaries releases will be in a single repository and available to any member of the community to continue the work.<br />
* Each user will have your own branch to work on.<br />
* The users will be able to make merge requests with the official branch.<br />
* At first, we will use GitLab (or similar tool) to manage this merges requests. The team who maintain each dictionary will judge if the modifications are valid or not.<br />
<br />
==Example of Iteraction - Adding new lemma to a dictionary==<br />
<br />
===1. Choosing an official dictionary and importing it===<br />
The Official Dictionaries page display all available dictionaries in the git repository. Each version correspond to a tag in the master branch.<br />
[[File:Prototype1.png|thumb|250px|none|Choosing an official dictionary and importing it]]<br />
<br />
[[File:Git1.png|thumb|250px|none|Master branch]]<br />
Once imported, the user will name this dictionary and it will appear on the My Dictionaries page.<br />
[[File:Prototype2.png|thumb|250px|none|My Dictionaries page]]<br />
<br />
===2. Loading the dictionary file===<br />
On the Language File page, the user selects one of their dictionaries and the dictionary XML will be formatted to be temporarily saved to a database. Also on this page, the user can edit the dictionary alphabet and see some statistics about it.<br />
<br />
The Symbols, Paradigms, and Lemmas pages refer to the dictionary selected here.<br />
<br />
[[File:Prototype3.png|thumb|250px|none|Loading the dictionary file]]<br />
===3. Verifying if the lemmas already exists===<br />
On the Lemmas - Search page, the user will be able to see all the inflections of the dictionary lemmas and check if the lemma he wants to add already exists.<br />
<br />
[[File:Prototype4.png|thumb|250px|none|Verifying if the lemmas already exists]]<br />
===4. Creating the new lemma===<br />
In the Lemmas - Create page, the user will follow three steps to add a new lemma.<br />
<br />
In the first step, the user will define the lemma and the lemma root. In addition, he will give some examples of inflections and symbols to receive suggestions on which paradigm to use.<br />
<br />
[[File:Prototype5.png|thumb|250px|none|text-top|Creating the new lemma - Step 1]]<br />
In the second step, the user will see paradigm suggestions (or can see all paradigms). When a paradigm is selected, all inflections of the created lemma will be shown to the user. If none of the paradigms fit, the user will be directed to create a new paradigm.<br />
<br />
[[File:Prototype6.png|thumb|250px|none|Creating the new lemma - Step 2]]<br />
In the third and last step, the user will confirm and save the change. At this point, a branch will be create for this dictionary in the git repository (if she doesn’t already exists) and a commit with this changes will be done.<br />
<br />
[[File:Prototype7.png|thumb|250px|none|Creating the new lemma - Step 3]]<br />
===5. Merge Request===<br />
On My Dictionaries page, the user can create a merge request that will be judge by the master branch maintainer.<br />
<br />
[[File:Prototype8.png|thumb|250px|none|Merge Request]]<br />
[[File:Git2.png|thumb|250px|none|New branch created in Git]]<br />
<br />
===6. Official dictionary keeper judges the merge request===<br />
In GitLab (or similar tool), the dictionary maintainer will see the list of merge requests.<br />
[[File:Git5.png|thumb|250px|none|Merge request list]]<br />
At each request, the maintainer can view all commits and accepts only a few of them.<br />
[[File:Git6.png|thumb|250px|none|Commits from current merge request]]<br />
At each commit, he will judge the changes.<br />
[[File:Git7.png|thumb|250px|none|Changes]]<br />
<br />
===7. Feedback===<br />
On Merge Requests page, the user can see all request he have made and their status.<br />
<br />
<br />
[[File:Prototype9.png|thumb|250px|none|Feedback]]<br />
<br />
==First Experiments==<br />
[[File:WebPrototype-1.jpg|thumb|500px|left|Example]]<br />
[[File:WebPrototype-2.jpg|thumb|500px|right|Example]]<br />
<br />
<br />
[[Category:GSoC 2019 student proposals|Alessio]]</div>Alessiohttps://wiki.apertium.org/w/index.php?title=File:Git7.png&diff=69002File:Git7.png2019-03-25T23:00:35Z<p>Alessio: </p>
<hr />
<div></div>Alessiohttps://wiki.apertium.org/w/index.php?title=File:Git6.png&diff=69001File:Git6.png2019-03-25T23:00:17Z<p>Alessio: </p>
<hr />
<div></div>Alessiohttps://wiki.apertium.org/w/index.php?title=File:Git5.png&diff=69000File:Git5.png2019-03-25T23:00:03Z<p>Alessio: Alessio uploaded a new version of &quot;File:Git5.png&quot;</p>
<hr />
<div></div>Alessiohttps://wiki.apertium.org/w/index.php?title=File:Git5.png&diff=68999File:Git5.png2019-03-25T23:00:02Z<p>Alessio: </p>
<hr />
<div></div>Alessiohttps://wiki.apertium.org/w/index.php?title=Web_Dictionary_Maintenance&diff=68998Web Dictionary Maintenance2019-03-25T22:57:09Z<p>Alessio: /* 5. Merge Request */</p>
<hr />
<div>{{TOCD}}<br />
<br />
[https://translate.google.com/translate?sl=en&tl=pt-br&prev=_t&hl=en&u=http://wiki.apertium.org/wiki/Web_Dictionary_Maintenance Translate to PT-BR with Google Tradução]<br />
<br />
= Introduction =<br />
<br />
Apertium over the years still has deficiencies so that lay people can contribute to increase the base of words in dictionaries, even with simple contributions. Collaboration is the key to developing a tool that serves a huge range of users throughout the world. We believe that it is possible to engage more users and thus give greater impact to the tool within the communities where there is involvement. We will deal in this document with requirements on non-functional and technical objectives regarding the tool proposal.<br />
<br />
;Original Ideias<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code/Easy_dictionary_maintenance<br />
<br />
;Original GSOC2019 Application<br />
: http://wiki.apertium.org/wiki/User:Alessiojr/Easy_dictionary_-_Application-GSOC2019<br />
<br />
;Studant Information<br />
: '''Student:''' Vinícius Silva Nogueira <br /><br />
: '''Unofficial Mentor:''' Alessio Miranda Junior<br /><br />
: '''Telegram/Whatsapp:''' Alessio: +55 (31) 9.8888-7770<br /><br />
: '''E-mail:''' alessio@cefetmg.br or viniciussnogueira13@gmail.com<br /><br />
: '''IRC:''' AlessioJr<br /><br />
: '''GTalk:''' alessiojunin@gmail.com<br />
<br />
=Description=<br />
==Abstract:==<br />
The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps away potential contributors. A tool that facilitates the work of dictionaries developers, eliminate computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
Even with several tools that help the way you manage and create dictionaries, Apertium is far from the normal users, who have a huge contribution potential. Or even create a simple way to create contributions to recurring users with advanced knowledge. Although it is a bold plan, and there are several possible and desirable requirements, we will describe some basic premises for this step and that must be respected and aligned with the apertium developer community.<br />
<br />
==Definitions==<br />
:* Lay users do not need to know Apertium's internal structure.<br />
:* Intermediate users need to have a knowledge of dictionary management methodology. <br />
:* Advanced users are those who know the structure of Apertium.<br />
:* Communities are user groups that merge characteristics to the database extension of a dictionary of a specific language.<br />
:* Official dictionaries are dictionaries managed and with seal of the apertium community.<br />
:* Unofficial dictionaries are dictionaries run by an independent community.<br />
:* Test dictionaries are deprived of users to test their contributions.<br />
<br />
==Objectives:==<br />
:* The major goal of the project is to develop a web tool to facilitate the management of the Apertium (XML's) database of integrators for novice and advanced users.<br />
:* New communities of contributions should be able to organize independently of a central command. The command exists but will be distributed.<br />
:* Lay users who feel motivated to contribute, should have an interface that promotes ease in contributing even with limited possibilities.<br />
:* The development of dictionaries should be collaborative and distributed. Each dictionary should have a management community, but a user may have the freedom to disagree and create a new version maintaining a history of the author.<br />
:* Any tool should maintain the traditional Apertium structure and not be interoperable between existing tools.<br />
:* There must be a methodology for communities to maintain the quality of their dictionaries. Although they are distributed the goal is to create a unified and mature dictionary.<br />
<br />
=Technical Objectives:=<br />
:* Develop, initially, monolingual dictionaries but keeping the particular format of each file.<br />
:* Minimize the direct manipulation of XML files, providing features that reduce this need.<br />
:* Making use of GitLab as an administrative and control tool.<br />
<br />
== Git, GitLab and Apertium ==<br />
[[File:Git_flow_demonstration.jpg|thumb|250px|right|Git Flow demonstration]]<br />
As the Apertium files are textual, we had the idea of seeking productivity and using existing and consolidated tools in the world.<br />
The proposal is to build a friendly web interface for lay users, but use git's own Back-End as version control and to make dictionary management GitLab as an administrative tool that already guarantees incredible power for remote collaboration.<br />
<br />
To demonstrate this relationship we will highlight some concepts of Git. Over time there may be several TimeLines:<br />
:* The Official Branch (Master) has the official version of the apertium managed by official developers or maintainers.<br />
:* Users have the power to create new Branches and develop unofficial dictionaries in parallel, creating communities that may from time to time suggest modifications to Brach Master.<br />
:* These requests can be accepted or rejected by maintainers, and this format is recursive and other developers can create unofficial copies of unofficial ones.<br />
:* Integration requests will use the Merge Request concepts present in tools such as GitLab that will be the BackEnd for advanced users.<br />
<br />
=Application-GSOC2019=<br />
===Abstract:===<br />
The idea is to develop the Web tool so that lay users contribute to dictionaries and use Git management with GitLab to manage these changes.<br />
* The focus will be on monolingual dictionaries and bilingual direct relationships.<br />
* Use the Git methodology and propose a guideline or flow for collaborative dictionary management.<br />
* Do not change the current XML format of dictionaries.<br />
<br />
===Why is it you are interested in machine translation?===<br />
<br />
During the graduation course, Professor Aléssio demonstrated the need and opportunity to contribute with open source projects. <br />
He introduced me to Apertium and in my final graduation work I started reading and talking about it. <br />
We started discussing techniques for managing collaboration with the community and currently do not have <br />
as much knowledge about machine translation machines but I have experience in developing applications <br />
and web using collaboration with Git and GitLab.<br />
<br />
===Why are they interested in the Apertium project?===<br />
<br />
I’ve .<br />
<br />
===Which of the published tasks are you interested in?===<br />
<br />
Easy dictionary maintenance.<br />
<br />
===Why should Google and Apertium sponsor it?===<br />
<br />
I .<br />
<br />
===How and who will it benefit in society?===<br />
I .<br />
<br />
===What do you plan to do?===<br />
<br />
We.<br />
<br />
'''Development Paradigm:''' MVC Paradigm<br /><br />
'''Program Language:''' Java, JavaScript<br /><br />
'''Persistence:''' XML (Apertium XML Files)<br /><br />
'''Framworks:''' Angular<br /><br />
<br />
===Stages/Milestones===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Week<br />
! Stage<br />
! Description<br />
|-<br />
| 1, 2<br />
| --<br />
| --.<br />
|-<br />
| 2, 3<br />
| --<br />
| --.|<br />
|-<br />
| '''Prototype'''<br />
| Milestone 1<br />
| --<br />
|-<br />
| 5, 6<br />
| --<br />
| --.<br />
|-<br />
| 7<br />
| --<br />
| --.<br />
|-<br />
| 8<br />
| --<br />
| --.<br />
|-<br />
| '''Prototype'''<br />
| Milestone 2<br />
| --<br />
|-<br />
| 9<br />
| --<br />
| --.<br />
|-<br />
| 10<br />
| --<br />
| --.<br />
|-<br />
| 11<br />
| Pré-Release<br />
| --<br />
|-<br />
| '''Prototype'''<br />
| --<br />
| <br />
|-<br />
| 12<br />
| Makeup<br />
| --<br />
|-<br />
| <br />
| '''Final Release'''<br />
|<br />
|}<br />
<br />
===Presentation===<br />
<br />
My name is Vinicius, a Brazilian Student at Federal Center for Technological Education of Minas Gerais - Brazil.<br />
<br />
===Resume of Skills===<br />
<br />
Apertium Knowledge:<br />
<br />
* Study to develop a collaborative tool for apertium.<br />
* A study of actual Apertium process about creating a language pair by the user point of view.<br />
* Analysis of the characteristics of the 2010 project of Aléssio and adaptation to current times.<br />
<br />
Academic Skills:<br />
<br />
* Graduating in Computer Engineering- Federal Center for Technological Education of Minas Gerais – Brazil<br />
<br />
Professional Skills:<br />
<br />
* Language developer: C, Java, JavaScript, PHP, Phyton, PL/SQL.<br />
<br />
Projects for Summer:<br />
<br />
* No professional activities planned.<br />
* Planning to work in GSOC<br />
<br />
=Project=<br />
==Why?==<br />
:* The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps potential contributors away. A tool that facilitates the work of dictionaries developers, eliminate the need of computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
==How can use?==<br />
:* --.<br />
:* --.<br />
:* --.<br />
:* --.<br />
<br />
==What its the plan?==<br />
:* We are planning to create a web GUI that allows the user to develop the basic tasks of dictionaries and translation pairs manipulation in an easy and practical way.<br />
:* We will use Git as an administrative and control tool, allowing the user to contribute to the work of other community members or start your own project.<br />
<br />
==Components ans Technologies==<br />
[[File:ComponentDiagramWebDictionary.jpg|thumb|700px|right|Components Diagram]]<br />
* Actors<br />
** Lay User <br />
** Dictionary Admin <br />
<br />
* UserBrowser <br />
** WebInterface with AngularJS - GUI to easily manipulate the dictionary XML file.<br />
<br />
* Web Dicionary Maintence (APP)<br />
** WebAPI - <br />
** Temporary Database - Temporary database in which the XML file will be loaded with the crosses made.<br />
** JavaGit Connector - <br />
** WebDictionary Controller - <br />
<br />
* Git - <br />
** GitRepository - <br />
** GitLab - <br />
** GitHub -<br />
<br />
==How it Works?==<br />
We will develop a WebInterface to LayUser add words or sugest modifiations.<br />
<br />
*<br />
*<br />
<br />
We are planning to use Git as an administrative and version control tool.<br />
<br />
* All dictionaries releases will be in a single repository and available to any member of the community to continue the work.<br />
* Each user will have your own branch to work on.<br />
* The users will be able to make merge requests with the official branch.<br />
* At first, we will use GitLab (or similar tool) to manage this merges requests. The team who maintain each dictionary will judge if the modifications are valid or not.<br />
<br />
==Example of Iteraction - Adding new lemma to a dictionary==<br />
<br />
===1. Choosing an official dictionary and importing it===<br />
The Official Dictionaries page display all available dictionaries in the git repository. Each version correspond to a tag in the master branch.<br />
[[File:Prototype1.png|thumb|250px|none|Choosing an official dictionary and importing it]]<br />
<br />
[[File:Git1.png|thumb|250px|none|Master branch]]<br />
Once imported, the user will name this dictionary and it will appear on the My Dictionaries page.<br />
[[File:Prototype2.png|thumb|250px|none|My Dictionaries page]]<br />
<br />
===2. Loading the dictionary file===<br />
On the Language File page, the user selects one of their dictionaries and the dictionary XML will be formatted to be temporarily saved to a database. Also on this page, the user can edit the dictionary alphabet and see some statistics about it.<br />
<br />
The Symbols, Paradigms, and Lemmas pages refer to the dictionary selected here.<br />
<br />
[[File:Prototype3.png|thumb|250px|none|Loading the dictionary file]]<br />
===3. Verifying if the lemmas already exists===<br />
On the Lemmas - Search page, the user will be able to see all the inflections of the dictionary lemmas and check if the lemma he wants to add already exists.<br />
<br />
[[File:Prototype4.png|thumb|250px|none|Verifying if the lemmas already exists]]<br />
===4. Creating the new lemma===<br />
In the Lemmas - Create page, the user will follow three steps to add a new lemma.<br />
<br />
In the first step, the user will define the lemma and the lemma root. In addition, he will give some examples of inflections and symbols to receive suggestions on which paradigm to use.<br />
<br />
[[File:Prototype5.png|thumb|250px|none|text-top|Creating the new lemma - Step 1]]<br />
In the second step, the user will see paradigm suggestions (or can see all paradigms). When a paradigm is selected, all inflections of the created lemma will be shown to the user. If none of the paradigms fit, the user will be directed to create a new paradigm.<br />
<br />
[[File:Prototype6.png|thumb|250px|none|Creating the new lemma - Step 2]]<br />
In the third and last step, the user will confirm and save the change. At this point, a branch will be create for this dictionary in the git repository (if she doesn’t already exists) and a commit with this changes will be done.<br />
<br />
[[File:Prototype7.png|thumb|250px|none|Creating the new lemma - Step 3]]<br />
===5. Merge Request===<br />
On My Dictionaries page, the user can create a merge request that will be judge by the master branch maintainer.<br />
<br />
[[File:Prototype8.png|thumb|250px|none|Merge Request]]<br />
[[File:Git2.png|thumb|250px|none|New branch created in Git]]<br />
<br />
===6. Official dictionary keeper judges the merge request===<br />
<br />
===7. Feedback===<br />
On Merge Requests page, the user can see all request he have made and their status.<br />
<br />
<br />
[[File:Prototype9.png|thumb|250px|none|Feedback]]<br />
<br />
==First Experiments==<br />
[[File:WebPrototype-1.jpg|thumb|500px|left|Example]]<br />
[[File:WebPrototype-2.jpg|thumb|500px|right|Example]]<br />
<br />
<br />
[[Category:GSoC 2019 student proposals|Alessio]]</div>Alessiohttps://wiki.apertium.org/w/index.php?title=File:Git4.png&diff=68997File:Git4.png2019-03-25T22:56:14Z<p>Alessio: </p>
<hr />
<div></div>Alessiohttps://wiki.apertium.org/w/index.php?title=File:Git3.png&diff=68996File:Git3.png2019-03-25T22:56:01Z<p>Alessio: </p>
<hr />
<div></div>Alessiohttps://wiki.apertium.org/w/index.php?title=File:Git2.png&diff=68995File:Git2.png2019-03-25T22:55:44Z<p>Alessio: Alessio uploaded a new version of &quot;File:Git2.png&quot;</p>
<hr />
<div></div>Alessiohttps://wiki.apertium.org/w/index.php?title=File:Git2.png&diff=68994File:Git2.png2019-03-25T22:55:39Z<p>Alessio: </p>
<hr />
<div></div>Alessiohttps://wiki.apertium.org/w/index.php?title=Web_Dictionary_Maintenance&diff=68993Web Dictionary Maintenance2019-03-25T22:54:13Z<p>Alessio: /* 1. Choosing an official dictionary and importing it */</p>
<hr />
<div>{{TOCD}}<br />
<br />
[https://translate.google.com/translate?sl=en&tl=pt-br&prev=_t&hl=en&u=http://wiki.apertium.org/wiki/Web_Dictionary_Maintenance Translate to PT-BR with Google Tradução]<br />
<br />
= Introduction =<br />
<br />
Apertium over the years still has deficiencies so that lay people can contribute to increase the base of words in dictionaries, even with simple contributions. Collaboration is the key to developing a tool that serves a huge range of users throughout the world. We believe that it is possible to engage more users and thus give greater impact to the tool within the communities where there is involvement. We will deal in this document with requirements on non-functional and technical objectives regarding the tool proposal.<br />
<br />
;Original Ideias<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code/Easy_dictionary_maintenance<br />
<br />
;Original GSOC2019 Application<br />
: http://wiki.apertium.org/wiki/User:Alessiojr/Easy_dictionary_-_Application-GSOC2019<br />
<br />
;Studant Information<br />
: '''Student:''' Vinícius Silva Nogueira <br /><br />
: '''Unofficial Mentor:''' Alessio Miranda Junior<br /><br />
: '''Telegram/Whatsapp:''' Alessio: +55 (31) 9.8888-7770<br /><br />
: '''E-mail:''' alessio@cefetmg.br or viniciussnogueira13@gmail.com<br /><br />
: '''IRC:''' AlessioJr<br /><br />
: '''GTalk:''' alessiojunin@gmail.com<br />
<br />
=Description=<br />
==Abstract:==<br />
The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps away potential contributors. A tool that facilitates the work of dictionaries developers, eliminate computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
Even with several tools that help the way you manage and create dictionaries, Apertium is far from the normal users, who have a huge contribution potential. Or even create a simple way to create contributions to recurring users with advanced knowledge. Although it is a bold plan, and there are several possible and desirable requirements, we will describe some basic premises for this step and that must be respected and aligned with the apertium developer community.<br />
<br />
==Definitions==<br />
:* Lay users do not need to know Apertium's internal structure.<br />
:* Intermediate users need to have a knowledge of dictionary management methodology. <br />
:* Advanced users are those who know the structure of Apertium.<br />
:* Communities are user groups that merge characteristics to the database extension of a dictionary of a specific language.<br />
:* Official dictionaries are dictionaries managed and with seal of the apertium community.<br />
:* Unofficial dictionaries are dictionaries run by an independent community.<br />
:* Test dictionaries are deprived of users to test their contributions.<br />
<br />
==Objectives:==<br />
:* The major goal of the project is to develop a web tool to facilitate the management of the Apertium (XML's) database of integrators for novice and advanced users.<br />
:* New communities of contributions should be able to organize independently of a central command. The command exists but will be distributed.<br />
:* Lay users who feel motivated to contribute, should have an interface that promotes ease in contributing even with limited possibilities.<br />
:* The development of dictionaries should be collaborative and distributed. Each dictionary should have a management community, but a user may have the freedom to disagree and create a new version maintaining a history of the author.<br />
:* Any tool should maintain the traditional Apertium structure and not be interoperable between existing tools.<br />
:* There must be a methodology for communities to maintain the quality of their dictionaries. Although they are distributed the goal is to create a unified and mature dictionary.<br />
<br />
=Technical Objectives:=<br />
:* Develop, initially, monolingual dictionaries but keeping the particular format of each file.<br />
:* Minimize the direct manipulation of XML files, providing features that reduce this need.<br />
:* Making use of GitLab as an administrative and control tool.<br />
<br />
== Git, GitLab and Apertium ==<br />
[[File:Git_flow_demonstration.jpg|thumb|250px|right|Git Flow demonstration]]<br />
As the Apertium files are textual, we had the idea of seeking productivity and using existing and consolidated tools in the world.<br />
The proposal is to build a friendly web interface for lay users, but use git's own Back-End as version control and to make dictionary management GitLab as an administrative tool that already guarantees incredible power for remote collaboration.<br />
<br />
To demonstrate this relationship we will highlight some concepts of Git. Over time there may be several TimeLines:<br />
:* The Official Branch (Master) has the official version of the apertium managed by official developers or maintainers.<br />
:* Users have the power to create new Branches and develop unofficial dictionaries in parallel, creating communities that may from time to time suggest modifications to Brach Master.<br />
:* These requests can be accepted or rejected by maintainers, and this format is recursive and other developers can create unofficial copies of unofficial ones.<br />
:* Integration requests will use the Merge Request concepts present in tools such as GitLab that will be the BackEnd for advanced users.<br />
<br />
=Application-GSOC2019=<br />
===Abstract:===<br />
The idea is to develop the Web tool so that lay users contribute to dictionaries and use Git management with GitLab to manage these changes.<br />
* The focus will be on monolingual dictionaries and bilingual direct relationships.<br />
* Use the Git methodology and propose a guideline or flow for collaborative dictionary management.<br />
* Do not change the current XML format of dictionaries.<br />
<br />
===Why is it you are interested in machine translation?===<br />
<br />
During the graduation course, Professor Aléssio demonstrated the need and opportunity to contribute with open source projects. <br />
He introduced me to Apertium and in my final graduation work I started reading and talking about it. <br />
We started discussing techniques for managing collaboration with the community and currently do not have <br />
as much knowledge about machine translation machines but I have experience in developing applications <br />
and web using collaboration with Git and GitLab.<br />
<br />
===Why are they interested in the Apertium project?===<br />
<br />
I’ve .<br />
<br />
===Which of the published tasks are you interested in?===<br />
<br />
Easy dictionary maintenance.<br />
<br />
===Why should Google and Apertium sponsor it?===<br />
<br />
I .<br />
<br />
===How and who will it benefit in society?===<br />
I .<br />
<br />
===What do you plan to do?===<br />
<br />
We.<br />
<br />
'''Development Paradigm:''' MVC Paradigm<br /><br />
'''Program Language:''' Java, JavaScript<br /><br />
'''Persistence:''' XML (Apertium XML Files)<br /><br />
'''Framworks:''' Angular<br /><br />
<br />
===Stages/Milestones===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Week<br />
! Stage<br />
! Description<br />
|-<br />
| 1, 2<br />
| --<br />
| --.<br />
|-<br />
| 2, 3<br />
| --<br />
| --.|<br />
|-<br />
| '''Prototype'''<br />
| Milestone 1<br />
| --<br />
|-<br />
| 5, 6<br />
| --<br />
| --.<br />
|-<br />
| 7<br />
| --<br />
| --.<br />
|-<br />
| 8<br />
| --<br />
| --.<br />
|-<br />
| '''Prototype'''<br />
| Milestone 2<br />
| --<br />
|-<br />
| 9<br />
| --<br />
| --.<br />
|-<br />
| 10<br />
| --<br />
| --.<br />
|-<br />
| 11<br />
| Pré-Release<br />
| --<br />
|-<br />
| '''Prototype'''<br />
| --<br />
| <br />
|-<br />
| 12<br />
| Makeup<br />
| --<br />
|-<br />
| <br />
| '''Final Release'''<br />
|<br />
|}<br />
<br />
===Presentation===<br />
<br />
My name is Vinicius, a Brazilian Student at Federal Center for Technological Education of Minas Gerais - Brazil.<br />
<br />
===Resume of Skills===<br />
<br />
Apertium Knowledge:<br />
<br />
* Study to develop a collaborative tool for apertium.<br />
* A study of actual Apertium process about creating a language pair by the user point of view.<br />
* Analysis of the characteristics of the 2010 project of Aléssio and adaptation to current times.<br />
<br />
Academic Skills:<br />
<br />
* Graduating in Computer Engineering- Federal Center for Technological Education of Minas Gerais – Brazil<br />
<br />
Professional Skills:<br />
<br />
* Language developer: C, Java, JavaScript, PHP, Phyton, PL/SQL.<br />
<br />
Projects for Summer:<br />
<br />
* No professional activities planned.<br />
* Planning to work in GSOC<br />
<br />
=Project=<br />
==Why?==<br />
:* The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps potential contributors away. A tool that facilitates the work of dictionaries developers, eliminate the need of computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
==How can use?==<br />
:* --.<br />
:* --.<br />
:* --.<br />
:* --.<br />
<br />
==What its the plan?==<br />
:* We are planning to create a web GUI that allows the user to develop the basic tasks of dictionaries and translation pairs manipulation in an easy and practical way.<br />
:* We will use Git as an administrative and control tool, allowing the user to contribute to the work of other community members or start your own project.<br />
<br />
==Components ans Technologies==<br />
[[File:ComponentDiagramWebDictionary.jpg|thumb|700px|right|Components Diagram]]<br />
* Actors<br />
** Lay User <br />
** Dictionary Admin <br />
<br />
* UserBrowser <br />
** WebInterface with AngularJS - GUI to easily manipulate the dictionary XML file.<br />
<br />
* Web Dicionary Maintence (APP)<br />
** WebAPI - <br />
** Temporary Database - Temporary database in which the XML file will be loaded with the crosses made.<br />
** JavaGit Connector - <br />
** WebDictionary Controller - <br />
<br />
* Git - <br />
** GitRepository - <br />
** GitLab - <br />
** GitHub -<br />
<br />
==How it Works?==<br />
We will develop a WebInterface to LayUser add words or sugest modifiations.<br />
<br />
*<br />
*<br />
<br />
We are planning to use Git as an administrative and version control tool.<br />
<br />
* All dictionaries releases will be in a single repository and available to any member of the community to continue the work.<br />
* Each user will have your own branch to work on.<br />
* The users will be able to make merge requests with the official branch.<br />
* At first, we will use GitLab (or similar tool) to manage this merges requests. The team who maintain each dictionary will judge if the modifications are valid or not.<br />
<br />
==Example of Iteraction - Adding new lemma to a dictionary==<br />
<br />
===1. Choosing an official dictionary and importing it===<br />
The Official Dictionaries page display all available dictionaries in the git repository. Each version correspond to a tag in the master branch.<br />
[[File:Prototype1.png|thumb|250px|none|Choosing an official dictionary and importing it]]<br />
<br />
[[File:Git1.png|thumb|250px|none|Master branch]]<br />
Once imported, the user will name this dictionary and it will appear on the My Dictionaries page.<br />
[[File:Prototype2.png|thumb|250px|none|My Dictionaries page]]<br />
<br />
===2. Loading the dictionary file===<br />
On the Language File page, the user selects one of their dictionaries and the dictionary XML will be formatted to be temporarily saved to a database. Also on this page, the user can edit the dictionary alphabet and see some statistics about it.<br />
<br />
The Symbols, Paradigms, and Lemmas pages refer to the dictionary selected here.<br />
<br />
[[File:Prototype3.png|thumb|250px|none|Loading the dictionary file]]<br />
===3. Verifying if the lemmas already exists===<br />
On the Lemmas - Search page, the user will be able to see all the inflections of the dictionary lemmas and check if the lemma he wants to add already exists.<br />
<br />
[[File:Prototype4.png|thumb|250px|none|Verifying if the lemmas already exists]]<br />
===4. Creating the new lemma===<br />
In the Lemmas - Create page, the user will follow three steps to add a new lemma.<br />
<br />
In the first step, the user will define the lemma and the lemma root. In addition, he will give some examples of inflections and symbols to receive suggestions on which paradigm to use.<br />
<br />
[[File:Prototype5.png|thumb|250px|none|text-top|Creating the new lemma - Step 1]]<br />
In the second step, the user will see paradigm suggestions (or can see all paradigms). When a paradigm is selected, all inflections of the created lemma will be shown to the user. If none of the paradigms fit, the user will be directed to create a new paradigm.<br />
<br />
[[File:Prototype6.png|thumb|250px|none|Creating the new lemma - Step 2]]<br />
In the third and last step, the user will confirm and save the change. At this point, a branch will be create for this dictionary in the git repository (if she doesn’t already exists) and a commit with this changes will be done.<br />
<br />
[[File:Prototype7.png|thumb|250px|none|Creating the new lemma - Step 3]]<br />
===5. Merge Request===<br />
On My Dictionaries page, the user can create a merge request that will be judge by the master branch maintainer.<br />
<br />
[[File:Prototype8.png|thumb|250px|none|Merge Request]]<br />
===6. Official dictionary keeper judges the merge request===<br />
<br />
===7. Feedback===<br />
On Merge Requests page, the user can see all request he have made and their status.<br />
<br />
<br />
[[File:Prototype9.png|thumb|250px|none|Feedback]]<br />
<br />
==First Experiments==<br />
[[File:WebPrototype-1.jpg|thumb|500px|left|Example]]<br />
[[File:WebPrototype-2.jpg|thumb|500px|right|Example]]<br />
<br />
<br />
[[Category:GSoC 2019 student proposals|Alessio]]</div>Alessiohttps://wiki.apertium.org/w/index.php?title=File:Git1.png&diff=68992File:Git1.png2019-03-25T22:50:57Z<p>Alessio: </p>
<hr />
<div></div>Alessiohttps://wiki.apertium.org/w/index.php?title=Web_Dictionary_Maintenance&diff=68991Web Dictionary Maintenance2019-03-25T22:28:20Z<p>Alessio: /* Example of Iteraction */</p>
<hr />
<div>{{TOCD}}<br />
<br />
[https://translate.google.com/translate?sl=en&tl=pt-br&prev=_t&hl=en&u=http://wiki.apertium.org/wiki/Web_Dictionary_Maintenance Translate to PT-BR with Google Tradução]<br />
<br />
= Introduction =<br />
<br />
Apertium over the years still has deficiencies so that lay people can contribute to increase the base of words in dictionaries, even with simple contributions. Collaboration is the key to developing a tool that serves a huge range of users throughout the world. We believe that it is possible to engage more users and thus give greater impact to the tool within the communities where there is involvement. We will deal in this document with requirements on non-functional and technical objectives regarding the tool proposal.<br />
<br />
;Original Ideias<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code/Easy_dictionary_maintenance<br />
<br />
;Original GSOC2019 Application<br />
: http://wiki.apertium.org/wiki/User:Alessiojr/Easy_dictionary_-_Application-GSOC2019<br />
<br />
;Studant Information<br />
: '''Student:''' Vinícius Silva Nogueira <br /><br />
: '''Unofficial Mentor:''' Alessio Miranda Junior<br /><br />
: '''Telegram/Whatsapp:''' Alessio: +55 (31) 9.8888-7770<br /><br />
: '''E-mail:''' alessio@cefetmg.br or viniciussnogueira13@gmail.com<br /><br />
: '''IRC:''' AlessioJr<br /><br />
: '''GTalk:''' alessiojunin@gmail.com<br />
<br />
=Description=<br />
==Abstract:==<br />
The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps away potential contributors. A tool that facilitates the work of dictionaries developers, eliminate computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
Even with several tools that help the way you manage and create dictionaries, Apertium is far from the normal users, who have a huge contribution potential. Or even create a simple way to create contributions to recurring users with advanced knowledge. Although it is a bold plan, and there are several possible and desirable requirements, we will describe some basic premises for this step and that must be respected and aligned with the apertium developer community.<br />
<br />
==Definitions==<br />
:* Lay users do not need to know Apertium's internal structure.<br />
:* Intermediate users need to have a knowledge of dictionary management methodology. <br />
:* Advanced users are those who know the structure of Apertium.<br />
:* Communities are user groups that merge characteristics to the database extension of a dictionary of a specific language.<br />
:* Official dictionaries are dictionaries managed and with seal of the apertium community.<br />
:* Unofficial dictionaries are dictionaries run by an independent community.<br />
:* Test dictionaries are deprived of users to test their contributions.<br />
<br />
==Objectives:==<br />
:* The major goal of the project is to develop a web tool to facilitate the management of the Apertium (XML's) database of integrators for novice and advanced users.<br />
:* New communities of contributions should be able to organize independently of a central command. The command exists but will be distributed.<br />
:* Lay users who feel motivated to contribute, should have an interface that promotes ease in contributing even with limited possibilities.<br />
:* The development of dictionaries should be collaborative and distributed. Each dictionary should have a management community, but a user may have the freedom to disagree and create a new version maintaining a history of the author.<br />
:* Any tool should maintain the traditional Apertium structure and not be interoperable between existing tools.<br />
:* There must be a methodology for communities to maintain the quality of their dictionaries. Although they are distributed the goal is to create a unified and mature dictionary.<br />
<br />
=Technical Objectives:=<br />
:* Develop, initially, monolingual dictionaries but keeping the particular format of each file.<br />
:* Minimize the direct manipulation of XML files, providing features that reduce this need.<br />
:* Making use of GitLab as an administrative and control tool.<br />
<br />
== Git, GitLab and Apertium ==<br />
[[File:Git_flow_demonstration.jpg|thumb|250px|right|Git Flow demonstration]]<br />
As the Apertium files are textual, we had the idea of seeking productivity and using existing and consolidated tools in the world.<br />
The proposal is to build a friendly web interface for lay users, but use git's own Back-End as version control and to make dictionary management GitLab as an administrative tool that already guarantees incredible power for remote collaboration.<br />
<br />
To demonstrate this relationship we will highlight some concepts of Git. Over time there may be several TimeLines:<br />
:* The Official Branch (Master) has the official version of the apertium managed by official developers or maintainers.<br />
:* Users have the power to create new Branches and develop unofficial dictionaries in parallel, creating communities that may from time to time suggest modifications to Brach Master.<br />
:* These requests can be accepted or rejected by maintainers, and this format is recursive and other developers can create unofficial copies of unofficial ones.<br />
:* Integration requests will use the Merge Request concepts present in tools such as GitLab that will be the BackEnd for advanced users.<br />
<br />
=Application-GSOC2019=<br />
===Abstract:===<br />
The idea is to develop the Web tool so that lay users contribute to dictionaries and use Git management with GitLab to manage these changes.<br />
* The focus will be on monolingual dictionaries and bilingual direct relationships.<br />
* Use the Git methodology and propose a guideline or flow for collaborative dictionary management.<br />
* Do not change the current XML format of dictionaries.<br />
<br />
===Why is it you are interested in machine translation?===<br />
<br />
During the graduation course, Professor Aléssio demonstrated the need and opportunity to contribute with open source projects. <br />
He introduced me to Apertium and in my final graduation work I started reading and talking about it. <br />
We started discussing techniques for managing collaboration with the community and currently do not have <br />
as much knowledge about machine translation machines but I have experience in developing applications <br />
and web using collaboration with Git and GitLab.<br />
<br />
===Why are they interested in the Apertium project?===<br />
<br />
I’ve .<br />
<br />
===Which of the published tasks are you interested in?===<br />
<br />
Easy dictionary maintenance.<br />
<br />
===Why should Google and Apertium sponsor it?===<br />
<br />
I .<br />
<br />
===How and who will it benefit in society?===<br />
I .<br />
<br />
===What do you plan to do?===<br />
<br />
We.<br />
<br />
'''Development Paradigm:''' MVC Paradigm<br /><br />
'''Program Language:''' Java, JavaScript<br /><br />
'''Persistence:''' XML (Apertium XML Files)<br /><br />
'''Framworks:''' Angular<br /><br />
<br />
===Stages/Milestones===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Week<br />
! Stage<br />
! Description<br />
|-<br />
| 1, 2<br />
| --<br />
| --.<br />
|-<br />
| 2, 3<br />
| --<br />
| --.|<br />
|-<br />
| '''Prototype'''<br />
| Milestone 1<br />
| --<br />
|-<br />
| 5, 6<br />
| --<br />
| --.<br />
|-<br />
| 7<br />
| --<br />
| --.<br />
|-<br />
| 8<br />
| --<br />
| --.<br />
|-<br />
| '''Prototype'''<br />
| Milestone 2<br />
| --<br />
|-<br />
| 9<br />
| --<br />
| --.<br />
|-<br />
| 10<br />
| --<br />
| --.<br />
|-<br />
| 11<br />
| Pré-Release<br />
| --<br />
|-<br />
| '''Prototype'''<br />
| --<br />
| <br />
|-<br />
| 12<br />
| Makeup<br />
| --<br />
|-<br />
| <br />
| '''Final Release'''<br />
|<br />
|}<br />
<br />
===Presentation===<br />
<br />
My name is Vinicius, a Brazilian Student at Federal Center for Technological Education of Minas Gerais - Brazil.<br />
<br />
===Resume of Skills===<br />
<br />
Apertium Knowledge:<br />
<br />
* Study to develop a collaborative tool for apertium.<br />
* A study of actual Apertium process about creating a language pair by the user point of view.<br />
* Analysis of the characteristics of the 2010 project of Aléssio and adaptation to current times.<br />
<br />
Academic Skills:<br />
<br />
* Graduating in Computer Engineering- Federal Center for Technological Education of Minas Gerais – Brazil<br />
<br />
Professional Skills:<br />
<br />
* Language developer: C, Java, JavaScript, PHP, Phyton, PL/SQL.<br />
<br />
Projects for Summer:<br />
<br />
* No professional activities planned.<br />
* Planning to work in GSOC<br />
<br />
=Project=<br />
==Why?==<br />
:* The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps potential contributors away. A tool that facilitates the work of dictionaries developers, eliminate the need of computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
==How can use?==<br />
:* --.<br />
:* --.<br />
:* --.<br />
:* --.<br />
<br />
==What its the plan?==<br />
:* We are planning to create a web GUI that allows the user to develop the basic tasks of dictionaries and translation pairs manipulation in an easy and practical way.<br />
:* We will use Git as an administrative and control tool, allowing the user to contribute to the work of other community members or start your own project.<br />
<br />
==Components ans Technologies==<br />
[[File:ComponentDiagramWebDictionary.jpg|thumb|700px|right|Components Diagram]]<br />
* Actors<br />
** Lay User <br />
** Dictionary Admin <br />
<br />
* UserBrowser <br />
** WebInterface with AngularJS - GUI to easily manipulate the dictionary XML file.<br />
<br />
* Web Dicionary Maintence (APP)<br />
** WebAPI - <br />
** Temporary Database - Temporary database in which the XML file will be loaded with the crosses made.<br />
** JavaGit Connector - <br />
** WebDictionary Controller - <br />
<br />
* Git - <br />
** GitRepository - <br />
** GitLab - <br />
** GitHub -<br />
<br />
==How it Works?==<br />
We will develop a WebInterface to LayUser add words or sugest modifiations.<br />
<br />
*<br />
*<br />
<br />
We are planning to use Git as an administrative and version control tool.<br />
<br />
* All dictionaries releases will be in a single repository and available to any member of the community to continue the work.<br />
* Each user will have your own branch to work on.<br />
* The users will be able to make merge requests with the official branch.<br />
* At first, we will use GitLab (or similar tool) to manage this merges requests. The team who maintain each dictionary will judge if the modifications are valid or not.<br />
<br />
==Example of Iteraction - Adding new lemma to a dictionary==<br />
<br />
===1. Choosing an official dictionary and importing it===<br />
The Official Dictionaries page display all available dictionaries in the git repository. Each version correspond to a tag in the master branch.<br />
[[File:Prototype1.png|thumb|250px|none|Choosing an official dictionary and importing it]]<br />
Once imported, the user will name this dictionary and it will appear on the My Dictionaries page.<br />
[[File:Prototype2.png|thumb|250px|none|My Dictionaries page]]<br />
<br />
===2. Loading the dictionary file===<br />
On the Language File page, the user selects one of their dictionaries and the dictionary XML will be formatted to be temporarily saved to a database. Also on this page, the user can edit the dictionary alphabet and see some statistics about it.<br />
<br />
The Symbols, Paradigms, and Lemmas pages refer to the dictionary selected here.<br />
<br />
[[File:Prototype3.png|thumb|250px|none|Loading the dictionary file]]<br />
===3. Verifying if the lemmas already exists===<br />
On the Lemmas - Search page, the user will be able to see all the inflections of the dictionary lemmas and check if the lemma he wants to add already exists.<br />
<br />
[[File:Prototype4.png|thumb|250px|none|Verifying if the lemmas already exists]]<br />
===4. Creating the new lemma===<br />
In the Lemmas - Create page, the user will follow three steps to add a new lemma.<br />
<br />
In the first step, the user will define the lemma and the lemma root. In addition, he will give some examples of inflections and symbols to receive suggestions on which paradigm to use.<br />
<br />
[[File:Prototype5.png|thumb|250px|none|text-top|Creating the new lemma - Step 1]]<br />
In the second step, the user will see paradigm suggestions (or can see all paradigms). When a paradigm is selected, all inflections of the created lemma will be shown to the user. If none of the paradigms fit, the user will be directed to create a new paradigm.<br />
<br />
[[File:Prototype6.png|thumb|250px|none|Creating the new lemma - Step 2]]<br />
In the third and last step, the user will confirm and save the change. At this point, a branch will be create for this dictionary in the git repository (if she doesn’t already exists) and a commit with this changes will be done.<br />
<br />
[[File:Prototype7.png|thumb|250px|none|Creating the new lemma - Step 3]]<br />
===5. Merge Request===<br />
On My Dictionaries page, the user can create a merge request that will be judge by the master branch maintainer.<br />
<br />
[[File:Prototype8.png|thumb|250px|none|Merge Request]]<br />
===6. Official dictionary keeper judges the merge request===<br />
<br />
===7. Feedback===<br />
On Merge Requests page, the user can see all request he have made and their status.<br />
<br />
<br />
[[File:Prototype9.png|thumb|250px|none|Feedback]]<br />
<br />
==First Experiments==<br />
[[File:WebPrototype-1.jpg|thumb|500px|left|Example]]<br />
[[File:WebPrototype-2.jpg|thumb|500px|right|Example]]<br />
<br />
<br />
[[Category:GSoC 2019 student proposals|Alessio]]</div>Alessiohttps://wiki.apertium.org/w/index.php?title=Web_Dictionary_Maintenance&diff=68990Web Dictionary Maintenance2019-03-25T22:27:04Z<p>Alessio: /* Example of Iteraction */</p>
<hr />
<div>{{TOCD}}<br />
<br />
[https://translate.google.com/translate?sl=en&tl=pt-br&prev=_t&hl=en&u=http://wiki.apertium.org/wiki/Web_Dictionary_Maintenance Translate to PT-BR with Google Tradução]<br />
<br />
= Introduction =<br />
<br />
Apertium over the years still has deficiencies so that lay people can contribute to increase the base of words in dictionaries, even with simple contributions. Collaboration is the key to developing a tool that serves a huge range of users throughout the world. We believe that it is possible to engage more users and thus give greater impact to the tool within the communities where there is involvement. We will deal in this document with requirements on non-functional and technical objectives regarding the tool proposal.<br />
<br />
;Original Ideias<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code<br />
: http://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code/Easy_dictionary_maintenance<br />
<br />
;Original GSOC2019 Application<br />
: http://wiki.apertium.org/wiki/User:Alessiojr/Easy_dictionary_-_Application-GSOC2019<br />
<br />
;Studant Information<br />
: '''Student:''' Vinícius Silva Nogueira <br /><br />
: '''Unofficial Mentor:''' Alessio Miranda Junior<br /><br />
: '''Telegram/Whatsapp:''' Alessio: +55 (31) 9.8888-7770<br /><br />
: '''E-mail:''' alessio@cefetmg.br or viniciussnogueira13@gmail.com<br /><br />
: '''IRC:''' AlessioJr<br /><br />
: '''GTalk:''' alessiojunin@gmail.com<br />
<br />
=Description=<br />
==Abstract:==<br />
The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps away potential contributors. A tool that facilitates the work of dictionaries developers, eliminate computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
Even with several tools that help the way you manage and create dictionaries, Apertium is far from the normal users, who have a huge contribution potential. Or even create a simple way to create contributions to recurring users with advanced knowledge. Although it is a bold plan, and there are several possible and desirable requirements, we will describe some basic premises for this step and that must be respected and aligned with the apertium developer community.<br />
<br />
==Definitions==<br />
:* Lay users do not need to know Apertium's internal structure.<br />
:* Intermediate users need to have a knowledge of dictionary management methodology. <br />
:* Advanced users are those who know the structure of Apertium.<br />
:* Communities are user groups that merge characteristics to the database extension of a dictionary of a specific language.<br />
:* Official dictionaries are dictionaries managed and with seal of the apertium community.<br />
:* Unofficial dictionaries are dictionaries run by an independent community.<br />
:* Test dictionaries are deprived of users to test their contributions.<br />
<br />
==Objectives:==<br />
:* The major goal of the project is to develop a web tool to facilitate the management of the Apertium (XML's) database of integrators for novice and advanced users.<br />
:* New communities of contributions should be able to organize independently of a central command. The command exists but will be distributed.<br />
:* Lay users who feel motivated to contribute, should have an interface that promotes ease in contributing even with limited possibilities.<br />
:* The development of dictionaries should be collaborative and distributed. Each dictionary should have a management community, but a user may have the freedom to disagree and create a new version maintaining a history of the author.<br />
:* Any tool should maintain the traditional Apertium structure and not be interoperable between existing tools.<br />
:* There must be a methodology for communities to maintain the quality of their dictionaries. Although they are distributed the goal is to create a unified and mature dictionary.<br />
<br />
=Technical Objectives:=<br />
:* Develop, initially, monolingual dictionaries but keeping the particular format of each file.<br />
:* Minimize the direct manipulation of XML files, providing features that reduce this need.<br />
:* Making use of GitLab as an administrative and control tool.<br />
<br />
== Git, GitLab and Apertium ==<br />
[[File:Git_flow_demonstration.jpg|thumb|250px|right|Git Flow demonstration]]<br />
As the Apertium files are textual, we had the idea of seeking productivity and using existing and consolidated tools in the world.<br />
The proposal is to build a friendly web interface for lay users, but use git's own Back-End as version control and to make dictionary management GitLab as an administrative tool that already guarantees incredible power for remote collaboration.<br />
<br />
To demonstrate this relationship we will highlight some concepts of Git. Over time there may be several TimeLines:<br />
:* The Official Branch (Master) has the official version of the apertium managed by official developers or maintainers.<br />
:* Users have the power to create new Branches and develop unofficial dictionaries in parallel, creating communities that may from time to time suggest modifications to Brach Master.<br />
:* These requests can be accepted or rejected by maintainers, and this format is recursive and other developers can create unofficial copies of unofficial ones.<br />
:* Integration requests will use the Merge Request concepts present in tools such as GitLab that will be the BackEnd for advanced users.<br />
<br />
=Application-GSOC2019=<br />
===Abstract:===<br />
The idea is to develop the Web tool so that lay users contribute to dictionaries and use Git management with GitLab to manage these changes.<br />
* The focus will be on monolingual dictionaries and bilingual direct relationships.<br />
* Use the Git methodology and propose a guideline or flow for collaborative dictionary management.<br />
* Do not change the current XML format of dictionaries.<br />
<br />
===Why is it you are interested in machine translation?===<br />
<br />
During the graduation course, Professor Aléssio demonstrated the need and opportunity to contribute with open source projects. <br />
He introduced me to Apertium and in my final graduation work I started reading and talking about it. <br />
We started discussing techniques for managing collaboration with the community and currently do not have <br />
as much knowledge about machine translation machines but I have experience in developing applications <br />
and web using collaboration with Git and GitLab.<br />
<br />
===Why are they interested in the Apertium project?===<br />
<br />
I’ve .<br />
<br />
===Which of the published tasks are you interested in?===<br />
<br />
Easy dictionary maintenance.<br />
<br />
===Why should Google and Apertium sponsor it?===<br />
<br />
I .<br />
<br />
===How and who will it benefit in society?===<br />
I .<br />
<br />
===What do you plan to do?===<br />
<br />
We.<br />
<br />
'''Development Paradigm:''' MVC Paradigm<br /><br />
'''Program Language:''' Java, JavaScript<br /><br />
'''Persistence:''' XML (Apertium XML Files)<br /><br />
'''Framworks:''' Angular<br /><br />
<br />
===Stages/Milestones===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Week<br />
! Stage<br />
! Description<br />
|-<br />
| 1, 2<br />
| --<br />
| --.<br />
|-<br />
| 2, 3<br />
| --<br />
| --.|<br />
|-<br />
| '''Prototype'''<br />
| Milestone 1<br />
| --<br />
|-<br />
| 5, 6<br />
| --<br />
| --.<br />
|-<br />
| 7<br />
| --<br />
| --.<br />
|-<br />
| 8<br />
| --<br />
| --.<br />
|-<br />
| '''Prototype'''<br />
| Milestone 2<br />
| --<br />
|-<br />
| 9<br />
| --<br />
| --.<br />
|-<br />
| 10<br />
| --<br />
| --.<br />
|-<br />
| 11<br />
| Pré-Release<br />
| --<br />
|-<br />
| '''Prototype'''<br />
| --<br />
| <br />
|-<br />
| 12<br />
| Makeup<br />
| --<br />
|-<br />
| <br />
| '''Final Release'''<br />
|<br />
|}<br />
<br />
===Presentation===<br />
<br />
My name is Vinicius, a Brazilian Student at Federal Center for Technological Education of Minas Gerais - Brazil.<br />
<br />
===Resume of Skills===<br />
<br />
Apertium Knowledge:<br />
<br />
* Study to develop a collaborative tool for apertium.<br />
* A study of actual Apertium process about creating a language pair by the user point of view.<br />
* Analysis of the characteristics of the 2010 project of Aléssio and adaptation to current times.<br />
<br />
Academic Skills:<br />
<br />
* Graduating in Computer Engineering- Federal Center for Technological Education of Minas Gerais – Brazil<br />
<br />
Professional Skills:<br />
<br />
* Language developer: C, Java, JavaScript, PHP, Phyton, PL/SQL.<br />
<br />
Projects for Summer:<br />
<br />
* No professional activities planned.<br />
* Planning to work in GSOC<br />
<br />
=Project=<br />
==Why?==<br />
:* The dictionaries complexity and size makes its modification extremely hard and time-consuming, and, along with the need for programming knowledge, keeps potential contributors away. A tool that facilitates the work of dictionaries developers, eliminate the need of computer knowledge (XML, Git, etc) and that allows collaboration between members of the community is of extreme necessity because, with the removal of these barriers, a larger group of people will have the necessary requirements to participate in the development of dictionaries, thus increasing the translation capacity of Apertium.<br />
<br />
==How can use?==<br />
:* --.<br />
:* --.<br />
:* --.<br />
:* --.<br />
<br />
==What its the plan?==<br />
:* We are planning to create a web GUI that allows the user to develop the basic tasks of dictionaries and translation pairs manipulation in an easy and practical way.<br />
:* We will use Git as an administrative and control tool, allowing the user to contribute to the work of other community members or start your own project.<br />
<br />
==Components ans Technologies==<br />
[[File:ComponentDiagramWebDictionary.jpg|thumb|700px|right|Components Diagram]]<br />
* Actors<br />
** Lay User <br />
** Dictionary Admin <br />
<br />
* UserBrowser <br />
** WebInterface with AngularJS - GUI to easily manipulate the dictionary XML file.<br />
<br />
* Web Dicionary Maintence (APP)<br />
** WebAPI - <br />
** Temporary Database - Temporary database in which the XML file will be loaded with the crosses made.<br />
** JavaGit Connector - <br />
** WebDictionary Controller - <br />
<br />
* Git - <br />
** GitRepository - <br />
** GitLab - <br />
** GitHub -<br />
<br />
==How it Works?==<br />
We will develop a WebInterface to LayUser add words or sugest modifiations.<br />
<br />
*<br />
*<br />
<br />
We are planning to use Git as an administrative and version control tool.<br />
<br />
* All dictionaries releases will be in a single repository and available to any member of the community to continue the work.<br />
* Each user will have your own branch to work on.<br />
* The users will be able to make merge requests with the official branch.<br />
* At first, we will use GitLab (or similar tool) to manage this merges requests. The team who maintain each dictionary will judge if the modifications are valid or not.<br />
<br />
==Example of Iteraction==<br />
<br />
===1. Choosing an official dictionary and importing it===<br />
The Official Dictionaries page display all available dictionaries in the git repository. Each version correspond to a tag in the master branch.<br />
[[File:Prototype1.png|thumb|250px|none|Choosing an official dictionary and importing it]]<br />
Once imported, the user will name this dictionary and it will appear on the My Dictionaries page.<br />
[[File:Prototype2.png|thumb|250px|none|My Dictionaries page]]<br />
<br />
===2. Loading the dictionary file===<br />
On the Language File page, the user selects one of their dictionaries and the dictionary XML will be formatted to be temporarily saved to a database. Also on this page, the user can edit the dictionary alphabet and see some statistics about it.<br />
<br />
The Symbols, Paradigms, and Lemmas pages refer to the dictionary selected here.<br />
<br />
[[File:Prototype3.png|thumb|250px|none|Loading the dictionary file]]<br />
===3. Verifying if the lemmas already exists===<br />
On the Lemmas - Search page, the user will be able to see all the inflections of the dictionary lemmas and check if the lemma he wants to add already exists.<br />
<br />
[[File:Prototype4.png|thumb|250px|none|Verifying if the lemmas already exists]]<br />
===4. Creating the new lemma===<br />
In the Lemmas - Create page, the user will follow three steps to add a new lemma.<br />
<br />
In the first step, the user will define the lemma and the lemma root. In addition, he will give some examples of inflections and symbols to receive suggestions on which paradigm to use.<br />
<br />
[[File:Prototype5.png|thumb|250px|none|text-top|Creating the new lemma - Step 1]]<br />
In the second step, the user will see paradigm suggestions (or can see all paradigms). When a paradigm is selected, all inflections of the created lemma will be shown to the user. If none of the paradigms fit, the user will be directed to create a new paradigm.<br />
<br />
[[File:Prototype6.png|thumb|250px|none|Creating the new lemma - Step 2]]<br />
In the third and last step, the user will confirm and save the change. At this point, a branch will be create for this dictionary in the git repository (if she doesn’t already exists) and a commit with this changes will be done.<br />
<br />
[[File:Prototype7.png|thumb|250px|none|Creating the new lemma - Step 3]]<br />
===5. Merge Request===<br />
On My Dictionaries page, the user can create a merge request that will be judge by the master branch maintainer.<br />
<br />
[[File:Prototype8.png|thumb|250px|none|Merge Request]]<br />
===6. Official dictionary keeper judges the merge request===<br />
<br />
===7. Feedback===<br />
On Merge Requests page, the user can see all request he have made and their status.<br />
<br />
<br />
[[File:Prototype9.png|thumb|250px|none|Feedback]]<br />
<br />
==First Experiments==<br />
[[File:WebPrototype-1.jpg|thumb|500px|left|Example]]<br />
[[File:WebPrototype-2.jpg|thumb|500px|right|Example]]<br />
<br />
<br />
[[Category:GSoC 2019 student proposals|Alessio]]</div>Alessio