From The Central Florida Geeks

PmWiki: Markup Master Index

Table of contents

Everything you wanted to know about wiki markup but were afraid to ask.

Links

See Links

External links

http://example.com
[[http://example.com]]
[[http://example.com | link text]]
[[link text -> http://example.com]]

Page links

[[PageName]]
[[page name]]
[[page (name)]]
[[PageName | link text]]
[[PageName | + ]] (titled link)
[[PageName | # ]] (anonymous numerical reference link)
[[link text -> PageName]]
[[#anchor]] (to create an anchor)
[[#anchor | link text]] (to refer to an anchor)
[[PageName#anchor | link text]] (to refer to an anchor in another page)

Wiki page links

See Wiki word and Wiki group

WikiWord
`NonWikiWord
Group/PageName
Group.PageName
[[GroupName/]]
[[GroupName.]]

Special group links

See Links and Categories

[[~Author Name]]
[[!Category Name]]

Intermap links

See Inter map

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

Upload links

See Uploads

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

Email links

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

Images

See Images and Uploads

Images as Images

http://example.com/image.gif
http://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
%rfloat% Attach:image.gif
%center% Attach:image.gif
%rframe% Attach:image.gif | Caption
%lframe% Attach:image.gif | Caption
%width=200px% Attach:image.gif
%thumb% Attach:image.gif

Images as links

[[Attach:image.gif]]
[[(Attach:)image.gif]]
[[PageName | Attach:image.gif"alt text"]]
[[http://example.com/ | Attach:image.gif"alt text"]]
%rframe thumb% [[Attach:image.gif | Attach:image.gif"alt text"]] | Caption

Start-of-line markup

See Text formatting rules

Lists

See List Styles, Wiki styles and Cookbook:Outline lists

* unordered list
** deeper list
# ordered list
# %item value=#% arbitrary start number
# %decimal%, %roman%, %ROMAN%, %alpha%, %ALPHA%
:term:definition

Also

Q: start a question paragraph
A: start an answer paragraph

Headings

!! Heading
!!! Deeper heading

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
[[<<]] produces a line break that clears floating content

Division blocks

See Wiki styles and Page directives

>>wikistyle<<
(:div attr:)
(:divend:)
>><<

Text markup

See Text formatting rules

Character format

''emphasized''
'''strong'''
'''''strong emphasis'''''
'~italic~' (if enabled in config.php)
'*bold*' (if enabled in config.php)
@@monospaced@@
[-small-], [--smaller--]
[+big+], [++bigger++]
'-small-', '+big+'
'^superscript^', '_subscript_'
{+inserted+} (underscore)
{-deleted-} (strikethrough)
[@escaped code@]
[=escaped text=]

Posting markup

~~~ (author's signature)
~~~~ (author's signature and date)
(:encrypt phrase:) -- replaced with encrypted form of phrase

Tables

Plain rows and columns of text

See Tables

||table attributes
||!table caption!||
||left aligned || centered || right aligned||
||!column heading||
||spanned columns ||||||

Structured tables

See Table directives

(:table attr:)
(:cellnr attr:)
(:cell attr:)
(:tableend:)

Directives

Page directives

See Page directives

(:redirect PageName:)
(:(no)spacewikiwords:)
(:(no)linkwikiwords:)
(:(no)linebreaks:)
(:nl:) insert newline in the *markup* only if one isn't present. The purpose of (:nl:) is to be able to write things like:
(:include Page1:)(:nl:)(:include Page2:)
which guarantees that the first line of Page2 is treated as a separate line from the last line of Page1, but without inadvertently generating a blank line between them.

Display

See Page directives Group headers

(:noheader:), (:nofooter:)
(:notitle:)
(:noleft:), (:noright:)
(:nogroupheader:), (:nogroupfooter:)
(:noaction:)

Metadata

See Page directives, Comment markup, Page text variables

(:title text:)
(:keywords word, ...:)
(:description text:)
(:comment text:)
{Group/PageName$:Var} includes from (:name:text:)

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:)

Conditional markup

See Conditional markup

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

Pagelists

See Page lists

(:searchbox group=Group size=size label=label target=Group.Page fmt=def list=ghi order=jkl:)
(:searchresults incl -excl group=abc fmt=def list=ghi order=jkl:)
(:pagelist incl -excl group=abc fmt=def list=ghi order=jkl:)

Other directives

See Page directives

(:attachlist:)
(:PageDirectives#markup:) [=...=]
(:markup:)...(:markupend:)
(:markup class=horiz:)...(:markupend:)
(:markup caption='...':)...(:markupend:)

Forms

See Forms

(:input form method=get action=url enctype=multipart/form-data:)
(:input end:)
(:input text name=first value="Bob" size=20:)
(: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="http:..." alt="Alt Text":)
(:input select name=xyz value="val1" label="Value 1":)
(:input select name=xyz value="val2" label="Value 2":)
(:input default name=xyz value="abc":)

Edit forms

See Forms#pageeditcontrols

(:messages:)
(:input e_form:)
(:e_guibuttons:)
(:e_preview:)
(:input e_textarea rows=24 cols=60:)
(:input e_author value={$Author} size=40:)
(:input e_changesummary value="Summary" size=60:)
(:input e_savebutton value=$[Save]:)
(:input e_saveeditbutton value=$[Save and edit]:)
(:input e_previewbutton value=$[Preview]:)
(:input e_resetbutton value=$[Reset]:)

Wiki trails

See Wiki trails

<<|TrailPage|>>
<|TrailPage|>
^|TrailPage|^

Page variables

See Page variables, Page text variables, Page lists

{$variable}
{pagename$variable}
(:name:description:) sets a page text variable

Expressions

See Markup expressions

{(function args)}
Retrieved from http://www.cfgeeks.org/pmwiki.php/PmWiki/MarkupMasterIndex
Page last modified on March 28, 2009, at 04:17 PM EST