config.global.show_tags - Initialization - Author API

Author API Initialization

show_tags

Specifies Tags that should be shown in all Tag suggestion lists.

You would want to use this to show specific Tags in Tag suggestion lists.

Tags will be shown in the following situations:

  • Using "find by Tags" drop-down menu in the Item or Activity list views
  • Applying Tags to Items or Activities
  • Viewing the Tags attached to an Item or an Activity
  • Browsing via browse controls

Examples

var initializationOptions = {
    "config": {
        "global": {
            "show_tags": [
                {
                    "type": "TYPE3",
                    "description": "TYPE3_DESCRIPTION",
                    "label": "TYPE3_UI_LABEL"
                },
                {
                    "type": "TYPE4",
                    "description": "TYPE4_DESCRIPTION",
                    "label": "TYPE4_UI_LABEL"
                },
            ]
        }
    }
};

Values

Attribute path config.global.show_tags

Type array[TagSearchByTypeObject]

Each array entry should be in the form of a TagSearchByType object.

Caveats

You can only specify hide_tags or show_tags, but not both at the same time.

Related articles

Was this article helpful?

Did you arrive here by accident? If so, learn more about Learnosity.