%audience% authors (basic)
The pages on this site are [[WikiWikiWeb]] 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(s)]]-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 fairly simple:
# Put a blank line between paragraphs
# To make a list, start each line with # for numbered (ordered) lists or * for bulleted (unordered) lists.
# To make a heading, start a line with two or more ! marks; !! is a subheading, and !!! is a sub-subheading.
# To emphasize text, enclose it in 2 or 3 ''single quotes''; [@''text''@] for italics or [@'''text'''@] for bold.
# To make a link to another page, enclose the page's name in double brackets; for example [@[[basic editing]]@] links to this page. Links to [[nonexistent pages]] are displayed specially, to invite others to create the page.
# To make a link to another site, type its address, such as http://www.example.com/ .
'''If you want to experiment with editing a page, try it on the [[Main/WikiSandbox]].''' You can [[Main/WikiSandbox?action=edit | edit the WikiSandbox]] 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.
!! Examples
The table below demonstrates many of the common markups used to format pages. The left column shows the effect of the markup, the right 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]]
!!! General Usage
(:table width='100%' border='1' cellspacing='0' cellpadding='2':)
(:cellnr width='40%':)
%center% '''What it looks like'''
(:cell:)
%center% '''What to type'''
(:cellnr:)
A single newline
usually doesn't affect the layout.
(:cell:) [@
A single newline
usually doesn't affect the layout.
@]
(:cellnr:)
An author must
place an empty line in the markup to
start a new paragraph. For a break\\
in the paragraph, use two backslashes.
(:cell:) [@
An author must
place an empty line in the markup to
start a new paragraph. For a break\\
in the paragraph, use two backslashes.
@]
(:cellnr:)
* Lists are created by using asterisks
** More asterisks result in deeper lists
*** The list is terminated
by the first line that is not a list
# Numbered lists
# are also possible
** and lists can nest
(:cell:) [@
* Lists are created by using asterisks
** More asterisks result in deeper lists
*** The list is terminated
by the first line that is not a list
# Numbered lists
# are also possible
** and lists can nest@]
(:cellnr:)
* A backslash at the \
end of a line joins the \
next line to the previous one.
* Two backslashes create \\
a line break.
* Three backslashes generate\\\
two line breaks.
(:cell:) [@
* A backslash at the \
end of a line joins the \
next line to the previous one.
* Two backslashes create \\
a line break.
* Three backslashes generate\\\
two line breaks.
@]
(:cellnr:)
->An arrow (->) indents a paragraph
-->Longer arrows indent more
--<A reverse arrow creates a \
hanging indent, the first line \
is outdented and remaining lines \
are indented.
(:cell:) [@
->An arrow (->) indents a paragraph
-->Longer arrows indent more
--<A reverse arrow creates a \
hanging indent, the first line \
is outdented and remaining lines \
are indented.
@]
(:cellnr:)
: Definition list : list of definitions
: item : the item's definition
: another item : another item's definition
(:cell:) [@
: Definition list : list of definitions
: item : the item's definition
: another item : another item's definition
@]
(:cellnr:)
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.
(:cell:) [@
Lines that begin with
a space are formatted exactly
as typed, in a fixed-width font.@]
(:cellnr:)
%center% This text is centered.
%right% This text is right justified.
(:cell:) [@
%center% This text is centered.
%right% This text is right justified.@]
(:cellnr:)
Four or more dashes
at the beginning of a line
----
produce a horizontal line.
(:cell:) [@
Four or more dashes
at the beginning of a line
----
produce a horizontal line.
@]
(:tableend:)
!!! [[#links]] [[Links]]
(:table width='100%' border='1' cellspacing='0' cellpadding='2':)
(:cellnr width='40%':)
%center% '''What it looks like'''
(:cell:)
%center% '''What to type'''
(:cellnr:)
Practice editing
in the [[wiki sandbox]].
* Text in double brackets become links to other pages.
* Words are automatically capitalized in page titles.
(:cell:) [@
Practice editing
in the [[wiki sandbox]].
@]
(:cellnr:)
Practice editing in the
[[WikiSandbox | practice area]].
* Text after a pipe (|) is used as the link text
(:cell:) [@
Practice editing in the
[[WikiSandbox | practice area]].
@]
(:cellnr:)
Practice editing in the
[[wiki sandbox]]es.
Practice editing in the
[[(wiki) sandbox]].
* Endings become part of the link text.
* Parentheses hide parts of the link name.
(:cell:) [@
Practice editing in the
[[wiki sandbox]]es.
Practice editing in the
[[(wiki) sandbox]].
@]
(:cellnr:)
What's an [[(Wikipedia:)aardvark]], anyway?
* Pmwiki can use [[InterMap| InterMap prefixes]] that have specific meanings.
* Parentheses can hide those too.
(:cell:) [@
%newwin%What's an
[[(Wikipedia:)aardvark]], anyway?
@]
(:cellnr:)
Links to external sources can be entered
# bare url: http://www.google.com
# link text: [[http://www.google.com | Google]]
# as reference: [[http://www.google.com |#]]
(:cell:) [@
Links to external sources can be entered
# bare url: http://www.google.com
# link text: [[http://www.google.com | Google]]
# as reference: [[http://www.google.com |#]]
@]
(:cellnr:)
Links can open in another window,
as in %newwin% http://www.pmwiki.org.
(:cell:) [@
Links can open in another window,
as in %newwin% http://www.pmwiki.org.
@]
(:tableend:)
!!! Character formatting
(:table width='100%' border='1' cellspacing='0' cellpadding='2':)
(:cellnr width='40%':)
''Emphasize'', '''strongly''',
'''''very strongly'''''.
* These are all apostrophes (single-quote marks), not double-quotes.
(:cell:) [@
''Emphasize'', '''strongly''',
'''''very strongly'''''. @]
(:cellnr:)
@@Monospaced text@@
[@This is a
preformatted
text block@]
(:cell:) [@
@@Monospaced text@@ @]
[=
[@This is a
preformatted
text block@]=]
(:cellnr:)
* Text with '^superscripts^'
* Text with '_subscripts_'
* deleted {-strikethrough-} text
* inserted {+underline+} text
* [+big+], [++bigger++], [-small-], [--smaller--] text
(:cell:) [@
* Text with '^superscripts^'
* Text with '_subscripts_'
* deleted {-strikethrough-} text
* inserted {+underline+} text
* [+big+], [++bigger++], [-small-], [--smaller--] text
@]
(:cellnr:)
[[WikiStyles]] allow %red% text
%blue% to %green% be
%color=#ff7f00% different %%colors.
* Use lowercase letters for RGB colors (#ff7f00, not [=#FF7F00=]).
(:cell:) [@
[[WikiStyles]] allow %red% text
%blue% to %green% be
%color=#ff7f00% different %%colors.
@]
(:tableend:)
!! Headings and blocks
(:table width='100%' border='1' cellspacing='0' cellpadding='2':)
(:cellnr width='40%':)
!! Major subheading
!!! Minor subheading
(:cell:) [@
!! Major subheading
!!! Minor subheading
@]
(:cellnr:)
-<'''Page titles'''
''Not shown''
(:title Basic Editing:)
* The [@(:title:)@] directive sets the page's title to something other than its name.
(:cell:) [@
(:title Basic Editing:)
@]
(:cellnr:)
-<'''Block styles'''
%block purple%All of the text in this block
is purple.
* %item purple%Purple cow
* %item purple%Purple people eater
* %item red% Now this list is red
* And this is normal
(:cell:) [@
>>purple<<
All of the text in this block
is purple.
* Purple cow
* Purple people eater
>>red<<
* Now this list is red
>><<
* And this is normal@]
(:tableend:)
%trail%<<|[[DocumentationIndex]]|>>