Help/TextFormattingRules

Note: You are viewing an old revision of this page. View the current version.

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 30455
PhpWikiAdministration 2379
Help/EditMetaDataPlugin 1893
Help/RedirectToPlugin 2049
TextFormattingRules 13050
OldTextFormattingRules 946
RedirectToPlugin 840
NewMarkupTestPage 963
OldMarkupTestPage 896
IncludePagePlugin 1316
AmperexElectronicCorporation 2048
DeltaElectronics 6014
EimacDivisionOfVarian 1915
GatesRadioCompany 16687
GatesRadioCatalog99 1234
GeneralElectric 3058
GeneralRadio 28807
HallikainenAndFriends 18770
MoseleyAssociatesInc 5331
Motorola 2046
National 1821
NemsClarke 2063
RCA 18890
WesternElectric 4097
Technics 2203
Westinghouse 1720
MilitaryRadio 7564
Historic Papers 6232
Station Histories 5575
Ratheon 831
Raytheon 2596
EfJohnson 1635
American Electronic Laboratories 2855
Victoreen Instrument Company 1857
Anton Electronic Laboratories 1889
Collins Radio 16972
HoweTech 1675
Belar Electronics Laboratory 4829
Ampex 15790
Harris Corporation - Broadcast Division 9099
Dorrough Electronics 7718
Radio Engineering Laboratories 1703
Standard Electronics 1503
Amalgamated Wireless (Australiasia) Ltd. 2826
Byer Industries 1707
Circuit Research Laboratories 2018
Bauer Electronics Corporation 2285
Trimax 1540
United Transformer Corporation 1657
template 918
Philips 2013
McMartin 3036
ITA 1715
Continental Electronics 4706
Magnecord 1951
TFT, Inc. 6173
Schafer Automation 2652
Gentner 6595
Texar 2304
Langevin 2433
Altec 3479
CBS Labs 3344
Pultec 1580
Sony 4630
3M 5313
UREI 2769
Frese and Kaping 2339
Revox 4363
Federated Purchaser 1464
CCA 3094
LPB 6417
Hollyanne 1504
Telfax 1463
Help/OldTextFormattingRules 887
AmministrazioneDiPhpWiki 960
Help/NewMarkupTestPage 886
Help/NewMarkupTestPage 886
Help/NewMarkupTestPage 886
Help/OldMarkupTestPage 856
Help/OldMarkupTestPage 856
Help/OldMarkupTestPage 856
Larcan 3046
Tepco 1687
Standard Telephones & Cables. Australia 1667
Presto 1657
Straight Wire Audio 1558
Arrakis Systems, Inc 3748
Consolidated Electronic Industries 1627
Aphex Systems Limited 2073
QEI 6986
Multronics 1537
ITC 5503
Machlett Laboratories 1767
Cutting Edge Technologies 1525
Bext 2324
Tektronix 4075
Electronics Research, Inc. 1355
Advanced Research & Technology 2974
Marantz 1965
Microcon 1503
Broadcast Television Systems 1901
Bosch 1747
dbx 3018
Otari 2260
Crown 5622
Broadcast Electronics 19099
ATI 2544
Scully 2085
Marti Electronics, Inc. 2785
Harman Kardon 2131
Potomac Instruments 3556
Broadcast Audio 4589
Andrew Corporation 2797
Audio Arts 1826
Bird Electronic Corporation 11884
Dumont 2576
Autogram 9409
Radio Engineering 982
Heathkit 75
Mullard 1732
NBC 1730
Amperite 1954
McIntosh 2521
Inovonics 3263
Neotek 3670
Moulic Specialties Co. 1424
Engineering Services 1569
IRC 2105
ESE 5159
Comtech Antenna Corporation 2013
Panasonic 7500
Orban 4936
Studer 1558
Coastcom 1698
Clear-Com 1670
Dolby Laboratories 2436
CSI 3877
Bell Telephone Laboratories 2680
Pacific Recorders and Engineers 2625
Hewlett Packard 4400
Sparta Electronics 6534
Tapecaster 4798
Scala 1705
Marconi Wireless Telegraph Company 1664
Energy-Onix 3493
Modulation Sciences 3859
Burk Technology 5338
Auditronics 5352
Jampro Antenna 1699
Dayton Industrial 6516
Thompson-CSF 2675
Rust Industrial Company, Inc. 2847
Accurate Sound Corporation 3267
IGM 2127
SMC 2474
Radix 2906
Fidelipac 3940
Hughey & Phillips 3277
Microwave Radio Corporation 3676
Broadcast Tools 1155
Symmetrix 3704
GatesAir 1799
Hallicrafters 4145
Kenwood 2925
Kyocera 3485
Teac 3940
Wheatstone Corporation 2246
Gorman-Redlich 2318
Studer International AG 1926
Data Systems Design 2166
Dana Electronics 3382
American Data 2941
Teletronix Engineering Company 2440
Tentel 2000
Taber Manufacturing and Engineering Company 2035
Standart Tape Laboratory 1992
Extel 2317
Russco 2168
Automated Broadcast Controls 2296
Electrovoice 1956
Jennings 1976
Wegener Communications 1928
Midwest Communications 1959
Aston 2334
Farallon 2053
Kenneth A. Bacon Associates 1858
J. G. S. Engineering Inc. 2102
Continental Satellite Systems 1983
ComStream 3072
Conex Electro Systems 1830
Denon 2118
Multi-technical Services 2066
Electronic Signal Products 2222
Lorain Products Corporation 1949
C & D Batteries 3673
Nova Systems, Inc. 1782
Nortronics 4156
Norcom 2609
Lambda Electronics Corp. 2625
US Audio 1876
Jensen Transformers 2036
Garner Industries 1917
Sescom 2107
Soltec 2180
Peak Audio 1820
MCI 2601
MEI 4339
Minicom Division of 3M 2830
Metrotech 3474
Lang Electronics 2057
Kinght-kit 2868
Cetec Broadcast Group 3692
Computer Concepts 2246
Dataworld 2081
National Association of Broadcasters 2864
Link, Fred M 1939
Weston 2876
Yokogawa Electric Works 1993
Measurements 2894
Electronics Digest 1663
Gregg Laboratories 2145
Leeds & Northrup Company 2025
Video Systems of America 1911
Simpson Electric Company 2030
Triplett 1960
Boonton Radio Corporation 1960
Ohmite Manufacturing Company 2099
Contel ASC 1650
Audi-Cord Corporation 1772
Johnson Electronics 1627
Telefile Computer Products, Inc. 1765
Realistic 1607
Thordarson 1615
Sine Systems 1946
Telos 1649
Harris Allied 1615
Broadcasters General Store 2146
QRK 1699
BME - Broadcast Management Engineering Magazine 2581
Radio Business Report 1579
UMC Beaucart 1582
Armstrong Transmitter Corporation 6708
Cablewave Systems 1519
Aristocart 1851
Elgin Electronics 1605
Goldline 1486
NAD Electronics 2096
Will-Burt Company 1049
Valcom 1722
SStran 1004

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