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

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