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 97
Jampro Antenna 133
dbx 209
GeneralElectric 223
Will-Burt Company 243
CBS Labs 295
Continental Electronics 333
Marti Electronics, Inc. 358
Electronics Digest 363
Wheatstone Corporation 384
Circuit Research Laboratories 416
Ratheon 440
Dolby Laboratories 449
OldMarkupTestPage 468
template 471
RedirectToPlugin 474
Help/OldMarkupTestPage 484
Help/OldMarkupTestPage 484
Help/OldMarkupTestPage 484
Help/NewMarkupTestPage 491
Help/NewMarkupTestPage 491
Help/NewMarkupTestPage 491
OldTextFormattingRules 493
McMartin 502
NewMarkupTestPage 507
Help/OldTextFormattingRules 508
Andrew Corporation 512
Potomac Instruments 527
Radio Engineering 541
AmministrazioneDiPhpWiki 543
UREI 553
CCA 555
GatesRadioCatalog99 602
Goldline 664
Teac 697
Hewlett Packard 703
UMC Beaucart 706
Cablewave Systems 719
IncludePagePlugin 738
Radio Business Report 742
Revox 744
Realistic 760
Thordarson 763
Harris Allied 766
Elgin Electronics 772
Sony 786
Fidelipac 789
3M 808
Tektronix 824
Telos 837
Johnson Electronics 850
MoseleyAssociatesInc 853
Electronics Research, Inc. 858
Aristocart 869
Station Histories 877
Telfax 878
Contel ASC 879
QRK 880
Federated Purchaser 883
Moulic Specialties Co. 899
Hollyanne 901
TFT, Inc. 910
Standard Telephones & Cables. Australia 920
Straight Wire Audio 921
Multronics 926
Microcon 931
Mullard 942
Heathkit 948
Magnecord 950
Standard Electronics 952
Consolidated Electronic Industries 952
Clear-Com 956
Sine Systems 956
Audi-Cord Corporation 958
Pultec 960
Studer 960
Trimax 961
Broadcast Television Systems 965
United Transformer Corporation 981
Cutting Edge Technologies 985
Engineering Services 985
Presto 995
Byer Industries 1003
Radio Engineering Laboratories 1014
ITC 1020
National 1025
Broadcasters General Store 1029
Coastcom 1035
EfJohnson 1039
HoweTech 1039
Sparta Electronics 1040
Triplett 1046
Telefile Computer Products, Inc. 1052
Westinghouse 1056
Broadcast Tools 1060
Tepco 1061
Kenneth A. Bacon Associates 1062
Scala 1064
Nova Systems, Inc. 1071
Conex Electro Systems 1083
Peak Audio 1086
Machlett Laboratories 1088
Marconi Wireless Telegraph Company 1092
Help/EditMetaDataPlugin 1094
Bosch 1096
NBC 1097
Garner Industries 1099
Video Systems of America 1100
Scully 1104
ITA 1105
Panasonic 1105
Boonton Radio Corporation 1107
EimacDivisionOfVarian 1108
Motorola 1110
Marantz 1115
GatesAir 1115
Midwest Communications 1119
NAD Electronics 1122
Help/RedirectToPlugin 1123
Multi-technical Services 1125
Lang Electronics 1134
Wegener Communications 1143
MilitaryRadio 1144
Link, Fred M 1144
Victoreen Instrument Company 1146
Dayton Industrial 1153
Bauer Electronics Corporation 1159
Tentel 1161
Studer International AG 1167
US Audio 1167
Continental Satellite Systems 1173
J. G. S. Engineering Inc. 1174
Russco 1177
NemsClarke 1181
Philips 1183
Audio Arts 1185
Jennings 1196
Historic Papers 1200
Comtech Antenna Corporation 1200
Electrovoice 1200
Lorain Products Corporation 1203
Jensen Transformers 1205
Standart Tape Laboratory 1210
Farallon 1210
Leeds & Northrup Company 1210
Harman Kardon 1214
Simpson Electric Company 1224
Gregg Laboratories 1231
Gentner 1235
Yokogawa Electric Works 1262
Sescom 1264
Otari 1277
Technics 1279
Taber Manufacturing and Engineering Company 1279
Soltec 1280
Data Systems Design 1285
Anton Electronic Laboratories 1288
Dataworld 1290
IGM 1291
PhpWikiAdministration 1292
Amperite 1301
Texar 1309
Denon 1310
IRC 1332
Frese and Kaping 1334
Langevin 1337
AmperexElectronicCorporation 1338
Ohmite Manufacturing Company 1341
Electronic Signal Products 1348
Aphex Systems Limited 1350
Computer Concepts 1355
Extel 1362
SMC 1392
Automated Broadcast Controls 1396
Pacific Recorders and Engineers 1406
Dorrough Electronics 1438
Gorman-Redlich 1445
Norcom 1449
McIntosh 1461
Bext 1464
Harris Corporation - Broadcast Division 1468
Teletronix Engineering Company 1498
Aston 1501
Lambda Electronics Corp. 1501
ATI 1530
Thompson-CSF 1533
Schafer Automation 1547
MCI 1547
Bell Telephone Laboratories 1558
Dumont 1560
Raytheon 1582
Rust Industrial Company, Inc. 1588
Radix 1602
Kinght-kit 1606
Weston 1611
Kenwood 1627
Measurements 1639
National Association of Broadcasters 1665
Minicom Division of 3M 1673
American Electronic Laboratories 1689
BME - Broadcast Management Engineering Magazine 1696
Inovonics 1699
ComStream 1699
Bird Electronic Corporation 1705
Larcan 1730
Hughey & Phillips 1781
American Data 1827
Amalgamated Wireless (Australiasia) Ltd. 1833
Kyocera 1888
Energy-Onix 1926
Metrotech 1926
Advanced Research & Technology 1946
Neotek 1974
WesternElectric 1984
Symmetrix 1986
Modulation Sciences 2036
Dana Electronics 2036
C & D Batteries 2052
Microwave Radio Corporation 2065
Cetec Broadcast Group 2081
Accurate Sound Corporation 2085
HallikainenAndFriends 2149
Altec 2155
Arrakis Systems, Inc 2156
CSI 2220
MEI 2289
Nortronics 2298
Hallicrafters 2302
Broadcast Audio 2358
Ampex 2462
GatesRadioCompany 2482
Tapecaster 2567
DeltaElectronics 2624
Collins Radio 2658
Orban 2666
ESE 2747
Burk Technology 2750
Broadcast Electronics 2757
Belar Electronics Laboratory 2832
Crown 2844
Auditronics 2941
RCA 3000
QEI 3485
LPB 3738
GeneralRadio 4089
Autogram 4427
Armstrong Transmitter Corporation 5788
TextFormattingRules 6404
Help/TextFormattingRules 15301

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