Changes

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 to on a timed interval or at the end-user's command. 

===About The SourceCode===

The [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 contacts to check for updates.

Contacts the MozillaAlthough this project is all about building a tool for browsing documentation off-Central line, that documentation is in a constant state of flux. It would be useful to be able to obtain the updates refresh it when need be. The update server needn't be terribly complex. A simple Apache server and injects them into some CGI work should suffice. However, it needs to be worked out exactly what kind of update is being pushed. Is it a binary diff of the sqlite database that can be used by ? And if so, will it need to keep a collection of diffs based on a original dataset in order to service users who haven't sync'd for some time. There's also the question of whether the update mechanism build into Mozilla for extensions is useful to us. We need to do some research on how extensionupdates work.

The front-end Portable DXR (our browsable source code documentation) is an applicationthat lives inside our extension. It's The CGI tools exist as part of an embeddable web server. When you remove the DXR part, what you are responsible for communicating left with is the core application platform on which it runs. It's also worth pointing out that the SQLite support is available in two ways. Local storage capabilities using SQLite are build into Mozilla applications and fetching can be accessed by an extension using C++, JavaScript, Python. However, SQLite database files can be accessed by any software that understands the data to format, so SQLite support will also be available through the applicationcgi tools. The DXR application then parses will probably use the CGI tools to access SQLite files if our presentation layer is traditional XHTML. But if we decide to use XUL, we can use the data and populates browser's built in functionality directly from JavaScript. In either case, I suspect we will end up leveraging the built in sqlite support for the UI as neccessaryupdates. But we need to do some research on that.

The core application has 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

==Related Projects====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

* [[Mozilla_Developer_Resource_Kit|Mozilla Developer Resource Kit]]: This is Implement the over-arching project of which the PDXR is but one piece.Perl parser <small>'''(1 week)'''</small>* [[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, Test Perl scripts on the problem of packaging other materials such as an mxr or developer documentation will also be solved.different platforms

* [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==* [httpirc://sameropensourceirc.blogspotmozilla.com Samer Ziadehorg/PDXR #PDXR]* [irc://irc.mozilla.org/seneca #seneca]

[http://www.jerrypau.ca/?cat=3 Jerry Pau] =TODO=IRC==[irc://irc.mozilla.org/PDXR #PDXR]

* Need to get figure out how to mash a perl web server into an extension. <small>'''(and pythonby 27/11/08)''' ([[User:Jtpau|Jerry Pau]])</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?) interpreter into *** Are we going to add options in the setting regarding to the extension or into an installer so it lives locally as well.updates?**** Automatically check for updates**** Prompt before download updates**** Prompt before installing updates**** Never ask again

Someone has to figure out * Explain how to mash a web server into an extensionthese work: <small>'''(by 27/11/08)''' ([[User:Jamesboston|James Boston]])</small>** Get updates from David's [http://zenit.senecac.on.ca/wiki/dxr/ DXR] or Mozilla-Central. There is research ** Push updates to be done there on all the options, compare them (which platform, license, complexity, etc.)extension.

Have to figure out how to a* Design of the interface of PDXR that will be using [https://developer.mozilla.org/en/Dehydra Dehydra] <small>'''(by 27/11/08) get updates from David's dxr or mozilla-central; b'' ([[User:Jtpau|Jerry Pau]] & [[User:Samer.Ziadeh|Samer Ziadeh]]) push updates to the extension</small>.