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 6000
PhpWikiAdministration 617
Help/EditMetaDataPlugin 613
Help/RedirectToPlugin 636
TextFormattingRules 3873
OldTextFormattingRules 231
RedirectToPlugin 244
NewMarkupTestPage 245
OldMarkupTestPage 237
IncludePagePlugin 309
AmperexElectronicCorporation 782
DeltaElectronics 1274
EimacDivisionOfVarian 594
GatesRadioCompany 7499
GatesRadioCatalog99 310
GeneralElectric 1632
GeneralRadio 7652
HallikainenAndFriends 7065
MoseleyAssociatesInc 2221
Motorola 631
National 623
NemsClarke 555
RCA 8095
WesternElectric 1047
Technics 727
Westinghouse 639
MilitaryRadio 2794
Historic Papers 4330
Station Histories 2290
Ratheon 236
Raytheon 883
EfJohnson 650
American Electronic Laboratories 962
Victoreen Instrument Company 666
Anton Electronic Laboratories 795
Collins Radio 6917
HoweTech 639
Belar Electronics Laboratory 1629
Ampex 5694
Harris Corporation - Broadcast Division 5072
Dorrough Electronics 1754
Radio Engineering Laboratories 588
Standard Electronics 583
Amalgamated Wireless (Australiasia) Ltd. 1164
Byer Industries 554
Circuit Research Laboratories 1138
Bauer Electronics Corporation 651
Trimax 542
United Transformer Corporation 577
template 259
Philips 672
McMartin 1524
ITA 709
Continental Electronics 1924
Magnecord 536
TFT, Inc. 3353
Schafer Automation 919
Gentner 3602
Texar 719
Langevin 769
Altec 1295
CBS Labs 1761
Pultec 575
Sony 1875
3M 2413
UREI 1382
Frese and Kaping 741
Revox 1837
Federated Purchaser 495
CCA 1505
LPB 2136
Hollyanne 523
Telfax 519
Help/OldTextFormattingRules 250
AmministrazioneDiPhpWiki 253
Help/NewMarkupTestPage 252
Help/NewMarkupTestPage 252
Help/NewMarkupTestPage 252
Help/OldMarkupTestPage 244
Help/OldMarkupTestPage 244
Help/OldMarkupTestPage 244
Larcan 907
Tepco 647
Standard Telephones & Cables. Australia 509
Presto 595
Straight Wire Audio 513
Arrakis Systems, Inc 1238
Consolidated Electronic Industries 558
Aphex Systems Limited 816
QEI 1991
Multronics 548
ITC 2124
Machlett Laboratories 660
Cutting Edge Technologies 508
Bext 852
Tektronix 1904
Electronics Research, Inc. 494
Advanced Research & Technology 1160
Marantz 603
Microcon 532
Broadcast Television Systems 537
Bosch 663
dbx 1612
Otari 714
Crown 1574
Broadcast Electronics 5668
ATI 885
Scully 615
Marti Electronics, Inc. 1349
Harman Kardon 594
Potomac Instruments 1350
Broadcast Audio 1281
Andrew Corporation 1406
Audio Arts 729
Bird Electronic Corporation 10257
Dumont 919
Autogram 2193
Radio Engineering 247
Heathkit 2528
Mullard 570
NBC 671
Amperite 788
McIntosh 871
Inovonics 882
Neotek 1105
Moulic Specialties Co. 510
Engineering Services 573
IRC 807
ESE 1357
Comtech Antenna Corporation 719
Panasonic 2809
Orban 1474
Studer 558
Coastcom 610
Clear-Com 554
Dolby Laboratories 1295
CSI 1237
Bell Telephone Laboratories 899
Pacific Recorders and Engineers 875
Hewlett Packard 1993
Sparta Electronics 2240
Tapecaster 1446
Scala 668
Marconi Wireless Telegraph Company 717
Energy-Onix 1107
Modulation Sciences 1143
Burk Technology 1297
Auditronics 1618
Jampro Antenna 959
Dayton Industrial 3044
Thompson-CSF 820
Rust Industrial Company, Inc. 933
Accurate Sound Corporation 1243
IGM 779
SMC 768
Radix 890
Fidelipac 1902
Hughey & Phillips 927
Microwave Radio Corporation 1084
Broadcast Tools 2296
Symmetrix 1008
GatesAir 609
Hallicrafters 1267
Kenwood 970
Kyocera 1034
Teac 1768
Wheatstone Corporation 1037
Gorman-Redlich 827
Studer International AG 660
Data Systems Design 723
Dana Electronics 1176
American Data 1065
Teletronix Engineering Company 879
Tentel 720
Taber Manufacturing and Engineering Company 825
Standart Tape Laboratory 688
Extel 792
Russco 697
Automated Broadcast Controls 814
Electrovoice 684
Jennings 707
Wegener Communications 659
Midwest Communications 656
Aston 943
Farallon 684
Kenneth A. Bacon Associates 575
J. G. S. Engineering Inc. 677
Continental Satellite Systems 650
ComStream 908
Conex Electro Systems 618
Denon 782
Multi-technical Services 633
Electronic Signal Products 754
Lorain Products Corporation 652
C & D Batteries 1101
Nova Systems, Inc. 605
Nortronics 1260
Norcom 831
Lambda Electronics Corp. 824
US Audio 640
Jensen Transformers 703
Garner Industries 630
Sescom 769
Soltec 735
Peak Audio 606
MCI 929
MEI 1276
Minicom Division of 3M 978
Metrotech 1101
Lang Electronics 633
Kinght-kit 924
Cetec Broadcast Group 1221
Computer Concepts 802
Dataworld 776
National Association of Broadcasters 932
Link, Fred M 674
Weston 933
Yokogawa Electric Works 810
Measurements 952
Electronics Digest 984
Gregg Laboratories 712
Leeds & Northrup Company 694
Video Systems of America 558
Simpson Electric Company 722
Triplett 584
Boonton Radio Corporation 614
Ohmite Manufacturing Company 840
Contel ASC 397
Audi-Cord Corporation 428
Johnson Electronics 404
Telefile Computer Products, Inc. 620
Realistic 247
Thordarson 262
Sine Systems 308
Telos 310
Harris Allied 240
Broadcasters General Store 362
QRK 354
BME - Broadcast Management Engineering Magazine 1120
Radio Business Report 231
UMC Beaucart 170
Armstrong Transmitter Corporation 3897
Cablewave Systems 136
Aristocart 168
Elgin Electronics 193
Goldline 138
NAD Electronics 540

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