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 30485
GeneralRadio 28820
Broadcast Electronics 19194
RCA 18946
HallikainenAndFriends 18834
Collins Radio 16991
GatesRadioCompany 16696
Ampex 15797
TextFormattingRules 13058
Bird Electronic Corporation 12186
Autogram 9412
Harris Corporation - Broadcast Division 9102
Dorrough Electronics 7756
MilitaryRadio 7599
Panasonic 7529
QEI 6988
Armstrong Transmitter Corporation 6710
Gentner 6609
Sparta Electronics 6542
Dayton Industrial 6523
LPB 6419
Historic Papers 6262
TFT, Inc. 6178
DeltaElectronics 6020
Crown 5624
Station Histories 5589
ITC 5519
Auditronics 5353
Burk Technology 5342
MoseleyAssociatesInc 5338
3M 5320
ESE 5160
Orban 4939
Belar Electronics Laboratory 4836
Tapecaster 4805
Continental Electronics 4727
Sony 4639
Broadcast Audio 4591
Hewlett Packard 4410
Revox 4368
MEI 4347
Nortronics 4167
Hallicrafters 4158
WesternElectric 4099
Tektronix 4092
Teac 3957
Fidelipac 3951
CSI 3879
Modulation Sciences 3861
Arrakis Systems, Inc 3749
Symmetrix 3712
Cetec Broadcast Group 3702
C & D Batteries 3682
Microwave Radio Corporation 3679
Neotek 3673
Potomac Instruments 3561
Energy-Onix 3495
Kyocera 3494
Metrotech 3482
Altec 3481
Dana Electronics 3390
CBS Labs 3348
Hughey & Phillips 3278
Accurate Sound Corporation 3272
Inovonics 3266
CCA 3096
ComStream 3072
GeneralElectric 3062
Larcan 3051
McMartin 3039
dbx 3021
Advanced Research & Technology 2976
American Data 2945
Kenwood 2929
Radix 2906
Measurements 2899
Weston 2877
National Association of Broadcasters 2870
Kinght-kit 2869
American Electronic Laboratories 2857
Rust Industrial Company, Inc. 2848
Minicom Division of 3M 2834
Amalgamated Wireless (Australiasia) Ltd. 2827
Andrew Corporation 2802
Marti Electronics, Inc. 2789
UREI 2776
Bell Telephone Laboratories 2680
Thompson-CSF 2675
Schafer Automation 2653
Lambda Electronics Corp. 2631
Pacific Recorders and Engineers 2626
Norcom 2614
MCI 2604
Raytheon 2600
BME - Broadcast Management Engineering Magazine 2583
Dumont 2577
ATI 2545
McIntosh 2528
SMC 2476
Teletronix Engineering Company 2440
Dolby Laboratories 2437
Langevin 2436
PhpWikiAdministration 2380
Frese and Kaping 2340
Aston 2337
Bext 2324
Gorman-Redlich 2318
Extel 2317
Texar 2305
Automated Broadcast Controls 2299
Bauer Electronics Corporation 2286
Otari 2261
Wheatstone Corporation 2251
Computer Concepts 2249
Electronic Signal Products 2223
Technics 2203
Soltec 2182
Russco 2170
Data Systems Design 2169
Broadcasters General Store 2148
Gregg Laboratories 2146
Harman Kardon 2133
IGM 2128
Denon 2122
Sescom 2109
IRC 2107
J. G. S. Engineering Inc. 2102
Ohmite Manufacturing Company 2102
NAD Electronics 2096
Scully 2086
Dataworld 2083
Aphex Systems Limited 2074
Multi-technical Services 2069
NemsClarke 2064
Lang Electronics 2062
Farallon 2055
Help/RedirectToPlugin 2050
AmperexElectronicCorporation 2049
Motorola 2047
Taber Manufacturing and Engineering Company 2038
Jensen Transformers 2037
Simpson Electric Company 2032
Leeds & Northrup Company 2027
Circuit Research Laboratories 2022
Comtech Antenna Corporation 2015
Philips 2014
Tentel 2003
Yokogawa Electric Works 1996
Standart Tape Laboratory 1995
Continental Satellite Systems 1985
Jennings 1978
Marantz 1967
Midwest Communications 1960
Triplett 1960
Boonton Radio Corporation 1960
Electrovoice 1957
Amperite 1955
Magnecord 1951
Lorain Products Corporation 1950
Sine Systems 1950
Link, Fred M 1941
Wegener Communications 1931
Studer International AG 1927
Garner Industries 1920
EimacDivisionOfVarian 1917
Video Systems of America 1913
Broadcast Television Systems 1903
Help/EditMetaDataPlugin 1893
Anton Electronic Laboratories 1889
US Audio 1878
Kenneth A. Bacon Associates 1861
Victoreen Instrument Company 1860
Aristocart 1853
Conex Electro Systems 1832
Audio Arts 1828
National 1822
Peak Audio 1822
GatesAir 1801
Nova Systems, Inc. 1782
Audi-Cord Corporation 1777
Machlett Laboratories 1768
Telefile Computer Products, Inc. 1767
Bosch 1748
Mullard 1732
NBC 1731
Valcom 1728
Westinghouse 1722
ITA 1717
Byer Industries 1707
Scala 1705
Radio Engineering Laboratories 1704
Jampro Antenna 1700
QRK 1700
Coastcom 1699
Tepco 1688
HoweTech 1676
Clear-Com 1671
Electronics Digest 1670
Standard Telephones & Cables. Australia 1669
Marconi Wireless Telegraph Company 1666
Presto 1658
United Transformer Corporation 1657
Telos 1653
Contel ASC 1651
EfJohnson 1637
Consolidated Electronic Industries 1629
Johnson Electronics 1629
Harris Allied 1618
Thordarson 1617
Realistic 1607
Elgin Electronics 1606
UMC Beaucart 1584
Radio Business Report 1581
Pultec 1580
Engineering Services 1570
Studer 1560
Straight Wire Audio 1559
Trimax 1541
Multronics 1537
Cutting Edge Technologies 1526
Cablewave Systems 1522
Hollyanne 1505
Microcon 1505
Standard Electronics 1503
Goldline 1488
Federated Purchaser 1465
Telfax 1464
Moulic Specialties Co. 1425
Electronics Research, Inc. 1355
IncludePagePlugin 1317
GatesRadioCatalog99 1235
Broadcast Tools 1178
Will-Burt Company 1051
SStran 1006
Radio Engineering 983
NewMarkupTestPage 964
AmministrazioneDiPhpWiki 961
OldTextFormattingRules 946
template 919
OldMarkupTestPage 898
Help/OldTextFormattingRules 887
Help/NewMarkupTestPage 886
Help/NewMarkupTestPage 886
Help/NewMarkupTestPage 886
Help/OldMarkupTestPage 856
Help/OldMarkupTestPage 856
Help/OldMarkupTestPage 856
RedirectToPlugin 840
Ratheon 832
Heathkit 80

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