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 17342
PhpWikiAdministration 1551
Help/EditMetaDataPlugin 1267
Help/RedirectToPlugin 1277
TextFormattingRules 8058
OldTextFormattingRules 594
RedirectToPlugin 543
NewMarkupTestPage 624
OldMarkupTestPage 608
IncludePagePlugin 877
AmperexElectronicCorporation 1515
DeltaElectronics 3561
EimacDivisionOfVarian 1265
GatesRadioCompany 6682
GatesRadioCatalog99 740
GeneralElectric 903
GeneralRadio 11126
HallikainenAndFriends 5630
MoseleyAssociatesInc 1890
Motorola 1318
National 1186
NemsClarke 1416
RCA 7887
WesternElectric 2514
Technics 1448
Westinghouse 1185
MilitaryRadio 2981
Historic Papers 4634
Station Histories 2100
Ratheon 543
Raytheon 1811
EfJohnson 1173
American Electronic Laboratories 1983
Victoreen Instrument Company 1327
Anton Electronic Laboratories 1460
Collins Radio 6656
HoweTech 1158
Belar Electronics Laboratory 3345
Ampex 6041
Harris Corporation - Broadcast Division 3789
Dorrough Electronics 3035
Radio Engineering Laboratories 1157
Standard Electronics 1067
Amalgamated Wireless (Australiasia) Ltd. 2067
Byer Industries 1146
Circuit Research Laboratories 695
Bauer Electronics Corporation 1324
Trimax 1083
United Transformer Corporation 1132
template 597
Philips 1378
McMartin 1166
ITA 1251
Continental Electronics 1378
Magnecord 1094
TFT, Inc. 2215
Schafer Automation 1803
Gentner 3158
Texar 1546
Langevin 1594
Altec 2474
CBS Labs 1059
Pultec 1096
Sony 1794
3M 1897
UREI 1093
Frese and Kaping 1555
Revox 1741
Federated Purchaser 1039
CCA 1202
LPB 4398
Hollyanne 1041
Telfax 1015
Help/OldTextFormattingRules 590
AmministrazioneDiPhpWiki 633
Help/NewMarkupTestPage 574
Help/NewMarkupTestPage 574
Help/NewMarkupTestPage 574
Help/OldMarkupTestPage 570
Help/OldMarkupTestPage 570
Help/OldMarkupTestPage 570
Larcan 2012
Tepco 1209
Standard Telephones & Cables. Australia 1118
Presto 1151
Straight Wire Audio 1075
Arrakis Systems, Inc 2572
Consolidated Electronic Industries 1117
Aphex Systems Limited 1502
QEI 4335
Multronics 1076
ITC 2051
Machlett Laboratories 1256
Cutting Edge Technologies 1097
Bext 1643
Tektronix 1650
Electronics Research, Inc. 956
Advanced Research & Technology 2186
Marantz 1344
Microcon 1068
Broadcast Television Systems 1072
Bosch 1238
dbx 907
Otari 1533
Crown 3537
Broadcast Electronics 7181
ATI 1828
Scully 1308
Marti Electronics, Inc. 947
Harman Kardon 1421
Potomac Instruments 1380
Broadcast Audio 2921
Andrew Corporation 1097
Audio Arts 1355
Bird Electronic Corporation 17817
Dumont 1809
Autogram 5726
Radio Engineering 645
Heathkit 2452
Mullard 1085
NBC 1253
Amperite 1448
McIntosh 1725
Inovonics 2137
Neotek 2366
Moulic Specialties Co. 1021
Engineering Services 1142
IRC 1508
ESE 3362
Comtech Antenna Corporation 1406
Panasonic 2754
Orban 3155
Studer 1121
Coastcom 1210
Clear-Com 1100
Dolby Laboratories 864
CSI 2626
Bell Telephone Laboratories 1864
Pacific Recorders and Engineers 1666
Hewlett Packard 1693
Sparta Electronics 2458
Tapecaster 3151
Scala 1228
Marconi Wireless Telegraph Company 1212
Energy-Onix 2274
Modulation Sciences 2463
Burk Technology 3369
Auditronics 3543
Jampro Antenna 629
Dayton Industrial 2646
Thompson-CSF 1842
Rust Industrial Company, Inc. 1875
Accurate Sound Corporation 2356
IGM 1484
SMC 1673
Radix 1867
Fidelipac 1567
Hughey & Phillips 2188
Microwave Radio Corporation 2462
Broadcast Tools 2503
Symmetrix 2440
GatesAir 1279
Hallicrafters 2822
Kenwood 1906
Kyocera 2296
Teac 1506
Wheatstone Corporation 918
Gorman-Redlich 1664
Studer International AG 1373
Data Systems Design 1475
Dana Electronics 2343
American Data 2122
Teletronix Engineering Company 1721
Tentel 1388
Taber Manufacturing and Engineering Company 1467
Standart Tape Laboratory 1404
Extel 1578
Russco 1388
Automated Broadcast Controls 1588
Electrovoice 1395
Jennings 1379
Wegener Communications 1327
Midwest Communications 1329
Aston 1700
Farallon 1420
Kenneth A. Bacon Associates 1279
J. G. S. Engineering Inc. 1371
Continental Satellite Systems 1374
ComStream 2065
Conex Electro Systems 1268
Denon 1494
Multi-technical Services 1321
Electronic Signal Products 1597
Lorain Products Corporation 1382
C & D Batteries 2473
Nova Systems, Inc. 1223
Nortronics 2775
Norcom 1697
Lambda Electronics Corp. 1805
US Audio 1327
Jensen Transformers 1418
Garner Industries 1307
Sescom 1494
Soltec 1528
Peak Audio 1257
MCI 1785
MEI 2793
Minicom Division of 3M 1969
Metrotech 2291
Lang Electronics 1286
Kinght-kit 1884
Cetec Broadcast Group 2496
Computer Concepts 1595
Dataworld 1483
National Association of Broadcasters 1944
Link, Fred M 1346
Weston 1904
Yokogawa Electric Works 1432
Measurements 1927
Electronics Digest 695
Gregg Laboratories 1461
Leeds & Northrup Company 1420
Video Systems of America 1303
Simpson Electric Company 1403
Triplett 1258
Boonton Radio Corporation 1287
Ohmite Manufacturing Company 1531
Contel ASC 1051
Audi-Cord Corporation 1127
Johnson Electronics 1018
Telefile Computer Products, Inc. 1213
Realistic 935
Thordarson 962
Sine Systems 1202
Telos 1025
Harris Allied 980
Broadcasters General Store 1302
QRK 1080
BME - Broadcast Management Engineering Magazine 1908
Radio Business Report 943
UMC Beaucart 900
Armstrong Transmitter Corporation 6030
Cablewave Systems 910
Aristocart 1119
Elgin Electronics 991
Goldline 853
NAD Electronics 1320
Will-Burt Company 451
Valcom 594

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