wiki:TablePlugin/docs

Version 6 (modified by jonny, 2 years ago) (diff)

--

TablePlugin Documentation

TablePlugin uses a similar style to the FlatTablePlugin that was originally developed. The inspiration for the TablePlugin originated from the FlatTablePlugin. A number of issues where present with the FlatTablePlugin, such as no wiki formatting support amongst other things.

TablePlugin provides improved readability and syntax for building up complex tables within a wiki. The headings and rows are now defined in the same way, this helps with the readability aspect, even for very complex tables that can be defined using the TablePlugin.

The TablePlugin supports the following items within the cells:

  • Lists
  • Wiki Markup
  • HTML
  • Web links
  • Nesting (including nesting of the TablePlugin itself)
  • Full CSS support (fully customisable heading and row cells)
  • Flexible heading/column definition styles, multi-line or comma-separated
  • etc...

Keywords

There are a number of keywords that are used within the TablePlugin macro that define various elements of the table. The keywords are preceded with the @ character to distinguish them.

The keywords:

  • @table
  • @css
  • @row
  • @column
  • @<cell_name>

The last keyword @<cell_name> is variable. It is based on the names you give the cells in your table definition. This is covered in more detail below in the Table Definition section.

Table Styles

The table styles are stored as part of a trac page. This trac page should be setup by the TablePlugin the first time it runs. It creates a page wiki/TablePluginStyles that contains a default table style along with a CSS header style for the tables heading.

There are two different types of styles:

  • Table Styles
  • CSS Styles

Both styles use the following naming conventions: @TYPE NAME (@STYLE): DATA

Table Styles define a full set of styles that can be applied to a table. They are written in CSS.

Table Styles are written as follows:

@table table_style_name:

This allows the individual to create different table styles depending on what

CSS Styles define individual styles that can be applied to individual elements of a table. They are also written in CSS.

CSS Styles are written as follows:

Table Definition

Usage

Attachments (1)

Download all attachments as: .zip