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

250 pages link to HomePage:
|<<   << - 1 / 5 - Next >>   >>|
|<<   << - 1 / 5 - Next >>   >>|
Page Name. HitsClick to reverse sort order
Help/TextFormattingRules 30267
GeneralRadio 28773
Broadcast Electronics 19013
RCA 18773
HallikainenAndFriends 18725
Collins Radio 16797
GatesRadioCompany 16566
Ampex 15683
TextFormattingRules 12985
Bird Electronic Corporation 11764
Autogram 9396
Harris Corporation - Broadcast Division 9072
Dorrough Electronics 7644
MilitaryRadio 7539
Panasonic 7476
QEI 6955
Armstrong Transmitter Corporation 6699
Gentner 6578
Sparta Electronics 6506
Dayton Industrial 6479
LPB 6391
TFT, Inc. 6166
Historic Papers 6126
DeltaElectronics 5982
Crown 5613
Station Histories 5558
ITC 5452
Auditronics 5347
Burk Technology 5327
MoseleyAssociatesInc 5306
3M 5300
ESE 5155
Orban 4906
Belar Electronics Laboratory 4816
Tapecaster 4790
Continental Electronics 4662
Sony 4597
Broadcast Audio 4586
Hewlett Packard 4367
Revox 4342
MEI 4331
Nortronics 4146
Hallicrafters 4139
WesternElectric 4090
Tektronix 4059
Fidelipac 3923
Teac 3912
CSI 3872
Modulation Sciences 3851
Arrakis Systems, Inc 3745
Symmetrix 3693
Cetec Broadcast Group 3687
Microwave Radio Corporation 3670
C & D Batteries 3667
Neotek 3657
Potomac Instruments 3540
Energy-Onix 3491
Altec 3474
Kyocera 3469
Metrotech 3466
Dana Electronics 3376
CBS Labs 3330
Hughey & Phillips 3273
Accurate Sound Corporation 3261
Inovonics 3253
CCA 3084
ComStream 3065
GeneralElectric 3039
Larcan 3031
McMartin 3012
dbx 3003
Advanced Research & Technology 2973
American Data 2935
Kenwood 2916
Radix 2897
Measurements 2883
Weston 2864
Kinght-kit 2862
American Electronic Laboratories 2854
National Association of Broadcasters 2851
Rust Industrial Company, Inc. 2845
Minicom Division of 3M 2825
Amalgamated Wireless (Australiasia) Ltd. 2821
Andrew Corporation 2784
Marti Electronics, Inc. 2769
UREI 2749
Bell Telephone Laboratories 2677
Thompson-CSF 2668
Schafer Automation 2644
Pacific Recorders and Engineers 2622
Lambda Electronics Corp. 2622
Norcom 2603
MCI 2591
Raytheon 2586
BME - Broadcast Management Engineering Magazine 2576
Dumont 2569
ATI 2535
McIntosh 2515
SMC 2463
Teletronix Engineering Company 2434
Dolby Laboratories 2433
Langevin 2422
PhpWikiAdministration 2375
Frese and Kaping 2335
Aston 2332
Bext 2320
Gorman-Redlich 2313
Extel 2311
Automated Broadcast Controls 2294
Texar 2292
Bauer Electronics Corporation 2281
Otari 2251
Computer Concepts 2238
Wheatstone Corporation 2233
Electronic Signal Products 2220
Technics 2195
Soltec 2173
Russco 2164
Data Systems Design 2152
Gregg Laboratories 2139
Broadcasters General Store 2139
Harman Kardon 2125
IGM 2121
Denon 2117
IRC 2102
Sescom 2101
J. G. S. Engineering Inc. 2099
Ohmite Manufacturing Company 2094
NAD Electronics 2088
Scully 2080
Dataworld 2074
Aphex Systems Limited 2066
Multi-technical Services 2065
NemsClarke 2058
Lang Electronics 2052
Farallon 2048
AmperexElectronicCorporation 2045
Help/RedirectToPlugin 2042
Motorola 2040
Taber Manufacturing and Engineering Company 2033
Jensen Transformers 2032
Simpson Electric Company 2025
Leeds & Northrup Company 2019
Comtech Antenna Corporation 2011
Philips 2007
Circuit Research Laboratories 1998
Tentel 1996
Yokogawa Electric Works 1989
Standart Tape Laboratory 1986
Continental Satellite Systems 1980
Jennings 1970
Marantz 1957
Midwest Communications 1956
Boonton Radio Corporation 1956
Triplett 1953
Electrovoice 1952
Amperite 1949
Magnecord 1948
Lorain Products Corporation 1946
Sine Systems 1937
Link, Fred M 1935
Wegener Communications 1926
Studer International AG 1921
Garner Industries 1913
EimacDivisionOfVarian 1912
Video Systems of America 1907
Broadcast Television Systems 1898
Help/EditMetaDataPlugin 1888
Anton Electronic Laboratories 1887
US Audio 1873
Kenneth A. Bacon Associates 1855
Victoreen Instrument Company 1853
Aristocart 1842
Conex Electro Systems 1828
Audio Arts 1825
National 1819
Peak Audio 1816
GatesAir 1797
Nova Systems, Inc. 1778
Audi-Cord Corporation 1766
Machlett Laboratories 1764
Telefile Computer Products, Inc. 1761
Bosch 1745
NBC 1727
Mullard 1726
Westinghouse 1712
ITA 1711
Valcom 1710
Byer Industries 1703
Scala 1701
Radio Engineering Laboratories 1698
Jampro Antenna 1697
QRK 1694
Coastcom 1693
Tepco 1683
HoweTech 1670
Standard Telephones & Cables. Australia 1662
Clear-Com 1662
Marconi Wireless Telegraph Company 1660
United Transformer Corporation 1654
Electronics Digest 1654
Presto 1653
Contel ASC 1645
Telos 1645
EfJohnson 1633
Consolidated Electronic Industries 1624
Johnson Electronics 1619
Harris Allied 1612
Thordarson 1607
Elgin Electronics 1599
Realistic 1598
Pultec 1576
UMC Beaucart 1574
Radio Business Report 1571
Engineering Services 1566
Straight Wire Audio 1557
Studer 1555
Trimax 1535
Multronics 1533
Cutting Edge Technologies 1522
Cablewave Systems 1513
Standard Electronics 1501
Hollyanne 1499
Microcon 1499
Goldline 1480
Federated Purchaser 1463
Telfax 1460
Moulic Specialties Co. 1421
Electronics Research, Inc. 1353
IncludePagePlugin 1310
GatesRadioCatalog99 1228
Broadcast Tools 1130
Will-Burt Company 1044
SStran 1000
Radio Engineering 979
NewMarkupTestPage 959
AmministrazioneDiPhpWiki 956
OldTextFormattingRules 940
template 916
OldMarkupTestPage 894
Help/NewMarkupTestPage 885
Help/NewMarkupTestPage 885
Help/NewMarkupTestPage 885
Help/OldTextFormattingRules 884
Help/OldMarkupTestPage 855
Help/OldMarkupTestPage 855
Help/OldMarkupTestPage 855
RedirectToPlugin 836
Ratheon 830
Heathkit 64

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