Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Wiki Markup
{scrollbar}

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.

...

No Format
borderStylesolid
titleTips

- 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:
    <geronimo_home>/
    <sampleApp_home>/
    <JBoss_home>/
    <WAS_home>/
    <WLS_home>/
    ...

- 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!


- 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.

...