AutoTOC


This page is for testing Cookbook:AutoTOC. Currently the TOC block appears in the sidebar.

Examples of common markups

The tables below demonstrate many of the common markups used to format pages. The left column shows what to write to achieve the effect, the right column shows the effect of the markup. More details are available from the text formatting rules? and other documentation pages. An exhaustive list of default markup is available as the markup master index?.

Voilà un titre, en français!?

What to type

What it looks like

Consecutive lines
will be merged together
as part of the same paragraph.

One or more empty lines will start a new paragraph.

Consecutive lines will be merged together as part of the same paragraph.

One or more empty lines will start a new paragraph.

Two backslashes at the end of a line \\
force a line break.

Or use this markup: [[<<]] to force a break.

Two backslashes at the end of a line
force a line break.

Or use this markup:
to force a break.

Further reading:

  • text formatting rules? for more information on linebreaks, indented or hanging paragraphs.
  • wiki styles for centered or right justified paragraphs and "floating" text (boxes), borders and much more.

Текст на кирилица

Start each line with # for numbered (ordered) lists or * for bulleted (unordered) lists:

* Bullet list
* Another item
** More asterisks produce sub-items
** etc.
  • Bullet list
  • Another item
    • More asterisks produce sub-items
    • etc.
# Numbered lists
# Another item
## more hashes produce sub-items
  1. Numbered lists
  2. Another item
    1. more hashes produce sub-items
# List types
# can be mixed
** numbered list with unordered sub-list
  1. List types
  2. can be mixed
    • numbered list with unordered sub-list

Learn more about lists? (including definition lists?) and list styles.

Headings

Headings are useful for creating a "well-structured" page. They're not just for making big text.

What to type

What it looks like

!! Major Subheading
!!! Minor Subheading
!!!! And More
!!!!! Subheadings

Major Subheading

Minor Subheading

And More

Subheadings

Text Emphasis

To emphasize, enclose text in apostrophes (single-quote marks), not double-quotes.

What to type

What it looks like

''Emphasize'' (italics),
'''strong''' (bold), 
'''''very strong''''' (bold italics).

Emphasize (italics), strong (bold), very strong (bold italics).

Links

To make a link to another page, enclose the page's name in double square brackets.

What to type

What it looks like

Practice editing in the [[wiki sandbox]]

Practice editing in the wiki sandbox

Note that words are automatically capitalized in page titles. The link above links to the page WikiSandbox.

Text after a pipe (|) is used as the link text:

Practice editing in the
[[WikiSandbox | practice area]].

Practice editing in the practice area.

Endings become part of the link text, parentheses hide parts of the link name:

[[wiki sandbox]]es.

[[(wiki) sandbox]].

wiki sandboxes.

sandbox.

When linking to a page in a different WikiGroup?, provide the group name, followed by a separator, and then the page name:

[[Main.Wiki Sandbox]] shows group + name

[[Main/Wiki Sandbox]] shows only name

Main.Wiki Sandbox shows group + name

Wiki Sandbox shows only name

Links to external sites

bare url:  http://www.pmwiki.org

link text: [[http://www.pmwiki.org | PmWiki home]]

bare url: http://www.pmwiki.org

link text: PmWiki home

Links as reference to external sites

bare url: http://www.pmwiki.org

link text: [[http://www.pmwiki.org | #]]

bare url: http://www.pmwiki.org

link text: [1]

Colons make InterMap (also called InterWiki?) links to other wikis:

What's an [[Wikipedia:aardvark]], anyway?

What's an Wikipedia:aardvark, anyway?

Links to nonexistent pages? are displayed specially, to invite others to create the page.

PmWiki supports more link types and a lot of display options, see Links? to learn more.

Preformatted text

Preformatted text is displayed using a monospace font and not generating linebreaks except where explicitly indicated in the markup.

Note that very long lines of preformatted text can cause the whole page to be wide.

For preformatted text with markup (e.g. emphasis) being processed, start each line with a space:

 Lines that begin with a space
 are formatted exactly as typed
 in a '''fixed-width''' font.
 Lines that begin with a space
 are formatted exactly as typed
 in a fixed-width font.

If you don't want Wiki markup to be processed, use [@ @]. Can also be used inline.

[@
Text escaped this way has
the HTML ''code'' style
@]
Text escaped this way has
the HTML ''code'' style

Escape sequence

If you don't want Wiki markup to be processed, but lines reformatted use [= =]. Can also be used inline.

[=
markup is ''not'' processed
but lines are reformatted
=]

markup is ''not'' processed but lines are reformatted

Horizontal line

Four or more dashes at
the beginning of a line
----
produce a "horizontal rule"

Four or more dashes at the beginning of a line


produce a "horizontal rule"

Tables

Simple tables use double pipe characters to separate cells:

|| border=1
||! head 1 ||! head 2 ||! head 3 ||
|| cell 1  ||  cell 2 ||  cell 3 ||
head 1head 2head 3
cell 1cell 2cell 3

See simple tables? and advanced tables to learn more about the rich feature set of PmWiki tables.

Images

See Images

Character formatting

What to type

What it looks like

* @@Monospaced text@@
* Text with '^superscripts^'
* Text with '_subscripts_'
* deleted {-strikethrough-} text
* inserted {+underline+} text
* [+big+], [++bigger++] text
* [-small-], [--smaller--] text
  • Monospaced text
  • Text with superscripts
  • Text with subscripts
  • deleted strikethrough text
  • inserted underline text
  • big, bigger text
  • small, smaller text

Use WikiStyles to change the text color .

Page titles

The (:title:) directive sets the page's title to something other than its page name.

The name of this page is "{$Name}", and its title is "{$Title}".

The name of this page is "AutoTOC", and its title is "AutoTOC".

Page Description

  • The (:Description Page summary here:) directive sets the page description. The description is used by search engines, and can be displayed in search results and in page lists?.
(:Description PmWiki's basic edit syntax:)
The summary description of this page is {$Description}.

The summary description of this page is PmWiki's basic edit syntax.

I'm new to PmWiki, where can I find some basic help for getting started?

The Basic Editing page is a good start. From there, you can just follow the navigational links at the top or the bottom of the page (they are called Wiki Trails) to the next pages, or to the Documentation Index? page, which provides an outline style index of essential documentation pages, organized from basic to advanced.

How do I include special characters such as Copyright (©) and Trademark (® or ™) on my wiki pages?

See special characters? on how to insert special characters that don't appear on your keyboard.

How can I preserve line-breaks from the source text?

PmWiki normally treats consecutive lines of text as being a paragraph, and merges and wraps lines together on output. This is consistent with most other wiki packages. An author can use the (:linebreaks:) directive to cause the following lines of markup text in the page to be kept as separate lines in the output. Or a wiki administrator can set in config.php $HTMLPNewline = '<br/>'; to force literal new lines for the whole site.

Can I just enter HTML directly?

By default (and by design), PmWiki does not support the use of HTML elements in the editable markup for wiki pages. There are a number of reasons for this described in the PmWiki Philosophy? and Audiences?. Enabling HTML markup within wiki pages in a collaborative environment may exclude some potential authors from being able to edit pages, and pose a number of display and security issues. However, a site administrator can use the Cookbook:Enable HTML recipe to enable the use of HTML markup directly in pages.

Where can I find more documentation?

See the documentation index? and the markup master index? pages.

 0: 00.00 00.00 config start
 1: 00.00 00.00 config end
 2: 00.03 00.02 MarkupToHTML begin
 3: 00.03 00.03 MarkupToHTML begin
 4: 00.04 00.03 MarkupToHTML end
 5: 00.04 00.03 MarkupToHTML begin
 6: 00.04 00.03 MarkupToHTML end
 7: 00.04 00.03 MarkupToHTML begin
 8: 00.04 00.03 MarkupToHTML end
 9: 00.04 00.03 MarkupToHTML begin
10: 00.04 00.03 MarkupToHTML end
11: 00.04 00.03 MarkupToHTML begin
12: 00.04 00.03 MarkupToHTML end
13: 00.04 00.03 MarkupToHTML begin
14: 00.04 00.04 MarkupToHTML end
15: 00.04 00.04 MarkupToHTML begin
16: 00.04 00.04 MarkupToHTML end
17: 00.04 00.04 MarkupToHTML begin
18: 00.04 00.04 MarkupToHTML end
19: 00.04 00.04 MarkupToHTML begin
20: 00.05 00.04 MarkupToHTML end
21: 00.05 00.04 MarkupToHTML begin
22: 00.05 00.04 MarkupToHTML end
23: 00.05 00.04 MarkupToHTML begin
24: 00.05 00.04 MarkupToHTML end
25: 00.05 00.04 MarkupToHTML begin
26: 00.05 00.04 MarkupToHTML end
27: 00.05 00.04 MarkupToHTML begin
28: 00.05 00.04 ReadApprovedUrls SiteAdmin.ApprovedUrls begin
29: 00.05 00.05 ReadApprovedUrls SiteAdmin.ApprovedUrls end
30: 00.05 00.05 MarkupToHTML end
31: 00.05 00.05 MarkupToHTML begin
32: 00.05 00.05 MarkupToHTML end
33: 00.05 00.05 MarkupToHTML begin
34: 00.05 00.05 MarkupToHTML end
35: 00.05 00.05 MarkupToHTML begin
36: 00.06 00.05 MarkupToHTML end
37: 00.06 00.05 MarkupToHTML begin
38: 00.06 00.05 MarkupToHTML end
39: 00.06 00.05 MarkupToHTML begin
40: 00.06 00.05 MarkupToHTML end
41: 00.06 00.05 MarkupToHTML begin
42: 00.06 00.05 MarkupToHTML end
43: 00.06 00.05 MarkupToHTML begin
44: 00.06 00.05 MarkupToHTML end
45: 00.06 00.05 MarkupToHTML begin
46: 00.06 00.06 MarkupToHTML end
47: 00.06 00.06 MarkupToHTML begin
48: 00.06 00.06 MarkupToHTML end
49: 00.06 00.06 MarkupToHTML begin
50: 00.07 00.06 MarkupToHTML end
51: 00.07 00.06 MarkupToHTML begin
52: 00.07 00.06 MarkupToHTML end
53: 00.13 00.12 MarkupToHTML end
54: 00.13 00.12 MarkupToHTML begin
55: 00.15 00.14 MarkupToHTML end
56: 00.15 00.14 MarkupToHTML begin
57: 00.15 00.14 MarkupToHTML end
58: 00.15 00.14 now
Peak memory: 3,167,368 bytes