This topic contains an outline of formatting to be used when editing on the Australian Wazeopedia.
Captions
Captions need to be manually added to images. They should be added directly under the image, with no line spacing, using italics and a smaller font as shown below.
[size=90]*Caption*[/size]
Inside a table created with HTML you may need to use the format below.
<small><i>Caption</i></small>
Drafts
Draft topics may be created before they are released to all editors. This would generally be to allow time for creation and editing before being released for consultation. These should be stored in the Wiki Resources category and begin with “draft” then the name - Draft - Topic Title
Tags should not be added to drafts until they are released and moved into their wiki category.
Formatting
Markdown
Markdown is the preferred method of formatting topics, primarily for its simplicity and readability. This is important as not all editors have advanced markup knowledge. In addition to the already provided tags and information in Wiki Resources, information on formatting topics can be found the in the Formatting posts using markdown, BBCode, and HTML topic at Discourse.
HTML
The use of HTML is severely restricted in Discourse and generally only allows basic tags. For this reason it should only be used when achieving the desired formatting is not possible using Markdown. An example of this would be a table without a header row or the use of rowspan or colspan in a table. Information on what may be possible is available from Discourse however be aware that Waze Discuss may be further restricted.
Highlighting
Bold text within paragraphs is quite stark in Discuss compared to other platforms. It should be avoided wherever possible and replaced with text that is italicised and underlined. You can use the [u][/u] tag to add underlining. Bold also does not stand out as much in dark mode.
Bold is acceptable when highlighting a word at the beginning of an important paragraph. For example note, care or hint.
Bold may be required when using a red Waze Box. The standard text can be hard to see on the red background.
Images
Description
When uploading images to a topic you should ensure that they contain an appropriate description. The example below has the description highlighted in orange.
Grouping
At the time of writing there is no way to add a gallery to Discuss. For small groups of images the best way is to use a table with the images in row one and the caption in row 2. An example of this can be found here.
Language
The wiki should be written with simple, plain and easy to understand words and phrases (unless specific language is required to highlight a particular point). The recommended age level is year seven.
Some example words and phrases to avoid are:
- Such as
- In so doing
- Aformentioned
Link Levels
Link levels should be the same as the heading level. For example Waze Heading 3 should have a link level of ###. There must be a space after the hashes.
mBoxes
These are not available in Discuss. They have been replaced with Waze Boxes.
Tables
Tables should be created using markdown by default. Insert Table can be used to make the initial setup and entering of data easier. The Edit Table function can be used to make changes after the table has been created. This is accessed by clicking on the pencil (Edit Table) in the top right hand corner when viewing the post (do not edit the post to use this).
There are cases where it may be necessary to create a table using HTML. Only a basic table (limited formatting) can be created.
Tags
Tags should only be created to group together multiple topics with the same subject. They are generally used to create a fourth category level but could also be used to group together related topics in different categories. Keep in mind tags are available to be searched across the entire Discuss site, not just with the Australian Wazeopedia.
- All tags must begin with
#as-wiki - Tags should contain the category and then subject. For example
#as-wiki-guides-permanent-hazards - If topics are in different categories, drop the category and only use the subject. For example
#as-wiki-streets
Templates
Templates should be stored in the Wiki Resources category. They should begin with “template” then the topic name - Template - Title
Waze Boxes (or wzBox)
Refer to the separate topic on Waze Boxes