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 16374
PhpWikiAdministration 1456
Help/EditMetaDataPlugin 1222
Help/RedirectToPlugin 1206
TextFormattingRules 7171
OldTextFormattingRules 560
RedirectToPlugin 522
NewMarkupTestPage 576
OldMarkupTestPage 569
IncludePagePlugin 834
AmperexElectronicCorporation 1454
DeltaElectronics 3188
EimacDivisionOfVarian 1217
GatesRadioCompany 4818
GatesRadioCatalog99 685
GeneralElectric 631
GeneralRadio 7912
HallikainenAndFriends 4236
MoseleyAssociatesInc 1420
Motorola 1243
National 1134
NemsClarke 1320
RCA 6238
WesternElectric 2256
Technics 1385
Westinghouse 1136
MilitaryRadio 2208
Historic Papers 3250
Station Histories 1523
Ratheon 519
Raytheon 1725
EfJohnson 1119
American Electronic Laboratories 1881
Victoreen Instrument Company 1265
Anton Electronic Laboratories 1399
Collins Radio 4976
HoweTech 1111
Belar Electronics Laboratory 3129
Ampex 4436
Harris Corporation - Broadcast Division 2777
Dorrough Electronics 2308
Radio Engineering Laboratories 1104
Standard Electronics 1024
Amalgamated Wireless (Australiasia) Ltd. 1981
Byer Industries 1096
Circuit Research Laboratories 602
Bauer Electronics Corporation 1254
Trimax 1040
United Transformer Corporation 1079
template 562
Philips 1298
McMartin 887
ITA 1192
Continental Electronics 967
Magnecord 1039
TFT, Inc. 1608
Schafer Automation 1703
Gentner 2367
Texar 1457
Langevin 1499
Altec 2362
CBS Labs 731
Pultec 1052
Sony 1350
3M 1492
UREI 887
Frese and Kaping 1467
Revox 1309
Federated Purchaser 1005
CCA 920
LPB 4127
Hollyanne 1008
Telfax 976
Help/OldTextFormattingRules 568
AmministrazioneDiPhpWiki 605
Help/NewMarkupTestPage 551
Help/NewMarkupTestPage 551
Help/NewMarkupTestPage 551
Help/OldMarkupTestPage 549
Help/OldMarkupTestPage 549
Help/OldMarkupTestPage 549
Larcan 1900
Tepco 1158
Standard Telephones & Cables. Australia 1049
Presto 1105
Straight Wire Audio 1021
Arrakis Systems, Inc 2408
Consolidated Electronic Industries 1062
Aphex Systems Limited 1451
QEI 3980
Multronics 1017
ITC 1604
Machlett Laboratories 1207
Cutting Edge Technologies 1061
Bext 1581
Tektronix 1357
Electronics Research, Inc. 921
Advanced Research & Technology 2110
Marantz 1243
Microcon 1023
Broadcast Television Systems 1040
Bosch 1187
dbx 632
Otari 1430
Crown 3288
Broadcast Electronics 5158
ATI 1719
Scully 1224
Marti Electronics, Inc. 710
Harman Kardon 1331
Potomac Instruments 1046
Broadcast Audio 2653
Andrew Corporation 923
Audio Arts 1301
Bird Electronic Corporation 10798
Dumont 1699
Autogram 5188
Radio Engineering 606
Heathkit 1710
Mullard 1031
NBC 1196
Amperite 1407
McIntosh 1630
Inovonics 1937
Neotek 2193
Moulic Specialties Co. 982
Engineering Services 1103
IRC 1454
ESE 3167
Comtech Antenna Corporation 1330
Panasonic 2056
Orban 2969
Studer 1060
Coastcom 1148
Clear-Com 1044
Dolby Laboratories 697
CSI 2477
Bell Telephone Laboratories 1742
Pacific Recorders and Engineers 1555
Hewlett Packard 1244
Sparta Electronics 1820
Tapecaster 2926
Scala 1169
Marconi Wireless Telegraph Company 1174
Energy-Onix 2148
Modulation Sciences 2282
Burk Technology 3112
Auditronics 3280
Jampro Antenna 427
Dayton Industrial 2023
Thompson-CSF 1729
Rust Industrial Company, Inc. 1768
Accurate Sound Corporation 2274
IGM 1404
SMC 1543
Radix 1783
Fidelipac 1261
Hughey & Phillips 2020
Microwave Radio Corporation 2276
Broadcast Tools 1747
Symmetrix 2262
GatesAir 1217
Hallicrafters 2607
Kenwood 1799
Kyocera 2124
Teac 1134
Wheatstone Corporation 683
Gorman-Redlich 1590
Studer International AG 1300
Data Systems Design 1404
Dana Electronics 2230
American Data 2009
Teletronix Engineering Company 1636
Tentel 1285
Taber Manufacturing and Engineering Company 1392
Standart Tape Laboratory 1330
Extel 1496
Russco 1300
Automated Broadcast Controls 1521
Electrovoice 1330
Jennings 1311
Wegener Communications 1249
Midwest Communications 1257
Aston 1635
Farallon 1336
Kenneth A. Bacon Associates 1202
J. G. S. Engineering Inc. 1291
Continental Satellite Systems 1295
ComStream 1923
Conex Electro Systems 1196
Denon 1428
Multi-technical Services 1256
Electronic Signal Products 1508
Lorain Products Corporation 1319
C & D Batteries 2323
Nova Systems, Inc. 1158
Nortronics 2599
Norcom 1587
Lambda Electronics Corp. 1681
US Audio 1269
Jensen Transformers 1318
Garner Industries 1212
Sescom 1402
Soltec 1421
Peak Audio 1198
MCI 1712
MEI 2610
Minicom Division of 3M 1842
Metrotech 2132
Lang Electronics 1228
Kinght-kit 1786
Cetec Broadcast Group 2324
Computer Concepts 1484
Dataworld 1412
National Association of Broadcasters 1812
Link, Fred M 1270
Weston 1792
Yokogawa Electric Works 1372
Measurements 1802
Electronics Digest 586
Gregg Laboratories 1361
Leeds & Northrup Company 1344
Video Systems of America 1230
Simpson Electric Company 1330
Triplett 1166
Boonton Radio Corporation 1220
Ohmite Manufacturing Company 1438
Contel ASC 979
Audi-Cord Corporation 1066
Johnson Electronics 956
Telefile Computer Products, Inc. 1152
Realistic 868
Thordarson 874
Sine Systems 1123
Telos 952
Harris Allied 892
Broadcasters General Store 1188
QRK 999
BME - Broadcast Management Engineering Magazine 1838
Radio Business Report 862
UMC Beaucart 834
Armstrong Transmitter Corporation 5933
Cablewave Systems 823
Aristocart 1017
Elgin Electronics 889
Goldline 784
NAD Electronics 1235
Will-Burt Company 391
Valcom 393

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