General object properties - Cloud

Navigate Author

Every Author-it object has a set of properties managed through the General tab on the Properties window.

These are the properties that are common across all objects, uniquely identify an object, and are used within Author-it, rather than in the output formats. Each property on the tab is described below.

icon_OpenNewWindowVideos: Blueprint of an object and Using the Templates

Properties General Tab

Object code

Unique identifier for the object, which you cannot change. Use this number for linking topics when you're producing context-sensitive Help. The number does not change if you create versions of the object.

Description

Defines a descriptive name for the object. This description will be displayed as the name of the object throughout Author-it.

Note: You should use a description that will make your objects easy to identify and find. In some object types, the description is copied to other properties when you first create the object. For example, in the topic object the text is copied to the print heading, help heading, and the web heading properties.

Template

Determines if this object is an object template. If you select the check box for this property, the object becomes a template.

Note: You can only set this property when the object is first created, and only if you have the required security permissions.

  • Base this object on and inherit properties from template drop-down menu allows you to choose the template on which the object will be based. The names that appear in this list are derived from the Description property of an object template. The object templates that appear may depend on your security access.
  • Make this object a structure template check box converts the template to use structure rules. Choose this option when you are using Structured Authoring. This option is enabled for Book and Topic templates.

    Structure rules are then created using the Structure Builder. The rules, or "structure" are then saved against the template. All books or topics based on the templates inherit the structure and their content must conform to the rules.

Include object in

Determines the published outputs the object will be included in.

  • Print: applies to Word and PDF
  • Help: applies to Windows Help
  • Web: applies to HTML Pages, XHTML Pages, HTML Help, JavaHelp, and Oracle Help for Java.

Version control

  • Object version contains a read-only unique version number for each version of an object. The object code will not change from one version of an object to another.
  • Object status is a read-only text property that contains the current status of the version of the object. An object version can move through several different states during its life cycle.

View Edit History

Opens the View Edit History window which shows a list of the changes made to this object.