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 95
Jampro Antenna 130
dbx 207
GeneralElectric 213
Will-Burt Company 243
CBS Labs 291
Continental Electronics 323
Marti Electronics, Inc. 358
Electronics Digest 361
Wheatstone Corporation 383
Circuit Research Laboratories 410
Ratheon 438
Dolby Laboratories 448
OldMarkupTestPage 463
template 469
RedirectToPlugin 473
Help/OldMarkupTestPage 482
Help/OldMarkupTestPage 482
Help/OldMarkupTestPage 482
OldTextFormattingRules 490
Help/NewMarkupTestPage 491
Help/NewMarkupTestPage 491
Help/NewMarkupTestPage 491
McMartin 499
NewMarkupTestPage 504
Help/OldTextFormattingRules 506
Andrew Corporation 509
Potomac Instruments 526
Radio Engineering 540
AmministrazioneDiPhpWiki 543
UREI 549
CCA 549
GatesRadioCatalog99 601
Goldline 664
Teac 694
Hewlett Packard 701
UMC Beaucart 704
Cablewave Systems 719
Revox 735
IncludePagePlugin 737
Radio Business Report 737
Realistic 758
Thordarson 763
Harris Allied 766
Elgin Electronics 772
Sony 781
Fidelipac 785
3M 805
Tektronix 811
Telos 836
MoseleyAssociatesInc 850
Johnson Electronics 850
Electronics Research, Inc. 858
Aristocart 866
Station Histories 870
Telfax 877
Contel ASC 879
QRK 879
Federated Purchaser 883
Moulic Specialties Co. 897
Hollyanne 898
TFT, Inc. 907
Standard Telephones & Cables. Australia 918
Straight Wire Audio 920
Multronics 923
Microcon 931
Mullard 939
Heathkit 942
Magnecord 949
Standard Electronics 952
Consolidated Electronic Industries 952
Clear-Com 954
Sine Systems 954
Audi-Cord Corporation 957
Pultec 959
Studer 959
Trimax 961
Broadcast Television Systems 965
United Transformer Corporation 979
Cutting Edge Technologies 984
Engineering Services 984
Presto 994
Byer Industries 1003
ITC 1013
Radio Engineering Laboratories 1014
National 1021
Broadcasters General Store 1023
Sparta Electronics 1029
Coastcom 1032
EfJohnson 1036
HoweTech 1039
Triplett 1046
Telefile Computer Products, Inc. 1051
Westinghouse 1053
Broadcast Tools 1056
Tepco 1059
Scala 1061
Kenneth A. Bacon Associates 1062
Nova Systems, Inc. 1070
Conex Electro Systems 1083
Machlett Laboratories 1086
Peak Audio 1086
Marconi Wireless Telegraph Company 1091
Help/EditMetaDataPlugin 1092
Video Systems of America 1093
Bosch 1094
NBC 1095
Panasonic 1098
Garner Industries 1098
Scully 1102
ITA 1103
EimacDivisionOfVarian 1107
Motorola 1107
Boonton Radio Corporation 1107
Marantz 1111
GatesAir 1114
Midwest Communications 1118
NAD Electronics 1121
Help/RedirectToPlugin 1123
Multi-technical Services 1124
Lang Electronics 1134
MilitaryRadio 1136
Wegener Communications 1141
Link, Fred M 1143
Victoreen Instrument Company 1144
Dayton Industrial 1147
Bauer Electronics Corporation 1158
Tentel 1161
Studer International AG 1166
US Audio 1167
Continental Satellite Systems 1169
Historic Papers 1172
J. G. S. Engineering Inc. 1172
Russco 1176
NemsClarke 1180
Philips 1181
Audio Arts 1183
Jennings 1196
Electrovoice 1197
Comtech Antenna Corporation 1199
Lorain Products Corporation 1201
Jensen Transformers 1204
Farallon 1209
Leeds & Northrup Company 1209
Standart Tape Laboratory 1210
Gentner 1211
Harman Kardon 1211
Simpson Electric Company 1224
Gregg Laboratories 1231
Yokogawa Electric Works 1261
Sescom 1263
Otari 1276
Taber Manufacturing and Engineering Company 1278
Technics 1279
Soltec 1279
Anton Electronic Laboratories 1284
Data Systems Design 1284
Dataworld 1288
PhpWikiAdministration 1290
IGM 1290
Amperite 1297
Texar 1307
Denon 1309
IRC 1328
Frese and Kaping 1333
AmperexElectronicCorporation 1335
Langevin 1335
Ohmite Manufacturing Company 1341
Aphex Systems Limited 1345
Electronic Signal Products 1345
Computer Concepts 1353
Extel 1360
SMC 1391
Automated Broadcast Controls 1396
Pacific Recorders and Engineers 1404
Dorrough Electronics 1430
Gorman-Redlich 1443
Norcom 1449
Harris Corporation - Broadcast Division 1452
Bext 1460
McIntosh 1460
Teletronix Engineering Company 1497
Aston 1500
Lambda Electronics Corp. 1501
ATI 1528
Thompson-CSF 1531
MCI 1545
Schafer Automation 1546
Bell Telephone Laboratories 1556
Dumont 1558
Raytheon 1577
Rust Industrial Company, Inc. 1588
Radix 1601
Kinght-kit 1606
Weston 1611
Kenwood 1626
Measurements 1636
National Association of Broadcasters 1662
Minicom Division of 3M 1672
American Electronic Laboratories 1683
Bird Electronic Corporation 1686
BME - Broadcast Management Engineering Magazine 1693
ComStream 1696
Inovonics 1697
Larcan 1727
Hughey & Phillips 1780
American Data 1824
Amalgamated Wireless (Australiasia) Ltd. 1832
Kyocera 1887
Metrotech 1916
Energy-Onix 1918
Advanced Research & Technology 1943
Neotek 1966
WesternElectric 1982
Symmetrix 1982
Modulation Sciences 2036
Dana Electronics 2036
C & D Batteries 2050
Microwave Radio Corporation 2065
Cetec Broadcast Group 2078
Accurate Sound Corporation 2082
HallikainenAndFriends 2141
Altec 2152
Arrakis Systems, Inc 2153
CSI 2218
MEI 2282
Nortronics 2297
Hallicrafters 2300
Broadcast Audio 2356
Ampex 2450
GatesRadioCompany 2461
Tapecaster 2566
DeltaElectronics 2596
Collins Radio 2640
Orban 2661
ESE 2739
Burk Technology 2748
Broadcast Electronics 2750
Belar Electronics Laboratory 2831
Crown 2835
Auditronics 2938
RCA 2964
QEI 3485
LPB 3737
GeneralRadio 4073
Autogram 4423
Armstrong Transmitter Corporation 5787
TextFormattingRules 6387
Help/TextFormattingRules 15258

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