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. Hits.
Help/TextFormattingRules 15233
PhpWikiAdministration 1288
Help/EditMetaDataPlugin 1091
Help/RedirectToPlugin 1122
TextFormattingRules 6384
OldTextFormattingRules 490
RedirectToPlugin 472
NewMarkupTestPage 503
OldMarkupTestPage 463
IncludePagePlugin 737
AmperexElectronicCorporation 1333
DeltaElectronics 2593
EimacDivisionOfVarian 1106
GatesRadioCompany 2451
GatesRadioCatalog99 601
GeneralElectric 208
GeneralRadio 4039
HallikainenAndFriends 2132
MoseleyAssociatesInc 846
Motorola 1105
National 1019
NemsClarke 1179
RCA 2947
WesternElectric 1980
Technics 1275
Westinghouse 1052
MilitaryRadio 1132
Historic Papers 1159
Station Histories 860
Ratheon 438
Raytheon 1575
EfJohnson 1034
American Electronic Laboratories 1679
Victoreen Instrument Company 1143
Anton Electronic Laboratories 1283
Collins Radio 2620
HoweTech 1038
Belar Electronics Laboratory 2829
Ampex 2447
Harris Corporation - Broadcast Division 1445
Dorrough Electronics 1428
Radio Engineering Laboratories 1011
Standard Electronics 951
Amalgamated Wireless (Australiasia) Ltd. 1830
Byer Industries 1002
Circuit Research Laboratories 408
Bauer Electronics Corporation 1157
Trimax 960
United Transformer Corporation 977
template 468
Philips 1179
McMartin 497
ITA 1102
Continental Electronics 318
Magnecord 948
TFT, Inc. 903
Schafer Automation 1544
Gentner 1204
Texar 1304
Langevin 1334
Altec 2150
CBS Labs 290
Pultec 956
Sony 778
3M 803
UREI 542
Frese and Kaping 1332
Revox 728
Federated Purchaser 881
CCA 544
LPB 3735
Hollyanne 896
Telfax 874
Help/OldTextFormattingRules 505
AmministrazioneDiPhpWiki 543
Help/NewMarkupTestPage 491
Help/NewMarkupTestPage 491
Help/NewMarkupTestPage 491
Help/OldMarkupTestPage 481
Help/OldMarkupTestPage 481
Help/OldMarkupTestPage 481
Larcan 1726
Tepco 1057
Standard Telephones & Cables. Australia 916
Presto 991
Straight Wire Audio 918
Arrakis Systems, Inc 2150
Consolidated Electronic Industries 950
Aphex Systems Limited 1343
QEI 3484
Multronics 922
ITC 1008
Machlett Laboratories 1084
Cutting Edge Technologies 983
Bext 1458
Tektronix 804
Electronics Research, Inc. 856
Advanced Research & Technology 1942
Marantz 1109
Microcon 930
Broadcast Television Systems 964
Bosch 1093
dbx 206
Otari 1274
Crown 2833
Broadcast Electronics 2746
ATI 1527
Scully 1099
Marti Electronics, Inc. 357
Harman Kardon 1210
Potomac Instruments 523
Broadcast Audio 2355
Andrew Corporation 507
Audio Arts 1181
Bird Electronic Corporation 1675
Dumont 1556
Autogram 4419
Radio Engineering 539
Heathkit 937
Mullard 937
NBC 1094
Amperite 1296
McIntosh 1459
Inovonics 1695
Neotek 1964
Moulic Specialties Co. 895
Engineering Services 983
IRC 1326
ESE 2736
Comtech Antenna Corporation 1196
Panasonic 1095
Orban 2654
Studer 958
Coastcom 1030
Clear-Com 953
Dolby Laboratories 444
CSI 2215
Bell Telephone Laboratories 1553
Pacific Recorders and Engineers 1399
Hewlett Packard 698
Sparta Electronics 1025
Tapecaster 2564
Scala 1060
Marconi Wireless Telegraph Company 1090
Energy-Onix 1915
Modulation Sciences 2034
Burk Technology 2746
Auditronics 2936
Jampro Antenna 129
Dayton Industrial 1144
Thompson-CSF 1530
Rust Industrial Company, Inc. 1587
Accurate Sound Corporation 2081
IGM 1288
SMC 1390
Radix 1600
Fidelipac 781
Hughey & Phillips 1779
Microwave Radio Corporation 2063
Broadcast Tools 1051
Symmetrix 1980
GatesAir 1110
Hallicrafters 2298
Kenwood 1625
Kyocera 1886
Teac 689
Wheatstone Corporation 382
Gorman-Redlich 1440
Studer International AG 1161
Data Systems Design 1282
Dana Electronics 2035
American Data 1822
Teletronix Engineering Company 1494
Tentel 1160
Taber Manufacturing and Engineering Company 1276
Standart Tape Laboratory 1208
Extel 1359
Russco 1175
Automated Broadcast Controls 1395
Electrovoice 1196
Jennings 1195
Wegener Communications 1140
Midwest Communications 1114
Aston 1499
Farallon 1206
Kenneth A. Bacon Associates 1061
J. G. S. Engineering Inc. 1171
Continental Satellite Systems 1167
ComStream 1695
Conex Electro Systems 1082
Denon 1308
Multi-technical Services 1123
Electronic Signal Products 1342
Lorain Products Corporation 1200
C & D Batteries 2049
Nova Systems, Inc. 1068
Nortronics 2295
Norcom 1448
Lambda Electronics Corp. 1500
US Audio 1164
Jensen Transformers 1203
Garner Industries 1097
Sescom 1262
Soltec 1278
Peak Audio 1084
MCI 1544
MEI 2280
Minicom Division of 3M 1671
Metrotech 1914
Lang Electronics 1133
Kinght-kit 1605
Cetec Broadcast Group 2075
Computer Concepts 1352
Dataworld 1287
National Association of Broadcasters 1660
Link, Fred M 1142
Weston 1610
Yokogawa Electric Works 1260
Measurements 1635
Electronics Digest 359
Gregg Laboratories 1230
Leeds & Northrup Company 1208
Video Systems of America 1092
Simpson Electric Company 1223
Triplett 1044
Boonton Radio Corporation 1106
Ohmite Manufacturing Company 1340
Contel ASC 877
Audi-Cord Corporation 956
Johnson Electronics 849
Telefile Computer Products, Inc. 1050
Realistic 757
Thordarson 762
Sine Systems 952
Telos 835
Harris Allied 764
Broadcasters General Store 1021
QRK 878
BME - Broadcast Management Engineering Magazine 1692
Radio Business Report 736
UMC Beaucart 702
Armstrong Transmitter Corporation 5785
Cablewave Systems 718
Aristocart 865
Elgin Electronics 771
Goldline 663
NAD Electronics 1120
Will-Burt Company 242
Valcom 94

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