Help/TextFormattingRules

Synopsis

Emphasis: // for italics, ** for bold, **//...//** for both, ## for fixed width.
Lists: * for bullet lists, # for numbered lists; use multiple * or # for nested lists.
Headings: "==", "===", "====", etc. make headings.
Preformatted text: Enclose text in {{{...}}} or <pre></pre>.
Indented text: Indent the paragraph with whitespaces.
References: use double square brackets for a [[page link]] or URL [[http://cool.wiki.int/]].
References: use pipe | to name the links: [[page link|some text]] or [[http://cool.wiki.int/|some text]].
Preventing linking: Prefix with "~": ~DoNotHyperlink.
Misc: "\\" makes a linebreak, "----" makes a horizontal rule.
Allowed HTML tags: b big i small tt em strong s strike abbr acronym cite code dfn kbd samp var sup sub
More: tables, images, table of contents, plugins

More explanations: Help:TextFormattingRules

Character Formatting

Emphasis

  • Use a double slash (//) for emphasis (usually italics)
  • Use a double asterisk (**) for strong emphasis (usually bold)
  • Mix them at will: bold italics
  • Emphasis can be used multiple times within a paragraph, but cannot cross paragraph boundaries:

// this

will not work//

Monospace

Monospace text is made using two hashes:

This sentence contains ##monospace text##.

This sentence contains monospace text.

Superscript

Superscript text is made using two carets:

The XX^^th^^ century.

The XXth century.

Subscript

Subscript text is made using two commas:

Water is H,,2,,O.

Water is H2O.

Fonts

There's no syntax for font tags.

Color Text

It is possible to write text in color.

%color=green% green text %% and back to normal

will give:
green text and back to normal

The easiest way to do it is to use the COLOR button in the Edit Toolbar. The text will be in green by default. You can then change the color.

Allowed colors are:

  • an HTML color number (# followed by 3 or 6 digits),
  • the following predefined color names:

aqua

beige

black

blue

brown

chocolate

cyan

fuchsia

gold

gray

green

ivory

indigo

lime

magenta

maroon

navy

olive

orange

pink

purple

red

salmon

silver

snow

teal

turquoise

violet

white

yellow

Note: you can put the headers in color, but only if you do not have a table of content. For now, the table of content is incompatible with color headers.

Escape Character

The tilde '~' is the Escape Character:

  • A single tilde '~' followed by nothing gets rendered as a single tilde. => ~
  • Two tilde '~~' get rendered as a single tilde. => ~
  • A single tilde before a link ('~http://foo.bar') prevents linking. => http://foo.bar
  • Two tildes before a link ('~~http://foo.bar') produce a tilde followed by the hyperlinked URL. => ~http://foo.bar
  • A tilde inside an URL gets removed, unless it's formatted inside square brackets.
  • Two tildes inside an URL (without brackets) become a single tilde. => http://foo.bar/~user or http://foo.bar/~user

Special Characters

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

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

Unordered lists

Recommended syntax (Wikicreole):

  • asterisk for first level
  • double asterisk for second level, etc.

Be sure to put a space after the asterisk.

You can also use indented asterisk for second level (indent at least two spaces).

Ordered lists

Recommended syntax (Wikicreole):

  • # for first level
  • double # for second level, etc.

Be sure to put a space after the hash sign.

You can also use indented # for second level (indent at least two spaces).

Definition lists

Term:
  definition

gives

Term
definition

Remark

Items may contain multiple paragraphs and other multi-lined content, just indent the items

Headings

Wikicreole syntax (recommended)

  • '==' at the start of a line makes a large heading (h2)
  • '===' at the start of a line makes a medium heading (h3)
  • '====' at the start of a line makes a small heading (h4)
  • '=====' at the start of a line makes a smaller heading (h5)
  • '======' at the start of a line makes a tiny heading (h6)

Classic Phpwiki syntax

  • '!!!' at the start of a line makes a large heading (h2)
  • '!!' at the start of a line makes a medium heading (h3)
  • '!' at the start of a line makes a small heading (h4)

Preformatted text

Place the preformatted text between three opening curly brackets and three closing curly brackets:

{{{
Preformatted text. ~WikiLinks do not work.
}}}

gives

Preformatted text. WikiLinks do not work.

If you want Wiki interaction, place preformatted lines inside <pre>:

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

gives

Preformatted text. WikiLinks still 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.

References

  • Hyperlinks to other pages within the Wiki are made by placing the page name in double square brackets: this is a page link. Single brackets or WikiWords will also work.
  • Hyperlinks to external pages are done like this: http://www.wcsb.org/
  • You can name the links by providing the hyperlink or pagename, a pipe (|) and then the name: PhpWiki home page, the front page
  • You can suppress linking to URIs by preceding the word with a '~', e.g. NotLinkedAsWikiName, http://not.linked.to/
  • Also, the old way of linking URL's 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:
  • You can create footnotes by using [1], [2], [3], ... like this here #[|ftnt

_ref_1][1]. See footnote for counterpart. (If the [ is in the first column, it is a footnote definition rather than a footnote

reference [1].)

  • In-page hyperlinks are made by placing a named anchor and referring to the anchor in a hyperlink:

    • Named anchors:

      • #[[foo]]: An anchor around the text "foo" with id "foo".
      • #[[|foo]]: An empty anchor with id "foo".
      • #[[howdy|foo]]: An anchor around the text "howdy" with id "foo".
    • References to name anchors are made thusly:
      [[#hyperlinks]], [[OtherPage#foo]], [[OtherPage#foo|named]].
  • Semantic links are named links like: is_a::WikiPage and attributes like size:-4000.
  • A pagelink within square brackets starting with ":" is not backlinked.

Images

An inline image is created with curly brackets. An alternate text can be put after a pipe. If there is none, an empty alternate text will be created.

{{myimage.png}}
{{myimage.png|this is the alt text for my image}}
[[some link|{{myimage.png}}]] - if you click on the image, will goto "some link"
[[some link|{{myimage.png|alt text}}]] - same with alternative
[[http://example.com/|{{myimage.png}}]] - same as above: picture links to url
[[http://example.com/|{{myimage.png|alt text}}]] - same with alternative

Tables

Wikicreole tables

All cells are separated by single pipes. Leading spaces are permitted before the first cell of a row and trailing spaces are permitted at the end of a line. The ending pipe is optional.

You can embed links, bold, italics, line breaks, and nowiki in table cells.

Equal sign directly following pipe defines a header. Headers can be arranged horizontally or vertically.

|=Heading Col 1 |=Heading Col 2         |
|Cell 1.1       |Two lines\\in Cell 1.2 |
|Cell 2.1       |Cell 2.2               |

will give:

Heading Col 1 Heading Col 2
Cell 1.1 Two lines
in Cell 1.2
Cell 2.1 Cell 2.2

Mediawiki tables

See Help:MediawikiTablePlugin.

Definition list style tables

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.

will give:

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.

Old-style tables

See: Help:OldStyleTablePlugin

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 Help:MagicPhpWikiURLs for gory details on how to write various kind of wiki maintenance and other special links.

Inserting plugins

Several plugins permit embedding additional functionality to Wiki pages. For example,

<<BackLinks page=HomePage info=hits>>

gives

247 pages link to HomePage:
|<<   << - 1 / 5 - Next >>   >>|
|<<   << - 1 / 5 - Next >>   >>|
Page Name. Hits.
Help/TextFormattingRules 30518
PhpWikiAdministration 2383
Help/EditMetaDataPlugin 1895
Help/RedirectToPlugin 2051
TextFormattingRules 13061
OldTextFormattingRules 948
RedirectToPlugin 841
NewMarkupTestPage 966
OldMarkupTestPage 902
IncludePagePlugin 1318
AmperexElectronicCorporation 2053
DeltaElectronics 6038
EimacDivisionOfVarian 1921
GatesRadioCompany 16703
GatesRadioCatalog99 1240
GeneralElectric 3070
GeneralRadio 28844
HallikainenAndFriends 18944
MoseleyAssociatesInc 5353
Motorola 2049
National 1822
NemsClarke 2068
RCA 19053
WesternElectric 4101
Technics 2206
Westinghouse 1725
MilitaryRadio 7656
Historic Papers 6323
Station Histories 5605
Ratheon 836
Raytheon 2604
EfJohnson 1639
American Electronic Laboratories 2858
Victoreen Instrument Company 1861
Anton Electronic Laboratories 1892
Collins Radio 17019
HoweTech 1678
Belar Electronics Laboratory 4843
Ampex 15810
Harris Corporation - Broadcast Division 9110
Dorrough Electronics 7813
Radio Engineering Laboratories 1707
Standard Electronics 1504
Amalgamated Wireless (Australiasia) Ltd. 2832
Byer Industries 1709
Circuit Research Laboratories 2037
Bauer Electronics Corporation 2289
Trimax 1543
United Transformer Corporation 1659
template 921
Philips 2017
McMartin 3046
ITA 1719
Continental Electronics 4758
Magnecord 1953
TFT, Inc. 6180
Schafer Automation 2655
Gentner 6632
Texar 2309
Langevin 2440
Altec 3486
CBS Labs 3363
Pultec 1582
Sony 4657
3M 5348
UREI 2786
Frese and Kaping 2344
Revox 4371
Federated Purchaser 1469
CCA 3101
LPB 6433
Hollyanne 1508
Telfax 1466
Help/OldTextFormattingRules 887
AmministrazioneDiPhpWiki 963
Help/NewMarkupTestPage 887
Help/NewMarkupTestPage 887
Help/NewMarkupTestPage 887
Help/OldMarkupTestPage 857
Help/OldMarkupTestPage 857
Help/OldMarkupTestPage 857
Larcan 3059
Tepco 1689
Standard Telephones & Cables. Australia 1671
Presto 1658
Straight Wire Audio 1560
Arrakis Systems, Inc 3752
Consolidated Electronic Industries 1632
Aphex Systems Limited 2078
QEI 6994
Multronics 1538
ITC 5552
Machlett Laboratories 1771
Cutting Edge Technologies 1528
Bext 2328
Tektronix 4122
Electronics Research, Inc. 1356
Advanced Research & Technology 2978
Marantz 1971
Microcon 1507
Broadcast Television Systems 1907
Bosch 1751
dbx 3023
Otari 2265
Crown 5628
Broadcast Electronics 19379
ATI 2551
Scully 2089
Marti Electronics, Inc. 2802
Harman Kardon 2138
Potomac Instruments 3569
Broadcast Audio 4596
Andrew Corporation 2812
Audio Arts 1831
Bird Electronic Corporation 12746
Dumont 2582
Autogram 9417
Radio Engineering 991
Heathkit 82
Mullard 1734
NBC 1733
Amperite 1957
McIntosh 2534
Inovonics 3269
Neotek 3681
Moulic Specialties Co. 1426
Engineering Services 1572
IRC 2110
ESE 5164
Comtech Antenna Corporation 2019
Panasonic 7581
Orban 4947
Studer 1561
Coastcom 1702
Clear-Com 1674
Dolby Laboratories 2441
CSI 3881
Bell Telephone Laboratories 2683
Pacific Recorders and Engineers 2628
Hewlett Packard 4435
Sparta Electronics 6556
Tapecaster 4813
Scala 1710
Marconi Wireless Telegraph Company 1667
Energy-Onix 3498
Modulation Sciences 3865
Burk Technology 5354
Auditronics 5356
Jampro Antenna 1701
Dayton Industrial 6548
Thompson-CSF 2677
Rust Industrial Company, Inc. 2852
Accurate Sound Corporation 3278
IGM 2131
SMC 2482
Radix 2909
Fidelipac 3974
Hughey & Phillips 3281
Microwave Radio Corporation 3685
Broadcast Tools 1227
Symmetrix 3728
GatesAir 1802
Hallicrafters 4172
Kenwood 2940
Kyocera 3513
Teac 3982
Wheatstone Corporation 2265
Gorman-Redlich 2320
Studer International AG 1931
Data Systems Design 2177
Dana Electronics 3403
American Data 2950
Teletronix Engineering Company 2444
Tentel 2009
Taber Manufacturing and Engineering Company 2042
Standart Tape Laboratory 2002
Extel 2321
Russco 2174
Automated Broadcast Controls 2307
Electrovoice 1960
Jennings 1985
Wegener Communications 1937
Midwest Communications 1965
Aston 2343
Farallon 2061
Kenneth A. Bacon Associates 1866
J. G. S. Engineering Inc. 2104
Continental Satellite Systems 1992
ComStream 3075
Conex Electro Systems 1838
Denon 2129
Multi-technical Services 2073
Electronic Signal Products 2228
Lorain Products Corporation 1953
C & D Batteries 3700
Nova Systems, Inc. 1783
Nortronics 4185
Norcom 2622
Lambda Electronics Corp. 2640
US Audio 1882
Jensen Transformers 2043
Garner Industries 1924
Sescom 2113
Soltec 2190
Peak Audio 1828
MCI 2612
MEI 4369
Minicom Division of 3M 2844
Metrotech 3497
Lang Electronics 2069
Kinght-kit 2870
Cetec Broadcast Group 3719
Computer Concepts 2255
Dataworld 2087
National Association of Broadcasters 2877
Link, Fred M 1942
Weston 2880
Yokogawa Electric Works 2002
Measurements 2910
Electronics Digest 1681
Gregg Laboratories 2153
Leeds & Northrup Company 2030
Video Systems of America 1918
Simpson Electric Company 2037
Triplett 1961
Boonton Radio Corporation 1962
Ohmite Manufacturing Company 2106
Contel ASC 1656
Audi-Cord Corporation 1784
Johnson Electronics 1634
Telefile Computer Products, Inc. 1770
Realistic 1612
Thordarson 1622
Sine Systems 1957
Telos 1658
Harris Allied 1622
Broadcasters General Store 2156
QRK 1704
BME - Broadcast Management Engineering Magazine 2588
Radio Business Report 1585
UMC Beaucart 1588
Armstrong Transmitter Corporation 6716
Cablewave Systems 1527
Aristocart 1862
Elgin Electronics 1613
Goldline 1490
NAD Electronics 2099
Will-Burt Company 1053
Valcom 1740
SStran 1009

For more information on plugins see Help:WikiPlugin, and PluginManager for a list of all plugins.