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 15364
PhpWikiAdministration 1298
Help/EditMetaDataPlugin 1105
Help/RedirectToPlugin 1129
TextFormattingRules 6419
OldTextFormattingRules 495
RedirectToPlugin 474
NewMarkupTestPage 511
OldMarkupTestPage 471
IncludePagePlugin 741
AmperexElectronicCorporation 1350
DeltaElectronics 2744
EimacDivisionOfVarian 1116
GatesRadioCompany 2547
GatesRadioCatalog99 605
GeneralElectric 237
GeneralRadio 4165
HallikainenAndFriends 2205
MoseleyAssociatesInc 871
Motorola 1115
National 1033
NemsClarke 1188
RCA 3047
WesternElectric 1993
Technics 1286
Westinghouse 1061
MilitaryRadio 1179
Historic Papers 1259
Station Histories 889
Ratheon 444
Raytheon 1590
EfJohnson 1043
American Electronic Laboratories 1712
Victoreen Instrument Company 1151
Anton Electronic Laboratories 1300
Collins Radio 2721
HoweTech 1046
Belar Electronics Laboratory 2843
Ampex 2497
Harris Corporation - Broadcast Division 1509
Dorrough Electronics 1466
Radio Engineering Laboratories 1019
Standard Electronics 957
Amalgamated Wireless (Australiasia) Ltd. 1839
Byer Industries 1007
Circuit Research Laboratories 432
Bauer Electronics Corporation 1165
Trimax 965
United Transformer Corporation 987
template 476
Philips 1189
McMartin 517
ITA 1109
Continental Electronics 350
Magnecord 954
TFT, Inc. 918
Schafer Automation 1554
Gentner 1284
Texar 1315
Langevin 1343
Altec 2171
CBS Labs 303
Pultec 965
Sony 799
3M 824
UREI 561
Frese and Kaping 1344
Revox 752
Federated Purchaser 890
CCA 571
LPB 3756
Hollyanne 906
Telfax 885
Help/OldTextFormattingRules 513
AmministrazioneDiPhpWiki 548
Help/NewMarkupTestPage 495
Help/NewMarkupTestPage 495
Help/NewMarkupTestPage 495
Help/OldMarkupTestPage 489
Help/OldMarkupTestPage 489
Help/OldMarkupTestPage 489
Larcan 1738
Tepco 1066
Standard Telephones & Cables. Australia 925
Presto 1002
Straight Wire Audio 925
Arrakis Systems, Inc 2165
Consolidated Electronic Industries 958
Aphex Systems Limited 1359
QEI 3496
Multronics 932
ITC 1035
Machlett Laboratories 1093
Cutting Edge Technologies 990
Bext 1470
Tektronix 832
Electronics Research, Inc. 865
Advanced Research & Technology 1960
Marantz 1123
Microcon 938
Broadcast Television Systems 969
Bosch 1100
dbx 217
Otari 1288
Crown 2854
Broadcast Electronics 2826
ATI 1538
Scully 1108
Marti Electronics, Inc. 367
Harman Kardon 1220
Potomac Instruments 546
Broadcast Audio 2367
Andrew Corporation 530
Audio Arts 1191
Bird Electronic Corporation 1890
Dumont 1565
Autogram 4450
Radio Engineering 545
Heathkit 974
Mullard 949
NBC 1101
Amperite 1309
McIntosh 1468
Inovonics 1706
Neotek 1982
Moulic Specialties Co. 903
Engineering Services 992
IRC 1338
ESE 2752
Comtech Antenna Corporation 1206
Panasonic 1127
Orban 2676
Studer 966
Coastcom 1041
Clear-Com 961
Dolby Laboratories 456
CSI 2230
Bell Telephone Laboratories 1565
Pacific Recorders and Engineers 1415
Hewlett Packard 719
Sparta Electronics 1055
Tapecaster 2574
Scala 1069
Marconi Wireless Telegraph Company 1097
Energy-Onix 1935
Modulation Sciences 2045
Burk Technology 2767
Auditronics 2953
Jampro Antenna 140
Dayton Industrial 1181
Thompson-CSF 1542
Rust Industrial Company, Inc. 1593
Accurate Sound Corporation 2102
IGM 1296
SMC 1399
Radix 1608
Fidelipac 804
Hughey & Phillips 1798
Microwave Radio Corporation 2072
Broadcast Tools 1086
Symmetrix 1995
GatesAir 1119
Hallicrafters 2308
Kenwood 1635
Kyocera 1902
Teac 706
Wheatstone Corporation 389
Gorman-Redlich 1453
Studer International AG 1174
Data Systems Design 1290
Dana Electronics 2042
American Data 1845
Teletronix Engineering Company 1503
Tentel 1166
Taber Manufacturing and Engineering Company 1285
Standart Tape Laboratory 1217
Extel 1370
Russco 1183
Automated Broadcast Controls 1402
Electrovoice 1207
Jennings 1204
Wegener Communications 1147
Midwest Communications 1125
Aston 1506
Farallon 1219
Kenneth A. Bacon Associates 1067
J. G. S. Engineering Inc. 1179
Continental Satellite Systems 1181
ComStream 1706
Conex Electro Systems 1090
Denon 1317
Multi-technical Services 1132
Electronic Signal Products 1366
Lorain Products Corporation 1211
C & D Batteries 2061
Nova Systems, Inc. 1077
Nortronics 2310
Norcom 1457
Lambda Electronics Corp. 1511
US Audio 1171
Jensen Transformers 1212
Garner Industries 1105
Sescom 1271
Soltec 1286
Peak Audio 1093
MCI 1554
MEI 2296
Minicom Division of 3M 1678
Metrotech 1935
Lang Electronics 1140
Kinght-kit 1613
Cetec Broadcast Group 2091
Computer Concepts 1361
Dataworld 1296
National Association of Broadcasters 1672
Link, Fred M 1151
Weston 1618
Yokogawa Electric Works 1269
Measurements 1646
Electronics Digest 371
Gregg Laboratories 1237
Leeds & Northrup Company 1214
Video Systems of America 1120
Simpson Electric Company 1228
Triplett 1056
Boonton Radio Corporation 1111
Ohmite Manufacturing Company 1347
Contel ASC 885
Audi-Cord Corporation 964
Johnson Electronics 855
Telefile Computer Products, Inc. 1059
Realistic 765
Thordarson 767
Sine Systems 960
Telos 845
Harris Allied 774
Broadcasters General Store 1048
QRK 885
BME - Broadcast Management Engineering Magazine 1706
Radio Business Report 750
UMC Beaucart 711
Armstrong Transmitter Corporation 5795
Cablewave Systems 725
Aristocart 886
Elgin Electronics 779
Goldline 671
NAD Electronics 1129
Will-Burt Company 250
Valcom 110

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