SpiritualWiki

PmWiki / MarkupMasterIndex

< Text formatting rules | Documentation Index | Uploads >

This page contains the most frequently used wiki markup, briefly. Follow the links in each section to learn more.

Markup concepts introduction

PmWiki markup can be applied to 'blocks' of text, and to text 'lines'.
PmWiki markup is also used to read and save page, group, and wiki metadata through the use of variables.
PmWiki markup can be used to process metadata variables though expressions and pagelists.
PmWiki provides a wiki style markup that can be applied to text, lists, paragraphs, and blocks.

Text markup, also known as wikitext is variable, see below, and in general broadly follows wiki conventions.
Text markup only applies to single lines of text, delimited by a newline.

Block markup is applied to multiple lines of text as paragraph blocks and division blocks.

In PmWiki the most important markup is the directive.
The directive is signified by parenthesis and a colon, viz: (:...:).
The directive provides most of PmWiki's functionality.

Markup expressions {(...)}, variable markup {$...}, and wiki styles %...% also provide PmWiki functionality.

LinkMarkups Links

See Links

ExternalLinks External links

https://example.com

[[https://example.com]]

[[https://example.com"tool tip"]]

[[https://example.com | link text]]

[[link text -> https://example.com]]

Use [=link address=] to escape any special characters, including quotes, spaces, parentheses and pipes.

InternalLinks Page links

[[PageName]]

[[page name]]

[[page (name)]]

[[PageName | link text]]

[[PageName | + ]] (titled link)

[[PageName | # ]] (anonymous numerical reference link)

[[PageName"tool tip"]]

[[link text -> PageName]]

[[#anchor]] (to create an anchor)

!!#anchor Heading (to create a heading with an anchor)

[[#anchor | link text]] (to refer to an anchor)

[[#anchor | # ]] (anonymous numerical reference link)

[[PageName#anchor | link text]] (to refer to an anchor in another page)

See also WikiWord on how to enable WikiWord links.

WikiGroupLinks WikiGroup links

See Links and Categories

[[GroupName/]] or [[Group name/]]

[[GroupName"tool tip"]]

[[GroupName.]]

[[GroupName/PageName]] or [[GroupName/page name]]

[[(GroupName.)page name]]

[[~Author Name]]

[[~Author Name | +]]

[[~Author Name | #]]

[[~Author Name | link text]]

[[~Author Name"tool tip"]]

[[!Category Name]]

IntermapLinks InterMap links

See InterMap

[[Path:/path/local_document.html]]

[[Wikipedia:WikiWikiWeb]]

EmailLinks Email links

mailto:someone@example.com

[[(mailto:)someone@example.com]]

[[mailto:someone@example.com | display text]]

[[display text -> mailto:someone@example.com]]

UploadLinks Upload links

See Uploads and Images

Attach:file.odt

[[(Attach:)file.odt]]

[[Attach:file.odt | alternative text ]]

[[Attach:file with spaces.pdf]]

[[Attach:Groupname./file with spaces.pdf]]

linkschemes Link Schemes

In addition to http:, https:, mailto: PmWiki also supports:

ftp:

news:

gopher:

nap:

file:

tel:

geo:

Images Images

See Images and Uploads

ImagesAsImages Images as Images

https://example.com/image.gif

https://example.com/image.gif"alt text"

Attach:image.gif"My image"

Attach:Groupname./image.gif"image in another group"

Attach:Groupname.Pagename/image.gif"image on another page"

%lfloat% Attach:image.gif | Caption %% (could be %rfloat%, %center%, %rframe%, %lframe%, %frame% )

%width=200px% Attach:image.gif %%

%thumb% Attach:image.gif %%

ImagesAsLinks Images as links

[[Attach:image.gif]]

[[(Attach:)image.gif]]

[[PageName | Attach:image.gif"alt text"]]

[[https://example.com/ | Attach:image.gif"alt text"]]

[[https://example.com/ | https://example.com/image.png"alt text"]] | Caption

%rframe thumb% [[Attach:image.gif | Attach:image.gif"alt text"]] | Caption

StartOfLine Start-of-line markup

See Text formatting rules

Lists Lists

See List styles, Wiki styles and Cookbook:Wiki Styles Plus

* unordered list

** deeper list

# ordered list

# %item value=#% arbitrary start number

# %decimal%, %roman%, %ROMAN%, %alpha%, %ALPHA%

%comment%

:term:definition

Also

Q: start a question paragraph

A: start an answer paragraph

Headings Headings

!! Heading

!!! Deeper heading

!!#anchor Heading with anchor

BlockMarkups Paragraph blocks

-> indented text

-< hanging indent

<space> preformatted text

[@...@] preformatted block

---- (horizontal rule)

blank line is vertical space

\ at end of line joins next line

\\ at end of line produces a line break

\\\ at the end of a line produces a blank line, even within a list item, n backslashes will produce n-1 blank lines

[[<<]] produces a line break that clears floating content

DivisionBlocks Division blocks, Semantic elements

See Block markup, Wiki styles and Page directives

>>wikistyle<<

>><<

(:div class="" style="":)

(:divend:)

>>comment<<

Semantic HTML 5 elements

(:article:)...(:articleend:)

(:section:)...(:sectionend:)

(:header:)...(:headerend:)

(:footer:)...(:footerend:)

(:aside:)...(:asideend:)

(:address:)...(:addressend:)

(:nav:)...(:navend:)

(:details summary="Summary" open=open:)...(:detailsend:)

Text Text markup

See Text formatting rules

InlineMarkups Character format

''emphasized''

'''strong'''

'''''strong emphasis'''''

@@monospaced@@

[-small-], [--smaller--]

[+big+], [++bigger++]

'-small-', '+big+'

'^superscript^', '_subscript_'

{+inserted+} (underscore)

{-deleted-} (strikethrough)

[@escaped code@]

[=escaped text=]

PostingMarkups Posting markup

~~~ (author's signature)

~~~~ (author's signature and date)

(:encrypt phrase:) -- replaced with encrypted form of phrase

Tables Tables

PlainTables Plain rows and columns of text

See Tables

||table attributes

||!table caption!||

||left aligned || centered || right aligned||

||!column heading||

||spanned columns ||||||

TablesAndDivs Structured tables

See Table directives

(:table attr:)

(:headnr attr:)

(:head attr:)

(:cellnr attr:)

(:cell attr:)

(:tableend:)

Directives Directives

PageDirectives Page directives

See Page directives

(:redirect PageName:)

(:spacewikiwords:) (:nospacewikiwords:)

(:linkwikiwords:) (:nolinkwikiwords:)

(:linebreaks:) (:nolinebreaks:)

Display Display

See Page directives Group headers

(:noheader:), (:nofooter:)

(:notitle:)

(:noleft:), (:noright:)

(:nogroupheader:), (:nogroupfooter:)

(:noaction:)

Metadata Metadata

See Page directives, Comment markup, Page variables

(:title text:)

(:keywords word, ...:)

(:description text:)

(:comment text:)

{Group/PageName$:Variable} includes from (:Variable:text:)

for example (:Summary:text:)

IncludeOtherPages Include

See Include other pages, Page text variables

(:include PageName:)

(:include PageName#start#end lines=n paras=n:)

(:include Page1 Page2 Page3:)

{Group/PageName$:Var} includes from (:name:text:)

(:nl:) separate included text by conditional line break

ConditionalMarkup Conditional markup

See Conditional markup

(:if (!) cond param:)...(:ifend:)

(:if (!) cond param:)...(:else:)...(:ifend:)

(:if (!) cond param:)...(:elseif (!) cond param:)...(:ifend:)

PageLists Pagelists

See Page lists

(:searchbox label=label order=-time:)

(:searchresults incl -excl group=abc fmt=def:)

(:pagelist incl -excl group=abc fmt=def:)

OtherDirectives Other directives

See Page directives

(:toc:) see Table of contents

(:attachlist:) see Page Directives#attachlist

(:markup:)...(:markupend:) see Page Directives#markup

(:markup class=horiz:)...(:markupend:)

(:markup class=norender:)...(:markupend:)

(:markup caption='...':)...(:markupend:)

(:messages keys=a,b details=open:) see Page Directives#message.

Forms Forms

See Forms

(:input form method=get action=url enctype=multipart/form-data:)

(:input default name=xyz value="abc":)

(:input text name=first value="Bob" size=20:)

(:input textarea name=xyz [=value=] rows=2 cols=80:)

(:input submit name=post value="Go" accesskey=g:)

(:input reset:)

(:input hidden name=action value=edit:)

(:input radio name=xyz value="abc" checked=1:)

(:input checkbox name=xyz value="abc" checked=1:)

(:input password name=authpw:)

(:input file name=upload:)

(:input image name=xyz src="https:..." alt="Alt Text":)

(:input select name=xyz value="val1" label="Value 1":)

(:input select name=xyz value="val2" label="Value 2":)

(:input end:)

WikiTrails Wiki trails

See Wiki trails

<<|[[TrailPage]]|>>

<|[[TrailPage]]|>

^|[[TrailPage]]|^

PageVariables Page variables

See Page variables, Page text variables, Page lists

{$variable}, {pagename$variable}, {groupname.pagename$variable}

{$:variable}, {pagename$:variable}, {groupname.pagename$:variable}

Set a page text variable

(:name:description:)

:name:description

name:description

See special references

{*$variable}

{*$:variable}

Page list templates special variables

{=$variable}, {<$variable}, {>$variable},

{=$:variable}, {<$:variable}, {>$:variable}

Internationalization Internationalization

See Internationalizations and SkinTemplates

$[phrase]

Expressions Expressions

See Markup expressions

{(function arg)}