Changes

Jump to: navigation, search

XULRunner Guide

2,397 bytes added, 09:14, 12 April 2012
m
Protected "XULRunner Guide": Excessive vandalism ([edit=sysop] (indefinite) [move=sysop] (indefinite)) [cascading]
The [http://en.wikipedia.org/wiki/XULRunner XULRunner project] provides an "application runner" for building apps -- like Firefox, Thunderbird, and Sunbird -- atop the [http://developer.mozilla.org/en/docs/Toolkit_API Mozilla toolkit] framework. It needs a guide outlined, high-priority parts written, and examples created to help people get started.
Related tech and skills: XUL, documentation, cross-platform testing  '''Reference: '''*[http://cs.senecac.on.ca/fsoss/2006/workshop.html#XULRunner XULRunner Workshop] *[http://en.wikipedia.org/wiki/XULRunner XULRunner project]*[http://developer.mozilla.org/en/docs/XULRunner_1.8.0.4_Release_Notes XULRunner 1.8.0.4 Release Note]*[http://developer.mozilla.org/en/docs/Debugging_a_XULRunner_Application Debugging a XULRunner Application]*[http://developer.mozilla.org/en/docs/Getting_started_with_XULRunner Getting startd with XULRunner]
== Project Leader(s) ==
== Project Contributor(s) ==
* [[User: Vpmirand | Vanessa]]:* Paul St-DenisProvided us a link to XULRunner examples in [http://benjamin.smedbergs.us/blog/ bsmedberg's blog]* [[User: Eldavey | Erin Davey]]:* Erin provided the screen shots of the XULRunner install on Windows.* [[User:Elichak | Elichak]]:* Provided lots of comments on how to fix the Hello World section of the guide* [[User:Melz | Melz]]:* Provided us a link on [http://meta.wikimedia.org/wiki/PDF_Export PDF Export from Wiki] to help us get started* [[User: Dwwoodsi | Dean]]:* Introduced us to mfinkle on IRC and also gave us his blog* [[User: Sherman | Sherman]]:* Helped to compile and convert the XULRunner guide to PDF.*mfinkle:* Help read through the whole guide and provided useful comments on the document*[[User:Mattar1 | Mohamed Attar]]:* Helped proof read v1 of the XULRunner Guide.*[[User:Jbmossop | Jeff]]:* Created a graphical icon that will be used for the footer of each page of the guide:* [[Image:XULRunner2.png]]* Smedberg:* Guided us on where to find certain information. :* Also gave us hints on what to put in the XR Guide Outline
== Project Details ==
== XULRunner Guide Outline ==
[[XULRunner_Guide_Outline| XULRunner Guide]]
== Project News XULRunner PDF =='''November 25, 2006 by mylau'''
Looked into the PDF recommended by [[UserLast Uploaded:Melz | Melz]] and recommendation by [[UserDec 13, 2006 4:Elichak | Elichak]] for the documentation structure35 PM EST
:[http://www.mikeylau.com/downloads/XULRunner%20Guide%20v1.3.pdf XULRunner Guide v1.5.pdf]
Updated all the doucments in the '''Tutorial on XULRunner''' sections. They include:[http:*File/Folder Structure:*application/www.mikeylau.com/downloads/XULRunner%20Guide%20v1.3.ini File:*chromedoc XULRunner Guide v1.manifest File:*prefs5.js File:*How to run the applicationdoc]
Last Uploaded: Dec 13, 2006 1:00 PM EST
Since there is only one version of XULRunner that this document is discussing currently I moved [:<strike>[XULRunner_1http://curr.8 | Deploying XULRunner_1mylau.8]] to [[How_to_deploy_XULRunner | Delploying net/school/DPS909/XULRunner]]%20Guide%20v2. Also, I moved the pdf XULRunner Guide Outline from the main page to [[XULRunner_Guide_Outline]v2.PDF]
I've added an introduction and conclusion to the :[[How_to_do_a_Hello_World_application_using_XULRunner | How to do a Hello World application using http://curr.mylau.net/school/DPS909/XULRunner]]%20Guide%20v2. I also revised the document so its more intuitive for new developers as well as provided a screenshot of the executed programdoc XULRunner Guide v2.doc]</strike>
'''November 25, 2006 by cbguy1'''
<br>
Currently working on the different mehods XULRunner is deployed amoung the various operating
systems. The page has been setup to accomadate subsequent versions of XULRunner when they
will be released.
Also any unnecessary or redundant headings were removed.
<br>
Working on an Introduction for the XUL Runner guide.
<br>
Made updates to setting up the pref.js file.
<br>
'''October 23Last Uploaded: Dec 12, 2006 by mylau''' 1:36 AM EST
Changed one of the headings in the table of contents "How to an application using :<strike>[http://curr.mylau.net/school/DPS909/XULRunner" to "How to do a Hello World application using %20Guide.pdf XULRunner". Also finished writing a tutorial on the "Hello World" applicationGuide.PDF]
'''October 22, 2006 by :[http://curr.mylau''' .net/school/DPS909/XULRunner%20Guide.doc XULRunner Guide.doc]</strike>
Worked on how to create a == XULRunner application tutorial.Guide Todo List==
* <strike>Have the conversion between XULRunner application to extensions and vice versa. (This part isn't very important to have in the guide but its good to have) -- assigned to [[User:Vpmirand | Vpmirand]] and [[User:PStD | PStD]] </strike>* Add ways of debugging XULRunner application on the guide -- assigned to [[User:Mylau | mylau]] --> ''October 16'done'''* Proof read guide -- assigned to [[User:Cbguy1 | Colin]], 2006 by cbguy1[[User:Mattar1 | Mohamed Attar]]* Put the whole guide into PDF format. (Once everything is done) -- assigned to [[User:Mylau | mylau]] --> '''done'''* Have a logo for the XULRunner Guide. [[User:Jbmossop | Jeff]] --> '''done'''
I have finished entering '''Note:''' If you would like to contribute to any of this in the todo list or would like to add something to the todo list, please notify the XUL Runner install instructions for a Win32 operating systemProject leaders. Currently I am looking into the XUL Runner 64bit installation instructions. I am looking for any similarities and differencesAlso, just because someone is already assigned to it, does not mean you cannot also work on it.
== Project News =='''October 09January 18, 2006 2007 by mylau''' * Changed the dead link for the XULRunner Guide v1.3
I've looked through bsmedberg emails on XULRunner (XR) ''December 12, 2006 by mylau'''* Special thanks to [[User:Mattar1 | Mattar1]] for proof reading our version 1 of the guide and [[User:Jbmossop | Jbmossop]] for creating an icon for this weekthe footer of each page of the guide. For * Updated the wiki to match the PDF information, * Updated the contribution list and the Todo List* Sent an email to bsmedberg and attached a starting pointcopy of the PDF file'''December 13, I wanted 2006 by cbguy1'''* Proofread the XULRunner Guide and made revisions as necessary and emailed the doc to [[User:Mylau | mylau]] to be uploaded. to start with the simplist task firsthis site.'''December 12, creating a "Hello World" application 2006 by mylau'''* Thanks to mfinkle for providing me some feedback on fixes which needed to be made for XRthe guide. I've searched through quite a few websites, mainly from took most of his advice and made the MDCmodifications necessary. For * I looked at the first half guide [[User:Cbguy1 | cbguy1]] posted but required a lot of work. I tried editing the day, I couldn't PDF directly but could not find any websites which actually guided me step by step on good tool to use. I attempted to modify the PDF using Foxit Editor but I spent over 1hour learning how to create a simple XR applicationdo it. The closes website I found realized this was from [http://blogsnot the best approach to modifying the PDF.acceleration Hence, I redid the whole document to PDF.net/ryan/archive/2005/05/06/1073 I put all the written work on the wiki onto a word document and converted it using Open Office.aspx Ryan's Blog] This was the practical solution since most of the work in the document was not proof read and organized. The blog had a tutorial on how * Fixed some of the spelling and grammatical mistakes while reorganizing the document to set up a XR application but fit onto the PDF. * If possible it missed one important aspect, how would be great if there were people who would like to proof read our document to run ensure the applicationdocument is sound.
After this'''December 11, 2006 by cbguy1'''Sherman and I realized I've been putting too much time finding tutorial on how just finished compiling and editing the XulRunner Guide and converted it to create an intutive XR applicationPDF format. Perhaps no one has posted any on the web yet. So I tried to reverse engineer an existing XR application, The guide can be viewed [http://developerwarp.mozillasenecac.orgon.ca/encbguy1/docsXULRunner/XULMine_sample_XULRunner_Application_%28external%29 XULMineXULRunnerGuide.pdf here]. Unfortunately I wasn't very successful. The code for this application seem too complex for myself to understand.
As '''December 10, 2006 by mylau'''I added some of the minor details [[User: elichak | elichak]] mentioned in the [[Talk:How_to_do_a_Hello_World_application_using_XULRunner | Hello World discussion]]. She helped find a result, lot of the little mistakes that I started my search all over againwould have never found. FortunatelyJust to note one thing she mentionied, I missed a link posting bat files which was on MDC XULRunnercreates the directory tree automatically, [http://developerthis won't be a good idea for the guide.mozilla.org/en/docs/Getting_started_with_XULRunner Getting started with XR] The main reason is that bat files are Window's specific. ThankfullyUntil someone creates a script which auto-creates directories for Linux and Mac, I was able to create my first "Hello World" application on XR. I wasnwon't able to finish writing documentation on this put the bat file but hopefully by the end of thanks for the week, I'll be able to manage some time and have this completedhelp.
'''December 9, 2006 by mylau'''
Today I found a really good link for [http://developer.mozilla.org/en/docs/Debugging_a_XULRunner_Application Deubbing XULRunner applications]. I also finally finished the debugging XULRunner part of the guide. Looks like the guide is in good shape for the deliverable that will be sent to [[User:David.humphrey | David Humphrey]]. All that needs to be done which is mandatory is putting the information in the wiki into PDF which [[User:Cbguy1| Cbguy1]] said would do.
'''October 02, 2006 by mylau''' Other things I worked on::* Updated Todo list:* Updated the contribution list
We sent an email to bsmerdberg about what we've currently have worked ''December 8, 2006 by mylau'''* Emailed bsmedberg on so far our progress of the guide and asked his feedback. Also mentioned to him that Colin and I will be sending him a PDF of our guide to date.* Special thanks to [[User: Dwwoodsi]] for this projectletting me know about the new Mozilla person mfinkle. Dave Humphrey helped us send another email dria, bsmedberg, and sheppy I spoke to mfinkle about our projectguide and asked the person to provide feedback. We're currently waiting for their responsemfinkle will most likely be emailing me back with feedback by the end of the day. Hopefully they will tell us what they want in I'll have time to incorporate his feedback into the XULRunner guideas well.
Colin and I have started testing the stable version of XULRunner which is 1.8.0.4. I'm mainly responsible for the Linux side of XULRunnre while as Colin is responsible for Windows. We've installed XULRunner and tried installing a few XULRunner application. We also put the information in the XULRunner Guide outline.'December 6, 2006 by mylau'''
'''September 25, 2006 by mylau''' Added a TODO list for the project
Moved the outline to have its own heading. This way when changes are needed to be made'''December 5, its done on the outline rather than keep updating the project news section.2006 by mylau'''
* Converting to PDFTalked to [[User: elichak | elichak]] about the conversion between Wiki and PDF. She mentioned the fact that in order to convert Wikis into PDF, I would need to embed some code like PHP into the Wiki for the converting program to work. This theory of her's did make senes since due to the research I've done last week had the same results. If I were to automate the PDF conversion, I would have to talk to ACS since they own the code base for zenit. I don'September 21, 2006 by mylaut think I'll be using that method. It's too much of a hassle. Since the document seems pretty short, I' m going to put it into the PDF manually.
The following is outline for XULRunner Guide. This outline may change. It needs *I moved the November project news to be reviewed by BSmedberg and Sheppyan achieve. '''About this guide''' - New features in this release - XULRunner versions - Document conventions '''XULRunner Overview''' - What is XULRunner? '''How Tos''' - Installation process - How to do an application using XULRunner - How to deploy XULRunner - How to run an extension as an application using XULRunner - How to update XULRunner
*Debugging XULRunnerI'''September 17, 2006 by mylau''' ve went back to listen to the workshop Ben Smedberg gave about XULRunner. I jotted some notes about how he debugged XULRunner and plan to post that section up on the guide later in the week.
I've spoke to Dave about this project and currently the following people to talk to are:== Project News Archive ==
*dria (owns MDC)[[XULRunner_Guide_November2006_Archive | November 2006]]*bsmedberg (XUL Runner guy)[[XULRunner_Guide_October2006_Archive | October 2006]]*sheppy (dev/docs)  I will speak to these following people along with dave as soon as I get up-to-speed on what XUL Runner actually is.[[XULRunner_Guide_September2006_Archive | September 2006]]
==Useful Links==
*[http://benjamin.smedbergs.us/blog/ XULRunner Examples By: Benjamin Smedberg]*[http://cs.senecac.on.ca/fsoss/2006/workshop.html#XULRunner XULRunner Workshop] *[http://en.wikipedia.org/wiki/XULRunner XULRunner project]*[http://developer.mozilla.org/en/docs/XULRunner_1.8.0.4_Release_Notes XULRunner 1.8.0.4 Release Note]*[http://developer.mozilla.org/en/docs/Debugging_a_XULRunner_Application Debugging a XULRunner Application]*[http://developer.mozilla.org/en/docs/Getting_started_with_XULRunner Getting started with XULRunner]*[http://developer.mozilla.org/en/docs/Debugging_a_XULRunner_Application Debugging XULRunner Application]

Navigation menu