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 NameClick to reverse sort order Hits.
Help/TextFormattingRules 14889
PhpWikiAdministration 1265
Help/EditMetaDataPlugin 1075
Help/RedirectToPlugin 1109
TextFormattingRules 6229
OldTextFormattingRules 486
RedirectToPlugin 466
NewMarkupTestPage 497
OldMarkupTestPage 452
IncludePagePlugin 726
AmperexElectronicCorporation 1319
DeltaElectronics 2522
EimacDivisionOfVarian 1094
GatesRadioCompany 2233
GatesRadioCatalog99 593
GeneralElectric 162
GeneralRadio 3852
HallikainenAndFriends 1961
MoseleyAssociatesInc 792
Motorola 1092
National 1006
NemsClarke 1161
RCA 2582
WesternElectric 1961
Technics 1259
Westinghouse 1042
MilitaryRadio 1055
Historic Papers 960
Station Histories 814
Ratheon 430
Raytheon 1550
EfJohnson 1023
American Electronic Laboratories 1655
Victoreen Instrument Company 1133
Anton Electronic Laboratories 1269
Collins Radio 2429
HoweTech 1028
Belar Electronics Laboratory 2792
Ampex 2298
Harris Corporation - Broadcast Division 1318
Dorrough Electronics 1326
Radio Engineering Laboratories 993
Standard Electronics 941
Amalgamated Wireless (Australiasia) Ltd. 1810
Byer Industries 993
Circuit Research Laboratories 388
Bauer Electronics Corporation 1147
Trimax 947
United Transformer Corporation 961
template 457
Philips 1163
McMartin 467
ITA 1095
Continental Electronics 255
Magnecord 939
TFT, Inc. 834
Schafer Automation 1523
Gentner 1076
Texar 1281
Langevin 1314
Altec 2128
CBS Labs 251
Pultec 942
Sony 702
3M 727
UREI 500
Frese and Kaping 1309
Revox 652
Federated Purchaser 868
CCA 503
LPB 3701
Hollyanne 885
Telfax 861
Help/OldTextFormattingRules 495
AmministrazioneDiPhpWiki 537
Help/NewMarkupTestPage 484
Help/NewMarkupTestPage 484
Help/NewMarkupTestPage 484
Help/OldMarkupTestPage 473
Help/OldMarkupTestPage 473
Help/OldMarkupTestPage 473
Larcan 1702
Tepco 1048
Standard Telephones & Cables. Australia 903
Presto 979
Straight Wire Audio 909
Arrakis Systems, Inc 2126
Consolidated Electronic Industries 937
Aphex Systems Limited 1329
QEI 3442
Multronics 909
ITC 923
Machlett Laboratories 1073
Cutting Edge Technologies 972
Bext 1440
Tektronix 763
Electronics Research, Inc. 850
Advanced Research & Technology 1922
Marantz 1092
Microcon 922
Broadcast Television Systems 953
Bosch 1085
dbx 135
Otari 1254
Crown 2809
Broadcast Electronics 2618
ATI 1508
Scully 1088
Marti Electronics, Inc. 335
Harman Kardon 1191
Potomac Instruments 458
Broadcast Audio 2329
Andrew Corporation 470
Audio Arts 1171
Bird Electronic Corporation 1411
Dumont 1539
Autogram 4348
Radio Engineering 531
Heathkit 853
Mullard 929
NBC 1086
Amperite 1285
McIntosh 1437
Inovonics 1678
Neotek 1943
Moulic Specialties Co. 890
Engineering Services 970
IRC 1308
ESE 2703
Comtech Antenna Corporation 1181
Panasonic 1020
Orban 2623
Studer 942
Coastcom 1018
Clear-Com 944
Dolby Laboratories 419
CSI 2176
Bell Telephone Laboratories 1535
Pacific Recorders and Engineers 1382
Hewlett Packard 640
Sparta Electronics 955
Tapecaster 2532
Scala 1048
Marconi Wireless Telegraph Company 1079
Energy-Onix 1892
Modulation Sciences 2008
Burk Technology 2714
Auditronics 2894
Jampro Antenna 100
Dayton Industrial 1067
Thompson-CSF 1505
Rust Industrial Company, Inc. 1572
Accurate Sound Corporation 2054
IGM 1270
SMC 1372
Radix 1570
Fidelipac 736
Hughey & Phillips 1736
Microwave Radio Corporation 2038
Broadcast Tools 995
Symmetrix 1950
GatesAir 1100
Hallicrafters 2274
Kenwood 1602
Kyocera 1858
Teac 640
Wheatstone Corporation 355
Gorman-Redlich 1417
Studer International AG 1143
Data Systems Design 1267
Dana Electronics 2014
American Data 1794
Teletronix Engineering Company 1478
Tentel 1146
Taber Manufacturing and Engineering Company 1264
Standart Tape Laboratory 1191
Extel 1343
Russco 1162
Automated Broadcast Controls 1378
Electrovoice 1179
Jennings 1179
Wegener Communications 1127
Midwest Communications 1098
Aston 1481
Farallon 1189
Kenneth A. Bacon Associates 1047
J. G. S. Engineering Inc. 1159
Continental Satellite Systems 1149
ComStream 1674
Conex Electro Systems 1069
Denon 1295
Multi-technical Services 1101
Electronic Signal Products 1321
Lorain Products Corporation 1180
C & D Batteries 2015
Nova Systems, Inc. 1059
Nortronics 2269
Norcom 1434
Lambda Electronics Corp. 1484
US Audio 1148
Jensen Transformers 1190
Garner Industries 1084
Sescom 1243
Soltec 1262
Peak Audio 1066
MCI 1515
MEI 2245
Minicom Division of 3M 1648
Metrotech 1893
Lang Electronics 1117
Kinght-kit 1585
Cetec Broadcast Group 2046
Computer Concepts 1339
Dataworld 1273
National Association of Broadcasters 1635
Link, Fred M 1126
Weston 1580
Yokogawa Electric Works 1246
Measurements 1610
Electronics Digest 337
Gregg Laboratories 1214
Leeds & Northrup Company 1188
Video Systems of America 1073
Simpson Electric Company 1206
Triplett 1025
Boonton Radio Corporation 1092
Ohmite Manufacturing Company 1320
Contel ASC 859
Audi-Cord Corporation 941
Johnson Electronics 834
Telefile Computer Products, Inc. 1038
Realistic 743
Thordarson 743
Sine Systems 931
Telos 817
Harris Allied 748
Broadcasters General Store 999
QRK 857
BME - Broadcast Management Engineering Magazine 1671
Radio Business Report 716
UMC Beaucart 682
Armstrong Transmitter Corporation 5771
Cablewave Systems 706
Aristocart 839
Elgin Electronics 755
Goldline 645
NAD Electronics 1104
Will-Burt Company 227
Valcom 36

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