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 30533
PhpWikiAdministration 2383
Help/EditMetaDataPlugin 1895
Help/RedirectToPlugin 2051
TextFormattingRules 13065
OldTextFormattingRules 949
RedirectToPlugin 841
NewMarkupTestPage 967
OldMarkupTestPage 902
IncludePagePlugin 1319
AmperexElectronicCorporation 2054
DeltaElectronics 6047
EimacDivisionOfVarian 1921
GatesRadioCompany 16705
GatesRadioCatalog99 1240
GeneralElectric 3077
GeneralRadio 28859
HallikainenAndFriends 18986
MoseleyAssociatesInc 5359
Motorola 2050
National 1823
NemsClarke 2070
RCA 19102
WesternElectric 4103
Technics 2206
Westinghouse 1728
MilitaryRadio 7678
Historic Papers 6344
Station Histories 5615
Ratheon 837
Raytheon 2605
EfJohnson 1640
American Electronic Laboratories 2860
Victoreen Instrument Company 1862
Anton Electronic Laboratories 1893
Collins Radio 17035
HoweTech 1680
Belar Electronics Laboratory 4849
Ampex 15818
Harris Corporation - Broadcast Division 9116
Dorrough Electronics 7832
Radio Engineering Laboratories 1707
Standard Electronics 1505
Amalgamated Wireless (Australiasia) Ltd. 2833
Byer Industries 1711
Circuit Research Laboratories 2042
Bauer Electronics Corporation 2290
Trimax 1544
United Transformer Corporation 1660
template 922
Philips 2018
McMartin 3048
ITA 1720
Continental Electronics 4768
Magnecord 1954
TFT, Inc. 6184
Schafer Automation 2655
Gentner 6644
Texar 2312
Langevin 2441
Altec 3486
CBS Labs 3370
Pultec 1583
Sony 4661
3M 5353
UREI 2790
Frese and Kaping 2344
Revox 4373
Federated Purchaser 1470
CCA 3102
LPB 6439
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 3061
Tepco 1690
Standard Telephones & Cables. Australia 1672
Presto 1659
Straight Wire Audio 1561
Arrakis Systems, Inc 3752
Consolidated Electronic Industries 1632
Aphex Systems Limited 2078
QEI 6995
Multronics 1538
ITC 5571
Machlett Laboratories 1771
Cutting Edge Technologies 1529
Bext 2332
Tektronix 4134
Electronics Research, Inc. 1357
Advanced Research & Technology 2978
Marantz 1973
Microcon 1507
Broadcast Television Systems 1907
Bosch 1752
dbx 3027
Otari 2269
Crown 5631
Broadcast Electronics 19466
ATI 2551
Scully 2089
Marti Electronics, Inc. 2806
Harman Kardon 2141
Potomac Instruments 3575
Broadcast Audio 4597
Andrew Corporation 2814
Audio Arts 1831
Bird Electronic Corporation 12974
Dumont 2587
Autogram 9419
Radio Engineering 992
Heathkit 86
Mullard 1735
NBC 1734
Amperite 1959
McIntosh 2536
Inovonics 3271
Neotek 3685
Moulic Specialties Co. 1427
Engineering Services 1573
IRC 2110
ESE 5165
Comtech Antenna Corporation 2021
Panasonic 7614
Orban 4952
Studer 1562
Coastcom 1704
Clear-Com 1675
Dolby Laboratories 2442
CSI 3883
Bell Telephone Laboratories 2684
Pacific Recorders and Engineers 2629
Hewlett Packard 4448
Sparta Electronics 6563
Tapecaster 4818
Scala 1711
Marconi Wireless Telegraph Company 1668
Energy-Onix 3499
Modulation Sciences 3866
Burk Technology 5359
Auditronics 5357
Jampro Antenna 1702
Dayton Industrial 6550
Thompson-CSF 2678
Rust Industrial Company, Inc. 2852
Accurate Sound Corporation 3278
IGM 2133
SMC 2485
Radix 2912
Fidelipac 3983
Hughey & Phillips 3282
Microwave Radio Corporation 3688
Broadcast Tools 1250
Symmetrix 3733
GatesAir 1803
Hallicrafters 4180
Kenwood 2941
Kyocera 3518
Teac 4004
Wheatstone Corporation 2273
Gorman-Redlich 2321
Studer International AG 1934
Data Systems Design 2181
Dana Electronics 3410
American Data 2955
Teletronix Engineering Company 2447
Tentel 2009
Taber Manufacturing and Engineering Company 2044
Standart Tape Laboratory 2004
Extel 2321
Russco 2177
Automated Broadcast Controls 2310
Electrovoice 1963
Jennings 1986
Wegener Communications 1940
Midwest Communications 1967
Aston 2346
Farallon 2061
Kenneth A. Bacon Associates 1867
J. G. S. Engineering Inc. 2105
Continental Satellite Systems 1992
ComStream 3076
Conex Electro Systems 1839
Denon 2129
Multi-technical Services 2075
Electronic Signal Products 2229
Lorain Products Corporation 1955
C & D Batteries 3707
Nova Systems, Inc. 1784
Nortronics 4190
Norcom 2624
Lambda Electronics Corp. 2645
US Audio 1885
Jensen Transformers 2044
Garner Industries 1927
Sescom 2114
Soltec 2191
Peak Audio 1828
MCI 2614
MEI 4373
Minicom Division of 3M 2846
Metrotech 3504
Lang Electronics 2069
Kinght-kit 2872
Cetec Broadcast Group 3724
Computer Concepts 2255
Dataworld 2088
National Association of Broadcasters 2882
Link, Fred M 1943
Weston 2881
Yokogawa Electric Works 2003
Measurements 2914
Electronics Digest 1683
Gregg Laboratories 2155
Leeds & Northrup Company 2034
Video Systems of America 1920
Simpson Electric Company 2038
Triplett 1962
Boonton Radio Corporation 1963
Ohmite Manufacturing Company 2107
Contel ASC 1658
Audi-Cord Corporation 1785
Johnson Electronics 1636
Telefile Computer Products, Inc. 1773
Realistic 1615
Thordarson 1624
Sine Systems 1961
Telos 1660
Harris Allied 1623
Broadcasters General Store 2158
QRK 1707
BME - Broadcast Management Engineering Magazine 2590
Radio Business Report 1586
UMC Beaucart 1589
Armstrong Transmitter Corporation 6719
Cablewave Systems 1529
Aristocart 1863
Elgin Electronics 1613
Goldline 1491
NAD Electronics 2102
Will-Burt Company 1054
Valcom 1746
SStran 1009

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