Extension:Translate/Mass migration tools
 | This page is obsolete. It is being retained for archival purposes. It may document extensions or features that are obsolete and/or no longer supported. Do not rely on the information here being up-to-date. This was a Google Summer of Code/2014 project/proposal. |
Project Outline
[edit]The MediaWiki Translate extension has a page translation feature that allows structured translation of wiki pages. It makes the task of translation easier by providing a user-friendly interface that consists of text strings split into translation units. Non-translatable content (for example, images) is excluded from the process of translation. Though that makes the job easy with a rich editor supporting various languages, a lot of effort is required to prepare the page for translation, i.e, the page under question first needs to be converted into a format that would be recognized by the Translate extension. The process of preparing the page for translation needs to take into consideration various markups which becomes a tedious task when done manually. Plus, wikis have a lot of legacy content that still needs to be prepared for translation.
Thus, with this motivation, the project aims to facilitate this conversion and thereby save manual time and effort. The tool developed would thus make the page translatable, and once that is done, it would import the translations (which were present before the page was made translatable) into the Translate extension. Thus, the entire process of importing translations, which involved a significant amount of manual effort gets automated by this project.
Mentor's summary
[edit]- Copied from Nemo's m:IRC office hours/Office hours 2014-08-19 while a wrap-up report is pending.
Hello all! BPositive/Pratik Lahoti, mentored by me and Nikerabbit/Niklas Laxström, has worked on Translate extension's Mass migration tools. ur1.ca/i09ny The problem: each multilingual wiki, like Meta and its spin-off mediawiki.org, in 10 years before Translate, accumulated thousands of translation pages and hundreds of thousands of strings which we need to manually migrate for Translate adoption.
The goal: make extremely hard work slightly less hard. The approach: a special page to import old translations, where copy-and-paste work is made less wrist-damaging by simple markup heuristics; and one to reduce manual basic preparations for new pages, with a set of regexes.
Hard work means few users, but important ones to support: they're happy to see this, but so far little usage other than myself. You can see it used e.g. at ur1.ca/i09li , or just try yourself on a Translate wiki, e.g. at https://www.mediawiki.org/wiki/Special:PageMigration / PagePreparation. The tool is currently restricted to translation administrators.
We tried hard to stick with MediaWiki best practices and have all work documented on bugzilla ur1.ca/i09m9 , so you can easily see what the work is and was about. ur1.ca/i09mr June was the most intense month and saw PageMigration deployed, then BPositive started a full time job and we slowed down a lot. The basic pieces are in place, but there are some features missing and this means that on a certain amount of pages the feature will be less useful than we'd like it to be.
As of November 2014, we know of around ten users in mediawiki.org and Meta-Wiki, who used the tool to make over 4000 edits.
Bug on Bugzilla
[edit]- General issue: Bug #46645
- Tickets for the project: [1] (by priority)
- Help testing and give feedback
- Use http://pagemigration.wmflabs.org
- Report a bug: [2]
- Watch this page and comment on talk
Thread on Mailing List
[edit]Announcement on Wikitech-l
Participation
[edit]IRC has always been my first option whenever I am stuck at something. I never hesitate to ask questions, however silly they might be. I would be available on IRC by the nickname BPositive on channels such as #mediawiki, #mediawiki-i18n, #wikimedia-dev. I am also suscribed to different mailing lists such as wikitech-l, mediawiki-i18n, translators-l, Mediawiki-India and I would appreciate all discussions related to my project to be carried on the above mentioned IRC channels and mailing lists.
I have a blog where I can update all the progress of my proposed project. I would also write weekly/monthly reports on MediaWiki itself to keep the community updated about the project.
The approach
[edit]The project aims at creating a tool which will essentially work as follows:
Step 1: Make the page translatable: This would involve -
- Getting the raw source text of the page in question. This can be done using the Parsing API
- Removing the
{{Languages}}template, if present, and adding the<languages />tag at the top of the page - Adding the
<translate>...</translate>tags - Converting the various elements into their translatable equivalents as per the markup examples. (Basically, to cut it short, this step of the tool would convert the manual document into code, as per my understanding)
- Adding
{{Langcat}}for all the Categories - Once all the necessary changes have been made, the page under question would be saved with the updated text, upon user confirmation.
The page is now ready for translation. The user can mark the page for translation now, after which the Translation Extension will perform its job of breaking it into translation units.
Step 2: Import the translations: This would involve
- Getting the list of languages in which the translation exists for the page under question
- For each of the languages:
- Grab the latest version of the page before FuzzyBot's edit
- Copy the translations present in that version unit by unit to the Translate Extension. This can be done either by comparing the lengths, checking if the string contains links which point to the same page. That would indicate a match and a series of (un)checkboxes and/or matching/mapping slides can be provided to the user. Another way of doing this would be to translate the English text using a machine translation interface provided by the Content Translation extension and compare it with the translated version we have. Performance, accuracy and usability will be the deciding factors. See also Design.
- Create corresponding page of the format
Translations:Page/<translation unit identifier>/<language code>and save it.
By the end of this step, the translations have been imported into the Translate Extension.
Each of these sub-steps would involve considering various possibilities and corner-cases, which would be handled as the project progresses.
Deliverables
[edit]- Further refined at Requirements
- User of the system: Translation administrator
- The Migration Tool: The tool would do the backend work, as mentioned above in 'The approach' section. This can be implemented -
- As a server side PHP script: If implemented as a PHP script, the tool would be called as the 'MigrationBot', and all the edits would be thus saved under the bot's name. The script would be a part of the Translate Extension code base. This has the advantage of best access to data, but at the same time has the drawbacks of difficulty in deployment and delay in testing.
- As a JavaScript gadget: If developed as a JS gadget, the edits would be made under the user's account. This has the advantage of easy access to data. Deployment and testing would be faster compared to the first method.
- A user interface asking for confirmation, showing the changes done in "Step 1 - Preparing the page for translation". This can be accomplished by:
- Simply re-offering the editing window to the user. The user would review the changes done and save the text using the "Save Page" button
- Offering the editing window integrated with some syntax highighting editor like CodeEditor. This would make the job of a TA easier by highlighting the changes made by the tool
- A series of confirmation dialogs showing each step performed by the tool. Though this would make it easier for the user to review the changes, it can get annoying at times. Plus, verifying each of the sub-tasks performed and then combining would make the otherwise simple task complicated
- A user interface asking for confirmation for the imported translations in "Step 2". The interface would aim at eliminating the tab switching + copy-pasting task and thereby would have the source language text and the target language text besides each other with "Yes" and "No" buttons.
- Upon selecting "Yes", the imported translation would be saved by creating the corresponding page
- Upon selecting "No", the blocks on the right hand side would be allowed to split or drag and drop to match the corresponding blocks.
Use Cases
[edit]
The following events would occur during migration of the page:
- The tool would be invoked in one of the following ways:
- Placing a link under the "Tools" section in the left hand side panel
- Providing a button in the editing window
- Confirmation screens for step 1 would be shown
- The user would confirm the changes made in the text and then mark the page for translation
- The Translate extension would split it into translatable units
- Upon confirming the splitted units clicking the "Save page" button, one of the following will occur:
- The step 2 would be triggered and imports will commence
- A dialog box saying something like, "It seems this page already had some translations. Do you want to import them to this system now?" would be shown. If 'Yes', the imports will commence and if 'No', a link under Tools would be added for access in the future (or a message at the top of the page in).
- Confirmation screen(s) for step 2 would be shown
The same has been depicted in the sequence diagram below:
If time permits
[edit]If things go as planned and I still have some time, I would be completing one or more of the following task(s):
- Implementing an automatic feedback system for the second part of the project. A database would be created, which would store user feedback on how they think the tool should have detected the unit correctly. This feedback would help in tweaking the detection algorithm for step 2.
- Allow the imported translations to be corrected in the confirmation screen itself by making them editable. This would help to complete the process in the confirmation screen itself rather than going to Special:Translate.
Project Schedule
[edit]| From-To Date | Timeline |
|---|---|
| Until Apr 22 | Thoroughly reading the existing documentation related to Translate extension, learning the coding conventions and setting up the coding environment |
| Apr 23 to Apr 25 | Gathering of requirements from end users and documenting them |
| Apr 28 to May 2 | Designing the algorithm for the Migration Tool |
| May 3 to May 5 | UI Designing for the confirmation screens |
| May 6 | Development of a module to access the raw source text of a wiki page |
| May 7 to May 28 | Coding of the confirmation and publishing screens related to Step 2, with basic initial import of old text |
| May 29 to June 7 | Coding rest of Migration Tool - Step 2, particularly a better initial alignment of the units |
| June 8 to June 22 | Coding of the Migration Tool - Step 1, taking into consideration all possibilities and corner-cases |
| June 23 to June 24 | Midterm Evaluation |
| June 25 to July 7 | Coding of the Confirmation screens related to Step 1 |
| July 7 to July 12 | UI Enhancements |
| July 12 to July 19 | Documenting the code completely, writing unit tests |
| July 19 to July 26 | Unit testing of the code and gathering bugs/errors |
| July 26 onwards | Bug fixing and improving the documentation |
| August 11 | Pencils Down |
| August 22 | Submitting code samples to Google |
Notes:
- During the Requirement Gathering Phase, I will keep working on the next task in parallel
- After July 7, I might have reduced working hours (30 hours per week), as I will be moving to a new city. I will be working after my office hours, but I ensure that the tasks planned will be completed on time. The project schedule has been planned accordingly.
- I plan to write the documentation and unit tests as the project goes along.
Personal information
[edit]Identity
[edit]Name: Pratik Lahoti
Email: [email protected]
Project title: Tools for mass migration of legacy translated wiki content
Contact/working info
[edit]Timezone: UTC+5:30 (IST - India)
Typical working hours: 10:00 to 14:00 (IST) and 20:00 to 2:00 (IST) (however, can adjust and go beyond if required)
IRC or IM networks/handle(s): BPositive (freenode)
I have a stable internet connection at home without any proxy issues. So, connectivity won't be an issue at any point of time
Mentors
[edit]Niklas Laxström and Federico Leva are my mentors for this project.
About me
[edit]I am Pratik Lahoti, from Pune, India. I am a final year Information Technology student from College of Engineering, Pune. I am known on all wikis as BPositive, and that's the attitude I carry with me! :) My journey on Wikipedia started as an editor. I was later selected as the Campus Ambassador for Wikipedia's India Education Program. I have also coordinated the WikiProject Indian Collaboration of the month whereby I carried out collaborations with editors from all over India. Owing to my contributions, I was fortunate to be a featured Wikimedian for the month of April 2012 on Wikimedia India. Contributing to FOSS projects, attending seminars, and involving more and more people in the movement has always been my passion!
I have met and worked with the WMF Language Engineering Team at hackathons held at Gnunify and their enthusiasm has been infectious! Hence, I would like to work with them.
Past Open Source Experience
[edit]I have been a promoter of FOSS in my college. I have conducted workshops for my juniors on subjects like "Introduction to FOSS", "Introduction to Vim", "Getting started with Git". I am also an active member of Google Developers Group Pune and have participated in a couple of hackathons and also attended several workshops. I have been attending Gnunify for the past four consecutive years and have interacted with many people from the Open Source community. I have also participated in the Translation sprint held by the WMF Language Engineering Team at Gnunify'13 and carried out translations for Marathi (mr) language on translatewiki.net.
Acknowledgment
[edit]I would like to thank my mentors, Niklas Laxström and Federico Leva for their valuable assistance in drafting this proposal and their time to time suggestions. I would also like to thank Sumana and Quim for helping me polish this proposal and ensuring that I complete the tasks on time. Finally, I would like to thank all the community members who provided help/feedback on the discussion page as well as on IRC.
Any other info
[edit]- Microtasks performed
- Solved some bugs related to the Translate extension
- Wrote a UserScript which returns the revision before FuzzyBot's edit on the page, if at all it exists. This would be the first step of the second part of the project - importing translations.
- Manually migrated wiki pages (and will be doing more before project starts)
- Project Experience
- Participated in Google Cloud Developer Challenge 2013 and one of the developers of Direct2Drive
- Internship at Eaton Corporation - Developed a time tracking application for the employees of Eaton
- Personalized News Reader, a web application which uses Facebook page likes and Twitter followers to generate relevant news for the user. Also, I used Neo4j - a graph database for this project.
- Emergency plan
I am positive about the project getting over by the end of the program but due to some unavoidable circumstances, if I am not able to do so, I will unconditionally work on it after the program gets over and complete it.
- Post GSoC plans
I hereby announce that once the project is over, I would like to take the responsibility of the tool developed and thereby maintain it, address bugs and any other concerns from the community.