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
Heathkit 80
Ratheon 832
RedirectToPlugin 840
Help/OldMarkupTestPage 856
Help/OldMarkupTestPage 856
Help/OldMarkupTestPage 856
Help/NewMarkupTestPage 886
Help/NewMarkupTestPage 886
Help/NewMarkupTestPage 886
Help/OldTextFormattingRules 887
OldMarkupTestPage 898
template 919
OldTextFormattingRules 946
AmministrazioneDiPhpWiki 961
NewMarkupTestPage 964
Radio Engineering 985
SStran 1006
Will-Burt Company 1051
Broadcast Tools 1178
GatesRadioCatalog99 1235
IncludePagePlugin 1317
Electronics Research, Inc. 1355
Moulic Specialties Co. 1425
Telfax 1464
Federated Purchaser 1465
Goldline 1488
Standard Electronics 1503
Hollyanne 1505
Microcon 1505
Cablewave Systems 1522
Cutting Edge Technologies 1526
Multronics 1537
Trimax 1541
Straight Wire Audio 1559
Studer 1560
Engineering Services 1570
Pultec 1580
Radio Business Report 1581
UMC Beaucart 1584
Elgin Electronics 1606
Realistic 1608
Thordarson 1617
Harris Allied 1618
Consolidated Electronic Industries 1629
Johnson Electronics 1629
EfJohnson 1637
Contel ASC 1651
Telos 1653
United Transformer Corporation 1658
Presto 1658
Marconi Wireless Telegraph Company 1666
Standard Telephones & Cables. Australia 1669
Electronics Digest 1670
Clear-Com 1671
HoweTech 1676
Tepco 1688
Coastcom 1699
Jampro Antenna 1700
QRK 1700
Radio Engineering Laboratories 1704
Scala 1705
Byer Industries 1707
ITA 1717
Westinghouse 1722
Valcom 1728
NBC 1731
Mullard 1732
Bosch 1748
Telefile Computer Products, Inc. 1767
Machlett Laboratories 1768
Audi-Cord Corporation 1777
Nova Systems, Inc. 1782
GatesAir 1801
National 1822
Peak Audio 1822
Audio Arts 1828
Conex Electro Systems 1832
Aristocart 1853
Victoreen Instrument Company 1860
Kenneth A. Bacon Associates 1861
US Audio 1878
Anton Electronic Laboratories 1889
Help/EditMetaDataPlugin 1893
Broadcast Television Systems 1903
Video Systems of America 1913
EimacDivisionOfVarian 1918
Garner Industries 1920
Studer International AG 1927
Wegener Communications 1931
Link, Fred M 1941
Lorain Products Corporation 1950
Sine Systems 1950
Magnecord 1951
Amperite 1955
Electrovoice 1957
Midwest Communications 1960
Triplett 1960
Boonton Radio Corporation 1960
Marantz 1967
Jennings 1978
Continental Satellite Systems 1985
Standart Tape Laboratory 1995
Yokogawa Electric Works 1996
Tentel 2003
Philips 2014
Comtech Antenna Corporation 2015
Circuit Research Laboratories 2022
Leeds & Northrup Company 2027
Simpson Electric Company 2032
Jensen Transformers 2037
Taber Manufacturing and Engineering Company 2038
Motorola 2047
Help/RedirectToPlugin 2050
AmperexElectronicCorporation 2050
Farallon 2055
Lang Electronics 2062
NemsClarke 2064
Multi-technical Services 2069
Aphex Systems Limited 2074
Dataworld 2084
Scully 2086
NAD Electronics 2096
J. G. S. Engineering Inc. 2102
Ohmite Manufacturing Company 2102
IRC 2108
Sescom 2109
Denon 2123
IGM 2128
Harman Kardon 2133
Gregg Laboratories 2146
Broadcasters General Store 2148
Data Systems Design 2169
Russco 2170
Soltec 2182
Technics 2203
Electronic Signal Products 2223
Computer Concepts 2249
Wheatstone Corporation 2251
Otari 2261
Bauer Electronics Corporation 2286
Automated Broadcast Controls 2300
Texar 2305
Extel 2317
Gorman-Redlich 2318
Bext 2324
Aston 2337
Frese and Kaping 2340
PhpWikiAdministration 2381
Langevin 2436
Dolby Laboratories 2437
Teletronix Engineering Company 2440
SMC 2476
McIntosh 2528
ATI 2545
Dumont 2577
BME - Broadcast Management Engineering Magazine 2583
Raytheon 2600
MCI 2604
Norcom 2614
Pacific Recorders and Engineers 2626
Lambda Electronics Corp. 2631
Schafer Automation 2653
Thompson-CSF 2675
Bell Telephone Laboratories 2680
UREI 2776
Marti Electronics, Inc. 2789
Andrew Corporation 2803
Amalgamated Wireless (Australiasia) Ltd. 2827
Minicom Division of 3M 2834
Rust Industrial Company, Inc. 2848
American Electronic Laboratories 2857
Kinght-kit 2869
National Association of Broadcasters 2870
Weston 2877
Measurements 2899
Radix 2906
Kenwood 2929
American Data 2945
Advanced Research & Technology 2976
dbx 3021
McMartin 3039
Larcan 3051
GeneralElectric 3063
ComStream 3072
CCA 3096
Inovonics 3266
Accurate Sound Corporation 3274
Hughey & Phillips 3278
CBS Labs 3348
Dana Electronics 3390
Altec 3481
Metrotech 3482
Kyocera 3494
Energy-Onix 3495
Potomac Instruments 3561
Neotek 3673
Microwave Radio Corporation 3679
C & D Batteries 3682
Cetec Broadcast Group 3702
Symmetrix 3713
Arrakis Systems, Inc 3749
Modulation Sciences 3861
CSI 3879
Fidelipac 3951
Teac 3957
Tektronix 4092
WesternElectric 4099
Hallicrafters 4158
Nortronics 4167
MEI 4347
Revox 4368
Hewlett Packard 4410
Broadcast Audio 4592
Sony 4640
Continental Electronics 4727
Tapecaster 4805
Belar Electronics Laboratory 4836
Orban 4939
ESE 5160
3M 5322
MoseleyAssociatesInc 5338
Burk Technology 5342
Auditronics 5353
ITC 5520
Station Histories 5589
Crown 5624
DeltaElectronics 6020
TFT, Inc. 6178
Historic Papers 6264
LPB 6419
Dayton Industrial 6525
Sparta Electronics 6542
Gentner 6609
Armstrong Transmitter Corporation 6710
QEI 6988
Panasonic 7529
MilitaryRadio 7599
Dorrough Electronics 7756
Harris Corporation - Broadcast Division 9104
Autogram 9412
Bird Electronic Corporation 12188
TextFormattingRules 13058
Ampex 15797
GatesRadioCompany 16696
Collins Radio 16992
HallikainenAndFriends 18836
RCA 18947
Broadcast Electronics 19195
GeneralRadio 28821
Help/TextFormattingRules 30488

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