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 14946
PhpWikiAdministration 1269
Help/EditMetaDataPlugin 1077
Help/RedirectToPlugin 1112
TextFormattingRules 6236
OldTextFormattingRules 488
RedirectToPlugin 470
NewMarkupTestPage 499
OldMarkupTestPage 456
IncludePagePlugin 726
AmperexElectronicCorporation 1326
DeltaElectronics 2528
EimacDivisionOfVarian 1096
GatesRadioCompany 2271
GatesRadioCatalog99 598
GeneralElectric 167
GeneralRadio 3858
HallikainenAndFriends 1967
MoseleyAssociatesInc 798
Motorola 1094
National 1010
NemsClarke 1164
RCA 2599
WesternElectric 1964
Technics 1261
Westinghouse 1045
MilitaryRadio 1060
Historic Papers 970
Station Histories 819
Ratheon 432
Raytheon 1554
EfJohnson 1026
American Electronic Laboratories 1662
Victoreen Instrument Company 1136
Anton Electronic Laboratories 1276
Collins Radio 2437
HoweTech 1031
Belar Electronics Laboratory 2795
Ampex 2312
Harris Corporation - Broadcast Division 1326
Dorrough Electronics 1333
Radio Engineering Laboratories 996
Standard Electronics 944
Amalgamated Wireless (Australiasia) Ltd. 1813
Byer Industries 996
Circuit Research Laboratories 392
Bauer Electronics Corporation 1151
Trimax 951
United Transformer Corporation 965
template 459
Philips 1167
McMartin 470
ITA 1097
Continental Electronics 260
Magnecord 942
TFT, Inc. 837
Schafer Automation 1526
Gentner 1085
Texar 1288
Langevin 1319
Altec 2135
CBS Labs 257
Pultec 945
Sony 707
3M 732
UREI 505
Frese and Kaping 1313
Revox 657
Federated Purchaser 871
CCA 508
LPB 3705
Hollyanne 888
Telfax 865
Help/OldTextFormattingRules 497
AmministrazioneDiPhpWiki 541
Help/NewMarkupTestPage 486
Help/NewMarkupTestPage 486
Help/NewMarkupTestPage 486
Help/OldMarkupTestPage 475
Help/OldMarkupTestPage 475
Help/OldMarkupTestPage 475
Larcan 1707
Tepco 1051
Standard Telephones & Cables. Australia 903
Presto 983
Straight Wire Audio 912
Arrakis Systems, Inc 2129
Consolidated Electronic Industries 940
Aphex Systems Limited 1334
QEI 3448
Multronics 912
ITC 928
Machlett Laboratories 1077
Cutting Edge Technologies 978
Bext 1444
Tektronix 767
Electronics Research, Inc. 851
Advanced Research & Technology 1929
Marantz 1095
Microcon 925
Broadcast Television Systems 955
Bosch 1089
dbx 139
Otari 1258
Crown 2813
Broadcast Electronics 2623
ATI 1511
Scully 1092
Marti Electronics, Inc. 337
Harman Kardon 1195
Potomac Instruments 466
Broadcast Audio 2332
Andrew Corporation 476
Audio Arts 1174
Bird Electronic Corporation 1422
Dumont 1542
Autogram 4353
Radio Engineering 535
Heathkit 859
Mullard 932
NBC 1089
Amperite 1290
McIntosh 1441
Inovonics 1681
Neotek 1946
Moulic Specialties Co. 891
Engineering Services 973
IRC 1312
ESE 2707
Comtech Antenna Corporation 1185
Panasonic 1024
Orban 2627
Studer 946
Coastcom 1020
Clear-Com 947
Dolby Laboratories 423
CSI 2184
Bell Telephone Laboratories 1539
Pacific Recorders and Engineers 1386
Hewlett Packard 649
Sparta Electronics 961
Tapecaster 2535
Scala 1052
Marconi Wireless Telegraph Company 1082
Energy-Onix 1898
Modulation Sciences 2013
Burk Technology 2719
Auditronics 2899
Jampro Antenna 106
Dayton Industrial 1070
Thompson-CSF 1509
Rust Industrial Company, Inc. 1574
Accurate Sound Corporation 2061
IGM 1274
SMC 1374
Radix 1575
Fidelipac 741
Hughey & Phillips 1740
Microwave Radio Corporation 2041
Broadcast Tools 999
Symmetrix 1955
GatesAir 1104
Hallicrafters 2278
Kenwood 1606
Kyocera 1862
Teac 645
Wheatstone Corporation 358
Gorman-Redlich 1422
Studer International AG 1146
Data Systems Design 1272
Dana Electronics 2019
American Data 1802
Teletronix Engineering Company 1481
Tentel 1150
Taber Manufacturing and Engineering Company 1268
Standart Tape Laboratory 1195
Extel 1348
Russco 1166
Automated Broadcast Controls 1382
Electrovoice 1181
Jennings 1182
Wegener Communications 1131
Midwest Communications 1103
Aston 1486
Farallon 1193
Kenneth A. Bacon Associates 1049
J. G. S. Engineering Inc. 1162
Continental Satellite Systems 1152
ComStream 1676
Conex Electro Systems 1072
Denon 1298
Multi-technical Services 1106
Electronic Signal Products 1328
Lorain Products Corporation 1186
C & D Batteries 2020
Nova Systems, Inc. 1063
Nortronics 2275
Norcom 1438
Lambda Electronics Corp. 1485
US Audio 1152
Jensen Transformers 1195
Garner Industries 1087
Sescom 1248
Soltec 1266
Peak Audio 1070
MCI 1520
MEI 2250
Minicom Division of 3M 1653
Metrotech 1899
Lang Electronics 1122
Kinght-kit 1589
Cetec Broadcast Group 2050
Computer Concepts 1344
Dataworld 1276
National Association of Broadcasters 1641
Link, Fred M 1130
Weston 1584
Yokogawa Electric Works 1250
Measurements 1614
Electronics Digest 340
Gregg Laboratories 1219
Leeds & Northrup Company 1192
Video Systems of America 1080
Simpson Electric Company 1210
Triplett 1029
Boonton Radio Corporation 1097
Ohmite Manufacturing Company 1325
Contel ASC 863
Audi-Cord Corporation 945
Johnson Electronics 837
Telefile Computer Products, Inc. 1040
Realistic 747
Thordarson 747
Sine Systems 935
Telos 822
Harris Allied 751
Broadcasters General Store 1005
QRK 861
BME - Broadcast Management Engineering Magazine 1675
Radio Business Report 720
UMC Beaucart 686
Armstrong Transmitter Corporation 5774
Cablewave Systems 708
Aristocart 846
Elgin Electronics 759
Goldline 650
NAD Electronics 1109
Will-Burt Company 229
Valcom 51

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