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 21: 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:<br />
  
−
# [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.
+
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 />
−
# Mediawiki’s [https://www.mediawiki.org/wiki/Extension:Collection Collection]  Extension allows user to collect articles and generate downloadable versions in different formats (including XML format too). It is configured by default to use the server http://tools.pediapress.com/ . For high traffic, we need to set up [http://mwlib.readthedocs.org/en/latest/installation.html mwlib] and setup our own render server which will generate the docbook XML output. The source code is available https://github.com/wikimedia/mediawiki-extensions-Collection
 
−
# Fedora’s [http://fedoraproject.org/wiki/DocBook_Editor_Documentation Beacon] project which was a done as GSoC 2009 is an XML editor which allows user to upload, create or edit docbook and parse the XML and return the HTML weboutput. The source code is available https://github.com/satya/beacon
 
  
−
===Basic Layout of the project:===
+
2. Mediawiki’s [https://www.mediawiki.org/wiki/Extension:Collection Collection]  Extension allows user to convert from Wiki markup to Docbook XML. It is configured by default to use the server http://tools.pediapress.com/ . For high traffic, we need to set up [http://mwlib.readthedocs.org/en/latest/installation.html mwlib] and setup our own render server which will generate the docbook XML output.<br />
−
# User will be given two edit options - wiki markup or Docbook XML.<br />
 
−
# 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 />
 
−
# 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.
 
  
−
===Approach for the project===
+
3. Fedora’s [http://fedoraproject.org/wiki/DocBook_Editor_Documentation Beacon] project which was a done as GSoC 2009 is an XML editor which allows user to upload, create or edit docbook and parse the XML and return the HTML weboutput.
  
−
There are basically two approaches for this project: <br />
+
===Basic Layout of the project:===
−
 
+
1. User will be given two edit options - wiki markup or Docbook XML.<br />
−
1. We can use a combination of Mediawiki's Collection Extension and Beacon Editor inorder to fufill the goal of this project. <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.
−
'''Conversion from wiki to Docbook -''' Collection Extension focuses on creating books by collecting articles and exporting this book to a variety of formats including the docbook XML format. This extension works as a special page. For our project, instead of this being implemented as a special page, we need to call this extension whenever a user chooses to edit the wiki.
 
−
 
 
−
'''Conversion from Docbook to wiki -''' Since Beacon project is an XML editor. This can be used to fetch XML to the edit window and then parsing this XML to generate the HTML web output.
 
−
 
 
−
[[File:Mockup.png]]
 
  
−
2. Instead of using combination of different tools, we can define our own mediawiki extension which intelligently maps wiki markup to docbook XML markup and serves both the purposes simultaneously. This can be done with mediawiki parser functions.
+
===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.
  
−
I am strongly in favour of following the first approach since there are already tools available which can fulfill the purpose. This may need a few quick experiments to be done with these tools. I will utilize the community bonding period and figure out which of them would require lesser effort and is more efficient.
+
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 to edit wiki syntax and Docbook XML.
+
* A mediawiki extension having two edit options - Wiki and Docbook.
−
* Providing XML markup instead of wiki when a user chooses "Edit the Docbook format".
+
* 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 54:
 
*'''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.
  
−
*'''Week 1-2 (May 19 to June 1):''' Making a skeleton for the extension and giving options to edit in Docbook XML format and wiki format.
+
*'''May 19 to May 31:''' Making a skeleton for the extension and giving two edit options - wiki and docbook.
  
−
*'''Week 3-5 (June 2 to June 22):''' Work on Wiki to Docbook Conversion (This includes integration with the Collection Extension, providing the user with an option to download the XML file generated)
+
*'''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.
  
−
*'''Week 6-8 (June 23 to July 13):''' Work on Docbook to Wiki Conversion (This includes fetching of XML in the edit window and parsing this XML to generate the Web output)
+
*'''July 16 to July 31:''' Testing and bug fixing
  
−
*'''Week 9 (July 14 to July 20):''' Work on improving the User Interface part.
+
*'''August 1 to August 10:''' Writing relevant Documentation
  
−
*'''Week 10 (July 21 to July 27):''' Check for errors and fixing bugs.
+
*'''August 11 to August 18:''' Final Evaluations
−
 
 
−
*'''Week 11 (July 28 to August 3):''' Writing relevant documentation
 
−
 
 
−
*'''Week 12-13 (August 4 to August 17):''' Prepare for final Evaluations
 
  
 
==Time availability==
 
==Time availability==
Line 81: Line 71:
  
 
==Past Experiences==
 
==Past Experiences==
−
* 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://github.com/wikimedia/mediawiki-extensions-Annotator here]. Here is a complete list of bugs that I have solved for Mediawiki [https://gerrit.wikimedia.org/r/#/q/owner:%2522Rjain%2522,n,z Bugs I have Worked On]. I was also a speaker at FOSSASIA 2014 (Asia's largest open source conference) where I gave a talk on "Annotator" Extension that I built for Mediawiki.
+
* 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.
−
 
−
I have also submitted one pull request for OGV https://github.com/harman052/geometry_viewer/pull/2
 
−
 
−
==Why BRL-CAD==
 
−
I was searching for projects in which my skills can be utilized and when I tried out with BRL-CAD, the thing which I liked the most is that the community here is very helpful and reponsive on the mailing list and IRC. The guidelines are well-defined for GSoC students and it motivates people to make improvements.
 
  
 
==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

Please note that all contributions to BRL-CAD may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see BRL-CAD:Copyrights for details). Do not submit copyrighted work without permission!

To edit this page, please answer the question that appears below (more info):

Cancel Editing help (opens in new window)
Retrieved from "https://brlcad.org/wiki/User:Richajain1912/GSOC2014/"