This style of page is not really very easy to read... as it
basically tosses out any use of any markup... and does not link to
urls, etc...
I highly recommend you don't use {noformat} macros here. If you want
to use a {noformat} around the wiki snips thats fine, but its really
not a good choice for this mostly full-page panel.
--jason
On Feb 13, 2007, at 11:39 AM, [EMAIL PROTECTED] wrote:
Page Edited : geronimo : Tips for writing and formatting documentation
Tips for writing and formatting documentation has been edited by
Hernan Cunico (Feb 13, 2007).
(View changes)
Content:
<back_16.gif>
Geronimo cwiki documentation architecture
<up_16.gif>
Index
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
<linkext7.gif>
Tips
- 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
of it's parent.
- For installation paths use something like this:
/
/
/
/
/
...
- For versions use:
Apache Geronimo v1.0
Apache Geronimo v1.1
Apache Geronimo v1.1.1
ultimately v1.0 or v1.1, the lower case "v" always precede the
number.
JBoss v4
Tomcat v5.5.9
- For reference to file extensions use:
*.zip*
*.tar*
*.gz*
*.gzip*
*.jar*
*.war*
(include the " . " )
- To display an image proceed this way:
-- Attach the image file first.
-- Avoid blank spaces in the file name.
-- in a new line reference the image !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
http://confluence.atlassian.com/display/CONFEXT/Gliffy+Plugin+for
+Confluence+-+Diagram+and+draw+in+Confluence
- For command samples, as in a command line window use:
*{{sample command}}*
use a new line when possible.
- For unformatted, plain text samples use:
{noformat:borderStyle=solid|title=file_name}
sample text
{noformat }
- For XML samples use:
{code:xml|borderStyle=solid|title=file_name}
text
{code}
- For Java samples use:
{code:java|borderStyle=solid|title=file_name}
text
{code}
- For command samples and results as a command line screen capture
use:
{color:white}
{noformat:borderStyle=solid|bgColor=#000000}
sample text
{noformat }{color}
- For commands or code within a paragraph use:
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:
{note}Message goes here.{note}
{warning}Warning message goes here.{warning}
{info}Info message goes here.{info}
{tip}Tips goe here.{tip}
When necessary you can also add a title to these boxes, for
example:
{warning:title=Warning}Warning message goes here.{warning}
- Spell checking:
Currently, Confluence does not provide spell check so you
should use the method of your choice to perform spell checking.
For comments and/or concern, please join our mailing list
<linkext7.gif>
and post your inquires there.
Powered by Atlassian Confluence (Version: 2.2.9 Build:#527 Sep 07,
2006) - Bug/feature request
Unsubscribe or edit your notifications preferences
