Description
The Tag Module allows you and your users to add Tags to weblog and/or photo gallery entries. It’s a very powerful module that allows you to create several different features in your templates using robust functions. You can show Tags that belong to an entry, view all entries that are Tagged with a specified Tag, show related entries based on shared Tags, and build a Tag “Cloud” to show and weigh all Tags in system. Additionally, your members can also subscribe to Tags, and view entries based on Tags they’ve subscribed to.
If you already have a Tagging system where Tags are placed into a custom field, or if you’ve manipulated the Tag “feel” by assigning your entries to several EE categories, the Tag module can easily transition your website. Using the built in Harvesting utility, you can easily harvest this data, and it will automatically convert all into Tags and apply them to your entries.
The Tag module adds a clean, robust AJAX tab to your Publish/Edit Entry page in the CP where you can easily add Tags, search for Tags, or scan your custom fields for Tags using the “Suggest” function.
NOTE: Tag 3.0 requires ExpressionEngine 1.6.x or ExpressionEngine 2.x, PHP 5+, and MySQL 4.1+
Release Date: 08/18/2010 |
Shortcut Link to this page: |
Compatibility: EE 1.6.x / EE 2.1.x |
Changelog
- Version 3.0.2
- Version 3.0.1
- Version 3.0.0
- Version 2.6.6
- Version 2.6.5
- Version 2.6.4 - Build 20090609
- Version 2.6.4
- Version 2.6.3 - Build 20090313
- Version 2.6.3
- Version 2.6.2
- Version 2.6.1 - Build 20081229
- Version 2.6.1 - Build 20081212
- Version 2.6.1
- Version 2.6.0 - Build 20081120
- Version 2.6.0
- Version 2.5.1
- Version 2.5.0
- Version 2.1.2 - Build 20080903
- Version 2.1.2
- Version 2.1.1 - Build 20080418
- Version 2.1.1 - Build 20080304
- Version 2.1.1
- Version 2.1.0
Version 3.0.2 (August 18, 2010)
- Added {tag_count} and {tag_total_results} variables to Tag:Tags to avoid naming conflicts with the variables parsed by Weblog:Entries.
- Fixed a bug where tags with spaces did not get wrapped in quotes when auto suggested in the Publish page.
- Fixed a bug where the Tags tab was inserted incorrectly and did not play nice with custom layouts.
- Fixed a bug where Tag:Entries would incorrectly parse foreign characters in custom weblog fields in EE 1.6.x.
- Fixed a bug where data from custom fields were being inserted into the Tag field in the Publish page upon update in EE 2.x.
- Fixed a misspelling in the Preferences page.
Version 3.0.1 (July 12, 2010)
- Added support for submitting Tags through the SAEF in EE 2.x.
- Modified all instances of BASEPATH to now use PATH_THIRD as the app folder is outside of the system folder in EE 2.1.
- Fixed a bug where the Tag tab was being called in the SAEF on the front end in EE 2.x.
Version 3.0.0 (June 23, 2010)
- Added a simple search ability to the Manage Tags area of the Tag control panel.
- Added a "cloud-like" clickable list of Tags to the UI (for EE 1.6.x) to easily add existing common Tags to an entry.
- Added {count} and {total_results} variables to the Tag:Tags tag.
- Added {subscribe_link} and {unsubscribe_link} variables to the Tag:Subscribed tag.
- Changed wording for removing of tags from "Bad" status.
- Upgraded module to use Solspace Bridge 1.0 with CodeIgniter, therefore allowing compatibility with EE 2.x.
- Fixed a bug where Bad Tags were still being shown in the Tag:Tags tag.
- Fixed a bug where the Tag_Name tag was ignoring the websafe_separator="" parameter completely.
- Fixed a bug where the inclusive="yes" with multiple tags in tag="" was sometimes treated as OR instead of AND in Tag:Entries.
Version 2.6.6 (October 8, 2009)
- Added the id_marker="" parameter to the Tag:Entries, Tag:Gallery_Entries and Tag:Tag_Name loops. Allows parsing of Tag ID from URI (default is "tag/id").
- Added the tag_name="", tag_id="", and fixed_order="" parameters to the Tag:Cloud loop.
- Added the {tag_id} variable to Tag:Cloud, Tag:Tags, and Tag:Subscriptions loops.
- Modified the Manage Tags page to display the Tag ID in the Tag list instead of the count of Tags.
- Fixed a bug where the Tag Browser feature would not work with foreign characters of two bytes or more.
- Fixed a bug where duplicate Tags would be created in the DB when there was a single quote in the Tag.
- Fixed a bug where the Screen Name column in the Manage Tags tab of the Tag CP was showing "1" for Tags submitted by guests.
- Removed "count" row from Bad Tags of control panel.
Version 2.6.5 (August 7, 2009)
- Modified Stats Recount tool in Tag CP to work in a batch mode.
- Fixed a bug where a MySQL error would be outputted if the type=“” parameter was invalid.
- Fixed a bug where MySQL database encoding was breaking non-Solspace extensions in the Tag Module’s CP.
- Fixed a bug where foreign characters would not display correctly in the module’s CP.
- Fixed a bug where the Tag Harvest using Categores for new Tags would duplicate tags that had single quotes.
- Fixed a bug in Harvest where if you selected Photo Gallery Categories method and did not select any photo galleries, a PHP error would be shown.
- Fixed a bug where the Tag preferences for a site were never cached and were re-loaded for every single Tag module call.
Version 2.6.4 - Build 20090609 (June 9, 2009)
- Added the parameter weblog_entry_id=“” to the Entries tag, allowing one to only allow certain weblog entry IDs to be displayed (or not).
- Modified the Tag block to take the Convert High ASCII to Entities setting into account.
- Fixed a bug where a Weblog Label with Foreign Characters was showing up garbled in Manage Preferences in the Tag module’s CP.
- Fixed a bug where the Tag extension and the Tag module’s DB character set changes were interfering with other extensions.
- Fixed a bug where Tags submitted via the Tag SAEF by a non-logged in user were being deleted by the Recount tool in the module’s CP.
Version 2.6.4 (May 8, 2009)
- Changed jQuery selectors to remove the @ symbol to be compatible with jQuery 1.3.2.
- Fixed a bug where Weblog Titles with foreign characters were not being displayed correctly in the Harvest area of the Tag CP.
- Fixed a bug where Tag language variables were interfering with Publish page language variables.
- Fixed a bug where Foreign Characters in Weblog Entry Titles and Weblog Labels were not displaying correctly in the module’s CP.
Version 2.6.3 - Build 20090313 (March 13, 2009)
- Modified the Tag:Related_Entries function to have a lighter load when only one Site is being used.
- Fixed a bug where the ajax() extension method was not using $EXT->last_call.
Version 2.6.3 (February 4, 2009)
- Fixed a bug where an upgrade from Tag 1.x to 2.x would cause a MySQL error.
- Fixed a bug where a table’s data was being manipulated by the update script before it might exist.
Version 2.6.2 (January 3, 2009)
- Added numerous indexes to the Tag module’s tables to improve performance.
Version 2.6.1 - Build 20081229 (December 29, 2008)
- Fixed a bug where the forward slash was a valid character in Tags.
Version 2.6.1 - Build 20081212 (December 12, 2008)
- Fixed a bug with the dynamic parameter in the Tag:Entries function where a string variable was being treated as if it were a boolean.
Version 2.6.1 (December 11, 2008)
- Added the exclusive=“” parameter to the the Tag:Entries function. It allows the tag=“not XX” parameter to only show entries that have none of those Tags at all.
- Updated the exclude=“” parameter to accept LIKE searches with %, example: exclude=“ o;g” would exclude the “sleddog” Tag.
- Updated the exclude=“” parameter to accept LIKE searches with %, example: exclude=“ o;g” would exclude the “sleddog” Tag.
- Fixed a bug where Upgrading from previous versions of Tag (v2.1.2 or earlier) would incorrectly insert foreign characters when UTF-8 was not the MySQL character set.
- Fixed a bug where the Tag:Related_Entries function would not take the site=“” parameter into account.
- Fixed a bug where the JavaScript in the Publish area was outputting errors.
Version 2.6.0 - Build 20081120 (November 20, 2008)
- Fixed a bug when iconv_substr() does not exist on the server.
- Fixed a bug where the Recount tool in the CP assumed the gallery module was installed.
Version 2.6.0 (November 19, 2008)
- Added Subscriptions function, which displays a list of the Tags a member is subscribed to.
- Added Subscriptions_Rank function, which displays Tags by how many subscriptions there are for them.
- Added Subscribed function, which lets you know if a member is subscribed to a Tag or not.
- Added Subscriptions_Count function, which returns the number of members subscribed to a Tag.
- Added {subscribe_link} and {unsubscribe_link} variables to Tag:Cloud and Tag:Tags functions.
- Fixed a bug where gallery entry Tags were being removed on update when there was no corresponding weblog entries Tagged for that Tag.
Version 2.5.1 (November 6, 2008)
- Added new Tag:Tagged function.
- Added ‘Recount Stats’ tool to Tag module’s control panel.
- Added type=“” parameter to the Related_Gallery_Entries function to accept either a Gallery or a Weblog Entry as the related type.
- Added a MySQL version check into the module’s CP to ensure the user is running MySQL 4.1 or above.
- Updated the Bad Tag link in Manage Tags so that an old, non-lowercased Tags will have its non-lowercased version submitted even if “Convert to Lower Case” is now enabled.
- Updated Tag to check for the new CP jQuery extension before calling it itself.
- Fixed a bug where Related and Reverse Related Entries would not be parsed because of foreign characters.
- Fixed a bug where Sites without Tag preferences set would be unable to have Tags until preferences were added.
- Fixed a bug where the use of jQuery.noConflict was interfering with other Third Party scripts.
- Fixed a bug where the Tag tab would not appear correctly when the weblog_id was not specified in the URL.
- Fixed a bug where a MySQL error would occur with older versions of MySQL when using rank_limit=“” and orderby=“relevance” in the Related Entries and Related Gallery Entries functions.
Version 2.5.0 (October 16, 2008)
- Added dynamic Category ID support to Tag:Entries function.
- Added new Tag:Stats function complete with variables.
- Added {if no_tag_results} conditional to Tag:Tags function.
- Added orderby=“clicks” as a valid parameter value for the Tag:Cloud function.
- Added orderby=“random” as a valid parameter value for the Tag:Cloud function.
- Added case=“” parameter to Tag:Name function.
- Added {total_results} variable to Tag:Cloud function.
- Added new Preference (“Maximum Tags Allowed per Entry in Publish Tab”) that restricts number of Tags submittable through the Publish Tab.
- Added new Preference (“Allow New Tag Creation via Publish Tab”) to prevent new Tags from being entered via Tag field in Publish Tab.
- Added Pagination support to Tag:Cloud function.
- Added rank_by=“” parameter to Tag:Cloud function.
- Added {clicks} variable to Tag:Cloud function.
- Added most_popular=“” parameter to Tag:Cloud function.
- Added orderby=“relevance” parameter option and {tag_relevance} & {tag_relevance_percent} variables to Tag:Related_Entries and Tag:Related_Gallery_Entries functions.
- Added tentative Foreign Character support.
- Updated Suggest Tags feature to work with tags longer than one word.
- Updated Suggest Tags feature so that entering an asterisk (*) will show all currently existing Tags.
- Updated javascript file/checking reference for Tag tab.
- Updated ‘Manage Tags’ section to be homepage in Tag CP.
- Updated Documentation link in Tag CP to go directly to Solspace Docs.
- Modified the ‘Add Bad Tag’ form in the Tag module’s CP to allow the adding of multiple bad Tags at once.
- Modified the module so that Automatic Upgrading is disabled and now requires user action.
- Modified the Tag tab in the Publish area so that when MSM is enabled, a checkbox exists to allow the searching for Tags from all Sites.
- Revamped and improved Solspace site Documentation.
- Fixed a bug where extension settings was not taking multiple MSM Sites into account.
- Fixed a bug where Tags with question marks and other characters could not be made Bad Tags in the Tags CP.
- Fixed a bug in the Tag:Entries and Tag:Tag_Name functions where if the marker was located in more than one segment it would not output.
- Fixed a bug where Tag:Related_Gallery_Entries was no longer working.
- Fixed a bug where websafe_separator=“” parameter was not supported with Tag:Gallery_Entries.
- Fixed a bug where the Site ID was not be inserted correctly for entries displayed on a Site that was not their own.
- Fixed a bug where Tags of multiple words would not be searchable or suggestable in the Tag tab.
- Fixed a bug where when “Convert to Lowercase” was turned on, a Tag could be duplicated.
- Fixed a bug in the Tag:Cloud and Tag:Entries function where if the category=“” parameter started with the ‘not’ phrase it would be ignored.
- Fixed a bug in the Module’s upgrade script where duplicate Actions might be installed.
- Fixed a bug where clicking the Tag tab in the Edit/Publish CP before all of the Publish page is loaded would hide all other tabs.
- Fixed a bug in the Tag Module CP where the number of existing Tags was not correct.
- Fixed a bug in the Tag:Entries function where uncategorized entries were not shown when category=“not #“ was used.
- Fixed a bug where non-existing Entries and Members might still have Tags in the module.
- Fixed a bug where viewing a Tag with an apostrophe in a Tag:Entries template, it would produce an error.
- Fixed a bug where Tag:Tag_Name would parse apostrophes with slashes in some server configurations.
Version 2.1.2 - Build 20080903 (September 3, 2008)
- Fixed a bug with duplicate ID numbers between galleries/weblogs in Tag Related Entries.
- Fixed a jQuery/Ajax bug in the Tag CP.
- Removed embedded jQuery from mod.tag.php file, now referenced to external file in lib folder.
Version 2.1.2 (August 11, 2008)
- Added ability to show/hide/rename Tag tabs per weblog in Extension Settings.
- Fixed Tag alpha column update in Tag CP when editing a Tag.
- Fixed bug with “Session ID Only” CP authentication introduced through EE 1.6.4 upgrade.
- Fixed Category parameter check to allow for multiple numeric categories in Tag:Cloud.
- Fixed show_expired=“” and show_future_entries=“” parameters in Tag:Cloud.
Version 2.1.1 - Build 20080418 (April 18, 2008)
- Fixed a bug where the “dynamic” parameter for the Tag:Gallery_Entries loop was not being recognized.
Version 2.1.1 - Build 20080304 (March 4, 2008)
- Made changes to install and upgrade process.
Version 2.1.1 (March 3, 2008)
- Fixed bug where Tag Form intermitantly worked on Full Image Entry Gallery pages.
- Fixed bug where Tag Harvest would not work if Photo Gallery module was not installed.
Version 2.1.0 (February 22, 2008)
- Added ‘status’ parameter to Tag:Cloud.
- Added ‘orderby’ and ‘sort’ parameters to Tag:Cloud.
- Added ‘total_entries’, ‘gallery_entries’, and ‘weblog_entries’ variables to Tag:Cloud.
- Added ‘exclude’ parameter to Tag:Cloud, Tag:Related, and Tag:Gallery_Related.
- Added Gallery Entry Tag Harvesting (convert Categories to Tags).
- Added Tag:Tag_Name function and variable for page headings.
- Added Websafe_Separator parameter to control the websafe seperator character.
- Added Tag:Search_Results function.
- Fixed {caption} variable bug for Gallery Entries.
- Fixed a bug where Tags added through front-end Tag form are NOT deletable through CP Entry Edit.
- Fixed a bug where deleting a Weblog Entry also deletes ALL associated Tags completely from system, including other Entries.
- Fixed a bug where Tagged Gallery Entries do not show up in Tag CP -> View Entries by Tag. As well, unrelated Weblog Entries with the same Entry ID as the related Gallery Entries would show.
- Fixed {count} variable bug for Tag:Cloud.
- Fixed security bug for Tag:Form.
- Fixed Tag:Tags loop bug that caused it to not work with Gallery Entries.
- Fixed bug where Category Url Titles with underscores do not work in Category parameter.
- Fixed ‘return’ parameter on Tag:Form.
Installation
This add-on uses the Solspace Bridge Expansion software, which allows you to install a single set of files for both ExpressionEngine 1.x and ExpressionEngine 2.x versions. After downloading the latest version of the add-on, unzip the download file and follow these instructions…
ExpressionEngine 2.x Installation Instructions
1. Copy Add-on Files
This add-on requires that you use the Solspace Bridge Expansion software with ExpressionEngine. It will be included with your download in a separate folder.
- Copy the bridge folder into your ./system/expressionengine/third_party/ directory.
- Copy the folder named tag into your ./system/expressionengine/third_party/ directory.
- If the ./themes/solspace_themes/ directory DOES NOT exist, copy the solspace_themes folder in the download into your ./themes/ directory.
- If the ./themes/solspace_themes/ directory DOES exist, copy all of the contents inside of the solspace_themes folder in the download into your ./themes/solspace_themes/ directory.
2. Installing the Add-On
- Go to the Modules tab in the ExpressionEngine Control Panel, find Tag in the list, and click Install.
3. Setup & Configuring
- To adjust any settings in Tag, click on the Preferences tab in the Control Panel area and then modify as necessary.
4. Troubleshooting and Support
For Support and Troubleshooting, visit the Solspace Support Forums.
ExpressionEngine 1.x Installation Instructions
1. Copy Add-on Files
This add-on requires that you use the Solspace Bridge Expansion software with ExpressionEngine. It will be included with your download in a separate folder.
- Copy the bridge folder into your ./system/ directory.
- Copy the folder named tag into your ./system/modules/ directory.
- Copy the extension file named ext.tag_extension.php into your ./system/extensions/ directory.
- If the ./themes/solspace_themes/ directory DOES NOT exist, copy the solspace_themes folder in the download into your ./themes/ directory.
- If the ./themes/solspace_themes/ directory DOES exist, copy all of the contents inside of the solspace_themes folder in the download into your ./themes/solspace_themes/ directory.
2. Installing the Add-On
- Go to the Modules tab in the ExpressionEngine Control Panel, find Tag in the list, and click Install.
- Go to the Extensions Manager area in the ExpressionEngine Control Panel, and make sure the jQuery for the CP extension exists and is enabled.
3. Setup & Configuring
- To adjust any settings in Tag, click on the Preferences tab in the Control Panel area and then modify as necessary.
4. Troubleshooting and Support
For Support and Troubleshooting, visit the Solspace Support Forums.
Updates
After downloading the latest version of the add-on, unzip the download file and follow these instructions...
ExpressionEngine 2.x Updating Instructions
1. Upgrading from Tag 2.x to Tag 3.x (if applicable)
If you're planning to upgrade BOTH ExpressionEngine AND Tag to ExpressionEngine 2.x, we recommend that you upgrade Tag first. Tag uses the Solspace Bridge Expansion software which allows a single set of files for an addon to work with both ExpressionEngine 1.x and ExpressionEngine 2.x, therefore making it more seamless to upgrade your Solspace addons in the process of upgrading your ExpressionEngine 1.x site to ExpressionEngine 2.x.
- IF you have NOT yet upgraded your site from ExpressionEngine 1.x to ExpressionEngine 2.x, proceed to the ExpressionEngine 1.x Updating instructions.
2. Copy Add-on Files
This add-on requires that you use the Solspace Bridge Expansion software with ExpressionEngine. It will be included with your download in a separate folder.
- Copy the bridge folder into your ./system/expressionengine/third_party/ directory.
- Copy the folder named tag into your ./system/expressionengine/third_party/ directory.
- Copy all of the contents inside of the solspace_themes folder in the download into your ./themes/solspace_themes/ directory.
3. Updating the Add-On
- Go to the Modules tab in the ExpressionEngine Control Panel and click the link for Tag
- Click the Update link now displayed in the module's control panel.
4. Troubleshooting and Support
For Support and Troubleshooting, visit the Solspace Support Forums.
ExpressionEngine 1.x Updating Instructions
1. Upgrading from Tag 2.x to Tag 3.x (if applicable)
If you're upgrading from Tag 2.x to Tag 3.x, please follow the special instructions below:
- Take your site Offline. We recommend that you take your site offline for the duration of the update so that people visiting your site won't see any PHP errors, etc.
- Delete the language files named lang.tag.php, lang.tag_fns.php, and lang.tag_submit.php in your ./system/language/english/ directory.
- Delete the folder named tag in your ./system/modules/ directory.
- Delete the folder named tag_themes in your ./themes/ directory.
2. Copy Add-on Files
This add-on requires that you use the Solspace Bridge Expansion software with ExpressionEngine. It will be included with your download in a separate folder.
- Copy the bridge folder into your ./system/ directory.
- Copy the folder named tag into your ./system/modules/ directory.
- Copy the extension files named ext.tag_extension.php and ext.tag_submit.php into your ./system/extensions/ directory.
- Copy all of the contents inside of the solspace_themes folder in the download into your ./themes/solspace_themes/ directory.
3. Updating the Add-On
- Go to the Modules tab in the ExpressionEngine Control Panel and click the link for Tag
- Click the Update link now displayed in the module's control panel.
4. Tag 2.x to Tag 3.x Clean-up (if applicable)
If you've just upgraded from Tag 2.x to Tag 3.x, please follow the additional set of special instructions below:
- Delete the extension file named ext.tag_submit.php in your ./system/extensions/ directory.
- Turn your site back Online.
5. Troubleshooting and Support
For Support and Troubleshooting, visit the Solspace Support Forums.
Software Support
We pride ourselves on our level of support and our attention to the customer. If you have an issue, we're here to help.