Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Fixed bad links due to copy-paste from cwiki-test

...

  • Precede annotation names with '@'. If the annotation name is hyperlinked, put the '@' character outside of the link: @[AnnotationType|http://...AnnotationType.html]
  • The first reference to a type on a page should be a link to http://tapestry.apache.org/current/apidocs/... (or the component reference)
  • Treat the page title as if it were an h0. element, and put top level sections within the page as h1.
  • Page names as headings should have All Words Captialized.
  • For other headings, only the first word of multi-word headings should be capitalized, e.g. "h2. Naming conventions" (following Wikipedia)
  • Use code font for method and property names: myProperty, someMethod().
  • Use the default font for Class names (qualified or not).
  • Use the default font for path names.
  • Use {code} for listings, not {noformat}.
  • Use {noformat} for console output.
  • Images and diagrams should be small-sized thumbnails, centered, with no border.
  • Use the Since and Deprecated macros to mark new or deprecated features.
  • Proposed: Each page should include explicit links to its child pages. Don't rely on the "Child Pages" links at the bottom, which don't carry over to the exported site.
  • Proposed: In pages other than the User Guide pages, subsections that briefly discuss topics that are more fully covered in the User Guide should lead with a "Main Article: [Foo]" line, where Foo is the name of the page in the User Guide. Example: the "Template Localization" section of Confluence Site Setupof Component Templates
  • Proposed: User Guide pages should generally start with a right-floated "Related Articles" box that provides links to related content in the FAQ, Cookbook, Cheat Sheets, etc. Example
  • Proposed: The lead paragraph should generally lead with the title word or phrase in bold (following Wikipedia)

Website structure

...

...

...

...

...

Warning

HLS: I've noticed that pages with footnotes that are combined with the {include} macro do not render correctly ... the footnote numbers and anchors reset back to 1 for each included page. Perhaps there's a way to fix that with the template?

...