diff options
Diffstat (limited to 'TWiki/TWikiCategoryTable.mdwn')
| -rw-r--r-- | TWiki/TWikiCategoryTable.mdwn | 75 |
1 files changed, 66 insertions, 9 deletions
diff --git a/TWiki/TWikiCategoryTable.mdwn b/TWiki/TWikiCategoryTable.mdwn index 96abcca1..e8f3115d 100644 --- a/TWiki/TWikiCategoryTable.mdwn +++ b/TWiki/TWikiCategoryTable.mdwn @@ -1,20 +1,77 @@ **_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. +It is possible to add a Category Table to a %WIKITOOLNAME% web. It allows you to categorize and classify a topic, e.g. give some structure to the content of a web. -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. +The Category Table is located at the end of a topic. Example: -**_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. +<table border="2" cellpadding="1" cellspacing="1"> + <tr> + <td align="right" valign="top"><a href="">TopicClassification</a>: <br /> + </td> + <td><a href="">PublicFAQ</a></td> + </tr> + <tr> + <td align="right" valign="top"><a href="">OperatingSystem</a>: <br /> + </td> + <td><a href="">OsSolaris</a></td> + </tr> +</table> -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: +When you edit the topic you see below the usual text area a table that includes widgets (controls) like drop-down menus, checkboxes, radio buttons, and text boxes. It makes it easy to provide keywords to categorize a topic. Example: + +<form> + <table border="2" cellpadding="1" cellspacing="1"> + <tr> + <td align="right" valign="top"><a href="">UseCategory</a> : <br /> + </td> + <td> + <table cellpadding="0" cellspacing="0"> + <tr> + <td><input checked name="UseCategory" type="radio" value="Yes" />Yes </td> + <td><input name="UseCategory" type="radio" value="Nodeletethiscategorytable" />No, delete this category table </td> + </tr> + </table> + </td> + </tr> + <tr> + <td align="right" valign="top"><a href="">TopicClassification</a> : <br /> + </td> + <td><select name="TopicClassification" size="1"><option value="Selectone">Select one... </option> + <option value="NoDisclosure">NoDisclosure </option> + <option value="PublicSupported">PublicSupported </option> + <option selected value="PublicFAQ">PublicFAQ </option></select></td> + </tr> + <tr> + <td align="right" valign="top"><a href="">OperatingSystem</a> : <br /><input onclick="" type="button" value=" Set " /> <input onclick="" type="button" value="Clear" /> </td> + <td> + <table cellpadding="0" cellspacing="0"> + <tr> + <td><input checked name="OperatingSystemOsSolaris" type="checkbox" />OsSolaris </td> + <td><input name="OperatingSystemOsSunOS" type="checkbox" />OsSunOS </td> + <td><input name="OperatingSystemOsHPUX" type="checkbox" />OsHPUX </td> + <td><input name="OperatingSystemOsWin" type="checkbox" />OsWin </td> + </tr> + </table> + </td> + </tr> + </table> +</form> + +The format of the Category Table can be defined per %WIKITOOLNAME% web. + +One sample application is a knowledge base for customer support. The web for customer support contains internal documents, FAQ entries and knowledge base entries. Topics are **_classified_** accordingly. In addition, FAQ entries and knowledge base entries can be **_categorized_** i.e. by the software product anf the operating system. For the operating system category, a checkbox contains OsSolaris, OsSunOS, OsHPUX and OsWin. + +**_Hint:_** The topic classification can be used to do some automatic processing in the background. For example, a script could automatically publish the FAQ entries to your corporate web site, including FAQ index page and file attachments. + +**_How to Define a Category Table_** + +The Category Table is defined by some template files. To add a Category Table to your %WIKITOOLNAME% 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 -**_Format of category definition template twikicatitems.tmpl_** +**_Format of Category Definition Template File twikicatitems.tmpl_** Valid lines: @@ -123,10 +180,10 @@ Above template files will result in the following table when **_editing_** a top </tr> </table></nop></form> -**_Note:_** It is possible to force the values of a category table when creating a new topic. This is useful to create new topics using a form for the topic name. The default values of the category table can be specified as hidden fields if needed, i.e. `<input type="hidden" name="someCategory" value="someValue">` +**_Note:_** It is possible to force the values of a Category Table when creating a new topic. This is useful to create new topics using a form for the topic name. The default values of the Category Table can be specified as hidden fields if needed, i.e. `<input type="hidden" name="someCategory" value="someValue">` Example (edit this page to see the source) : * <form action="%SCRIPTURLPATH%/edit%SCRIPTSUFFIX%/Know/"> New <span style="background:"><font color="">Public FAQ</font></span><a href="http://LOCATIONKnow/PublicFAQ">?</a> topic: <input name="topic" size="32" type="text" /> <input name="TopicClassification" type="hidden" value="PublicFAQ" /> <input name="OperatingSystem" type="hidden" value="OsSolaris,OsSunOS" /> <input name="OsVersion" type="hidden" value="Just testing..." /> <input name="onlywikiname" type="hidden" value="on" /> <input type="submit" value="Create Topic" /></form> --- [[Main/PeterThoeny]] - 21 Apr 2000 <br /> +-- [[Main/PeterThoeny]] - 26 Feb 2001 <br /> |