Cytoscape Wiki|
Size: 1735
Comment:
|
← Revision 27 as of 2009-02-12 01:03:38
Size: 975
Comment: converted to 1.6 markup
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 1: | Line 1: |
| The Cytoscape user manual exists as a Microsoft Word file in: | = Overview = |
| Line 3: | Line 3: |
|
{{{ cytoscape\user_docs }}} |
The Cytoscape user manual exists as a wiki page: [[Cytoscape 2.3 User Manual]] |
| Line 7: | Line 5: |
| 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. | When editing the manual, please use GIF or PNG files for all screenshots. Do not use JPG, as this is a lossy file format. |
| Line 9: | Line 7: |
| 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. | When creating a manual for a new version, the manual from the pervious version should be copied to a new page. This is so we can keep old versions of the manual for those using older versions of Cytoscape. |
| Line 11: | Line 9: |
| Two options for DocBook editing with GUI editor: | During the release process, the page will be automatically converted to DocBook format and then to various other formats, like PDF and Java Help |
| Line 13: | Line 11: |
|
* 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 * [http://openoffice.org/ OpenOffice 2.0 (RC1)] has support for saving in docbook format directly: |
= Style Guide = |
| Line 21: | Line 13: |
|
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. It is also ported to Linux, FreeBSD, Solaris and Windows, so portability is not too much a problem here :-) . The source code is also available, so it can be ported to other platforms too. For the PDF generation, one can use the native PDF exporter of OpenOffice (no need for extra tools). 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. |
* Try not to use underlines. Underlines generally indicate hyperlinks, and using underlines w/o such hyperlinks tends to confuse the user. Use bold instead. * To describe user menu actions, use the following template: '''File → Import → Network'''. * Resize images to a max width of 600 pixels. The images should not be so big as to overhwelm the reader. |
Overview
The Cytoscape user manual exists as a wiki page: Cytoscape 2.3 User Manual
When editing the manual, please use GIF or PNG files for all screenshots. Do not use JPG, as this is a lossy file format.
When creating a manual for a new version, the manual from the pervious version should be copied to a new page. This is so we can keep old versions of the manual for those using older versions of Cytoscape.
During the release process, the page will be automatically converted to DocBook format and then to various other formats, like PDF and Java Help
Style Guide
- Try not to use underlines. Underlines generally indicate hyperlinks, and using underlines w/o such hyperlinks tends to confuse the user. Use bold instead.
To describe user menu actions, use the following template: File → Import → Network.
- Resize images to a max width of 600 pixels. The images should not be so big as to overhwelm the reader.