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 30445
GeneralRadio 28802
Broadcast Electronics 19049
RCA 18873
HallikainenAndFriends 18750
Collins Radio 16968
GatesRadioCompany 16686
Ampex 15785
TextFormattingRules 13029
Bird Electronic Corporation 11783
Autogram 9408
Harris Corporation - Broadcast Division 9095
Dorrough Electronics 7708
MilitaryRadio 7554
Panasonic 7485
QEI 6985
Armstrong Transmitter Corporation 6706
Gentner 6591
Sparta Electronics 6532
Dayton Industrial 6515
LPB 6412
Historic Papers 6218
TFT, Inc. 6172
DeltaElectronics 6007
Crown 5622
Station Histories 5571
ITC 5494
Auditronics 5352
Burk Technology 5336
MoseleyAssociatesInc 5330
3M 5313
ESE 5158
Orban 4933
Belar Electronics Laboratory 4827
Tapecaster 4796
Continental Electronics 4704
Sony 4628
Broadcast Audio 4589
Hewlett Packard 4389
Revox 4362
MEI 4336
Nortronics 4154
Hallicrafters 4144
WesternElectric 4096
Tektronix 4071
Fidelipac 3934
Teac 3934
CSI 3877
Modulation Sciences 3858
Arrakis Systems, Inc 3748
Symmetrix 3703
Cetec Broadcast Group 3690
Microwave Radio Corporation 3676
C & D Batteries 3671
Neotek 3668
Potomac Instruments 3554
Energy-Onix 3493
Kyocera 3485
Altec 3479
Metrotech 3472
Dana Electronics 3380
CBS Labs 3339
Hughey & Phillips 3276
Accurate Sound Corporation 3264
Inovonics 3263
CCA 3093
ComStream 3071
GeneralElectric 3054
Larcan 3044
McMartin 3036
dbx 3018
Advanced Research & Technology 2974
American Data 2941
Kenwood 2923
Radix 2905
Measurements 2892
Weston 2875
Kinght-kit 2868
National Association of Broadcasters 2863
American Electronic Laboratories 2855
Rust Industrial Company, Inc. 2846
Minicom Division of 3M 2828
Amalgamated Wireless (Australiasia) Ltd. 2825
Andrew Corporation 2795
Marti Electronics, Inc. 2778
UREI 2769
Bell Telephone Laboratories 2679
Thompson-CSF 2674
Schafer Automation 2652
Pacific Recorders and Engineers 2625
Lambda Electronics Corp. 2623
Norcom 2609
MCI 2598
Raytheon 2595
BME - Broadcast Management Engineering Magazine 2580
Dumont 2574
ATI 2542
McIntosh 2521
SMC 2472
Teletronix Engineering Company 2437
Dolby Laboratories 2436
Langevin 2432
PhpWikiAdministration 2379
Frese and Kaping 2338
Aston 2334
Bext 2324
Gorman-Redlich 2317
Extel 2315
Texar 2302
Automated Broadcast Controls 2296
Bauer Electronics Corporation 2285
Otari 2259
Computer Concepts 2245
Wheatstone Corporation 2240
Electronic Signal Products 2222
Technics 2201
Soltec 2179
Russco 2168
Data Systems Design 2164
Broadcasters General Store 2146
Gregg Laboratories 2143
Harman Kardon 2130
IGM 2127
Denon 2118
Sescom 2106
IRC 2105
J. G. S. Engineering Inc. 2101
Ohmite Manufacturing Company 2098
NAD Electronics 2092
Scully 2085
Dataworld 2081
Aphex Systems Limited 2072
Multi-technical Services 2066
NemsClarke 2063
Lang Electronics 2057
Farallon 2052
Help/RedirectToPlugin 2049
AmperexElectronicCorporation 2048
Motorola 2045
Jensen Transformers 2035
Taber Manufacturing and Engineering Company 2034
Simpson Electric Company 2029
Leeds & Northrup Company 2025
Circuit Research Laboratories 2014
Philips 2012
Comtech Antenna Corporation 2012
Tentel 1997
Yokogawa Electric Works 1992
Standart Tape Laboratory 1990
Continental Satellite Systems 1982
Jennings 1975
Marantz 1965
Boonton Radio Corporation 1960
Triplett 1959
Midwest Communications 1958
Electrovoice 1955
Amperite 1954
Magnecord 1950
Lorain Products Corporation 1948
Sine Systems 1946
Link, Fred M 1939
Wegener Communications 1928
Studer International AG 1925
Garner Industries 1917
EimacDivisionOfVarian 1914
Video Systems of America 1910
Broadcast Television Systems 1901
Help/EditMetaDataPlugin 1893
Anton Electronic Laboratories 1889
US Audio 1875
Kenneth A. Bacon Associates 1858
Victoreen Instrument Company 1857
Aristocart 1849
Conex Electro Systems 1829
Audio Arts 1826
National 1820
Peak Audio 1819
GatesAir 1799
Nova Systems, Inc. 1781
Audi-Cord Corporation 1771
Machlett Laboratories 1767
Telefile Computer Products, Inc. 1764
Bosch 1747
Mullard 1731
NBC 1728
Westinghouse 1720
Valcom 1720
ITA 1715
Byer Industries 1706
Scala 1704
Radio Engineering Laboratories 1702
Jampro Antenna 1699
QRK 1699
Coastcom 1698
Tepco 1686
HoweTech 1674
Clear-Com 1668
Standard Telephones & Cables. Australia 1667
Marconi Wireless Telegraph Company 1664
Electronics Digest 1663
United Transformer Corporation 1657
Presto 1656
Telos 1649
Contel ASC 1648
EfJohnson 1635
Consolidated Electronic Industries 1627
Johnson Electronics 1626
Harris Allied 1615
Thordarson 1614
Realistic 1604
Elgin Electronics 1603
UMC Beaucart 1581
Pultec 1579
Radio Business Report 1579
Engineering Services 1569
Straight Wire Audio 1558
Studer 1558
Trimax 1540
Multronics 1536
Cutting Edge Technologies 1525
Cablewave Systems 1517
Standard Electronics 1503
Hollyanne 1503
Microcon 1503
Goldline 1485
Federated Purchaser 1464
Telfax 1463
Moulic Specialties Co. 1424
Electronics Research, Inc. 1354
IncludePagePlugin 1316
GatesRadioCatalog99 1233
Broadcast Tools 1140
Will-Burt Company 1048
SStran 1003
Radio Engineering 981
NewMarkupTestPage 963
AmministrazioneDiPhpWiki 960
OldTextFormattingRules 945
template 918
OldMarkupTestPage 896
Help/OldTextFormattingRules 887
Help/NewMarkupTestPage 886
Help/NewMarkupTestPage 886
Help/NewMarkupTestPage 886
Help/OldMarkupTestPage 856
Help/OldMarkupTestPage 856
Help/OldMarkupTestPage 856
RedirectToPlugin 840
Ratheon 831
Heathkit 75

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