TextFormattingRules

Structured text is an easy to use shorthand method for formatting text in your web pages. It allows rapid and simple editing of text in a plain text view as an alternative to a WYSIWYG or direct HTML editor. Simple text structures are used that are translated to HTML when viewed in a web browser. Pages created with structured text automatically take on the style and appearance of the Web site they are created on. You should normally use structured text in Structured Text or Wiki pages, but you may also use simple HTML tags in those pages if necessary (see HTMLBasics). Restructured text is an extended version of structured text which you may also use if the page type is set to reStructured Text.

Structured text rules:

Paragraph

Separate paragraphs with at least one blank line in between.

Heading

Type out the heading; indent the first line of the next paragraph using a single space.

Bullet-list

Place a dash (-) before each item in your list. Double space list items. To make sublists, indent the sublist items more than the main list items.

Numbered List

Place a number (any number) before each item in your list. Double space list items.

Definition List

Type the definition term followed by two dashes and then type your definition.

Italics/Emphasis

Put a single asterick (*) on each side of the text to be italicized.

Bold/Strong

Enclose text with two astericks (**).

Underlined

Enclose text with an underscore ( _ )

Web Address Citation

Type out or copy/paste a web address in its usual form. It will be recognized and turned into a link.

Example: http://www.google.com

...appears as http://www.google.com.

Hypertext

Enclose the text for the link in quotation marks followed by a comma and the full web address

Example: "Google", http://www.google.com

...appears as Google

Email Address

Enclose text in quotation marks followed by a comma, the code "mailto:" and the email address

Example: "Jordan Carswell", mailto:jordan.carswell@hccs.edu

...appears as Jordan Carswell

Footnote

Cite your footnote using a bracketed number, [1]

At the end of the page, provide footnote using two periods, space, and bracketed number, .. [1]

Clicking the first bracketed number will jump to the bracketed number preceded by the two periods.

Python, HTML or XML code

For short sections of code, enclose the text in single quotes (this doesn't work if the code contains single quotes). For longer code excerpts, type a preceding paragraph that ends in two colons. Then indent each following line at least one space. All characters will be printed exactly as typed, in monospaced font, until a line with no indenting is reached.


Source: jhh Wikis    URL: http://jhh.med.virginia.edu/main/TextFormattingRules