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

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