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 15205
PhpWikiAdministration 1284
Help/EditMetaDataPlugin 1090
Help/RedirectToPlugin 1121
TextFormattingRules 6381
OldTextFormattingRules 490
RedirectToPlugin 472
NewMarkupTestPage 503
OldMarkupTestPage 461
IncludePagePlugin 735
AmperexElectronicCorporation 1332
DeltaElectronics 2586
EimacDivisionOfVarian 1106
GatesRadioCompany 2419
GatesRadioCatalog99 601
GeneralElectric 205
GeneralRadio 4024
HallikainenAndFriends 2102
MoseleyAssociatesInc 840
Motorola 1104
National 1018
NemsClarke 1176
RCA 2919
WesternElectric 1978
Technics 1275
Westinghouse 1052
MilitaryRadio 1127
Historic Papers 1139
Station Histories 856
Ratheon 438
Raytheon 1573
EfJohnson 1034
American Electronic Laboratories 1675
Victoreen Instrument Company 1142
Anton Electronic Laboratories 1283
Collins Radio 2610
HoweTech 1037
Belar Electronics Laboratory 2823
Ampex 2438
Harris Corporation - Broadcast Division 1439
Dorrough Electronics 1423
Radio Engineering Laboratories 1011
Standard Electronics 950
Amalgamated Wireless (Australiasia) Ltd. 1828
Byer Industries 1002
Circuit Research Laboratories 405
Bauer Electronics Corporation 1156
Trimax 957
United Transformer Corporation 977
template 467
Philips 1178
McMartin 494
ITA 1102
Continental Electronics 306
Magnecord 948
TFT, Inc. 899
Schafer Automation 1539
Gentner 1189
Texar 1300
Langevin 1332
Altec 2150
CBS Labs 286
Pultec 954
Sony 771
3M 789
UREI 539
Frese and Kaping 1327
Revox 720
Federated Purchaser 881
CCA 544
LPB 3732
Hollyanne 895
Telfax 874
Help/OldTextFormattingRules 505
AmministrazioneDiPhpWiki 543
Help/NewMarkupTestPage 490
Help/NewMarkupTestPage 490
Help/NewMarkupTestPage 490
Help/OldMarkupTestPage 481
Help/OldMarkupTestPage 481
Help/OldMarkupTestPage 481
Larcan 1726
Tepco 1057
Standard Telephones & Cables. Australia 915
Presto 990
Straight Wire Audio 917
Arrakis Systems, Inc 2148
Consolidated Electronic Industries 950
Aphex Systems Limited 1343
QEI 3482
Multronics 920
ITC 999
Machlett Laboratories 1083
Cutting Edge Technologies 983
Bext 1458
Tektronix 799
Electronics Research, Inc. 856
Advanced Research & Technology 1942
Marantz 1109
Microcon 929
Broadcast Television Systems 962
Bosch 1093
dbx 205
Otari 1274
Crown 2829
Broadcast Electronics 2741
ATI 1525
Scully 1099
Marti Electronics, Inc. 356
Harman Kardon 1209
Potomac Instruments 519
Broadcast Audio 2352
Andrew Corporation 503
Audio Arts 1181
Bird Electronic Corporation 1625
Dumont 1554
Autogram 4412
Radio Engineering 539
Heathkit 930
Mullard 936
NBC 1094
Amperite 1296
McIntosh 1457
Inovonics 1694
Neotek 1964
Moulic Specialties Co. 895
Engineering Services 981
IRC 1326
ESE 2734
Comtech Antenna Corporation 1196
Panasonic 1089
Orban 2654
Studer 956
Coastcom 1030
Clear-Com 953
Dolby Laboratories 442
CSI 2213
Bell Telephone Laboratories 1552
Pacific Recorders and Engineers 1399
Hewlett Packard 694
Sparta Electronics 1022
Tapecaster 2562
Scala 1059
Marconi Wireless Telegraph Company 1087
Energy-Onix 1912
Modulation Sciences 2032
Burk Technology 2743
Auditronics 2931
Jampro Antenna 126
Dayton Industrial 1129
Thompson-CSF 1530
Rust Industrial Company, Inc. 1586
Accurate Sound Corporation 2078
IGM 1286
SMC 1390
Radix 1598
Fidelipac 774
Hughey & Phillips 1771
Microwave Radio Corporation 2060
Broadcast Tools 1049
Symmetrix 1980
GatesAir 1109
Hallicrafters 2297
Kenwood 1624
Kyocera 1885
Teac 682
Wheatstone Corporation 380
Gorman-Redlich 1438
Studer International AG 1160
Data Systems Design 1282
Dana Electronics 2034
American Data 1821
Teletronix Engineering Company 1494
Tentel 1158
Taber Manufacturing and Engineering Company 1276
Standart Tape Laboratory 1206
Extel 1358
Russco 1175
Automated Broadcast Controls 1395
Electrovoice 1196
Jennings 1193
Wegener Communications 1138
Midwest Communications 1112
Aston 1498
Farallon 1206
Kenneth A. Bacon Associates 1060
J. G. S. Engineering Inc. 1171
Continental Satellite Systems 1166
ComStream 1694
Conex Electro Systems 1082
Denon 1308
Multi-technical Services 1120
Electronic Signal Products 1342
Lorain Products Corporation 1199
C & D Batteries 2037
Nova Systems, Inc. 1068
Nortronics 2295
Norcom 1447
Lambda Electronics Corp. 1499
US Audio 1163
Jensen Transformers 1203
Garner Industries 1097
Sescom 1260
Soltec 1278
Peak Audio 1082
MCI 1540
MEI 2278
Minicom Division of 3M 1669
Metrotech 1912
Lang Electronics 1133
Kinght-kit 1605
Cetec Broadcast Group 2070
Computer Concepts 1352
Dataworld 1285
National Association of Broadcasters 1658
Link, Fred M 1142
Weston 1604
Yokogawa Electric Works 1260
Measurements 1635
Electronics Digest 357
Gregg Laboratories 1229
Leeds & Northrup Company 1206
Video Systems of America 1092
Simpson Electric Company 1222
Triplett 1044
Boonton Radio Corporation 1105
Ohmite Manufacturing Company 1340
Contel ASC 876
Audi-Cord Corporation 956
Johnson Electronics 848
Telefile Computer Products, Inc. 1050
Realistic 757
Thordarson 760
Sine Systems 951
Telos 835
Harris Allied 764
Broadcasters General Store 1021
QRK 876
BME - Broadcast Management Engineering Magazine 1691
Radio Business Report 734
UMC Beaucart 702
Armstrong Transmitter Corporation 5784
Cablewave Systems 717
Aristocart 862
Elgin Electronics 769
Goldline 663
NAD Electronics 1120
Will-Burt Company 242
Valcom 92

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