A Book's Content

There are three different ways to enter the content for a book: using our Wiki-style markup, HTML, or plain text. The Wiki-style markup is what we use internally (including in the Note Annotations), and is typically easier for people to use for editing than HTML.

Wiki-style markup

In the left column of the table below, you can see what effects are possible. In the right column, you can see how those effects were achieved. In other words, to make text look like it looks in the left column, type it in the format you see in the right column.

What it looks like What you type

Headings look like this:

Book Title

by Author Name

Section Name

Subsection

Sub-subsection

Notes
  • Only use first-level headings (=) for the title of the book.
  • Always use second-level headings (==) for the start of each section.

Headings look like this:

= Book Title =

=== by Author Name ===

== Section Name ==

=== Subsection ===

==== Sub-subsection ====

A single newline generally has no effect on the layout.  Some folks like to put each sentence on a separate line.

But an empty line starts a new paragraph.

Notes
  • When used in a list, a newline does affect the layout (see below).

A single newline
generally has no effect on the layout.<>
Some folks like to start each new sentence
on a separate line.

But an empty line
starts a new paragraph.

You can break lines
without starting a new paragraph.

Notes
  • Please use this sparingly.
  • Close markup between lines, do not start a link or italics or bold on one line and close it on the next.

You can break lines<br/>
without starting a new paragraph.

Mark the end of each sentence so that we know where to insert extra whitespace between sentences.  It also allows the search routine to display matching sentences instead of just matching paragraphs.

Notes
  • You don't need to mark the end of the last sentence in a paragraph, but you can.

Mark the end of each sentence so that
we know where to insert extra whitespace between
sentences.<> It also allows the search
routine to display matching sentences instead
of just matching paragraphs.
  • It's easy to create a list:
    • Start every line with a star (asterisk).
      • More stars means deeper levels.
        • A newline in a list

marks the end of a list item.

  • An empty line starts a new list.
* It's easy to create a list:
** Start every line with a star.
*** More stars means deeper levels.
**** A newline in a list
marks the end of a list item.

* An empty line starts a new list.
  1. Numbered lists are also good
    1. very organized
    2. easy to follow
      1. easier still
# Numbered lists are also good<>
## very organized<>
## easy to follow<>
### easier still<>
  • You can even create mixed lists
    1. and nest them
      • like this
* You can even create mixed lists<>
*# and nest them<>
*#* like this<>
Definition list
list of definitions
item
the item's definition
another item
the other item's definition

Notes
  • One item per line; a newline can appear before the colon, but using a space before the colon improves parsing.

; Definition list : list of definitions
; item 2 : the second item's definition
; last item
: the last item's definition
A colon indents a line or paragraph.
Multiple colons indents more deeply.
A second line at the same level.

A manual newline starts a new paragraph.

Notes
  • This is primarily for displayed material.

: A colon indents a line or paragraph.
::: Multiple colons indents more deeply.
::: A second line at the same level.
A manual newline starts a new paragraph.

When there is a need for separating a block of text

the blockquote command will indent both margins when needed instead of the left margin only as the colon does.

Notes
  • This is useful for (as the name says) inserting blocks of quoted (and cited) text.

When there is a need for separating
a block of text

<blockquote>
The '''blockquote''' command will indent 
both margins when needed instead of the 
left margin only as the colon does.  
</blockquote>
Centered text.

Notes
  • Please note the American spelling of "center."

<center>Centered text.</center>

A horizontal dividing line: this is above it


and this is below it.

A horizontal dividing line:
this is above it
----
and this is below it.

Character formatting

What it looks like What you type

Emphasize, strongly, very strongly.

Notes
  • These are double, triple, and quintuple apostrophes (single-quote marks), not double-quote marks.

''Emphasize'', '''strongly''', '''''very strongly'''''.

A typewriter font for monospace text or for computer code: int main()

Notes
  • For semantic reasons, using <code> where applicable is preferable to using <tt>.

A typewriter font for <tt>monospace text</tt>
or for computer code: <code>int main()</code>

You can use small text for captions.

You can use <small>small text</small> for captions.

You can strike out deleted material and underline new material.

You can also mark deleted material and inserted material using logical markup rather than visual markup.

You can <s>strike out deleted material</s>
and <u>underline new material</u>.

You can also mark <del>deleted material</del> and
<ins>inserted material</ins> using logical markup
rather than visual markup.

Diacritical marks:
À Á Â Ã Ä Å
Æ Ç È É Ê Ë
Ì Í Î Ï Ñ Ò
Ó Ô Õ Ö Ø Ù
Ú Û Ü ß à á
â ã ä å æ ç
è é ê ë ì í
î ï ñ ò ó ô
œ õ ö ø ù ú
û ü ÿ

Notes
  • See special characters.


&Agrave; &Aacute; &Acirc; &Atilde; &Auml; &Aring; 
&AElig; &Ccedil; &Egrave; &Eacute; &Ecirc; &Euml; 
&Igrave; &Iacute; &Icirc; &Iuml; &Ntilde; &Ograve; 
&Oacute; &Ocirc; &Otilde; &Ouml; &Oslash; &Ugrave; 
&Uacute; &Ucirc; &Uuml; &szlig; &agrave; &aacute; 
&acirc; &atilde; &auml; &aring; &aelig; &ccedil; 
&egrave; &eacute; &ecirc; &euml; &igrave; &iacute;
&icirc; &iuml; &ntilde; &ograve; &oacute; &ocirc; 
&oelig; &otilde; &ouml; &oslash; &ugrave; &uacute; 
&ucirc; &uuml; &yuml;

Punctuation:
¿ ¡ § ¶
† ‡ • – —
‹ › « »
‘ ’ “ ”


&iquest; &iexcl; &sect; &para;
&dagger; &Dagger; &bull; &ndash; &mdash;
&lsaquo; &rsaquo; &laquo; &raquo;
&lsquo; &rsquo; &ldquo; &rdquo;

Commercial symbols:
™ © ® ¢ € ¥
£ ¤


&trade; &copy; &reg; &cent; &euro; &yen; 
&pound; &curren;

Subscripts:
x1 x2 x3 or
x₀ x₁ x₂ x₃ x₄
x₅ x₆ x₇ x₈ x₉

Superscripts:
x1 x2 x3 or
x⁰ x¹ x² x³ x⁴
x⁵ x⁶ x⁷ x⁸ x⁹

ε0 = 8.85 × 10−12 C² / J m.

1 hectare = 1 E4 m²

Notes
  • The latter methods of sub/superscripting cannot be used in the most general context, as they rely on Unicode support which may not be present on all users' machines. For the 1-2-3 superscripts, it is nevertheless preferred when possible (as with units of measurement) because most browsers have an easier time formatting lines with it.


x<sub>1</sub> x<sub>2</sub> x<sub>3</sub> or<br/>
x&#8320; x&#8321; x&#8322; x&#8323; x&#8324;<br/>
x&#8325; x&#8326; x&#8327; x&#8328; x&#8329;
x<sup>1</sup> x<sup>2</sup> x<sup>3</sup> or<br/>
x&#8304; x&sup1; x&sup2; x&sup3; x&#8308;<br/>
x&#8309; x&#8310; x&#8311; x&#8312; x&#8313;

&epsilon;<sub>0</sub> =
8.85 &times; 10<sup>&minus;12</sup>
C&sup2; / J m.

1 hectare = 1 E4 m&sup2;

Greek characters:
α β γ δ ε ζ
η θ ι κ λ μ ν
ξ ο π ρ σ ς
τ υ φ χ ψ ω
Γ Δ Θ Λ Ξ Π
Σ Φ Ψ Ω


&alpha; &beta; &gamma; &delta; &epsilon; &zeta; 
&eta; &theta; &iota; &kappa; &lambda; &mu; &nu; 
&xi; &omicron; &pi; &rho; &sigma; &sigmaf;
&tau; &upsilon; &phi; &chi; &psi; &omega;
&Gamma; &Delta; &Theta; &Lambda; &Xi; &Pi; 
&Sigma; &Phi; &Psi; &Omega;

Mathematical characters:
∫ ∑ ∏ √ − ± ∞
≈ ∝ ≡ ≠ ≤ ≥
× · ÷ ∂ ′ ″
∇ ‰ ° ∴ ℵ ø
∈ ∉ ∩ ∪ ⊂ ⊃ ⊆ ⊇
¬ ∧ ∨ ∃ ∀ ⇒ ⇔
→ ↔


&int; &sum; &prod; &radic; &minus; &plusmn; &infin;
&asymp; &prop; &equiv; &ne; &le; &ge;
&times; &middot; &divide; &part; &prime; &Prime;
&nabla; &permil; &deg; &there4; &alefsym; &oslash;
&isin; &notin; &cap; &cup; &sub; &sup; &sube; &supe;
&not; &and; &or; &exist; &forall; &rArr; &hArr;
&rarr; &harr;

Spacing in simple math formulas:
Obviously, x² ≥ 0 is true.

Notes
  • To space things out without allowing line breaks to interrupt the formula, use non-breaking spaces: &nbsp;.


Obviously, ''x''&sup2;&nbsp;&ge;&nbsp;0 is true.

Links and URLs

What it looks like What you type

Link to an external website.  You can abbreviate that if the URL and the link text are the same: slashdot.org.

Link to section two of the current book or section zero of book one.

Linking to a named target appends a hash+name idiom (taken from HTML) to the above forms.  For example, this link goes to an "overview" target.

Notes
  • If the URL consists of a number (without or without a trailing "#targetname"), it refers to a section number in the current book (section numbers start with 0).
  • The normal "#targetname" suffix must refer to a named target that exists in the destination section. You can create a target by adding an id=targetname attribute to any HTML tag or an wiki image reference.
  • If the link text is different from the URL, it must follow after a single space.
  • The entire double-bracketed string must be on a single line.

Link to [[http://slashdot.org/ an external website]].<>
You can abbreviate that if the URL and the link text
are the same:  [[slashdot.org]].

Link to [[2 section two of the current book]] or
[[1,0 section zero of book one]].

Linking to a named target appends a hash+name idiom
(taken from HTML) to the above forms.<> For example,
[[2,2#overview this link]] goes to an "overview" target.

Images

You can reference images you've uploaded by name, or supply a full URL of an image from another site.
What it looks like What you type
A picture:

A picture: 
[[Image:button.png]]

The same picture, but with an id specified and its width & height supplied:
[[Image:button.png id=targetname width=23 height=22]]


Tables

Start a table {| params
Specify a caption |+ caption
Start a new row |- params
Add header columns ! header 1
! params | header 2
! header 3 !! params | header 4 !! header 5
Add data columns | data 1
| params | data 2
| data 3 || data 4 || params | data 5
End a table |}

Some sample tables:
What it looks like What you type
1 2
3 4
five
{| border=1
| 1 || 2
|-
| 3 || 4
|-
| colspan=2 | five
|}
AbbreviationTimezone (USA)
EST Eastern Standard Time
CST Central Standard Time
MST Mountain Standard Time
PST Pacific Standard Time
{| border=1
! Timezone (USA) !! Abbreviation
|-
| align=center | EST
| Eastern Standard Time
|-
| align=center | CST
| Central Standard Time
|-
| align=center | MST
| Mountain Standard Time
|-
| align=center | PST
| Pacific Standard Time
|}