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

250 pages link to HomePage:
|<<   << - 1 / 5 - Next >>   >>|
|<<   << - 1 / 5 - Next >>   >>|
Page Name. HitsClick to reverse sort order
Help/TextFormattingRules 30510
GeneralRadio 28838
Broadcast Electronics 19333
RCA 19028
HallikainenAndFriends 18912
Collins Radio 17013
GatesRadioCompany 16703
Ampex 15808
TextFormattingRules 13061
Bird Electronic Corporation 12611
Autogram 9416
Harris Corporation - Broadcast Division 9109
Dorrough Electronics 7798
MilitaryRadio 7641
Panasonic 7570
QEI 6993
Armstrong Transmitter Corporation 6715
Gentner 6626
Sparta Electronics 6553
Dayton Industrial 6546
LPB 6429
Historic Papers 6309
TFT, Inc. 6180
DeltaElectronics 6035
Crown 5628
Station Histories 5602
ITC 5545
Auditronics 5356
Burk Technology 5352
MoseleyAssociatesInc 5350
3M 5343
ESE 5163
Orban 4945
Belar Electronics Laboratory 4843
Tapecaster 4811
Continental Electronics 4748
Sony 4652
Broadcast Audio 4595
Hewlett Packard 4430
Revox 4371
MEI 4361
Nortronics 4179
Hallicrafters 4168
Tektronix 4113
WesternElectric 4100
Teac 3978
Fidelipac 3968
CSI 3881
Modulation Sciences 3864
Arrakis Systems, Inc 3751
Symmetrix 3723
Cetec Broadcast Group 3713
C & D Batteries 3696
Microwave Radio Corporation 3685
Neotek 3679
Potomac Instruments 3568
Kyocera 3508
Energy-Onix 3498
Metrotech 3492
Altec 3485
Dana Electronics 3400
CBS Labs 3359
Hughey & Phillips 3280
Accurate Sound Corporation 3277
Inovonics 3269
CCA 3100
ComStream 3075
GeneralElectric 3069
Larcan 3056
McMartin 3044
dbx 3023
Advanced Research & Technology 2977
American Data 2949
Kenwood 2936
Radix 2909
Measurements 2907
Weston 2880
National Association of Broadcasters 2874
Kinght-kit 2870
American Electronic Laboratories 2858
Rust Industrial Company, Inc. 2851
Minicom Division of 3M 2840
Amalgamated Wireless (Australiasia) Ltd. 2832
Andrew Corporation 2812
Marti Electronics, Inc. 2799
UREI 2783
Bell Telephone Laboratories 2683
Thompson-CSF 2677
Schafer Automation 2654
Lambda Electronics Corp. 2637
Pacific Recorders and Engineers 2628
Norcom 2619
MCI 2610
Raytheon 2603
BME - Broadcast Management Engineering Magazine 2587
Dumont 2582
ATI 2550
McIntosh 2532
SMC 2481
Teletronix Engineering Company 2443
Dolby Laboratories 2440
Langevin 2438
PhpWikiAdministration 2383
Frese and Kaping 2343
Aston 2343
Bext 2328
Gorman-Redlich 2320
Extel 2320
Texar 2309
Automated Broadcast Controls 2306
Bauer Electronics Corporation 2289
Otari 2265
Wheatstone Corporation 2262
Computer Concepts 2253
Electronic Signal Products 2227
Technics 2205
Soltec 2188
Data Systems Design 2175
Russco 2174
Broadcasters General Store 2154
Gregg Laboratories 2151
Harman Kardon 2138
IGM 2130
Denon 2127
Sescom 2111
IRC 2109
Ohmite Manufacturing Company 2105
J. G. S. Engineering Inc. 2103
NAD Electronics 2099
Scully 2088
Dataworld 2087
Aphex Systems Limited 2077
Multi-technical Services 2072
NemsClarke 2067
Lang Electronics 2067
Farallon 2059
AmperexElectronicCorporation 2052
Help/RedirectToPlugin 2051
Motorola 2049
Taber Manufacturing and Engineering Company 2041
Jensen Transformers 2041
Simpson Electric Company 2035
Circuit Research Laboratories 2034
Leeds & Northrup Company 2030
Comtech Antenna Corporation 2019
Philips 2016
Tentel 2006
Yokogawa Electric Works 2000
Standart Tape Laboratory 1999
Continental Satellite Systems 1989
Jennings 1982
Marantz 1971
Midwest Communications 1964
Boonton Radio Corporation 1962
Triplett 1961
Electrovoice 1960
Amperite 1957
Sine Systems 1956
Magnecord 1953
Lorain Products Corporation 1952
Link, Fred M 1942
Wegener Communications 1935
Studer International AG 1930
Garner Industries 1924
EimacDivisionOfVarian 1920
Video Systems of America 1917
Broadcast Television Systems 1906
Help/EditMetaDataPlugin 1895
Anton Electronic Laboratories 1892
US Audio 1881
Kenneth A. Bacon Associates 1863
Victoreen Instrument Company 1861
Aristocart 1860
Conex Electro Systems 1836
Audio Arts 1830
Peak Audio 1825
National 1822
GatesAir 1802
Nova Systems, Inc. 1783
Audi-Cord Corporation 1783
Machlett Laboratories 1770
Telefile Computer Products, Inc. 1770
Bosch 1750
Valcom 1737
Mullard 1734
NBC 1733
Westinghouse 1725
ITA 1719
Scala 1710
Byer Industries 1709
Radio Engineering Laboratories 1706
QRK 1704
Coastcom 1702
Jampro Antenna 1701
Tepco 1689
HoweTech 1678
Electronics Digest 1676
Clear-Com 1674
Standard Telephones & Cables. Australia 1671
Marconi Wireless Telegraph Company 1667
United Transformer Corporation 1659
Presto 1658
Telos 1656
Contel ASC 1655
EfJohnson 1639
Johnson Electronics 1632
Consolidated Electronic Industries 1631
Thordarson 1621
Harris Allied 1620
Realistic 1611
Elgin Electronics 1610
UMC Beaucart 1587
Radio Business Report 1585
Pultec 1582
Engineering Services 1572
Studer 1561
Straight Wire Audio 1560
Trimax 1543
Multronics 1538
Cutting Edge Technologies 1528
Cablewave Systems 1526
Hollyanne 1507
Microcon 1506
Standard Electronics 1504
Goldline 1490
Federated Purchaser 1469
Telfax 1465
Moulic Specialties Co. 1426
Electronics Research, Inc. 1356
IncludePagePlugin 1318
GatesRadioCatalog99 1239
Broadcast Tools 1215
Will-Burt Company 1053
SStran 1008
Radio Engineering 990
NewMarkupTestPage 966
AmministrazioneDiPhpWiki 962
OldTextFormattingRules 948
template 921
OldMarkupTestPage 900
Help/OldTextFormattingRules 887
Help/NewMarkupTestPage 887
Help/NewMarkupTestPage 887
Help/NewMarkupTestPage 887
Help/OldMarkupTestPage 857
Help/OldMarkupTestPage 857
Help/OldMarkupTestPage 857
RedirectToPlugin 841
Ratheon 835
Heathkit 82

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