Caution: This documentation is for eZ Publish legacy, from version 3.x to 5.x.
For 5.x documentation covering Platform see eZ Documentation Center, for difference between legacy and Platform see 5.x Architecture overview.

Creating help texts/help descriptions

The description fields on the object and the object attribute is used to create help texts or help description for your editors when they work on a specific class or its attributes. This will then help the end-users to understand the significance of the fields in their daily work. The help texts are specified on a content class, so you need to go to "Setup" - "Classes" - "Content Classes" to find the specific class where you want to add help text.

In the example below we have put in a description of the "Frontpage" class in the description fields for the class and the name attribute, both marked with read in the screenshot below:

After saving it by clicking "OK", help text will appear on objects created from this class; for instance on front pages, as in this example.

The next time an editor creates a new front page, the new help descriptions will appear on the front page object. An example of how the help texts will work in the object edit interface is shown below:

Examples of help texts added for the Frontpage class, the first one is a class description and the others are class attribute descriptions

Geir Arne Waaler (07/05/2010 8:54 am)

Geir Arne Waaler (06/09/2010 2:07 pm)


There are no comments.