authors (basic)
The pages on this site are Wiki Wiki Web? pages, which means that pages can be created and edited by multiple authors. To edit a page, click the Edit link that exists somewhere on the page, usually in the header or footer. Some pages may be password-protected, depending on the system's security policies, but many systems allow open editing of pages.
When editing a page, you see the markup text that describes the content of the page. The basic rules for page markup are simple:
''text''
for italics or '''text'''
for bold.
[[basic editing]]
links to this page. Links to nonexistent pages are displayed specially, to invite others to create the page.
If you want to experiment with editing a page, try it on the Wiki Sandbox. You can edit the Wiki Sandbox without affecting anything important on this site. If you do edit other pages, it's courteous to sign your contribution; using ~~~ effectively 'signs' the name that you provide in the Author field on the Page Edit form.
The table below demonstrates many of the common markups used to format pages. The right column shows the effect of the markup, the left column shows what to write to achieve the effect. 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?
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. |
* Lists are created by using asterisks. ** More asterisks produce deeper lists. *** A list is terminated by the first line that is not a list. * Continue a list item by lining up the text with leading whitespace. * You can use a double-backslash \\ to force a newline in your list item. |
by the first line that is not a list.
|
# Numbered lists # are also possible ## more hashes produced deeper lists *** and lists can nest -> use [[list styles]] to maintain numbering ## Text between list items can cause numbering to restart ## %item value=3% this can be dealt with |
use list styles? to maintain numbering
|
-> An arrow (->) indents content. Line up text to continue the indent. -->Longer arrows (-->) indent further. -<A reverse arrow (-<) creates a hanging indent, the first line is outdented and remaining lines are indented. --<Longer reverse arrows (--<) indent further. |
: Definition list : list of definitions : item : the item's definition : another item : that item's definition :: indentation : more leading colons produce deeper lists |
|
Lines that begin with a space are formatted exactly as typed, in a fixed-width font. Note that very long lines of preformatted text can cause the whole page to be wide. | Lines that begin with a space are formatted exactly as typed, in a fixed-width font. Note that very long lines of preformatted text can cause the whole page to be wide. |
%rfloat% This text floats to the right %rframe% This text floats to the right with a frame %center% This text is centered. %right% This text is right justified. | This text floats to the right This text floats to the right with a frame This text is centered. This text is right justified. |
Four or more dashes at the beginning of a line ---- produce a horizontal line. | Four or more dashes at the beginning of a line produce a horizontal line. |
What to type |
What it looks like |
* Text in double brackets become links to other pages. * Words are automatically capitalized in page titles. Practice editing in the [[wiki sandbox]]. |
Practice editing in the wiki sandbox?. |
Practice editing in the [[Main/WikiSandbox]]. Which one? Oh, in the [[Main.WikiSandbox]]. | Practice editing in the WikiSandbox. Which one? Oh, in the Main.WikiSandbox. |
Practice editing in the [[WikiSandbox | practice area]]. Practice editing in the [[Main.WikiSandbox | practice area]]. Practice editing in the [[practice area -> Wiki sandbox]]. Advanced tables are described in [[table directives]]. | Practice editing in the practice area?. Practice editing in the practice area. Practice editing in the practice area?. Advanced tables are described in table directives?. |
Practice editing in the [[wiki sandbox]]es. Practice editing in the [[(wiki) sandbox]]. # as reference: [[Tables |#]] # to a page title [[Basic editing|+]] | Practice editing in the wiki sandboxes?. Practice editing in the sandbox?.
|
What's an [[(Wikipedia:)aardvark]], anyway? | What's an aardvark, anyway? |
Links to external sources can be entered # bare url: http://google.com # link text: [[http://google.com | Google]] # as reference: [[http://google.com |#]] | Links to external sources can be entered
|
Links can open in another window, as in %newwin% http://www.pmwiki.org. | Links can open in another window, as in http://www.pmwiki.org. |
Use two backslashes\\ to break a line. Wikistyles and other '''%red%formatting\\ will continue%% on the next''' line Or use a this markup: [[<<]] to force a break. Use extra backslashes\\\\ for extra empty lines. | Use two backslashes Wikistyles and other formatting Or use a this markup: Use extra backslashes |
A single backslash joins the \ next line so the multiple \ lines are like a single line. | A single backslash joins the next line so the multiple lines are like a single line. |
What to type |
What it looks like |
''Emphasize'', '''strongly''', '''''very strongly'''''. | Emphasize, strongly, very strongly. |
@@Monospaced text@@ [@This is a preformatted text block@] |
This is a preformatted text block |
* Text with '^superscripts^' * Text with '_subscripts_' * deleted {-strikethrough-} text * inserted {+underline+} text * [+big+], [++bigger++] text * [-small-], [--smaller--] text |
|
[[WikiStyles]] allow %red% text %blue% to %green% be in %color=#ff7f00% different %%colors. | WikiStyles? allow text to be in different colors. |
What to type |
What it looks like |
!! Major Subheading !! [-Major Subheading With Smaller Text-] !!! Minor Subheading !!!! And More !!!!! Subheadings | Major SubheadingMajor Subheading With Smaller TextMinor SubheadingAnd MoreSubheadings |
(:title:)
directive sets the page's title to something other than its page name.
(:Title Basic PmWiki editing rules:) The title of this page is {$Title}, spaced as {$Titlespaced}. | The title of this page is Základnà pravidla editace a syntaxe, spaced as Základnà pravidla editace a syntaxe. |
>>purple<< All of the text in this block is purple. * Purple cows and purple flowers * Purple people eater >>red<< * Now this list is red >>center<< * and this text is centered >>right green<< * and this text is green and right justified >><< * And this is normal | All of the text in this block is purple.
|
<< Upgrading from PmWiki 1? | Documentation Index | AccessKeys? >>
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 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 on my wiki pages?
Use character codes to insert special characters?, such as Copyright (©) and Trademark (® or ™) symbols, that don't appear on your keyboard.
Why are separate lines of text in the markup combined into a single line on output?
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. However, an author can use the (:linebreaks:)
directive to cause separate lines of markup text to be kept as separate lines in the output.
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 PmWiki:Audiences. Basically, Pm feels that enabling HTML markup within wiki pages in a collaborative environment has the effect of excluding some potential authors from being able to edit pages, as well as posing a number of display and security issues. However, a site administrator can use the Cookbook:EnableHTML recipe to enable the use of HTML markup directly in pages.
Where can I find more documentation?
See the documentation index page.