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

Is it 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 a name, a pipe (|) and then the hyperlink or pagename: 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 30561
PhpWikiAdministration 2385
Help/EditMetaDataPlugin 1897
Help/RedirectToPlugin 2052
TextFormattingRules 13072
OldTextFormattingRules 949
RedirectToPlugin 841
NewMarkupTestPage 970
OldMarkupTestPage 905
IncludePagePlugin 1320
AmperexElectronicCorporation 2057
DeltaElectronics 6087
EimacDivisionOfVarian 1925
GatesRadioCompany 16712
GatesRadioCatalog99 1242
GeneralElectric 3087
GeneralRadio 28891
HallikainenAndFriends 19061
MoseleyAssociatesInc 5368
Motorola 2051
National 1824
NemsClarke 2075
RCA 19188
WesternElectric 4105
Technics 2209
Westinghouse 1730
MilitaryRadio 7723
Historic Papers 6399
Station Histories 5631
Ratheon 838
Raytheon 2621
EfJohnson 1642
American Electronic Laboratories 2864
Victoreen Instrument Company 1864
Anton Electronic Laboratories 1896
Collins Radio 17160
HoweTech 1683
Belar Electronics Laboratory 4867
Ampex 15931
Harris Corporation - Broadcast Division 9125
Dorrough Electronics 7913
Radio Engineering Laboratories 1709
Standard Electronics 1508
Amalgamated Wireless (Australiasia) Ltd. 2837
Byer Industries 1714
Circuit Research Laboratories 2063
Bauer Electronics Corporation 2293
Trimax 1545
United Transformer Corporation 1663
template 923
Philips 2020
McMartin 3053
ITA 1723
Continental Electronics 4817
Magnecord 1957
TFT, Inc. 6194
Schafer Automation 2656
Gentner 6665
Texar 2318
Langevin 2444
Altec 3493
CBS Labs 3402
Pultec 1584
Sony 4677
3M 5397
UREI 2796
Frese and Kaping 2345
Revox 4376
Federated Purchaser 1471
CCA 3117
LPB 6447
Hollyanne 1509
Telfax 1468
Help/OldTextFormattingRules 888
AmministrazioneDiPhpWiki 967
Help/NewMarkupTestPage 888
Help/NewMarkupTestPage 888
Help/NewMarkupTestPage 888
Help/OldMarkupTestPage 859
Help/OldMarkupTestPage 859
Help/OldMarkupTestPage 859
Larcan 3068
Tepco 1693
Standard Telephones & Cables. Australia 1673
Presto 1660
Straight Wire Audio 1562
Arrakis Systems, Inc 3764
Consolidated Electronic Industries 1635
Aphex Systems Limited 2082
QEI 6999
Multronics 1540
ITC 5600
Machlett Laboratories 1772
Cutting Edge Technologies 1532
Bext 2341
Tektronix 4155
Electronics Research, Inc. 1359
Advanced Research & Technology 2983
Marantz 1976
Microcon 1509
Broadcast Television Systems 1910
Bosch 1755
dbx 3033
Otari 2271
Crown 5656
Broadcast Electronics 19701
ATI 2556
Scully 2090
Marti Electronics, Inc. 2812
Harman Kardon 2145
Potomac Instruments 3582
Broadcast Audio 4613
Andrew Corporation 2833
Audio Arts 1833
Bird Electronic Corporation 13473
Dumont 2598
Autogram 9457
Radio Engineering 997
Heathkit 93
Mullard 1737
NBC 1737
Amperite 1961
McIntosh 2541
Inovonics 3274
Neotek 3692
Moulic Specialties Co. 1428
Engineering Services 1574
IRC 2112
ESE 5186
Comtech Antenna Corporation 2026
Panasonic 7657
Orban 4959
Studer 1563
Coastcom 1706
Clear-Com 1678
Dolby Laboratories 2456
CSI 3895
Bell Telephone Laboratories 2690
Pacific Recorders and Engineers 2630
Hewlett Packard 4469
Sparta Electronics 6577
Tapecaster 4826
Scala 1714
Marconi Wireless Telegraph Company 1669
Energy-Onix 3500
Modulation Sciences 3869
Burk Technology 5390
Auditronics 5378
Jampro Antenna 1705
Dayton Industrial 6607
Thompson-CSF 2683
Rust Industrial Company, Inc. 2854
Accurate Sound Corporation 3286
IGM 2134
SMC 2491
Radix 2915
Fidelipac 4004
Hughey & Phillips 3284
Microwave Radio Corporation 3692
Broadcast Tools 1329
Symmetrix 3746
GatesAir 1806
Hallicrafters 4193
Kenwood 2949
Kyocera 3531
Teac 4031
Wheatstone Corporation 2284
Gorman-Redlich 2324
Studer International AG 1939
Data Systems Design 2189
Dana Electronics 3428
American Data 2962
Teletronix Engineering Company 2452
Tentel 2013
Taber Manufacturing and Engineering Company 2047
Standart Tape Laboratory 2007
Extel 2323
Russco 2180
Automated Broadcast Controls 2318
Electrovoice 1969
Jennings 1990
Wegener Communications 1943
Midwest Communications 1971
Aston 2353
Farallon 2066
Kenneth A. Bacon Associates 1871
J. G. S. Engineering Inc. 2107
Continental Satellite Systems 1997
ComStream 3085
Conex Electro Systems 1844
Denon 2135
Multi-technical Services 2077
Electronic Signal Products 2233
Lorain Products Corporation 1958
C & D Batteries 3731
Nova Systems, Inc. 1786
Nortronics 4201
Norcom 2630
Lambda Electronics Corp. 2652
US Audio 1889
Jensen Transformers 2047
Garner Industries 1930
Sescom 2119
Soltec 2198
Peak Audio 1831
MCI 2622
MEI 4390
Minicom Division of 3M 2852
Metrotech 3513
Lang Electronics 2072
Kinght-kit 2875
Cetec Broadcast Group 3747
Computer Concepts 2261
Dataworld 2092
National Association of Broadcasters 2890
Link, Fred M 1944
Weston 2882
Yokogawa Electric Works 2006
Measurements 2920
Electronics Digest 1699
Gregg Laboratories 2160
Leeds & Northrup Company 2037
Video Systems of America 1924
Simpson Electric Company 2041
Triplett 1963
Boonton Radio Corporation 1966
Ohmite Manufacturing Company 2109
Contel ASC 1663
Audi-Cord Corporation 1791
Johnson Electronics 1639
Telefile Computer Products, Inc. 1777
Realistic 1620
Thordarson 1628
Sine Systems 1967
Telos 1663
Harris Allied 1627
Broadcasters General Store 2165
QRK 1710
BME - Broadcast Management Engineering Magazine 2596
Radio Business Report 1591
UMC Beaucart 1594
Armstrong Transmitter Corporation 6724
Cablewave Systems 1534
Aristocart 1869
Elgin Electronics 1617
Goldline 1492
NAD Electronics 2106
Will-Burt Company 1056
Valcom 1757
SStran 1013

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