Documentation outline (draft)
Felix Maeder <[email protected]> Thu, 13 Mar 2003 02:23:47 +0100
| Newsgroups | gmane.comp.cms.wyona.devel |
|---|---|
| Message-ID | <[email protected]> |
Hi list With the goal to improve the lenya documentation I was thinking about a new structure of the documentation and came up with a first draft of an outline (attached as xdocs and html). The main change I would suggest is to abandon the separation of an integrator's, an administrator's and a deveoper's guide. In the past, it was never clear to what section a new topic belongs to. Most of the topics would have to be discussed and maintained in the integrator's and the develper's guide (think about access controlling, revision controlling, editors, workflow management, concepts like a URI scheme or the site tree). Most of the information is important for the integrator as well as for the developer. The documentation is so high level that there's only a few things that are aimed exclusively at the developer. Those items can be provided in sub-sections like "Developing your own ...". The real deleveloper's documentation is JavaDoc anyway. A user's guide (for the business user of the cms application) is no high priority at this point because such a guide depends on the concrete implementation (the real publication). That's why I left it out. I included a hands-on section "Getting started" that provides tutorials for different tasks like creating your own publication or adding a doctype. The "Related Topics" section would be a place to store information or references to information that is not part of the system itself but loosely connected to it. The top-level structure looks like this: - Installation - Getting Started (How-to's) - Concepts and Best Practises - Components - Deployment and Administration - Proposals / Requests for Comment (RFC) - Related Topics -Felix
outline_v0.1.xml
(text/xml, 4.6 KB)
<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE document SYSTEM "C:\Documents and Settings\Day\Desktop\Work\Documentation\schema\dtd\document-v11.dtd"> <?xml-stylesheet type="text/xsl" href="C:\Documents and Settings\Day\Desktop\Work\Documentation\skins\common\xslt\html\document2html.xsl"?> <document> <header> <title>Outline Lenya Documentation (Draft)</title> <version>0.3</version> <authors> <person name="Felix Maeder" email="[email protected]"/> </authors> </header> <body> <section> <title>Outline Lenya Documentation</title> <ol> <li>Installation<ol> <li>Binary Version</li> <li>Source Version</li> </ol> </li> <li>Getting Started (How-to's) <ol> <li>Customizing the default publication<ol> <li>Change the look</li> </ol> </li> <li>Creating your own publication<ol> <li>Copy the default publication</li> <li>Some basic configuration</li> <li>Customize the navigation</li> <li>Further steps</li> </ol> </li> <li>Adding a new doctype<ol> <li>Create the directories</li> <li>Customize the sitemap</li> <li>Create the dummy xml</li> <li>Create the look (xhtml, xslt)</li> <li>Make the document editable<ol> <li>With Bitfluxeditor</li> <li>With Xopus</li> <li>With HTMLFormEditor</li> </ol> </li> <li>Configure menus, creator, publisher, scheduler</li> </ol> </li> </ol> </li> <li>Concepts and Best Practises <ol> <li>Architecture<ol> <li>Overview</li> <li>Apache Cocoon</li> <li>Apache Slide</li> <li>Apache Lucene</li> <li>Third-party Editors</li> </ol> </li> <li>Directory structure</li> <li>Different sitemaps and their function</li> <li>Site tree</li> <li>Doctypes</li> <li>URI space</li> <li>Page envelope</li> <li>XHTML templating</li> <li>Metadata</li> <li>Tasks<ol> <li>The task concept</li> <li>Defining tasks</li> <li>The TaskAction: Triggering a Task from the Sitemap</li> <li>Scheduling a Task</li> <li>Included tasks<ol> <li>The DefaultFilePublisher Task</li> <li>The StaticHTMLExporter Task</li> <li>The MailTask</li> </ol> </li> <li>Developing Your Own Tasks</li> </ol> </li> </ol> </li> <li>Components <ol> <li>Access controlling<ol> <li>Overview</li> <li>Users and roles (IML)</li> <li>Policies (PML)</li> <li>Authenticators and authorisers</li> </ol> </li> <li>Revision controlling <ol> <li>Revision controller</li> <li>Check-out</li> <li>Check-in</li> <li>Rollback (RCML)</li> </ol> </li> <li>Workflow management</li> <li>Scheduler<ol> <ol> <li>Configuring the scheduler tasks</li> <li>Quartz scheduler</li> </ol> </ol> </li> <li>Editors and editor interfaces<ol> <li>HTMLFormEditor</li> <li>Bitfluxeditor</li> <li>Xopus</li> <li>Integrating other editors</li> </ol> </li> <li>Page/document creator<ol> <ol> <li>DefaultCreator</li> <li>Developing your own creator</li> </ol> </ol> </li> <li>Publisher/replicator<ol> <li>File system publishing</li> <li>Database publishing</li> <li>Publishing static HTML</li> <li>Replication<ol> <li>Via scp</li> <li>Via ftp/sftp</li> </ol> </li> <li>Developing your own publisher/replicator</li> </ol> </li> <li>Syndication<ol> <li>RSS</li> </ol> </li> <li>File upload</li> <li>Menus<ol> <ol> <li>Default menus</li> <li>Customizing the menus</li> </ol> </ol> </li> <li>Navigation</li> <li>Search Engine (Lucene)</li> </ol> </li> <li>Deployment and Administration<ol> <li>Server architecture</li> <li>Performance</li> <li>Testing</li> </ol> </li> <li>Proposals / Requests for Comment (RFC)</li> <li>Related Topics<ol> <li>Interesting editors</li> <li>Testing tools</li> <li>HSQL Database </li> <li>Java Virtual Machine: Encoding</li> <li>Publisher-Dispatcher-Notifier-Subscriber Pattern </li> <li>Spell Checking</li> <li>...</li> </ol></li> </ol> </section> </body> <footer> <legal>Lenya</legal> </footer> </document>
outline_v0.1.html
(text/html, 3.4 KB)
<?xml version="1.0" encoding="UTF-8"?><?xml-stylesheet type="text/xsl" href="C:\Documents and Settings\Day\Desktop\Work\Documentation\skins\common\xslt\html\document2html.xsl"?><div class="content"><table summary="" class="title"><tr><td valign="middle"><h1>Outline Lenya Documentation (Draft)</h1></td></tr></table><p><font size="-2">by Felix Maeder</font></p><ul class="minitoc"><li><a href="#">Outline Lenya Documentation</a></li></ul><a name="section52579608"/><h3>Outline Lenya Documentation</h3><div style="margin-left: 0 ; border: 2px"><ol><li>Installation<ol><li>Binary Version</li><li>Source Version</li></ol></li><li>Getting Started (How-to's) <ol><li>Customizing the default publication<ol><li>Change the look</li></ol></li><li>Creating your own publication<ol><li>Copy the default publication</li><li>Some basic configuration</li><li>Customize the navigation</li><li>Further steps</li></ol></li><li>Adding a new doctype<ol><li>Create the directories</li><li>Customize the sitemap</li><li>Create the dummy xml</li><li>Create the look (xhtml, xslt)</li><li>Make the document editable<ol><li>With Bitfluxeditor</li><li>With Xopus</li><li>With HTMLFormEditor</li></ol></li><li>Configure menus, creator, publisher, scheduler</li></ol></li></ol></li><li>Concepts and Best Practises <ol><li>Architecture<ol><li>Overview</li><li>Apache Cocoon</li><li>Apache Slide</li><li>Apache Lucene</li><li>Third-party Editors</li></ol></li><li>Directory structure</li><li>Different sitemaps and their function</li><li>Site tree</li><li>Doctypes</li><li>URI space</li><li>Page envelope</li><li>XHTML templating</li><li>Metadata</li><li>Tasks<ol><li>The task concept</li><li>Defining tasks</li><li>The TaskAction: Triggering a Task from the Sitemap</li><li>Scheduling a Task</li><li>Included tasks<ol><li>The DefaultFilePublisher Task</li><li>The StaticHTMLExporter Task</li><li>The MailTask</li></ol></li><li>Developing Your Own Tasks</li></ol></li></ol></li><li>Components <ol><li>Access controlling<ol><li>Overview</li><li>Users and roles (IML)</li><li>Policies (PML)</li><li>Authenticators and authorisers</li></ol></li><li>Revision controlling <ol><li>Revision controller</li><li>Check-out</li><li>Check-in</li><li>Rollback (RCML)</li></ol></li><li>Workflow management</li><li>Scheduler<ol><ol><li>Configuring the scheduler tasks</li><li>Quartz scheduler</li></ol></ol></li><li>Editors and editor interfaces<ol><li>HTMLFormEditor</li><li>Bitfluxeditor</li><li>Xopus</li><li>Integrating other editors</li></ol></li><li>Page/document creator<ol><ol><li>DefaultCreator</li><li>Developing your own creator</li></ol></ol></li><li>Publisher/replicator<ol><li>File system publishing</li><li>Database publishing</li><li>Publishing static HTML</li><li>Replication<ol><li>Via scp</li><li>Via ftp/sftp</li></ol></li><li>Developing your own publisher/replicator</li></ol></li><li>Syndication<ol><li>RSS</li></ol></li><li>File upload</li><li>Menus<ol><ol><li>Default menus</li><li>Customizing the menus</li></ol></ol></li><li>Navigation</li><li>Search Engine (Lucene)</li></ol></li><li>Deployment and Administration<ol><li>Server architecture</li><li>Performance</li><li>Testing</li></ol></li><li>Proposals / Requests for Comment (RFC)</li><li>Related Topics<ol><li>Interesting editors</li><li>Testing tools</li><li>HSQL Database </li><li>Java Virtual Machine: Encoding</li><li>Publisher-Dispatcher-Notifier-Subscriber Pattern </li><li>Spell Checking</li><li>...</li></ol></li></ol></div></div>