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 15187
TextFormattingRules 6374
Armstrong Transmitter Corporation 5782
Autogram 4410
GeneralRadio 4007
LPB 3730
QEI 3478
Auditronics 2929
Crown 2828
Belar Electronics Laboratory 2820
RCA 2789
Burk Technology 2742
ESE 2733
Broadcast Electronics 2729
Orban 2651
DeltaElectronics 2579
Collins Radio 2565
Tapecaster 2562
Ampex 2431
GatesRadioCompany 2400
Broadcast Audio 2351
Hallicrafters 2296
Nortronics 2293
MEI 2264
CSI 2204
Altec 2150
Arrakis Systems, Inc 2148
HallikainenAndFriends 2093
Accurate Sound Corporation 2076
Cetec Broadcast Group 2069
Microwave Radio Corporation 2059
C & D Batteries 2037
Dana Electronics 2033
Modulation Sciences 2031
Symmetrix 1979
WesternElectric 1978
Neotek 1960
Advanced Research & Technology 1942
Energy-Onix 1910
Metrotech 1910
Kyocera 1882
Amalgamated Wireless (Australiasia) Ltd. 1826
American Data 1819
Hughey & Phillips 1768
Larcan 1721
Inovonics 1694
ComStream 1693
BME - Broadcast Management Engineering Magazine 1687
American Electronic Laboratories 1674
Minicom Division of 3M 1669
National Association of Broadcasters 1655
Measurements 1634
Kenwood 1623
Weston 1602
Kinght-kit 1598
Radix 1593
Bird Electronic Corporation 1590
Rust Industrial Company, Inc. 1586
Raytheon 1570
Dumont 1554
Bell Telephone Laboratories 1552
Schafer Automation 1539
MCI 1534
Thompson-CSF 1528
ATI 1524
Lambda Electronics Corp. 1499
Aston 1496
Teletronix Engineering Company 1493
Bext 1456
McIntosh 1455
Norcom 1447
Gorman-Redlich 1435
Harris Corporation - Broadcast Division 1412
Dorrough Electronics 1409
Pacific Recorders and Engineers 1397
Automated Broadcast Controls 1395
SMC 1386
Extel 1358
Computer Concepts 1352
Aphex Systems Limited 1343
Electronic Signal Products 1341
Ohmite Manufacturing Company 1340
AmperexElectronicCorporation 1332
Langevin 1330
Frese and Kaping 1326
IRC 1326
Denon 1308
Texar 1298
Amperite 1296
IGM 1285
Dataworld 1285
Anton Electronic Laboratories 1283
Data Systems Design 1282
PhpWikiAdministration 1280
Soltec 1277
Taber Manufacturing and Engineering Company 1276
Technics 1273
Otari 1273
Yokogawa Electric Works 1260
Sescom 1259
Gregg Laboratories 1229
Simpson Electric Company 1221
Harman Kardon 1208
Standart Tape Laboratory 1206
Leeds & Northrup Company 1205
Farallon 1204
Jensen Transformers 1203
Lorain Products Corporation 1197
Comtech Antenna Corporation 1196
Electrovoice 1195
Jennings 1191
Audio Arts 1181
Philips 1178
Gentner 1177
NemsClarke 1176
Russco 1175
J. G. S. Engineering Inc. 1170
Continental Satellite Systems 1165
US Audio 1162
Studer International AG 1159
Tentel 1158
Bauer Electronics Corporation 1156
Victoreen Instrument Company 1141
Link, Fred M 1141
Wegener Communications 1138
Lang Electronics 1132
Dayton Industrial 1125
Help/RedirectToPlugin 1120
Multi-technical Services 1120
NAD Electronics 1120
MilitaryRadio 1116
Historic Papers 1116
Midwest Communications 1112
Marantz 1109
GatesAir 1109
EimacDivisionOfVarian 1105
Boonton Radio Corporation 1105
Motorola 1103
ITA 1102
Scully 1099
Garner Industries 1096
NBC 1094
Bosch 1093
Video Systems of America 1092
Help/EditMetaDataPlugin 1089
Panasonic 1088
Marconi Wireless Telegraph Company 1087
Machlett Laboratories 1083
Conex Electro Systems 1082
Peak Audio 1080
Nova Systems, Inc. 1068
Scala 1059
Kenneth A. Bacon Associates 1059
Tepco 1056
Westinghouse 1052
Telefile Computer Products, Inc. 1050
Broadcast Tools 1046
Triplett 1044
HoweTech 1037
EfJohnson 1034
Coastcom 1029
Sparta Electronics 1020
Broadcasters General Store 1019
National 1018
Radio Engineering Laboratories 1011
Byer Industries 1002
Presto 990
Cutting Edge Technologies 982
Engineering Services 981
United Transformer Corporation 975
ITC 970
Broadcast Television Systems 962
Trimax 957
Studer 956
Audi-Cord Corporation 954
Pultec 952
Clear-Com 951
Standard Electronics 950
Consolidated Electronic Industries 949
Sine Systems 949
Magnecord 948
Mullard 936
Microcon 928
Multronics 919
Straight Wire Audio 917
Standard Telephones & Cables. Australia 915
Heathkit 911
TFT, Inc. 898
Hollyanne 895
Moulic Specialties Co. 895
Federated Purchaser 881
Telfax 874
QRK 874
Contel ASC 873
Aristocart 860
Electronics Research, Inc. 855
Station Histories 853
Johnson Electronics 848
MoseleyAssociatesInc 835
Telos 833
Tektronix 796
Fidelipac 774
Elgin Electronics 769
Harris Allied 764
Thordarson 760
Realistic 757
3M 748
Sony 738
Radio Business Report 733
IncludePagePlugin 732
Cablewave Systems 717
UMC Beaucart 700
Revox 694
Hewlett Packard 692
Teac 678
Goldline 662
GatesRadioCatalog99 600
AmministrazioneDiPhpWiki 542
CCA 538
Radio Engineering 538
UREI 534
Potomac Instruments 516
Andrew Corporation 503
NewMarkupTestPage 502
Help/OldTextFormattingRules 502
OldTextFormattingRules 489
McMartin 489
Help/NewMarkupTestPage 488
Help/NewMarkupTestPage 488
Help/NewMarkupTestPage 488
Help/OldMarkupTestPage 480
Help/OldMarkupTestPage 480
Help/OldMarkupTestPage 480
RedirectToPlugin 471
template 466
OldMarkupTestPage 460
Dolby Laboratories 441
Ratheon 436
Circuit Research Laboratories 404
Wheatstone Corporation 379
Marti Electronics, Inc. 356
Electronics Digest 355
Continental Electronics 304
CBS Labs 283
Will-Burt Company 241
GeneralElectric 200
dbx 178
Jampro Antenna 126
Valcom 87

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