GENESIS: Documentation

Related Documentation:

New Document

The three above headings are included in all documentation by default.

• The Documentation Identifier: This may be replaced by a descriptor of the type of documentation you have developed, for example Introduction or Tutorial, etc.
• Related Documentation Heading: Followed by a hyperlink list of any related documentation.
• New Document Heading: Should be replaced with the title of your document. Note: In your document (the LATEX source documentation file–NewDocument.tex) all text below the New Document heading should be replaced with your own content. See Create Document for further information.

Help with LATEX Documentation

Text color

Text in your document can be colorized with the command

for example This is IMPORTANT, green and blue are also recognized arguments.

Hyperlinks

Two classes of hyperlink exist in the GENESIS Documentation System:

• Static Hyperlinks:
  • Local links: These are produced with the command:

    \href{../NewDocument/NewDocument.html}{NewDocument}}

    for example NewDocument references this document. Note that these links may not work in your LATEX pdf file viewer, but should be testable with the Acrobat Reader or Acrobat Professional packages.

  • Remote links: These use the href command in a slightly different way:

    \href{http://www.genesis-sim.org/documentation}{GENESIS Documentation}

    for example see GENESIS Documentation. Note that these links do not wrap automatically at the end of a line even outside of the verbatim environment.

• Reference Hyperlinks: See Document Creation for further details on managing reference hyperlinks.

Figures

Figures can easily be added with the following code:

References