Formatting rules

Introduction

This section describes the syntax used to format a UWiKiCMS page and make it display paragraphs, lists, links, and so on. Basically all other operations (creating pages, images) do not truely require any documentation. However these formatting rules might not be so easily guessed.

That's why this documentation exists.

Note that most of the formatting rules here are inherited from PhpWiki, indeed UWiKiCMS HTML engine borrows 99% of code from PhpWiki. This very documentation is itself largely inspired from PhpWiki.

Standard PhpWiki rules

All this is heavily inspired from PhpWiki formatting rules.

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
  • %%% makes a linebreak (in headings and lists too)

Lists

  • asterisk for first level
    • asterisk-asterisk for second level, etc.
  • Use * for bullet lists, # for numbered lists (mix at will)
  • semicolon-term-colon-definition for definition lists:
term here
definition here, as in the <DL><DT><DD> list
  • One line for each item
  • Other leading whitespace signals preformatted text, changes font.

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

Fonts

  • Indent with one or more spaces to use a monospace font:
 This is in monospace

This is not

Indented Paragraphs

  • semicolon-colon -- works like <BLOCKQUOTE>
this is an indented block of 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 (a bit different from PhpWiki)

  • To make a link to an external site you can put it explicitly into bracketys [ http://www.ufoot.org/uwikicms ].
  • You can specify a name for a link, for instance [ UWiKiCMS | http://www.ufoot.org/uwikicms ].
  • Even ommitting brackets, a valid URL starting by a known protocol such as "http:", "ftp:" or "mailto:" will be automatically be made an HTML link.

HTML Mark-Up Language

  • Don't bother
  • < and > are themselves
  • The & characters will not work

UWiKiCMS specific stuff

Here are a few extensions which I added for UWiKiCMS. Basically they are all of the same type: new protocols of the form "protocol:" which can be used in links.

Images

[ img:123 ] includes image 123.

Note that the list of available images appears at the bottom of the page when you enter page modification mode. Then you can simply copy/paste the code which appears before each image.

Links to other UWiKiCMS pages

[ page:xyz ] or [ Page description | page:xyz ] makes a link to a relative page.

Use relative links. In page "/foo" a link of type [ Bar | page:bar ] points to "/foo/bar". A link to [ Foo2 | page:../foo2 ] points to "/foo2". A link to [ Foobug page:/foobug ] points to nothing good.

Translations

[ lang:xy ] or [ Language | lang:xy ] creates a link to the translation in the given language.

For instance [ in French | lang:fr ].

Page generated by UWiKiCMS 1.1.8 on Wed Mar 29 2017.
Copyright © 2005 Christian Mauduit. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
Updated on Sun Jun 05 2005.