diff options
| -rw-r--r-- | TWiki/TWikiCategoryTable.mdwn | 30 |
1 files changed, 19 insertions, 11 deletions
diff --git a/TWiki/TWikiCategoryTable.mdwn b/TWiki/TWikiCategoryTable.mdwn index 34d9c1b6..96abcca1 100644 --- a/TWiki/TWikiCategoryTable.mdwn +++ b/TWiki/TWikiCategoryTable.mdwn @@ -1,12 +1,20 @@ +**_What is a Category Table?_** + +A Category Table is a table that can include drop-down menus, checkboxes, radio buttons, and text fields. It makes it easy to provide keywords to categorize a topic. + +For example, if a TWiki web is devoted to technical support, wiki topics might be incident reports. The Category Table can prompt the writer to select the operating system, the software product, and the version for this report. For the operating system category, checkboxes can be displayed for OsSolaris, OsSunOS, OsHPUX and OsWin. + +**_Using a Category Table_** + It is possible to add a category table to a TWiki web. This permits storing and searching for more structured information. Editing a topic shows a HTML form with the usual text area and a table with selectors, checkboxes, radio buttons and text fields. The category table is shown at the end of a topic. The format of the category table can be defined per TWiki web. -If you want to use a Category Table in a TWiki web you need to have the following three files in the twiki/templates/\{Yourweb\} directory: +If you want to add a Category Table in a TWiki web you need to place the following three files into the `twiki/templates/{Yourweb}` directory: -* twikicatitems.tmpl : Defines the items in the table -* twikicatedit.tmpl : Defines the look of the table when editing a topic -* twikicatview.tmpl : Defines the look of the table when viewing a topic +* `twikicatitems.tmpl` : Defines the items in the table +* `twikicatedit.tmpl` : Defines the look of the table when editing a topic +* `twikicatview.tmpl` : Defines the look of the table when viewing a topic -**\_Format of category definition template twikicatitems.tmpl\_** +**_Format of category definition template twikicatitems.tmpl_** Valid lines: @@ -25,7 +33,7 @@ Explanation: {itemsPerLine} input items per line before wrap around, 0 if no wrap around {charSize} number of characters for text fields -**\_Remark:\_** Line ` radio|UseCategory|0|Yes|No ` has a special meaning. If present, it is possible to choose in "edit" if the category table is included in the topic or not +**_Remark:_** Line `radio|UseCategory|0|Yes|No` has a special meaning. If present, it is possible to choose in "edit" if the category table is included in the topic or not Example file: @@ -34,11 +42,11 @@ Example file: checkbox|OperatingSystem|true|5|OsSolaris|OsSunOS|OsHPUX|OsWin text|OsVersion|16 -**\_Format of twikicatedit.tmpl and twikicatview.tmpl\_** +**_Format of twikicatedit.tmpl and twikicatview.tmpl_** -Use the example below and customize if needed. twikicatedit.tmpl and twikicatview.tmpl can be identical, but they do not have to be. +Use the example below and customize if needed. `twikicatedit.tmpl` and `twikicatview.tmpl` can be identical, but they do not have to be. -**\_Attention:\_** ` <!--TWikiCat--> ` is needed at the beginning and end as markers. Do not delete them! +**_Attention:_** `<!--TWikiCat-->` is needed at the beginning and end as markers. Do not delete them! Example: @@ -49,7 +57,7 @@ Example: </tr>%REPEAT% </table><!--TWikiCat--> -Above template files will result in the following category table when **\_viewing\_** a topic: +Above template files will result in the following category table when **_viewing_** a topic: #### <a name="TWikiCategory_a_"> </a> [TWikiCategory]() @@ -71,7 +79,7 @@ Above template files will result in the following category table when **\_viewin </tr> </table> -Above template files will result in the following table when **\_editing\_** a topic: +Above template files will result in the following table when **_editing_** a topic: <form><nop><h4><a name="TWikiCategory_a_"> </a> <a href="">TWikiCategory</a></h4> <table border="2" cellpadding="1" cellspacing="1"> |