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 73
Jampro Antenna 120
dbx 176
GeneralElectric 192
Will-Burt Company 236
CBS Labs 278
Continental Electronics 294
Electronics Digest 351
Marti Electronics, Inc. 353
Wheatstone Corporation 376
Circuit Research Laboratories 401
Ratheon 435
Dolby Laboratories 436
OldMarkupTestPage 458
template 465
RedirectToPlugin 471
Help/OldMarkupTestPage 478
Help/OldMarkupTestPage 478
Help/OldMarkupTestPage 478
McMartin 486
Help/NewMarkupTestPage 487
Help/NewMarkupTestPage 487
Help/NewMarkupTestPage 487
OldTextFormattingRules 489
Andrew Corporation 498
Help/OldTextFormattingRules 501
NewMarkupTestPage 502
Potomac Instruments 510
CCA 528
UREI 531
Radio Engineering 538
AmministrazioneDiPhpWiki 542
GatesRadioCatalog99 600
Goldline 660
Teac 673
Revox 689
Hewlett Packard 690
UMC Beaucart 696
Cablewave Systems 715
IncludePagePlugin 731
Radio Business Report 731
Sony 733
3M 741
Realistic 754
Thordarson 758
Harris Allied 760
Elgin Electronics 767
Fidelipac 769
Tektronix 791
MoseleyAssociatesInc 830
Telos 832
Station Histories 846
Johnson Electronics 846
Electronics Research, Inc. 853
Aristocart 858
Contel ASC 870
QRK 870
Telfax 872
Federated Purchaser 879
TFT, Inc. 891
Hollyanne 893
Moulic Specialties Co. 895
Heathkit 907
Standard Telephones & Cables. Australia 914
Straight Wire Audio 916
Multronics 917
Microcon 928
Mullard 935
Magnecord 944
Consolidated Electronic Industries 946
Sine Systems 946
Standard Electronics 947
Pultec 950
Clear-Com 950
Audi-Cord Corporation 952
Trimax 953
Studer 954
Broadcast Television Systems 962
ITC 963
United Transformer Corporation 974
Engineering Services 979
Cutting Edge Technologies 981
Presto 988
Byer Industries 999
Radio Engineering Laboratories 1000
Sparta Electronics 1013
National 1015
Broadcasters General Store 1016
Coastcom 1026
EfJohnson 1030
HoweTech 1036
Broadcast Tools 1040
Triplett 1040
Telefile Computer Products, Inc. 1047
Westinghouse 1052
Tepco 1054
Scala 1054
Kenneth A. Bacon Associates 1055
Nova Systems, Inc. 1067
Panasonic 1077
Conex Electro Systems 1077
Peak Audio 1078
Machlett Laboratories 1081
Marconi Wireless Telegraph Company 1084
Help/EditMetaDataPlugin 1086
Video Systems of America 1088
Bosch 1092
NBC 1092
Garner Industries 1093
Scully 1097
Historic Papers 1098
Motorola 1100
ITA 1100
EimacDivisionOfVarian 1103
Boonton Radio Corporation 1103
Marantz 1104
GatesAir 1106
Midwest Communications 1109
MilitaryRadio 1111
Dayton Industrial 1111
Multi-technical Services 1115
Help/RedirectToPlugin 1118
NAD Electronics 1118
Lang Electronics 1128
Wegener Communications 1136
Link, Fred M 1138
Victoreen Instrument Company 1141
Gentner 1147
Bauer Electronics Corporation 1154
Studer International AG 1155
Tentel 1156
US Audio 1159
Continental Satellite Systems 1160
J. G. S. Engineering Inc. 1166
NemsClarke 1171
Russco 1172
Philips 1174
Audio Arts 1179
Jennings 1189
Electrovoice 1190
Comtech Antenna Corporation 1193
Lorain Products Corporation 1194
Farallon 1200
Jensen Transformers 1201
Standart Tape Laboratory 1202
Leeds & Northrup Company 1202
Harman Kardon 1206
Simpson Electric Company 1220
Gregg Laboratories 1227
Sescom 1254
Yokogawa Electric Works 1257
Otari 1269
Technics 1270
Taber Manufacturing and Engineering Company 1274
Soltec 1274
PhpWikiAdministration 1279
Data Systems Design 1279
Anton Electronic Laboratories 1282
IGM 1282
Dataworld 1283
Texar 1295
Amperite 1295
Denon 1304
Frese and Kaping 1320
IRC 1321
Langevin 1326
AmperexElectronicCorporation 1330
Electronic Signal Products 1336
Ohmite Manufacturing Company 1336
Aphex Systems Limited 1340
Computer Concepts 1352
Extel 1355
SMC 1385
Automated Broadcast Controls 1390
Dorrough Electronics 1391
Pacific Recorders and Engineers 1394
Harris Corporation - Broadcast Division 1395
Gorman-Redlich 1431
Norcom 1443
McIntosh 1451
Bext 1453
Teletronix Engineering Company 1489
Aston 1493
Lambda Electronics Corp. 1496
ATI 1519
Thompson-CSF 1521
MCI 1532
Schafer Automation 1536
Bell Telephone Laboratories 1548
Dumont 1549
Bird Electronic Corporation 1560
Raytheon 1565
Rust Industrial Company, Inc. 1583
Radix 1590
Kinght-kit 1597
Weston 1600
Kenwood 1618
Measurements 1631
National Association of Broadcasters 1651
Minicom Division of 3M 1665
American Electronic Laboratories 1671
BME - Broadcast Management Engineering Magazine 1683
ComStream 1689
Inovonics 1692
Larcan 1720
Hughey & Phillips 1764
American Data 1814
Amalgamated Wireless (Australiasia) Ltd. 1823
Kyocera 1877
Metrotech 1907
Energy-Onix 1909
Advanced Research & Technology 1938
Neotek 1955
WesternElectric 1971
Symmetrix 1975
Modulation Sciences 2029
Dana Electronics 2031
C & D Batteries 2032
Microwave Radio Corporation 2054
HallikainenAndFriends 2061
Cetec Broadcast Group 2065
Accurate Sound Corporation 2074
Arrakis Systems, Inc 2142
Altec 2145
CSI 2200
MEI 2261
Nortronics 2292
Hallicrafters 2295
Broadcast Audio 2349
GatesRadioCompany 2377
Ampex 2415
Collins Radio 2544
Tapecaster 2559
DeltaElectronics 2568
Orban 2647
Broadcast Electronics 2721
ESE 2728
Burk Technology 2736
RCA 2753
Belar Electronics Laboratory 2814
Crown 2822
Auditronics 2926
QEI 3472
LPB 3725
GeneralRadio 3990
Autogram 4407
Armstrong Transmitter Corporation 5779
TextFormattingRules 6369
Help/TextFormattingRules 15162

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