Proposal for https://phabricator.wikimedia.org/T115158
Note: Feedback is welcomed. I have collected some resources that I think will be helpful during this project https://mine0901.wordpress.com/2017/03/30/important-resources/
Name: Sonali Gupta
IRC handle: mine0901
Web Page: http://sonali0901.github.io/
User Page: https://www.mediawiki.org/wiki/User:Mine0901
Location: Jaipur, India
Time Zone: UTC+05:30
Typical working hours: 10 AM to 2 AM.(UTC+05:30)
On college days, occupied between 1 PM to 4 PM.(UTC+05:30)
Citoid service relies heavily on Zotero's translation-server which makes use of translators to get citation metadata from specific pages. Translators are written for various browser support, namely, Firefox, Chrome, Safari, Internet Explorer and Bookmarklet. The existing detailed documentation for writing a translator in the browser plugin is almost 10 years old. The documentation on the wiki is also outdated. For Citoid it is necessary for the translators to work in translation-server. This project will focus on preparing documentation on mediawiki.org(https://www.mediawiki.org/wiki/Citoid/Creating_Zotero_translators) on How to write a Zotero translator that works in translation-server, keeping Citoid in mind and including the current Zotero code updates.
The process of documentation will include the creation of a sample translator. Translation of the above-mentioned documentation in Hindi will be a part of the project. Solving bugs in Zotero upstream and writing the requested translators is also in the scope of this project.
**Mentors**: @Mvolz, @czar
**Experience + Contribution made for the project**
WMF has been providing the essential content online that helps students like me to explore and learn new stuff. It is the most reliable and informative source on the internet. I would say I have been a WMF product user since the time I started using the internet.
I have been active on phabricator and I started working and interacting with WMF developers from 23rd February 2017. For this project, it was important for me to first understand what Zotero translators are. So we were provided some minor tasks to complete to familiarize ourselves with the code structure of Zotero project. While working on my initial contributions, I communicated with mentors at WMF and Zotero developers, asked for help and suggestions. The positive responses from them helped me decide that I want to be a part of this team and contribute to the best of my potential.
- https://phabricator.wikimedia.org/T95128 - Citation for OpenLibrary returned incorrect author information. The task was to file this bug to Zotero upstream. For solving this microtask I installed Zotero translation-server and tested the bug and reported it upstream.
- https://phabricator.wikimedia.org/T158675 - WM fork of Zotero’s translator repository was behind by several commits and needed an update. This task helped me learn about Gerrit and how to push code for review.
- https://github.com/zotero/translators/pull/1250 - Deleted an outdated translator.
After getting a basic idea about the use of these translators, I took a step further and wrote a translator from scratch and solved code related bugs.
- https://github.com/zotero/translators/pull/1280 - I created a PR to resolve the bug leading to incorrect citation data (T95128)
- https://github.com/zotero/translators/pull/1282 - Created a translator for a leading English newspaper in India. I explored several concepts while writing it which will be important for the project. I took help of Zotero-translator documentation and existing translators in the same category. The PR is merged.
- https://github.com/zotero/translators/pull/1291 - I rewrote the translator for The Globe and Mail. After the site updation the old translator was failing. The PR is being reviewed. I learned how to use meta tags and made a note to write descriptive commit messages as suggested by Mvolz.
- https://github.com/zotero/translators/issues/796 - Currently working on it. It is a translator for a catalog and is different from the above translators.
**Past Experience with Open Source Software**
I have been a full-time Linux user for 3 years and I use open source software all the time. I started contributing to an open source organization named [[ https://www.zulip.org/ | Zulip ]] during the application period of Outreachy 13. Zulip is a powerful open source group chat platform, with great features making it preferable over other chat platforms. I solved some code based issues in python, the links to those are -
I also did some documentation tasks at Zulip:
Working with Zulip community has always been an enriching experience for me. There are live coding sessions now and then for new contributors, a great initiative by the core developers. I wanted to give back to the community and volunteered to be a [[ https://www.dropbox.com/s/ds7ih763xq6cw4m/Certificate%20for%20Sonali%20Gupta.pdf?dl=0 | Zulip mentor ]] for Google Code-In 2016. The task I handled was the creation of User Documentation for Zulip’s features and improvement of existing User pages. With other mentors, I helped in designing tasks before and during GCI and I guided students in their introductory tasks and helped them in using git and Github. I recently moderated one of the online English-tutorial sessions organized by Zulip.
**About the project**
I have tried to work out an outline for the documentation that I will prepare. I am planning to include a section that explains translators like Embedded Metadata, BibTex, RDF, Marc and how to call another translator inside a translator.
**Table of content**
# Brief about Citoid and Zotero translators – This will include a synopsis of these software and information about their features.
# Relationship between Citoid and Zotero - How Citoid makes use of Zotero will be the focus of this section. What is required in Zotero translators to be compatible with Citoid, the main motivation of the documentation will be explained in this section.
# Installation and setup of required software(procedure explanation through screenshots)
# Common code blocks in Zotero translators - For each block, code snippet and the result of the block – There are specific code blocks that are included in almost all the new translators and make it easy for new and old developers to come up with a translator.
# Information of the Zotero Utilities with examples
# Build a sample translator(Screenshots of tools and code snippets) – Following all the above-mentioned points, a sample translator will be built at translation-server side.
# Testing a translator - Before a translator is submitted to get live in production, it must be tested by the developer. Use of automated testing by Scaffold.
# Getting a translator live
# Troubleshooting - Common errors faced during installation of tools. General errors that are thrown by the code. Errors during testing.
# Useful links - Links to courses(HTML, XPath, etc.), Links to Videos, Links to developer forums.
# See Also
**Elements of the documentation will remain as follows:**
- Code snippets
30th March - 28th April
- Work with Citoid and Visual Editor. Solve tasks at https://phabricator.wikimedia.org/tag/citoid/ .
- Continue writing new translators.
- Solve bugs and gather information about translators.
30th April - 29th May
- Community bonding period.
- Search and finalize the sample translator to be used for documentation.
- Study the existing translators for blogs, catalog, magazine, newspaper and learn the similarities and differences between them.
- Solve Zotero bugs and write translators. Mark bugs to solve during the internship period.
- Study the different types of translators(COinS, BibTex, RDF, etc.)
Week 1(30th May - 5th June)
- Complete section 1 of the documentation, that is, brief about Citoid and Zotero.
- Solve https://github.com/zotero/translators/issues/1206
- Complete section 2.
Week 2(6th June - 12th June)
- Document(section 3) Installation of Zotero, Scaffold, Firebug and text editor for JS(code snippets will be for Ubuntu OS user).
- Solve https://github.com/zotero/translators/issues/1020
Week 3(13th June - 19th June)
- Complete section 4(synopsis of concepts needed).
- Cover detectWeb and getSearchResults functions(section 5).
Week 4(20th June - 26th June)
- Cover scrape and doWeb functions(section 5).
- Write subsection about Zotero Utilities.
Week 5(27th June - 3rd July)
- Document how to write a translator for the sample site(section 6). This section will have sub-sections holding code snippets specific to the sample site and their outputs. This section can be finished smoothly making use of already provided documentation in the previous sections. (Use of common code blocks)
Week 6(4th July - 10th July) + Week 7(11th July - 17th July)
- Section 7,8,9,10,11
The documentation will be shared to be reviewed by developers at Zotero and WMF and their ideas/suggestions will be incorporated. Once the content is developed, translation to Hindi will be done. The crucial(and time taking) part for Hindi translation is typing in Hindi and researching words that are commonly used in other pages on MediaWiki.
Week 8(18th July - 24th July)
- Complete section 1,2,3
Week 9(25th July - 31st July)
- Complete section 4,5
Week 10(1st August - 7th August)
- Complete section 6
Week 11(8th August - 14th August)
- Complete section 7
Week 12(15th August - 21st August)
- Document section 8,9,10,11
- Share the documentation for review + improve it.
Week 13(22nd August - 30th August)
- Give final touch to documentations and get approval from the mentor for English and Hindi.
- A blog post for my complete journey.
30th August and later
- Start code-based contributions in WMF. Explore Citoid and other projects on WMF to contribute to.
- Be an active member of the community.
- Participate in future programs as a volunteer and a mentor.
Every week, I will post blogs about my progress and get my work reviewed by mentors. This will help in cleaning each section before moving to the next in the following weeks.
**Other deliverables during the internship**
- Blog posts on my progress every week.
- Blog posts on my experience with WMF and/or FOSS-related topics at least once every two weeks.
- Regular communication with my mentors and other community members at WMF.
I am an undergraduate student, pursuing a degree in Bachelor of Technology in Computer Science and Engineering from [[ http://lnmiit.ac.in/ | The LNM Institute of Information Technology, Jaipur, India ]]. I am in the 6th semester of my eight-semester program. I will graduate in May 2018. I am an active member of my institute’s Open Source Society and Mozilla society. As a member, I have attended and taken up the organization of various workshops on the Git, Open Source, How to contribute to Mozilla and Womoz, etc. Our team at FOSS organized the conference of KDE in 2016 which was my first open-source conference. I also met WMF contributors at the WikiToLearn conference 2017. Steve Jobs said, "Everybody should learn how to program a computer because it teaches you how to think" and I feel open source software and communities make it easy for people to join and be a part of software development. The concept of Outreach programs like Summer of Code motivates and help so many people. The best part is that all the communities are welcoming towards new contributors.
**How did I learn about Outreachy?**
I read about Outreachy in a magazine (OpenSource For You) and had a discussion with a senior in college who explained me much about it. Later I came in contact with many open source enthusiasts and also had interactions with a few past interns of Outreachy. The program is a wonderful initiative. I will be obliged to be a part of this program through the community Wikimedia.
- Android App Development for Inter-App Communication: The aim of this project was to develop all possible combinations of Android apps with source and sink varying between activity, service and broadcast receiver. The first app read call logs and sent the data to the second app to save them in sd card(external memory). The intents taken into action were explicit, implicit and pending intents. The apps were hidden (malicious apps, with least or no GUI). I created 52 apps(26 pairs). The apps were created for a larger project where the behavior of different android versions was to be studied. https://github.com/sonali0901/Android_Mystery
- Web application in Django for FOSS community of my institute: Our team developed a web application in Django with Postgresql to provide a platform for blogs, directories of achievements, sessions and conferences along with interesting stuff related to FOSS LNMIIT. This project is under development. https://github.com/fosslnmiit/fosslnmiit-website
- Blog in Django: I mentored a group of 3 students for a winter internship program under the student chapter of Computer Society of India of my college wherein I took online sessions during holidays to teach them about Django(through DjangoGirls tutorial) and build a blog. Later we included Facebook plugins to provide more features. http://mine0901.pythonanywhere.com/
- Two Pass Assembler: With a team of 4, I prepared an Instruction Set Architecture and wrote mnemonic codes for two C programs. We then created a program to convert those mnemonic codes to binary and another program to execute the binary code. So a two pass assembler for defined ISA was written in C. https://github.com/sonali0901/Two-Pass-assembler
**Will you have any other time commitments, such as school work, exams, research, another job, planned vacation, etc., between May 30, 2017 and August 30, 2017? Please provide exact dates for these commitments and the number of hours a week these commitments take.**
I will have summer vacations from 30th May to 30th July. That will be 8 weeks in the internship which I will work full-time. From 31st July to 30th August, I will have school work which will take at max 3-4 hours a day, an average of 24 hours a week.
**If a student, please list the courses you will be taking between May 30, 2017 and August 30, 2017, how many credits you will be taking, and how many credits a full-time student normally takes at your school. Please provide a link or upload your program's suggested curriculum by semester, which includes the suggested number of credits in each semester. Please provide a link or upload your school's academic calendar.**
A full-time student averagely takes 23 credits per semester. My 7th semester allows me to choose the number of courses as all the core courses will be over by the current semester. I will have to take 3 credits for BTech Project that runs for a year. I will be taking open electives and program electives such that the entire sum of my credits remains 12 or less. There will be no examination during the internship period.