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 75
Ratheon 831
RedirectToPlugin 838
Help/OldMarkupTestPage 856
Help/OldMarkupTestPage 856
Help/OldMarkupTestPage 856
Help/NewMarkupTestPage 886
Help/NewMarkupTestPage 886
Help/NewMarkupTestPage 886
Help/OldTextFormattingRules 887
OldMarkupTestPage 896
template 918
OldTextFormattingRules 945
AmministrazioneDiPhpWiki 959
NewMarkupTestPage 963
Radio Engineering 980
SStran 1003
Will-Burt Company 1048
Broadcast Tools 1139
GatesRadioCatalog99 1231
IncludePagePlugin 1316
Electronics Research, Inc. 1354
Moulic Specialties Co. 1423
Telfax 1463
Federated Purchaser 1464
Goldline 1485
Hollyanne 1502
Microcon 1502
Standard Electronics 1503
Cablewave Systems 1517
Cutting Edge Technologies 1525
Multronics 1535
Trimax 1539
Straight Wire Audio 1558
Studer 1558
Engineering Services 1568
Radio Business Report 1577
Pultec 1579
UMC Beaucart 1580
Elgin Electronics 1603
Realistic 1604
Thordarson 1613
Harris Allied 1615
Johnson Electronics 1626
Consolidated Electronic Industries 1627
EfJohnson 1635
Contel ASC 1648
Telos 1649
Presto 1655
United Transformer Corporation 1657
Electronics Digest 1662
Marconi Wireless Telegraph Company 1664
Standard Telephones & Cables. Australia 1667
Clear-Com 1667
HoweTech 1674
Tepco 1686
Coastcom 1697
Jampro Antenna 1698
QRK 1699
Radio Engineering Laboratories 1702
Scala 1704
Byer Industries 1706
ITA 1715
Westinghouse 1718
Valcom 1720
NBC 1728
Mullard 1729
Bosch 1746
Telefile Computer Products, Inc. 1764
Machlett Laboratories 1767
Audi-Cord Corporation 1771
Nova Systems, Inc. 1781
GatesAir 1799
Peak Audio 1818
National 1820
Audio Arts 1826
Conex Electro Systems 1829
Aristocart 1849
Victoreen Instrument Company 1856
Kenneth A. Bacon Associates 1858
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 1954
Electrovoice 1955
Midwest Communications 1958
Triplett 1959
Boonton Radio Corporation 1960
Marantz 1964
Jennings 1975
Continental Satellite Systems 1982
Standart Tape Laboratory 1989
Yokogawa Electric Works 1992
Tentel 1997
Philips 2012
Comtech Antenna Corporation 2012
Circuit Research Laboratories 2014
Leeds & Northrup Company 2024
Simpson Electric Company 2029
Taber Manufacturing and Engineering Company 2034
Jensen Transformers 2034
Motorola 2043
Help/RedirectToPlugin 2048
AmperexElectronicCorporation 2048
Farallon 2052
Lang Electronics 2057
NemsClarke 2061
Multi-technical Services 2066
Aphex Systems Limited 2070
Dataworld 2080
Scully 2085
NAD Electronics 2092
Ohmite Manufacturing Company 2098
J. G. S. Engineering Inc. 2101
IRC 2105
Sescom 2106
Denon 2118
IGM 2126
Harman Kardon 2130
Gregg Laboratories 2143
Broadcasters General Store 2145
Data Systems Design 2163
Russco 2168
Soltec 2178
Technics 2199
Electronic Signal Products 2222
Wheatstone Corporation 2240
Computer Concepts 2245
Otari 2259
Bauer Electronics Corporation 2284
Automated Broadcast Controls 2296
Texar 2302
Extel 2315
Gorman-Redlich 2316
Bext 2323
Aston 2334
Frese and Kaping 2338
PhpWikiAdministration 2378
Langevin 2431
Dolby Laboratories 2436
Teletronix Engineering Company 2437
SMC 2471
McIntosh 2521
ATI 2541
Dumont 2574
BME - Broadcast Management Engineering Magazine 2580
Raytheon 2595
MCI 2597
Norcom 2609
Lambda Electronics Corp. 2623
Pacific Recorders and Engineers 2624
Schafer Automation 2651
Thompson-CSF 2674
Bell Telephone Laboratories 2679
UREI 2767
Marti Electronics, Inc. 2776
Andrew Corporation 2794
Amalgamated Wireless (Australiasia) Ltd. 2825
Minicom Division of 3M 2827
Rust Industrial Company, Inc. 2846
American Electronic Laboratories 2855
National Association of Broadcasters 2863
Kinght-kit 2867
Weston 2874
Measurements 2891
Radix 2904
Kenwood 2923
American Data 2941
Advanced Research & Technology 2974
dbx 3017
McMartin 3032
Larcan 3044
GeneralElectric 3052
ComStream 3071
CCA 3091
Inovonics 3262
Accurate Sound Corporation 3263
Hughey & Phillips 3275
CBS Labs 3339
Dana Electronics 3379
Metrotech 3472
Altec 3478
Kyocera 3483
Energy-Onix 3493
Potomac Instruments 3554
Neotek 3665
C & D Batteries 3671
Microwave Radio Corporation 3676
Cetec Broadcast Group 3690
Symmetrix 3700
Arrakis Systems, Inc 3748
Modulation Sciences 3857
CSI 3877
Fidelipac 3931
Teac 3934
Tektronix 4070
WesternElectric 4095
Hallicrafters 4144
Nortronics 4154
MEI 4333
Revox 4361
Hewlett Packard 4389
Broadcast Audio 4589
Sony 4624
Continental Electronics 4701
Tapecaster 4796
Belar Electronics Laboratory 4827
Orban 4932
ESE 5157
3M 5312
MoseleyAssociatesInc 5330
Burk Technology 5335
Auditronics 5350
ITC 5493
Station Histories 5568
Crown 5618
DeltaElectronics 6007
TFT, Inc. 6171
Historic Papers 6212
LPB 6411
Dayton Industrial 6513
Sparta Electronics 6531
Gentner 6590
Armstrong Transmitter Corporation 6705
QEI 6984
Panasonic 7485
MilitaryRadio 7551
Dorrough Electronics 7707
Harris Corporation - Broadcast Division 9095
Autogram 9408
Bird Electronic Corporation 11782
TextFormattingRules 13026
Ampex 15779
GatesRadioCompany 16681
Collins Radio 16963
HallikainenAndFriends 18747
RCA 18868
Broadcast Electronics 19044
GeneralRadio 28801
Help/TextFormattingRules 30427

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