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

250 pages link to HomePage:
|<<   << - 1 / 5 - Next >>   >>|
|<<   << - 1 / 5 - Next >>   >>|
Page Name. HitsClick to reverse sort order
Help/TextFormattingRules 30347
GeneralRadio 28796
Broadcast Electronics 19031
RCA 18854
HallikainenAndFriends 18744
Collins Radio 16899
GatesRadioCompany 16600
Ampex 15709
TextFormattingRules 13009
Bird Electronic Corporation 11776
Autogram 9403
Harris Corporation - Broadcast Division 9084
Dorrough Electronics 7700
MilitaryRadio 7543
Panasonic 7480
QEI 6960
Armstrong Transmitter Corporation 6702
Gentner 6586
Sparta Electronics 6525
Dayton Industrial 6498
LPB 6394
Historic Papers 6187
TFT, Inc. 6167
DeltaElectronics 6002
Crown 5614
Station Histories 5565
ITC 5463
Auditronics 5348
Burk Technology 5334
MoseleyAssociatesInc 5322
3M 5310
ESE 5157
Orban 4919
Belar Electronics Laboratory 4822
Tapecaster 4793
Continental Electronics 4683
Sony 4609
Broadcast Audio 4586
Hewlett Packard 4388
Revox 4344
MEI 4332
Nortronics 4151
Hallicrafters 4141
WesternElectric 4092
Tektronix 4067
Fidelipac 3929
Teac 3914
CSI 3873
Modulation Sciences 3855
Arrakis Systems, Inc 3745
Symmetrix 3698
Cetec Broadcast Group 3689
Microwave Radio Corporation 3671
C & D Batteries 3667
Neotek 3657
Potomac Instruments 3545
Energy-Onix 3491
Altec 3476
Kyocera 3471
Metrotech 3468
Dana Electronics 3378
CBS Labs 3335
Hughey & Phillips 3274
Accurate Sound Corporation 3262
Inovonics 3259
CCA 3089
ComStream 3069
GeneralElectric 3047
Larcan 3036
McMartin 3016
dbx 3008
Advanced Research & Technology 2973
American Data 2938
Kenwood 2917
Radix 2899
Measurements 2890
Weston 2872
Kinght-kit 2862
National Association of Broadcasters 2858
American Electronic Laboratories 2854
Rust Industrial Company, Inc. 2845
Minicom Division of 3M 2826
Amalgamated Wireless (Australiasia) Ltd. 2823
Andrew Corporation 2789
Marti Electronics, Inc. 2771
UREI 2759
Bell Telephone Laboratories 2678
Thompson-CSF 2670
Schafer Automation 2647
Pacific Recorders and Engineers 2623
Lambda Electronics Corp. 2622
Norcom 2604
MCI 2594
Raytheon 2590
BME - Broadcast Management Engineering Magazine 2579
Dumont 2572
ATI 2538
McIntosh 2516
SMC 2464
Teletronix Engineering Company 2436
Dolby Laboratories 2435
Langevin 2424
PhpWikiAdministration 2376
Frese and Kaping 2336
Aston 2332
Bext 2322
Gorman-Redlich 2314
Extel 2313
Texar 2296
Automated Broadcast Controls 2295
Bauer Electronics Corporation 2282
Otari 2253
Computer Concepts 2240
Wheatstone Corporation 2239
Electronic Signal Products 2221
Technics 2197
Soltec 2175
Russco 2164
Data Systems Design 2155
Broadcasters General Store 2143
Gregg Laboratories 2142
Harman Kardon 2128
IGM 2122
Denon 2117
Sescom 2104
IRC 2103
J. G. S. Engineering Inc. 2100
Ohmite Manufacturing Company 2096
NAD Electronics 2090
Scully 2081
Dataworld 2079
Aphex Systems Limited 2069
Multi-technical Services 2065
NemsClarke 2059
Lang Electronics 2055
Farallon 2049
AmperexElectronicCorporation 2047
Help/RedirectToPlugin 2045
Motorola 2041
Taber Manufacturing and Engineering Company 2033
Jensen Transformers 2033
Simpson Electric Company 2028
Leeds & Northrup Company 2022
Comtech Antenna Corporation 2011
Circuit Research Laboratories 2010
Philips 2009
Tentel 1996
Yokogawa Electric Works 1991
Standart Tape Laboratory 1986
Continental Satellite Systems 1980
Jennings 1972
Marantz 1960
Boonton Radio Corporation 1959
Midwest Communications 1956
Triplett 1955
Electrovoice 1952
Amperite 1949
Magnecord 1948
Lorain Products Corporation 1947
Sine Systems 1945
Link, Fred M 1938
Wegener Communications 1927
Studer International AG 1923
Garner Industries 1915
EimacDivisionOfVarian 1913
Video Systems of America 1909
Broadcast Television Systems 1900
Help/EditMetaDataPlugin 1891
Anton Electronic Laboratories 1888
US Audio 1873
Kenneth A. Bacon Associates 1855
Victoreen Instrument Company 1854
Aristocart 1845
Conex Electro Systems 1828
Audio Arts 1825
National 1819
Peak Audio 1817
GatesAir 1797
Nova Systems, Inc. 1778
Audi-Cord Corporation 1769
Machlett Laboratories 1765
Telefile Computer Products, Inc. 1763
Bosch 1745
Mullard 1728
NBC 1728
Valcom 1716
Westinghouse 1714
ITA 1713
Byer Industries 1705
Scala 1703
Radio Engineering Laboratories 1701
Jampro Antenna 1697
QRK 1696
Coastcom 1694
Tepco 1684
HoweTech 1672
Standard Telephones & Cables. Australia 1664
Clear-Com 1663
Marconi Wireless Telegraph Company 1662
Electronics Digest 1660
United Transformer Corporation 1656
Presto 1653
Contel ASC 1647
Telos 1647
EfJohnson 1634
Consolidated Electronic Industries 1626
Johnson Electronics 1623
Harris Allied 1614
Thordarson 1611
Realistic 1602
Elgin Electronics 1602
Pultec 1577
UMC Beaucart 1577
Radio Business Report 1576
Engineering Services 1566
Straight Wire Audio 1557
Studer 1557
Trimax 1537
Multronics 1533
Cutting Edge Technologies 1524
Cablewave Systems 1515
Standard Electronics 1502
Hollyanne 1501
Microcon 1499
Goldline 1483
Federated Purchaser 1463
Telfax 1460
Moulic Specialties Co. 1421
Electronics Research, Inc. 1353
IncludePagePlugin 1315
GatesRadioCatalog99 1229
Broadcast Tools 1134
Will-Burt Company 1047
SStran 1003
Radio Engineering 979
NewMarkupTestPage 962
AmministrazioneDiPhpWiki 958
OldTextFormattingRules 942
template 916
OldMarkupTestPage 895
Help/NewMarkupTestPage 885
Help/NewMarkupTestPage 885
Help/NewMarkupTestPage 885
Help/OldTextFormattingRules 884
Help/OldMarkupTestPage 855
Help/OldMarkupTestPage 855
Help/OldMarkupTestPage 855
RedirectToPlugin 837
Ratheon 830
Heathkit 73

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