1
edit
Changes
→Development updates
=Description=
This project aims to turn the [http://142.204.133.123/dxr DXR] into an extension that can be installed in Firefox or distributed as a XUL/[http://labs.mozilla.com/2007/10/prism/ Prism] application. This will allow developers with limited or no internet connection to access it the Mozilla source code and documentation in an offlineenvironment. The extension will also provide a low-bandwidth solution for pushing applying updates on a timed interval or at the user's command. The [http://142.204.133.123/dxr DXR] is a compilation of Mozilla developer documentation. The plan is for this material to be distributed on a Fedora Live DVD that will allow the user to access these materials offline or, alternatively, install them for use on a Windows machine. Currently the endLocal MXR and MDRK exist as web applications that run only on Fedora and require the installation of MySQL, Perl and apache. These projects have to be setup manually and are not installable.Our part in this project would be to convert these projects so that they can be installed cross-userplatform as a Mozilla Firefox extension.
=Leaders=
=Details=
==Related Projects==
* [[Mozilla_Developer_Resource_Kit|Mozilla Developer Resource Kit]]: This is the over-arching project of which the PDXR is but one piece.
* [[Creating_an_MDRK_spin|Creating an MDRK spin]]: This is how this project will eventually be distributed.
* [[Create_Local_MXR|Create a local mxr]]: It is hoped that by solving the more difficult problem of packaging the dxr, the problem of packaging other materials such as an mxr or developer documentation will also be solved.
==Technical Overview==
===Business Rules===
* Commit to lowest file size bandwidth
===About The SourceCode===
* Backend: Perl
* Database: SQLite
* Interface: XUL
===Perl Interpreter===
Perl will be needed to create pages from database queries. It needs to be able to run from within the extension on Windows, Linux, and Mac. [http://perldoc.perl.org/perlembed.html Perlembed] allows us to use Perl from C, which means that we could compile our program with headers that will be able to alternate between Windows, Linux, and Mac.
===Web Server===
<pre style="font-family:Verdana,Helvetica,sans-serif;border:1px solid #F4C430;font-weight:bold">We are still researching for a light-weight webserver. This section be updated regularly.</pre>
Our picks (so far):
* [http://shttpd.sourceforge.net/ SHTTPD]
* [http://dclib.sourceforge.net/ dlib C++]
* [https://neuro-tech.net/files/ Cheetah Server]
* [http://www.documentroot.com/code/ppcgid Pure Perl CGId]
* [http://nginx.net/ nginx] ([http://wiki.codemongers.com/NginxEmbeddedPerlExample?highlight=(embed) Embedding example code])
List of web servers:
* [http://en.wikipedia.org/wiki/Tiny_web_servers Wikipedia's List]
* [http://www.ibm.com/developerworks/web/library/wa-ltwebserv IBM's List]
===Features===
===Architecture===
<pre style="backgroundfont-colorfamily:Verdana,Helvetica,sans-serif;border:1px solid #ffff66F4C430;font-weight:bold">The architecture is still undergoing development and this section will be updated regularly.</pre> [[Image:PDXR_high_level_diagram.png|thumbnail|right|400px|High level conceptualization]] ====Mozilla-Central====[https://developer.mozilla.org/en/mozilla-central Mozilla-Central] is the main repository for Mozilla source code. This is the raw fodder out of which documentation will be created. How it is created doesn't really appear on our diagram unless you count the "How does this happen?" note. Well, how it happens is through a static analysis tool called [https://developer.mozilla.org/en/Dehydra Dehydra]. In layman's terms, Dehydra reads the Mozilla source code and annotates it in a way that can be turned into documentation in an automated fashion. This part is another project entirely and as it relates to our project, the relevant work is being done by David Humphrey. However, our team will need to setup the Dehyra tool to feed our update server.
==Related Projects====DXR======The presentation. The front-end is mostly implemented by [http://vocamus.net/dave/ David Humphrey] on his [http://zenit.senecac.on.ca/wiki/dxr/ DXR]. We need to modify the UI to implement the following functionalities:* Navigation* Database querying* Update services* Data transaction ======UI======* Navigation* Tree:**Source Code**Documentation '''(Source code documentation)'''**Help '''(PDXR Documentation)'''**Options*** Automatic updates*** Prompted updates*** Session saving =Roadmap= * Port [http://zenit.senecac.on.ca/wiki/dxr/ DXR] <small>'''(1 week)'''</small> * Modify UI <small>'''(4 weeks total)'''</small>** Left panel:*** Source Code*** Documentation <small>(Source code documentation) '''(1 week)'''</small>*** Help <small>(PDXR Documentation) '''(2 weeks)'''</small> *** Options <small>'''(1 week)'''</small>**** Automatic updates**** Prompted updates**** Session saving * Implement the web server <small>'''(1 week)'''</small>** Test the web server on the different platforms * Implement the Perl parser <small>'''(1 week)'''</small>** Test Perl scripts on the different platforms * Code the CGI tools <small>'''(4 weeks)'''</small> =News & Updates=
==Meetings (Chronological)==
[[Portable_DXR/meeting_092608|Sept 26, 2008]]: Discussion with David Humphrey about project scope.
Oct 8, 2008: Team meeting to discuss Work Breakdown Structure (WBS)
[[Portable_DXR/meeting_101608|Oct 16, 2008]]: Team meeting to discuss technical details of project [[http://zenit.senecac.on.ca/wiki/index.php/Image:16-10-08_1751.jpg Diagram 1]] [[http://zenit.senecac.on.ca/wiki/index.php/Image:16-10-08_1801.jpg Diagram 2]]
[[Portable_DXR/meeting_102908|Oct 29, 2008]]: Further discussions with David Humphrey about documenting the project.
[[Portable_DXR/meeting_103008|Oct 30, 2008]]: Group meeting to map out high level design.
==Team Blogs==
* [http://jamesboston.ca/cms/taxonomy/term/22 James Boston]: All relevant posts are tagged 'pdxr'.* [http://sameropensource.blogspot.com Samer Ziadeh]* [http://www.jerrypau.ca/?cat=3 Jerry Pau] ==IRC==* [irc://irc.mozilla.org/PDXR #PDXR]* [irc://irc.mozilla.org/seneca #seneca] ==TODO== * Need to get a perl (and python?) interpreter into the extension or into an installer so it lives locally as well <small>'''(by 27/11/08)''' ([[User:Samer.Ziadeh|Samer Ziadeh]])</small>.** Must work within the extension** It probably doesn't need to be ligthweight.** Needs to work with the extension on Windows, Mac, and Linux
* Need to figure out how to mash a web server into an extension. <small>'''(by 27/11/08)''' ([http[User:Jtpau|Jerry Pau]])<//sameropensource.blogspot.com Samer Ziadeh]small>** Which Mashup should we use?*** Consumer Mashups*** Data Mashups*** Business Mashups** Do we make sure the web server is up to date?*** How would we do that?*** Are we going to add options in the setting regarding to the updates?**** Automatically check for updates**** Prompt before download updates**** Prompt before installing updates**** Never ask again
* Explain how these work: <small>'''(by 27/11/08)''' ([[User:Jamesboston|James Boston]])</small>** Get updates from David's [http://wwwzenit.senecac.jerrypauon.ca/?cat=3 Jerry Pauwiki/dxr/ DXR]or Mozilla-Central.** Push updates to the extension.