Penguin
Recent Changes
Note: You are viewing an old revision of this page. View the current version.

Synopsis

TextFormattingRules
Emphasis: '' for italics, __ for bold, ''__ for both, <tt> for fixed width.
Lists: * for bullet lists, # for numbered lists, Term:<newline> definition for definition lists.
Preformatted text: Enclose text in <pre></pre> or <verbatim></verbatim>.
Indented text: Indent the paragraph with whitespaces.
References: JoinCapitalizedWords or use square brackets for a [page link] or URL [http://cool.wiki.int/].
Preventing linking: Prefix with "~": ~DoNotHyperlink, name links like [text | URL].
Misc: "!", "!!", "!!!" make headings, "%%%" or "<br>" makes a linebreak, "----" makes a horizontal rule.
Allowed HTML tags: b big i small tt em strong abbr acronym cite code dfn kbd samp var sup sub

Character formatting

  • All special non-whitespace HTML characters are displayed as-is.

  • The tilde ~ is the Escape Character

    • A single tilde before a link ('~http://foo.bar', '~WikiWord') prevents linking. => http://foo.bar, WikiWord
    • You can use tildes in the middle of WikiWord~s to prevent them from being linked as a whole. => WikiWords
    • Similarly, a tilde can be used to cancel the effect of markup ('~__', '~<tt>'). => __, <tt>
    • A tilde also cancels a following tilde, so any two tildes in a row ('~~') get rendered as a single tilde. => ~
    • The exception is within URLs ('http://foo.bar/~baz'), where a single tilde renders as itself. => http://foo.bar/baz
    • A single tilde '~' followed by nothing gets rendered as a single tilde. => ~

Paragraphs

  • Don't indent paragraphs
  • Words wrap and fill as needed
  • Use blank lines as separators
  • Four or more minus signs make a horizontal rule
  • %%% or <br> makes a linebreak (in headings and lists too)

Lists

  • asterisk for first level

    • indented asterisk (indent at least two spaces) for second level, etc.
  • Use *, -, + or o for bullet lists, # for numbered lists (mix at will)

  • Definition lists:

    Term:
  definition

    gives

    Term
    definition

    as in the <DL><DT><DD> list

  • Items may contain multiple paragraphs and other multi-lined content, just indent the items. This includes <pre> and <verbatim> text!

Headings

  • '!' at the start of a line makes a small heading
  • '!!' at the start of a line makes a medium heading
  • '!!!' at the start of a line makes a large heading

Preformatted text

  • Place preformatted lines inside <pre>:

    <pre>
Preformatted text. WikiLinks still work.
</pre>

    gives

    Preformatted text. WikiLinks? still work.

  • If you want text with no Wiki interaction, use the <verbatim> tag:

    <verbatim>
Preformatted text. WikiLinks do not work.
</verbatim>

    gives

    Preformatted text. WikiLinks do not work.

Indented Paragraphs

  • Two or more whitespaces signal indented text. Indents may be nested.

    This is an indented block of text.

    This block is even more indented.

  • E-mail style block-quoting is supported as well:

    > This is block-quoted text.

    renders as

    This is block-quoted text.

Emphasis

  • Use doubled single-quotes ('') for emphasis (usually italics)
  • Use doubled underscores (__) for strong emphasis (usually bold)
  • Mix them at will: bold italics

  • Emphasis can be used multiple times within a line, but cannot cross line boundaries:

    ''this

    will not work''

References

  • Hyperlinks to other pages within the Wiki are made by placing the page name in square brackets: this is a page link or UsingWikiWords? (preferred)
  • Hyperlinks to external pages are done like this: http://www.wcsb.org/
  • You can name the links by providing a name, a bar (|) and then the hyperlink or pagename: PhpWiki home page --- the front page
  • You can suppress linking to old-style references and URIs by preceding the word with a '~', e.g. NotLinkedAsWikiName, http://not.linked.to/
  • Also, the old way of linking URLs is still supported: precede URLs with "http:", "ftp:" or "mailto:" to create links automatically as in: http://c2.com/
  • URLs ending with .png, .gif, or .jpg are inlined if in square brackets, by themselves:
    png.png

Tables

  • Old-style tables are supported through the OldStyleTablePlugin -- at the WlugWiki we prefer you use that.

  • Definition list style tables are written just like definition lists, except that you replace the trailing colon on the term with a "pipe" (|).

    Term 1 |
   Definition 1 begins here.
   Term 1.1 |
      Definition 1.1
   Term 1.2 |
      Definition 1.2
   This is part of definition 1.
Term 2 |
   Here's definition 2.
    Term 1

    Definition 1 begins here.
    Term 1.1 Definition 1.1
    Term 1.2 Definition 1.2

    This is part of definition 1.
    Term 2 Here's definition 2.

HTML Mark-Up Language

  • Some in-line markup is allowed through the use of HTML tags: b, big, i, small, tt, em, strong, abbr, acronym, cite, code, dfn, kbd, samp, var, sup and sub
  • < and > are themselves
  • The & characters will not work

Creating various kinds of special links

  • See MagicPhpWikiURLs for gory details on how to write various kind of wiki maintenance and other special links.

Inserting plugins

PhpWikiDocumentation