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
Valcom 60
Jampro Antenna 106
dbx 144
GeneralElectric 169
Will-Burt Company 229
CBS Labs 259
Continental Electronics 264
Marti Electronics, Inc. 339
Electronics Digest 344
Wheatstone Corporation 360
Circuit Research Laboratories 395
Dolby Laboratories 423
Ratheon 433
OldMarkupTestPage 456
template 461
RedirectToPlugin 470
Help/OldMarkupTestPage 476
Help/OldMarkupTestPage 476
Help/OldMarkupTestPage 476
Andrew Corporation 480
McMartin 481
Potomac Instruments 481
Help/NewMarkupTestPage 486
Help/NewMarkupTestPage 486
Help/NewMarkupTestPage 486
OldTextFormattingRules 488
Help/OldTextFormattingRules 498
NewMarkupTestPage 499
UREI 512
CCA 512
Radio Engineering 537
AmministrazioneDiPhpWiki 541
GatesRadioCatalog99 598
Goldline 651
Hewlett Packard 656
Revox 657
Teac 658
UMC Beaucart 688
Sony 709
Cablewave Systems 709
Radio Business Report 721
IncludePagePlugin 729
3M 733
Fidelipac 742
Thordarson 748
Realistic 749
Harris Allied 752
Elgin Electronics 761
Tektronix 767
MoseleyAssociatesInc 807
Station Histories 822
Telos 823
Johnson Electronics 839
Aristocart 848
Electronics Research, Inc. 851
QRK 862
Heathkit 863
Contel ASC 864
Telfax 869
Federated Purchaser 875
TFT, Inc. 876
Hollyanne 890
Moulic Specialties Co. 892
Standard Telephones & Cables. Australia 908
Multronics 913
Straight Wire Audio 914
Microcon 925
Mullard 932
ITC 933
Sine Systems 936
Consolidated Electronic Industries 942
Magnecord 943
Standard Electronics 945
Audi-Cord Corporation 946
Pultec 947
Studer 947
Clear-Com 947
Trimax 951
Broadcast Television Systems 957
Sparta Electronics 965
United Transformer Corporation 969
Engineering Services 974
Cutting Edge Technologies 978
Historic Papers 983
Presto 985
Byer Industries 996
Radio Engineering Laboratories 997
Broadcast Tools 1002
Broadcasters General Store 1009
National 1012
Coastcom 1022
EfJohnson 1026
Triplett 1030
HoweTech 1033
Telefile Computer Products, Inc. 1040
Westinghouse 1047
Kenneth A. Bacon Associates 1050
Tepco 1051
Scala 1052
Panasonic 1058
MilitaryRadio 1064
Nova Systems, Inc. 1065
Peak Audio 1070
Dayton Industrial 1076
Conex Electro Systems 1076
Machlett Laboratories 1079
Help/EditMetaDataPlugin 1080
Video Systems of America 1081
Marconi Wireless Telegraph Company 1082
Garner Industries 1088
Bosch 1089
NBC 1091
Scully 1093
Motorola 1097
ITA 1097
Marantz 1097
Boonton Radio Corporation 1097
EimacDivisionOfVarian 1098
GatesAir 1104
Midwest Communications 1104
Multi-technical Services 1108
NAD Electronics 1109
Gentner 1110
Help/RedirectToPlugin 1112
Lang Electronics 1123
Wegener Communications 1131
Link, Fred M 1133
Victoreen Instrument Company 1137
Studer International AG 1148
Tentel 1151
Bauer Electronics Corporation 1152
US Audio 1152
Continental Satellite Systems 1153
J. G. S. Engineering Inc. 1162
NemsClarke 1165
Philips 1168
Russco 1169
Audio Arts 1176
Electrovoice 1182
Jennings 1183
Comtech Antenna Corporation 1187
Lorain Products Corporation 1190
Farallon 1194
Harman Kardon 1195
Jensen Transformers 1195
Leeds & Northrup Company 1195
Standart Tape Laboratory 1196
Simpson Electric Company 1210
Gregg Laboratories 1220
Sescom 1249
Yokogawa Electric Works 1253
Otari 1259
Technics 1263
Taber Manufacturing and Engineering Company 1269
Soltec 1271
Data Systems Design 1274
PhpWikiAdministration 1276
Dataworld 1277
IGM 1278
Anton Electronic Laboratories 1279
Texar 1288
Amperite 1292
Denon 1298
Frese and Kaping 1313
IRC 1316
Langevin 1319
AmperexElectronicCorporation 1327
Ohmite Manufacturing Company 1328
Electronic Signal Products 1331
Harris Corporation - Broadcast Division 1333
Aphex Systems Limited 1338
Dorrough Electronics 1343
Computer Concepts 1347
Extel 1350
SMC 1374
Automated Broadcast Controls 1382
Pacific Recorders and Engineers 1387
Gorman-Redlich 1423
Norcom 1438
McIntosh 1443
Bext 1444
Teletronix Engineering Company 1482
Lambda Electronics Corp. 1485
Aston 1487
Thompson-CSF 1509
ATI 1512
Bird Electronic Corporation 1514
MCI 1520
Schafer Automation 1528
Bell Telephone Laboratories 1541
Dumont 1544
Raytheon 1556
Rust Industrial Company, Inc. 1575
Radix 1577
Weston 1585
Kinght-kit 1591
Kenwood 1606
Measurements 1614
National Association of Broadcasters 1643
Minicom Division of 3M 1658
American Electronic Laboratories 1664
BME - Broadcast Management Engineering Magazine 1675
ComStream 1677
Inovonics 1683
Larcan 1708
Hughey & Phillips 1761
American Data 1803
Amalgamated Wireless (Australiasia) Ltd. 1816
Kyocera 1864
Energy-Onix 1898
Metrotech 1900
Advanced Research & Technology 1933
Neotek 1949
Symmetrix 1957
WesternElectric 1966
HallikainenAndFriends 1974
Modulation Sciences 2014
Dana Electronics 2020
C & D Batteries 2020
Microwave Radio Corporation 2041
Cetec Broadcast Group 2051
Accurate Sound Corporation 2066
Arrakis Systems, Inc 2132
Altec 2137
CSI 2187
MEI 2252
Hallicrafters 2279
Nortronics 2279
Ampex 2318
Broadcast Audio 2345
GatesRadioCompany 2354
Collins Radio 2453
DeltaElectronics 2536
Tapecaster 2536
Orban 2630
Broadcast Electronics 2631
RCA 2632
ESE 2708
Burk Technology 2731
Belar Electronics Laboratory 2808
Crown 2814
Auditronics 2900
QEI 3468
LPB 3705
GeneralRadio 3867
Autogram 4362
Armstrong Transmitter Corporation 5774
TextFormattingRules 6327
Help/TextFormattingRules 15113

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