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 74
Ratheon 830
RedirectToPlugin 838
Help/OldMarkupTestPage 856
Help/OldMarkupTestPage 856
Help/OldMarkupTestPage 856
Help/OldTextFormattingRules 885
Help/NewMarkupTestPage 886
Help/NewMarkupTestPage 886
Help/NewMarkupTestPage 886
OldMarkupTestPage 896
template 918
OldTextFormattingRules 944
AmministrazioneDiPhpWiki 959
NewMarkupTestPage 963
Radio Engineering 980
SStran 1003
Will-Burt Company 1048
Broadcast Tools 1137
GatesRadioCatalog99 1230
IncludePagePlugin 1316
Electronics Research, Inc. 1354
Moulic Specialties Co. 1422
Telfax 1460
Federated Purchaser 1464
Goldline 1484
Microcon 1500
Hollyanne 1502
Standard Electronics 1503
Cablewave Systems 1516
Cutting Edge Technologies 1525
Multronics 1534
Trimax 1538
Straight Wire Audio 1558
Studer 1558
Engineering Services 1568
Radio Business Report 1577
Pultec 1578
UMC Beaucart 1579
Realistic 1603
Elgin Electronics 1603
Thordarson 1612
Harris Allied 1615
Johnson Electronics 1624
Consolidated Electronic Industries 1627
EfJohnson 1635
Contel ASC 1648
Telos 1649
Presto 1653
United Transformer Corporation 1657
Electronics Digest 1661
Standard Telephones & Cables. Australia 1664
Marconi Wireless Telegraph Company 1664
Clear-Com 1666
HoweTech 1672
Tepco 1684
Coastcom 1696
Jampro Antenna 1698
QRK 1698
Radio Engineering Laboratories 1702
Scala 1704
Byer Industries 1706
ITA 1713
Westinghouse 1715
Valcom 1717
NBC 1728
Mullard 1729
Bosch 1746
Telefile Computer Products, Inc. 1764
Machlett Laboratories 1767
Audi-Cord Corporation 1770
Nova Systems, Inc. 1779
GatesAir 1799
Peak Audio 1818
National 1819
Audio Arts 1826
Conex Electro Systems 1829
Aristocart 1846
Kenneth A. Bacon Associates 1855
Victoreen Instrument Company 1856
US Audio 1875
Anton Electronic Laboratories 1889
Help/EditMetaDataPlugin 1892
Broadcast Television Systems 1901
Video Systems of America 1910
EimacDivisionOfVarian 1914
Garner Industries 1916
Studer International AG 1925
Wegener Communications 1928
Link, Fred M 1939
Sine Systems 1946
Lorain Products Corporation 1948
Magnecord 1949
Amperite 1952
Electrovoice 1953
Midwest Communications 1957
Triplett 1957
Marantz 1960
Boonton Radio Corporation 1960
Jennings 1972
Continental Satellite Systems 1982
Standart Tape Laboratory 1988
Yokogawa Electric Works 1992
Tentel 1997
Philips 2011
Circuit Research Laboratories 2012
Comtech Antenna Corporation 2012
Leeds & Northrup Company 2023
Simpson Electric Company 2029
Taber Manufacturing and Engineering Company 2034
Jensen Transformers 2034
Motorola 2042
Help/RedirectToPlugin 2047
AmperexElectronicCorporation 2048
Farallon 2050
Lang Electronics 2056
NemsClarke 2061
Multi-technical Services 2066
Aphex Systems Limited 2070
Dataworld 2079
Scully 2081
NAD Electronics 2091
Ohmite Manufacturing Company 2097
J. G. S. Engineering Inc. 2101
IRC 2103
Sescom 2106
Denon 2118
IGM 2122
Harman Kardon 2129
Gregg Laboratories 2143
Broadcasters General Store 2145
Data Systems Design 2158
Russco 2165
Soltec 2177
Technics 2198
Electronic Signal Products 2222
Wheatstone Corporation 2240
Computer Concepts 2244
Otari 2255
Bauer Electronics Corporation 2283
Texar 2296
Automated Broadcast Controls 2296
Extel 2314
Gorman-Redlich 2315
Bext 2323
Aston 2334
Frese and Kaping 2337
PhpWikiAdministration 2377
Langevin 2424
Dolby Laboratories 2436
Teletronix Engineering Company 2437
SMC 2466
McIntosh 2517
ATI 2541
Dumont 2573
BME - Broadcast Management Engineering Magazine 2580
Raytheon 2590
MCI 2595
Norcom 2604
Lambda Electronics Corp. 2623
Pacific Recorders and Engineers 2624
Schafer Automation 2648
Thompson-CSF 2672
Bell Telephone Laboratories 2679
UREI 2759
Marti Electronics, Inc. 2773
Andrew Corporation 2792
Amalgamated Wireless (Australiasia) Ltd. 2824
Minicom Division of 3M 2827
Rust Industrial Company, Inc. 2846
American Electronic Laboratories 2855
National Association of Broadcasters 2861
Kinght-kit 2865
Weston 2873
Measurements 2891
Radix 2899
Kenwood 2918
American Data 2940
Advanced Research & Technology 2974
dbx 3010
McMartin 3017
Larcan 3036
GeneralElectric 3049
ComStream 3069
CCA 3090
Inovonics 3262
Accurate Sound Corporation 3263
Hughey & Phillips 3275
CBS Labs 3337
Dana Electronics 3379
Metrotech 3470
Kyocera 3471
Altec 3477
Energy-Onix 3492
Potomac Instruments 3548
Neotek 3657
C & D Batteries 3669
Microwave Radio Corporation 3672
Cetec Broadcast Group 3690
Symmetrix 3699
Arrakis Systems, Inc 3746
Modulation Sciences 3857
CSI 3875
Teac 3915
Fidelipac 3931
Tektronix 4068
WesternElectric 4095
Hallicrafters 4143
Nortronics 4152
MEI 4333
Revox 4344
Hewlett Packard 4389
Broadcast Audio 4587
Sony 4612
Continental Electronics 4700
Tapecaster 4794
Belar Electronics Laboratory 4825
Orban 4919
ESE 5157
3M 5310
MoseleyAssociatesInc 5326
Burk Technology 5335
Auditronics 5349
ITC 5468
Station Histories 5568
Crown 5615
DeltaElectronics 6004
TFT, Inc. 6168
Historic Papers 6201
LPB 6395
Dayton Industrial 6501
Sparta Electronics 6528
Gentner 6587
Armstrong Transmitter Corporation 6703
QEI 6961
Panasonic 7482
MilitaryRadio 7546
Dorrough Electronics 7704
Harris Corporation - Broadcast Division 9089
Autogram 9405
Bird Electronic Corporation 11778
TextFormattingRules 13014
Ampex 15766
GatesRadioCompany 16672
Collins Radio 16956
HallikainenAndFriends 18746
RCA 18860
Broadcast Electronics 19035
GeneralRadio 28798
Help/TextFormattingRules 30372

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