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 30346
PhpWikiAdministration 2375
Help/EditMetaDataPlugin 1890
Help/RedirectToPlugin 2044
TextFormattingRules 13002
OldTextFormattingRules 942
RedirectToPlugin 837
NewMarkupTestPage 961
OldMarkupTestPage 895
IncludePagePlugin 1315
AmperexElectronicCorporation 2047
DeltaElectronics 6002
EimacDivisionOfVarian 1913
GatesRadioCompany 16600
GatesRadioCatalog99 1229
GeneralElectric 3047
GeneralRadio 28796
HallikainenAndFriends 18743
MoseleyAssociatesInc 5322
Motorola 2041
National 1819
NemsClarke 2059
RCA 18854
WesternElectric 4092
Technics 2197
Westinghouse 1714
MilitaryRadio 7543
Historic Papers 6186
Station Histories 5565
Ratheon 830
Raytheon 2590
EfJohnson 1634
American Electronic Laboratories 2854
Victoreen Instrument Company 1854
Anton Electronic Laboratories 1888
Collins Radio 16899
HoweTech 1672
Belar Electronics Laboratory 4822
Ampex 15708
Harris Corporation - Broadcast Division 9084
Dorrough Electronics 7700
Radio Engineering Laboratories 1701
Standard Electronics 1502
Amalgamated Wireless (Australiasia) Ltd. 2823
Byer Industries 1705
Circuit Research Laboratories 2009
Bauer Electronics Corporation 2282
Trimax 1537
United Transformer Corporation 1656
template 916
Philips 2009
McMartin 3016
ITA 1713
Continental Electronics 4683
Magnecord 1948
TFT, Inc. 6167
Schafer Automation 2647
Gentner 6586
Texar 2296
Langevin 2424
Altec 3476
CBS Labs 3335
Pultec 1577
Sony 4609
3M 5310
UREI 2759
Frese and Kaping 2336
Revox 4344
Federated Purchaser 1463
CCA 3088
LPB 6393
Hollyanne 1501
Telfax 1460
Help/OldTextFormattingRules 884
AmministrazioneDiPhpWiki 958
Help/NewMarkupTestPage 885
Help/NewMarkupTestPage 885
Help/NewMarkupTestPage 885
Help/OldMarkupTestPage 855
Help/OldMarkupTestPage 855
Help/OldMarkupTestPage 855
Larcan 3036
Tepco 1684
Standard Telephones & Cables. Australia 1664
Presto 1653
Straight Wire Audio 1557
Arrakis Systems, Inc 3745
Consolidated Electronic Industries 1626
Aphex Systems Limited 2069
QEI 6960
Multronics 1533
ITC 5463
Machlett Laboratories 1765
Cutting Edge Technologies 1524
Bext 2322
Tektronix 4067
Electronics Research, Inc. 1353
Advanced Research & Technology 2973
Marantz 1960
Microcon 1499
Broadcast Television Systems 1900
Bosch 1745
dbx 3008
Otari 2253
Crown 5614
Broadcast Electronics 19030
ATI 2538
Scully 2081
Marti Electronics, Inc. 2771
Harman Kardon 2128
Potomac Instruments 3545
Broadcast Audio 4586
Andrew Corporation 2789
Audio Arts 1825
Bird Electronic Corporation 11776
Dumont 2572
Autogram 9403
Radio Engineering 979
Heathkit 73
Mullard 1728
NBC 1728
Amperite 1949
McIntosh 2516
Inovonics 3259
Neotek 3657
Moulic Specialties Co. 1421
Engineering Services 1566
IRC 2103
ESE 5157
Comtech Antenna Corporation 2011
Panasonic 7480
Orban 4919
Studer 1557
Coastcom 1694
Clear-Com 1663
Dolby Laboratories 2435
CSI 3873
Bell Telephone Laboratories 2678
Pacific Recorders and Engineers 2623
Hewlett Packard 4387
Sparta Electronics 6525
Tapecaster 4793
Scala 1703
Marconi Wireless Telegraph Company 1662
Energy-Onix 3491
Modulation Sciences 3855
Burk Technology 5334
Auditronics 5348
Jampro Antenna 1697
Dayton Industrial 6497
Thompson-CSF 2670
Rust Industrial Company, Inc. 2845
Accurate Sound Corporation 3262
IGM 2122
SMC 2464
Radix 2899
Fidelipac 3929
Hughey & Phillips 3274
Microwave Radio Corporation 3671
Broadcast Tools 1134
Symmetrix 3698
GatesAir 1797
Hallicrafters 4141
Kenwood 2917
Kyocera 3471
Teac 3914
Wheatstone Corporation 2239
Gorman-Redlich 2314
Studer International AG 1923
Data Systems Design 2155
Dana Electronics 3378
American Data 2937
Teletronix Engineering Company 2436
Tentel 1996
Taber Manufacturing and Engineering Company 2033
Standart Tape Laboratory 1986
Extel 2313
Russco 2164
Automated Broadcast Controls 2295
Electrovoice 1952
Jennings 1972
Wegener Communications 1927
Midwest Communications 1956
Aston 2332
Farallon 2049
Kenneth A. Bacon Associates 1855
J. G. S. Engineering Inc. 2100
Continental Satellite Systems 1980
ComStream 3069
Conex Electro Systems 1828
Denon 2117
Multi-technical Services 2065
Electronic Signal Products 2221
Lorain Products Corporation 1947
C & D Batteries 3667
Nova Systems, Inc. 1778
Nortronics 4151
Norcom 2604
Lambda Electronics Corp. 2622
US Audio 1873
Jensen Transformers 2033
Garner Industries 1915
Sescom 2104
Soltec 2175
Peak Audio 1817
MCI 2593
MEI 4332
Minicom Division of 3M 2825
Metrotech 3467
Lang Electronics 2053
Kinght-kit 2862
Cetec Broadcast Group 3687
Computer Concepts 2240
Dataworld 2079
National Association of Broadcasters 2858
Link, Fred M 1938
Weston 2872
Yokogawa Electric Works 1991
Measurements 2890
Electronics Digest 1660
Gregg Laboratories 2142
Leeds & Northrup Company 2022
Video Systems of America 1909
Simpson Electric Company 2028
Triplett 1955
Boonton Radio Corporation 1958
Ohmite Manufacturing Company 2096
Contel ASC 1647
Audi-Cord Corporation 1769
Johnson Electronics 1623
Telefile Computer Products, Inc. 1763
Realistic 1602
Thordarson 1611
Sine Systems 1945
Telos 1647
Harris Allied 1614
Broadcasters General Store 2143
QRK 1696
BME - Broadcast Management Engineering Magazine 2579
Radio Business Report 1576
UMC Beaucart 1577
Armstrong Transmitter Corporation 6702
Cablewave Systems 1515
Aristocart 1845
Elgin Electronics 1602
Goldline 1483
NAD Electronics 2090
Will-Burt Company 1047
Valcom 1716
SStran 1003

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