...
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.
...
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.
...
Use {scrollbar}
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:
...
Versions
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 "."
...
For command samples, as in a command line window use:
...
...
The result will look like this:
...
For unformatted, plain text samples use:
...
...
{noformat:borderStyle=solid|title=some_title}
sample text
{noformat}
...
The result will look like this:
...
...
Code formatting
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.
...
For XML samples use:
...
The result will look like this:
...
...
For Java samples use:
...
The result will look like this:
...
...
For JavaScript samples use:
...
...
The result will look like this:
...
...
For HTML samples use:
...
...
The result will look like this:
...
...
For SQL samples use:
...
The result will look like this:
...
Command samples and results
For command samples and results as a command line screen capture use:
...
...
{noformat:borderStyle=solid}
sample text
{noformat}
...
The result will look like this:
...
Commands in paragraph
For commands or code within a paragraph use:
...
...
The result will look like this:
...
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.
...