Difference between revisions of "XULRunner Guide"
Chris Tyler (talk | contribs) m (Protected "XULRunner Guide": Excessive vandalism ([edit=sysop] (indefinite) [move=sysop] (indefinite)) [cascading]) |
|||
| (22 intermediate revisions by 8 users not shown) | |||
| Line 4: | Line 4: | ||
== Project Description == | == Project Description == | ||
| − | + | ||
| − | The [http://en.wikipedia.org/wiki/XULRunner XULRunner project] provides an "application runner" for | + | 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. |
| − | people get started. | + | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
Related tech and skills: XUL, documentation, cross-platform testing. | Related tech and skills: XUL, documentation, cross-platform testing. | ||
| − | + | ||
== Project Leader(s) == | == Project Leader(s) == | ||
| Line 44: | Line 14: | ||
[[User:cbguy1|Colin Guy (Guiness)]] | [[User:cbguy1|Colin Guy (Guiness)]] | ||
| − | |||
| − | |||
== Project Contributor(s) == | == Project Contributor(s) == | ||
| − | * [[User: Vpmirand|Vanessa]] | + | * [[User: Vpmirand | Vanessa]] |
:* Provided us a link to XULRunner examples in [http://benjamin.smedbergs.us/blog/ bsmedberg's blog] | :* Provided us a link to XULRunner examples in [http://benjamin.smedbergs.us/blog/ bsmedberg's blog] | ||
| − | * [[User: Eldavey|Erin Davey]] | + | * [[User: Eldavey | Erin Davey]] |
:* Erin provided the screen shots of the XULRunner install on Windows. | :* Erin provided the screen shots of the XULRunner install on Windows. | ||
| − | * [[User:Elichak|Elichak] | + | * [[User:Elichak | Elichak]] |
:* Provided lots of comments on how to fix the Hello World section of the guide | :* 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]] | + | * [[User: Dwwoodsi | Dean]] |
:* Introduced us to mfinkle on IRC and also gave us his blog | :* Introduced us to mfinkle on IRC and also gave us his blog | ||
| − | * [[User: Sherman|Sherman]] | + | * [[User: Sherman | Sherman]] |
:* Helped to compile and convert the XULRunner guide to PDF. | :* Helped to compile and convert the XULRunner guide to PDF. | ||
| − | * mfinkle | + | *mfinkle |
:* Help read through the whole guide and provided useful comments on the document | :* Help read through the whole guide and provided useful comments on the document | ||
| − | * [[User:Mattar1|Mohamed Attar]] | + | *[[User:Mattar1 | Mohamed Attar]] |
:* Helped proof read v1 of the XULRunner Guide. | :* Helped proof read v1 of the XULRunner Guide. | ||
| − | * [[User:Jbmossop|Jeff]] | + | *[[User:Jbmossop | Jeff]] |
:* Created a graphical icon that will be used for the footer of each page of the guide | :* Created a graphical icon that will be used for the footer of each page of the guide | ||
:* [[Image:XULRunner2.png]] | :* [[Image:XULRunner2.png]] | ||
| − | |||
* Smedberg | * Smedberg | ||
| − | :* Guided us on where to find certain information. | + | :* Guided us on where to find certain information. |
:* Also gave us hints on what to put in the XR Guide Outline | :* Also gave us hints on what to put in the XR Guide Outline | ||
| − | |||
== Project Details == | == Project Details == | ||
| − | |||
| − | |||
| − | |||
| − | * [[ | + | *[[XULRunner_Details| Project Details]] |
== XULRunner Guide Outline == | == XULRunner Guide Outline == | ||
| − | [[ | + | [[XULRunner_Guide_Outline | XULRunner Guide]] |
| − | == XULRunner PDF == | + | == XULRunner PDF == |
| − | Last Uploaded: Dec 13, 2006 4:35 PM EST | + | Last Uploaded: Dec 13, 2006 4:35 PM EST |
| − | : [http://www.mikeylau.com/downloads/XULRunner%20Guide%20v1.3.pdf XULRunner Guide v1.5.pdf | + | :[http://www.mikeylau.com/downloads/XULRunner%20Guide%20v1.3.pdf XULRunner Guide v1.5.pdf] |
| − | + | :[http://www.mikeylau.com/downloads/XULRunner%20Guide%20v1.3.doc XULRunner Guide v1.5.doc] | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | : [http://www.mikeylau.com/downloads/XULRunner%20Guide%20v1.3.doc XULRunner Guide v1.5.doc] | ||
| − | Last Uploaded: Dec 13, 2006 1:00 PM EST | + | Last Uploaded: Dec 13, 2006 1:00 PM EST |
| − | : <strike>[http://curr.mylau.net/school/DPS909/XULRunner%20Guide%20v2.pdf XULRunner Guide v2.PDF] | + | :<strike>[http://curr.mylau.net/school/DPS909/XULRunner%20Guide%20v2.pdf XULRunner Guide v2.PDF] |
| − | : [http://curr.mylau.net/school/DPS909/XULRunner%20Guide%20v2.doc XULRunner Guide v2.doc]</strike> | + | :[http://curr.mylau.net/school/DPS909/XULRunner%20Guide%20v2.doc XULRunner Guide v2.doc]</strike> |
| − | |||
| − | : | + | Last Uploaded: Dec 12, 2006 1:36 AM EST |
| − | : [http://curr.mylau.net/school/DPS909/XULRunner%20Guide. | + | :<strike>[http://curr.mylau.net/school/DPS909/XULRunner%20Guide.pdf XULRunner Guide.PDF] |
| − | |||
| − | |||
| − | + | :[http://curr.mylau.net/school/DPS909/XULRunner%20Guide.doc XULRunner Guide.doc]</strike> | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | '''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 | + | == XULRunner 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]] --> '''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''' | ||
| + | |||
| + | '''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''' | '''January 18, 2007 by mylau''' | ||
| − | |||
* Changed the dead link for the XULRunner Guide v1.3 | * Changed the dead link for the XULRunner Guide v1.3 | ||
'''December 12, 2006 by mylau''' | '''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. | |
| − | * 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 wiki to match the PDF information, | ||
* Updated the contribution list and the Todo List | * Updated the contribution list and the Todo List | ||
| − | * Sent an email to bsmedberg and attached a copy of the PDF file | + | * Sent an email to bsmedberg and attached a copy of the PDF file |
| − | |||
'''December 13, 2006 by cbguy1''' | '''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. | |
| − | * 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''' | '''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. | |
| − | * 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. |
| − | * 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. | + | * Fixed some of the spelling and grammatical mistakes while reorganizing the document to fit onto the PDF. |
| − | * 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. | * 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''' | '''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] | 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] | ||
| − | + | ||
'''December 10, 2006 by mylau''' | '''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 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. | |
| − | I added some of the minor details [[User: elichak|elichak]] mentioned in the [[Talk: | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | 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 | ||
'''December 9, 2006 by mylau''' | '''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. | + | 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. |
Other things I worked on: | Other things I worked on: | ||
| − | |||
:* Updated Todo list | :* Updated Todo list | ||
:* Updated the contribution list | :* Updated the contribution list | ||
'''December 8, 2006 by mylau''' | '''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''' | '''December 6, 2006 by mylau''' | ||
| Line 207: | Line 120: | ||
* Converting to PDF | * 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. | |
| − | * Debugging XULRunner | ||
| − | |||
| − | I've went back to listen to the workshop Ben Smedberg gave about XULRunner. | ||
== Project News Archive == | == Project News Archive == | ||
| − | * [[ | + | *[[XULRunner_Guide_November2006_Archive | November 2006]] |
| − | * [[ | + | *[[XULRunner_Guide_October2006_Archive | October 2006]] |
| − | * [[ | + | *[[XULRunner_Guide_September2006_Archive | September 2006]] |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | *[http:// | + | ==Useful Links== |
| − | *[http:// | + | *[http://benjamin.smedbergs.us/blog/ XULRunner Examples By: Benjamin Smedberg] |
| − | *[http:// | + | *[http://cs.senecac.on.ca/fsoss/2006/workshop.html#XULRunner XULRunner Workshop] |
| − | [http:// | + | *[http://en.wikipedia.org/wiki/XULRunner XULRunner project] |
| − | [http:// | + | *[http://developer.mozilla.org/en/docs/XULRunner_1.8.0.4_Release_Notes XULRunner 1.8.0.4 Release Note] |
| − | [http:// | + | *[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
Contents
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)
Project Contributor(s)
- Provided us a link to XULRunner examples in bsmedberg's blog
- 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
- Provided us a link on PDF Export from Wiki to help us get started
- 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
-
- 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 PDF
Last Uploaded: Dec 13, 2006 4:35 PM EST
Last Uploaded: Dec 13, 2006 1:00 PM EST
Last Uploaded: Dec 12, 2006 1:36 AM EST
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.
