Changes between Version 19 and Version 20 of TablePlugin/docs

Timestamp:

Aug 30, 2019, 6:09:56 PM (5 years ago)

Author:

anonymous

Comment:

Added documentation for @endrow

TablePlugin/docs

@@ -25 +25 @@
  - @column - used to introduce a column.
  - @row - used to introduce a row
+ - @endrow - used to prematurely end a row
  - @<cell_name> - named as part of the @column definition.
 
@@ -90 +91 @@
 [[Image(table_example2.png)]]
 
+== How it works
+
+First the plugin counts the @column keywords. Then it iterates, using that number, to find data for all cells in each row. If a cell is missing, it will fail with an error. The solution then is to either add data for the missing cell (which might be hard to find, depending on the complexity of the table), or use the @endrow keyword to prematurely finish the row and consider all missing cells empty. Using this keyword the whole table syntax can still be very short, if the table contains a lot of columns and a lot of empty cells.
+
+{{{
+
+{{{
+#!styledtable
+#!-- Demonstration of the keyword @endrow
+
+@table (@default)
+
+#!-- Define the three columns to use: task, details, status
+@column task
+@column details
+@column status
+
+#!-- First row is header
+@task: Task
+@details: Details
+@status: Status
+
+#!-- Second row is missing two fields and would generate an 
+#!-- error if we didn't use @endrow to fill in with empty cells
+@task: My first task
+@endrow
+}}}
+
+}}}
+
+
 == Table Styles