You must log in to edit PetroWiki. Help with editing

Content of PetroWiki is intended for personal use only and to supplement, not replace, engineering judgment. SPE disclaims any and all liability for your use of such content. More information

Message: PetroWiki content is moving to OnePetro! Please note that all projects need to be complete by November 1, 2024, to ensure a smooth transition. Online editing will be turned off on this date.


Help:Formatting

PetroWiki
Jump to navigation Jump to search

You can format your text by using wiki markup. This consists of normal characters like asterisks, single quotes or equal signs which have a special function in the wiki, sometimes depending on their position. For example, to format a word in italic, you include it in two pairs of single quotes like ''this''.

The Edit toolbar can greatly simplify formatting your text without knowing wiki markup. But it is easy to pick up the basics, and they will be helpful when you are editing text someone else has already formatted.

Text formatting markup

Description You type You get
character (inline) formatting – applies anywhere
Italic text 
''italic''

italic

Bold text 
'''bold'''

bold

Bold and italic 
'''''bold & italic'''''

bold & italic

Strike text 
<strike> strike text </strike>
strike text
Escape wiki markup 
<nowiki>no ''markup''</nowiki>

no ''markup''

Escape wiki markup once 
[[API]]<nowiki/>extension

APIextension

section formatting – only at the beginning of the line
Headings of different levels 

== Level 2 ==

=== Level 3 ===

==== Level 4 ====

===== Level 5 =====

====== Level 6 ======
  • Skip Level 1, it is page name level. So the first level of heading is Level 2 (two equals signs on each side of heading text)
  • An article with 4 or more headings automatically creates a table of contents

Level 2

Level 3

Level 4

Level 5
Level 6
Horizontal rule 
Text above
----
Text below

Text above

Text below

Bullet list 
* Start each line
* with an [[Wikipedia:asterisk|asterisk]] (*).
** More asterisks gives deeper
*** and deeper levels.
* Line breaks<br/>don't break levels.
*** But jumping levels creates empty space.
Any other start ends the list.
  • Start each line
  • with an asterisk (*).
    • More asterisks gives deeper
      • and deeper levels.
  • Line breaks
    don't break levels.
      • But jumping levels creates empty space.

Any other start ends the list.

Numbered list 
# Start each line
# with a [[Wikipedia:Number_sign|number sign]] (#).
## More number signs gives deeper
### and deeper
### levels.
# Line breaks<br/>don't break levels.
### But jumping levels creates empty space.
# Blank lines

# end the list and start another.
Any other start also
ends the list.
  1. Start each line
  2. with a number sign (#).
    1. More number signs gives deeper
      1. and deeper
      2. levels.
  3. Line breaks
    don't break levels.
      1. But jumping levels creates empty space.
  4. Blank lines
  1. end the list and start another.

Any other start also ends the list.

Definition list 
;item 1
: definition 1
;item 2
: definition 2-1
: definition 2-2
item 1
definition 1
item 2
definition 2-1
definition 2-2
Indent text 
: Single indent
:: Double indent
::::: Multiple indent
  • This workaround may be controversial from the viewpoint of accessibility.
Single indent
Double indent
Multiple indent
Mixture of different types of list 
# one
# two
#* two point one
#* two point two
# three
#; three item one
#: three def one
# four
#: four def one
#: this looks like a continuation
#: and is often used
#: instead<br/>of <nowiki><br/></nowiki>
# five
## five sub 1
### five sub 1 sub 1
## five sub 2
  • The usage of #: and *: for breaking a line within an item may also be controversial.
  1. one
  2. two
    • two point one
    • two point two
  3. three
    three item one
    three def one
  4. four
    four def one
    this looks like a continuation
    and is often used
    instead
    of <br/>
  5. five
    1. five sub 1
      1. five sub 1 sub 1
    2. five sub 2
Preformatted text 
 Start each line with a space.
 Text is '''preformatted''' and
 ''markups'' '''''can''''' be done.
  • This way of preformatting only applies to section formatting. Character formatting markups are still effective.
 
Start each line with a space.
Text is preformatted and
markups can be done.
Preformatted text blocks 
 <nowiki>Start with a space in the first column,
(before the <nowiki>).

Then your block format will be
    maintained.
 
This is good for copying in code blocks:

def function():
    """documentation string"""

    if True:
        print True
    else:
        print False</nowiki>

Start with a space in the first column,
(before the <nowiki>).

Then your block format will be
    maintained.

This is good for copying in code blocks:

def function():
    """documentation string"""

    if True:
        print True
    else:
        print False

Paragraphs

PetroWiki ignores single line breaks. To start a new paragraph, leave an empty line. You can force a line break within a paragraph with the HTML tag <br/>.

HTML tags

Some HTML tags are allowed in PetroWiki, for example <code>, <div>,<span> and <font>. These apply anywhere you insert them.

Description You type You get
Inserted
(Displays as underline in most browsers.) 
<ins>Inserted</ins>

or

<span style="text-decoration: underline;">Underline</span>

Inserted

or

Underline

Deleted
(Displays as strikethrough in most browsers.) 
<del>Deleted</del>

or

<span style="text-decoration:line-through;">Deleted</span>

Deleted

or

Deleted

Fixed width text 
<code>Source code</code>

or

<tt>Fixed width text</tt>

Source code

or

Fixed width text

Blockquotes 
text above
text above
<blockquote>blockquote</blockquote>
text below
text below

text above text above

blockquote

text below text below

Comment 
<!-- This is a comment -->
Comments are only visible
in the edit window.

Comments are only visible in the edit window.

Completely preformatted text 
<pre> Text is '''preformatted''' and
''markups'' '''''cannot''''' be done</pre>
  • For marking up of preformatted text, check the "Preformatted text" entry at the bottom of the previous table.
 
 Text is '''preformatted''' and
''markups'' '''''cannot''''' be done
Customized preformatted text 
<pre style="color:red">
Text is '''preformatted'''
with a style and
''markups'' '''''cannot''''' be done
</pre>
  • A CSS style can be named within the style property.
 
Text is '''preformatted'''
with a style and
''markups'' '''''cannot''''' be done
Customized preformatted text with text wrap according to screen width 
<pre style="white-space: pre-wrap; 
white-space: -moz-pre-wrap;
white-space: -pre-wrap;
white-space: -o-pre-wrap; 
word-wrap: break-word">
This longer sentence is used to demonstrate text wrapping.
</pre>

This longer sentence is used to demonstrate text wrapping.
Preformatted text with text wrap according to screen width 
<code>
This longer sentence is used to demonstrate text wrapping.
</code>

This longer sentence is used to demonstrate text wrapping.

Inserting symbols

Symbols and other special characters not available on your keyboard can be inserted one of two ways:

  • By selecting the desired character from the Special characters dropdown in the Edit toolbar
  • Through a special sequence of characters called HTML entities. For example, the following sequence (entity) &rarr; when inserted will be shown as right arrow HTML symbol → and &mdash; when inserted will be shown as an em dash HTML symbol —
  • Hover any character to find out the symbol that produces it. Some symbols not available in the current font will appear as empty squares.


HTML symbol entities
á Â â ´ Æ æ À à ℵ Α α & ∧ ∠ Å å ≈ Ã ã Ä ä „ Β β ¦ • ∩ Ç ç ¸ ¢
Χ χ ˆ ♣ ≅ © ↵ ∪ ¤ † ‡ ↓ ⇓ ° Δ δ ♦ ÷ É é Ê ê È è ∅     Ε ε ≡ Η η
Ð ð Ë ë € ∃ ƒ ∀ ½ ¼ ¾ ⁄ Γ γ ≥ > ↔ ⇔ ♥ … Í í Î î ¡ Ì ì ℑ ∞ ∫ Ι ι
¿ ∈ Ï ï Κ κ Λ λ ⟨ « ← ⇐ ⌈ “ ≤ ⌊ ∗ ◊ ‎ ‹ ‘ < ¯ — µ · − Μ μ ∇   –
≠ ∋ ¬ ∉ ⊄ Ñ ñ Ν ν Ó ó Ô ô Œ œ Ò ò ‾ Ω ω Ο ο ⊕ ∨ ª º Ø ø Õ õ ⊗ Ö
ö ∂ ‰ ⊥ Φ φ Π π ϖ ± £ ′ ″ ∏ ∝ Ψ ψ " √ ⟩ » → ⇒ ⌉ ” ℜ ® ⌋ Ρ ρ ‏
› ’ ‚ Š š ⋅ § ­ Σ σ ς ∼ ♠ ⊂ ⊆ ∑ ⊃ ¹ ² ³ ⊇ ß Τ τ ∴ Θ θ ϑ   Þ þ ˜
× ™ Ú ú ↑ ⇑ Û û Ù ù ¨ ϒ Υ υ Ü ü ℘ Ξ ξ Ý ý ¥ ÿ Ÿ Ζ ζ ‍ ‌
Description You type You get
Copyright symbol 
&copy;
©
Greek delta letter symbol 
&delta;
δ
Euro currency symbol 
&euro;
€

See the list of all HTML entities on the Wikipedia article List of HTML entities.

Other formatting

Beyond the text formatting markup shown above, here are some other formatting references:

You can find more references at Help:Contents.

Retrieved from "https://petrowiki.spe.org/w/index.php?title=Help:Formatting&oldid=42660"