CVS update: /cowiki/

User: cmarble 
Date: 2005/07/27 14:59:49

Modified:
   cowiki/README.IDIOM

Log:
 This belated adjustment should cover many issues.
 
 Comment is awaited, and approbation expected to be limited.

File Changes:

Directory: /cowiki/
===================

File [changed]: README.IDIOM
Url: http://cowiki.tigris.org/source/browse/cowiki/README.IDIOM?r1=1.1&r2=1.2
Delta lines:  +58 -32
---------------------
--- README.IDIOM	4 Sep 2003 04:02:08 -0000	1.1
+++ README.IDIOM	27 Jul 2005 21:59:46 -0000	1.2
@@ -1,6 +1,6 @@
 Text formatting rules and document syntax - The coWiki idiom
 
-$Id: README.IDIOM,v 1.1 2003/09/04 04:02:08 dtg Exp $
+$Id: README.IDIOM,v 1.2 2005/07/27 21:59:46 cmarble Exp $
 
 ---------------------------------------------------------------------------
 
@@ -116,11 +116,11 @@
 
     * A list item in an unordered list
     * Another list item
-     * A =nested= item
+    ** A =nested= item
 
     # First item in an ordered list
-     # A nested item
-     # Another nested item
+    ## A nested item
+    ## Another nested item
 
     This will render:
 
@@ -137,8 +137,8 @@
   Example:
 
     * A list item in an unordered list
-     # Ordered list item
-     # Another one
+    ## Ordered list item
+    ## Another one
     * The last item
 
   Result:
@@ -165,18 +165,17 @@
 
   The source:
 
-    You are able to use *emphasis*, /italic/ or =monospace= almost as
+    You are able to use **emphasis**, //italic// or ==monospace== almost as
     easily as you use them in your daily emails and usenet postings.
-    If /*you* want/ to /you *=can=*/ =mix= *the =styles=*.
+    If //**you** want// to //you **==can==**// ==mix== **the ==styles==**.
 
   These delimiters produce:
 
-    * *emphasis* -> emphasis
-    * /italic/ -> italic
-    * =monospace= -> monospace
-
-  The underline style is not supported, as it indicates hyperlinks and we
-  do not want to confuse our coWiki users, do we?
+    * **emphasis** -> bold emphasis
+    * //italic// -> italics
+    * ==monospace== -> monospace
+    * --strikeout-- -> strikethrough
+    * __underlined__ -> underlined
 
 ---------------------------------------------------------------------------
 
@@ -246,15 +245,21 @@
   A basic table looks like:
 
     <table>
-    | *foo*    |  *bar*
-    |  one     |   two
-    | =a cell= | other cell
+    |-
+    | *foo*    
+    |  *bar*
+    |-
+    |  one     
+    |   two
+    |-    
+    | =a cell=
+    | other cell
     </table>
 
   Tables have to be surrounded by the <table> ... </table> tags. These tags
   have to be placed at the beginning of a line and cannot be nested. The
-  pipe (|) delimiter separates cells in a row. Each row has to start with
-  a pipe delimititer - a trailing delimiter in a row is optional.
+  pipe delimiter is used with a hyphen to delimit table rows. Pipes are used
+  within a row on consecutive lines to delimit table cells.
 
   The example above will render a very simple table:
 
@@ -263,26 +268,47 @@
     a cell 	other cell
 
   The <table> tag can contain (raw HTML) attibutes to change the visual
-  appearence:
+  appearence, and a pipe followed by an asterisk denotes the table caption:
 
     <table cellpadding="2" border="1" style="text-align:center">
-    | *foo*    |  *bar*
-    |  one     |   two
-    | =a cell= | other cell
+    |-
+    |* Demonstrative table
+    | *foo*    
+    |  *bar*
+    |-
+    |  one     
+    |   two
     </table>
 
-  Spanning over columns is possible with multiple successive pipes
-  (|| or ||| etc.)
+  Spanning over columns is possible with the standard HTML colspan attribute:
 
-    <table align="center" cellspacing="5" border="1" style="text-align:center">
-    || About this document
-    | *What*   | *When*
-    | Created  | %CREATED%
-    | Modified | %MODIFIED%
+    <table cellpadding="2" border="1" style="text-align:center">
+    |-
+    |colspan="2"|*foo*    
+    |-
+    |  one     
+    |   two
     </table>
 
-  Of course you can play with the style (CSS) attribute to create other
-  borders, backgrounds and so on.
+  Attributes, like rowspan, are assigned to cells without a space following 
+  the table cell's delimiting pipe. The cell's content follows a second pipe
+  character, immediately. That is, when a cell's attributes are specified
+  immediately following the cell's delimiting pipe character, no space is then
+  required to follow the second pipe, that indicates the cell's character data.
+
+  Attributes are assigned to rows by similarly leaving no space between the
+  row-delimiting hyphen, "|-rowspan=...", as for table cells.
+
+  Column headers may be described with exactly the same syntax as for cells, 
+  but with a bang, "!", used as the line-start delimiter:
+
+    <table cellpadding="2" border="1" style="text-align:center">
+    |-
+    !rowspan="2"|Column header
+    |-
+    |  one     
+    |   two
+    </table>
 
 ---------------------------------------------------------------------------