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 384
Will-Burt Company 386
Jampro Antenna 412
RedirectToPlugin 517
Ratheon 517
Help/OldMarkupTestPage 547
Help/OldMarkupTestPage 547
Help/OldMarkupTestPage 547
Help/NewMarkupTestPage 550
Help/NewMarkupTestPage 550
Help/NewMarkupTestPage 550
OldTextFormattingRules 554
template 557
OldMarkupTestPage 564
Help/OldTextFormattingRules 564
NewMarkupTestPage 574
Electronics Digest 577
Circuit Research Laboratories 595
Radio Engineering 601
AmministrazioneDiPhpWiki 603
GeneralElectric 614
dbx 623
Wheatstone Corporation 664
GatesRadioCatalog99 681
Marti Electronics, Inc. 691
Dolby Laboratories 691
CBS Labs 715
Goldline 779
Cablewave Systems 820
IncludePagePlugin 830
UMC Beaucart 832
Radio Business Report 857
Realistic 862
Thordarson 871
McMartin 874
UREI 874
Elgin Electronics 885
Harris Allied 889
Andrew Corporation 908
CCA 912
Electronics Research, Inc. 919
Continental Electronics 945
Telos 947
Johnson Electronics 952
Telfax 970
Contel ASC 974
Moulic Specialties Co. 977
QRK 990
Federated Purchaser 1001
Hollyanne 1006
Aristocart 1009
Microcon 1016
Multronics 1017
Straight Wire Audio 1018
Standard Electronics 1023
Mullard 1027
Potomac Instruments 1033
Magnecord 1034
Trimax 1039
Broadcast Television Systems 1040
Clear-Com 1041
Standard Telephones & Cables. Australia 1047
Pultec 1051
Cutting Edge Technologies 1057
Studer 1057
Consolidated Electronic Industries 1060
Audi-Cord Corporation 1061
United Transformer Corporation 1077
Byer Industries 1091
Radio Engineering Laboratories 1100
Presto 1101
Engineering Services 1102
HoweTech 1110
Sine Systems 1115
EfJohnson 1116
Teac 1127
National 1129
Westinghouse 1132
Coastcom 1144
Telefile Computer Products, Inc. 1148
Tepco 1153
Nova Systems, Inc. 1154
Triplett 1162
Scala 1166
Marconi Wireless Telegraph Company 1169
Broadcasters General Store 1178
Bosch 1184
ITA 1188
Conex Electro Systems 1190
NBC 1191
Peak Audio 1193
Kenneth A. Bacon Associates 1196
Help/RedirectToPlugin 1201
Machlett Laboratories 1204
Garner Industries 1208
EimacDivisionOfVarian 1209
Boonton Radio Corporation 1210
GatesAir 1214
Scully 1221
Help/EditMetaDataPlugin 1222
NAD Electronics 1223
Lang Electronics 1224
Video Systems of America 1226
Hewlett Packard 1228
Fidelipac 1232
Motorola 1241
Marantz 1241
Wegener Communications 1245
Bauer Electronics Corporation 1249
Midwest Communications 1252
Multi-technical Services 1254
Victoreen Instrument Company 1256
Revox 1260
US Audio 1265
Link, Fred M 1268
Tentel 1278
J. G. S. Engineering Inc. 1288
Philips 1292
Continental Satellite Systems 1292
Studer International AG 1295
Russco 1296
Audio Arts 1298
Jennings 1305
Jensen Transformers 1312
Lorain Products Corporation 1315
NemsClarke 1317
Standart Tape Laboratory 1323
Electrovoice 1323
Comtech Antenna Corporation 1325
Harman Kardon 1326
Simpson Electric Company 1327
Farallon 1332
Sony 1339
Tektronix 1340
Leeds & Northrup Company 1342
Gregg Laboratories 1355
Yokogawa Electric Works 1368
Taber Manufacturing and Engineering Company 1381
Technics 1383
Sescom 1394
Anton Electronic Laboratories 1396
MoseleyAssociatesInc 1399
IGM 1400
Data Systems Design 1400
Amperite 1406
Dataworld 1406
Soltec 1416
Denon 1419
Otari 1429
Ohmite Manufacturing Company 1433
Aphex Systems Limited 1446
PhpWikiAdministration 1449
IRC 1450
Texar 1452
AmperexElectronicCorporation 1453
Frese and Kaping 1461
3M 1471
Station Histories 1479
Computer Concepts 1479
Extel 1490
Langevin 1494
Electronic Signal Products 1503
Automated Broadcast Controls 1514
SMC 1537
Pacific Recorders and Engineers 1550
ITC 1570
TFT, Inc. 1575
Bext 1577
Norcom 1582
Gorman-Redlich 1586
McIntosh 1627
Teletronix Engineering Company 1628
Aston 1628
Lambda Electronics Corp. 1672
Heathkit 1686
Broadcast Tools 1690
Dumont 1693
Schafer Automation 1700
MCI 1708
ATI 1714
Raytheon 1717
Thompson-CSF 1722
Bell Telephone Laboratories 1739
Rust Industrial Company, Inc. 1762
Kinght-kit 1777
Radix 1780
Weston 1787
Measurements 1792
Kenwood 1793
Sparta Electronics 1798
National Association of Broadcasters 1805
BME - Broadcast Management Engineering Magazine 1834
Minicom Division of 3M 1837
American Electronic Laboratories 1876
Larcan 1893
ComStream 1911
Inovonics 1929
Amalgamated Wireless (Australiasia) Ltd. 1973
Dayton Industrial 1995
American Data 2002
Hughey & Phillips 2014
Panasonic 2029
Advanced Research & Technology 2109
Kyocera 2112
Metrotech 2128
Energy-Onix 2134
Neotek 2178
MilitaryRadio 2183
Dana Electronics 2223
WesternElectric 2238
Symmetrix 2254
Microwave Radio Corporation 2265
Accurate Sound Corporation 2270
Modulation Sciences 2276
Dorrough Electronics 2277
Gentner 2311
Cetec Broadcast Group 2311
C & D Batteries 2312
Altec 2355
Arrakis Systems, Inc 2393
CSI 2474
Hallicrafters 2589
Nortronics 2589
MEI 2605
Broadcast Audio 2642
Harris Corporation - Broadcast Division 2671
Tapecaster 2920
Orban 2957
Burk Technology 3096
Belar Electronics Laboratory 3115
ESE 3158
DeltaElectronics 3171
Historic Papers 3189
Auditronics 3260
Crown 3280
QEI 3966
LPB 4113
HallikainenAndFriends 4187
Ampex 4367
GatesRadioCompany 4730
Collins Radio 4880
Broadcast Electronics 5051
Autogram 5154
Armstrong Transmitter Corporation 5926
RCA 6164
TextFormattingRules 7128
GeneralRadio 7697
Bird Electronic Corporation 10178
Help/TextFormattingRules 16341

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