Cytoscape Wiki|
Size: 1427
Comment:
|
Size: 899
Comment:
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 9: | Line 9: |
| It would be nice to have a more cross-platform and manageable solution to user documentation. Mike Smoot suggested DocBook, though as of late 2005, it appears not to have a GUI editor, which is definitely a requirement for us. If you are aware of other options, let us know. | We are considering moving to a more cross-platform and manageable solution to user documentation. One option is [http://docbook.org DocBook], however, as of late 2005 it appears that GUI DocBook editors, a requirement for us, are somewhat limited. If you are aware of other options, let us know. |
| Line 11: | Line 11: |
| Two options for DocBook editing with GUI editor: |
* ["/Learn about DocBook"] * ["/DocBook GUI editor"] |
| Line 13: | Line 14: |
|
* XMLEditor is specific for XML: * http://www.happy-monkey.net/docbook/gui-editor.html * http://www.xmlmind.com/xmleditor/ * [http://openoffice.org/ OpenOffice] can work with DocBook: * http://wiki.docbook.org/topic/OpenOffice * http://xml.openoffice.org/xmerge/docbook/UserGuide.html * OpenOffice 2.0 (still beta) has support for saving in docbook format directly: attachment:ooo-docbook.png An advantage of using OpenOffice is that it can open the current manual in MS-Word format (see the picture above). As many of Cytoscape developers are Mac users, OpenOffice is also not a problem as it runs on MacOSX too. I haven't tested OpenOffice with DocBook (because I never worked with DocBook :-) ) and just found XMLEditor using Google, so I haven't tested it either. |
Another possibility is to use HTML (for this one, there is a high number of editors) and use [http://htmldoc.org/ htmldoc] to convert to PDF. This has the advantage of letting users to consult the manual direct from the Cytoscape website. |
The Cytoscape user manual exists as a Microsoft Word file in:
cytoscape\user_docs
To modify the manual, edit the document in Microsoft Word and check it back in to CVS. Someone (maybe it will be you!) will create a PDF from this Word document near release time for distribution.
We are considering moving to a more cross-platform and manageable solution to user documentation. One option is [http://docbook.org DocBook], however, as of late 2005 it appears that GUI DocBook editors, a requirement for us, are somewhat limited. If you are aware of other options, let us know.
Another possibility is to use HTML (for this one, there is a high number of editors) and use [http://htmldoc.org/ htmldoc] to convert to PDF. This has the advantage of letting users to consult the manual direct from the Cytoscape website.