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
Help/TextFormattingRules 15907
Bird Electronic Corporation 7583
TextFormattingRules 6825
GeneralRadio 6585
Armstrong Transmitter Corporation 5864
RCA 5100
Autogram 4872
Broadcast Electronics 4375
Collins Radio 4187
GatesRadioCompany 4029
LPB 3973
Ampex 3768
QEI 3768
HallikainenAndFriends 3618
Auditronics 3138
Crown 3126
DeltaElectronics 3022
ESE 3004
Belar Electronics Laboratory 3000
Burk Technology 2968
Orban 2876
Tapecaster 2821
Historic Papers 2670
Broadcast Audio 2517
MEI 2493
Hallicrafters 2472
Nortronics 2470
CSI 2377
Harris Corporation - Broadcast Division 2355
Arrakis Systems, Inc 2304
Altec 2292
Cetec Broadcast Group 2234
C & D Batteries 2228
Accurate Sound Corporation 2211
Modulation Sciences 2203
Microwave Radio Corporation 2181
Dana Electronics 2152
Symmetrix 2147
WesternElectric 2137
Neotek 2101
Energy-Onix 2055
Advanced Research & Technology 2047
Metrotech 2047
Kyocera 2043
Dorrough Electronics 1999
Gentner 1997
American Data 1945
Hughey & Phillips 1938
Amalgamated Wireless (Australiasia) Ltd. 1923
MilitaryRadio 1863
ComStream 1847
Inovonics 1838
Larcan 1833
American Electronic Laboratories 1822
BME - Broadcast Management Engineering Magazine 1795
Minicom Division of 3M 1771
National Association of Broadcasters 1764
Dayton Industrial 1743
Measurements 1741
Kenwood 1739
Weston 1722
Panasonic 1719
Kinght-kit 1711
Radix 1710
Rust Industrial Company, Inc. 1695
Bell Telephone Laboratories 1677
Raytheon 1662
ATI 1658
Thompson-CSF 1658
Schafer Automation 1648
MCI 1647
Dumont 1640
Lambda Electronics Corp. 1624
Teletronix Engineering Company 1585
Aston 1582
McIntosh 1574
Sparta Electronics 1564
Gorman-Redlich 1540
Bext 1533
Norcom 1533
Pacific Recorders and Engineers 1501
Heathkit 1482
SMC 1479
Broadcast Tools 1473
Automated Broadcast Controls 1469
Electronic Signal Products 1458
Extel 1444
Langevin 1434
Computer Concepts 1433
AmperexElectronicCorporation 1414
Frese and Kaping 1413
Aphex Systems Limited 1413
IRC 1406
Ohmite Manufacturing Company 1403
Texar 1393
ITC 1385
PhpWikiAdministration 1384
Denon 1379
Otari 1376
Amperite 1373
Anton Electronic Laboratories 1367
Soltec 1366
Data Systems Design 1360
IGM 1358
Dataworld 1356
Sescom 1352
Taber Manufacturing and Engineering Company 1349
Technics 1338
TFT, Inc. 1332
Yokogawa Electric Works 1329
Gregg Laboratories 1307
Leeds & Northrup Company 1296
Simpson Electric Company 1293
Farallon 1289
Electrovoice 1285
Lorain Products Corporation 1284
Comtech Antenna Corporation 1283
Harman Kardon 1282
Standart Tape Laboratory 1280
Station Histories 1275
NemsClarke 1272
Jensen Transformers 1270
Jennings 1266
Audio Arts 1259
Russco 1251
Philips 1249
Studer International AG 1245
Continental Satellite Systems 1244
J. G. S. Engineering Inc. 1240
Tentel 1233
Link, Fred M 1228
US Audio 1227
Victoreen Instrument Company 1222
MoseleyAssociatesInc 1216
Bauer Electronics Corporation 1213
Midwest Communications 1212
Wegener Communications 1210
Multi-technical Services 1209
3M 1205
Motorola 1196
Marantz 1195
Lang Electronics 1192
GatesAir 1188
NAD Electronics 1188
Video Systems of America 1186
Help/EditMetaDataPlugin 1180
Scully 1180
EimacDivisionOfVarian 1176
Boonton Radio Corporation 1169
Help/RedirectToPlugin 1168
Garner Industries 1165
ITA 1164
Machlett Laboratories 1164
NBC 1157
Bosch 1156
Peak Audio 1155
Conex Electro Systems 1148
Marconi Wireless Telegraph Company 1144
Kenneth A. Bacon Associates 1144
Tektronix 1142
Scala 1131
Sony 1130
Broadcasters General Store 1127
Nova Systems, Inc. 1125
Tepco 1121
Triplett 1119
Telefile Computer Products, Inc. 1113
Coastcom 1110
Westinghouse 1103
Fidelipac 1102
National 1093
EfJohnson 1090
HoweTech 1086
Engineering Services 1068
Radio Engineering Laboratories 1067
Presto 1064
Byer Industries 1060
Sine Systems 1059
Revox 1051
United Transformer Corporation 1045
Cutting Edge Technologies 1029
Studer 1025
Hewlett Packard 1024
Consolidated Electronic Industries 1021
Audi-Cord Corporation 1020
Pultec 1018
Broadcast Television Systems 1013
Trimax 1012
Magnecord 1007
Standard Telephones & Cables. Australia 1007
Clear-Com 1007
Standard Electronics 996
Mullard 995
Multronics 985
Microcon 983
Hollyanne 968
Straight Wire Audio 965
Federated Purchaser 964
Aristocart 958
QRK 956
Teac 953
Moulic Specialties Co. 949
Contel ASC 939
Telfax 937
Johnson Electronics 914
Telos 903
Electronics Research, Inc. 895
Potomac Instruments 863
Harris Allied 842
Elgin Electronics 842
Thordarson 829
Realistic 825
Andrew Corporation 820
Radio Business Report 812
IncludePagePlugin 800
UMC Beaucart 793
UREI 787
CCA 787
Cablewave Systems 776
McMartin 749
Continental Electronics 743
Goldline 736
GatesRadioCatalog99 644
Dolby Laboratories 607
Marti Electronics, Inc. 605
AmministrazioneDiPhpWiki 582
Radio Engineering 580
Wheatstone Corporation 573
CBS Labs 563
NewMarkupTestPage 546
Help/OldTextFormattingRules 542
OldMarkupTestPage 533
OldTextFormattingRules 530
Help/NewMarkupTestPage 529
Help/NewMarkupTestPage 529
Help/NewMarkupTestPage 529
Help/OldMarkupTestPage 526
Help/OldMarkupTestPage 526
Help/OldMarkupTestPage 526
template 523
Circuit Research Laboratories 511
RedirectToPlugin 500
Electronics Digest 499
Ratheon 493
GeneralElectric 475
dbx 463
Will-Burt Company 343
Jampro Antenna 323
Valcom 300

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