Guidelines to publish content on Avaya Documentation Center

Last Updated : Jan 17, 2022 |

To publish the content seamlessly on Avaya Documentation Center, you must add required metadata.

Also, follow best practices to enhance the content search and filter on Avaya Documentation Center.

DITA filename titles

  • Avoid special characters: The Title field of the DITA file in Tridion Docs must contain only alphanumeric characters, dashes, and underscores.

    Important:

    Do not include any special characters, such as trademarks , registered marks, and special characters, such as +-!(){}[]^"~:\&||#$@€/><,.‘;=%£&¬|`'“.

  • Avoid long topic title: Ensure that the topic title is not too long, truncate the names of the existing topics where required and keep it to 50 characters maximum. Examples of long titles:

    When I start the Avaya Communicator client Microsoft Outlook displays a security notification mess

    Avaya Equinox_for_iOS_is_matching_local_contact_details_for_incoming_call_instead_of_aggregate_con

    Important:

    Change the name from Topic > Properties. You do not need to create a new version.

  • Unique Override Output Filenames: In a publication, ensure that the Override Output Filename in the Baseline tab is unique. Checkout the topic, and remove or change the value if you find duplicate override filenames within the publication. See Duplicate override filenames.

Metadata

You need to set the following metadata in the document that you want to publish on Avaya Documentation Center

Metadata

Element where the value is set

Description

Publication type

Publication properties

To enable content search by document type.

Release number

Publication properties

To enable content search by release number.

Product family and product names

Topics properties

Map properties

To enable content search by product family and product name.

Bundle name

Bookmap/bookmeta/othermeta

To identify different releases of a publication on Avaya Documentation Center.

Homepage

Map/topicmeta

To make a preferred topic as the home or landing page.

By default, legal page is set as the homepage.

Cross-reference to topic external to the publication

xref/@scope

To link a topic to another topic that is external to the current publication.

Related link

related-links/link

To link to content or a video topic