Usage descriptors can be defined in plugins and can also be created interactively by a site administrator with a special Usage Descriptor entry type. See /repository/usagedescriptors to view the list of descriptors.

To create a custom Usage Descriptor:

• Go to some folder
• Add an new entry with "Pick a type..."
• Look for the "Usage Descriptor" entry type
• Specify a name, optional image, description, unique identifier and an optional redirect URL.

This results in a new Usage Descriptor entry, e.g.: A usage descriptor is displayed in a wiki page with the "usage" tag. The below tag:

{{usage  descriptor="cc-by"  includeName="true"  showDescription="true"  decorate="true"  
#iconWidth="60px"  #textBefore="extra text"  #textAfter="extra text"  
#required="If set then user must agree. Some unique id, e.g., agreed_license_1"  
#requireMessage="Message to show" 
#requireSuffix="Message to show after descriptor"
#requireShowLicense="false"
#requireRedirect="https://example.com"
#requireOnlyAnonymous="true" 
#logName="true"  
}} 

Gives:

Creative Commons Attribution 4.0 International

This license enables reusers to distribute, remix, adapt, and build upon the material in any medium or format, so long as attribution is given to the creator. The license allows for commercial use.

The descriptor used is specified with the license="<descriptor id>" attribute. You can select the descriptor ID from the list of usage descriptors. You can also configure the Usage Descriptor with custom text, etc. If you set the required="some identifier" then, when a user visits a page that displays the usage descriptor they will be prompted to accept the terms. The "some identifier" is used to track whether the user has accepted the usage descriptor. If you want to update a descriptor then just change the required identifier.

Setting logName="true" will prompt the user for their name and email. This will be logged by RAMADDA in the file <RAMADDA home>/logs/usagedescriptor.log

This will result in a prompt when a user visits the page that displays the usage descriptor: There is also Usage Tag type that can be specified and can then be embedded in entry pages. To create a Usage Tag property go to the Entry Add Properties form and, under Basic Properties, select "Add Usage Tag". You need to specify the Usage Descriptor ID and optionally specify a description, required ID, message,etc. If inherited is set to true then this Usage Tag property is applicable to all descendant entries. To embed a Usage Tag in any wiki page use the properties tag as shown below. The inherited=true specifies to use any inherited property. The message="" states to show blank if there are no usage tag properties. Some entry types (e.g., Cultural Site) have wiki text that embeds the usage tags.

#Note the usage tag type is actually content.license to maintain backwards compatability
{{properties   message="" inherited="true" metadata.types="content.license"}}  

You can add a Usage Tag to a whole tree of entries, even the entire repository. This is done through the Footer property:

• Go to Add Property
• Under Thumbnails, Page Style, Etc. choose Footer
• The Footer takes arbitrary wiki text. Add the Usage Tag.
• Select inherited to apply this footer to all children pages

This results in the below footer added to every page: