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 15873
PhpWikiAdministration 1373
Help/EditMetaDataPlugin 1167
Help/RedirectToPlugin 1168
TextFormattingRules 6775
OldTextFormattingRules 523
RedirectToPlugin 497
NewMarkupTestPage 535
OldMarkupTestPage 525
IncludePagePlugin 791
AmperexElectronicCorporation 1406
DeltaElectronics 2976
EimacDivisionOfVarian 1171
GatesRadioCompany 3876
GatesRadioCatalog99 635
GeneralElectric 442
GeneralRadio 6155
HallikainenAndFriends 3384
MoseleyAssociatesInc 1164
Motorola 1188
National 1088
NemsClarke 1257
RCA 4842
WesternElectric 2118
Technics 1331
Westinghouse 1100
MilitaryRadio 1795
Historic Papers 2476
Station Histories 1238
Ratheon 486
Raytheon 1651
EfJohnson 1084
American Electronic Laboratories 1810
Victoreen Instrument Company 1218
Anton Electronic Laboratories 1358
Collins Radio 4015
HoweTech 1082
Belar Electronics Laboratory 2978
Ampex 3628
Harris Corporation - Broadcast Division 2276
Dorrough Electronics 1931
Radio Engineering Laboratories 1060
Standard Electronics 993
Amalgamated Wireless (Australiasia) Ltd. 1914
Byer Industries 1056
Circuit Research Laboratories 509
Bauer Electronics Corporation 1208
Trimax 1007
United Transformer Corporation 1040
template 515
Philips 1239
McMartin 721
ITA 1157
Continental Electronics 698
Magnecord 997
TFT, Inc. 1270
Schafer Automation 1632
Gentner 1916
Texar 1383
Langevin 1423
Altec 2282
CBS Labs 541
Pultec 1012
Sony 1095
3M 1143
UREI 763
Frese and Kaping 1405
Revox 1022
Federated Purchaser 958
CCA 765
LPB 3947
Hollyanne 963
Telfax 932
Help/OldTextFormattingRules 540
AmministrazioneDiPhpWiki 577
Help/NewMarkupTestPage 527
Help/NewMarkupTestPage 527
Help/NewMarkupTestPage 527
Help/OldMarkupTestPage 523
Help/OldMarkupTestPage 523
Help/OldMarkupTestPage 523
Larcan 1822
Tepco 1117
Standard Telephones & Cables. Australia 996
Presto 1056
Straight Wire Audio 959
Arrakis Systems, Inc 2283
Consolidated Electronic Industries 1013
Aphex Systems Limited 1408
QEI 3727
Multronics 976
ITC 1336
Machlett Laboratories 1161
Cutting Edge Technologies 1026
Bext 1524
Tektronix 1099
Electronics Research, Inc. 893
Advanced Research & Technology 2041
Marantz 1184
Microcon 979
Broadcast Television Systems 1008
Bosch 1148
dbx 421
Otari 1362
Crown 3076
Broadcast Electronics 4103
ATI 1645
Scully 1172
Marti Electronics, Inc. 572
Harman Kardon 1273
Potomac Instruments 801
Broadcast Audio 2494
Andrew Corporation 784
Audio Arts 1251
Bird Electronic Corporation 6870
Dumont 1628
Autogram 4812
Radio Engineering 576
Heathkit 1393
Mullard 989
NBC 1151
Amperite 1363
McIntosh 1561
Inovonics 1817
Neotek 2082
Moulic Specialties Co. 943
Engineering Services 1063
IRC 1401
ESE 2974
Comtech Antenna Corporation 1275
Panasonic 1625
Orban 2854
Studer 1018
Coastcom 1098
Clear-Com 1005
Dolby Laboratories 587
CSI 2356
Bell Telephone Laboratories 1662
Pacific Recorders and Engineers 1494
Hewlett Packard 968
Sparta Electronics 1496
Tapecaster 2793
Scala 1124
Marconi Wireless Telegraph Company 1138
Energy-Onix 2050
Modulation Sciences 2180
Burk Technology 2947
Auditronics 3104
Jampro Antenna 301
Dayton Industrial 1659
Thompson-CSF 1643
Rust Industrial Company, Inc. 1679
Accurate Sound Corporation 2199
IGM 1351
SMC 1474
Radix 1690
Fidelipac 1075
Hughey & Phillips 1920
Microwave Radio Corporation 2162
Broadcast Tools 1421
Symmetrix 2114
GatesAir 1184
Hallicrafters 2440
Kenwood 1722
Kyocera 2016
Teac 914
Wheatstone Corporation 541
Gorman-Redlich 1530
Studer International AG 1239
Data Systems Design 1351
Dana Electronics 2141
American Data 1934
Teletronix Engineering Company 1574
Tentel 1222
Taber Manufacturing and Engineering Company 1337
Standart Tape Laboratory 1273
Extel 1433
Russco 1238
Automated Broadcast Controls 1457
Electrovoice 1274
Jennings 1258
Wegener Communications 1201
Midwest Communications 1205
Aston 1572
Farallon 1276
Kenneth A. Bacon Associates 1133
J. G. S. Engineering Inc. 1230
Continental Satellite Systems 1233
ComStream 1825
Conex Electro Systems 1136
Denon 1370
Multi-technical Services 1197
Electronic Signal Products 1448
Lorain Products Corporation 1273
C & D Batteries 2206
Nova Systems, Inc. 1119
Nortronics 2443
Norcom 1525
Lambda Electronics Corp. 1608
US Audio 1222
Jensen Transformers 1260
Garner Industries 1151
Sescom 1340
Soltec 1354
Peak Audio 1144
MCI 1642
MEI 2472
Minicom Division of 3M 1758
Metrotech 2032
Lang Electronics 1185
Kinght-kit 1704
Cetec Broadcast Group 2223
Computer Concepts 1421
Dataworld 1350
National Association of Broadcasters 1755
Link, Fred M 1222
Weston 1706
Yokogawa Electric Works 1323
Measurements 1725
Electronics Digest 486
Gregg Laboratories 1291
Leeds & Northrup Company 1287
Video Systems of America 1181
Simpson Electric Company 1285
Triplett 1112
Boonton Radio Corporation 1160
Ohmite Manufacturing Company 1399
Contel ASC 930
Audi-Cord Corporation 1012
Johnson Electronics 907
Telefile Computer Products, Inc. 1106
Realistic 818
Thordarson 818
Sine Systems 1043
Telos 897
Harris Allied 832
Broadcasters General Store 1116
QRK 947
BME - Broadcast Management Engineering Magazine 1783
Radio Business Report 804
UMC Beaucart 781
Armstrong Transmitter Corporation 5850
Cablewave Systems 773
Aristocart 949
Elgin Electronics 835
Goldline 727
NAD Electronics 1178
Will-Burt Company 326
Valcom 277

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