User Documentation Guidelines
The purpose of this document is to briefly address some common documentation style questions, so that user documentation is as consistent as possible.
Since this documentation is written in the wiki, please see the WikiFormatting page for general guidelines on how to format text in Trac's wiki.
Feel free to add additional conventions to this page that come up during the course of writing documentation.
General Rules
Including the navigation and info headers
Like all Wiki Pages on the Propel website, your documents have to contain the following snippet at the very top of your document (i.e. in the first line):
[[WikiInclude(PropelSiteHeader)]]
This will make sure that the breadcrumb navigation, last-modified info, TOC and navigation tree are displayed. The main document starts in the second line.
Headings and Table Of Contents
Use one First-Level heading at the top of your document:
= This is a schweet title for my guide =
Level-2 to Level-5 Headings will be detected and used to build a table of contents in the upper left corner of the page, so use headings to structure your document.
Markup Conventions
Referencing Filenames
Filenames can be referenced like 1-line code blocks:
You can find this in {{{default.properties}}}
Displays as:
You can find this in default.properties
Referencing Language Identifiers
PHP language identifiers such as PHP INI settings, and names of variables, classes, methods, constants, etc. should be expressed in italics.
You may notice that the generated ''Bookstore'' class has a ''getAuthor()'' method.
Displays as:
You may notice that the generated Bookstore class has a getAuthor() method.
XML & PHP code blocks
PHP Example:
{{{
#!php
<?php
$foo = $bar->getBaz();
}}}
XML Example:
{{{
#!xml
<foo>
<bar>Hello</bar>
</foo>
}}}
