Skip to main content
Jump to: navigation, search

Jetty/Contributor/Editing the Wiki

< Jetty‎ | Contributor
Revision as of 06:53, 22 June 2009 by (Talk | contribs) (New page: <!-- page template --> {{Jetty How To | introduction = The Jetty Wiki structure is organized into sections, one tab for each section. The sections are described in [[Jetty|the Jetty wiki i...)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

{{Jetty How To | introduction = The Jetty Wiki structure is organized into sections, one tab for each section. The sections are described in the Jetty wiki index. For adding pages to each tab, use the following guidelines:

Getting Started
Entries should use the How To template. This list should be kept very short, and reference only the important getting started subjects: downloading, installing, running, upgrading.
Use the Feature template. These are also howto-like entries, but the section should contain only headline features like continuations, embedding etc. They should not contain too much detail, but instead link to howtos and/or references.

A feature will always be one feature per page.
These are longer entries with worked examples, often starting from something simple, and expanding to more complex examples. Tutorials are not exhaustive in their detail, but can link references for detail.

A tutorial may be multiple pages.
Use the How To template. These are introductory pages to specific feature sets (e.g., clustering, comet, security). The are like short tutorials and probably lack worked examples. They will often cover multiple related subjects, but should not contain too much detail. Instead, link to reference pages.

A howto will always be one howto per page.
These are detailed single subject pages, e.g., configuration formats, session configuration. etc.

A reference will always be one reference per page.
These are like chatty indexes into howtos and references that use the question form to guide the reader. The answers should be short and to the point. Link to howtos and references for the details.

Questions like "Where do I download Jetty?" do not belong in an FAQ; this should be easily discoverable from the site navigation. A good question for the FAQ would be "How do I find out which version of Jetty I am running?".

FAQ page(s) should be broken up into sections, each section getting its own page with multiple questions/answers on each page.
These are just like FAQs only about problems. Troubleshooting can be both a top level tab and a FAQ section pointing to the same content.

| prereqs = You must have sufficient edit privileges for the wiki. And make sure you're logged in! We assume that you are familiar with the Mediawiki syntax for formatting text, creating links, etc. If you need a reference, there's a link to "Editing help" at the bottom of each form. | steps =

  1. Decide the title of the page, and the section it should be under.
  2. Create the new page by going to, then use the Edit link at the left of that page.
  3. Look for an applicable template from the list above. If you can't find a suitable template and must write the page from scratch, use the {{Jetty}} template, which will add the navigation tabs, the infobox at the right, and the Jetty category. The Jetty templates all already include the {{Jetty}} template (and thus, navigation). Even better, though, if it looks like you'll be needing it for more than one document, is to create a new template based on the existing templates
  4. Add any additional categories, by doing [[Category: Category Name]]

| notes =

Other templates

There are a few additional templates that are worth taking note of:

a panel that can be used to highlight a section to the reader
a panel that can be used to warn the reader of something important
BlueBox|{{BlueBox}}]] : a blue box (actually, maybe only use this on the index pages?) === CSS === There are several ways you can prettify formatting: * To prettify tables, use the "jetty-table" class <pre> {| class="jetty-table" ! header |- | text |} </pre> * For non-tabular data, where you want a word to the left, and its definition to the right, such as above, use definition lists. ** wrap it in a <nowiki><div class="wide-list"> if you want it to stretch across the entire page (also the default)
    • wrap it in a <div class="narrow-list"> if you expect you will not have long content, and don't want it to sprawl across the entire page
    • wrap it in a <div class="unbounded-list"> if you want the alignment, but not the borders
 ; phrase : definition
<div class="wide-list">; phrase : definition</div>, etc
  • If you wish to define additional page-specific CSS, put it in between <css></css> tags.

| examples = This page is one big example. View the source code of the page (click the Edit button) to see how template usage in action. The Jetty templates also have #Usage sections, which show you the syntax you need to use the templates. But in general, what you'll see on a page is:

  {{Jetty How To
  | introduction = Paragraphs of introduction. May contain whitespace, wiki formatting, etc, as long as they don't start with a "|"
  | (sectionname) = section text
  | ... (more template-specific sections)
  | more =
  * [[Link 1|Text of link 1]]
  * [[Link 2|Text of link 1]]

  [[Category: How To]]
  [[Category: Meta]]


Back to the top