Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment:

Add Shortcut Links section

...

FIXME

A page that mentions a problem in the distribution that we intend to fix. Review these pages before tagging a distribution to see if the issue has been resolved.

TODO

A page that is incomplete. Try to complete these pages before tagging a distribution

The Shortcut Link feature should be used for any external reference that may be used elsewhere. Shortcuts being used include

jira

A ticket in our issue tracker

primer

A bookmark in our Key Technologies Primer

xwork/api

A class in the XWork Javadocs

java/api

A class in the Java Javadocs

wiki/help

A topic the Confluence help system

Please add new shortcuts as needed.

About Headings

(info) This section refers to: Notation Guide >> Headings.

About h1

Don't use h1. at the top of each page. The page title serves as the "top level header". This is not as obvious online, but it is very apparent when the documentation is exported to HTML or PDF.

...