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 30498
PhpWikiAdministration 2382
Help/EditMetaDataPlugin 1893
Help/RedirectToPlugin 2051
TextFormattingRules 13059
OldTextFormattingRules 947
RedirectToPlugin 840
NewMarkupTestPage 965
OldMarkupTestPage 899
IncludePagePlugin 1317
AmperexElectronicCorporation 2051
DeltaElectronics 6034
EimacDivisionOfVarian 1919
GatesRadioCompany 16700
GatesRadioCatalog99 1236
GeneralElectric 3069
GeneralRadio 28836
HallikainenAndFriends 18909
MoseleyAssociatesInc 5346
Motorola 2048
National 1822
NemsClarke 2067
RCA 19025
WesternElectric 4100
Technics 2205
Westinghouse 1725
MilitaryRadio 7639
Historic Papers 6304
Station Histories 5601
Ratheon 833
Raytheon 2602
EfJohnson 1639
American Electronic Laboratories 2857
Victoreen Instrument Company 1861
Anton Electronic Laboratories 1891
Collins Radio 17011
HoweTech 1678
Belar Electronics Laboratory 4842
Ampex 15803
Harris Corporation - Broadcast Division 9105
Dorrough Electronics 7790
Radio Engineering Laboratories 1706
Standard Electronics 1504
Amalgamated Wireless (Australiasia) Ltd. 2830
Byer Industries 1708
Circuit Research Laboratories 2031
Bauer Electronics Corporation 2287
Trimax 1542
United Transformer Corporation 1659
template 920
Philips 2015
McMartin 3042
ITA 1719
Continental Electronics 4747
Magnecord 1953
TFT, Inc. 6180
Schafer Automation 2654
Gentner 6625
Texar 2309
Langevin 2438
Altec 3484
CBS Labs 3358
Pultec 1581
Sony 4651
3M 5332
UREI 2782
Frese and Kaping 2342
Revox 4370
Federated Purchaser 1468
CCA 3098
LPB 6426
Hollyanne 1506
Telfax 1465
Help/OldTextFormattingRules 887
AmministrazioneDiPhpWiki 962
Help/NewMarkupTestPage 886
Help/NewMarkupTestPage 886
Help/NewMarkupTestPage 886
Help/OldMarkupTestPage 856
Help/OldMarkupTestPage 856
Help/OldMarkupTestPage 856
Larcan 3055
Tepco 1689
Standard Telephones & Cables. Australia 1671
Presto 1658
Straight Wire Audio 1560
Arrakis Systems, Inc 3750
Consolidated Electronic Industries 1630
Aphex Systems Limited 2076
QEI 6991
Multronics 1537
ITC 5541
Machlett Laboratories 1770
Cutting Edge Technologies 1527
Bext 2326
Tektronix 4111
Electronics Research, Inc. 1356
Advanced Research & Technology 2976
Marantz 1970
Microcon 1506
Broadcast Television Systems 1904
Bosch 1749
dbx 3022
Otari 2265
Crown 5626
Broadcast Electronics 19325
ATI 2546
Scully 2087
Marti Electronics, Inc. 2796
Harman Kardon 2138
Potomac Instruments 3568
Broadcast Audio 4592
Andrew Corporation 2807
Audio Arts 1829
Bird Electronic Corporation 12602
Dumont 2579
Autogram 9414
Radio Engineering 988
Heathkit 82
Mullard 1733
NBC 1732
Amperite 1956
McIntosh 2532
Inovonics 3267
Neotek 3677
Moulic Specialties Co. 1426
Engineering Services 1571
IRC 2109
ESE 5162
Comtech Antenna Corporation 2018
Panasonic 7567
Orban 4945
Studer 1561
Coastcom 1701
Clear-Com 1673
Dolby Laboratories 2439
CSI 3880
Bell Telephone Laboratories 2682
Pacific Recorders and Engineers 2628
Hewlett Packard 4430
Sparta Electronics 6552
Tapecaster 4811
Scala 1707
Marconi Wireless Telegraph Company 1667
Energy-Onix 3497
Modulation Sciences 3864
Burk Technology 5350
Auditronics 5354
Jampro Antenna 1701
Dayton Industrial 6544
Thompson-CSF 2676
Rust Industrial Company, Inc. 2851
Accurate Sound Corporation 3275
IGM 2130
SMC 2481
Radix 2909
Fidelipac 3967
Hughey & Phillips 3280
Microwave Radio Corporation 3683
Broadcast Tools 1213
Symmetrix 3720
GatesAir 1802
Hallicrafters 4168
Kenwood 2935
Kyocera 3508
Teac 3978
Wheatstone Corporation 2261
Gorman-Redlich 2319
Studer International AG 1930
Data Systems Design 2172
Dana Electronics 3397
American Data 2948
Teletronix Engineering Company 2443
Tentel 2006
Taber Manufacturing and Engineering Company 2041
Standart Tape Laboratory 1999
Extel 2318
Russco 2174
Automated Broadcast Controls 2304
Electrovoice 1958
Jennings 1982
Wegener Communications 1934
Midwest Communications 1964
Aston 2342
Farallon 2058
Kenneth A. Bacon Associates 1863
J. G. S. Engineering Inc. 2103
Continental Satellite Systems 1988
ComStream 3074
Conex Electro Systems 1835
Denon 2126
Multi-technical Services 2072
Electronic Signal Products 2226
Lorain Products Corporation 1952
C & D Batteries 3695
Nova Systems, Inc. 1783
Nortronics 4179
Norcom 2618
Lambda Electronics Corp. 2637
US Audio 1881
Jensen Transformers 2041
Garner Industries 1923
Sescom 2111
Soltec 2188
Peak Audio 1825
MCI 2609
MEI 4359
Minicom Division of 3M 2840
Metrotech 3491
Lang Electronics 2067
Kinght-kit 2870
Cetec Broadcast Group 3711
Computer Concepts 2252
Dataworld 2085
National Association of Broadcasters 2874
Link, Fred M 1942
Weston 2878
Yokogawa Electric Works 1999
Measurements 2906
Electronics Digest 1676
Gregg Laboratories 2150
Leeds & Northrup Company 2030
Video Systems of America 1916
Simpson Electric Company 2035
Triplett 1960
Boonton Radio Corporation 1961
Ohmite Manufacturing Company 2105
Contel ASC 1654
Audi-Cord Corporation 1782
Johnson Electronics 1632
Telefile Computer Products, Inc. 1770
Realistic 1611
Thordarson 1620
Sine Systems 1955
Telos 1656
Harris Allied 1620
Broadcasters General Store 2153
QRK 1704
BME - Broadcast Management Engineering Magazine 2585
Radio Business Report 1585
UMC Beaucart 1587
Armstrong Transmitter Corporation 6714
Cablewave Systems 1525
Aristocart 1856
Elgin Electronics 1609
Goldline 1489
NAD Electronics 2099
Will-Burt Company 1053
Valcom 1736
SStran 1008

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