Tagger

Tags, Categories, and More for MODX!

A robust and performant tag management system. Summary of the many, many features:

1. Tested with up to a million tags
2. Paginated drop-down and type-ahead for easy tag input
3. Combo-box or tag-field input types
4. Optionally remove unused tags from the database automatically
5. Optionally restrict tag creation to the CMP, versus on input
6. Optionally use Auto-Tag cloud for input

Display and list: all tags, tags from specified group(s), omit unused tags, Resources with a given tag, etc. Supplies getResources with a &where condition, so that all the templating and sorting abilities of getResources are at your fingertips.

Installation¶

Install via Package Management, or download the package from the MODX Extras repository

Tagger FURLs are currently not working when using any resource extensions (.html,...) except /. Please change your extension to / at least on the resource where the TaggerGetResourcesWhere snippet is called.

• Content -> Content Types -> HTML (.html) -> /

Groups¶

After installation you will need to set up some groups. Groups are representing fields that will be added to your Resource panel. Open components menu, find Tagger and go to Groups tab. Add new group.

**WARNING** Please make sure that group alias will not match any Resource alias, otherwise resource with same alias will be unreachable.

GROUP OPTIONS:

Changing labels of Tagger places¶

System Settings under Tagger namespace are available for these settings: tagger.place_in_tab_label, tagger.place_tvs_tab_label, tagger.place_above_content_label, tagger.place_below_content_label, tagger.place_bottom_page_label

You can change their value to text or a lexicon key. If you want to have different name based on Resource Template, you can use following notation:

1==Label For Template with ID 1||2==Label For Template with ID 2

Default label: tagger.tab.label

Basic Usage¶

TaggerGetTags¶

This Snippet allows you to list tags for resource(s), group(s) and all tags

PROPERTIES:

OUTPUT PLACEHOLDERS AND EXAMPLE VALUES:

[[+id]] => 1
[[+tag]] => News
[[+alias]] => news
[[+group]] => 3
[[+group_id]] => 3
[[+group_alias]] => mediatype
[[+group_name]] => Media Type
[[+group_field_type]] => tagger-combo-tag
[[+group_allow_new]] => 0
[[+group_remove_unused]] => 0
[[+group_allow_blank]] => 1
[[+group_allow_type]] => 0
[[+group_show_autotag]] => 0
[[+group_show_for_templates]] => 21
[[+cnt]] => 1
[[+uri]]
[[+idx]] = Number starting from one for each tag
[[+active]] => 1 (1/0 based on if current tag is active or not)

For the [[+active]] placeholder to show the correct state, the snippet TaggerGetTags has to be called uncached.

EXAMPLE USAGE:

// Get tags for all resources, including unused tags
[[TaggerGetTags? &showUnused=`1`]]
// Get tags from groups 1 and 3 for all resources
[[TaggerGetTags? &groups=`1,3` &rowTpl=`tag_links_tpl`]]
// Get tags for current resource
[[!TaggerGetTags? &resources=`[[*id]]` &rowTpl=`tag_links_tpl`]]
// Get tags for current resource in getResources tpl
[[!TaggerGetTags? &resources=`[[+id]]` &rowTpl=`tag_links_tpl`]]

How to translate groups¶

Let's say we have a group with name Tags and alias tags. To translate name and/or description of this group, we will have to create new lexicons entries in a specific format.

• Open lexicon management
• Select Tagger namespace and custom topic
• Add new lexicon entry to this namespace and topic with a key: tagger.custom."group_alias" (in this example it will be tagger.custom.tags)
• If you want to translate description add one more lexicon entry with key: tagger.custom."group_alias"_desc (in this example it will be tagger.custom.tags_desc)
• If you want to use those translations also on the frontend, call TaggerGetTags with option &translate=1 ([[TaggetGetTags? &translate=1]]), new placeholders (group_name_translated, group_description_translated) will be available

TaggerGetResourcesWhere¶

This snippet generate a SQL Query that can be used in a WHERE condition in the getResources snippet

PROPERTIES:

EXAMPLE USAGE:

[[!getResources?
    &where=`[[!TaggerGetResourcesWhere?
    &tags=`Books,Vehicles`
    &where=`{"isfolder": 0}`]]`
]]

TaggerGetCurrentTag¶

This snippet lists the groups and tags that are the parameters of the current request. Always call this snippet uncached, as it reads the values from $_GET.

PROPERTIES:

TEMPLATE PLACEHOLDERS:

// tagTpl
[[+tag]]
[[+label]]
[[+alias]]
[[+uri]] => The URL contains all the tags of the current request, excluding the one of this template
[[+group_name]] => Name of the group the tag belongs to
[[+group_alias]] => Alias of the group the tag belongs to

// groupTpl
[[+name]] => Group name
[[+alias]] => Group alias
[[+multipleTags]] => Whether this group has more than 1 active tag
[[+tags]] => The markup of the active tags of this group

// outTpl
[[+groups]] => The markup of all the active groups

EXAMPLE USAGE:

[[!TaggerGetCurrentTag?
    &tagTpl=`@INLINE [[+label]]`
    &groupTpl=`@INLINE <li>[[+name]]: [[+tags]]</li>`
    &outTpl=`@INLINE <ul>[[+groups]]</ul>`
    &tagSeparator=`, `
]]

TaggerGetRelatedWhere¶

This snippet can be used to get related resources, which have the same tag. It generates a SQL condition for the WHERE property of a getResources snippet tag.

PROPERTIES:

Internally this snippet runs the snippet TaggerGetResourcesWhere, so the properties of TaggerGetResourcesWhere can be used as well. (Except &tags and &where which are set by the code.)

EXAMPLE USAGE:

// Lists all the resources with the same parent, that share at least one tag from the group 1 with the current resource.
[[getResources?
    &where=`[[TaggerGetRelatedWhere? &groups=`1`]]`
    &parents=`[[*parent]]`
    &tpl=`@INLINE <li>[[+pagetitle]]</li>`
    &tplWrapper=`@INLINE <ul>[[+output]]</ul>`
    &limit=`0`
]]