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 16368
PhpWikiAdministration 1453
Help/EditMetaDataPlugin 1222
Help/RedirectToPlugin 1205
TextFormattingRules 7154
OldTextFormattingRules 559
RedirectToPlugin 521
NewMarkupTestPage 576
OldMarkupTestPage 568
IncludePagePlugin 834
AmperexElectronicCorporation 1454
DeltaElectronics 3184
EimacDivisionOfVarian 1215
GatesRadioCompany 4788
GatesRadioCatalog99 684
GeneralElectric 628
GeneralRadio 7843
HallikainenAndFriends 4214
MoseleyAssociatesInc 1413
Motorola 1243
National 1133
NemsClarke 1319
RCA 6207
WesternElectric 2253
Technics 1385
Westinghouse 1136
MilitaryRadio 2194
Historic Papers 3226
Station Histories 1509
Ratheon 519
Raytheon 1723
EfJohnson 1117
American Electronic Laboratories 1879
Victoreen Instrument Company 1261
Anton Electronic Laboratories 1399
Collins Radio 4936
HoweTech 1111
Belar Electronics Laboratory 3125
Ampex 4406
Harris Corporation - Broadcast Division 2758
Dorrough Electronics 2289
Radio Engineering Laboratories 1103
Standard Electronics 1024
Amalgamated Wireless (Australiasia) Ltd. 1979
Byer Industries 1095
Circuit Research Laboratories 600
Bauer Electronics Corporation 1251
Trimax 1040
United Transformer Corporation 1079
template 561
Philips 1297
McMartin 881
ITA 1190
Continental Electronics 959
Magnecord 1036
TFT, Inc. 1600
Schafer Automation 1702
Gentner 2361
Texar 1456
Langevin 1498
Altec 2361
CBS Labs 728
Pultec 1052
Sony 1345
3M 1486
UREI 882
Frese and Kaping 1466
Revox 1297
Federated Purchaser 1004
CCA 918
LPB 4122
Hollyanne 1008
Telfax 974
Help/OldTextFormattingRules 568
AmministrazioneDiPhpWiki 605
Help/NewMarkupTestPage 550
Help/NewMarkupTestPage 550
Help/NewMarkupTestPage 550
Help/OldMarkupTestPage 549
Help/OldMarkupTestPage 549
Help/OldMarkupTestPage 549
Larcan 1898
Tepco 1156
Standard Telephones & Cables. Australia 1048
Presto 1105
Straight Wire Audio 1019
Arrakis Systems, Inc 2403
Consolidated Electronic Industries 1062
Aphex Systems Limited 1451
QEI 3975
Multronics 1017
ITC 1592
Machlett Laboratories 1207
Cutting Edge Technologies 1060
Bext 1580
Tektronix 1351
Electronics Research, Inc. 920
Advanced Research & Technology 2110
Marantz 1241
Microcon 1021
Broadcast Television Systems 1040
Bosch 1186
dbx 629
Otari 1430
Crown 3286
Broadcast Electronics 5111
ATI 1717
Scully 1224
Marti Electronics, Inc. 705
Harman Kardon 1328
Potomac Instruments 1043
Broadcast Audio 2652
Andrew Corporation 922
Audio Arts 1301
Bird Electronic Corporation 10567
Dumont 1698
Autogram 5179
Radio Engineering 606
Heathkit 1702
Mullard 1030
NBC 1195
Amperite 1407
McIntosh 1629
Inovonics 1934
Neotek 2189
Moulic Specialties Co. 979
Engineering Services 1103
IRC 1453
ESE 3164
Comtech Antenna Corporation 1328
Panasonic 2048
Orban 2967
Studer 1059
Coastcom 1148
Clear-Com 1043
Dolby Laboratories 695
CSI 2476
Bell Telephone Laboratories 1741
Pacific Recorders and Engineers 1553
Hewlett Packard 1243
Sparta Electronics 1812
Tapecaster 2923
Scala 1168
Marconi Wireless Telegraph Company 1171
Energy-Onix 2142
Modulation Sciences 2280
Burk Technology 3109
Auditronics 3270
Jampro Antenna 421
Dayton Industrial 2013
Thompson-CSF 1729
Rust Industrial Company, Inc. 1765
Accurate Sound Corporation 2272
IGM 1403
SMC 1542
Radix 1783
Fidelipac 1249
Hughey & Phillips 2018
Microwave Radio Corporation 2274
Broadcast Tools 1732
Symmetrix 2261
GatesAir 1216
Hallicrafters 2602
Kenwood 1798
Kyocera 2121
Teac 1130
Wheatstone Corporation 680
Gorman-Redlich 1589
Studer International AG 1298
Data Systems Design 1401
Dana Electronics 2227
American Data 2008
Teletronix Engineering Company 1634
Tentel 1283
Taber Manufacturing and Engineering Company 1388
Standart Tape Laboratory 1326
Extel 1493
Russco 1299
Automated Broadcast Controls 1520
Electrovoice 1329
Jennings 1309
Wegener Communications 1246
Midwest Communications 1253
Aston 1634
Farallon 1336
Kenneth A. Bacon Associates 1200
J. G. S. Engineering Inc. 1289
Continental Satellite Systems 1295
ComStream 1919
Conex Electro Systems 1195
Denon 1427
Multi-technical Services 1255
Electronic Signal Products 1507
Lorain Products Corporation 1317
C & D Batteries 2322
Nova Systems, Inc. 1157
Nortronics 2597
Norcom 1585
Lambda Electronics Corp. 1679
US Audio 1269
Jensen Transformers 1318
Garner Industries 1210
Sescom 1400
Soltec 1420
Peak Audio 1197
MCI 1711
MEI 2610
Minicom Division of 3M 1841
Metrotech 2129
Lang Electronics 1227
Kinght-kit 1786
Cetec Broadcast Group 2320
Computer Concepts 1481
Dataworld 1410
National Association of Broadcasters 1810
Link, Fred M 1270
Weston 1790
Yokogawa Electric Works 1370
Measurements 1801
Electronics Digest 583
Gregg Laboratories 1359
Leeds & Northrup Company 1342
Video Systems of America 1228
Simpson Electric Company 1330
Triplett 1163
Boonton Radio Corporation 1217
Ohmite Manufacturing Company 1437
Contel ASC 979
Audi-Cord Corporation 1065
Johnson Electronics 954
Telefile Computer Products, Inc. 1152
Realistic 866
Thordarson 873
Sine Systems 1122
Telos 952
Harris Allied 891
Broadcasters General Store 1187
QRK 997
BME - Broadcast Management Engineering Magazine 1837
Radio Business Report 861
UMC Beaucart 833
Armstrong Transmitter Corporation 5930
Cablewave Systems 823
Aristocart 1014
Elgin Electronics 888
Goldline 784
NAD Electronics 1232
Will-Burt Company 389
Valcom 391

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