RFC Name : Migrating the user manual to the wiki

Editor(s): GaryBader

<<TableOfContents: execution failed [Argument "maxdepth" must be an integer value, not "[2]"] (see also the log)>>

About this document

This is an official Request for Comment (RFC) for migrating the user manual to the wiki.

For details on RFCs in general, check out the Wikipedia Entry: Request for Comments (RFCs)


Open for public comment

How to Comment

To view/add comments, add them directly under the appropriate section. By adding your ideas to the Wiki directly, we can more easily organize everyone's ideas, and keep clear records. Be sure to include today's date and your name for each comment.

Try to keep your comments as concrete and constructive as possible. For example, if you find a part of the RFC makes no sense, please say so, but don't stop there. Take the extra step and propose alternatives.


Currently the user manual is stored as a master Microsoft Word document in CVS. This is the main document edited and is converted automatically to PDF for the distribution and mostly manually to HTML to the online help (JavaHelp format) available from within Cytoscape. The problem with this is that it takes a long time to update the HTML and is not very flexible - for instance, we can't automate it as part of the build process.

The proposal is to move the master user manual document to the wiki and write some scripts to convert from the wiki initially only to PDF and JavaHelp HTML.

General Notes

Open Issues

Implementation Plan

RFC_3 (last edited 2009-02-12 01:04:11 by localhost)

Funding for Cytoscape is provided by a federal grant from the U.S. National Institute of General Medical Sciences (NIGMS) of the Na tional Institutes of Health (NIH) under award number GM070743-01. Corporate funding is provided through a contract from Unilever PLC.

MoinMoin Appliance - Powered by TurnKey Linux