Authoring - Changing the object description

The description is the object’s title. We prefer to use the term ‘description’. It is used to recognize the object and to select it in overviews and tree views. So, it is important to specify a clear description that distinguishes the object. The description is also included in translation jobs.

Changing a description is done in the following way.

You select the object in the tree on the left. Its content is shown on the right pane. Depending on whether you select a folder or a topic object you will see respectively the folder editor or the topic editor on the right. The entry field on top of both the editor panes allows you to over type the description.

Changing a folder description

Changing a topic description

The changes are  reflected in the tree pane on the left while you type. Each object should have a description. You cannot clear the entire entry field.

Authoring

 About HelpServer
 Starting up and logging on
 The basic working principles
 Introducing the Workbench
 Adding a new project
 Creating the content structure with folders
 Adding the content in topics
 Previewing the result
 Changing the object description
 Adding new objects at a specific position in the folder
 Rearranging objects in a folder
 References to content objects
 Using the work modes
 The properties of a content object
 The properties of a reference to a content object
 Copying, cutting, and pasting
 Removing
 Printing
 Publishing
 The object status
 Searching for changed content
 Recovering unsaved changes
 Enabling and disabling a reference in a folder
 Auto selecting a topic in a folder
 Controlling the levels in the folder structure
 Grouping topics in a folder
 Your profile and Workbench preferences
 Using the content in help and documentation systems
 Formatting the content
 Searching and replacing text
 Reusing content with shares
 Navigating with hyperlinks
 Navigating with pointerpaths
 Using bookmarks and jumps
 Duplicating content with clones
 Using tables
 Including media files
 Navigating to web pages
 Using embedded chunks
 Including html code
 Navigating with menus
 Using snippets
 Spelling checking
 Using the view mode
 Creating an index
 Creating a FAQ
 Creating a glossary
 Team authoring
 Working with projects
 Setting up structured authoring
 Generating file based output
 Creating printed output
 Importing files and folders
 Loading files in the project gallery
 Converting legacy content
 Including legacy content in real time
 Transferring objects between installations
 Smartcontent
 Notification
 Feedback
 Translating
 Customizing the look and feel
 User accounts
 Security
 Working with templates
 Working with metadata
 Versioning
 Auditing
 Workflow management
 Annotations
 Using event exits
 Appendix A: The URL parameters
 Appendix B: The object indicators
 Appendix C: Play Javascript