PmWiki is a wiki-based system for collaborative creation and maintenance of websites.

PmWiki pages look and act like normal web pages, except they have an "Edit" link that makes it easy to modify existing pages and add new pages into the website, using basic editing rules. You do not need to know or use any HTML or CSS. Page editing can be left open to the public or restricted to small groups of authors.

Key PmWiki Features

Custom look-and-feel: A site administrator can quickly change the appearance and functions of a PmWiki site by using different skins and HTML templates. If you can't find an appropriate skin already made, you can easily modify one or create your own.
Access control: PmWiki password protection can be applied to an entire site, to groups of pages, or to individual pages. Password protection controls who can read pages, edit pages, and upload attachments. PmWiki's access control system is completely self-contained, but it can also work in conjunction with existing password databases, such as .htaccess, LDAP servers, and MySQL databases.
Customization and plugin architecture: One principle of the PmWikiPhilosophy is to only include essential features in the core engine, but make it easy for administrators to customize and add new markup. Hundreds of features are already available by using extensions (called "recipes") that are available from the PmWiki Cookbook.

PmWiki is written in PHP and distributed under the General Public License. It is designed to be simple to install, customize, and maintain for a variety of applications. This site is running pmwiki-2.2.11.

PmWiki is a registered trademark of Patrick R. Michaud.

PmWiki's home on the web is at pmwiki.org.

Table of contents

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

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)

See also WikiWord on how to enable WikiWord links.

WikiGroup links

See Links and Categories

[[GroupName/]] or [[Group name/]]
[[GroupName.]]
[[GroupName/PageName]] or [[GroupName/page name]]
[[(GroupName.)page name]]
[[~Author Name]]
[[!Category Name]]

InterMap links

See InterMap

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

Email links

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

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]]

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 | Caption %% (could be %rfloat%, %center%, %rframe%, %lframe% )
%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'''''
@@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 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 label=label order=-time:)
(:searchresults incl -excl group=abc fmt=def:)
(:pagelist incl -excl group=abc fmt=def:)

Other directives

See Page directives

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

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

See also PmWiki Edit forms.

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

PmWiki is a wiki-based system for collaborative creation and maintenance of websites.

PmWiki pages look and act like normal web pages, except they have an "Edit" link that makes it easy to modify existing pages and add new pages into the website, using basic editing rules. You do not need to know or use any HTML or CSS. Page editing can be left open to the public or restricted to small groups of authors.

Key PmWiki Features

Custom look-and-feel: A site administrator can quickly change the appearance and functions of a PmWiki site by using different skins and HTML templates. If you can't find an appropriate skin already made, you can easily modify one or create your own.
Access control: PmWiki password protection can be applied to an entire site, to groups of pages, or to individual pages. Password protection controls who can read pages, edit pages, and upload attachments. PmWiki's access control system is completely self-contained, but it can also work in conjunction with existing password databases, such as .htaccess, LDAP servers, and MySQL databases.
Customization and plugin architecture: One principle of the PmWikiPhilosophy is to only include essential features in the core engine, but make it easy for administrators to customize and add new markup. Hundreds of features are already available by using extensions (called "recipes") that are available from the PmWiki Cookbook.

PmWiki is written in PHP and distributed under the General Public License. It is designed to be simple to install, customize, and maintain for a variety of applications. This site is running pmwiki-2.2.11.

PmWiki is a registered trademark of Patrick R. Michaud.

PmWiki's home on the web is at pmwiki.org.