Question

Is it possible to add a description or help text to an aspect’s property in Alfresco Share? I cannot change the title because it would require too much text.

Answer 1

When defining your type or aspect, you can set both a title and description. These will generally be shown in Forms, in Share and Explorer, and are normally the easiest way to explain to both users and developers about your model.

To see this in use, take a look at the audio:audio aspect in Alfresco, the latest version is available here. You’ll see some of the aspect properties have both a title and a description. If you upload an MP3 into Alfresco 4, and edit the metadata for it in Share, you should see that information show up.

As a general guide though, your aspect should look something like:

 <aspect name="test:thing">
     <title>Testing Content</title>
     <description>Aspect applied to mark content as being for testing use</description>
     <properties>
        <property name="test:edition">
           <title>Test Edition</title>
           <description>Which testing edition does this belong to?</description>
           <type>d:int</type>
        </property>
        <property name="test:notes">
           <title>Test Notes</title>
           <description>Notes for using this content in testing</description>
           <type>d:text</type>
        </property>
     </properties>
  </aspect>

If you’re going to be using your type or aspect in a multi-lingual system, then you should look at the Model Localisation Guide for information on how to specify names, titles and descriptions from properties bundles which can be localised