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 14906
PhpWikiAdministration 1265
Help/EditMetaDataPlugin 1075
Help/RedirectToPlugin 1109
TextFormattingRules 6229
OldTextFormattingRules 486
RedirectToPlugin 468
NewMarkupTestPage 499
OldMarkupTestPage 452
IncludePagePlugin 726
AmperexElectronicCorporation 1322
DeltaElectronics 2524
EimacDivisionOfVarian 1096
GatesRadioCompany 2265
GatesRadioCatalog99 595
GeneralElectric 164
GeneralRadio 3854
HallikainenAndFriends 1964
MoseleyAssociatesInc 796
Motorola 1094
National 1009
NemsClarke 1163
RCA 2588
WesternElectric 1963
Technics 1261
Westinghouse 1045
MilitaryRadio 1057
Historic Papers 963
Station Histories 816
Ratheon 432
Raytheon 1553
EfJohnson 1025
American Electronic Laboratories 1657
Victoreen Instrument Company 1135
Anton Electronic Laboratories 1272
Collins Radio 2431
HoweTech 1030
Belar Electronics Laboratory 2794
Ampex 2303
Harris Corporation - Broadcast Division 1321
Dorrough Electronics 1329
Radio Engineering Laboratories 996
Standard Electronics 943
Amalgamated Wireless (Australiasia) Ltd. 1811
Byer Industries 995
Circuit Research Laboratories 390
Bauer Electronics Corporation 1149
Trimax 949
United Transformer Corporation 964
template 457
Philips 1166
McMartin 470
ITA 1097
Continental Electronics 257
Magnecord 941
TFT, Inc. 835
Schafer Automation 1525
Gentner 1078
Texar 1283
Langevin 1316
Altec 2131
CBS Labs 255
Pultec 944
Sony 707
3M 729
UREI 503
Frese and Kaping 1311
Revox 656
Federated Purchaser 870
CCA 505
LPB 3704
Hollyanne 887
Telfax 863
Help/OldTextFormattingRules 495
AmministrazioneDiPhpWiki 538
Help/NewMarkupTestPage 484
Help/NewMarkupTestPage 484
Help/NewMarkupTestPage 484
Help/OldMarkupTestPage 473
Help/OldMarkupTestPage 473
Help/OldMarkupTestPage 473
Larcan 1704
Tepco 1050
Standard Telephones & Cables. Australia 903
Presto 982
Straight Wire Audio 912
Arrakis Systems, Inc 2128
Consolidated Electronic Industries 940
Aphex Systems Limited 1332
QEI 3445
Multronics 911
ITC 926
Machlett Laboratories 1075
Cutting Edge Technologies 975
Bext 1442
Tektronix 765
Electronics Research, Inc. 850
Advanced Research & Technology 1924
Marantz 1094
Microcon 924
Broadcast Television Systems 955
Bosch 1087
dbx 137
Otari 1256
Crown 2811
Broadcast Electronics 2620
ATI 1510
Scully 1090
Marti Electronics, Inc. 335
Harman Kardon 1194
Potomac Instruments 460
Broadcast Audio 2331
Andrew Corporation 474
Audio Arts 1173
Bird Electronic Corporation 1413
Dumont 1542
Autogram 4350
Radio Engineering 534
Heathkit 855
Mullard 931
NBC 1088
Amperite 1288
McIntosh 1440
Inovonics 1681
Neotek 1945
Moulic Specialties Co. 890
Engineering Services 972
IRC 1310
ESE 2705
Comtech Antenna Corporation 1185
Panasonic 1022
Orban 2626
Studer 944
Coastcom 1020
Clear-Com 946
Dolby Laboratories 421
CSI 2179
Bell Telephone Laboratories 1537
Pacific Recorders and Engineers 1384
Hewlett Packard 643
Sparta Electronics 958
Tapecaster 2535
Scala 1050
Marconi Wireless Telegraph Company 1081
Energy-Onix 1897
Modulation Sciences 2011
Burk Technology 2716
Auditronics 2896
Jampro Antenna 104
Dayton Industrial 1070
Thompson-CSF 1509
Rust Industrial Company, Inc. 1572
Accurate Sound Corporation 2057
IGM 1273
SMC 1374
Radix 1572
Fidelipac 739
Hughey & Phillips 1738
Microwave Radio Corporation 2040
Broadcast Tools 997
Symmetrix 1953
GatesAir 1103
Hallicrafters 2277
Kenwood 1604
Kyocera 1860
Teac 643
Wheatstone Corporation 357
Gorman-Redlich 1421
Studer International AG 1145
Data Systems Design 1269
Dana Electronics 2017
American Data 1797
Teletronix Engineering Company 1480
Tentel 1148
Taber Manufacturing and Engineering Company 1267
Standart Tape Laboratory 1193
Extel 1346
Russco 1164
Automated Broadcast Controls 1380
Electrovoice 1181
Jennings 1181
Wegener Communications 1130
Midwest Communications 1101
Aston 1484
Farallon 1191
Kenneth A. Bacon Associates 1048
J. G. S. Engineering Inc. 1159
Continental Satellite Systems 1151
ComStream 1676
Conex Electro Systems 1071
Denon 1298
Multi-technical Services 1103
Electronic Signal Products 1323
Lorain Products Corporation 1183
C & D Batteries 2018
Nova Systems, Inc. 1059
Nortronics 2272
Norcom 1436
Lambda Electronics Corp. 1484
US Audio 1150
Jensen Transformers 1192
Garner Industries 1086
Sescom 1245
Soltec 1264
Peak Audio 1068
MCI 1517
MEI 2247
Minicom Division of 3M 1650
Metrotech 1895
Lang Electronics 1119
Kinght-kit 1587
Cetec Broadcast Group 2048
Computer Concepts 1342
Dataworld 1275
National Association of Broadcasters 1638
Link, Fred M 1129
Weston 1582
Yokogawa Electric Works 1248
Measurements 1612
Electronics Digest 339
Gregg Laboratories 1217
Leeds & Northrup Company 1190
Video Systems of America 1075
Simpson Electric Company 1209
Triplett 1028
Boonton Radio Corporation 1095
Ohmite Manufacturing Company 1322
Contel ASC 861
Audi-Cord Corporation 943
Johnson Electronics 836
Telefile Computer Products, Inc. 1038
Realistic 746
Thordarson 745
Sine Systems 934
Telos 820
Harris Allied 750
Broadcasters General Store 1001
QRK 860
BME - Broadcast Management Engineering Magazine 1673
Radio Business Report 718
UMC Beaucart 685
Armstrong Transmitter Corporation 5773
Cablewave Systems 708
Aristocart 841
Elgin Electronics 758
Goldline 647
NAD Electronics 1106
Will-Burt Company 229
Valcom 38

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