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

250 pages link to HomePage:
|<<   << - 1 / 5 - Next >>   >>|
|<<   << - 1 / 5 - Next >>   >>|
Page Name. HitsClick to reverse sort order
Help/TextFormattingRules 30552
GeneralRadio 28872
Broadcast Electronics 19581
RCA 19114
HallikainenAndFriends 18993
Collins Radio 17040
GatesRadioCompany 16708
Ampex 15924
Bird Electronic Corporation 13110
TextFormattingRules 13069
Autogram 9454
Harris Corporation - Broadcast Division 9121
Dorrough Electronics 7837
MilitaryRadio 7681
Panasonic 7617
QEI 6997
Armstrong Transmitter Corporation 6721
Gentner 6647
Sparta Electronics 6565
Dayton Industrial 6560
LPB 6441
Historic Papers 6362
TFT, Inc. 6193
DeltaElectronics 6050
Crown 5632
Station Histories 5619
ITC 5576
3M 5394
Burk Technology 5377
Auditronics 5377
MoseleyAssociatesInc 5359
ESE 5168
Orban 4953
Belar Electronics Laboratory 4861
Tapecaster 4819
Continental Electronics 4769
Sony 4667
Broadcast Audio 4612
Hewlett Packard 4448
MEI 4374
Revox 4373
Nortronics 4190
Hallicrafters 4182
Tektronix 4137
WesternElectric 4104
Teac 4008
Fidelipac 3988
CSI 3883
Modulation Sciences 3866
Arrakis Systems, Inc 3762
Symmetrix 3734
Cetec Broadcast Group 3725
C & D Batteries 3708
Microwave Radio Corporation 3689
Neotek 3686
Potomac Instruments 3576
Kyocera 3519
Metrotech 3504
Energy-Onix 3499
Altec 3492
Dana Electronics 3411
CBS Labs 3371
Accurate Sound Corporation 3285
Hughey & Phillips 3282
Inovonics 3272
CCA 3106
GeneralElectric 3079
ComStream 3076
Larcan 3063
McMartin 3048
dbx 3031
Advanced Research & Technology 2983
American Data 2959
Kenwood 2942
Measurements 2914
Radix 2913
National Association of Broadcasters 2884
Weston 2881
Kinght-kit 2874
American Electronic Laboratories 2863
Rust Industrial Company, Inc. 2852
Minicom Division of 3M 2846
Amalgamated Wireless (Australiasia) Ltd. 2834
Andrew Corporation 2830
Marti Electronics, Inc. 2806
UREI 2790
Bell Telephone Laboratories 2689
Thompson-CSF 2680
Schafer Automation 2655
Lambda Electronics Corp. 2645
Pacific Recorders and Engineers 2629
Norcom 2625
Raytheon 2617
MCI 2617
BME - Broadcast Management Engineering Magazine 2592
Dumont 2590
ATI 2554
McIntosh 2537
SMC 2486
Teletronix Engineering Company 2448
Dolby Laboratories 2443
Langevin 2442
PhpWikiAdministration 2384
Aston 2349
Frese and Kaping 2344
Bext 2338
Gorman-Redlich 2322
Extel 2321
Texar 2314
Automated Broadcast Controls 2314
Bauer Electronics Corporation 2292
Wheatstone Corporation 2273
Otari 2269
Computer Concepts 2255
Electronic Signal Products 2229
Technics 2208
Soltec 2192
Data Systems Design 2182
Russco 2177
Broadcasters General Store 2161
Gregg Laboratories 2157
Harman Kardon 2141
IGM 2133
Denon 2129
Sescom 2117
IRC 2111
Ohmite Manufacturing Company 2107
J. G. S. Engineering Inc. 2105
NAD Electronics 2102
Scully 2089
Dataworld 2088
Aphex Systems Limited 2080
Multi-technical Services 2075
NemsClarke 2070
Lang Electronics 2069
Farallon 2063
AmperexElectronicCorporation 2055
Help/RedirectToPlugin 2052
Motorola 2050
Taber Manufacturing and Engineering Company 2044
Jensen Transformers 2044
Circuit Research Laboratories 2042
Simpson Electric Company 2038
Leeds & Northrup Company 2034
Comtech Antenna Corporation 2021
Philips 2018
Tentel 2009
Standart Tape Laboratory 2004
Yokogawa Electric Works 2003
Continental Satellite Systems 1992
Jennings 1987
Marantz 1973
Midwest Communications 1967
Boonton Radio Corporation 1965
Electrovoice 1964
Triplett 1962
Sine Systems 1962
Amperite 1960
Magnecord 1955
Lorain Products Corporation 1955
Link, Fred M 1943
Wegener Communications 1940
Studer International AG 1935
Garner Industries 1927
EimacDivisionOfVarian 1922
Video Systems of America 1921
Broadcast Television Systems 1908
Help/EditMetaDataPlugin 1896
Anton Electronic Laboratories 1895
US Audio 1885
Kenneth A. Bacon Associates 1867
Aristocart 1866
Victoreen Instrument Company 1862
Conex Electro Systems 1839
Audio Arts 1832
Peak Audio 1828
National 1823
GatesAir 1805
Audi-Cord Corporation 1787
Nova Systems, Inc. 1785
Telefile Computer Products, Inc. 1773
Machlett Laboratories 1771
Bosch 1754
Valcom 1747
Mullard 1736
NBC 1735
Westinghouse 1729
ITA 1722
Byer Industries 1712
Scala 1712
Radio Engineering Laboratories 1708
QRK 1707
Coastcom 1704
Jampro Antenna 1703
Tepco 1692
Electronics Digest 1683
HoweTech 1681
Clear-Com 1676
Standard Telephones & Cables. Australia 1672
Marconi Wireless Telegraph Company 1668
United Transformer Corporation 1661
Presto 1660
Telos 1660
Contel ASC 1658
EfJohnson 1640
Johnson Electronics 1636
Consolidated Electronic Industries 1633
Thordarson 1626
Harris Allied 1624
Realistic 1615
Elgin Electronics 1613
UMC Beaucart 1591
Radio Business Report 1586
Pultec 1583
Engineering Services 1573
Studer 1562
Straight Wire Audio 1561
Trimax 1544
Multronics 1539
Cutting Edge Technologies 1530
Cablewave Systems 1529
Hollyanne 1508
Microcon 1508
Standard Electronics 1507
Goldline 1491
Federated Purchaser 1470
Telfax 1466
Moulic Specialties Co. 1427
Electronics Research, Inc. 1357
IncludePagePlugin 1319
Broadcast Tools 1289
GatesRadioCatalog99 1240
Will-Burt Company 1055
SStran 1010
Radio Engineering 995
NewMarkupTestPage 967
AmministrazioneDiPhpWiki 965
OldTextFormattingRules 949
template 922
OldMarkupTestPage 904
Help/NewMarkupTestPage 888
Help/NewMarkupTestPage 888
Help/NewMarkupTestPage 888
Help/OldTextFormattingRules 887
Help/OldMarkupTestPage 858
Help/OldMarkupTestPage 858
Help/OldMarkupTestPage 858
RedirectToPlugin 841
Ratheon 837
Heathkit 89

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