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

247 pages link to HomePage:
|<<   << - 1 / 5 - Next >>   >>|
|<<   << - 1 / 5 - Next >>   >>|
Page Name. Hits.
Help/TextFormattingRules 14572
PhpWikiAdministration 1156
Help/EditMetaDataPlugin 989
Help/RedirectToPlugin 1015
TextFormattingRules 5971
OldTextFormattingRules 451
RedirectToPlugin 432
NewMarkupTestPage 463
OldMarkupTestPage 417
IncludePagePlugin 682
AmperexElectronicCorporation 1189
DeltaElectronics 2290
EimacDivisionOfVarian 995
GatesRadioCompany 1687
GatesRadioCatalog99 510
GeneralElectric 2774
GeneralRadio 2997
HallikainenAndFriends 1588
MoseleyAssociatesInc 597
Motorola 981
National 909
NemsClarke 920
RCA 1739
WesternElectric 1817
Technics 1146
Westinghouse 940
MilitaryRadio 830
Historic Papers 1378
Station Histories 573
Ratheon 397
Raytheon 1437
EfJohnson 935
American Electronic Laboratories 1513
Victoreen Instrument Company 1025
Anton Electronic Laboratories 1143
Collins Radio 1775
HoweTech 934
Belar Electronics Laboratory 2635
Ampex 1555
Harris Corporation - Broadcast Division 930
Dorrough Electronics 1039
Radio Engineering Laboratories 902
Standard Electronics 849
Amalgamated Wireless (Australiasia) Ltd. 1674
Byer Industries 887
Circuit Research Laboratories 234
Bauer Electronics Corporation 1022
Trimax 855
United Transformer Corporation 859
template 421
Philips 1060
McMartin 317
ITA 1003
Continental Electronics 22
Magnecord 846
TFT, Inc. 568
Schafer Automation 1422
Gentner 781
Texar 1175
Langevin 1206
Altec 1968
CBS Labs 3076
Pultec 848
Sony 477
3M 445
UREI 332
Frese and Kaping 1191
Revox 434
Federated Purchaser 773
CCA 292
LPB 3517
Hollyanne 790
Telfax 769
Help/OldTextFormattingRules 446
AmministrazioneDiPhpWiki 459
Help/NewMarkupTestPage 430
Help/NewMarkupTestPage 430
Help/NewMarkupTestPage 430
Help/OldMarkupTestPage 418
Help/OldMarkupTestPage 418
Help/OldMarkupTestPage 418
Larcan 1571
Tepco 961
Standard Telephones & Cables. Australia 818
Presto 890
Straight Wire Audio 818
Arrakis Systems, Inc 1976
Consolidated Electronic Industries 837
Aphex Systems Limited 1212
QEI 3246
Multronics 811
ITC 628
Machlett Laboratories 979
Cutting Edge Technologies 844
Bext 1308
Tektronix 522
Electronics Research, Inc. 755
Advanced Research & Technology 1767
Marantz 982
Microcon 831
Broadcast Television Systems 841
Bosch 978
dbx 341
Otari 1147
Crown 2555
Broadcast Electronics 1906
ATI 1367
Scully 988
Marti Electronics, Inc. 215
Harman Kardon 1083
Potomac Instruments 285
Broadcast Audio 2135
Andrew Corporation 252
Audio Arts 1055
Bird Electronic Corporation 55
Dumont 1415
Autogram 3975
Radio Engineering 444
Heathkit 638
Mullard 836
NBC 988
Amperite 1160
McIntosh 1326
Inovonics 1554
Neotek 1799
Moulic Specialties Co. 800
Engineering Services 877
IRC 1200
ESE 2484
Comtech Antenna Corporation 1063
Panasonic 724
Orban 2472
Studer 851
Coastcom 908
Clear-Com 836
Dolby Laboratories 256
CSI 1996
Bell Telephone Laboratories 1399
Pacific Recorders and Engineers 1288
Hewlett Packard 446
Sparta Electronics 703
Tapecaster 2369
Scala 957
Marconi Wireless Telegraph Company 994
Energy-Onix 1740
Modulation Sciences 1848
Burk Technology 2480
Auditronics 2668
Jampro Antenna 190
Dayton Industrial 721
Thompson-CSF 1389
Rust Industrial Company, Inc. 1475
Accurate Sound Corporation 1893
IGM 1167
SMC 1255
Radix 1458
Fidelipac 524
Hughey & Phillips 1602
Microwave Radio Corporation 1854
Broadcast Tools 661
Symmetrix 1801
GatesAir 1000
Hallicrafters 2095
Kenwood 1489
Kyocera 1725
Teac 440
Wheatstone Corporation 236
Gorman-Redlich 1303
Studer International AG 1049
Data Systems Design 1154
Dana Electronics 1854
American Data 1645
Teletronix Engineering Company 1375
Tentel 1046
Taber Manufacturing and Engineering Company 1177
Standart Tape Laboratory 1099
Extel 1239
Russco 1060
Automated Broadcast Controls 1260
Electrovoice 1070
Jennings 1075
Wegener Communications 1031
Midwest Communications 996
Aston 1350
Farallon 1094
Kenneth A. Bacon Associates 945
J. G. S. Engineering Inc. 1049
Continental Satellite Systems 1031
ComStream 1523
Conex Electro Systems 962
Denon 1183
Multi-technical Services 998
Electronic Signal Products 1211
Lorain Products Corporation 1084
C & D Batteries 1851
Nova Systems, Inc. 964
Nortronics 2144
Norcom 1315
Lambda Electronics Corp. 1378
US Audio 1042
Jensen Transformers 1093
Garner Industries 979
Sescom 1140
Soltec 1152
Peak Audio 965
MCI 1400
MEI 2080
Minicom Division of 3M 1546
Metrotech 1754
Lang Electronics 1012
Kinght-kit 1469
Cetec Broadcast Group 1921
Computer Concepts 1225
Dataworld 1166
National Association of Broadcasters 1510
Link, Fred M 1029
Weston 1474
Yokogawa Electric Works 1155
Measurements 1493
Electronics Digest 210
Gregg Laboratories 1112
Leeds & Northrup Company 1096
Video Systems of America 972
Simpson Electric Company 1110
Triplett 918
Boonton Radio Corporation 987
Ohmite Manufacturing Company 1226
Contel ASC 748
Audi-Cord Corporation 834
Johnson Electronics 737
Telefile Computer Products, Inc. 953
Realistic 645
Thordarson 645
Sine Systems 823
Telos 716
Harris Allied 651
Broadcasters General Store 885
QRK 760
BME - Broadcast Management Engineering Magazine 1558
Radio Business Report 612
UMC Beaucart 584
Armstrong Transmitter Corporation 5659
Cablewave Systems 591
Aristocart 714
Elgin Electronics 654
Goldline 538
NAD Electronics 1011

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