Date: Mon, 22 Dec 2008 14:15:24 +0000
Mime-Version: 1.0 (Produced by PhpWiki 1.3.14-20080124)
X-Rcs-Id: $Id$
Content-Type: application/x-phpwiki;
  pagename=Help%2FMediawikiTablePlugin;
  flags=PAGE_LOCKED;
  markup=2;
  charset=iso-8859-1
Content-Transfer-Encoding: binary

The *~MediawikiTable* [plugin|Help:WikiPlugin] takes off from the [RichTable|Help:RichTablePlugin] plugin. It allows a user to specify a <tt><table></tt> with (a subset of) the syntax used by Mediawiki.

* The table starts with a line <b>{~|</b> and ends with a line <b>|~}</b>.
* An optional table caption is made with a line starting with a pipe and a plus sign <b>|+</b> followed by the caption.
* An optional table summary is made with a line starting with a pipe and an equal sign <b>|=</b> followed by the summary.
* A table row starts with a pipe and a hyphen: <b>|-</b>.
* A table cell starts with a pipe on a new line, or a double bar <b>||</b> on the same line.
* A header table cell starts with an exclamation mark, or a double exclamation mark <b>!!</b> on the same line (works only with an explicit plugin call).

The summary syntax is an extension to the Mediawiki syntax. 
You can also simply put the summary as an attribute to the table.
The summary is necessary to be able to create accessible tables.

!!! HTML attributes

<?plugin RichTable
* class="bordered"
-
|
Attribute
|
Syntax
-
|
For the table
|
{| border="1"
-
|
For the caption
|
~|+ style="font-weight: bold;"
-
|
For a row
|
~|- style="height:100px"
-
|
For a cell
|
~| align="right" | Cell 2 (right aligned)
?>

The attributes might be put with or without double quotes.

!!! Example

{| border="1", style="width: 100%"
|+ style="font-weight: bold; font-size: 150%;" | This is the table caption
|= This is the table summary
|- style="white-space: nowrap"
| <b>Header 1</b>
| <b>Header 2</b>
| <b>Header 3</b>
|- style=height:100px
| Cell I
| <b>Cell II</b>,  in bold
|align=right, width="100%" |Cell III
|- bgcolor=#f0f0ff, align=center
|Cell 1||Cell 2||Cell 3
|}

The above table is rendered from:

<verbatim>
{| border="1", style="width: 100%"
|+ style="font-weight: bold; font-size: 150%;" | This is the table caption
|= This is the table summary
|- style="white-space: nowrap"
| <b>Header 1</b>
| <b>Header 2</b>
| <b>Header 3</b>
|- style=height:100px
| Cell I
| <b>Cell II</b>,  in bold
|align=right, width="100%" |Cell III
|- bgcolor=#f0f0ff, align=center
|Cell 1||Cell 2||Cell 3
|}
</verbatim>

In this example, there is no explicit call to the plugin. You have the same syntax as in Mediawiki.

You can also explictly call the plugin. This will allow you:
* to use the Mediawiki header syntax (!),
* to use multiple paragraphs in a cell,
* to use lists in a cell.

<?plugin MediawikiTable
{|
|- style="white-space: nowrap"
! Header 1
! Header 2
|- bgcolor=yellow
| First paragraph.

Second paragraph.
|
* One
* Two
* Three
|- bgcolor=#f0f0ff, align=center
|Cell 1||Cell 2
|}
?>

The above table is rendered from:

<verbatim>
<?plugin MediawikiTable
{|
|- style="white-space: nowrap"
! Header 1
! Header 2
|- bgcolor=yellow
| First paragraph.

Second paragraph.
|
* One
* Two
* Three
|- bgcolor=#f0f0ff, align=center
|Cell 1||Cell 2
|}
?>
</verbatim>

!!! Author

Marc-Etienne Vargenau, Alcatel-Lucent

----
[PhpWikiDocumentation] [CategoryWikiPlugin]