Recently I made up a little project at work that generated some HTML, and given the right CSS (which I think wikis are notoriously good at!), printable documents are totally possible. While I have no love for HTML and CSS, they are the easiest common denominator in this situation. The reasons everyone else brought up for using the wiki are also all very valid.
We should probably decide where it is going to appear first to the user. This document sounds like it should be resource #1, so putting the "table of contents" section as a link off of the documentation tab at qooxdoo.org would make sense. I would suggest that we recycle and even TRIM/DELETE some of the existing wiki content. If you introduce redundant content, people get a sense of being lost or not being in the right place to find all their answers.
Which makes the first job easy. Format up the table of contents, and then we can all dive right in there making changes. If something doesn't go straight or I require more input, I can simply leave a marker on that page and make mention of it on the mailing list. Every morning, afternoon or night, the programmers if they have time can take a spin through and suggest or make additions.
I'd also like to note that it's important to make sure we aren't splitting single documents up into multiple pages in a howto-style. One page per subject, that is the wiki (and thus, printable) way.
I've made some comments:
-=-
- Table of Contents - (Needs to be made ASAP)
- Introduction - ( More sections? )
- What is qooxdoo? - ( http://qooxdoo.org/documentation/developer/why_we_don_t_use_css_for_appearance?s=not%20css would serve as part of this document quite nicely. )
- General Installation
- Obtaining qooxdoo
- Building and Installing the qooxdoo frontend
- Building and Installing the qooxdoo online documentation
- Selecting and Installing one or more backends - ( Can all the back ends integrate & play nicely with peoples' existing applications? This should be hyped up. )
- Application Basics - What's a qooxdoo application made of? - (I LOVE IT!)
- The "header" of all qooxdoo applications
- Preferences
- Loading the qooxdoo core
- The qooxdoo "Main" function
- Layouts - ( A discussion about the intended behaviour of the DockLayout is needed, as it is right now, it is a bit of a hybrid dock/fixed layout. People who use DockLayouts are going to expect some pretty tricky behaviour from it. )
- What is a "Layout"?
- Available layouts
- Widgets
- Creating widgets and adding them to the application (document) - ( Add a section about which widgets can be added together and how. I get scared when I'm putting certain things together. )
- Handling Events
- Once widgets are created, all runtime processing is as a result of
events being dispatched and handled.
- There's a crapload of stuff to talk about here even for basic usage,
so we'll have to figure out what goes here and what goes in the
Advanced Usage section's Events chapter.
- Advanced Usage
- Extending qooxdoo classes
- Events - The Full Rundown
- What widgets generate what events?
- Using context menus
- Themes and Customization
- Selecting a Theme
- Changing Icon Paths
- qx.core.Init.defineInitialize()
- qx.manager.object.ImageManager
.defineAlias(x, path)
- x can be "static", "widget", "icon"
- Logging
- Appenders
- What is an appender
- The provided appenders
- Writing your own appender
- Managers
- What is a Manager
- Manipulating managers
- Constants
- Use of constants
- Why use them rather than their literal value
- Enumerate the constants
- Constants in qx/constant
- (Eventually, these constants should be in the auto-generated
documentation)
- Class constants (already in auto-generated documentation)
-=-- x can be "static", "widget", "icon"
- Logging
- Appenders
- What is an appender
- The provided appenders
- Writing your own appender
- Managers
- What is a Manager
- Manipulating managers
- Constants
- Use of constants
- Why use them rather than their literal value
- Enumerate the constants
- Constants in qx/constant
- (Eventually, these constants should be in the auto-generated
documentation)
- Class constants (already in auto-generated documentation)
I'm sure more will come out, but the remaining topics look great at a glance. We should go top-to bottom. Once the TOC is created, make "dummy" pages with references to existing documents we can cannibalize. The work will start from there.
_________________________________________________
Alexander Trauzzi
------------------------------------------------------------------------- Using Tomcat but need to do more? Need to support web services, security? Get stuff done quickly with pre-integrated technology to make your job easier Download IBM WebSphere Application Server v.1.0.1 based on Apache Geronimo http://sel.as-us.falkag.net/sel?cmd=lnk&kid=120709&bid=263057&dat=121642
_______________________________________________ qooxdoo-devel mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/qooxdoo-devel
