Editing User:Richajain1912/GSOC2014/
From BRL-CAD
Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.
The edit can be undone.
Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
Latest revision | Your text | ||
Line 2: | Line 2: | ||
'''Name:''' Richa Jain <br /> | '''Name:''' Richa Jain <br /> | ||
'''E-Mail:''' richa.jain1912@gmail.com <br /> | '''E-Mail:''' richa.jain1912@gmail.com <br /> | ||
− | '''IRC Nick:''' richa (#brlcad on freenode) | + | '''IRC Nick:''' richa (#brlcad on freenode) |
− | |||
==Background Information== | ==Background Information== | ||
− | Hi, I am Richa Jain, a third year Undergraduate student from Indian Institute of Technology Roorkee. I am currently a developer at Software Development Section of my institute | + | Hi, I am Richa Jain, a third year Undergraduate student from Indian Institute of Technology Roorkee. I am currently a developer at Software Development Section of my institute. I was also a GSoC 2013 student under Wikimedia Foundation and now I am looking forward to work with BRL-CAD. |
=Project Information= | =Project Information= | ||
Line 22: | Line 21: | ||
===Tools available for conversion between Wiki to Docbook and Vice-Versa:=== | ===Tools available for conversion between Wiki to Docbook and Vice-Versa:=== | ||
There are some tools available which convert docbook to wiki or vice-versa which can be used for this project: | There are some tools available which convert docbook to wiki or vice-versa which can be used for this project: | ||
− | + | 1. [https://github.com/jgm/pandoc pandoc] converts from one markup to another. However, while conversion between wiki and docbook, some of the tags are lost and hence the data is not preserved.<br /> | |
− | + | 2. Mediawiki’s [https://www.mediawiki.org/wiki/Extension:Collection Collection] Extension allows user to export the wiki into docbook XML. <br /> | |
− | + | 3. Fedora’s [http://fedoraproject.org/wiki/DocBook_Editor_Documentation Beacon] project is an XML editor converting XML format into the HTML web output. | |
− | |||
===Basic Layout of the project:=== | ===Basic Layout of the project:=== | ||
− | + | 1. User will be given two edit options - wiki markup or Docbook XML.<br /> | |
− | + | 2. If a user chooses editing Docbook, the docbook XML will be displayed in the editing window rather than wiki syntax. When the user clicks on “save”, the entire XML is processed and converted to wikitext and the HTML output is displayed.<br /> | |
− | + | 3. If a user prefers to edit wiki markup, then after clicking “save” button the wiki markup is converted to docbook and the user is given an option to download the XML file. | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | ' | + | ===Possible approaches for the project=== |
+ | There are basically two approaches for this project:<br /> | ||
+ | 1. Since mediawiki's Collection extension[1] converts wiki markup to Docbook XML and for the vice-versa, projects like Beacon[2] converts Docbook to weboutput. | ||
+ | So, in order to have a synchronization between the two edits we must use both the technologies in a combined way.<br /> | ||
+ | 2. Instead of using both of these technologies, we can define our own mediawiki extension which intelligently maps wiki markup to docbook markup and serves both the purposes simultaneously. This can be done with mediawiki parser functions. | ||
− | + | This needs some research regarding which approach will be more beneficial, so I will utilize my time during the community bonding period in finding out a reliable method. | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
==Deliverables== | ==Deliverables== | ||
− | * A mediawiki extension having options | + | * A mediawiki extension having two edit options - Wiki and Docbook. |
− | * Providing XML markup instead of wiki when a user chooses "Edit | + | * Providing XML markup instead of wiki when a user chooses "Edit via Docbook". |
* Mapping Docbook and wiki by using any of the approaches described above such that there exists a synchronization between the two edits. | * Mapping Docbook and wiki by using any of the approaches described above such that there exists a synchronization between the two edits. | ||
* Adding an option to download the XML file once a user has finished editing wiki markup. | * Adding an option to download the XML file once a user has finished editing wiki markup. | ||
Line 60: | Line 50: | ||
*'''May 1 to May 18 (Community bonding period):''' Investigating the two approaches described above, making few experiments with Beacon and Collection Extension and deciding which of the two will be better. | *'''May 1 to May 18 (Community bonding period):''' Investigating the two approaches described above, making few experiments with Beacon and Collection Extension and deciding which of the two will be better. | ||
− | *''' | + | *'''May 19 to May 31:''' Making a skeleton for the extension and giving two edit options - wiki and docbook. |
− | *''' | + | *'''June 1 to July 15:''' Implementing the backend of the extension. This involves fetching of XML to the edit window and mapping XML to wiki and vice-versa using any of the two approaches. |
− | *''' | + | *'''July 16 to July 31:''' Testing and bug fixing |
− | *''' | + | *'''August 1 to August 10:''' Writing relevant Documentation |
− | *''' | + | *'''August 11 to August 18:''' Final Evaluations |
− | |||
− | |||
− | |||
− | |||
==Time availability== | ==Time availability== | ||
Line 81: | Line 67: | ||
==Past Experiences== | ==Past Experiences== | ||
− | * I was a Google Summer of Code 2013 student under Wikimedia Foundation. I worked on making a | + | * I was a Google Summer of Code 2013 student under Wikimedia Foundation. I worked on making a mediawiki extension (Annotator) which allows user to make inline comments on a wiki article. This project was based on PHP, JavaScript. The source code can be seen [https://git.wikimedia.org/summary/r=mediawiki/extensions/Annotator.git here] |
* My open source projects can be seen on [https://github.com/richajain github]. | * My open source projects can be seen on [https://github.com/richajain github]. | ||
==Why me== | ==Why me== | ||
I will work hard and bring this project to completion. I am always logged in to IRC (#brlcad) whenever I work and also do respond to the emails quickly whenever I am awake. I will keep a repository of this project on github and make frequent commits. I will always be in touch with my mentor and the community and taking help from people around whenever I am stuck. | I will work hard and bring this project to completion. I am always logged in to IRC (#brlcad) whenever I work and also do respond to the emails quickly whenever I am awake. I will keep a repository of this project on github and make frequent commits. I will always be in touch with my mentor and the community and taking help from people around whenever I am stuck. | ||
− | |||
− | |||
− | |||
− | |||
− | |||
==References== | ==References== | ||
[1] https://www.mediawiki.org/wiki/Extension:Collection <br /> | [1] https://www.mediawiki.org/wiki/Extension:Collection <br /> | ||
[2] http://fedoraproject.org/wiki/DocBook_Editor_Documentation | [2] http://fedoraproject.org/wiki/DocBook_Editor_Documentation |