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 15286
PhpWikiAdministration 1291
Help/EditMetaDataPlugin 1092
Help/RedirectToPlugin 1123
TextFormattingRules 6400
OldTextFormattingRules 492
RedirectToPlugin 473
NewMarkupTestPage 506
OldMarkupTestPage 466
IncludePagePlugin 737
AmperexElectronicCorporation 1336
DeltaElectronics 2601
EimacDivisionOfVarian 1108
GatesRadioCompany 2471
GatesRadioCatalog99 601
GeneralElectric 220
GeneralRadio 4082
HallikainenAndFriends 2145
MoseleyAssociatesInc 852
Motorola 1109
National 1022
NemsClarke 1181
RCA 2990
WesternElectric 1984
Technics 1279
Westinghouse 1055
MilitaryRadio 1142
Historic Papers 1185
Station Histories 875
Ratheon 439
Raytheon 1579
EfJohnson 1038
American Electronic Laboratories 1684
Victoreen Instrument Company 1146
Anton Electronic Laboratories 1284
Collins Radio 2649
HoweTech 1039
Belar Electronics Laboratory 2831
Ampex 2454
Harris Corporation - Broadcast Division 1457
Dorrough Electronics 1433
Radio Engineering Laboratories 1014
Standard Electronics 952
Amalgamated Wireless (Australiasia) Ltd. 1832
Byer Industries 1003
Circuit Research Laboratories 416
Bauer Electronics Corporation 1159
Trimax 961
United Transformer Corporation 980
template 469
Philips 1183
McMartin 502
ITA 1104
Continental Electronics 328
Magnecord 950
TFT, Inc. 908
Schafer Automation 1546
Gentner 1227
Texar 1308
Langevin 1336
Altec 2153
CBS Labs 293
Pultec 959
Sony 783
3M 807
UREI 552
Frese and Kaping 1333
Revox 743
Federated Purchaser 883
CCA 553
LPB 3738
Hollyanne 899
Telfax 877
Help/OldTextFormattingRules 506
AmministrazioneDiPhpWiki 543
Help/NewMarkupTestPage 491
Help/NewMarkupTestPage 491
Help/NewMarkupTestPage 491
Help/OldMarkupTestPage 483
Help/OldMarkupTestPage 483
Help/OldMarkupTestPage 483
Larcan 1729
Tepco 1061
Standard Telephones & Cables. Australia 919
Presto 994
Straight Wire Audio 920
Arrakis Systems, Inc 2156
Consolidated Electronic Industries 952
Aphex Systems Limited 1345
QEI 3485
Multronics 924
ITC 1019
Machlett Laboratories 1087
Cutting Edge Technologies 984
Bext 1462
Tektronix 824
Electronics Research, Inc. 858
Advanced Research & Technology 1943
Marantz 1113
Microcon 931
Broadcast Television Systems 965
Bosch 1094
dbx 209
Otari 1276
Crown 2839
Broadcast Electronics 2754
ATI 1530
Scully 1103
Marti Electronics, Inc. 358
Harman Kardon 1211
Potomac Instruments 527
Broadcast Audio 2358
Andrew Corporation 509
Audio Arts 1184
Bird Electronic Corporation 1694
Dumont 1560
Autogram 4425
Radio Engineering 540
Heathkit 948
Mullard 940
NBC 1096
Amperite 1297
McIntosh 1460
Inovonics 1698
Neotek 1973
Moulic Specialties Co. 898
Engineering Services 984
IRC 1329
ESE 2744
Comtech Antenna Corporation 1199
Panasonic 1102
Orban 2666
Studer 959
Coastcom 1034
Clear-Com 956
Dolby Laboratories 448
CSI 2218
Bell Telephone Laboratories 1556
Pacific Recorders and Engineers 1404
Hewlett Packard 702
Sparta Electronics 1031
Tapecaster 2567
Scala 1062
Marconi Wireless Telegraph Company 1092
Energy-Onix 1924
Modulation Sciences 2036
Burk Technology 2749
Auditronics 2939
Jampro Antenna 133
Dayton Industrial 1148
Thompson-CSF 1533
Rust Industrial Company, Inc. 1588
Accurate Sound Corporation 2082
IGM 1290
SMC 1392
Radix 1602
Fidelipac 786
Hughey & Phillips 1780
Microwave Radio Corporation 2065
Broadcast Tools 1058
Symmetrix 1985
GatesAir 1114
Hallicrafters 2301
Kenwood 1626
Kyocera 1888
Teac 696
Wheatstone Corporation 383
Gorman-Redlich 1445
Studer International AG 1166
Data Systems Design 1285
Dana Electronics 2036
American Data 1825
Teletronix Engineering Company 1498
Tentel 1161
Taber Manufacturing and Engineering Company 1279
Standart Tape Laboratory 1210
Extel 1361
Russco 1177
Automated Broadcast Controls 1396
Electrovoice 1199
Jennings 1196
Wegener Communications 1142
Midwest Communications 1118
Aston 1501
Farallon 1210
Kenneth A. Bacon Associates 1062
J. G. S. Engineering Inc. 1174
Continental Satellite Systems 1171
ComStream 1697
Conex Electro Systems 1083
Denon 1310
Multi-technical Services 1124
Electronic Signal Products 1345
Lorain Products Corporation 1201
C & D Batteries 2051
Nova Systems, Inc. 1070
Nortronics 2298
Norcom 1449
Lambda Electronics Corp. 1501
US Audio 1167
Jensen Transformers 1204
Garner Industries 1099
Sescom 1263
Soltec 1280
Peak Audio 1086
MCI 1545
MEI 2284
Minicom Division of 3M 1673
Metrotech 1925
Lang Electronics 1134
Kinght-kit 1606
Cetec Broadcast Group 2080
Computer Concepts 1355
Dataworld 1288
National Association of Broadcasters 1664
Link, Fred M 1144
Weston 1611
Yokogawa Electric Works 1261
Measurements 1638
Electronics Digest 362
Gregg Laboratories 1231
Leeds & Northrup Company 1210
Video Systems of America 1093
Simpson Electric Company 1224
Triplett 1046
Boonton Radio Corporation 1107
Ohmite Manufacturing Company 1341
Contel ASC 879
Audi-Cord Corporation 958
Johnson Electronics 850
Telefile Computer Products, Inc. 1052
Realistic 760
Thordarson 763
Sine Systems 954
Telos 836
Harris Allied 766
Broadcasters General Store 1024
QRK 880
BME - Broadcast Management Engineering Magazine 1695
Radio Business Report 740
UMC Beaucart 705
Armstrong Transmitter Corporation 5787
Cablewave Systems 719
Aristocart 867
Elgin Electronics 772
Goldline 664
NAD Electronics 1122
Will-Burt Company 243
Valcom 97

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