Topic properties

Last Updated : Dec 20, 2017 |

General tab

Name

Description

Title

Tridion Docs title for the topic. You can include only alphanumeric characters, spaces, hyphens, and underscores. Do not use characters, like slashes, asterisks, periods, parenthesis, or other special characters. The maximum length is 100 characters including spaces. The length restriction is important because Tridion Docs uses the Tridion Docs topic title as part of the topic's temporary filename. This is a required field.

Example: Creating a user

In Folder

The location of the topic. This field is read-only.

Content type

The topic type. This field automatically populates the topic type of the template that you selected, for example, structure, task, or concept.

Note:

Changing this field has no effect on the topic itself so do not change it. To change the type of topic, you must create a new topic of the correct type and copy the content from the existing topic to the new one.

Description

A description of the topic. This field can contain any text and is optional.

Enable translation management

For localization only.

Requested languages

For localization only.

Important:

For successful translation, ensure that the field is always blank and check box is clear.

Inherited languages

For localization only.

Version tab

Name

Description

Version

Version of the topic. The system automatically populates this field.

Changes

A description of changes in this topic. This field is relevant for the new version of a topic. This field can contain any text and is mandatory for new versions and branches.

Candidate for baseline

This field is blank.

Baseline label

This field lists the frozen baselines that use this topic. This field is automatically populated.

Workflow tab

Name

Description

Language

The language of the object. This field is automatically populated

Status

Workflow status. Options are:

  • Draft

  • Editorial review

  • Pre-release validation

  • Technical review

  • Released

You can move an object to the Released state only when the object is in the Pre-release Validation state.

Author

The owner of the topic.

Last modified by

The last person who modified the topic. This field is automatically populated.

Source language

This field is blank.

Comments

Comments about the workflow. This field can contain any text and is optional.

Avaya-specific fields tab

Name

Description

Override Output File Name

Required HTML file name if the topic is part of context-sensitive help or use for chunking. This field is auto populated by the base attribute in the topic and is read-only. This field has the same character and restriction limitations as the Title field on the General tab:

  • The base attribute can contain alphanumeric characters, spaces, hyphens, and underscores. Do not use any other characters, like slashes, asterisks, periods, parenthesis, or other special characters.

  • The maximum length of this field is 100 characters including spaces.

Product Family

The product category or family to which the product belongs.

This is a required field.

Product

The product for which you want to create the content.

This is a required field.

Component

Product components will be set up by the system administrator on a case by case basis. Talk to the system administrator if you think a product component is appropriate for your product.

Contributor

This field is currently unused.

Doc Lead

The user who has responsibility for this content and can move the object to the Released state in workflow. This a required field.

Localization Coordinator

For localization team only.

Reviewer

You can optionally specify another Tridion Docs user as a reviewer for an object. This is useful when content is in the editorial review phase in workflow and you want the object to appear in the inbox of the selected user.

The user that you want to select in the Reviewer field must be assigned the role of Reviewer in Tridion Docs. Open a ticket on the Infosolutions project to add the Reviewer role for the user if the name is not available for selection.