Changes between Version 18 and Version 19 of TablePlugin/docs


Ignore:
Timestamp:
Jul 23, 2015, 2:08:34 PM (9 years ago)
Author:
figaro
Comment:

Cosmetic changes

Legend:

Unmodified
Added
Removed
Modified

  • TablePlugin/docs

    v18 v19  
    33= TablePlugin Documentation =
    44
    5 TablePlugin uses a similar style to the FlatTableMacro that was originally developed. The inspiration for the TablePlugin originated from the FlatTableMacro. A number of issues where present with the FlatTableMacro, such as no wiki formatting support amongst other things.
     5TablePlugin provides improved legibility and syntax for building up complex tables within a wiki. The headings and rows are now defined in the same way. This improves legibility, even for very complex tables that can be defined using the TablePlugin.
    66
    7 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,
    8 this helps with the readability aspect, even for very complex tables that can be defined using the TablePlugin.
     7Key features:
     8 - Lists
     9 - Wiki Markup
     10 - HTML
     11 - Web links
     12 - Nesting (including nesting of the TablePlugin itself)
     13 - Full CSS support (fully customisable heading and row cells)
     14 - Flexible heading/column definition styles, multi-line or comma-separated
    915
    10 The TablePlugin supports the following items within the cells:
    11     - Lists
    12     - Wiki Markup
    13     - HTML
    14     - Web links
    15     - Nesting (including nesting of the TablePlugin itself)
    16     - Full CSS support (fully customisable heading and row cells)
    17     - Flexible heading/column definition styles, multi-line or comma-separated
    18     - etc...
     16This plugin was inspired by FlatTableMacro. A number of issues where present with that macro, including lack of support for wiki formatting.
    1917
    20 == Keywords ==
     18== Keywords
    2119
    22 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.
     20There are a number of keywords that are used within the TablePlugin macro that define the elements of the table. The keywords are preceded with the @ character to distinguish them.
    2321
    2422The keywords:
    25     - @table - used when you want to define a table style or apply a custom table style to a new table.
    26     - @css - used to define a new style
    27     - @column - used to introduce a column.
    28     - @row - used to introduce a row
    29     - @<cell_name> - named as part of the @column definition.
     23 - @table - used when you want to define a table style or apply a custom table style to a new table.
     24 - @css - used to define a new style
     25 - @column - used to introduce a column.
     26 - @row - used to introduce a row
     27 - @<cell_name> - named as part of the @column definition.
    3028
    3129The last keyword `@<cell_name>` is variable. It is based on the names you give the cells in your @column definition. This is covered in more detail below in the Table Definition section.
    3230
    33 == Table Definition ==
     31== Table Definition
    3432
    3533The following example will not focus on any types of styles. The TablePlugin provides a default style (which can be edited if required) that will always be used if no specific style is applied to the table. We will focus on the bare minimum markup required to setup a new table. Comments are included as part of the codeblock to further explain the markup and how to use it.
    … …  
    9290[[Image(table_example2.png)]]
    9391
    94 == Table Styles ==
     92== Table Styles
    9593
    96 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.
     94The table styles are stored as part of a Trac page. This Trac page should be set up by the plugin 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.
    9795
    9896There are two different types of styles:
    99     - Table Styles
    100     - CSS Styles
     97 - Table Styles
     98 - CSS Styles
    10199
    102 Both styles use the following naming conventions: `@TYPE NAME (@STYLE): DATA`
     100Both styles use the following naming conventions: `@TYPE NAME (@STYLE): DATA`.
    103101
    104102Table Styles define a full set of styles that can be applied to a table. They are written in CSS.
    … …  
    127125
    128126This @header style can then be applied to any of the following elements:
    129     - @row
    130     - @column
    131     - @<cell_name>
     127 - @row
     128 - @column
     129 - @<cell_name>
    132130
    133 In the above example, we could do the following to the first row (which corresponds to the header). The other data has been omitted for brevity.
     131In the above example, we could do the following to the first row, which corresponds to the header. The other data has been omitted for brevity.
    134132
    135133{{{
    … …  
    148146This will now enforce centering of the text along with making it bold for that entire row of data. Any other valid CSS can be used here as well. For example, `background: green;` could also be added to make the header cells background green.
    149147
    150 == Usage ==
     148== Usage
    151149
    152150The TablePlugin will parse all styles from the !TablePluginStyles wiki page so that they can be used to style any of the elements.
    153151
    154 It is also possible to create custom styles within the actual table definition as well. Although this can get quite messy and unreadable and it is recommended that the !TablePluginStyle wiki page be used to house all of the styles.
     152It is also possible to create custom styles within the actual table definition as well. Although this can get quite messy and unreadable and it is recommended that the !TablePluginStyle wiki page be used to accommodate all of the styles.