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. Hits.
Help/TextFormattingRules 11607
PhpWikiAdministration 732
Help/EditMetaDataPlugin 713
Help/RedirectToPlugin 744
TextFormattingRules 4633
OldTextFormattingRules 303
RedirectToPlugin 294
NewMarkupTestPage 289
OldMarkupTestPage 282
IncludePagePlugin 461
AmperexElectronicCorporation 949
DeltaElectronics 1584
EimacDivisionOfVarian 758
GatesRadioCompany 9113
GatesRadioCatalog99 361
GeneralElectric 1983
GeneralRadio 9216
HallikainenAndFriends 8900
MoseleyAssociatesInc 6878
Motorola 733
National 734
NemsClarke 684
RCA 9561
WesternElectric 1294
Technics 881
Westinghouse 758
MilitaryRadio 3423
Historic Papers 5229
Station Histories 2730
Ratheon 284
Raytheon 1094
EfJohnson 759
American Electronic Laboratories 1178
Victoreen Instrument Company 804
Anton Electronic Laboratories 938
Collins Radio 8408
HoweTech 762
Belar Electronics Laboratory 1988
Ampex 7056
Harris Corporation - Broadcast Division 6194
Dorrough Electronics 2788
Radio Engineering Laboratories 701
Standard Electronics 670
Amalgamated Wireless (Australiasia) Ltd. 1370
Byer Industries 686
Circuit Research Laboratories 1423
Bauer Electronics Corporation 790
Trimax 666
United Transformer Corporation 670
template 315
Philips 810
McMartin 1849
ITA 823
Continental Electronics 2539
Magnecord 663
TFT, Inc. 3957
Schafer Automation 1103
Gentner 4231
Texar 874
Langevin 924
Altec 1516
CBS Labs 2184
Pultec 685
Sony 2341
3M 2852
UREI 1699
Frese and Kaping 906
Revox 2214
Federated Purchaser 602
CCA 1860
LPB 2614
Hollyanne 625
Telfax 611
Help/OldTextFormattingRules 294
AmministrazioneDiPhpWiki 296
Help/NewMarkupTestPage 295
Help/NewMarkupTestPage 295
Help/NewMarkupTestPage 295
Help/OldMarkupTestPage 285
Help/OldMarkupTestPage 285
Help/OldMarkupTestPage 285
Larcan 1133
Tepco 782
Standard Telephones & Cables. Australia 619
Presto 716
Straight Wire Audio 632
Arrakis Systems, Inc 1489
Consolidated Electronic Industries 652
Aphex Systems Limited 976
QEI 2450
Multronics 638
ITC 2676
Machlett Laboratories 773
Cutting Edge Technologies 637
Bext 1020
Tektronix 2272
Electronics Research, Inc. 590
Advanced Research & Technology 1396
Marantz 747
Microcon 656
Broadcast Television Systems 634
Bosch 785
dbx 2031
Otari 870
Crown 1879
Broadcast Electronics 7511
ATI 1087
Scully 753
Marti Electronics, Inc. 1725
Harman Kardon 770
Potomac Instruments 1673
Broadcast Audio 1548
Andrew Corporation 1734
Audio Arts 854
Bird Electronic Corporation 14932
Dumont 1093
Autogram 2671
Radio Engineering 297
Heathkit 3038
Mullard 658
NBC 779
Amperite 933
McIntosh 1047
Inovonics 1070
Neotek 1333
Moulic Specialties Co. 624
Engineering Services 698
IRC 959
ESE 1722
Comtech Antenna Corporation 838
Panasonic 3483
Orban 1832
Studer 665
Coastcom 719
Clear-Com 660
Dolby Laboratories 1502
CSI 1491
Bell Telephone Laboratories 1078
Pacific Recorders and Engineers 1017
Hewlett Packard 2416
Sparta Electronics 2845
Tapecaster 1735
Scala 784
Marconi Wireless Telegraph Company 813
Energy-Onix 1280
Modulation Sciences 1352
Burk Technology 1657
Auditronics 2002
Jampro Antenna 1143
Dayton Industrial 3763
Thompson-CSF 1020
Rust Industrial Company, Inc. 1126
Accurate Sound Corporation 1491
IGM 935
SMC 941
Radix 1097
Fidelipac 2277
Hughey & Phillips 1166
Microwave Radio Corporation 1346
Broadcast Tools 2767
Symmetrix 1226
GatesAir 742
Hallicrafters 1509
Kenwood 1163
Kyocera 1265
Teac 2171
Wheatstone Corporation 1312
Gorman-Redlich 1003
Studer International AG 769
Data Systems Design 876
Dana Electronics 1385
American Data 1299
Teletronix Engineering Company 1071
Tentel 833
Taber Manufacturing and Engineering Company 951
Standart Tape Laboratory 826
Extel 954
Russco 829
Automated Broadcast Controls 981
Electrovoice 814
Jennings 845
Wegener Communications 792
Midwest Communications 777
Aston 1094
Farallon 842
Kenneth A. Bacon Associates 718
J. G. S. Engineering Inc. 826
Continental Satellite Systems 794
ComStream 1136
Conex Electro Systems 741
Denon 930
Multi-technical Services 773
Electronic Signal Products 937
Lorain Products Corporation 824
C & D Batteries 1340
Nova Systems, Inc. 742
Nortronics 1560
Norcom 1013
Lambda Electronics Corp. 1050
US Audio 790
Jensen Transformers 821
Garner Industries 751
Sescom 907
Soltec 879
Peak Audio 720
MCI 1097
MEI 1544
Minicom Division of 3M 1180
Metrotech 1316
Lang Electronics 760
Kinght-kit 1125
Cetec Broadcast Group 1446
Computer Concepts 945
Dataworld 925
National Association of Broadcasters 1118
Link, Fred M 803
Weston 1112
Yokogawa Electric Works 935
Measurements 1149
Electronics Digest 1207
Gregg Laboratories 846
Leeds & Northrup Company 863
Video Systems of America 716
Simpson Electric Company 853
Triplett 713
Boonton Radio Corporation 745
Ohmite Manufacturing Company 977
Contel ASC 510
Audi-Cord Corporation 558
Johnson Electronics 513
Telefile Computer Products, Inc. 731
Realistic 393
Thordarson 390
Sine Systems 491
Telos 473
Harris Allied 380
Broadcasters General Store 572
QRK 507
BME - Broadcast Management Engineering Magazine 1288
Radio Business Report 358
UMC Beaucart 332
Armstrong Transmitter Corporation 5347
Cablewave Systems 287
Aristocart 384
Elgin Electronics 360
Goldline 286
NAD Electronics 712

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