This document describes our web site setup: what is where and how it works.

Overview

Most of the web site and documentation (with the notable exception of the Javadoc API pages) are kept in Confluence.

...

• 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 Component Templates Confluence Site Setup
• 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

The Index Confluence Site Setup page includes the Banner and Key Features Confluence Site Setup and Confluence Site Setup pages as well as the blog posts. Most other pages are just plain pages and may or may not include other parts. In addition the Navigation, Small Banner and Footer Confluence Site Setup, Confluence Site Setup and Confluence Site Setup pages exist.

Our SiteExporter template (described above) glues everything together. It adds the contents of the Navigation and Footer Confluence Site Setup and Confluence Site Setup pages in the appropriate places and on all pages except the Index Confluence Site Setup page. It also adds the contents of the Small Banner Confluence Site Setup page as well as the breadcrumbs navigation.

Updating the template

You must be a Tapestry committer or otherwise have write access to the subversion repository (see link above).

...