|
|
| Index > Tips for writing and formatting documentation |
This page is included in an attempt to provide some standard guidelines for the naming and formatting used in the development of Geronimo's documentation. This will help us all to maintain a consistent look and feel throughout the entire documentation and Geronimo spaces.
First of all, get familiar with Confluence markup, see the Notation Help. You may also find this guide useful.
For comments and/or concern, please join our mailing list and post your inquires there.
This document is organized in the following sections:
When making a reference to any document in the wiki you should point to this autoexported HTML content, avoid pointing directly to Confluence content. If the page you are browsing does not have the Geronimo banner on top then you are not looking at the HTML version.
Good:
http://cwiki.apache.org/geronimo/geronimo-cwiki-documentation-architecture.html
Bad:
http://cwiki.apache.org/confluence/display/geronimo/Tips+for+writing+and+formatting+documentation
Tip:
One way to get back to the HTML version of the page you just edited is to navigate to that particular page from http://cwiki.apache.org/geronimo .
Refer to Geronimo cwiki documentation architecture for further details.
Every time you create a new page add at the top the {scrollbar} macro unless that page is (and will remain that way) the only child page of it's parent.
For installation paths use something like this:
For versions use:
Ultimately v1.0 or v1.1, the lower case "v" always precede the number.
For reference to file extensions use:
Make sure to include the "."
To display an image proceed this way:
!file_name.gif! optionally for flow charts you can use center alignment !file_name.gif|align=center!.To create the diagram you could use any presentation software such as OpenOffice (http://www.openoffice.org) and export the slide as JPG and then attach it to the documentation page. THIS IS THE PREFERRED METHOD.
Alternatively you could use the "Add Diagram" option to build one chart online. This option depends on a plugin and uses a web based interface to create the various diagrams. For additional information on this plugin visit:
For command samples, as in a command line window use:
The result will look like this:
sample command
Use a new line when possible.
For unformatted, plain text samples use:
{noformat:borderStyle=solid|title=some_title}
sample text
{noformat}
The result will look like this:
The current version of Confluence supports color coding for XML, Java, JavaScript, HTML, SQL and ActionScript. Here are some examples for those formats likely to be used in Geronimo's doumentation.
The result will look like this:
The result will look like this:
The result will look like this:
The result will look like this:
The result will look like this:
For command samples and results as a command line screen capture use:
{noformat:borderStyle=solid}
sample text
{noformat}
The result will look like this:
For commands or code within a paragraph use:
The result will look like this:
"sample text in the paragraph command sample text in the paragraph some_java_code."
For special notes to bring reader's attention use the already existing standard macros such as:
When necessary, you can also add a title to these boxes, for example:
The result will look like these:
Message goes here.
Info message goes here.
Tips goe here.
Warning message goes here.
Currently, Confluence does not provide spell check so you should use the method of your choice to perform spell checking.
Mac OS X users can simply right-click on text areas and select Spelling -> Check Spelling as You Type.
Firefox 2.0 provides a built-in spell-checking, older versions of Firefox can get a plugin to fill in the gap.
Bookmark this on Delicious
Digg this
|
Privacy Policy - Copyright © 2003-2009, The Apache Software Foundation, Licensed under ASL 2.0. |