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

248 pages link to HomePage:
|<<   << - 1 / 5 - Next >>   >>|
|<<   << - 1 / 5 - Next >>   >>|
Page Name. Hits.
Help/TextFormattingRules 14820
PhpWikiAdministration 1251
Help/EditMetaDataPlugin 1060
Help/RedirectToPlugin 1098
TextFormattingRules 6138
OldTextFormattingRules 477
RedirectToPlugin 457
NewMarkupTestPage 492
OldMarkupTestPage 445
IncludePagePlugin 719
AmperexElectronicCorporation 1307
DeltaElectronics 2470
EimacDivisionOfVarian 1084
GatesRadioCompany 2072
GatesRadioCatalog99 589
GeneralElectric 123
GeneralRadio 3555
HallikainenAndFriends 1842
MoseleyAssociatesInc 749
Motorola 1083
National 997
NemsClarke 1145
RCA 2316
WesternElectric 1937
Technics 1246
Westinghouse 1030
MilitaryRadio 981
Historic Papers 776
Station Histories 746
Ratheon 422
Raytheon 1540
EfJohnson 1015
American Electronic Laboratories 1639
Victoreen Instrument Company 1120
Anton Electronic Laboratories 1259
Collins Radio 2199
HoweTech 1021
Belar Electronics Laboratory 2770
Ampex 2173
Harris Corporation - Broadcast Division 1193
Dorrough Electronics 1259
Radio Engineering Laboratories 986
Standard Electronics 930
Amalgamated Wireless (Australiasia) Ltd. 1801
Byer Industries 985
Circuit Research Laboratories 367
Bauer Electronics Corporation 1136
Trimax 941
United Transformer Corporation 949
template 448
Philips 1151
McMartin 440
ITA 1085
Continental Electronics 219
Magnecord 928
TFT, Inc. 759
Schafer Automation 1511
Gentner 996
Texar 1268
Langevin 1306
Altec 2112
CBS Labs 222
Pultec 932
Sony 658
3M 668
UREI 466
Frese and Kaping 1295
Revox 601
Federated Purchaser 859
CCA 474
LPB 3671
Hollyanne 877
Telfax 850
Help/OldTextFormattingRules 489
AmministrazioneDiPhpWiki 531
Help/NewMarkupTestPage 476
Help/NewMarkupTestPage 476
Help/NewMarkupTestPage 476
Help/OldMarkupTestPage 464
Help/OldMarkupTestPage 464
Help/OldMarkupTestPage 464
Larcan 1688
Tepco 1041
Standard Telephones & Cables. Australia 896
Presto 971
Straight Wire Audio 900
Arrakis Systems, Inc 2109
Consolidated Electronic Industries 928
Aphex Systems Limited 1319
QEI 3411
Multronics 896
ITC 866
Machlett Laboratories 1063
Cutting Edge Technologies 959
Bext 1426
Tektronix 693
Electronics Research, Inc. 839
Advanced Research & Technology 1904
Marantz 1081
Microcon 914
Broadcast Television Systems 940
Bosch 1076
dbx 99
Otari 1241
Crown 2770
Broadcast Electronics 2437
ATI 1496
Scully 1076
Marti Electronics, Inc. 305
Harman Kardon 1183
Potomac Instruments 408
Broadcast Audio 2304
Andrew Corporation 448
Audio Arts 1162
Bird Electronic Corporation 708
Dumont 1523
Autogram 4294
Radio Engineering 522
Heathkit 793
Mullard 920
NBC 1080
Amperite 1271
McIntosh 1423
Inovonics 1662
Neotek 1917
Moulic Specialties Co. 881
Engineering Services 963
IRC 1295
ESE 2661
Comtech Antenna Corporation 1168
Panasonic 964
Orban 2597
Studer 934
Coastcom 1007
Clear-Com 934
Dolby Laboratories 399
CSI 2151
Bell Telephone Laboratories 1518
Pacific Recorders and Engineers 1370
Hewlett Packard 585
Sparta Electronics 870
Tapecaster 2508
Scala 1039
Marconi Wireless Telegraph Company 1072
Energy-Onix 1866
Modulation Sciences 1980
Burk Technology 2665
Auditronics 2863
Jampro Antenna 86
Dayton Industrial 975
Thompson-CSF 1486
Rust Industrial Company, Inc. 1558
Accurate Sound Corporation 2034
IGM 1258
SMC 1356
Radix 1553
Fidelipac 682
Hughey & Phillips 1719
Microwave Radio Corporation 2012
Broadcast Tools 912
Symmetrix 1920
GatesAir 1092
Hallicrafters 2242
Kenwood 1591
Kyocera 1839
Teac 598
Wheatstone Corporation 333
Gorman-Redlich 1402
Studer International AG 1134
Data Systems Design 1257
Dana Electronics 1991
American Data 1777
Teletronix Engineering Company 1464
Tentel 1137
Taber Manufacturing and Engineering Company 1256
Standart Tape Laboratory 1182
Extel 1328
Russco 1150
Automated Broadcast Controls 1370
Electrovoice 1168
Jennings 1168
Wegener Communications 1118
Midwest Communications 1087
Aston 1471
Farallon 1180
Kenneth A. Bacon Associates 1039
J. G. S. Engineering Inc. 1143
Continental Satellite Systems 1137
ComStream 1655
Conex Electro Systems 1058
Denon 1282
Multi-technical Services 1092
Electronic Signal Products 1307
Lorain Products Corporation 1172
C & D Batteries 1995
Nova Systems, Inc. 1052
Nortronics 2250
Norcom 1421
Lambda Electronics Corp. 1469
US Audio 1137
Jensen Transformers 1183
Garner Industries 1071
Sescom 1232
Soltec 1251
Peak Audio 1058
MCI 1500
MEI 2221
Minicom Division of 3M 1635
Metrotech 1873
Lang Electronics 1104
Kinght-kit 1570
Cetec Broadcast Group 2022
Computer Concepts 1329
Dataworld 1261
National Association of Broadcasters 1618
Link, Fred M 1115
Weston 1568
Yokogawa Electric Works 1236
Measurements 1597
Electronics Digest 309
Gregg Laboratories 1203
Leeds & Northrup Company 1179
Video Systems of America 1061
Simpson Electric Company 1195
Triplett 1015
Boonton Radio Corporation 1080
Ohmite Manufacturing Company 1310
Contel ASC 849
Audi-Cord Corporation 933
Johnson Electronics 821
Telefile Computer Products, Inc. 1029
Realistic 731
Thordarson 734
Sine Systems 921
Telos 808
Harris Allied 736
Broadcasters General Store 988
QRK 848
BME - Broadcast Management Engineering Magazine 1660
Radio Business Report 703
UMC Beaucart 672
Armstrong Transmitter Corporation 5760
Cablewave Systems 692
Aristocart 824
Elgin Electronics 747
Goldline 633
NAD Electronics 1094
Will-Burt Company 215

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