Publication properties

Last Updated : Jun 19, 2024 |

These properties are displayed in the New Publication dialog box and in the Properties dialog box for a publication.

General tab

Name

Description

Title

Title for the publication. The title can contain alphanumeric characters, spaces, hyphens, and underscores. Do not use slashes, asterisks, or other special characters. This is a required field.

Example: Administering Communication Manager 8.

The title appears as the filename of the output, additionally, the publication version, language, and output format is appended. For example, Administering Communication Manager 8.0=3=Avaya Book=en-us. The maximum number of characters in an output filename is 116 characters. Out of which, 9 characters are used for the version number, language, and separators. The length of the output format name can vary, with the maximum being 30 for the Avaya 3–column Quick Reference. The remaining characters are used for the publication title. If the title is long and if there are no enough remaining characters, the complete publication title is not included in the output filename. You can rename the output filename after you download it, or you can shorten the name that fits within the supported characters.

Publication Type

The type of publication. This is a required field. The options are:

  • Administering

  • Article

  • Article for Administrator

  • Deploying

  • Documentation Library

  • Feature Description

  • Feature Pack Description

  • Getting Started

  • Glossary

  • Help System

  • Job Aid

  • Maintaining

  • Overview and Specification

  • Quick Reference

  • Reference Configuration

  • Release Notes

  • Snap-in Reference

  • Solution Description

  • Troubleshooting

  • Upgrading

  • Using

  • Videos

  • What's New

Description

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

Requested languages

For localization only.

Version tab

Name

Description

Version

Version of the publication. This field is auto-populated and cannot be modified.

Changes

A description of changes in this publication. This field can contain any text and is mandatory for new versions and branches. The description must contain the reason for creating this version. For example, For 8.0 updates, Localization updates, and SMGR-12345 updates.

Working language

en-us

Working resolution

Low

Avaya-specific fields tab

Name

Description

Created Date

Date on which you create the publication. This field is required.

Do not modify Created Date, instead provide or modify the Revised Date to specify the publication updated date.

This date appears in the following locations:

  • The cover page of the book in the month year format. For example, November 2020

  • Copyright year in the legal page

  • Footer

Important:

Do not enter the first or last day of a month in the date. The first or last day of the month might display incorrect month on the front cover of the book due to time zone differences.

Release Number

Product release number for which you created this version of the publication. This number appears on the front cover of the book with the text Release prepended.

However, if you type Release 8.0, you still see Release 8.0 in the output because Tridion Docs removes the text Release from the field.

The text you include after the number continues to display on the front cover of the book.

Revised Date

The date of a new release of the publication.

The date in this field takes precedence over the date in Created Date and appears on the front cover of the book.

The Created Date and Revised Date fields are used to automatically generate a copyright range in the legal page and in the footer of the output. See Specifying a copyright range for an output.

You can use the Revised Date to specify that the date on the cover must automatically reflect the publish date. See Setting the date of your outputs to the current date.

Important:

Do not enter the first or last day of a month in the date. The first or last day of the month might display incorrect month on the front cover of the book due to time zone differences.

Issue number

The issue number of the publication.

This number is displayed on the front cover of the book with the text Issue prepended. This field is optional.

However, if you type Issue 2.0, the output displays Issue 2 in the PDF output because Tridion Docs removes the text Issue, decimal, and any number after the decimal.

The text you include after the number continues to display on the front cover of the book.

For draft outputs you can use issue numbers such as 1.0.5.

Book number

The book number for the publication. This number appears on the cover of the book. This field is optional.