Help:Formatting
Revision as of 14:10, 19 August 2013 by Mtrojan (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Help:Formatting

This page contains an overview of code elements that can be used to style content within the wiki.

Basic Design Elements

'''Bold text''' Bold text

''Italic text'' Italic text

'''''Bold Italic text''''' Bold Italic text

[[Link to internal page]] Link to internal page

[http://www.google.com Link to external site] Link to external site

Images

To left align an image: [[Image:example.png|Alt Tag|left]]

To right align an image: [[Image:example.png|Alt Tag|right]]

HTML Tables

Code:

<table>
<tr>
<th>Heading 1</th>
<th>Heading 2</th>
<th>Heading 3</th>
<th>Heading 4</th>
<th>Heading 5</th>
</tr>
<tr>
<td>Row 1-1</td>
<td>Row 1-2</td>
<td>Row 1-3</td>
<td>Row 1-4</td>
<td>Row 1-5</td>
</tr>
</table>

Heading 1	Heading 2	Heading 3	Heading 4	Heading 5
Row 1-1	Row 1-2	Row 1-3	Row 1-4	Row 1-5
Row 2-1	Row 2-2	Row 2-3	Row 2-4	Row 2-5
Row 3-1	Row 3-2	Row 3-3	Row 3-4	Row 3-5

Math / Equations

Usage: \(A_{sv} = (A_{sd} * Sn_w) - I_{vol}\)

Output:\[A_{sv} = (A_{sd} * Sn_w) - I_{vol}\]

Construct equations using LaTeX. More indepth instructions and example can be found here.

The following formatting rules will be applied to all equations:

no equation numbers (e.g. do not indicate "Equation 1", "Equation 2", etc.
the equation should be indented once (:) and written in 5 point font.
The "where" term, which identifies the terms used in the equation, is regular font, left indented, with a space between it an the equation
the terms under the "where" heading are 5 point font; the remaining text is regular font
numbers and non-formula text (i.e. not equation terms) are not italicized
equation terms under the "where" heading are indented once (:)
no bold

It is recommended you use the Math function. However,if using the Math function you will need to overide the centering, adjust the font, and correct use of italics.

Example;

File Uploads

Link to the wiki page that contains a link to download

Usage: [[File:sample.doc]] Example: File:Sample.doc

Link directly to the document

Usage: [[media:sample.doc|This is a Microsoft Word document]] Example: This is a Microsoft Word document

Bootstrap specific design elements

Alert Messages

Usage: {{alert|This is your message|alert-danger}}

Examples

Warning: This is an alert message! (alert-danger)

Caution: This is an alert message! (alert-warning)

Green Infrastructure: This is an alert message! (alert-success)

Information: This is an alert message! (alert-info)

Tooltips

Usage: {{tip|Something|This is the tooltip!}} or {{tip|[[A Link]]|This is the tooltip!}}

Examples

Something

A Link

Popovers

Usage: {{pop|This is a popover|Popover Title|Popover Content}}

Example: This is a popover

Citations/references

The basic concept of the ref tag is that it inserts the text enclosed by the ref tags as a footnote in a designated section, which you indicate with the placeholder tag references /. See [1]

Equations

The following conventions should be followed when writing math equations

It is recommended to use the math function
There should be no text in the equation other than equation terms
Use coding for the Math extension (see Help:Contents)
Combine numeric terms to the extent possible
Use spacing between terms
Do not use * to denote multiplication

For example, the equation a = 0.5 inches * (b - c) * 1/20 can be rewritten a = 0.25 (b - c)

The following conventions should be followed when writing the explanation for equation terms

"where" should be left justified and lower case
terms following "where' should be indented once (:)
the terms should be italicized if they are italicized in the equation
follow each equation term description with a semicolon; the next to last description should include "and" after the semicolon
you will manually have to insert subscript and superscript commands
you will manually have to change the font size to 3

Other conventions to follow

do not use equation numbers (e.g. equation 1)
do not use bold
utilize a space between the equation and the "where" term

An example equation is shown below and a screen shot of the code used to generate this equation is included below.

\(V_wq = 1815 (IC - CA)\)

where:

V_wq = required water quality volume in cubic feet;

IC = new site impervious cover, in acres;

CA = total natural area conserved at site, in acres; and

1815 is a term used to convert the volume to cubic feet

Rule 2 (Stormwater Ponds and Constructed Wetlands Draining to Special Waters) and Rule 4 (Non-Ponds Draining to Special Waters):

\(V_wq = 3630 (IC - CA)\)