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

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