<%@ page language="java" buffer="100kb" errorPage="/common/error.jsp"%>

<%@ taglib uri="struts-html" prefix="html"%>
<%@ taglib uri="struts-bean" prefix="bean"%>
<%@ taglib uri="vkc-taglib"  prefix="vkc" %>

<html:html locale="true">
<head>
  <vkc:init/>
  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  <meta http-equiv="expires" content="0">
  <meta name="description" content="VKC Help: Functions for Categories">

  <vkc:cssinclude />

  <title><vkc:message key="vkc" /></title>
  <script type="text/javascript" src="<vkc:rewrite page='/common/utils.js'/>"></script>

  <script type="text/javascript">

  window.name = "MAINVIEW";

  function init() {
  }
  
  function confirmation(){
    return confirm('<vkc:message javascript="true" filter="false" key="vkc.string.confirmation"/>');
  }

  </script>
</head>

<!-- ENGLISH VERSION ************************************************** -->

<!-- Version 31-Jul-2007 VKC 4.0 + -->

<body onload="init();">
<a name="top"></a>

<h2>
<a name="catfunctions"></a>
VKC Help: Functions for Categories</h2>


<p>
This help page describes all VKC functions for categories
even though it depends on the access permissions of the current
user which functions are actually provided for a category.
Click on a function to jump to the function description.
</p>


<map name="categoryfunctions">
<area title="categorylink as URL" shape=rect coords="76,88,95,107" href="#caturl">
<area title="categorylink as URL" shape=rect coords="3,68,70,107" href="#caturl">
<area title="refresh page" shape=rect coords="103,88,118,107" href="#reloadcat">
<area title="refresh page" shape=rect coords="16,52,117,62" href="#reloadcat">
<area title="go to home category" shape=rect coords="121,88,138,107" href="#gohome">
<area title="go to home category" shape=rect coords="2,39,137,48" href="#gohome">
<area title="define home category" shape=rect coords="141,88,162,107" href="#sethome">
<area title="define home category" shape=rect coords="10,13,163,36" href="#sethome">
<area title="show properties" shape=rect coords="169,88,189,107" href="#showdocs">
<area title="show properties" shape=rect coords="171,6,388,15" href="#showdocs">
<area title="hide properties" shape=rect coords="192,88,212,107" href="#hidedocs">
<area title="hide properties" shape=rect coords="193,22,357,45" href="#hidedocs">
<area title="full view" shape=rect coords="212,88,230,107" href="#fullview">
<area title="full view" shape=rect coords="71,123,229,150" href="#fullview">
<area title="short view" shape=rect coords="234,88,251,107" href="#shortview">
<area title="short view" shape=rect coords="91,155,249,181" href="#shortview">
<area title="count categories/documents" shape=rect coords="256,88,275,107" href="#countcatdoc">
<area title="count categories/documents" shape=rect coords="125,187,272,214" href="#countcatdoc">
<area title="archive category" shape=rect coords="277,88,297,107" href="#archivecat">
<area title="archive category" shape=rect coords="144,219,296,245" href="#archivecat">
<area title="cluster documents" shape=rect coords="301,88,318,107" href="#clustering">
<area title="cluster documents" shape=rect coords="308,234,516,246" href="#clustering">
<area title="insert document" shape=rect coords="327,88,345,107" href="#insert">
<area title="insert document" shape=rect coords="332,219,495,231" href="#insert">
<area title="insert from clipboard" shape=rect coords="350,88,370,107" href="#paste">
<area title="insert from clipboard" shape=rect coords="355,186,486,200" href="#paste">
<area title="create new category" shape=rect coords="372,88,392,107" href="#createcat">
<area title="create new category" shape=rect coords="373,154,510,168" href="#createcat">
<area title="edit category" shape=rect coords="397,88,419,107" href="#editcat">
<area title="edit category" shape=rect coords="396,123,555,149" href="#editcat">
<area title="delete category" shape=rect coords="423,88,430,107" href="#deletecat">
<area title="delete category" shape=rect coords="419,11,521,24" href="#deletecat">
<area title="edit permissions" shape=rect coords="449,88,468,107" href="#permissioncat">
<area title="edit permissions" shape=rect coords="447,28,523,42" href="#permissioncat">
<area title="add notification" shape=rect coords="470,88,489,107" href="#notify">
<area title="add notification" shape=rect coords="470,43,565,55" href="#notify">
<area title="add to VKC favorites" shape=rect coords="491,88,510,107" href="#addfavcat">
<area title="add to VKC favorites" shape=rect coords="491,58,579,85" href="#addfavcat">
</map>

<p>
<img src="pic3-altf-vkc-catfunctions.gif" usemap="#categoryfunctions"
border="1" alt="category functions, clickable">
</p>


<h4>
<a name="caturl"></a>
Display category link as URL&nbsp;&nbsp;
<img src="pic3-button-document-url.gif" align="middle" alt="">
</h4>

<p>
This function opens a small window that displays <b>web paths</b> of
the current category in URL format.
You may copy/paste those paths into a document or email message.
</p>
<p>
Two different paths will be generated, one for access by VKC <b>user login</b> and
one for access by <b>guest login</b>.
A guest login does not require a VKC user account but allows access only
to categories which are readable for "anyone".
For categories with restricted access a user login is required.
If the user has no access permissions for the referenced category,
an error message will be shown.
</p>
<p>
<img src="pic3-vkc-showcatlink.gif" border="1" alt="category URL">
</p>

<div align="right">
<a href="#top">
<img src="top-blue.gif" alt="to top of page" border="0"></a>
</div>


<h4>
<a name="reloadcat"></a>
Refresh page&nbsp;&nbsp;
<img src="pic3-button-refresh.gif" align="middle" alt="">
</h4>

<p>
After clicking this icon the current category page will be reloaded.
</p>

<div align="right">
<a href="#top">
<img src="top-blue.gif" alt="to top of page" border="0"></a>
</div>


<h4>
<a name="gohome"></a>
Go to home category&nbsp;&nbsp;
<img src="pic3-button-home.gif" align="middle" alt="">
</h4>

<p>
By clicking this icon you navigate to your personal VKC home category,
which may be set by function
<a href="#sethome">Define category as home category</a>.
If no individual home category has been set,
the page of the top level category ("VKC root") will be loaded.
</p>

<div align="right">
<a href="#top">
<img src="top-blue.gif" alt="to top of page" border="0"></a>
</div>


<h4>
<a name="sethome"></a>
Define category as home category&nbsp;&nbsp;
<img src="pic3-button-registerhomecat.gif" align="middle" alt="">
</h4>

<p>
By clicking this icon the current category will be defined as your
<b>personal home category</b> in your profile.
After your next login, this home category will be loaded automatically.
During your login session, you may use function
<a href="#gohome">go to home category</a>
to navigate from any other category to your home category anytime.
</p>

<div align="right">
<a href="#top">
<img src="top-blue.gif" alt="to top of page" border="0"></a>
</div>



<h4>
<a name="showdocs"></a>
Show properties for all documents&nbsp;&nbsp;
<img src="pic3-button-show-all-documents.gif" align="middle" alt="">
</h4>

<p>
This function may be used to show <b>document attributes and function
icons</b> for all documents in the current category.
Only those attributes will be shown that have been preselected as
the <b>user view</b> in the user's profile.
Details are described on
<a href="helpmod-profile.jsp">help page "Profile"</a>,
function "Customize document view".
<br>
For displaying all available properties, function
<a href="#fullview">Show all properties</a> can be used.
</p>
<p>
Function icons will be shown for all functions that are permitted
for the current user according to the
category <a href="#permissioncat">permissions</a>.
More details concerning document functions can be found on
<a href="helpmod-docentry-alternate.jsp">help page "Document entry"</a>.
</p>

<div align="right">
<a href="#top">
<img src="top-blue.gif" alt="zum Seitenanfang" border="0"></a>
</div>


<h4>
<a name="hidedocs"></a>
Hide properties for all documents&nbsp;&nbsp;
<img src="pic3-button-hide-all-documents.gif" align="middle" alt="">
</h4>

<p>
This function may be used to hide the document attributes of all
documents from the category view to reload a <b>short view</b>.
The short view displays only the titles of the documents.
By clicking on the title, the <b>document will be opened</b> in a separate
window.
</p>

<div align="right">
<a href="#top">
<img src="top-blue.gif" alt="zum Seitenanfang" border="0"></a>
</div>


<h4>
<a name="fullview"></a>
Show all properties for all documents&nbsp;&nbsp;
<img src="pic3-button-documents-fullview.gif" align="middle" alt="">
</h4>

<p>
This function turns on the <b>full view</b>
of all document entries in this category.
The full view includes all document properties.
A detailed description of document entries can be found on
<a href="helpmod-docentry-alternate.jsp">help page "Document Entry"</a>.
</p>

<div align="right">
<a href="#top">
<img src="top-blue.gif" alt="to top of page" border="0"></a>
</div>


<h4>
<a name="shortview"></a>
Show individual properties for all documents&nbsp;&nbsp;
<img src="pic3-button-category-individualview.gif" align="middle" alt="">
</h4>

<p>
By clicking this icon you turn on a <b>customized view</b> of all document
entries in this category. Only selected properties are shown.
You may define your individual selection of attributes in your <b>profile</b>.
Details are explained on
<a href="helpmod-profile.jsp">help page "Profile"</a>,
function "Customize Documentview".<br>
A detailed description of document entries can be found on
<a href="helpmod-docentry-alternate.jsp">help page "Document Entry"</a>.
</p>

<div align="right">
<a href="#top">
<img src="top-blue.gif" alt="to top of page" border="0"></a>
</div>


<h4>
<a name="countcatdoc"></a>
Compute count of subcategories and documents&nbsp;&nbsp;
<img src="pic3-button-count-cats-docs.gif" align="middle" alt="">
</h4>

<p>
This function counts all subcategories and documents
of the current category and its next level subcategories
and computes the space consumed by them.
The results are shown behind the category name.
This information will be removed when you <a href="#reloadcat">refresh</a>
the page or change to another category.
</p>
<p>
<img src="pic3-altf-vkc-countcatdoc.gif" border="1" alt="count subcategories/documents">
</p>

<div align="right">
<a href="#top">
<img src="top-blue.gif" alt="to top of page" border="0"></a>
</div>


<h4>
<a name="archivecat"></a>
Archive category&nbsp;&nbsp;
<img src="pic3-button-zip.gif" align="middle" alt="">
</h4>

<p>
This function can be used to create a zipped archive of the current category
for administrative reasons.
You can extract a directory tree corresponding to the archived VKC structure
from the archive into the file system.
Thus, the function is kind of an "export" tool.
The archive cannot be used to restore the structure in a VKC.
</p>
<p>
By clicking the icon a form is loaded for entering archive parameters.
</p>
<img src="pic3-vkc-makezip.gif" border="1" alt="archive dialog">
<p>
You may determine whether <b>subcategories</b>, all <b>document versions</b>
and <b>virtual documents</b> shall be included in the archive.
Furthermore, you can select the <b>language</b> of the dialog included in the
archive.
The form also shows the <b>directory path</b> where the archive will be stored.
By clicking on <b>Create archive</b> the archive will be built.
If you click on <b>Cancel</b> instead, no archive will be created and the
usual category page will be reloaded.
Completion of archiving will be confirmed by a notification window.
You may use the hyperlink to the archive file to download the archive
to your local file system.
</p>
<img src="pic3-vkc-makezip-done.gif" border="1" alt="archive confirmation">
<p>
You may return to the category by clicking on <b>Back to document folder</b>.
</p>

<div align="right">
<a href="#top">
<img src="top-blue.gif" alt="to top of page" border="0"></a>
</div>


<h4>
<a name="clustering"></a>
Cluster all documents&nbsp;&nbsp;
<img src="pic3-button-clustern.gif" align="middle"></h4>

<p>
This function can be used to create a hierarchical sub-structure for an 
existing VKC category that contains a large number of documents.
All documents will be analyzed and divided into smaller clusters of documents.
VKC suggests a structure that may be examined and modified by the user
who has to decide whether to save the new structure or to keep the
original flat category.
</p>
<p>
The clustering function includes all documents directly located in the current
category that can be analyzed by VKC automatically
(that is: all documents with a valid ASCII representation after publication).
Existing sub-categories of the current category remain untouched.
</p>
<p>
In the following simple example, only ten documents shall be "clustered":
</p>
<img src="pic3-altf-vkc-clustering.gif" border="1" alt="before clustering">
<p>
<b>Select clustering options</b>
</p>
<p>
The following form will be loaded after clicking on icon
<img src="pic3-button-clustern.gif" align="middle" alt="cluster documents">:
</p>
<img src="pic3-vkc-clustering-options.gif" border="1" 
alt="form: clustering options">
<p>
The default settings are predefined to yield good results for most cases.
<br>
You may experiment with different settings as follows:
</p>
<p>
Algorithm <b>Complete link</b> produces smaller, compact clusters.<br>
When choosing option <b>fast</b>, less than the full document length
will be regarded during the clustering process.
You may get quicker but less accurate results.<br>
If only <b>named clusters</b> shall be generated, the clustering process
will be terminated earlier producing a planer structure.
</p>
<p>
Click on <b>Cluster</b> to start the clustering algorithm.<br>
Click on <b>Cancel</b> to return to the category view without further actions.
</p>
<p>
The suggested structure will be presented in a window with multiple smaller
sub-windows:
</p>
<img src="pic3-vkc-clustering-window1.gif" border="1"
alt="Clustering: Fensteraufteilung">
<p>
<b>Examination of the suggested structure</b>
</p>
<p>
The different windows can be used to examine and to edit the suggested
structure in detail.
</p>
<p>
On the left side you will find:
</p>
<ul>
<li>
<p>
the <b>structure browser</b>:<br>
You may browse and revise the suggested sub-structure and check
which documents have been assigned to the new sub-categories.
</p>
<p>
As known from the VKC Explorer, you may expand or collapse
categories by clicking on the symbol icons
<img src="pic3-button-plusdots.gif" alt="plus"  align="middle">
and
<img src="pic3-button-minusdots.gif" alt="minus"  align="middle">.<br>
During expansion the sub-categories
(folder icon
<img src="pic3-button-folder.gif" alt="folder"  align="middle">)
or documents
(document icon
<img src="pic3-button-document.gif" alt="document"  align="middle">)
will be listed.<br>
You may display the corresponding document or category information
in the windows on the left by clicking on the label
beside the folder or document icon.
</p>
<img src="pic3-vkc-clustering-window2.gif" border="1"
alt="Clustering: structure browser, documents, categories">
<p>
<b>Accept or reject categories:</b><br>
Right beside a folder icon there are a check box and a number
representing the number of all documents that have been clustered
below the category.
If the check box is marked, the category shall be present in the final
structure to be saved.
<br>
If the check box is cleared, the category shall be rejected.
Documents that have been placed in a rejected category will remain
in their original category.
Sub-categories of a rejected category will be placed in the parent
category of the rejected category.
<br>
</p>
<img src="pic3-vkc-clustering-category-checkbox.gif" border="1"
alt="Clustering: accept or reject categories">
<p>
If present, folder "Misc" will contain all documents that could not
be included in the clustering process or could not be placed in
a common cluster with at least one other document.
By default, this folder is not marked and the respective documents
will remain in their original category.
</p>
<p>
<b>Revise category names:</b><br>
Furthermore, a name might be shwon for a category.
(If unnamed clusters have been excluded by clustering option,
all categories will have a generated name. Unnamed cluster will be
labeled with a numerical ID.)
<br>
You may overwrite the name of every generated category.
Just click on the folder's label in the structure browser.
In the category window name and description can be defined.
(See description in section "category window" below.)
</p>
<p>
</li>
</ul>

<p>
On the right side you will find:
</p>
<ul>
<li>
<p>
the <b>document window</b>:<br>
You may check the document properties of the document selected by
a single click in the structure browser.
</p>
<img src="pic3-vkc-clustering-docwindow.gif" border="1"
alt="Clustering: document properties">
<p>
You will find all the properties that are known from the
usual category view. Hyperlinks in the document window can be
used to display the document contents in a separate window.
</p>
</li>

<li>
<p>
the <b>category window</b>:<br>
You may check and edit the category properties of the category selected
by single click in the structure browser.
</p>
<p>
You may assign a <b>name</b> to the category or change the generated name.
<br>
You may add a <b>description</b> to the category.
<br>
If you turn on option <b>plane hierarchy</b>, all suggested sub-categories
will be removed and the assigned documents will be collected in the
current category. (This action will be deferred until the structure is
actually saved.)
</p>
<img src="pic3-vkc-clustering-categorywindow.gif" border="1"
alt="Clustering: revise categories">
<p>
All modifications in the category window have to be confirmed by
clicking on button <b>Apply</b> to become effective.
</p>
</li>
<li>
<p>
the <b>function window</b>:<br>
You may save or reject the examined and revised suggested structure.
</p>
<img src="pic3-vkc-clustering-final.gif" border="1"
alt="Clustering: save structure or cancel function">
<p>
Click on button <b>Save</b> to save the revised structure in VKC.
You will return to the category view when the operation has been completed.
The new structure will be shown:
</p>
<img src="pic3-altf-vkc-clustering-result.gif" border="1"
alt="Clustering: return to category view">
<p>
If you choose to click on button <b>Cancel</b> instead of "Save", 
the original category will remain unchanged.
You will return to the category view immediately.
</p>
</li>
</ul>

<p>
In case single documents shall be moved to different places
in the new structure you should use the "cut/paste" functions of
the category view.
See the <a href="help-alternate.jsp#functionlist">VKC help page</a> for details.
</p>

<div align="right">
<a href="#top">
<img src="top-blue.gif" alt="to top of page" border="0"></a>
</div>



<h4>
<a name="insert"></a>
Insert document with analysis and classification&nbsp;&nbsp;
<img src="pic3-button-newdocument.gif" align="middle" alt="insert document"></h4>

<p>
This function inserts a new document into
the current category. Write permission for the category is
required to perform this function.
</p>

<p>
Please notice:
If you intend to publish multiple documents or a directory tree quickly without
analysis or classification, you can use the WebDAV interface to access VKC
as a Web folder. Then it is possible to use copy and paste functions of the file system
to transfer files or file trees into VKC.
See <a href="helpmod-webfolder.jsp">help page "How to use VKC as a Web folder (WebDAV)"</a>
</p>

<p>
When you click on function icon
<img src="pic3-button-newdocument.gif" align="middle" alt="insert document">,
a form is loaded.
As a first step, you have to choose which
kind of object you want to publish: a <b>file</b>, a <b>WWW&nbsp;link</b>,
a <b>WWW&nbsp;copy</b>, or a <b>note</b>.
This is necessary because they need different parameters.
The default is "file".
</p>
<p>
<img src="pic3-webld-document.gif" border="1" alt="form: publish file">
</p>
<p>
You have to locate the file to be published by button <b>Browse</b>.
The <b>file type</b> will be deducted from the file name extension.
Therefore, it is recommended to use the usual file name extensions
associated with common applications (like ".doc", ".pdf", ".html"). 
In field <b>Title</b> you have to enter the document title.
As <b>author</b> the name of the publishing user will be supplied automatically.
You may overwrite it if necessary.
<b>Creation date</b>, <b>version description</b>, and <b>label</b> are optional for this
first document version.
</p>
<p>
Instead of a local file a source from the Internet (WWW) may be used
either as <b>WWW link</b> or as <b>WWW copy</b>.
"WWW copy" means that a copy of the referenced file is published.
For both options you have to enter the corresponding web path (URL)
in field <b>WWW Link</b> and a <b>title</b>.
As <b>author</b> the name of the publishing user will be supplied automatically.
You may overwrite it if necessary.
<b>Creation date</b>, <b>version description</b>, and <b>label</b> are optional.
</p>
<p>
<img src="pic3-webld-html.gif" border="1" alt="form: publish WWW link">
</p>
<p>
For files as well as for web links <b>title</b>, <b>keywords</b>, and <b>description</b>
may be entered manually or can be generated automatically for many file types.
Check the boxes in front of the field names on or off to enable or disable automatic
generation of the corresponding field.
You have to click on button <b>Analyse</b> to start automatic generation. 
Non empty fields will not be overwritten.
The generated results may be edited manually if required.
You may activate an HTML editor by clicking on the "plus" symbol
<img src="pic3-button-plus-big.gif" alt="plus">
right above the description field.
(See details on help page <a href="helpmod-htmledit.jsp">HTML Editor</a>.)
</p>
<img src="pic3-webld-analyse.gif" border="1" alt="results of analyse">
<p>
If you chose to publish a <b>note</b>, you may insert a VKC entry without a file.
</p>
<p>
<img src="pic3-webld-note.gif" border="1" alt="form: publish note">
</p>
<p>
A <b>title</b> must be given for a note.
The text of the note has to be entered in field <b>Description</b>.
You may activate an HTML editor by clicking on the "plus" symbol
<img src="pic3-button-plus-big.gif" alt="plus">
right above the description field.
(See details on help page <a href="helpmod-htmledit.jsp">HTML Editor</a>.)
As <b>author</b> the name of the publishing user will be supplied automatically.
You may overwrite it if necessary.
All other fields are optional. The "Analyse" function is not supported
for notes.
</p>
<p>
In the lower part of the form there are several fields relevant for
all kinds of documents:
</p>
<p>
<img src="pic3-webld-common.gif" border="1" alt="document attributes">
</p>
<p>
<b>Dynamic attributes:</b>
These are user-defined attributes of a document.
A dynamic attribute has a <b>name</b> and a <b>value</b>
as shown in the following example:
</p>
<img src="pic3-vkc-dynattributes.gif" border="1" alt="dynamic attributes">
<p>
By clicking on <b>Add a dynamic attribute</b> an input field
for a new attribute will be inserted.
</p>
<p>
You can <b>remove</b> a dynamic attribute by clicking on the wastebasket
<img src="pic3-button-deletecat.gif"  align="middle" alt="">
to the right of the attribute definition.
</p>
<p>
<b>Document publish:</b>
A publication date may be entered using a calendar
<img src="pic3-button-calendar.gif" align="middle" alt="">.
On that date the corresponding document entry will be visible
for all users with read permission. Before that date, only
the author and administrators will see the preliminary entry.
</p>
<p>
<b>Document expires:</b>
An expiration date may be entered using a calendar 
<img src="pic3-button-calendar.gif" align="middle" alt="">.
On that date the corresponding
document entry will be removed from the category and the author will
be notified. He may decide what to do with the expired document.
Expired documents are accessible by means of the author's profile.
(See <a href="helpmod-profile.jsp">help page "Profile"</a>,
function "Expired Documents" for details.) 
</p>
<p>
<b>Publish as:</b> If you are registered as a <b>proxy</b> for another user,
you may select the user to publish in behalf of in this list.
That user will be named as the <b>author</b> in the document attributes.
</p>
<p>
If you have not decided whether the current <b>category</b> is appropriate
for the new document, you may use function <b>Classify</b>.
The function compares the document with either all categories in
the VKC or with categories below the current category.
The results will be presented in a new form
where you may select one of the categories:
</p>
<p>
<img src="pic3-webld-classify-results.gif" border="1"
alt="classification results">
</p>
<p>
If you want to insert the document into the selected category,
you have to click on <b>Select category</b>.
Otherwise you click on <b>Cancel</b>.
In both cases you will return to the publication form to complete
the process.
</p>
<p>
When you are finished with completing the form, you have to
click on <b>Publish</b> to initiate publication.
If you have marked a result of the classification, the document will be
inserted in that category. Otherwise it will be inserted into
the current category.
</p>
<p>
The button <b>Cancel</b> can be used to return to the current
category without publishing a document.
</p>

<div align="right">
<a href="#top">
<img src="top-blue.gif" alt="to top of page" border="0"></a>
</div>


<h4>
<a name="paste"></a>
Paste from clipboard&nbsp;&nbsp;
<img src="pic3-button-paste.gif" align="middle"></h4>

<p>
If there are categories or documents in the clipboard,
you may insert those objects into the current category.
For details of the clipboard functions see
<a href="help-alternate.jsp#functionlist">help page "Document storage, Function selection"</a>.
</p>

<div align="right">
<a href="#top">
<img src="top-blue.gif" alt="to top of page" border="0"></a>
</div>



<h4>
<a name="createcat"></a>
Create new category&nbsp;&nbsp;
<img src="pic3-button-newcat.gif" align="middle"></h4>

<p>
This function creates a new subcategory. 
A form is loaded where you have to enter the
<b>category name</b> and optionally <b>keywords</b>
and a <b>description</b>.
You may activate an HTML editor by clicking on the "plus" symbol
<img src="pic3-button-plus-big.gif" alt="plus">
right above the description field.
(See details on help page <a href="helpmod-htmledit.jsp">HTML Editor</a>.)
</p>
<img src="pic3-vkc-newcat.gif" border="1" alt="new category">
<p>
<b>Query for virtual documents:</b>
Currently, only administrators may enter this query.
The defined query will initiate a search of the document storage whenever
the document list of the category is loaded to include a dynamic list of
accessible documents matching the query.
Document entries resulting from this search are called <b>virtual documents</b>.<br>
<a href="#queryvirtual">Detailed description of the query ...</a>
</p>
<p>
<b>Dynamic attributes:</b>
These are user-defined attributes of a category that are included
in the descriptional section of the category page.
During creation or
editing of a category, dynamic attributes
can be added, modified, or deleted.
A dynamic attribute has a <b>name</b> and a <b>value</b>
as shown in the following example:
</p>
<img src="pic3-vkc-dynattributes.gif" border="1" alt="dynamic attributes">
<p>
By clicking on <b>Add a dynamic attribute</b> an input field
for a new attribute will be inserted.
The attribute will be added to the database when the category
is created or saved.
</p>
<p>
You can <b>remove</b> a dynamic attribute by clicking on the wastebasket
to the right of the attribute definition.
</p>
<p>
<b>Access permissions:</b>
If option
<b>Copy access permissions from parent category</b>
is set, the new category will be created with the same access
permissions as defined for the parent category.
<br>
If option 
<b>Take access permissions from corresponding default acl</b> is turned on,
those default settings are applied.
<br>
By clicking on the icon
<img src="pic3-button-acl.gif" align="middle" alt="">
you may have a look at those permission settings in a separate window.
</p>
<p>
By clicking on <b>Create</b> the new category will be created
and the VKC page of the parent category will be reloaded, now
showing the new entry.
You may leave the form without creation of a new category
by clicking on <b>Cancel</b>.
</p>

<p>
Please notice:
You can use the WebDAV interface to access VKC as a Web folder.
Then it is possible to create a category just like any other folder in
the file system.
See <a href="helpmod-webfolder.jsp">help page "How to use VKC as a Web folder (WebDAV)"</a>
</p>

<div align="right">
<a href="#top">
<img src="top-blue.gif" alt="to top of page" border="0"></a>
</div>



<h4>
<a name="editcat"></a>
Edit category properties&nbsp;&nbsp;
<img src="pic3-button-editcat.gif" align="middle"></h4>

<p>
This function can be used to edit the name and descriptional information
of the current category. Optionally, you may also define or edit
a <b>query for virtual documents</b> (administrators only)
and <b>dynamic attributes</b>.
A form similar to the form for category creation will be loaded.
</p>
<img src="pic3-vkc-form-editcat.gif" border="1"
alt="form: edit category properties">
<p>
Refer to function <a href="#createcat">create new category</a>
for details about the different input fields.
</p>
<p>
To make changes permanent, you have to click on <b>Save</b>.<br>
You can leave the form without saving by clicking on <b>Back</b>.
</p>

<div align="right">
<a href="#top">
<img src="top-blue.gif" alt="to top of page" border="0"></a>
</div>



<h4>
<a name="deletecat"></a>
Delete category&nbsp;&nbsp;
<img src="pic3-button-deletecat.gif" align="middle"></h4>

<p>
This function can be used to delete the current category 
with all subcategories and all published documents.
Before this function is actually performed, you will be asked
for confirmation.
</p>

<p>
Please notice:
You can use the WebDAV interface to access VKC as a Web folder.
Then it is possible to delete a category just like any other folder in
the file system.
See <a href="helpmod-webfolder.jsp">help page "How to use VKC as a Web folder (WebDAV)"</a>
</p>

<p>
Categories deleted accidentally can be restored for a certain
time by the administrator. You have to remember at least the date of deletion
and the username.
</p>

<div align="right">
<a href="#top">
<img src="top-blue.gif" alt="to top of page" border="0"></a>
</div>



<h4>
<a name="permissioncat"></a>
Permissions: view&nbsp;&nbsp;
<img src="pic3-button-acl.gif" align="middle">&nbsp;&nbsp;
and edit&nbsp;&nbsp;
<img src="pic3-button-acl-edit.gif" align="middle">
</h4>

<p>
This function can be used to <a href="#acl-view">view</a> and
<a href="#acl-edit">edit</a> the <b>access control list</b> (ACL)
of the current category.
</p>
<p><a name="acl-view"></a><b>View permissions</b>&nbsp;&nbsp;
<img src="pic3-button-acl.gif" align="middle"></p>
<p>
The following form will be shown indicating the access permissions
of the current category:
</p>
<img src="pic3-vkc-acl-view.gif" width="247" height="394" border="1" 
alt="view permissions">
<p>
When you click on a user or group name the permissions of that user or
group will be displayed in the list of permissions below.
By clicking on <b>Exit</b> you may return to the document view of the category.
</p>
<p><a name="acl-edit"></a><b>Edit permissions</b>&nbsp;&nbsp;
<img src="pic3-button-acl-edit.gif" align="middle"></p>
<p>
If the user has permission to change the access control list (ACL) of
the current category, the following form will be loaded:
</p>
<p>
<img src="pic3-vkc-acl.gif" width="547" height="454" border="1"
alt="edit permissions">
</p>
<p>
Permissions can be granted for individual <b>users</b> or for
VKC <b>groups</b>. 
An entry named <b>anyother</b> applies to all users that are
neither mentioned as user nor a member of a mentioned group.
When you select an entry, the corresponding <b>permissions</b> will be
shown in the lower part of the form.
The user or group name is a hyperlink; you may click it to open a window
with the related user or group profile for your information.
Permissions may be changed bei turning on or off the individual options.
Changes of an entry become effective by clicking <b>Save</b>.
</p>
<p>
The buttons to the right of the user and group list can be used
to add or remove entries to or from the list.
If you remove the entry <b>anyother</b>, only the users and groups
listed explicitly may access the category.
</p>
<p>
Below the list of permissions you may determine if and how your
changes may effect the subcategories of the current category:
</p>
<ul>
<li>
By default the settings are applied <b>to the current category only</b>.
</li>
<li>
Option <b>Inherit and merge these settings to all subcategories</b> merges
the settings of the current category with the settings of every subcategory
performing a logical OR operation if the subcategory allows modification of
the ACL.
</li>
<li>
Option <b>Inherit these settings to all subcategories</b> copies
the ACL of the current category to all subcategories that allow
modification of the ACL for the user.
</li>
</ul>
<p>
Button <b>Set Defaults...</b> can be used to define default permissions
for all subcategories that will be created below the current category.
</p>
<p>
If you want to <b>protect a whole subtree</b>, please remember that you
have to adjust the permissions of <b>every category</b> in it. 
If you protect the root of the subtree only, users may access documents 
in subcategories by means of the search function if the respective
subcategory permits accesss.
</p>
<p>
By clicking on <b>Exit</b> you may return to the document view of the category.
</p>

<div align="right">
<a href="#top">
<img src="top-blue.gif" alt="to top of page" border="0"></a>
</div>


<h4>
<a name="notify"></a>
Add notification for category&nbsp;&nbsp;
<img src="pic3-button-registercat.gif" align="middle"></h4>

<p>
This function registers the current VKC category in the Messenger.
If messaging is enabled, you will be notified by email when new documents
have been published in this category.
</p>
<p>
The <b>subcategories</b> ("subdirs") of the category are registered
automatically. This option can be switched off explicitly in the
Messenger.
</p>
<p>
If you want to remove a category from your notification list, 
you have to go to the Messenger,
check off the respective category entry and click on <b>Save</b>.
</p>
<p>
<img src="pic3-vkc-messenger-del.gif" border="1" alt="Messenger">
</p>
<p>
You will find a detailed description of the Messenger on
<a href="help-alternate.jsp#messenger">help page "Messenger"</a>.
</p>

<p>
<b>Registration for further VKC groups or users
(only as administrator)</b>
</p>
<p>
When an administrator activates function <b>Add notification</b>,
the category will not be added to the messenger profile immediately
but a special form will be loaded.
In this form, it is possible to determine whether further VKC groups or
users shall get a notification entry for the category.
</p>
<img src="pic3-vkc-registercat-adm.gif" width="483" height="459" border="1" 
alt="register category (Admin)">
<p>
Users with <b>full administration privileges</b> may select among <b>all</b>
VKC groups and users, whereas <b>dedicated administrators</b> can only
add notifications for the <b>groups or users managed by them</b>.
</p>
<p>
Adding notification for a VKC group means that the category will
be registered in the messenger for all current members of the group.
</p>
<p>
The selection becomes effective by clicking on button <b>Register</b>,
causing the messenger entries to be written.
As soon as the registration has been completed, the entries may only
be modified by the individual users themselves in the messenger.
</p>
<p>
You may return to the document view by clicking on button <b>Back</b>.
</p>

<div align="right">
<a href="#top">
<img src="top-blue.gif" alt="to top of page" border="0"></a>
</div>


<h4>
<a name="addfavcat"></a>
Add category to VKC favorites&nbsp;&nbsp;
<img src="pic3-button-add-catfavorites.gif" align="middle" alt="">
</h4>

<p>
This function adds the current category to your
<b>VKC list of favorites</b> which can be used to navigate quickly to the
most important categories.
The operation will be confirmed by a notification message.
Details about the list of favorites can be found on
<a href="help-alternate.jsp#favorites">help page "Favorites"</a>.
</p>

<div align="right">
<a href="#top">
<img src="top-blue.gif" alt="to top of page" border="0"></a>
</div>


<h4>
<a name="queryvirtual"></a>
Query for virtual documents
</h4>

<p>
An individual <b>search query</b> can be attached to every category.
It will be evaluated whenever the category is displayed.
All documents matching the query and accessible by the user according to their
permissions will be listed in the category as <b>virtual documents</b>.
</p>
<p>
You may <a href="#newvquery">create a new query</a> or
<a href="#editvquery">edit or delete a query</a> that has been defined before. 
</p>

<p><a name="newvquery"></a>
<b>Create a new query</b></p>

<p>
A query for virtual documents can be defined during <b>creation</b>
<img src="pic3-button-newcat.gif" align="middle" alt="">
or <b>modification</b> 
<img src="pic3-button-editcat.gif" align="middle" alt="">
of a category.
Currently, administrator privilege is required for this operation.
In the category properties you will find an entry
<b>Query for virtual documents</b>:
</p>
<img src="pic3-vkc-vquery1.gif" border="1"
alt="Query for virtual documents">
<p>
By clicking on <b>Create</b> on the right a form will be opened
for entering the query. It is very similar to the form of the advanced search.
</p>
<img src="pic3-vkc-vquery.gif" border="1"
alt="Create query for virutal documents">
<p>
You have to specify a search pattern for at least one field
in the upper part of the form. All fields with specified patterns
will be combined by logical AND during evaluation. 
Details about the search pattern syntax can be found on
<a href="helpmod-searchstring.jsp">help page "Syntax of Search Patterns"</a>.
The results can be further restricted by publication date and document type in
the lower part of the form. A sorting order can be selected.
</p>
<p>
By clicking on <b>Apply</b> the query will be added to the category properties.
The category properties form will be reloaded to complete the process.
This can be done by clicking "Create"
(in function <a href="#createcat">Create new category</a>)
or by clicking "Save"
(in function <a href="#editcat">Edit category</a>).<br>
If you click on <b>Back</b> instead of "Apply" in the query definition form,
the category properties will be reloaded without adding the query.
</p>

<p><a name="editvquery"></a>
<b>Edit or delete query</b></p>

<p>
If there is a search query associated with a category already,
users with administrator privilege will find it among the category properties
as shown in the example below:
</p>
<img src="pic3-vkc-vquery2.gif" border="1"
alt="Query in category properties">
<p>
To remove the query completely you have to click on <b>Delete</b> and then save the
properties.
If you want to change the query, you have to click on <b>Edit</b> to load the
detailed search form for modification of the query.
</p>
<img src="pic3-vkc-vquery3.gif" border="1"
alt="Edit query">
<p>
You may now edit the quey. For completing the process you have to click
on <b>Apply</b> and save the category properties.
In case you decide not to change the query, you click on <b>Back</b> to return to
the category properties form.
</p>

<div align="right">
<a href="#top">
<img src="top-blue.gif" alt="to top of page" border="0"></a>
</div>

<!-- DOCUMENT FOOTER ************************************************** -->

<hr>
<p>
<b>Attention:</b>
<br>
Please use the <b>back</b> button of your browser for returning
to the previous help page. 
</p>

<img src="vkc-versioninfo.gif" alt="Version information" border="0">

</body>
</html:html>