Categories

With the help of categories, a project is divided into various subjects. The most commonly used partitioning strategy is the differentiation by topics or subjects. Each subject is assigned to a separate category and in turn (sub)categories are created for individual topics. Subcategories can be nested arbitrarily.

Building department
    |-Documents
        |-Home
        |-Monument protection
        |-Urban planning
    |-MAM
        |-Home
        |-Monument protection
        |-Urban planning
Culture department
    |-Documents
        |-Home
        |-Monument protection
        |-Urban planning
    |-MAM
        |-Home
        |-Monument protection
        |-Urban planning

Usually, a project is structured in such a way that at the top level it is separated by client (e.g. the clients Building department and Culture department). At the level below this, a division is usually made between document categories and asset categories, which are usually structured in parallel.

This chapter explains how to create, edit, move or delete categories and how to change their properties.

Category Manager

Open the Category Manager

Prerequisites

• The Category Manager is accessable only by groups with the according Permissions on this module.
• As a user you can change to the group that ownes this permission (provided that you are added to this group), see chapter Change group or contact the system administrator (Superuser).

• Choose the menu Structure - > Categories to open the category management.

The category management is divided into two areas:

• In the left area, the category tree is displayed. This is also used in the archive, when creating new documents and when editing the categories. For each of these views, however, it is saved separately which categories are expanded and which are not. At the end of the line of a category, you will find various options for setting up, editing and deleting the selected category. This also includes options for setting the access rights and meta information.

• After clicking on a category, its properties appear on the right-hand side, where you can also edit them.

Use the Search field in the left-hand area to search for specific categories.

Note

If you don't possess the appropiate access rights of the category, it will not be shown to you in the search. * When searching all branches of the category tree, branches will be extended up to the search term. * Categories of the same level with no found search term won't be shown in the category tree. * Parent categories are greyed out if the search term is not included.

Edit the properties of a category

A category has different properties that on the one hand are given automatically but on the other hand can also be manually assigned and changed.

• To open and edit the properties, click on the desired category in the category management.

• The properties are divided into three topics for a better overview. For editing the properties proceed as described in the specified sections:

  • property 'Category Information'
  • property 'Permissions'
  • property 'Meta File, Templates, Workflow'

---

Create new category

1. Choose level of category

In the category tree, new categories can be added either as a top-level category, i. e. root element, or as a subcategory of a parent category.

• To create a top-level category, select New Top-level category in the upper right corner.

• To create a subcategory choose Create Subcategory at the end of the line of the respective main category. Subcategories are added directly beneath their parent categories.

2. Enter the properties for the category

The input fields and options for the category properties are now offered in the right-hand area of the category management.

Category properties may also be used in templates. For more information read the chapter Access Category Properties in the programming documentation.

• Assign the properties for the new category as described in the following sections:

  • property 'Category Information'
  • property 'Permissions'
  • property 'Meta File, Templates, Workflow'

---

Delete category

Delete

1. Select the desired category.

2. Choose Delete.

   Note

   Here, you can only delete empty categories, i.e. with no documents nor subcategories. Deleting filled categories will be prevented by an error message.

   

The category will be deleted.

Recursive Delete

1. If you want to delete a category including all content (subcategories, documents, assets), select Recursive Delete

   Note

   Here, you can only delete empty categories, i.e. with no documents nor subcategories.
   Deleting filled categories will be prevented by an error message.

   

2. The dialog that opens gives information about the numbers of the documents and subcategories within this category.

   

   • If the checkbox Delete documents is not selected only categories without documents will be deleted.
   • Confirm the deleting by clicking Delete or cancel the procedure with Cancel.

   An overview of the deleted documents is opened.

---

Property 'Category Information'

Those category information serve as default settings for the documents generated in this category.

These information can be changed at any time during a workflow by different plug-ins (e.g. different directory of a document than specified here).

• Enter the following information in this dialogue of the section:

entry field/option	description
Name	Enter a name for the category in the input field. This name appears in the category tree and for each document in the corresponding column of the Desktop.
Description	Enter a brief description of the category.
Directory	Specify the directory (beneath htdocs) in which all generated documents in this section are to be saved, e.g. /sport/tennis. It is not allowed to use spaces in directory names. This value can be changed while a document is in a workflow.
Filename	Enter the default filename for documents, created in this category, e.g. index.html. This value can be changed while a document is in a workflow.
Category meta variables	Click on the Edit link to set additional meta information about a category. This information is valid for all documents in this category, as well as in the subcategories. Already created subcategories do not “inherit” additionally added meta information. See Property 'Metainfo' for more information. Note: When creating new categories, this link will only be displayed for subcategories, not top-level categories. whereas when editing a categoy, this link will be displayed for any kind of category.
Media Assets	To create a so called asset category, this option has to be selected. It is relevant for creating a category in the Media Asset Management, i.e. to enable assets. imperia dinstinguishes betweenn 'document categories' and 'asset categories'. All categories and their tree branches also appear in the Media Management.
Only subcategories	If the new category serves only to structure a tree, activate this switch. No documents nor assets can be created in such a category. Note: You won't be able to import any previously created documents in this category. This applies even if documents are to be re-imported from the Archive.
Only one document	With this option you can reduce the number of documents in the desired category. You are not allowed to create more than one document in this category. That means that an already existing document won't be overwritten, but re-imported. Also in the category tree, the category stays grey when creating a new document. Example: A website should only contain one landing page. In this case, the category 'Home' should be enabled to contain only one document.

---

Property 'Metainfo'

1. To edit this property use Edit Metainfo at the end of the line of the category.

   

   Note

   This option is only available to users with 'write'-permission on the category.

   

2. Change a value of an existing meta field by clicking in the desired field and enter the new value.

3. Edit existing meta fields:

   • Append a new value to the metafield by clicking Append value.
     A new field is inserted below.

   • Delete the metafield or only a value of the metafield by using Delete metafield or Delete value in the Drop-down-list.

   

   • Change the position of a value field by using Move up/down in the Drop-down-list.
     As first/As last moves the value field to the first and last position.

4. Create new meta information by clicking New Metafield.

   

   

   • Enter the name of the new metafield.
   • Enter the value.
   • If necessary, use Append value to add another value field.
   • Choose Create to save your settings. Cancel will lead you back to the Meta information without saving your settings.

Background information on meta information

The categories' metainfo are inherited automatically when creating subcategories. That means, the subcategory contains the same meta information as its parent category.

What is the use of metainfos?

• Instead of entering values in the DESCRIPTION field of the category in order to save e.g. variables for generating the navigation, you can here enter your own, comprehensive variables for the category.
• In this way, you can easily access via Perl: whenever a Nodeinfo-Hash returns or is entered, there is a Meta::Info-Object beneath the META_INFO-key. The class Category::Category is extended by getMetaInfo() and setMetaInfo().
• When you are using the data storage File System and want to read or edit the meta information without imperia, you should consider that in this case, the Meta::Info-Object won't be stored, but the empty Hash-reference (that is not an object).
  In contrast, in a database the meta information will be stored in the new table category_meta.
• If the meta field __imperia_category_template contains a valid template name, this template will be used for editing.
  If there is no meta field, the system-conf-variable CATEGORY_TEMPLATE will be used or the default template.
  By that, you can restrict the use to only specific meta information.
• Another application of the metainfo is to determine available languages for multilingual documents:
  Therefore, the meta field linguas is provided (as seen in the second figure 'page META VIEW' in Edit Metainfo) .
  The meta field stores the desired languages in one array.
  Each value in this array complies with the ISO 639 language code (de, en, fr, etc.). imperia then builds the language selection for the MetaEdit (in the step 'Edit' of a workflow) according to these values.
• Also, __getAssociatedFiles() is an important variarble: This meta variable suppresses reference searching by the publisher. By adding return [] if $meta->getValues('__ifp_skip_associated_files'); the checking of references in the document is suppressed. This is useful for large documents as XML documents.

Access to Meta Information

• The access to meta information takes place as to any category information/field. An additional [index] reads out the appropiate field of an array.
• Alternatively, you can set META_INFO_ in the meta field to distinguish between categoriy fields and meta fields.
  This is useful when using the same name for category- as well as meta fields (although this is a rare case).

Example:
Assumed, in a category 'Test' with the ID "/123/456/789" and directory /test the following metainfo is included:

example   | "example text"
DIRECTORY | "meta-info, not the directory"
list      | "one" | "two" | "three"

In the (document!-)template use:

category: <!--SECTION:NAME:0-->
example(M): <!--SECTION:META_INFO_example:0-->
example: <!--SECTION:example:0-->
DIRECTORY: <!--SECTION:DIRECTORY:0-->
DIRECTORY(M): <!--SECTION:META_INFO_DIRECTORY:0-->
List: <!--SECTION:list[0]:0-->
List: <!--SECTION:list[1]:0-->
List: <!--SECTION:list[2]:0-->
List: <!--SECTION:list:0-->
category-ID: <!--SECTION:__imperia_node_id:0-->

The template processor returns

category: Test
example(M): Ein Beispieltext
example: Ein Beispieltext
DIRECTORY: /test
DIRECTORY(M): meta-info, not the directory
List: one
List: two
List: three
List: one
category-ID: /123/456/789[/en]

---

Property 'Permissions'

When assigning access rights for categories, a distinction is made between structure groups and functional groups. The type of group for which you want to assign rights determines where you can do this.

Structure groups:
Since not every user should be able to create or edit documents in every category, you can set the access permissions to it. That means, it will be determined for every group which access permissions are granted to the category.
Structure groups are groups that can assign the access permissions of categories to other users.

Assign the permission for structure groups in the categories' properties in the section Edit Permissions,

Functional groups:
In order to grant different permissions for different groups to different parts of a category, users are assigned to functional groups. In most installations there are four functional groups: trainee, editor, editor-in-chief, administrator.
When, for example, users select the menu item Create New Document they only see the categories they have access to. In addition, users must also have “Read” permissions for all the upper categories.

Assign the permission for functional groups using the Edit Permissions option in the drop-down-list at the end of the line for the selected category.

Tipp

If you create a new user and assign him rights to the main category, the rights are not assigned to the subcategory. This only happens when a new subcategory is created.
In this case, you would also have to assign the user rights to the subcategory.

If a document was already created before the new user existed, the document would have to go through the workflow again for the change to take effect in the document.

---

Section 'Edit Permissions'

Note

If the CATEGORY_QUICK_CONFIG variable is set, this section is not displayed. To edit permissions in this case, use the 'Edit Permissions' option .

If you want to edit the category permissions for other users (groups), proceed as follows:

1. In the category management click the category in the category tree to open the Edit category page.

2. Find the Edit category permissions section within the page.

   

3. The permissions to a category can be assigned in four different levels:

   Abbreviation	description	meaning
   r	read	users of this group can see the content of the category
   c	creating documents	users of this group can create documents in this category
   d	deleting documents	users of this group can delete documents of this category
   w	change category	users of this group can change the properties of this category and can create subcategories

   For each level, all or only certain groups can be assigned.

4. For every category you can assign the permissions differently. These permissions determine how a user can edit a document in this category.

Note

The permission to create documents in a given category also entails the permissions to publish these documents.
Apart from the create permissions to a category, a user also needs read permissions to the categories of all associated files (usually MAM objects) in order to be able to publish documents.

'Edit Permissions' option

One of the main differences to the editing of access rights described in the previous section is the option to set access rights recursively in the ACL administration. This means that you can set the permissions for entire subcategory trees.

1. Choose Edit Permissions in the drop-down-list of the category.

   
   

   
   

   In the upper area of the Modify Permissions page, specify whether the changes to the rights should apply recursively, i.e. also for contained subcategories.
   In the lower area, assign the rights to individual or multiple groups:

   • Select the desired groups in the Groups field or activate the Allow everybody logged in checkbox.
   • Under Manage Privileges, select the action for the rights in the left-hand column.
     • Add priviliges (+): This adds the selected rights to the existing rights of the selected groups.
     • Remove priviliges (-): This removes the selected rights from the selected group.
     • Set priviliges (=): This sets the rights of the group exactly to the marked priviliges.

   • In the right-hand column, select the rights you want to modify. To make multiple selections, press and hold the CTRL button at the same time.

     Warning

     Unmarked priviliges are removed from the groups.

2. Save your settings by clicking OK.

---

Property 'Meta File, templates, workflow'

Determine the meta file, template and workflow to be used in a category.

1 Click on the desired category in the category management to open the category properties. 2. Find the Workflow section within the properties.

![modify permissions](/images/admin/category/metafiles_templates_workflows.png)

!!!note "Note"  
    These are only default settings that may be overwritten by the template selection during the meta information input.When adding sub categories, the following information are inherited from the parent category by default.

• Workflow: This drop-down list provides a list of all entry points of all available workflows in the form "Name of workflow" -> "Name of entry point".

  • Select the workflow to be used for the category. As a workflow can have several entry points, not only the workflow but also the entry point is determined.

  Each document created in the category receives a copy of the workflow set here and runs through all the steps belonging to this workflow until it leaves the workflow. Documents that are within a workflow are not affected if this workflow is modified.

• Metafile: This drop-down list lists all metafiles that are located in the /site/metafiles directory.

  • Select the metafile to be used in the category.

• Template: All templates, located in /site/templates, are listed in this drop-down list. The list contains the name and description of the available templates.

  • Select the template to be used in the category.