Difference between revisions of "XULRunner Guide"

From CDOT Wiki
Jump to: navigation, search
(Project Contributor(s))
m (Protected "XULRunner Guide": Excessive vandalism ([edit=sysop] (indefinite) [move=sysop] (indefinite)) [cascading])
 
(157 intermediate revisions by 39 users not shown)
Line 7: Line 7:
 
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.
 
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
+
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 Leader(s) ==
Line 25: Line 17:
 
== Project Contributor(s) ==
 
== Project Contributor(s) ==
  
* Vanessa
+
* [[User: Vpmirand | Vanessa]]
* Paul St-Denis
+
:* Provided us a link to XULRunner examples in [http://benjamin.smedbergs.us/blog/ bsmedberg's blog]
* Erin Davey
+
* [[User: Eldavey | Erin Davey]]
 +
:* Erin provided the screen shots of the XULRunner install on Windows.
 
* [[User:Elichak | Elichak]]
 
* [[User:Elichak | Elichak]]
:* Helped some comments on the Hello World tutorial
+
:* Provided lots of comments on how to fix the Hello World section of the guide
 
* [[User:Melz | Melz]]
 
* [[User:Melz | Melz]]
 
:* Provided us a link on [http://meta.wikimedia.org/wiki/PDF_Export PDF Export from Wiki] to help us get started
 
:* 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 ==
 
== Project Details ==
Line 39: Line 46:
 
== XULRunner Guide Outline ==
 
== XULRunner Guide Outline ==
  
[[XULRunner_Guide_Outline]]
+
[[XULRunner_Guide_Outline | XULRunner Guide]]
  
== Project News ==
+
== XULRunner PDF ==  
'''November 25, 2006 by mylau'''
 
  
Looked into the PDF recommended by [[User:Melz | Melz]] and recommendation by [[User:Elichak | Elichak]] for the documentation structure
+
Last Uploaded: Dec 13, 2006 4:35 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://www.mikeylau.com/downloads/XULRunner%20Guide%20v1.3.doc XULRunner Guide v1.5.doc]
:*File/Folder Structure
 
:*application.ini File
 
:*chrome.manifest File
 
:*prefs.js File
 
:*How to run the application
 
  
 +
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 [[XULRunner_1.8 | Deploying XULRunner_1.8]] to [[How_to_deploy_XULRunner | Delploying XULRunner]]. Also, I moved the XULRunner Guide Outline from the main page to [[XULRunner_Guide_Outline]]
+
:<strike>[http://curr.mylau.net/school/DPS909/XULRunner%20Guide%20v2.pdf XULRunner Guide 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 XULRunner]]. I also revised the document so its more intuitive for new developers as well as provided a screenshot of the executed program.
+
:[http://curr.mylau.net/school/DPS909/XULRunner%20Guide%20v2.doc 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 23, 2006 by mylau'''
+
Last Uploaded: Dec 12, 2006 1:36 AM EST
  
Changed one of the headings in the table of contents "How to an application using XULRunner" to "How to do a Hello World application using XULRunner".  Also finished writing a tutorial on the "Hello World" application.
+
:<strike>[http://curr.mylau.net/school/DPS909/XULRunner%20Guide.pdf XULRunner Guide.PDF]
  
'''October 22, 2006 by mylau'''
+
:[http://curr.mylau.net/school/DPS909/XULRunner%20Guide.doc XULRunner Guide.doc]</strike>
  
Worked on how to create a XULRunner application tutorial.
+
== XULRunner Guide Todo List==
  
'''October 16, 2006 by cbguy1'''
+
* <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]] --> '''done'''
 +
* Proof read guide -- assigned to [[User:Cbguy1 | Colin]], [[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 the XUL Runner install instructions for a Win32 operating systemCurrently I am looking into the XUL Runner 64bit installation instructions.  I am looking for any similarities and differences.  
+
'''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 Project leadersAlso, just because someone is already assigned to it, does not mean you cannot also work on it.
  
'''October 09, 2006 by mylau'''  
+
== Project News ==
 +
'''January 18, 2007 by mylau'''
 +
* Changed the dead link for the XULRunner Guide v1.3
  
I've looked through bsmedberg emails on XULRunner (XR) for this week. For a starting point, I wanted to start with the simplist task first, creating a "Hello World" application for XR.  I've searched through quite a few websites, mainly from the MDCFor the first half of the day, I couldn't find any websites which actually guided me step by step on how to create a simple XR applicationThe closes website I found was from [http://blogs.acceleration.net/ryan/archive/2005/05/06/1073.aspx Ryan's Blog]The blog had a tutorial on how to set up a XR application but it missed one important aspect, how to run the application.
+
'''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 the footer of each page of the guide.
 +
* Updated the wiki to match the PDF information,
 +
* Updated the contribution list and the Todo List
 +
* Sent an email to bsmedberg and attached a copy of the PDF file
 +
'''December 13, 2006 by cbguy1'''
 +
* Proofread the XULRunner Guide and made revisions as necessary and emailed the doc to [[User:Mylau | mylau]] to be uploaded. to his site.
 +
'''December 12, 2006 by mylau'''
 +
* Thanks to mfinkle for providing me some feedback on fixes which needed to be made for the guide.  I took most of his advice and made the modifications necessary.   
 +
* I looked at the guide [[User:Cbguy1 | cbguy1]] posted but required a lot of work.  I tried editing the PDF directly but could not find any good tool to use.  I attempted to modify the PDF using Foxit Editor but I spent over 1hour learning how to do it.  I realized this was not the best approach to modifying the PDF. Hence, I redid the whole document to PDF. I put all the written work on the wiki onto a word document and converted it using Open Office. This was the practical solution since most of the work in the document was not proof read and organized.   
 +
* Fixed some of the spelling and grammatical mistakes while reorganizing the document to fit onto the PDF. 
 +
* If possible it would be great if there were people who would like to proof read our document to ensure the document is sound.
  
After this, I realized I've been putting too much time finding tutorial on how to create an intutive XR application. Perhaps no one has posted any on the web yet.  So I tried to reverse engineer an existing XR application, [http://developer.mozilla.org/en/docs/XULMine_sample_XULRunner_Application_%28external%29 XULMine].  Unfortunately I wasn't very successful.  The code for this application seem too complex for myself to understand. 
+
'''December 11, 2006 by cbguy1'''
 +
Sherman and I just finished compiling and editing the XulRunner Guide and converted it to PDF format. The guide can be viewed [http://warp.senecac.on.ca/cbguy1/XULRunner/XULRunnerGuide.pdf here]
  
As a result, I started my search all over againFortunately, I missed a link which was on MDC XULRunner, [http://developer.mozilla.org/en/docs/Getting_started_with_XULRunner Getting started with XR]Thankfully, I was able to create my first "Hello World" application on XR.  I wasn't able to finish writing documentation on this but hopefully by the end of the week, I'll be able to manage some time and have this completed.
+
'''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 lot of the little mistakes that I would have never foundJust to note one thing she mentionied, posting bat files which creates the directory tree automatically, this won't be a good idea for the guide. The main reason is that bat files are Window's specificUntil someone creates a script which auto-creates directories for Linux and Mac, I won't put the bat file but thanks for the help.
  
 +
'''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 on so far for this projectDave Humphrey helped us send another email dria, bsmedberg, and sheppy about our projectWe're currently waiting for their response. Hopefully they will tell us what they want in the XULRunner guide.  
+
'''December 8, 2006 by mylau'''
 +
* Emailed bsmedberg on 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 letting me know about the new Mozilla person mfinkleI spoke to mfinkle about our guide and asked the person to provide feedbackmfinkle will most likely be emailing me back with feedback by the end of the day. Hopefully I'll have time to incorporate his feedback into the guide as 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, its done on the outline rather than keep updating the project news section.
+
'''December 5, 2006 by mylau'''
  
'''September 21, 2006 by mylau'''  
+
* Converting to PDF
 +
Talked 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't 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 to be reviewed by BSmedberg and Sheppy.
+
*I moved the November project news to an 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
 
 
 
  
'''September 17, 2006 by mylau'''
+
*Debugging XULRunner
 +
I'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)
+
*[[XULRunner_Guide_September2006_Archive | September 2006]]
 
 
I will speak to these following people along with dave as soon as I get up-to-speed on what XUL Runner actually is.
 
  
 
==Useful Links==
 
==Useful Links==
[http://benjamin.smedbergs.us/blog/ XULRunner Examples By: Benjamin Smedberg]
+
*[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]

Latest revision as of 09:14, 12 April 2012

Project Name

XUL Runner Guide

Project Description

The XULRunner project provides an "application runner" for building apps -- like Firefox, Thunderbird, and Sunbird -- atop the 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.

Project Leader(s)

Michael Lau (mylau)

Colin Guy (Guiness)

Project Contributor(s)

  • Erin provided the screen shots of the XULRunner install on Windows.
  • Provided lots of comments on how to fix the Hello World section of the guide
  • Introduced us to mfinkle on IRC and also gave us his blog
  • Helped to compile and convert the XULRunner guide to PDF.
  • mfinkle
  • Help read through the whole guide and provided useful comments on the document
  • Helped proof read v1 of the XULRunner Guide.
  • Created a graphical icon that will be used for the footer of each page of the guide
  • 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

XULRunner PDF

Last Uploaded: Dec 13, 2006 4:35 PM EST

XULRunner Guide v1.5.pdf
XULRunner Guide v1.5.doc

Last Uploaded: Dec 13, 2006 1:00 PM EST

XULRunner Guide v2.PDF
XULRunner Guide v2.doc


Last Uploaded: Dec 12, 2006 1:36 AM EST

XULRunner Guide.PDF
XULRunner Guide.doc

XULRunner Guide Todo List

  • 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 Vpmirand and PStD
  • Add ways of debugging XULRunner application on the guide -- assigned to mylau --> done
  • Proof read guide -- assigned to Colin, Mohamed Attar
  • Put the whole guide into PDF format. (Once everything is done) -- assigned to mylau --> done
  • Have a logo for the XULRunner Guide. Jeff --> done

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 Project leaders. Also, just because someone is already assigned to it, does not mean you cannot also work on it.

Project News

January 18, 2007 by mylau

  • Changed the dead link for the XULRunner Guide v1.3

December 12, 2006 by mylau

  • Special thanks to Mattar1 for proof reading our version 1 of the guide and Jbmossop for creating an icon for the footer of each page of the guide.
  • Updated the wiki to match the PDF information,
  • Updated the contribution list and the Todo List
  • Sent an email to bsmedberg and attached a copy of the PDF file

December 13, 2006 by cbguy1

  • Proofread the XULRunner Guide and made revisions as necessary and emailed the doc to mylau to be uploaded. to his site.

December 12, 2006 by mylau

  • Thanks to mfinkle for providing me some feedback on fixes which needed to be made for the guide. I took most of his advice and made the modifications necessary.
  • I looked at the guide cbguy1 posted but required a lot of work. I tried editing the PDF directly but could not find any good tool to use. I attempted to modify the PDF using Foxit Editor but I spent over 1hour learning how to do it. I realized this was not the best approach to modifying the PDF. Hence, I redid the whole document to PDF. I put all the written work on the wiki onto a word document and converted it using Open Office. This was the practical solution since most of the work in the document was not proof read and organized.
  • Fixed some of the spelling and grammatical mistakes while reorganizing the document to fit onto the PDF.
  • If possible it would be great if there were people who would like to proof read our document to ensure the document is sound.

December 11, 2006 by cbguy1 Sherman and I just finished compiling and editing the XulRunner Guide and converted it to PDF format. The guide can be viewed here

December 10, 2006 by mylau I added some of the minor details elichak mentioned in the Hello World discussion. She helped find a lot of the little mistakes that I would have never found. Just to note one thing she mentionied, posting bat files which creates the directory tree automatically, this won't be a good idea for the guide. The main reason is that bat files are Window's specific. Until someone creates a script which auto-creates directories for Linux and Mac, I won't put the bat file but thanks for the help.

December 9, 2006 by mylau Today I found a really good link for 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 David Humphrey. All that needs to be done which is mandatory is putting the information in the wiki into PDF which Cbguy1 said would do.

Other things I worked on:

  • Updated Todo list
  • Updated the contribution list

December 8, 2006 by mylau

  • Emailed bsmedberg on 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 letting me know about the new Mozilla person mfinkle. I spoke to mfinkle about our guide and asked the person to provide feedback. mfinkle will most likely be emailing me back with feedback by the end of the day. Hopefully I'll have time to incorporate his feedback into the guide as well.

December 6, 2006 by mylau

Added a TODO list for the project

December 5, 2006 by mylau

  • Converting to PDF

Talked to 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't 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.

  • I moved the November project news to an achieve.
  • Debugging XULRunner

I'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.

Project News Archive

Useful Links