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

It is 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 the hyperlink or pagename, a pipe (|) and then the name: 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 16298
Bird Electronic Corporation 9878
GeneralRadio 7472
TextFormattingRules 7094
RCA 5996
Armstrong Transmitter Corporation 5920
Autogram 5087
Broadcast Electronics 4913
Collins Radio 4707
GatesRadioCompany 4579
Ampex 4237
LPB 4087
HallikainenAndFriends 4050
QEI 3933
Crown 3253
Auditronics 3249
Historic Papers 3155
DeltaElectronics 3136
ESE 3132
Belar Electronics Laboratory 3100
Burk Technology 3074
Orban 2951
Tapecaster 2896
Broadcast Audio 2618
MEI 2591
Hallicrafters 2583
Harris Corporation - Broadcast Division 2574
Nortronics 2570
CSI 2459
Arrakis Systems, Inc 2381
Altec 2346
Cetec Broadcast Group 2308
C & D Batteries 2307
Gentner 2277
Accurate Sound Corporation 2262
Modulation Sciences 2259
Microwave Radio Corporation 2244
Symmetrix 2238
WesternElectric 2226
Dana Electronics 2219
Dorrough Electronics 2218
Neotek 2170
MilitaryRadio 2166
Energy-Onix 2129
Metrotech 2117
Kyocera 2105
Advanced Research & Technology 2102
Hughey & Phillips 2003
American Data 2000
Amalgamated Wireless (Australiasia) Ltd. 1967
Panasonic 1961
Dayton Industrial 1942
Inovonics 1913
ComStream 1902
Larcan 1886
American Electronic Laboratories 1871
BME - Broadcast Management Engineering Magazine 1832
Minicom Division of 3M 1828
National Association of Broadcasters 1797
Measurements 1787
Kenwood 1786
Weston 1777
Radix 1773
Kinght-kit 1766
Rust Industrial Company, Inc. 1751
Sparta Electronics 1738
Bell Telephone Laboratories 1726
Thompson-CSF 1713
Raytheon 1711
ATI 1707
MCI 1699
Schafer Automation 1692
Dumont 1687
Broadcast Tools 1669
Lambda Electronics Corp. 1666
Heathkit 1637
Aston 1621
McIntosh 1619
Teletronix Engineering Company 1619
Gorman-Redlich 1580
Norcom 1577
Bext 1570
ITC 1556
Pacific Recorders and Engineers 1542
SMC 1529
Automated Broadcast Controls 1511
TFT, Inc. 1506
Electronic Signal Products 1500
Extel 1486
Langevin 1485
Computer Concepts 1473
Frese and Kaping 1454
AmperexElectronicCorporation 1451
Aphex Systems Limited 1445
Texar 1444
IRC 1444
Station Histories 1433
PhpWikiAdministration 1431
Ohmite Manufacturing Company 1431
Otari 1419
Denon 1416
Soltec 1415
3M 1411
Amperite 1403
Dataworld 1399
Data Systems Design 1398
Anton Electronic Laboratories 1396
IGM 1393
Sescom 1390
Technics 1378
Taber Manufacturing and Engineering Company 1378
Yokogawa Electric Works 1364
MoseleyAssociatesInc 1355
Gregg Laboratories 1347
Leeds & Northrup Company 1336
Farallon 1326
Electrovoice 1322
Comtech Antenna Corporation 1321
Simpson Electric Company 1321
Harman Kardon 1320
Standart Tape Laboratory 1320
Lorain Products Corporation 1312
NemsClarke 1311
Tektronix 1306
Sony 1305
Jensen Transformers 1305
Jennings 1302
Audio Arts 1294
Studer International AG 1290
Russco 1290
Philips 1288
Continental Satellite Systems 1287
J. G. S. Engineering Inc. 1281
Tentel 1274
Link, Fred M 1264
US Audio 1261
Victoreen Instrument Company 1250
Multi-technical Services 1250
Midwest Communications 1249
Revox 1246
Bauer Electronics Corporation 1244
Wegener Communications 1243
Motorola 1238
Marantz 1238
Fidelipac 1224
Lang Electronics 1222
NAD Electronics 1222
Video Systems of America 1221
Scully 1217
Help/EditMetaDataPlugin 1214
GatesAir 1212
EimacDivisionOfVarian 1205
Boonton Radio Corporation 1203
Garner Industries 1202
Help/RedirectToPlugin 1200
Machlett Laboratories 1198
ITA 1188
NBC 1187
Kenneth A. Bacon Associates 1187
Peak Audio 1187
Conex Electro Systems 1185
Bosch 1182
Hewlett Packard 1182
Broadcasters General Store 1174
Marconi Wireless Telegraph Company 1167
Scala 1162
Triplett 1154
Nova Systems, Inc. 1152
Tepco 1149
Telefile Computer Products, Inc. 1143
Coastcom 1141
Westinghouse 1131
National 1125
EfJohnson 1115
HoweTech 1109
Sine Systems 1106
Presto 1100
Engineering Services 1099
Radio Engineering Laboratories 1098
Teac 1092
Byer Industries 1087
United Transformer Corporation 1074
Audi-Cord Corporation 1059
Consolidated Electronic Industries 1056
Cutting Edge Technologies 1056
Studer 1055
Pultec 1048
Standard Telephones & Cables. Australia 1042
Clear-Com 1038
Trimax 1037
Broadcast Television Systems 1034
Magnecord 1030
Mullard 1024
Standard Electronics 1021
Straight Wire Audio 1015
Multronics 1015
Microcon 1013
Potomac Instruments 1011
Aristocart 1004
Hollyanne 1003
Federated Purchaser 996
QRK 989
Moulic Specialties Co. 975
Contel ASC 970
Telfax 969
Johnson Electronics 946
Telos 940
Electronics Research, Inc. 918
Continental Electronics 905
CCA 893
Andrew Corporation 888
Harris Allied 883
Elgin Electronics 874
UREI 867
Thordarson 863
Realistic 858
Radio Business Report 850
McMartin 848
UMC Beaucart 826
IncludePagePlugin 825
Cablewave Systems 815
Goldline 774
CBS Labs 685
GatesRadioCatalog99 677
Marti Electronics, Inc. 677
Dolby Laboratories 674
Wheatstone Corporation 646
AmministrazioneDiPhpWiki 602
GeneralElectric 599
Radio Engineering 598
dbx 592
Circuit Research Laboratories 591
NewMarkupTestPage 570
OldMarkupTestPage 562
Electronics Digest 562
Help/OldTextFormattingRules 559
OldTextFormattingRules 551
template 551
Help/NewMarkupTestPage 548
Help/NewMarkupTestPage 548
Help/NewMarkupTestPage 548
Help/OldMarkupTestPage 544
Help/OldMarkupTestPage 544
Help/OldMarkupTestPage 544
RedirectToPlugin 517
Ratheon 514
Jampro Antenna 403
Will-Burt Company 383
Valcom 371

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