Difference between revisions of "XULRunner Guide"

From CDOT Wiki
Jump to: navigation, search
(Project News)
m (Protected "XULRunner Guide": Excessive vandalism ([edit=sysop] (indefinite) [move=sysop] (indefinite)) [cascading])
 
(231 intermediate revisions by 41 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]
 
  
 
== Project Leader(s) ==
 
== Project Leader(s) ==
  
 
[[User:mylau|Michael Lau (mylau)]]
 
[[User:mylau|Michael Lau (mylau)]]
 +
 +
[[User:cbguy1|Colin Guy (Guiness)]]
  
 
== Project Contributor(s) ==
 
== Project Contributor(s) ==
  
Vanessa
+
* [[User: Vpmirand | Vanessa]]
TBA
+
:* Provided 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 ==
 
== Project Details ==
  
=== Project Description ===
+
*[[XULRunner_Details| Project Details]]
  
XULRunner is an Internet technology runtime similar to Java and .NET runtime.  What makes this different from the other two is that it does not restrict developers from programming in one language like Java runtime.  XULRunner allows developers to write programs in any language that Mozilla web platform can support.  They are the following:
+
== XULRunner Guide Outline ==
  
*HTML
+
[[XULRunner_Guide_Outline | XULRunner Guide]]
*XHTML
 
*SVG
 
*XUL
 
  
=== Project Expectations ===
+
== XULRunner PDF ==  
  
The first part of the XULRunner Guide should introduce the basic technologies and concepts, and walk readers through the various features of XUL and the techniques used to develop applications with it.  If this walkthrough includes the development of a full-blown (but relatively simple) application, that would be great.  The second part should be a comprehensive and detailed XULRunner reference.  These halves could be treated as separate documents that cross-reference to each other liberally.  Both the Guide and the Reference should include sample code examples and explanations.
+
Last Uploaded: Dec 13, 2006 4:35 PM EST
  
=== Target audience ===
+
:[http://www.mikeylau.com/downloads/XULRunner%20Guide%20v1.3.pdf XULRunner Guide v1.5.pdf]
  
Experienced programmers, although not necessarily experienced with XUL. I think we can safely assume a fairly solid knowledge of Web technologies, including JavaScript, HTML, CSS, and DOM, and some experience developing desktop applications, web applications, or basic Firefox extensions.
+
:[http://www.mikeylau.com/downloads/XULRunner%20Guide%20v1.3.doc XULRunner Guide v1.5.doc]
  
=== Sections/Chapters/Content ===
+
Last Uploaded: Dec 13, 2006 1:00 PM EST
  
# '''Guide''': Introduction to XULRunner, including core concepts, technologies, and features.  See the JavaScript Guide as an example.
+
:<strike>[http://curr.mylau.net/school/DPS909/XULRunner%20Guide%20v2.pdf XULRunner Guide v2.PDF]
http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Guide
 
  
# '''Reference''': Organized and comprehensive reference material.  I don't really know enough about the technology to know how this content should be organized, but see the JavaScript Reference as an example.
+
:[http://curr.mylau.net/school/DPS909/XULRunner%20Guide%20v2.doc XULRunner Guide v2.doc]</strike>
http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference
 
  
If there's time/interest, a tutorial would be a nice addition, akin to the XUL Tutorial here:
 
http://developer.mozilla.org/en/docs/XUL_Tutorial
 
  
NOTE: I'm not suggesting that the XULRunner documentation emulate the structure and formatting of the JavaScript Guide/Reference -- the JavaScript documentation is in fairly dire need of reorganization and updating (which would be another great project for students if they're interested in that sort of thing).
+
Last Uploaded: Dec 12, 2006 1:36 AM EST
  
=== Methodology ===
+
:<strike>[http://curr.mylau.net/school/DPS909/XULRunner%20Guide.pdf XULRunner Guide.PDF]
  
I think a great way for this project to start would be to have the students research the technology and put together a proposed outline for the document(s). That outline could then be vetted by BSmedberg and Sheppy to ensure completeness and solid organizational structure. Once that outline is finished and agreed upon, it will be easier for students to pick up various pieces of the project, rather than facing the more daunting whole.
+
:[http://curr.mylau.net/school/DPS909/XULRunner%20Guide.doc XULRunner Guide.doc]</strike>
  
=== Expectations for collaboration ===
+
== XULRunner Guide Todo List==
  
BSmedberg and Sheppy are both busy, so I think the best way for students to effectively interact with them would be to do some work, then ask the guys for reviews when they need help, clarification, or to verify technical details.  I think the students should also join the dev-mdc@ mailing list and leverage the larger MDC community when they have questions or need help with stuffBSmedberg and Sheppy are both on that mailing list, as are a fairly large number of other interested and technically competent contributors.
+
* <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 think we should look to avoid overloading Bsmedberg and Sheppy with review requests and questions, so if students are interested in working on the project, we should have a meeting at the beginning (with the students, me, you guys, bsmedberg, and sheppy) and discuss interaction expectations and requirements at that point.
+
'''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 ==
 
== Project News ==
 +
'''January 18, 2007 by mylau'''
 +
* Changed the dead link for the XULRunner Guide v1.3
  
'''September 21, 2006 by mylau'''  
+
'''December 12, 2006 by mylau'''
The following is outline for XULRunner Guide. This outline may change. It needs to be reviewed by BSmedberg and Sheppy.
+
* 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.
  * How to do an app using xulrunner
+
* Updated the wiki to match the PDF information,
  * How do you deploy
+
* Updated the contribution list and the Todo List
  * How do I run an extension as an app
+
* Sent an email to bsmedberg and attached a copy of the PDF file
  * How to do updates
+
'''December 13, 2006 by cbguy1'''
  * Installation process
+
* 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.
  
 +
'''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]
  
'''September 17, 2006 by mylau'''  
+
'''December 10, 2006 by mylau'''
I've spoke to Dave about this project and currently the following people to talk to are:
+
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 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.
  
*dria (owns MDC)
+
'''December 9, 2006 by mylau'''
*bsmedberg (XUL Runner guy)
+
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.
*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.
+
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 [[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.
 +
 
 +
*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 ==
 +
 
 +
*[[XULRunner_Guide_November2006_Archive | November 2006]]
 +
*[[XULRunner_Guide_October2006_Archive | October 2006]]
 +
*[[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]

Latest revision as of 08: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