Open Med School

Experience with Evidence

User Tools

Site Tools


Sidebar

Search and resources

OMS project

Contributors

Editor information
» Account creation
» Syntax guide
» Page templates
» Citation


Material on OMS is for educational purposes and should not be used for clinical decision making.

oms:syntax

Syntax guide

Sentences and paragraphs

Since formatting paragraphs is more straight forward, we will go over them first.


Paragraphs

To start a new paragraph, simply have a full blank line in between the paragraphs.

  • For example, when you type:
Sentence 1 in paragraph I. Sentence 2 in paragraph I.

Sentence 1 in paragraph II. Sentence 2 in paragraph II.
  • You get:

Sentence 1 in paragraph I. Sentence 2 in paragraph I.

Sentence 1 in paragraph II. Sentence 2 in paragraph II.


Sentences

When you don't include a full blank line, Wiki will ignore a hard-return (equivalent of hitting the Enter key once) and join the two sentences in a single paragraph.

  • For example, when you type:
This is line 1.
This is line 2.
  • You get:

This is line 1. This is line 2.


Thus, in order to have a new line or paragraph without a blank line in between, use the syntax two forward slashes (\\) at the end of the line and a space ( ).

  • For example, when you type:
This is line 1.\\
This is line 2.

or

This is line 1.\\ This is line 2.
  • You get:

This is line 1.
This is line 2.



Text formatting


Bold

Use two asterisks (**) to enclose the word(s) that you want to bold.

  • For example, when you type:
This is a **very** important sentence.
  • You get:

This is a very important sentence.


Italic

Use two slashes (//) to enclose the word(s) that you want to italicize.

  • For example, when you type:
This is a very important //sentence//.
  • You get:

This is a very important sentence.


Underline

Use two underscores (__) to enclose the word(s) that you want to underline.

  • For example, when you type:
This is an __important__ sentence.
  • You get:

This is an important sentence.


Monospace

Use two apostrophes ('') to enclose the word(s) that you want to be monospaced.

  • For example, when you type:
This is an important ''sentence''.
  • You get:

This is an important sentence.


Strike-through

Use the tag pair <del> and </del> to enclose the word(s) that you want to strike through.

  • For example, when you type:
This is an <del>important</del> sentence.
  • You get:

This is an important sentence.


Superscripts and subscripts

Use the tag pair <sup> and </sup> to enclose the word(s) for superscript.

Conversely, use the tag pair <sub> and </sub> to enclose the word(s) for subscript.

  • For example, when you type:
This shows you how <sup>superscripts</sup> AND <sub>subscripts</sub> work.
  • You get:

This shows you how superscripts AND subscripts work.


Combining formats

You can combine the formats listed above in any way you want.

  • For example, when you type:
This **//__is__//** an **<del>important</del>** ''//sentence//''**<sup>(see footnote)</sup>**.
  • You get:

This is an important sentence(see footnote).



Sectioning


Headings

  • Headings are enclosed by a certain number of equal signs (=).
  • Syntax:
====== Level 1 heading ======

===== Level 2 heading =====

==== Level 3 heading ====

=== Level 4 heading ===

== Level 5 heading ==
  • Level 1 heading is for the page title only
  • Level 2 headings are for the major sections of a page
  • Level 3 headings are for sub-sections of major sections
  • Level 4 and level 5 headings can be confused with normal body text and should only be used sparingly.


Table of contents

  • Table of contents is automatically created using the headings.
  • To disable, include ~~NOTOC~~ anywhere in the page.


Dividing line

A dividing line is created by typing four (4) dash symbols (----) with a blank line above and below the dash lines (make sure there's no space [like this ] in the blank lines).




Internal


External


Interwiki



Lists

Unordered

Use two spaces ( ), an asterisk (*), and another space. For each additional level, add addition two spaces in the front.

  • For example, if you type:
  * Item A
  * Item B
  * Item C
    * Sub-item C1
    * Sub-item C2
    * Sub-item C3
      * Sub-sub-item C3a
      * Sub-sub-item C3b
  * Item D
    * Sub-item D1
  * Item E
  • You get:
  • Item A
  • Item B
  • Item C
    • Sub-item C1
    • Sub-item C2
    • Sub-item C3
      • Sub-sub-item C3a
      • Sub-sub-item C3b
  • Item D
    • Sub-item D1
  • Item E


Ordered

Use two spaces ( ), a dash (-), and another space. For each additional level, add addition two spaces in the front.

  • For example, if you type:
  - Item A
  - Item B
  - Item C
    - Sub-item C1
    - Sub-item C2
    - Sub-item C3
      - Sub-sub-item C3a
      - Sub-sub-item C3b
  - Item D
    - Sub-item D1
  - Item E
  • You get:
  1. Item A
  2. Item B
  3. Item C
    1. Sub-item C1
    2. Sub-item C2
    3. Sub-item C3
      1. Sub-sub-item C3a
      2. Sub-sub-item C3b
  4. Item D
    1. Sub-item D1
  5. Item E


Mixing both

You can mix both of the syntax above to create any combined ordered/unordered list.

  • For example, if you type:
  - Item A
  - Item B
  - Item C
    * Sub-item C1
    * Sub-item C2
    * Sub-item C3
      - Sub-sub-item C3a
      - Sub-sub-item C3b
  - Item D
    * Sub-item D1
  - Item E
  • You get:
  1. Item A
  2. Item B
  3. Item C
    • Sub-item C1
    • Sub-item C2
    • Sub-item C3
      1. Sub-sub-item C3a
      2. Sub-sub-item C3b
  4. Item D
    • Sub-item D1
  5. Item E



Tables

CSV

You can insert a table by uploading a CSV file.

The following table is created using syntax <csv oms:csv_example.csv></csv>, in which <csv></csv> is the syntax with <csv> modified by oms:csv_example.csv, which is a CSV file named csv_example with file extension .csv uploaded to the oms: namespace.

Header 1Header 2
Item ABox A1Box A2
Item BBox B1Box B2
Item CBox C1Box C2

Quoting


Media files


No formatting

  • Syntax:
    1. Enclose the relevant portion with %% symbols or
    2. Enclose with <nowiki> and </nowiki> pair of tags

Tagging

  • Syntax: {{tag>}}
  • Separate each tag with a space ( )
  • For example, if you want to tag a page as internal medicine article that is related to the heart and lungs, you can type the following at the end of the page:
    • {{tag>Internal_medicine Heart Lung Article}}
    • A tag with more than one word is separated by an underscore (_) and the words after the first one is not capitalized
    • Put the tags in the order that they appeared in the tagging guide
  • For a list of standardized tags, please refer to category tagging guide

Footnotes

oms/syntax.txt · Last modified: 2020-06-25 23:24 by TC Chen