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 16355
Bird Electronic Corporation 10437
GeneralRadio 7784
TextFormattingRules 7147
RCA 6188
Armstrong Transmitter Corporation 5928
Autogram 5170
Broadcast Electronics 5091
Collins Radio 4911
GatesRadioCompany 4765
Ampex 4392
HallikainenAndFriends 4201
LPB 4120
QEI 3969
Crown 3282
Auditronics 3265
Historic Papers 3211
DeltaElectronics 3180
ESE 3163
Belar Electronics Laboratory 3120
Burk Technology 3103
Orban 2963
Tapecaster 2921
Harris Corporation - Broadcast Division 2737
Broadcast Audio 2648
MEI 2609
Hallicrafters 2599
Nortronics 2595
CSI 2475
Arrakis Systems, Inc 2401
Altec 2360
Gentner 2336
C & D Batteries 2320
Cetec Broadcast Group 2317
Dorrough Electronics 2284
Modulation Sciences 2276
Accurate Sound Corporation 2271
Microwave Radio Corporation 2271
Symmetrix 2258
WesternElectric 2247
Dana Electronics 2224
MilitaryRadio 2188
Neotek 2184
Energy-Onix 2137
Metrotech 2129
Kyocera 2119
Advanced Research & Technology 2109
Panasonic 2038
Hughey & Phillips 2017
Dayton Industrial 2004
American Data 2004
Amalgamated Wireless (Australiasia) Ltd. 1977
Inovonics 1930
ComStream 1917
Larcan 1896
American Electronic Laboratories 1878
Minicom Division of 3M 1838
BME - Broadcast Management Engineering Magazine 1835
Sparta Electronics 1807
National Association of Broadcasters 1807
Measurements 1798
Kenwood 1795
Weston 1789
Radix 1781
Kinght-kit 1780
Rust Industrial Company, Inc. 1764
Bell Telephone Laboratories 1740
Thompson-CSF 1728
Raytheon 1721
ATI 1716
Broadcast Tools 1714
MCI 1711
Schafer Automation 1702
Dumont 1696
Heathkit 1691
Lambda Electronics Corp. 1676
Teletronix Engineering Company 1633
Aston 1631
McIntosh 1629
Gorman-Redlich 1587
TFT, Inc. 1584
ITC 1584
Norcom 1583
Bext 1579
Pacific Recorders and Engineers 1551
SMC 1539
Automated Broadcast Controls 1517
Electronic Signal Products 1505
Station Histories 1500
Langevin 1496
Extel 1491
Computer Concepts 1480
3M 1479
Frese and Kaping 1464
AmperexElectronicCorporation 1454
Texar 1454
PhpWikiAdministration 1451
IRC 1451
Aphex Systems Limited 1447
Ohmite Manufacturing Company 1436
Otari 1429
Denon 1426
Soltec 1418
Dataworld 1408
MoseleyAssociatesInc 1407
Amperite 1406
IGM 1402
Data Systems Design 1401
Anton Electronic Laboratories 1398
Sescom 1395
Technics 1384
Taber Manufacturing and Engineering Company 1384
Yokogawa Electric Works 1369
Gregg Laboratories 1358
Tektronix 1346
Sony 1342
Leeds & Northrup Company 1342
Farallon 1335
Simpson Electric Company 1330
Comtech Antenna Corporation 1328
Electrovoice 1328
Harman Kardon 1327
Standart Tape Laboratory 1326
NemsClarke 1318
Lorain Products Corporation 1316
Jensen Transformers 1316
Jennings 1307
Audio Arts 1299
Studer International AG 1298
Russco 1298
Philips 1296
Continental Satellite Systems 1294
J. G. S. Engineering Inc. 1288
Revox 1287
Tentel 1282
Link, Fred M 1270
US Audio 1268
Victoreen Instrument Company 1258
Multi-technical Services 1254
Midwest Communications 1252
Bauer Electronics Corporation 1251
Fidelipac 1245
Wegener Communications 1245
Motorola 1242
Marantz 1241
Hewlett Packard 1237
NAD Electronics 1228
Video Systems of America 1227
Lang Electronics 1226
Scully 1223
Help/EditMetaDataPlugin 1222
GatesAir 1216
Boonton Radio Corporation 1216
EimacDivisionOfVarian 1212
Garner Industries 1209
Machlett Laboratories 1207
Help/RedirectToPlugin 1204
Kenneth A. Bacon Associates 1196
NBC 1195
Peak Audio 1195
Conex Electro Systems 1193
ITA 1189
Bosch 1186
Broadcasters General Store 1185
Marconi Wireless Telegraph Company 1170
Scala 1166
Triplett 1162
Tepco 1156
Nova Systems, Inc. 1154
Telefile Computer Products, Inc. 1149
Coastcom 1147
Westinghouse 1134
National 1132
Teac 1129
Sine Systems 1120
EfJohnson 1117
HoweTech 1110
Presto 1104
Engineering Services 1103
Radio Engineering Laboratories 1102
Byer Industries 1093
United Transformer Corporation 1078
Audi-Cord Corporation 1064
Consolidated Electronic Industries 1061
Cutting Edge Technologies 1059
Studer 1058
Pultec 1052
Standard Telephones & Cables. Australia 1048
Clear-Com 1042
Trimax 1040
Broadcast Television Systems 1040
Potomac Instruments 1039
Magnecord 1036
Mullard 1029
Standard Electronics 1024
Straight Wire Audio 1019
Multronics 1017
Microcon 1016
Aristocart 1013
Hollyanne 1008
Federated Purchaser 1002
QRK 993
Moulic Specialties Co. 978
Contel ASC 975
Telfax 972
Continental Electronics 955
Johnson Electronics 954
Telos 949
Electronics Research, Inc. 920
Andrew Corporation 920
CCA 915
Harris Allied 889
Elgin Electronics 888
McMartin 880
UREI 878
Thordarson 871
Realistic 863
Radio Business Report 860
UMC Beaucart 833
IncludePagePlugin 832
Cablewave Systems 821
Goldline 782
CBS Labs 724
Marti Electronics, Inc. 699
Dolby Laboratories 693
GatesRadioCatalog99 681
Wheatstone Corporation 677
dbx 627
GeneralElectric 624
AmministrazioneDiPhpWiki 604
Radio Engineering 604
Circuit Research Laboratories 598
Electronics Digest 580
NewMarkupTestPage 576
OldMarkupTestPage 567
Help/OldTextFormattingRules 566
template 561
OldTextFormattingRules 557
Help/NewMarkupTestPage 550
Help/NewMarkupTestPage 550
Help/NewMarkupTestPage 550
Help/OldMarkupTestPage 548
Help/OldMarkupTestPage 548
Help/OldMarkupTestPage 548
RedirectToPlugin 520
Ratheon 518
Jampro Antenna 419
Valcom 389
Will-Burt Company 388

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