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

247 pages link to HomePage:
|<<   << - 1 / 5 - Next >>   >>|
|<<   << - 1 / 5 - Next >>   >>|
Page Name. HitsClick to reverse sort order
Fidelipac 50
Broadcast Tools 104
Ratheon 342
Help/OldMarkupTestPage 344
Help/OldMarkupTestPage 344
Help/OldMarkupTestPage 344
OldMarkupTestPage 345
Radio Engineering 352
Help/NewMarkupTestPage 353
Help/NewMarkupTestPage 353
Help/NewMarkupTestPage 353
RedirectToPlugin 362
Help/OldTextFormattingRules 362
template 363
OldTextFormattingRules 375
NewMarkupTestPage 381
AmministrazioneDiPhpWiki 388
GeneralRadio 397
Goldline 404
GatesRadioCompany 409
GatesRadioCatalog99 433
UMC Beaucart 448
Cablewave Systems 450
Radio Business Report 481
Elgin Electronics 499
Harris Allied 503
Thordarson 515
Realistic 516
Aristocart 546
Telos 583
IncludePagePlugin 584
Johnson Electronics 608
Contel ASC 609
QRK 621
Sine Systems 644
Electronics Research, Inc. 664
Federated Purchaser 670
Telfax 677
Audi-Cord Corporation 690
Hollyanne 696
Moulic Specialties Co. 708
Multronics 714
Straight Wire Audio 716
Standard Telephones & Cables. Australia 716
Cutting Edge Technologies 725
Microcon 730
Broadcast Television Systems 730
Clear-Com 731
Consolidated Electronic Industries 735
Standard Electronics 737
Broadcasters General Store 737
Magnecord 746
Mullard 746
United Transformer Corporation 747
Studer 751
Trimax 751
Pultec 753
NemsClarke 766
Engineering Services 774
Byer Industries 784
Triplett 787
Radio Engineering Laboratories 790
Presto 794
Coastcom 807
National 807
Kenneth A. Bacon Associates 825
Motorola 825
Help/EditMetaDataPlugin 827
Peak Audio 832
HoweTech 835
Westinghouse 837
Conex Electro Systems 839
Video Systems of America 839
EfJohnson 841
Garner Industries 845
Telefile Computer Products, Inc. 850
Marantz 854
Scully 854
Nova Systems, Inc. 855
Scala 858
EimacDivisionOfVarian 858
Boonton Radio Corporation 860
NBC 861
NAD Electronics 861
Tepco 864
GatesAir 866
Lang Electronics 868
Machlett Laboratories 869
Bosch 871
Help/RedirectToPlugin 872
Midwest Communications 873
Multi-technical Services 876
Continental Satellite Systems 895
Marconi Wireless Telegraph Company 896
Wegener Communications 897
Bauer Electronics Corporation 899
ITA 900
Victoreen Instrument Company 903
US Audio 906
PhpWikiAdministration 907
Link, Fred M 908
Harman Kardon 909
Philips 916
Studer International AG 919
Tentel 921
Electrovoice 923
Russco 931
Comtech Antenna Corporation 935
J. G. S. Engineering Inc. 940
Audio Arts 944
Jennings 946
Farallon 953
Gregg Laboratories 959
Lorain Products Corporation 963
Jensen Transformers 969
Leeds & Northrup Company 974
Standart Tape Laboratory 974
Simpson Electric Company 980
Technics 992
Soltec 1000
Otari 1004
Data Systems Design 1005
Texar 1010
Sescom 1017
Dataworld 1026
IGM 1030
Yokogawa Electric Works 1035
Denon 1037
Anton Electronic Laboratories 1038
Frese and Kaping 1040
Amperite 1040
Electronic Signal Products 1057
Taber Manufacturing and Engineering Company 1057
IRC 1064
Langevin 1064
SMC 1077
Computer Concepts 1077
AmperexElectronicCorporation 1080
Extel 1085
Aphex Systems Limited 1093
Ohmite Manufacturing Company 1096
Automated Broadcast Controls 1116
Bext 1135
Gorman-Redlich 1144
Pacific Recorders and Engineers 1156
Norcom 1162
McIntosh 1162
Thompson-CSF 1185
Aston 1207
ATI 1216
Teletronix Engineering Company 1227
Bell Telephone Laboratories 1229
Dumont 1233
MCI 1233
Lambda Electronics Corp. 1234
Schafer Automation 1255
Raytheon 1271
Weston 1274
Kinght-kit 1278
Radix 1278
National Association of Broadcasters 1294
ComStream 1303
Measurements 1305
Kenwood 1306
Inovonics 1307
Jampro Antenna 1315
Rust Industrial Company, Inc. 1332
Larcan 1350
Minicom Division of 3M 1353
American Electronic Laboratories 1356
Hughey & Phillips 1362
Electronics Digest 1374
BME - Broadcast Management Engineering Magazine 1419
Kyocera 1457
Energy-Onix 1460
American Data 1485
Symmetrix 1492
Metrotech 1524
Amalgamated Wireless (Australiasia) Ltd. 1544
Neotek 1547
WesternElectric 1557
C & D Batteries 1570
Wheatstone Corporation 1573
Microwave Radio Corporation 1583
Advanced Research & Technology 1584
Modulation Sciences 1591
Dana Electronics 1592
Circuit Research Laboratories 1674
Cetec Broadcast Group 1693
Accurate Sound Corporation 1700
CSI 1715
Dolby Laboratories 1731
Arrakis Systems, Inc 1738
Hallicrafters 1752
Altec 1771
Broadcast Audio 1796
MEI 1801
Nortronics 1869
DeltaElectronics 1906
UREI 1967
Potomac Instruments 2011
Tapecaster 2039
Andrew Corporation 2041
ESE 2076
Burk Technology 2107
Orban 2121
Marti Electronics, Inc. 2125
CCA 2125
McMartin 2167
Crown 2171
Auditronics 2279
Belar Electronics Laboratory 2333
GeneralElectric 2335
dbx 2355
Teac 2602
Revox 2602
CBS Labs 2634
Tektronix 2696
Sony 2815
QEI 2864
Hewlett Packard 2870
LPB 3111
Continental Electronics 3247
3M 3262
Autogram 3267
ITC 3313
Station Histories 3344
Sparta Electronics 3626
Heathkit 3682
MilitaryRadio 4210
Dorrough Electronics 4286
Panasonic 4286
Dayton Industrial 4568
Gentner 4733
TFT, Inc. 4967
TextFormattingRules 5251
Armstrong Transmitter Corporation 5515
Historic Papers 6362
Harris Corporation - Broadcast Division 7527
MoseleyAssociatesInc 7572
Ampex 8936
Broadcast Electronics 9751
Collins Radio 10223
HallikainenAndFriends 10772
RCA 11119
Help/TextFormattingRules 13374
Bird Electronic Corporation 21783

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