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

249 pages link to HomePage:
|<<   << - 1 / 5 - Next >>   >>|
|<<   << - 1 / 5 - Next >>   >>|
Page Name. HitsClick to reverse sort order
Help/TextFormattingRules 15089
TextFormattingRules 6327
Armstrong Transmitter Corporation 5774
Autogram 4359
GeneralRadio 3867
LPB 3705
QEI 3466
Auditronics 2900
Crown 2814
Belar Electronics Laboratory 2797
Burk Technology 2720
ESE 2707
RCA 2631
Broadcast Electronics 2630
Orban 2630
Tapecaster 2536
DeltaElectronics 2535
Collins Radio 2451
GatesRadioCompany 2351
Broadcast Audio 2342
Ampex 2318
Nortronics 2279
Hallicrafters 2278
MEI 2252
CSI 2186
Altec 2137
Arrakis Systems, Inc 2131
Accurate Sound Corporation 2064
Cetec Broadcast Group 2051
Microwave Radio Corporation 2041
Dana Electronics 2020
C & D Batteries 2020
Modulation Sciences 2013
HallikainenAndFriends 1973
WesternElectric 1965
Symmetrix 1956
Neotek 1948
Advanced Research & Technology 1932
Metrotech 1900
Energy-Onix 1898
Kyocera 1863
Amalgamated Wireless (Australiasia) Ltd. 1816
American Data 1803
Hughey & Phillips 1752
Larcan 1708
Inovonics 1683
ComStream 1677
BME - Broadcast Management Engineering Magazine 1675
American Electronic Laboratories 1664
Minicom Division of 3M 1656
National Association of Broadcasters 1643
Measurements 1614
Kenwood 1606
Kinght-kit 1590
Weston 1585
Radix 1577
Rust Industrial Company, Inc. 1575
Raytheon 1554
Dumont 1544
Bell Telephone Laboratories 1541
Schafer Automation 1528
MCI 1520
ATI 1512
Thompson-CSF 1509
Aston 1487
Lambda Electronics Corp. 1485
Teletronix Engineering Company 1482
Bird Electronic Corporation 1451
Bext 1444
McIntosh 1443
Norcom 1438
Gorman-Redlich 1423
Pacific Recorders and Engineers 1387
Automated Broadcast Controls 1382
SMC 1374
Extel 1349
Computer Concepts 1347
Dorrough Electronics 1342
Aphex Systems Limited 1338
Harris Corporation - Broadcast Division 1332
Electronic Signal Products 1331
Ohmite Manufacturing Company 1328
AmperexElectronicCorporation 1327
Langevin 1319
IRC 1314
Frese and Kaping 1313
Denon 1298
Amperite 1292
Texar 1288
Anton Electronic Laboratories 1279
IGM 1278
Dataworld 1277
PhpWikiAdministration 1274
Data Systems Design 1274
Soltec 1271
Taber Manufacturing and Engineering Company 1269
Technics 1263
Otari 1259
Yokogawa Electric Works 1250
Sescom 1248
Gregg Laboratories 1220
Simpson Electric Company 1210
Harman Kardon 1195
Standart Tape Laboratory 1195
Jensen Transformers 1195
Leeds & Northrup Company 1195
Farallon 1194
Lorain Products Corporation 1189
Comtech Antenna Corporation 1187
Jennings 1183
Electrovoice 1182
Audio Arts 1176
Philips 1168
Russco 1168
NemsClarke 1165
J. G. S. Engineering Inc. 1162
Continental Satellite Systems 1153
US Audio 1152
Bauer Electronics Corporation 1151
Tentel 1151
Studer International AG 1148
Victoreen Instrument Company 1137
Link, Fred M 1132
Wegener Communications 1131
Lang Electronics 1122
Help/RedirectToPlugin 1112
Gentner 1110
NAD Electronics 1109
Multi-technical Services 1108
GatesAir 1104
Midwest Communications 1103
EimacDivisionOfVarian 1098
Motorola 1097
ITA 1097
Marantz 1097
Boonton Radio Corporation 1097
Scully 1093
NBC 1091
Bosch 1089
Garner Industries 1088
Marconi Wireless Telegraph Company 1082
Video Systems of America 1081
Help/EditMetaDataPlugin 1080
Machlett Laboratories 1079
Conex Electro Systems 1075
Dayton Industrial 1074
Peak Audio 1070
Nova Systems, Inc. 1065
MilitaryRadio 1063
Panasonic 1055
Scala 1052
Tepco 1051
Kenneth A. Bacon Associates 1050
Westinghouse 1047
Telefile Computer Products, Inc. 1040
HoweTech 1032
Triplett 1030
EfJohnson 1026
Coastcom 1021
National 1012
Broadcasters General Store 1009
Broadcast Tools 1002
Radio Engineering Laboratories 997
Byer Industries 996
Presto 984
Historic Papers 983
Cutting Edge Technologies 978
Engineering Services 974
United Transformer Corporation 967
Sparta Electronics 965
Broadcast Television Systems 957
Trimax 951
Pultec 947
Studer 947
Clear-Com 947
Audi-Cord Corporation 946
Standard Electronics 945
Magnecord 943
Consolidated Electronic Industries 942
Sine Systems 936
Mullard 932
ITC 931
Microcon 925
Straight Wire Audio 914
Multronics 913
Standard Telephones & Cables. Australia 908
Moulic Specialties Co. 891
Hollyanne 889
Federated Purchaser 874
Telfax 868
Contel ASC 863
Heathkit 862
QRK 862
Electronics Research, Inc. 851
Aristocart 848
TFT, Inc. 844
Johnson Electronics 839
Telos 823
Station Histories 821
MoseleyAssociatesInc 804
Tektronix 767
Elgin Electronics 760
Harris Allied 752
Thordarson 748
Realistic 747
Fidelipac 742
3M 733
IncludePagePlugin 728
Radio Business Report 721
Sony 709
Cablewave Systems 709
UMC Beaucart 688
Revox 657
Teac 657
Hewlett Packard 655
Goldline 651
GatesRadioCatalog99 598
AmministrazioneDiPhpWiki 541
Radio Engineering 536
CCA 512
UREI 511
NewMarkupTestPage 499
Help/OldTextFormattingRules 498
OldTextFormattingRules 488
Help/NewMarkupTestPage 486
Help/NewMarkupTestPage 486
Help/NewMarkupTestPage 486
Potomac Instruments 480
Andrew Corporation 480
Help/OldMarkupTestPage 476
Help/OldMarkupTestPage 476
Help/OldMarkupTestPage 476
McMartin 474
RedirectToPlugin 470
template 461
OldMarkupTestPage 456
Ratheon 433
Dolby Laboratories 423
Circuit Research Laboratories 395
Wheatstone Corporation 359
Electronics Digest 344
Marti Electronics, Inc. 338
Continental Electronics 264
CBS Labs 259
Will-Burt Company 229
GeneralElectric 169
dbx 144
Jampro Antenna 106
Valcom 60

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