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 64
Ratheon 830
RedirectToPlugin 836
Help/OldMarkupTestPage 855
Help/OldMarkupTestPage 855
Help/OldMarkupTestPage 855
Help/OldTextFormattingRules 884
Help/NewMarkupTestPage 885
Help/NewMarkupTestPage 885
Help/NewMarkupTestPage 885
OldMarkupTestPage 894
template 916
OldTextFormattingRules 940
AmministrazioneDiPhpWiki 956
NewMarkupTestPage 959
Radio Engineering 979
SStran 1000
Will-Burt Company 1045
Broadcast Tools 1131
GatesRadioCatalog99 1229
IncludePagePlugin 1310
Electronics Research, Inc. 1353
Moulic Specialties Co. 1421
Telfax 1460
Federated Purchaser 1463
Goldline 1480
Hollyanne 1499
Microcon 1499
Standard Electronics 1502
Cablewave Systems 1513
Cutting Edge Technologies 1522
Multronics 1533
Trimax 1535
Studer 1556
Straight Wire Audio 1557
Engineering Services 1566
Radio Business Report 1571
UMC Beaucart 1575
Pultec 1576
Realistic 1598
Elgin Electronics 1599
Thordarson 1607
Harris Allied 1612
Johnson Electronics 1619
Consolidated Electronic Industries 1624
EfJohnson 1633
Contel ASC 1645
Telos 1645
Presto 1653
United Transformer Corporation 1654
Electronics Digest 1654
Marconi Wireless Telegraph Company 1660
Standard Telephones & Cables. Australia 1662
Clear-Com 1662
HoweTech 1670
Tepco 1683
Coastcom 1693
QRK 1694
Jampro Antenna 1697
Radio Engineering Laboratories 1698
Scala 1701
Byer Industries 1703
Valcom 1710
ITA 1711
Westinghouse 1713
Mullard 1727
NBC 1727
Bosch 1745
Telefile Computer Products, Inc. 1761
Machlett Laboratories 1764
Audi-Cord Corporation 1767
Nova Systems, Inc. 1778
GatesAir 1797
Peak Audio 1816
National 1819
Audio Arts 1825
Conex Electro Systems 1828
Aristocart 1843
Victoreen Instrument Company 1854
Kenneth A. Bacon Associates 1855
US Audio 1873
Help/EditMetaDataPlugin 1888
Anton Electronic Laboratories 1888
Broadcast Television Systems 1899
Video Systems of America 1907
EimacDivisionOfVarian 1912
Garner Industries 1914
Studer International AG 1922
Wegener Communications 1927
Link, Fred M 1935
Sine Systems 1938
Lorain Products Corporation 1946
Magnecord 1948
Amperite 1949
Electrovoice 1952
Triplett 1953
Midwest Communications 1956
Boonton Radio Corporation 1956
Marantz 1957
Jennings 1970
Continental Satellite Systems 1980
Standart Tape Laboratory 1986
Yokogawa Electric Works 1989
Tentel 1996
Circuit Research Laboratories 1999
Philips 2008
Comtech Antenna Corporation 2011
Leeds & Northrup Company 2019
Simpson Electric Company 2025
Jensen Transformers 2032
Taber Manufacturing and Engineering Company 2033
Motorola 2040
Help/RedirectToPlugin 2043
AmperexElectronicCorporation 2045
Farallon 2048
Lang Electronics 2052
NemsClarke 2058
Multi-technical Services 2065
Aphex Systems Limited 2066
Dataworld 2074
Scully 2081
NAD Electronics 2088
Ohmite Manufacturing Company 2094
J. G. S. Engineering Inc. 2100
IRC 2102
Sescom 2102
Denon 2117
IGM 2121
Harman Kardon 2126
Gregg Laboratories 2139
Broadcasters General Store 2139
Data Systems Design 2152
Russco 2164
Soltec 2173
Technics 2195
Electronic Signal Products 2220
Wheatstone Corporation 2233
Computer Concepts 2238
Otari 2251
Bauer Electronics Corporation 2281
Texar 2292
Automated Broadcast Controls 2294
Extel 2311
Gorman-Redlich 2313
Bext 2320
Aston 2332
Frese and Kaping 2335
PhpWikiAdministration 2375
Langevin 2422
Dolby Laboratories 2433
Teletronix Engineering Company 2434
SMC 2463
McIntosh 2516
ATI 2535
Dumont 2569
BME - Broadcast Management Engineering Magazine 2576
Raytheon 2586
MCI 2592
Norcom 2603
Pacific Recorders and Engineers 2622
Lambda Electronics Corp. 2622
Schafer Automation 2645
Thompson-CSF 2669
Bell Telephone Laboratories 2677
UREI 2749
Marti Electronics, Inc. 2769
Andrew Corporation 2785
Amalgamated Wireless (Australiasia) Ltd. 2823
Minicom Division of 3M 2825
Rust Industrial Company, Inc. 2845
National Association of Broadcasters 2851
American Electronic Laboratories 2854
Kinght-kit 2862
Weston 2864
Measurements 2883
Radix 2898
Kenwood 2916
American Data 2937
Advanced Research & Technology 2973
dbx 3004
McMartin 3012
Larcan 3032
GeneralElectric 3041
ComStream 3065
CCA 3084
Inovonics 3253
Accurate Sound Corporation 3261
Hughey & Phillips 3273
CBS Labs 3330
Dana Electronics 3377
Metrotech 3467
Kyocera 3469
Altec 3475
Energy-Onix 3491
Potomac Instruments 3540
Neotek 3657
C & D Batteries 3667
Microwave Radio Corporation 3670
Cetec Broadcast Group 3687
Symmetrix 3693
Arrakis Systems, Inc 3745
Modulation Sciences 3851
CSI 3872
Teac 3913
Fidelipac 3924
Tektronix 4061
WesternElectric 4091
Hallicrafters 4139
Nortronics 4146
MEI 4331
Revox 4342
Hewlett Packard 4367
Broadcast Audio 4586
Sony 4597
Continental Electronics 4662
Tapecaster 4790
Belar Electronics Laboratory 4816
Orban 4906
ESE 5156
3M 5303
MoseleyAssociatesInc 5306
Burk Technology 5327
Auditronics 5347
ITC 5452
Station Histories 5558
Crown 5613
DeltaElectronics 5982
Historic Papers 6128
TFT, Inc. 6166
LPB 6391
Dayton Industrial 6481
Sparta Electronics 6506
Gentner 6579
Armstrong Transmitter Corporation 6699
QEI 6956
Panasonic 7477
MilitaryRadio 7539
Dorrough Electronics 7645
Harris Corporation - Broadcast Division 9073
Autogram 9397
Bird Electronic Corporation 11766
TextFormattingRules 12986
Ampex 15684
GatesRadioCompany 16567
Collins Radio 16799
HallikainenAndFriends 18730
RCA 18774
Broadcast Electronics 19015
GeneralRadio 28774
Help/TextFormattingRules 30275

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