Diff: Help/TextFormattingRules

Note: You are viewing an old revision of this page. View the current version.

Differences between version 2 and previous revision of Help/TextFormattingRules.

Other diffs: Previous Major Revision, Previous Author

Newer page: version 2 Last edited on 22 May 2014 3:01 by harold Revert
Older page: version 1 Last edited on 17 January 2022 18:35 by harold Revert
@@ -11,9 +11,9 @@
 **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>b</b> <big>big</big> <i>i</i> 
-<small>small</small> < tt>tt</tt> <em>em</em> <strong>strong</strong> 
+<small>small</small> ## tt## <em>em</em> <strong>strong</strong> 
 <s>s</s> <strike>strike</strike> 
 <abbr>abbr</abbr> <acronym>acronym</acronym> <cite>cite</cite> 
 <code>code</code> <dfn>dfn</dfn> <kbd>kbd</kbd> <samp>samp</samp> 
 <var>var</var> <sup>sup</sup> <sub>sub</sub> \\ 
@@ -70,9 +70,9 @@
 There's no syntax for font tags. 
  
 === Color Text === 
  
-It is possible to write text in color. 
+Is it possible to write text in color. 
  
 {{{ 
 %color=green% green text %% and back to normal 
 }}} 
@@ -88,9 +88,9 @@
 * the following predefined color names: 
 {| class="bordered" 
 |- 
 | %color=aqua% aqua %% 
-| style ="background-color: #565c5e" | %color=beige% beige %% 
+| bgcolor ="#565c5e" | %color=beige% beige %% 
 | %color=black% black %% 
 | %color=blue% blue %% 
 | %color=brown% brown %% 
 | %color=chocolate% chocolate %% 
@@ -99,9 +99,9 @@
 | %color=gold% gold %% 
 | %color=gray% gray %% 
 |- 
 | %color=green% green %% 
-| style ="background-color: #565c5e" | %color=ivory% ivory %% 
+| bgcolor ="#565c5e" | %color=ivory% ivory %% 
 | %color=indigo% indigo %% 
 | %color=lime% lime %% 
 | %color=magenta% magenta %% 
 | %color=maroon% maroon %% 
@@ -113,13 +113,13 @@
 | %color=purple% purple %% 
 | %color=red% red %% 
 | %color=salmon% salmon %% 
 | %color=silver% silver %% 
-| style ="background-color: #565c5e" | %color=snow% snow %% 
+| bgcolor ="#565c5e" | %color=snow% snow %% 
 | %color=teal% teal %% 
 | %color=turquoise% turquoise %% 
 | %color=violet% violet %% 
-| style ="background-color: #565c5e" | %color=white% white %% 
+| bgcolor ="#565c5e" | %color=white% white %% 
 | %color=yellow% 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. 
@@ -251,17 +251,16 @@
 * 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
+* You can name the links by providing a name , a pipe (##|##) and then the hyperlink or pagename
  [[http://phpwiki.sourceforge.net/|PhpWiki home page]], [[HomePage|the front page]] 
-* You can suppress linking to URIs by preceding the word with a '##~~##',  
- e.g. ~NotLinkedAsWikiName, ~http~://not.linked.to/ 
+* 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: 
- [[http://phpwiki.demo .free .fr /themes/default/images/png.png]] 
+ [[http://phpwiki.svn .sourceforge .net/viewvc/phpwiki/trunk /themes/default/images/png.png]] 
 * You can create footnotes by using ~[1], ~[2], ~[3], ... like this here #[|ftnt 
 _ref_1]<sup>~[[1|#ftnt_1]~]</sup>. See footnote for counterpart. (If the ~[ is 
 in the first column, it is a footnote <em>definition</em> rather than a footnote 
  <em>reference</em> #[|ftnt_ref_1]<sup>~[[1|#ftnt_1]~]</sup>.) 
@@ -270,9 +269,9 @@
 *** ##~#~[~[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}}}
+* 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 == 
  

version 2

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. Hits.
Help/TextFormattingRules 17245
PhpWikiAdministration 1538
Help/EditMetaDataPlugin 1261
Help/RedirectToPlugin 1273
TextFormattingRules 7965
OldTextFormattingRules 589
RedirectToPlugin 542
NewMarkupTestPage 619
OldMarkupTestPage 602
IncludePagePlugin 869
AmperexElectronicCorporation 1507
DeltaElectronics 3514
EimacDivisionOfVarian 1261
GatesRadioCompany 6365
GatesRadioCatalog99 733
GeneralElectric 872
GeneralRadio 10545
HallikainenAndFriends 5330
MoseleyAssociatesInc 1802
Motorola 1308
National 1183
NemsClarke 1407
RCA 7607
WesternElectric 2466
Technics 1440
Westinghouse 1181
MilitaryRadio 2861
Historic Papers 4424
Station Histories 2021
Ratheon 542
Raytheon 1805
EfJohnson 1169
American Electronic Laboratories 1966
Victoreen Instrument Company 1320
Anton Electronic Laboratories 1452
Collins Radio 6402
HoweTech 1155
Belar Electronics Laboratory 3311
Ampex 5740
Harris Corporation - Broadcast Division 3674
Dorrough Electronics 2957
Radio Engineering Laboratories 1155
Standard Electronics 1065
Amalgamated Wireless (Australiasia) Ltd. 2054
Byer Industries 1143
Circuit Research Laboratories 683
Bauer Electronics Corporation 1312
Trimax 1077
United Transformer Corporation 1126
template 590
Philips 1373
McMartin 1132
ITA 1243
Continental Electronics 1324
Magnecord 1091
TFT, Inc. 2151
Schafer Automation 1793
Gentner 3050
Texar 1539
Langevin 1582
Altec 2457
CBS Labs 1010
Pultec 1092
Sony 1739
3M 1832
UREI 1057
Frese and Kaping 1541
Revox 1693
Federated Purchaser 1037
CCA 1152
LPB 4360
Hollyanne 1038
Telfax 1014
Help/OldTextFormattingRules 587
AmministrazioneDiPhpWiki 630
Help/NewMarkupTestPage 571
Help/NewMarkupTestPage 571
Help/NewMarkupTestPage 571
Help/OldMarkupTestPage 567
Help/OldMarkupTestPage 567
Help/OldMarkupTestPage 567
Larcan 2005
Tepco 1205
Standard Telephones & Cables. Australia 1111
Presto 1147
Straight Wire Audio 1068
Arrakis Systems, Inc 2548
Consolidated Electronic Industries 1112
Aphex Systems Limited 1498
QEI 4277
Multronics 1073
ITC 1989
Machlett Laboratories 1253
Cutting Edge Technologies 1096
Bext 1637
Tektronix 1619
Electronics Research, Inc. 954
Advanced Research & Technology 2179
Marantz 1335
Microcon 1063
Broadcast Television Systems 1070
Bosch 1234
dbx 863
Otari 1519
Crown 3494
Broadcast Electronics 6796
ATI 1815
Scully 1299
Marti Electronics, Inc. 917
Harman Kardon 1415
Potomac Instruments 1338
Broadcast Audio 2872
Andrew Corporation 1068
Audio Arts 1349
Bird Electronic Corporation 16321
Dumont 1797
Autogram 5654
Radio Engineering 641
Heathkit 2358
Mullard 1080
NBC 1248
Amperite 1442
McIntosh 1718
Inovonics 2105
Neotek 2345
Moulic Specialties Co. 1018
Engineering Services 1137
IRC 1505
ESE 3332
Comtech Antenna Corporation 1394
Panasonic 2650
Orban 3134
Studer 1114
Coastcom 1204
Clear-Com 1091
Dolby Laboratories 844
CSI 2596
Bell Telephone Laboratories 1847
Pacific Recorders and Engineers 1652
Hewlett Packard 1639
Sparta Electronics 2339
Tapecaster 3108
Scala 1223
Marconi Wireless Telegraph Company 1210
Energy-Onix 2262
Modulation Sciences 2432
Burk Technology 3333
Auditronics 3496
Jampro Antenna 594
Dayton Industrial 2529
Thompson-CSF 1824
Rust Industrial Company, Inc. 1863
Accurate Sound Corporation 2345
IGM 1473
SMC 1658
Radix 1863
Fidelipac 1528
Hughey & Phillips 2162
Microwave Radio Corporation 2434
Broadcast Tools 2342
Symmetrix 2413
GatesAir 1274
Hallicrafters 2791
Kenwood 1898
Kyocera 2264
Teac 1460
Wheatstone Corporation 869
Gorman-Redlich 1650
Studer International AG 1365
Data Systems Design 1464
Dana Electronics 2325
American Data 2104
Teletronix Engineering Company 1707
Tentel 1376
Taber Manufacturing and Engineering Company 1456
Standart Tape Laboratory 1394
Extel 1569
Russco 1380
Automated Broadcast Controls 1579
Electrovoice 1390
Jennings 1375
Wegener Communications 1314
Midwest Communications 1320
Aston 1693
Farallon 1411
Kenneth A. Bacon Associates 1268
J. G. S. Engineering Inc. 1363
Continental Satellite Systems 1367
ComStream 2043
Conex Electro Systems 1259
Denon 1487
Multi-technical Services 1314
Electronic Signal Products 1587
Lorain Products Corporation 1377
C & D Batteries 2444
Nova Systems, Inc. 1214
Nortronics 2760
Norcom 1678
Lambda Electronics Corp. 1792
US Audio 1315
Jensen Transformers 1398
Garner Industries 1289
Sescom 1481
Soltec 1517
Peak Audio 1250
MCI 1777
MEI 2768
Minicom Division of 3M 1957
Metrotech 2270
Lang Electronics 1279
Kinght-kit 1872
Cetec Broadcast Group 2476
Computer Concepts 1584
Dataworld 1477
National Association of Broadcasters 1925
Link, Fred M 1339
Weston 1886
Yokogawa Electric Works 1421
Measurements 1911
Electronics Digest 682
Gregg Laboratories 1452
Leeds & Northrup Company 1413
Video Systems of America 1293
Simpson Electric Company 1395
Triplett 1251
Boonton Radio Corporation 1281
Ohmite Manufacturing Company 1522
Contel ASC 1044
Audi-Cord Corporation 1119
Johnson Electronics 1011
Telefile Computer Products, Inc. 1206
Realistic 927
Thordarson 955
Sine Systems 1196
Telos 1018
Harris Allied 967
Broadcasters General Store 1283
QRK 1072
BME - Broadcast Management Engineering Magazine 1888
Radio Business Report 933
UMC Beaucart 890
Armstrong Transmitter Corporation 6018
Cablewave Systems 899
Aristocart 1107
Elgin Electronics 977
Goldline 842
NAD Electronics 1309
Will-Burt Company 443
Valcom 569

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