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 81
Ratheon 833
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 920
OldTextFormattingRules 947
AmministrazioneDiPhpWiki 962
NewMarkupTestPage 965
Radio Engineering 987
SStran 1006
Will-Burt Company 1051
Broadcast Tools 1202
GatesRadioCatalog99 1235
IncludePagePlugin 1317
Electronics Research, Inc. 1356
Moulic Specialties Co. 1426
Telfax 1465
Federated Purchaser 1468
Goldline 1489
Standard Electronics 1504
Hollyanne 1506
Microcon 1506
Cablewave Systems 1525
Cutting Edge Technologies 1527
Multronics 1537
Trimax 1542
Straight Wire Audio 1560
Studer 1560
Engineering Services 1571
Pultec 1581
Radio Business Report 1584
UMC Beaucart 1587
Elgin Electronics 1608
Realistic 1609
Thordarson 1619
Harris Allied 1619
Consolidated Electronic Industries 1630
Johnson Electronics 1630
EfJohnson 1638
Contel ASC 1653
Telos 1656
United Transformer Corporation 1658
Presto 1658
Marconi Wireless Telegraph Company 1667
Standard Telephones & Cables. Australia 1671
Clear-Com 1672
Electronics Digest 1674
HoweTech 1676
Tepco 1689
Coastcom 1700
Jampro Antenna 1701
QRK 1702
Radio Engineering Laboratories 1706
Scala 1706
Byer Industries 1708
ITA 1719
Westinghouse 1724
NBC 1731
Valcom 1731
Mullard 1732
Bosch 1749
Telefile Computer Products, Inc. 1768
Machlett Laboratories 1770
Audi-Cord Corporation 1781
Nova Systems, Inc. 1783
GatesAir 1801
National 1822
Peak Audio 1823
Audio Arts 1829
Conex Electro Systems 1834
Aristocart 1855
Victoreen Instrument Company 1860
Kenneth A. Bacon Associates 1861
US Audio 1881
Anton Electronic Laboratories 1890
Help/EditMetaDataPlugin 1893
Broadcast Television Systems 1903
Video Systems of America 1915
EimacDivisionOfVarian 1918
Garner Industries 1923
Studer International AG 1929
Wegener Communications 1934
Link, Fred M 1942
Magnecord 1952
Lorain Products Corporation 1952
Sine Systems 1953
Amperite 1956
Electrovoice 1958
Triplett 1960
Boonton Radio Corporation 1961
Midwest Communications 1964
Marantz 1969
Jennings 1980
Continental Satellite Systems 1988
Standart Tape Laboratory 1998
Yokogawa Electric Works 1998
Tentel 2006
Philips 2015
Comtech Antenna Corporation 2015
Circuit Research Laboratories 2029
Leeds & Northrup Company 2030
Simpson Electric Company 2035
Taber Manufacturing and Engineering Company 2039
Jensen Transformers 2040
Motorola 2047
Help/RedirectToPlugin 2050
AmperexElectronicCorporation 2050
Farallon 2058
NemsClarke 2066
Lang Electronics 2067
Multi-technical Services 2072
Aphex Systems Limited 2074
Dataworld 2085
Scully 2086
NAD Electronics 2098
J. G. S. Engineering Inc. 2103
Ohmite Manufacturing Company 2105
IRC 2109
Sescom 2111
Denon 2125
IGM 2130
Harman Kardon 2138
Gregg Laboratories 2148
Broadcasters General Store 2151
Data Systems Design 2171
Russco 2173
Soltec 2186
Technics 2204
Electronic Signal Products 2224
Computer Concepts 2252
Wheatstone Corporation 2260
Otari 2264
Bauer Electronics Corporation 2287
Automated Broadcast Controls 2303
Texar 2309
Extel 2318
Gorman-Redlich 2319
Bext 2326
Aston 2339
Frese and Kaping 2342
PhpWikiAdministration 2381
Langevin 2437
Dolby Laboratories 2438
Teletronix Engineering Company 2440
SMC 2480
McIntosh 2529
ATI 2546
Dumont 2579
BME - Broadcast Management Engineering Magazine 2585
Raytheon 2602
MCI 2609
Norcom 2615
Pacific Recorders and Engineers 2627
Lambda Electronics Corp. 2634
Schafer Automation 2654
Thompson-CSF 2676
Bell Telephone Laboratories 2682
UREI 2779
Marti Electronics, Inc. 2795
Andrew Corporation 2806
Amalgamated Wireless (Australiasia) Ltd. 2830
Minicom Division of 3M 2838
Rust Industrial Company, Inc. 2850
American Electronic Laboratories 2857
Kinght-kit 2870
National Association of Broadcasters 2873
Weston 2877
Measurements 2905
Radix 2909
Kenwood 2933
American Data 2946
Advanced Research & Technology 2976
dbx 3021
McMartin 3041
Larcan 3055
GeneralElectric 3068
ComStream 3073
CCA 3097
Inovonics 3267
Accurate Sound Corporation 3275
Hughey & Phillips 3278
CBS Labs 3354
Dana Electronics 3393
Altec 3484
Metrotech 3489
Energy-Onix 3495
Kyocera 3504
Potomac Instruments 3566
Neotek 3677
Microwave Radio Corporation 3682
C & D Batteries 3692
Cetec Broadcast Group 3710
Symmetrix 3716
Arrakis Systems, Inc 3749
Modulation Sciences 3863
CSI 3880
Fidelipac 3964
Teac 3971
WesternElectric 4100
Tektronix 4106
Hallicrafters 4163
Nortronics 4175
MEI 4354
Revox 4369
Hewlett Packard 4423
Broadcast Audio 4592
Sony 4649
Continental Electronics 4736
Tapecaster 4810
Belar Electronics Laboratory 4840
Orban 4942
ESE 5161
3M 5331
MoseleyAssociatesInc 5344
Burk Technology 5346
Auditronics 5354
ITC 5531
Station Histories 5600
Crown 5626
DeltaElectronics 6028
TFT, Inc. 6179
Historic Papers 6291
LPB 6426
Dayton Industrial 6540
Sparta Electronics 6548
Gentner 6622
Armstrong Transmitter Corporation 6714
QEI 6989
Panasonic 7554
MilitaryRadio 7632
Dorrough Electronics 7777
Harris Corporation - Broadcast Division 9105
Autogram 9414
Bird Electronic Corporation 12482
TextFormattingRules 13058
Ampex 15803
GatesRadioCompany 16697
Collins Radio 17009
HallikainenAndFriends 18883
RCA 19005
Broadcast Electronics 19284
GeneralRadio 28833
Help/TextFormattingRules 30494

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