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

247 pages link to HomePage:
|<<   << - 1 / 5 - Next >>   >>|
|<<   << - 1 / 5 - Next >>   >>|
Page Name. Hits.
Help/TextFormattingRules 11616
PhpWikiAdministration 736
Help/EditMetaDataPlugin 715
Help/RedirectToPlugin 746
TextFormattingRules 4633
OldTextFormattingRules 304
RedirectToPlugin 295
NewMarkupTestPage 290
OldMarkupTestPage 282
IncludePagePlugin 462
AmperexElectronicCorporation 949
DeltaElectronics 1595
EimacDivisionOfVarian 758
GatesRadioCompany 9147
GatesRadioCatalog99 361
GeneralElectric 1988
GeneralRadio 9302
HallikainenAndFriends 8930
MoseleyAssociatesInc 6890
Motorola 733
National 734
NemsClarke 684
RCA 9605
WesternElectric 1299
Technics 882
Westinghouse 758
MilitaryRadio 3441
Historic Papers 5264
Station Histories 2745
Ratheon 285
Raytheon 1094
EfJohnson 759
American Electronic Laboratories 1178
Victoreen Instrument Company 805
Anton Electronic Laboratories 938
Collins Radio 8441
HoweTech 762
Belar Electronics Laboratory 1991
Ampex 7116
Harris Corporation - Broadcast Division 6220
Dorrough Electronics 2804
Radio Engineering Laboratories 701
Standard Electronics 670
Amalgamated Wireless (Australiasia) Ltd. 1370
Byer Industries 686
Circuit Research Laboratories 1423
Bauer Electronics Corporation 790
Trimax 666
United Transformer Corporation 670
template 316
Philips 811
McMartin 1853
ITA 823
Continental Electronics 2544
Magnecord 663
TFT, Inc. 3975
Schafer Automation 1105
Gentner 4244
Texar 875
Langevin 925
Altec 1516
CBS Labs 2193
Pultec 685
Sony 2348
3M 2871
UREI 1711
Frese and Kaping 907
Revox 2233
Federated Purchaser 602
CCA 1861
LPB 2622
Hollyanne 626
Telfax 611
Help/OldTextFormattingRules 295
AmministrazioneDiPhpWiki 297
Help/NewMarkupTestPage 296
Help/NewMarkupTestPage 296
Help/NewMarkupTestPage 296
Help/OldMarkupTestPage 286
Help/OldMarkupTestPage 286
Help/OldMarkupTestPage 286
Larcan 1137
Tepco 782
Standard Telephones & Cables. Australia 619
Presto 716
Straight Wire Audio 633
Arrakis Systems, Inc 1493
Consolidated Electronic Industries 652
Aphex Systems Limited 976
QEI 2454
Multronics 638
ITC 2696
Machlett Laboratories 773
Cutting Edge Technologies 638
Bext 1022
Tektronix 2281
Electronics Research, Inc. 590
Advanced Research & Technology 1397
Marantz 748
Microcon 657
Broadcast Television Systems 634
Bosch 786
dbx 2033
Otari 871
Crown 1879
Broadcast Electronics 7569
ATI 1088
Scully 755
Marti Electronics, Inc. 1732
Harman Kardon 772
Potomac Instruments 1674
Broadcast Audio 1552
Andrew Corporation 1738
Audio Arts 854
Bird Electronic Corporation 15132
Dumont 1096
Autogram 2684
Radio Engineering 299
Heathkit 3067
Mullard 658
NBC 779
Amperite 933
McIntosh 1047
Inovonics 1075
Neotek 1341
Moulic Specialties Co. 624
Engineering Services 699
IRC 960
ESE 1733
Comtech Antenna Corporation 839
Panasonic 3504
Orban 1843
Studer 665
Coastcom 720
Clear-Com 660
Dolby Laboratories 1508
CSI 1496
Bell Telephone Laboratories 1079
Pacific Recorders and Engineers 1020
Hewlett Packard 2432
Sparta Electronics 2857
Tapecaster 1745
Scala 785
Marconi Wireless Telegraph Company 813
Energy-Onix 1284
Modulation Sciences 1355
Burk Technology 1665
Auditronics 2007
Jampro Antenna 1145
Dayton Industrial 3782
Thompson-CSF 1023
Rust Industrial Company, Inc. 1134
Accurate Sound Corporation 1493
IGM 936
SMC 943
Radix 1100
Fidelipac 2293
Hughey & Phillips 1169
Microwave Radio Corporation 1351
Broadcast Tools 2778
Symmetrix 1227
GatesAir 742
Hallicrafters 1509
Kenwood 1166
Kyocera 1267
Teac 2198
Wheatstone Corporation 1313
Gorman-Redlich 1005
Studer International AG 771
Data Systems Design 877
Dana Electronics 1387
American Data 1301
Teletronix Engineering Company 1072
Tentel 833
Taber Manufacturing and Engineering Company 951
Standart Tape Laboratory 826
Extel 956
Russco 830
Automated Broadcast Controls 982
Electrovoice 817
Jennings 846
Wegener Communications 793
Midwest Communications 777
Aston 1096
Farallon 842
Kenneth A. Bacon Associates 719
J. G. S. Engineering Inc. 827
Continental Satellite Systems 795
ComStream 1140
Conex Electro Systems 744
Denon 930
Multi-technical Services 775
Electronic Signal Products 937
Lorain Products Corporation 824
C & D Batteries 1344
Nova Systems, Inc. 742
Nortronics 1569
Norcom 1014
Lambda Electronics Corp. 1050
US Audio 791
Jensen Transformers 822
Garner Industries 752
Sescom 907
Soltec 880
Peak Audio 720
MCI 1099
MEI 1557
Minicom Division of 3M 1186
Metrotech 1324
Lang Electronics 762
Kinght-kit 1130
Cetec Broadcast Group 1452
Computer Concepts 948
Dataworld 928
National Association of Broadcasters 1121
Link, Fred M 803
Weston 1115
Yokogawa Electric Works 935
Measurements 1152
Electronics Digest 1209
Gregg Laboratories 846
Leeds & Northrup Company 863
Video Systems of America 720
Simpson Electric Company 853
Triplett 714
Boonton Radio Corporation 745
Ohmite Manufacturing Company 978
Contel ASC 510
Audi-Cord Corporation 559
Johnson Electronics 513
Telefile Computer Products, Inc. 732
Realistic 393
Thordarson 391
Sine Systems 493
Telos 473
Harris Allied 380
Broadcasters General Store 574
QRK 507
BME - Broadcast Management Engineering Magazine 1288
Radio Business Report 358
UMC Beaucart 333
Armstrong Transmitter Corporation 5349
Cablewave Systems 288
Aristocart 384
Elgin Electronics 361
Goldline 288
NAD Electronics 716

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