You are here

Home » API reference » Community Tags 6.2

README.txt in Community Tags 6.2

Same filename in this branch
  1. 6.2 README.txt
  2. 6.2 community_tags_unitag/README.txt
  3. 6.2 community_tags_authcache/README.txt
  4. 6.2 community_tags_views/README.txt
  5. 6.2 community_tags_node/README.txt
; $Id$

Community Tags Views
====================

All community tags views support is contained in this sub-module.

Tagging form attachment
------------------------

The tagging form views attachment allows you to add a tagging interface to
a view of community tags for a node. The entire view is refreshed via AJAX
in response to tagging actions.

The view it attaches to must have a node argument, and a vocabulary filter set to
a single vocabulary. If these conditions are not met the attachment will not display.

The term links or names can have checkboxes dynamically added by JS for one-click
tagging/un-tagging of existing tags. To enable this, add the class 'ct-tag' to
the term link or term name field that contains the term name text. You may need
to use field re-write or theming.

Caching Views Block with attachment
-----------------------------------

The only feasible Block Cache policy for block views with the tagging form attachment
is "per page, per user". I'm not sure what value there is in per page/per user
CT block caching - authcache is a much better solution. There is some support to selectively invalidate the
block cache on ajax tagging operations so that the view refreshes correctly.

TODO
----

1. Decide whether to continue support for block cache and if so make invalidation logic apply to non-ajax tagging ops.
2. More docs.

File

community_tags_views/README.txt
View source 
  1. ; $Id$

  2. 

  3. Community Tags Views

  4. ====================

  5. 

  6. All community tags views support is contained in this sub-module.

  7. 

  8. Tagging form attachment

  9. ------------------------

  10. 

  11. The tagging form views attachment allows you to add a tagging interface to

  12. a view of community tags for a node. The entire view is refreshed via AJAX

  13. in response to tagging actions.

  14. 

  15. The view it attaches to must have a node argument, and a vocabulary filter set to

  16. a single vocabulary. If these conditions are not met the attachment will not display.

  17. 

  18. The term links or names can have checkboxes dynamically added by JS for one-click

  19. tagging/un-tagging of existing tags. To enable this, add the class 'ct-tag' to

  20. the term link or term name field that contains the term name text. You may need

  21. to use field re-write or theming.

  22. 

  23. Caching Views Block with attachment

  24. -----------------------------------

  25. 

  26. The only feasible Block Cache policy for block views with the tagging form attachment

  27. is "per page, per user". I'm not sure what value there is in per page/per user

  28. CT block caching - authcache is a much better solution. There is some support to selectively invalidate the

  29. block cache on ajax tagging operations so that the view refreshes correctly.

  30. 

  31. TODO

  32. ----

  33. 

  34. 1. Decide whether to continue support for block cache and if so make invalidation logic apply to non-ajax tagging ops.

  35. 2. More docs.

  36. 

  37. 

  38.