Versions Compared

Key

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

Add sections for Parent Pageds, Labels, and Comments.

...

  • Use "the framework" or "Struts 2" to refer to Struts 2 as a whole, including any frameworks we use internally, like XWork and OGNL.
  • Use "Action class" to refer to the Java class incorporated by the action element.Use "action mapping" to refer to the object created by the action element.or "action handler" to refer to the Java class incorporated by the action element.
  • Use "action mapping" to refer to the object created by the action element.

Page Save Comment

Try to include a brief description of a change when saving a page. The comments are included in the page's history. The comments are also included on the daily change report. In a group environment, it's important to help each other follow along.

Parent Pages

Use the Parent Page feature to create a hierarchy of pages. The parent pages are reflected in the "bread crumb" menu. If propertly used, parent pages can help browsers "visualize" the documenation as an outline.

The root of the documentation is the "Home" page, which is also the "Welcome" page. The documnentation is ordered into three main areas: Tutorials, FAQs, and Guides. Each area has a contents page, whose parent is Home. Other pages within each section can also serve as parents, to help organize the documentation into a coherent outline.

Labels

Pages can be cross-indexed with the Label feature. Labels are not be used much yet, except for internal authoring.

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

About Headings

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

...

Code Block
java
java
titleHelloWorld.java
/** Hello World class. */
public class HelloWorld {
  /** Main method. */
  public static void main(String[] args) {
    System.out.println("Hello, World!");
  }
}

(warning) (tick) Try to use snippets for code blocks whenever possible!

...