Cytoscape Wiki|
Size: 899
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: |
| 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. | 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: |
|
* ["/Learn about DocBook"] * ["/DocBook 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 14: | Line 11: |
| 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. |
= 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. |
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.