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

249 pages link to HomePage:
|<<   << - 1 / 5 - Next >>   >>|
|<<   << - 1 / 5 - Next >>   >>|
Page Name. Hits.
Help/TextFormattingRules 15575
PhpWikiAdministration 1324
Help/EditMetaDataPlugin 1123
Help/RedirectToPlugin 1141
TextFormattingRules 6572
OldTextFormattingRules 501
RedirectToPlugin 488
NewMarkupTestPage 516
OldMarkupTestPage 493
IncludePagePlugin 753
AmperexElectronicCorporation 1372
DeltaElectronics 2828
EimacDivisionOfVarian 1141
GatesRadioCompany 3086
GatesRadioCatalog99 618
GeneralElectric 297
GeneralRadio 4669
HallikainenAndFriends 2436
MoseleyAssociatesInc 960
Motorola 1150
National 1061
NemsClarke 1216
RCA 3661
WesternElectric 2030
Technics 1304
Westinghouse 1080
MilitaryRadio 1274
Historic Papers 1537
Station Histories 997
Ratheon 462
Raytheon 1616
EfJohnson 1062
American Electronic Laboratories 1746
Victoreen Instrument Company 1176
Anton Electronic Laboratories 1324
Collins Radio 3231
HoweTech 1062
Belar Electronics Laboratory 2885
Ampex 2740
Harris Corporation - Broadcast Division 1765
Dorrough Electronics 1572
Radio Engineering Laboratories 1033
Standard Electronics 970
Amalgamated Wireless (Australiasia) Ltd. 1872
Byer Industries 1027
Circuit Research Laboratories 467
Bauer Electronics Corporation 1181
Trimax 983
United Transformer Corporation 1012
template 489
Philips 1207
McMartin 573
ITA 1133
Continental Electronics 463
Magnecord 972
TFT, Inc. 1007
Schafer Automation 1583
Gentner 1543
Texar 1347
Langevin 1380
Altec 2217
CBS Labs 378
Pultec 990
Sony 895
3M 901
UREI 614
Frese and Kaping 1366
Revox 831
Federated Purchaser 931
CCA 633
LPB 3809
Hollyanne 932
Telfax 907
Help/OldTextFormattingRules 525
AmministrazioneDiPhpWiki 558
Help/NewMarkupTestPage 500
Help/NewMarkupTestPage 500
Help/NewMarkupTestPage 500
Help/OldMarkupTestPage 504
Help/OldMarkupTestPage 504
Help/OldMarkupTestPage 504
Larcan 1767
Tepco 1090
Standard Telephones & Cables. Australia 955
Presto 1023
Straight Wire Audio 939
Arrakis Systems, Inc 2199
Consolidated Electronic Industries 984
Aphex Systems Limited 1381
QEI 3543
Multronics 951
ITC 1104
Machlett Laboratories 1122
Cutting Edge Technologies 1009
Bext 1494
Tektronix 896
Electronics Research, Inc. 878
Advanced Research & Technology 1993
Marantz 1149
Microcon 952
Broadcast Television Systems 989
Bosch 1121
dbx 280
Otari 1317
Crown 2942
Broadcast Electronics 3131
ATI 1590
Scully 1129
Marti Electronics, Inc. 406
Harman Kardon 1239
Potomac Instruments 619
Broadcast Audio 2398
Andrew Corporation 576
Audio Arts 1220
Bird Electronic Corporation 3476
Dumont 1587
Autogram 4578
Radio Engineering 555
Heathkit 1053
Mullard 965
NBC 1124
Amperite 1337
McIntosh 1501
Inovonics 1735
Neotek 2016
Moulic Specialties Co. 916
Engineering Services 1037
IRC 1364
ESE 2800
Comtech Antenna Corporation 1234
Panasonic 1235
Orban 2726
Studer 987
Coastcom 1067
Clear-Com 981
Dolby Laboratories 485
CSI 2273
Bell Telephone Laboratories 1601
Pacific Recorders and Engineers 1445
Hewlett Packard 787
Sparta Electronics 1145
Tapecaster 2626
Scala 1095
Marconi Wireless Telegraph Company 1113
Energy-Onix 1963
Modulation Sciences 2077
Burk Technology 2816
Auditronics 3000
Jampro Antenna 184
Dayton Industrial 1324
Thompson-CSF 1576
Rust Industrial Company, Inc. 1616
Accurate Sound Corporation 2139
IGM 1316
SMC 1430
Radix 1635
Fidelipac 880
Hughey & Phillips 1835
Microwave Radio Corporation 2099
Broadcast Tools 1162
Symmetrix 2035
GatesAir 1139
Hallicrafters 2348
Kenwood 1662
Kyocera 1933
Teac 775
Wheatstone Corporation 429
Gorman-Redlich 1485
Studer International AG 1197
Data Systems Design 1311
Dana Electronics 2070
American Data 1878
Teletronix Engineering Company 1525
Tentel 1191
Taber Manufacturing and Engineering Company 1302
Standart Tape Laboratory 1232
Extel 1390
Russco 1207
Automated Broadcast Controls 1422
Electrovoice 1235
Jennings 1228
Wegener Communications 1170
Midwest Communications 1153
Aston 1532
Farallon 1236
Kenneth A. Bacon Associates 1085
J. G. S. Engineering Inc. 1197
Continental Satellite Systems 1203
ComStream 1744
Conex Electro Systems 1105
Denon 1336
Multi-technical Services 1157
Electronic Signal Products 1393
Lorain Products Corporation 1229
C & D Batteries 2097
Nova Systems, Inc. 1093
Nortronics 2351
Norcom 1480
Lambda Electronics Corp. 1530
US Audio 1188
Jensen Transformers 1230
Garner Industries 1121
Sescom 1298
Soltec 1312
Peak Audio 1113
MCI 1588
MEI 2357
Minicom Division of 3M 1699
Metrotech 1971
Lang Electronics 1156
Kinght-kit 1645
Cetec Broadcast Group 2138
Computer Concepts 1381
Dataworld 1314
National Association of Broadcasters 1694
Link, Fred M 1175
Weston 1650
Yokogawa Electric Works 1286
Measurements 1673
Electronics Digest 406
Gregg Laboratories 1254
Leeds & Northrup Company 1238
Video Systems of America 1141
Simpson Electric Company 1245
Triplett 1081
Boonton Radio Corporation 1128
Ohmite Manufacturing Company 1365
Contel ASC 904
Audi-Cord Corporation 984
Johnson Electronics 874
Telefile Computer Products, Inc. 1078
Realistic 789
Thordarson 787
Sine Systems 987
Telos 868
Harris Allied 791
Broadcasters General Store 1068
QRK 903
BME - Broadcast Management Engineering Magazine 1733
Radio Business Report 772
UMC Beaucart 736
Armstrong Transmitter Corporation 5817
Cablewave Systems 742
Aristocart 911
Elgin Electronics 798
Goldline 691
NAD Electronics 1147
Will-Burt Company 284
Valcom 181

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