Diff: Help/TextFormattingRules

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

Differences between version 2 and predecessor to the previous major change of Help/TextFormattingRules.

Other diffs: Previous 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

250 pages link to HomePage:
|<<   << - 1 / 5 - Next >>   >>|
|<<   << - 1 / 5 - Next >>   >>|
Page Name. Hits.
Help/TextFormattingRules 30278
PhpWikiAdministration 2375
Help/EditMetaDataPlugin 1888
Help/RedirectToPlugin 2043
TextFormattingRules 12988
OldTextFormattingRules 940
RedirectToPlugin 836
NewMarkupTestPage 959
OldMarkupTestPage 894
IncludePagePlugin 1310
AmperexElectronicCorporation 2045
DeltaElectronics 5982
EimacDivisionOfVarian 1912
GatesRadioCompany 16567
GatesRadioCatalog99 1229
GeneralElectric 3041
GeneralRadio 28774
HallikainenAndFriends 18734
MoseleyAssociatesInc 5306
Motorola 2040
National 1819
NemsClarke 2058
RCA 18776
WesternElectric 4091
Technics 2195
Westinghouse 1713
MilitaryRadio 7540
Historic Papers 6128
Station Histories 5558
Ratheon 830
Raytheon 2586
EfJohnson 1633
American Electronic Laboratories 2854
Victoreen Instrument Company 1854
Anton Electronic Laboratories 1888
Collins Radio 16799
HoweTech 1670
Belar Electronics Laboratory 4816
Ampex 15684
Harris Corporation - Broadcast Division 9073
Dorrough Electronics 7645
Radio Engineering Laboratories 1698
Standard Electronics 1502
Amalgamated Wireless (Australiasia) Ltd. 2823
Byer Industries 1703
Circuit Research Laboratories 1999
Bauer Electronics Corporation 2281
Trimax 1535
United Transformer Corporation 1654
template 916
Philips 2008
McMartin 3013
ITA 1711
Continental Electronics 4662
Magnecord 1948
TFT, Inc. 6166
Schafer Automation 2645
Gentner 6580
Texar 2292
Langevin 2422
Altec 3475
CBS Labs 3330
Pultec 1576
Sony 4598
3M 5303
UREI 2749
Frese and Kaping 2335
Revox 4342
Federated Purchaser 1463
CCA 3084
LPB 6391
Hollyanne 1499
Telfax 1460
Help/OldTextFormattingRules 884
AmministrazioneDiPhpWiki 956
Help/NewMarkupTestPage 885
Help/NewMarkupTestPage 885
Help/NewMarkupTestPage 885
Help/OldMarkupTestPage 855
Help/OldMarkupTestPage 855
Help/OldMarkupTestPage 855
Larcan 3032
Tepco 1683
Standard Telephones & Cables. Australia 1662
Presto 1653
Straight Wire Audio 1557
Arrakis Systems, Inc 3745
Consolidated Electronic Industries 1624
Aphex Systems Limited 2066
QEI 6956
Multronics 1533
ITC 5452
Machlett Laboratories 1764
Cutting Edge Technologies 1523
Bext 2320
Tektronix 4061
Electronics Research, Inc. 1353
Advanced Research & Technology 2973
Marantz 1957
Microcon 1499
Broadcast Television Systems 1899
Bosch 1745
dbx 3004
Otari 2251
Crown 5613
Broadcast Electronics 19016
ATI 2535
Scully 2081
Marti Electronics, Inc. 2769
Harman Kardon 2126
Potomac Instruments 3540
Broadcast Audio 4586
Andrew Corporation 2786
Audio Arts 1825
Bird Electronic Corporation 11768
Dumont 2569
Autogram 9397
Radio Engineering 979
Heathkit 64
Mullard 1727
NBC 1727
Amperite 1949
McIntosh 2516
Inovonics 3253
Neotek 3657
Moulic Specialties Co. 1421
Engineering Services 1566
IRC 2102
ESE 5156
Comtech Antenna Corporation 2011
Panasonic 7477
Orban 4906
Studer 1556
Coastcom 1693
Clear-Com 1662
Dolby Laboratories 2433
CSI 3872
Bell Telephone Laboratories 2677
Pacific Recorders and Engineers 2622
Hewlett Packard 4367
Sparta Electronics 6506
Tapecaster 4791
Scala 1701
Marconi Wireless Telegraph Company 1660
Energy-Onix 3491
Modulation Sciences 3851
Burk Technology 5327
Auditronics 5347
Jampro Antenna 1697
Dayton Industrial 6481
Thompson-CSF 2669
Rust Industrial Company, Inc. 2845
Accurate Sound Corporation 3261
IGM 2121
SMC 2463
Radix 2898
Fidelipac 3924
Hughey & Phillips 3273
Microwave Radio Corporation 3670
Broadcast Tools 1131
Symmetrix 3693
GatesAir 1797
Hallicrafters 4139
Kenwood 2916
Kyocera 3469
Teac 3913
Wheatstone Corporation 2233
Gorman-Redlich 2313
Studer International AG 1923
Data Systems Design 2152
Dana Electronics 3377
American Data 2937
Teletronix Engineering Company 2434
Tentel 1996
Taber Manufacturing and Engineering Company 2033
Standart Tape Laboratory 1986
Extel 2311
Russco 2164
Automated Broadcast Controls 2294
Electrovoice 1952
Jennings 1971
Wegener Communications 1927
Midwest Communications 1956
Aston 2332
Farallon 2048
Kenneth A. Bacon Associates 1855
J. G. S. Engineering Inc. 2100
Continental Satellite Systems 1980
ComStream 3065
Conex Electro Systems 1828
Denon 2117
Multi-technical Services 2065
Electronic Signal Products 2221
Lorain Products Corporation 1946
C & D Batteries 3667
Nova Systems, Inc. 1778
Nortronics 4146
Norcom 2603
Lambda Electronics Corp. 2622
US Audio 1873
Jensen Transformers 2032
Garner Industries 1914
Sescom 2102
Soltec 2173
Peak Audio 1816
MCI 2592
MEI 4331
Minicom Division of 3M 2825
Metrotech 3467
Lang Electronics 2052
Kinght-kit 2862
Cetec Broadcast Group 3687
Computer Concepts 2238
Dataworld 2075
National Association of Broadcasters 2851
Link, Fred M 1935
Weston 2864
Yokogawa Electric Works 1989
Measurements 2883
Electronics Digest 1654
Gregg Laboratories 2139
Leeds & Northrup Company 2019
Video Systems of America 1907
Simpson Electric Company 2025
Triplett 1953
Boonton Radio Corporation 1956
Ohmite Manufacturing Company 2094
Contel ASC 1645
Audi-Cord Corporation 1767
Johnson Electronics 1619
Telefile Computer Products, Inc. 1761
Realistic 1599
Thordarson 1607
Sine Systems 1938
Telos 1645
Harris Allied 1612
Broadcasters General Store 2139
QRK 1694
BME - Broadcast Management Engineering Magazine 2576
Radio Business Report 1571
UMC Beaucart 1575
Armstrong Transmitter Corporation 6699
Cablewave Systems 1513
Aristocart 1843
Elgin Electronics 1599
Goldline 1481
NAD Electronics 2088
Will-Burt Company 1045
Valcom 1710
SStran 1000

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