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

249 pages link to HomePage:
|<<   << - 1 / 5 - Next >>   >>|
|<<   << - 1 / 5 - Next >>   >>|
Page Name. HitsClick to reverse sort order
Valcom 60
Jampro Antenna 107
dbx 145
GeneralElectric 171
Will-Burt Company 232
CBS Labs 260
Continental Electronics 265
Electronics Digest 344
Marti Electronics, Inc. 349
Wheatstone Corporation 360
Circuit Research Laboratories 396
Dolby Laboratories 423
Ratheon 434
OldMarkupTestPage 456
template 462
RedirectToPlugin 471
Help/OldMarkupTestPage 477
Help/OldMarkupTestPage 477
Help/OldMarkupTestPage 477
Andrew Corporation 480
Potomac Instruments 482
McMartin 483
Help/NewMarkupTestPage 487
Help/NewMarkupTestPage 487
Help/NewMarkupTestPage 487
OldTextFormattingRules 489
Help/OldTextFormattingRules 498
NewMarkupTestPage 500
UREI 512
CCA 513
Radio Engineering 537
AmministrazioneDiPhpWiki 542
GatesRadioCatalog99 599
Goldline 652
Revox 658
Teac 659
Hewlett Packard 679
UMC Beaucart 688
Sony 709
Cablewave Systems 709
Radio Business Report 721
IncludePagePlugin 730
3M 734
Fidelipac 743
Realistic 749
Thordarson 750
Harris Allied 752
Elgin Electronics 761
Tektronix 768
Station Histories 823
Telos 823
MoseleyAssociatesInc 824
Johnson Electronics 841
Aristocart 849
Electronics Research, Inc. 852
QRK 862
Heathkit 863
Contel ASC 864
Telfax 869
Federated Purchaser 875
TFT, Inc. 876
Hollyanne 890
Moulic Specialties Co. 893
Standard Telephones & Cables. Australia 909
Multronics 914
Straight Wire Audio 915
Microcon 926
Mullard 932
ITC 933
Sine Systems 936
Magnecord 943
Consolidated Electronic Industries 943
Standard Electronics 946
Pultec 947
Clear-Com 947
Audi-Cord Corporation 947
Studer 948
Trimax 951
Broadcast Television Systems 958
Sparta Electronics 966
United Transformer Corporation 970
Engineering Services 976
Cutting Edge Technologies 979
Presto 986
Byer Industries 997
Radio Engineering Laboratories 998
Broadcast Tools 1002
Historic Papers 1003
Broadcasters General Store 1009
National 1012
Coastcom 1023
EfJohnson 1026
Triplett 1031
HoweTech 1034
Telefile Computer Products, Inc. 1041
Westinghouse 1048
Kenneth A. Bacon Associates 1050
Tepco 1052
Scala 1052
Panasonic 1063
MilitaryRadio 1066
Nova Systems, Inc. 1066
Peak Audio 1071
Dayton Industrial 1076
Conex Electro Systems 1076
Machlett Laboratories 1079
Help/EditMetaDataPlugin 1081
Video Systems of America 1081
Marconi Wireless Telegraph Company 1083
Garner Industries 1088
Bosch 1091
NBC 1091
Scully 1094
Boonton Radio Corporation 1097
Motorola 1098
ITA 1098
Marantz 1098
EimacDivisionOfVarian 1099
GatesAir 1105
Midwest Communications 1105
Multi-technical Services 1108
NAD Electronics 1110
Help/RedirectToPlugin 1113
Gentner 1113
Lang Electronics 1125
Wegener Communications 1131
Link, Fred M 1133
Victoreen Instrument Company 1138
Studer International AG 1148
Tentel 1151
Bauer Electronics Corporation 1153
Continental Satellite Systems 1153
US Audio 1154
J. G. S. Engineering Inc. 1163
NemsClarke 1167
Philips 1169
Russco 1170
Audio Arts 1176
Electrovoice 1182
Jennings 1183
Comtech Antenna Corporation 1187
Lorain Products Corporation 1190
Harman Kardon 1195
Farallon 1195
Jensen Transformers 1196
Leeds & Northrup Company 1196
Standart Tape Laboratory 1197
Simpson Electric Company 1212
Gregg Laboratories 1220
Sescom 1250
Yokogawa Electric Works 1254
Otari 1259
Technics 1264
Taber Manufacturing and Engineering Company 1269
Soltec 1271
Data Systems Design 1274
PhpWikiAdministration 1276
Dataworld 1278
IGM 1279
Anton Electronic Laboratories 1281
Texar 1289
Amperite 1293
Denon 1298
Frese and Kaping 1314
IRC 1316
Langevin 1319
AmperexElectronicCorporation 1327
Ohmite Manufacturing Company 1328
Electronic Signal Products 1331
Harris Corporation - Broadcast Division 1336
Aphex Systems Limited 1338
Dorrough Electronics 1345
Computer Concepts 1348
Extel 1351
SMC 1375
Automated Broadcast Controls 1383
Pacific Recorders and Engineers 1388
Gorman-Redlich 1424
Norcom 1440
McIntosh 1443
Bext 1445
Teletronix Engineering Company 1483
Aston 1487
Lambda Electronics Corp. 1487
Thompson-CSF 1509
ATI 1512
MCI 1522
Bird Electronic Corporation 1525
Schafer Automation 1529
Bell Telephone Laboratories 1541
Dumont 1544
Raytheon 1558
Rust Industrial Company, Inc. 1575
Radix 1579
Weston 1586
Kinght-kit 1591
Kenwood 1607
Measurements 1618
National Association of Broadcasters 1643
Minicom Division of 3M 1662
American Electronic Laboratories 1664
BME - Broadcast Management Engineering Magazine 1676
ComStream 1677
Inovonics 1683
Larcan 1710
Hughey & Phillips 1761
American Data 1804
Amalgamated Wireless (Australiasia) Ltd. 1816
Kyocera 1864
Energy-Onix 1899
Metrotech 1900
Advanced Research & Technology 1933
Neotek 1949
Symmetrix 1960
WesternElectric 1967
HallikainenAndFriends 1975
Modulation Sciences 2015
C & D Batteries 2020
Dana Electronics 2021
Microwave Radio Corporation 2041
Cetec Broadcast Group 2053
Accurate Sound Corporation 2071
Arrakis Systems, Inc 2132
Altec 2137
CSI 2188
MEI 2253
Hallicrafters 2279
Nortronics 2280
Ampex 2319
Broadcast Audio 2345
GatesRadioCompany 2359
Collins Radio 2456
DeltaElectronics 2537
Tapecaster 2537
Orban 2633
Broadcast Electronics 2635
RCA 2640
ESE 2708
Burk Technology 2731
Belar Electronics Laboratory 2808
Crown 2814
Auditronics 2901
QEI 3468
LPB 3706
GeneralRadio 3870
Autogram 4363
Armstrong Transmitter Corporation 5774
TextFormattingRules 6340
Help/TextFormattingRules 15118

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