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 92
Jampro Antenna 128
GeneralElectric 205
dbx 206
Will-Burt Company 242
CBS Labs 286
Continental Electronics 307
Marti Electronics, Inc. 356
Electronics Digest 357
Wheatstone Corporation 380
Circuit Research Laboratories 408
Ratheon 438
Dolby Laboratories 442
OldMarkupTestPage 462
template 467
RedirectToPlugin 472
Help/OldMarkupTestPage 481
Help/OldMarkupTestPage 481
Help/OldMarkupTestPage 481
OldTextFormattingRules 490
Help/NewMarkupTestPage 491
Help/NewMarkupTestPage 491
Help/NewMarkupTestPage 491
McMartin 495
NewMarkupTestPage 503
Andrew Corporation 503
Help/OldTextFormattingRules 505
Potomac Instruments 520
Radio Engineering 539
UREI 540
AmministrazioneDiPhpWiki 543
CCA 544
GatesRadioCatalog99 601
Goldline 663
Teac 682
Hewlett Packard 696
UMC Beaucart 702
Cablewave Systems 717
Revox 722
IncludePagePlugin 735
Radio Business Report 735
Realistic 757
Thordarson 760
Harris Allied 764
Sony 771
Elgin Electronics 771
Fidelipac 774
3M 791
Tektronix 800
Telos 835
MoseleyAssociatesInc 843
Johnson Electronics 848
Electronics Research, Inc. 856
Station Histories 857
Aristocart 862
Telfax 874
Contel ASC 876
QRK 878
Federated Purchaser 881
Hollyanne 895
Moulic Specialties Co. 895
TFT, Inc. 899
Standard Telephones & Cables. Australia 915
Straight Wire Audio 918
Multronics 920
Microcon 929
Heathkit 931
Mullard 936
Magnecord 948
Standard Electronics 950
Consolidated Electronic Industries 950
Sine Systems 951
Clear-Com 953
Pultec 956
Studer 956
Audi-Cord Corporation 956
Trimax 960
Broadcast Television Systems 964
United Transformer Corporation 977
Engineering Services 982
Cutting Edge Technologies 983
Presto 990
Byer Industries 1002
ITC 1003
Radio Engineering Laboratories 1011
National 1018
Broadcasters General Store 1021
Sparta Electronics 1023
Coastcom 1030
EfJohnson 1034
HoweTech 1038
Triplett 1044
Broadcast Tools 1050
Telefile Computer Products, Inc. 1050
Westinghouse 1052
Tepco 1057
Scala 1059
Kenneth A. Bacon Associates 1060
Nova Systems, Inc. 1068
Conex Electro Systems 1082
Peak Audio 1082
Machlett Laboratories 1083
Panasonic 1089
Marconi Wireless Telegraph Company 1089
Help/EditMetaDataPlugin 1090
Video Systems of America 1092
Bosch 1093
NBC 1094
Garner Industries 1097
Scully 1099
ITA 1102
Motorola 1104
Boonton Radio Corporation 1105
EimacDivisionOfVarian 1106
Marantz 1109
GatesAir 1110
Midwest Communications 1112
Multi-technical Services 1120
NAD Electronics 1120
Help/RedirectToPlugin 1121
MilitaryRadio 1127
Dayton Industrial 1130
Lang Electronics 1133
Wegener Communications 1138
Victoreen Instrument Company 1142
Link, Fred M 1142
Historic Papers 1147
Bauer Electronics Corporation 1156
Tentel 1158
Studer International AG 1160
US Audio 1163
Continental Satellite Systems 1167
J. G. S. Engineering Inc. 1171
Russco 1175
NemsClarke 1177
Philips 1179
Audio Arts 1181
Gentner 1193
Jennings 1195
Comtech Antenna Corporation 1196
Electrovoice 1196
Lorain Products Corporation 1199
Jensen Transformers 1203
Farallon 1206
Leeds & Northrup Company 1206
Standart Tape Laboratory 1208
Harman Kardon 1210
Simpson Electric Company 1222
Gregg Laboratories 1229
Sescom 1260
Yokogawa Electric Works 1260
Otari 1274
Technics 1275
Taber Manufacturing and Engineering Company 1276
Soltec 1278
Data Systems Design 1282
Anton Electronic Laboratories 1283
PhpWikiAdministration 1285
Dataworld 1285
IGM 1287
Amperite 1296
Texar 1302
Denon 1308
IRC 1326
Frese and Kaping 1327
Langevin 1332
AmperexElectronicCorporation 1333
Ohmite Manufacturing Company 1340
Electronic Signal Products 1342
Aphex Systems Limited 1343
Computer Concepts 1352
Extel 1358
SMC 1390
Automated Broadcast Controls 1395
Pacific Recorders and Engineers 1399
Dorrough Electronics 1423
Gorman-Redlich 1438
Harris Corporation - Broadcast Division 1440
Norcom 1447
Bext 1458
McIntosh 1459
Teletronix Engineering Company 1494
Aston 1498
Lambda Electronics Corp. 1499
ATI 1527
Thompson-CSF 1530
MCI 1542
Schafer Automation 1543
Bell Telephone Laboratories 1552
Dumont 1554
Raytheon 1575
Rust Industrial Company, Inc. 1586
Radix 1598
Kinght-kit 1605
Weston 1606
Kenwood 1624
Bird Electronic Corporation 1632
Measurements 1635
National Association of Broadcasters 1659
Minicom Division of 3M 1669
American Electronic Laboratories 1677
BME - Broadcast Management Engineering Magazine 1691
Inovonics 1694
ComStream 1694
Larcan 1726
Hughey & Phillips 1778
American Data 1821
Amalgamated Wireless (Australiasia) Ltd. 1830
Kyocera 1885
Energy-Onix 1913
Metrotech 1913
Advanced Research & Technology 1942
Neotek 1964
WesternElectric 1979
Symmetrix 1980
Modulation Sciences 2034
Dana Electronics 2034
C & D Batteries 2047
Microwave Radio Corporation 2062
Cetec Broadcast Group 2075
Accurate Sound Corporation 2080
HallikainenAndFriends 2108
Arrakis Systems, Inc 2148
Altec 2150
CSI 2213
MEI 2278
Nortronics 2295
Hallicrafters 2297
Broadcast Audio 2353
GatesRadioCompany 2422
Ampex 2440
Tapecaster 2562
DeltaElectronics 2587
Collins Radio 2611
Orban 2654
ESE 2734
Burk Technology 2743
Broadcast Electronics 2745
Belar Electronics Laboratory 2825
Crown 2829
RCA 2929
Auditronics 2931
QEI 3482
LPB 3732
GeneralRadio 4028
Autogram 4412
Armstrong Transmitter Corporation 5784
TextFormattingRules 6384
Help/TextFormattingRules 15215

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