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 111
Jampro Antenna 141
dbx 218
GeneralElectric 239
Will-Burt Company 251
CBS Labs 304
Continental Electronics 351
Marti Electronics, Inc. 368
Electronics Digest 373
Wheatstone Corporation 390
Circuit Research Laboratories 433
Ratheon 445
Dolby Laboratories 457
OldMarkupTestPage 471
RedirectToPlugin 475
template 476
Help/OldMarkupTestPage 490
Help/OldMarkupTestPage 490
Help/OldMarkupTestPage 490
OldTextFormattingRules 495
Help/NewMarkupTestPage 495
Help/NewMarkupTestPage 495
Help/NewMarkupTestPage 495
NewMarkupTestPage 511
Help/OldTextFormattingRules 513
McMartin 518
Andrew Corporation 531
Radio Engineering 545
AmministrazioneDiPhpWiki 548
Potomac Instruments 548
UREI 562
CCA 572
GatesRadioCatalog99 605
Goldline 672
Teac 711
UMC Beaucart 712
Hewlett Packard 720
Cablewave Systems 726
IncludePagePlugin 741
Radio Business Report 752
Revox 756
Realistic 767
Thordarson 768
Harris Allied 776
Elgin Electronics 780
Sony 804
Fidelipac 806
3M 825
Tektronix 835
Telos 846
Johnson Electronics 856
Electronics Research, Inc. 866
MoseleyAssociatesInc 873
Telfax 886
Contel ASC 886
QRK 888
Aristocart 888
Federated Purchaser 895
Station Histories 897
Moulic Specialties Co. 904
Hollyanne 907
TFT, Inc. 925
Straight Wire Audio 926
Standard Telephones & Cables. Australia 927
Multronics 933
Microcon 939
Mullard 950
Magnecord 956
Standard Electronics 958
Consolidated Electronic Industries 959
Clear-Com 962
Sine Systems 962
Audi-Cord Corporation 965
Trimax 967
Pultec 967
Studer 967
Broadcast Television Systems 971
Heathkit 976
United Transformer Corporation 988
Cutting Edge Technologies 991
Engineering Services 993
Presto 1003
Byer Industries 1010
Radio Engineering Laboratories 1020
National 1035
ITC 1037
Coastcom 1042
EfJohnson 1044
HoweTech 1047
Broadcasters General Store 1050
Triplett 1057
Sparta Electronics 1061
Telefile Computer Products, Inc. 1061
Westinghouse 1062
Tepco 1067
Kenneth A. Bacon Associates 1068
Scala 1070
Nova Systems, Inc. 1078
Broadcast Tools 1088
Conex Electro Systems 1091
Peak Audio 1094
Machlett Laboratories 1095
Marconi Wireless Telegraph Company 1099
Bosch 1101
NBC 1102
Help/EditMetaDataPlugin 1105
Garner Industries 1106
ITA 1110
Scully 1112
Boonton Radio Corporation 1112
Motorola 1117
EimacDivisionOfVarian 1119
GatesAir 1121
Video Systems of America 1123
Marantz 1125
Midwest Communications 1126
Panasonic 1128
Help/RedirectToPlugin 1129
NAD Electronics 1130
Multi-technical Services 1133
Lang Electronics 1141
Wegener Communications 1148
Victoreen Instrument Company 1152
Link, Fred M 1152
Bauer Electronics Corporation 1166
Tentel 1167
US Audio 1172
Studer International AG 1176
MilitaryRadio 1180
J. G. S. Engineering Inc. 1180
Dayton Industrial 1182
Continental Satellite Systems 1182
Russco 1185
NemsClarke 1189
Philips 1190
Audio Arts 1192
Jennings 1206
Comtech Antenna Corporation 1208
Electrovoice 1208
Lorain Products Corporation 1212
Jensen Transformers 1213
Leeds & Northrup Company 1215
Standart Tape Laboratory 1219
Farallon 1220
Harman Kardon 1221
Simpson Electric Company 1230
Gregg Laboratories 1238
Historic Papers 1262
Yokogawa Electric Works 1270
Sescom 1274
Taber Manufacturing and Engineering Company 1287
Technics 1288
Soltec 1288
Gentner 1289
Otari 1289
Data Systems Design 1291
Dataworld 1297
IGM 1298
PhpWikiAdministration 1299
Anton Electronic Laboratories 1302
Amperite 1310
Texar 1317
Denon 1318
IRC 1340
Langevin 1345
Frese and Kaping 1345
Ohmite Manufacturing Company 1349
AmperexElectronicCorporation 1352
Aphex Systems Limited 1361
Computer Concepts 1362
Electronic Signal Products 1369
Extel 1372
SMC 1403
Automated Broadcast Controls 1403
Pacific Recorders and Engineers 1417
Gorman-Redlich 1455
Norcom 1458
Dorrough Electronics 1468
McIntosh 1469
Bext 1471
Teletronix Engineering Company 1504
Aston 1507
Harris Corporation - Broadcast Division 1510
Lambda Electronics Corp. 1512
ATI 1540
Thompson-CSF 1544
Schafer Automation 1556
MCI 1556
Bell Telephone Laboratories 1566
Dumont 1568
Raytheon 1593
Rust Industrial Company, Inc. 1595
Radix 1610
Kinght-kit 1614
Weston 1620
Kenwood 1636
Measurements 1647
National Association of Broadcasters 1674
Minicom Division of 3M 1679
ComStream 1707
BME - Broadcast Management Engineering Magazine 1708
Inovonics 1709
American Electronic Laboratories 1716
Larcan 1739
Hughey & Phillips 1799
Amalgamated Wireless (Australiasia) Ltd. 1840
American Data 1848
Bird Electronic Corporation 1894
Kyocera 1904
Energy-Onix 1936
Metrotech 1936
Advanced Research & Technology 1962
Neotek 1983
WesternElectric 1994
Symmetrix 1997
Dana Electronics 2043
Modulation Sciences 2047
C & D Batteries 2063
Microwave Radio Corporation 2074
Cetec Broadcast Group 2094
Accurate Sound Corporation 2105
Arrakis Systems, Inc 2166
Altec 2174
HallikainenAndFriends 2208
CSI 2231
MEI 2297
Hallicrafters 2309
Nortronics 2311
Broadcast Audio 2368
Ampex 2500
GatesRadioCompany 2550
Tapecaster 2577
Orban 2677
Collins Radio 2722
DeltaElectronics 2749
ESE 2754
Burk Technology 2770
Broadcast Electronics 2828
Belar Electronics Laboratory 2844
Crown 2855
Auditronics 2954
RCA 3064
QEI 3497
LPB 3757
GeneralRadio 4168
Autogram 4451
Armstrong Transmitter Corporation 5796
TextFormattingRules 6421
Help/TextFormattingRules 15373

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