1,885
edits
Changes
m
*HTML*XHTML*SVG*XUL:[http://www.mikeylau.com/downloads/XULRunner%20Guide%20v1.3.doc XULRunner Guide v1.5.doc]
=== Project Expectations ===Last Uploaded: Dec 13, 2006 1:00 PM EST
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:<strike>[http://curr. If this walkthrough includes the development of a full-blown (but relatively simple) application, that would be greatmylau. The second part should be a comprehensive and detailed net/school/DPS909/XULRunner reference%20Guide%20v2. These halves could be treated as separate documents that cross-reference to each other liberally. Both the pdf XULRunner Guide and the Reference should include sample code examples and explanationsv2.PDF]
=== Target audience ===:[http://curr.mylau.net/school/DPS909/XULRunner%20Guide%20v2.doc XULRunner Guide v2.doc]</strike>
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.
=== Sections/Chapters/Content ===Last Uploaded: Dec 12, 2006 1:36 AM EST
# '''Guide''': Introduction to XULRunner, including core concepts, technologies, and features. See the JavaScript Guide as an example.<strike>[http://developercurr.mozillamylau.orgnet/enschool/docsDPS909/Core_JavaScript_1XULRunner%20Guide.pdf XULRunner Guide.5_GuidePDF]
# '''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://developercurr.mozillamylau.orgnet/enschool/docsDPS909/Core_JavaScript_1XULRunner%20Guide.doc XULRunner Guide.5_Referencedoc]</strike>
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== XULRunner Guide Todo List==
NOTE: I'm not suggesting that * <strike>Have the conversion between XULRunner documentation emulate application to extensions and vice versa. (This part isn't very important to have in the structure guide but its good to have) -- assigned to [[User:Vpmirand | Vpmirand]] and formatting [[User:PStD | PStD]] </strike>* Add ways of debugging XULRunner application on the JavaScript Guide/Reference guide -- assigned to [[User:Mylau | mylau]] --> '''done'''* Proof read guide -- assigned to [[User:Cbguy1 | Colin]], [[User:Mattar1 | Mohamed Attar]]* Put the JavaScript documentation whole guide into PDF format. (Once everything is in fairly dire need of reorganization and updating (which would be another great project done) -- assigned to [[User:Mylau | mylau]] --> '''done'''* Have a logo for students if theythe XULRunner Guide. [[User:Jbmossop | Jeff]] --> '''done'''re interested in that sort of thing).
=== Methodology ==='''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.
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 == Project News =='''January 18, 2007 by mylau'''* Changed 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 dead link for students to pick up various pieces of the project, rather than facing the more daunting wholeXULRunner Guide v1.3
=== Expectations '''December 12, 2006 by mylau'''* Special thanks to [[User:Mattar1 | Mattar1]] for collaboration ===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.
BSmedberg '''December 11, 2006 by cbguy1'''Sherman and Sheppy are both busy, so I think just finished compiling and editing the best way for students XulRunner Guide and converted it to effectively interact with them would PDF format. The guide can be to do some work, then ask the guys for reviews when they need help, clarification, or to verify technical detailsviewed [http://warp. 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 stuffsenecac. BSmedberg and Sheppy are both on that mailing list, as are a fairly large number of other interested and technically competent contributors.ca/cbguy1/XULRunner/XULRunnerGuide.pdf here]
== '''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 Guide Outline ==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.
'''Introduction '''Other things I worked on: '''About this guide''':* Updated Todo list - New features in this release - XULRunner versions - Changes made - Bug Fixes for each version - Document conventions:* Updated the contribution list
'''XULRunner OverviewDecember 8, 2006 by mylau''' - What is XULRunner?* 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. '''Installation Process''' - 32-bit installation - Microsoft Windows - System Requirements - Installation Instructions - Linux - System Requirements - Installation Instructions - 64-bit installation - Microsoft Windows - System Requirements - Installation Instructions - Linux - System Requirements - Installation Instructions '''How Tos''' - How * Special thanks to [[User: Dwwoodsi]] for letting me know about the new Mozilla person mfinkle. I spoke to do an application using XULRunner - How mfinkle about our guide and asked the person to deploy XULRunner - How provide feedback. mfinkle will most likely be emailing me back with feedback by the end of the day. Hopefully I'll have time to run an extension incorporate his feedback into the guide as an application using XULRunner - How to update XULRunnerwell.
== Project News =='''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 projectn ews section.2006 by mylau'''
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
I've spoke to Dave about this project and currently the following people to talk to are:== Project News Archive ==
I will speak to these following people along ==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 dave as soon as I get up-to-speed on what XUL Runner actually isXULRunner]*[http://developer.mozilla.org/en/docs/Debugging_a_XULRunner_Application Debugging XULRunner Application]
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]
== Project Leader(s) ==
[[User:mylau|Michael Lau (mylau)]]
[[User:cbguy1|Colin Guy (GuynessGuiness)]]
== Project Contributor(s) ==
* [[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 ==
*[[XULRunner_Details| Project Details]] == XULRunner Guide Outline == [[XULRunner_Guide_Outline | XULRunner Guide]] = Project Description =XULRunner PDF == Last Uploaded: Dec 13, 2006 4:35 PM EST
:[http://www.mikeylau.com/downloads/XULRunner is an Internet technology runtime similar to Java and %20Guide%20v1.NET runtime3. What makes this different from the other two is that it does not restrict developers from programming in one language like Java runtimepdf XULRunner Guide v1. XULRunner allows developers to write programs in any language that Mozilla web platform can support5. They are the following:pdf]
'''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 think we should look would have never found. Just to avoid overloading Bsmedberg and Sheppy with review requests and questionsnote one thing she mentionied, so if students are interested in working on posting bat files which creates the projectdirectory tree automatically, we should have 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 meeting at script which auto-creates directories for Linux and Mac, I won't put the beginning (with bat file but thanks for the students, me, you guys, bsmedberg, and sheppy) and discuss interaction expectations and requirements at that pointhelp.
* 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.
*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.
*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]]
