You are here

Home » API reference » Community Tags 6

README.txt in Community Tags 6

Same filename and directory in other branches
  1. 5 README.txt
  2. 6.2 README.txt
  3. 7 README.txt

-----------------------
  OVERVIEW
-----------------------
Community Tags module allows users with the proper permissions to tag other users' content. These
tags can be displayed in a "tag cloud" from Tagedlic module in a variety of ways in order to
emphasize popular items.

Note: As of 2.x this module no longer requires the 6.x version of Tagadelic module. If Tagadelic is installed it may be selected
for tag display.

-----------------------
  INSTALLATION
-----------------------

1. Download the 6.x version of Tagadelic module and place its directory into your Drupal
   modules directory.

2. Download the 6.x version of Community Tags module and place its directory into your Drupal
   modules directory.

3. Enable the modules by navigating to:

     Administer > Site Building > Modules

4. Create a free tagging vocabulary for your content type(s) by going to:

     Administer > Content managment > Taxonomy

   On the "edit vocabulary" pages of the vocabularies you wish to use for community tagging,
   select the content type(s) to tag, and check the "Tags" setting.

5. Select which vocabularies should use community tagging by going to:

     Administer > Site Configuration > Community tags

   Note: you can only select free-tagging vocabularies - i.e. those that have the "Tags" setting checked.

6. Select how each node type should display the community tagging form by going to:

     Administer > Content > Content Types

   Note: The community tagging settings can be found in the "Workflow settings" section
   of the content type settings form. They will only be visible if a community tags
   enabled vocabulary is assigned to the content type. See steps 4 and 5 above!

6. Set permissions for tagging content and editing tags by going to:

     Administer > Access control

-----------------------
  NOTES
-----------------------

1. Block caching - Block caching is not supported for the community tags block.

------------------------
  WORKFLOW
------------------------
These are the rules applied to community tags WRT to affecting workflow.

The following workflow satisfies:
#984496 - tag attribution on node save
#612318 - node save handled correctly
#309681 - support generated nodes e.g. Feed API
#199936 - support more than one CT vocabulary
#984462 - when a tag is no longer attached to any nodes, (provide option to) automatically remove it from its taxonomy vocabulary - delete orphans mode
#644640 - quick form submit doesn't node save
#655354 - Community tags and apache solr search
#250300 (partial) - Node Author must be able to delete the unwanted tags. Non-sync mode supports use case 2 in comment #5 -  content is tagged by community member for use by themselves


Note: In the following discussion "valid terms" refer to taxonomy terms belonging
to free-tagging vocabularies that have been configured for use as "community tags".


Community Tags operations:
==========================

Tag added
---------
If not already present add term to node terms via node_save() (sync mode).


Tag removed
-----------
1. If node has this tag as a node term and no other user has tagged this node with this
term then remove node term via node_save() (sync mode).

2. Orphaned terms are removed (delete orphans mode only)


Node operations:
================

New node
--------
Community tags are created for all valid node terms with user set to
the node editor (not author).


Node update
-----------
1. Any valid node terms that are not community tags (for any user)
are added as community tags for the node editor - i.e. current user.

2. Any community tags for the node (for any user) that are not valid node terms
are either a) deleted for all users (snyc mode) or b) deleted for the current user (non-sync mode).

3. Orphaned terms are removed (delete orphans mode only)


Node delete
-----------
1. All community tags records are removed for the deleted node.
2. Remove orphaned terms (delete orphans mode only)


User operations:
================

User delete
-----------
All community tags are removed for the deleted user. Where the deleted user's tags were the
only tag for the combination of node/term then do:
1. Remove corresponding node terms (sync mode)
2. Remove orphaned terms (delete orphans mode only)

(NB thinking of having the option of moving tags to a "dead" user rather than
lose potentially valuable tagging activity).


Taxonomy operations:
====================

Term delete
-----------
All community tags are removed for the deleted term. No synchronisation issues.


Configuration changes:
======================

What happens when configuration that affects CT behaviour changes? NB: a valid
CT vocabulary is free-tagging, CT enabled, and has content type(s) assigned.

Valid CT vocabulary is changed to non-free-tagging
------------------------------------------------------
Does nothing. Tags will remain in the database. All CT operations including
orphan control etc only affect tags in valid CT vocabularies. If vocabulary is
subsequently reverted back to free-tagging then there may be some orphaned
tags for any nodes, terms or users that have been deleted in the mean time. Rebuild.

Valid CT vocabulary has community tagging disabled via the Community Tags settings page
---------------------------------------------------------------------------------------
Similar to above.

Valid CT vocabulary has content type assignation(s) removed
-----------------------------------------------------------
Similar to above. Will prevent orphaned terms from being removed (delete orphans mode only)
if tags were created for the de-assigned content type and other content type(s) are
being tagged with the same vocabulary. Need a solution?

CT Synchronisation mode changes
-------------------------------
No affect.


-----------------------
  AUTHOR INFORMATION
-----------------------

Tagadelic was originally written by Bèr Kessels and more information can be
found on http://www.webschuur.com/modules/tagadelic.

Carpentered in the webschuur.com

Additional modifications including weighted node tagging, the quick tag form and
user tags have been authored by Rob Barreca of Electronic Insight and more
information can be found at http://www.electronicinsight.com.

Cherry-picking from Rob Barreca's work and using it to create the Community Tags
module was done by Angela Byron of Lullabot with support from the Bryght guys.

Steven Wittens of Bryght updated this module to 5.x, cleaned up the code some more
and added more shiny features.

Andy Chapman - partial rewrite for 2.x.

File

README.txt
View source 
  1. 

  2. 

  3. -----------------------

  4.   OVERVIEW

  5. -----------------------

  6. Community Tags module allows users with the proper permissions to tag other users' content. These

  7. tags can be displayed in a "tag cloud" from Tagedlic module in a variety of ways in order to

  8. emphasize popular items.

  9. 

  10. Note: As of 2.x this module no longer requires the 6.x version of Tagadelic module. If Tagadelic is installed it may be selected

  11. for tag display.

  12. 

  13. -----------------------

  14.   INSTALLATION

  15. -----------------------

  16. 

  17. 1. Download the 6.x version of Tagadelic module and place its directory into your Drupal

  18.    modules directory.

  19. 

  20. 2. Download the 6.x version of Community Tags module and place its directory into your Drupal

  21.    modules directory.

  22. 

  23. 3. Enable the modules by navigating to:

  24. 

  25.      Administer > Site Building > Modules

  26. 

  27. 4. Create a free tagging vocabulary for your content type(s) by going to:

  28. 

  29.      Administer > Content managment > Taxonomy

  30. 

  31.    On the "edit vocabulary" pages of the vocabularies you wish to use for community tagging,

  32.    select the content type(s) to tag, and check the "Tags" setting.

  33. 

  34. 5. Select which vocabularies should use community tagging by going to:

  35. 

  36.      Administer > Site Configuration > Community tags

  37. 

  38.    Note: you can only select free-tagging vocabularies - i.e. those that have the "Tags" setting checked.

  39. 

  40. 6. Select how each node type should display the community tagging form by going to:

  41. 

  42.      Administer > Content > Content Types

  43. 

  44.    Note: The community tagging settings can be found in the "Workflow settings" section

  45.    of the content type settings form. They will only be visible if a community tags

  46.    enabled vocabulary is assigned to the content type. See steps 4 and 5 above!

  47. 

  48. 6. Set permissions for tagging content and editing tags by going to:

  49. 

  50.      Administer > Access control

  51. 

  52. -----------------------

  53.   NOTES

  54. -----------------------

  55. 

  56. 1. Block caching - Block caching is not supported for the community tags block.

  57. 

  58. ------------------------

  59.   WORKFLOW

  60. ------------------------

  61. These are the rules applied to community tags WRT to affecting workflow.

  62. 

  63. The following workflow satisfies:

  64. #984496 - tag attribution on node save

  65. #612318 - node save handled correctly

  66. #309681 - support generated nodes e.g. Feed API

  67. #199936 - support more than one CT vocabulary

  68. #984462 - when a tag is no longer attached to any nodes, (provide option to) automatically remove it from its taxonomy vocabulary - delete orphans mode

  69. #644640 - quick form submit doesn't node save

  70. #655354 - Community tags and apache solr search

  71. #250300 (partial) - Node Author must be able to delete the unwanted tags. Non-sync mode supports use case 2 in comment #5 -  content is tagged by community member for use by themselves

  72. 

  73. 

  74. Note: In the following discussion "valid terms" refer to taxonomy terms belonging

  75. to free-tagging vocabularies that have been configured for use as "community tags".

  76. 

  77. 

  78. Community Tags operations:

  79. ==========================

  80. 

  81. Tag added

  82. ---------

  83. If not already present add term to node terms via node_save() (sync mode).

  84. 

  85. 

  86. Tag removed

  87. -----------

  88. 1. If node has this tag as a node term and no other user has tagged this node with this

  89. term then remove node term via node_save() (sync mode).

  90. 

  91. 2. Orphaned terms are removed (delete orphans mode only)

  92. 

  93. 

  94. Node operations:

  95. ================

  96. 

  97. New node

  98. --------

  99. Community tags are created for all valid node terms with user set to

  100. the node editor (not author).

  101. 

  102. 

  103. Node update

  104. -----------

  105. 1. Any valid node terms that are not community tags (for any user)

  106. are added as community tags for the node editor - i.e. current user.

  107. 

  108. 2. Any community tags for the node (for any user) that are not valid node terms

  109. are either a) deleted for all users (snyc mode) or b) deleted for the current user (non-sync mode).

  110. 

  111. 3. Orphaned terms are removed (delete orphans mode only)

  112. 

  113. 

  114. Node delete

  115. -----------

  116. 1. All community tags records are removed for the deleted node.

  117. 2. Remove orphaned terms (delete orphans mode only)

  118. 

  119. 

  120. User operations:

  121. ================

  122. 

  123. User delete

  124. -----------

  125. All community tags are removed for the deleted user. Where the deleted user's tags were the

  126. only tag for the combination of node/term then do:

  127. 1. Remove corresponding node terms (sync mode)

  128. 2. Remove orphaned terms (delete orphans mode only)

  129. 

  130. (NB thinking of having the option of moving tags to a "dead" user rather than

  131. lose potentially valuable tagging activity).

  132. 

  133. 

  134. Taxonomy operations:

  135. ====================

  136. 

  137. Term delete

  138. -----------

  139. All community tags are removed for the deleted term. No synchronisation issues.

  140. 

  141. 

  142. Configuration changes:

  143. ======================

  144. 

  145. What happens when configuration that affects CT behaviour changes? NB: a valid

  146. CT vocabulary is free-tagging, CT enabled, and has content type(s) assigned.

  147. 

  148. Valid CT vocabulary is changed to non-free-tagging

  149. ------------------------------------------------------

  150. Does nothing. Tags will remain in the database. All CT operations including

  151. orphan control etc only affect tags in valid CT vocabularies. If vocabulary is

  152. subsequently reverted back to free-tagging then there may be some orphaned

  153. tags for any nodes, terms or users that have been deleted in the mean time. Rebuild.

  154. 

  155. Valid CT vocabulary has community tagging disabled via the Community Tags settings page

  156. ---------------------------------------------------------------------------------------

  157. Similar to above.

  158. 

  159. Valid CT vocabulary has content type assignation(s) removed

  160. -----------------------------------------------------------

  161. Similar to above. Will prevent orphaned terms from being removed (delete orphans mode only)

  162. if tags were created for the de-assigned content type and other content type(s) are

  163. being tagged with the same vocabulary. Need a solution?

  164. 

  165. CT Synchronisation mode changes

  166. -------------------------------

  167. No affect.

  168. 

  169. 

  170. -----------------------

  171.   AUTHOR INFORMATION

  172. -----------------------

  173. 

  174. Tagadelic was originally written by Bèr Kessels and more information can be

  175. found on http://www.webschuur.com/modules/tagadelic.

  176. 

  177. Carpentered in the webschuur.com

  178. 

  179. Additional modifications including weighted node tagging, the quick tag form and

  180. user tags have been authored by Rob Barreca of Electronic Insight and more

  181. information can be found at http://www.electronicinsight.com.

  182. 

  183. Cherry-picking from Rob Barreca's work and using it to create the Community Tags

  184. module was done by Angela Byron of Lullabot with support from the Bryght guys.

  185. 

  186. Steven Wittens of Bryght updated this module to 5.x, cleaned up the code some more

  187. and added more shiny features.

  188. 

  189. Andy Chapman - partial rewrite for 2.x.