From 50516a6cec46084003c3a66fd7fa1cbc09651848 Mon Sep 17 00:00:00 2001 From: Peter Thoeny Date: Sun, 4 Mar 2001 08:50:24 +0000 Subject: none --- TWiki/TWikiCategoryTable.mdwn | 47 ++++++++++++++++++++++++++++++++----------- 1 file changed, 35 insertions(+), 12 deletions(-) diff --git a/TWiki/TWikiCategoryTable.mdwn b/TWiki/TWikiCategoryTable.mdwn index e8f3115d..7a048c65 100644 --- a/TWiki/TWikiCategoryTable.mdwn +++ b/TWiki/TWikiCategoryTable.mdwn @@ -1,4 +1,6 @@ -**_What is a Category Table?_** +## TWiki Category Table + +### What is a Category Table? 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. @@ -63,15 +65,26 @@ One sample application is a knowledge base for customer support. The web for cus **_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_** +### 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: +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 + + + + + + + + + + + + + +
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 File twikicatitems.tmpl_** +#### Format of Category Definition Template File twikicatitems.tmpl Valid lines: @@ -99,11 +112,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:_** `` 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: @@ -180,10 +193,20 @@ Above template files will result in the following table when **_editing_** a top -**_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. `` +### Default Values for a Category Table + +It is possible to force the values of a Category Table when creating a new topic. You can define a default template to set the Category Table and/or specify individual values. + +#### Default Topic Template + +Whenever you create a new topic, the **twiki/templates/Webname/notedited.tmpl** file is used as the new topic template. To create this template, save a topic with the default text and the Category Table setting you need, then copy the content of the topic to the **notedited.tmpl** template (including the Category Table). Look also at the **twiki/templates/Know/notedited.tmpl** included in the distribution. + +#### Set Individual Category Table Values + +It is possible to set individual values of a Category Table when creating a new topic. This is useful when you have a form to create a new topic of a certain classification. The default values of the Category Table can be specified as hidden fields as needed, i.e. `` Example (edit this page to see the source) : *
New Public FAQ? topic:
--- [[Main/PeterThoeny]] - 26 Feb 2001
+-- [[RandyKramer]] - 26 Feb 2001
-- [[Main/PeterThoeny]] - 04 Mar 2001
-- cgit v1.2.3