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 15157
PhpWikiAdministration 1278
Help/EditMetaDataPlugin 1086
Help/RedirectToPlugin 1118
TextFormattingRules 6365
OldTextFormattingRules 489
RedirectToPlugin 471
NewMarkupTestPage 501
OldMarkupTestPage 458
IncludePagePlugin 731
AmperexElectronicCorporation 1329
DeltaElectronics 2565
EimacDivisionOfVarian 1102
GatesRadioCompany 2369
GatesRadioCatalog99 600
GeneralElectric 187
GeneralRadio 3985
HallikainenAndFriends 2057
MoseleyAssociatesInc 826
Motorola 1098
National 1014
NemsClarke 1169
RCA 2746
WesternElectric 1968
Technics 1268
Westinghouse 1049
MilitaryRadio 1109
Historic Papers 1088
Station Histories 844
Ratheon 435
Raytheon 1563
EfJohnson 1029
American Electronic Laboratories 1668
Victoreen Instrument Company 1139
Anton Electronic Laboratories 1281
Collins Radio 2536
HoweTech 1034
Belar Electronics Laboratory 2812
Ampex 2414
Harris Corporation - Broadcast Division 1390
Dorrough Electronics 1387
Radio Engineering Laboratories 998
Standard Electronics 946
Amalgamated Wireless (Australiasia) Ltd. 1820
Byer Industries 998
Circuit Research Laboratories 398
Bauer Electronics Corporation 1153
Trimax 952
United Transformer Corporation 972
template 465
Philips 1172
McMartin 483
ITA 1098
Continental Electronics 293
Magnecord 943
TFT, Inc. 889
Schafer Automation 1535
Gentner 1142
Texar 1292
Langevin 1323
Altec 2143
CBS Labs 277
Pultec 949
Sony 732
3M 741
UREI 529
Frese and Kaping 1317
Revox 687
Federated Purchaser 877
CCA 526
LPB 3724
Hollyanne 892
Telfax 871
Help/OldTextFormattingRules 501
AmministrazioneDiPhpWiki 542
Help/NewMarkupTestPage 487
Help/NewMarkupTestPage 487
Help/NewMarkupTestPage 487
Help/OldMarkupTestPage 477
Help/OldMarkupTestPage 477
Help/OldMarkupTestPage 477
Larcan 1718
Tepco 1053
Standard Telephones & Cables. Australia 912
Presto 987
Straight Wire Audio 915
Arrakis Systems, Inc 2141
Consolidated Electronic Industries 944
Aphex Systems Limited 1339
QEI 3471
Multronics 916
ITC 960
Machlett Laboratories 1080
Cutting Edge Technologies 980
Bext 1450
Tektronix 790
Electronics Research, Inc. 852
Advanced Research & Technology 1937
Marantz 1101
Microcon 927
Broadcast Television Systems 960
Bosch 1091
dbx 175
Otari 1265
Crown 2821
Broadcast Electronics 2720
ATI 1517
Scully 1096
Marti Electronics, Inc. 351
Harman Kardon 1203
Potomac Instruments 507
Broadcast Audio 2347
Andrew Corporation 496
Audio Arts 1178
Bird Electronic Corporation 1553
Dumont 1548
Autogram 4405
Radio Engineering 538
Heathkit 903
Mullard 933
NBC 1091
Amperite 1293
McIntosh 1450
Inovonics 1690
Neotek 1954
Moulic Specialties Co. 894
Engineering Services 978
IRC 1318
ESE 2726
Comtech Antenna Corporation 1191
Panasonic 1074
Orban 2645
Studer 952
Coastcom 1025
Clear-Com 949
Dolby Laboratories 435
CSI 2199
Bell Telephone Laboratories 1547
Pacific Recorders and Engineers 1392
Hewlett Packard 684
Sparta Electronics 1011
Tapecaster 2558
Scala 1053
Marconi Wireless Telegraph Company 1083
Energy-Onix 1908
Modulation Sciences 2028
Burk Technology 2733
Auditronics 2924
Jampro Antenna 119
Dayton Industrial 1110
Thompson-CSF 1520
Rust Industrial Company, Inc. 1582
Accurate Sound Corporation 2073
IGM 1280
SMC 1383
Radix 1589
Fidelipac 767
Hughey & Phillips 1762
Microwave Radio Corporation 2053
Broadcast Tools 1038
Symmetrix 1972
GatesAir 1105
Hallicrafters 2294
Kenwood 1617
Kyocera 1876
Teac 672
Wheatstone Corporation 372
Gorman-Redlich 1429
Studer International AG 1154
Data Systems Design 1278
Dana Electronics 2029
American Data 1812
Teletronix Engineering Company 1488
Tentel 1155
Taber Manufacturing and Engineering Company 1272
Standart Tape Laboratory 1201
Extel 1353
Russco 1171
Automated Broadcast Controls 1388
Electrovoice 1188
Jennings 1188
Wegener Communications 1135
Midwest Communications 1108
Aston 1491
Farallon 1199
Kenneth A. Bacon Associates 1054
J. G. S. Engineering Inc. 1164
Continental Satellite Systems 1158
ComStream 1686
Conex Electro Systems 1076
Denon 1303
Multi-technical Services 1114
Electronic Signal Products 1333
Lorain Products Corporation 1193
C & D Batteries 2031
Nova Systems, Inc. 1066
Nortronics 2291
Norcom 1441
Lambda Electronics Corp. 1495
US Audio 1158
Jensen Transformers 1199
Garner Industries 1092
Sescom 1253
Soltec 1273
Peak Audio 1077
MCI 1531
MEI 2260
Minicom Division of 3M 1664
Metrotech 1906
Lang Electronics 1127
Kinght-kit 1596
Cetec Broadcast Group 2063
Computer Concepts 1350
Dataworld 1282
National Association of Broadcasters 1649
Link, Fred M 1136
Weston 1598
Yokogawa Electric Works 1256
Measurements 1629
Electronics Digest 349
Gregg Laboratories 1225
Leeds & Northrup Company 1198
Video Systems of America 1084
Simpson Electric Company 1216
Triplett 1036
Boonton Radio Corporation 1100
Ohmite Manufacturing Company 1331
Contel ASC 867
Audi-Cord Corporation 949
Johnson Electronics 842
Telefile Computer Products, Inc. 1044
Realistic 750
Thordarson 754
Sine Systems 941
Telos 827
Harris Allied 756
Broadcasters General Store 1013
QRK 866
BME - Broadcast Management Engineering Magazine 1678
Radio Business Report 726
UMC Beaucart 692
Armstrong Transmitter Corporation 5776
Cablewave Systems 712
Aristocart 855
Elgin Electronics 763
Goldline 656
NAD Electronics 1113
Will-Burt Company 233
Valcom 65

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