You are here

README.txt in Fasttoggle 6

Same filename and directory in other branches
  1. 8.3 README.txt
  2. 5 README.txt
  3. 7 README.txt
fasttoggle.module
=================

This module is a result of SoC 2006 from the Administration usability project.
It adds "fast toggling" capabilities to Drupal so that you can perform common
tasks a lot quicker because they are managed via AJAX callbacks instead of
loading new pages every time you unpublish a node for example.

Currently, fasttoggle.module has these functionalites:

* Add publish/unpublish, sticky/not sticky and promoted/not promoted links to
  each node
* Add publish/unpublish links to the content listing in the administration
  section
* Add block/unblock links to the user listing in the administration section
  and to the user profile of each user
* Add/revoke roles
* Adds publish/unpublish links to each comment
* Adds a field type "Fasttoggle" to views which allows fasttoggling of nodes.


CUSTOMIZING LABELS
==================
In addition to selecting a different predefined set of labels that show
actions instead of the current state, you can also define your own set of
labels. In your settings.php, you can add:

$conf['fasttoggle_labels'] = array(
  'node_status' => array(0 => 'show', 1 => 'hide'),
);

to change the label for toggling the node status. The fasttoggle options this
module ships with by default are:
    - node_status
    - node_sticky
    - node_promote
    - node_comment
    - user_status
    - user_role
    - comment_status

For further details on the syntax, see the fasttoggle_fasttoggle_labels()
function. Additionally, you can write modules that override these strings by
implementing hook_fasttoggle_labels().

After you added your custom strings, make sure to select them on the
configuration page.


THEMING LINKS
=============
There is no dedicated theme function for altering the HTML code of fasttoggle
links, however, the module applies classes to the <a> tag in the form
"fasttoggle-status-<type>-<option>-<status>" with status being 0, 1 or 2.
The status number always refers to the current state of the option (e.g. it's
0 for an unpublished node's "publish" link). Make sure that the throbbing
graphic is appropriately displayed when overriding the background image.


PERMISSIONS
===========
It is possible to control what links are displayed in a very fine-grained way.
Only users who have the ability to toggle a specific setting may update this
setting. They can only change nodes they have admin access to. This means that
fasttoggle.module plays nicely with node access modules as well.

File

README.txt
View source
  1. fasttoggle.module
  2. =================
  3. This module is a result of SoC 2006 from the Administration usability project.
  4. It adds "fast toggling" capabilities to Drupal so that you can perform common
  5. tasks a lot quicker because they are managed via AJAX callbacks instead of
  6. loading new pages every time you unpublish a node for example.
  7. Currently, fasttoggle.module has these functionalites:
  8. * Add publish/unpublish, sticky/not sticky and promoted/not promoted links to
  9. each node
  10. * Add publish/unpublish links to the content listing in the administration
  11. section
  12. * Add block/unblock links to the user listing in the administration section
  13. and to the user profile of each user
  14. * Add/revoke roles
  15. * Adds publish/unpublish links to each comment
  16. * Adds a field type "Fasttoggle" to views which allows fasttoggling of nodes.
  17. CUSTOMIZING LABELS
  18. ==================
  19. In addition to selecting a different predefined set of labels that show
  20. actions instead of the current state, you can also define your own set of
  21. labels. In your settings.php, you can add:
  22. $conf['fasttoggle_labels'] = array(
  23. 'node_status' => array(0 => 'show', 1 => 'hide'),
  24. );
  25. to change the label for toggling the node status. The fasttoggle options this
  26. module ships with by default are:
  27. - node_status
  28. - node_sticky
  29. - node_promote
  30. - node_comment
  31. - user_status
  32. - user_role
  33. - comment_status
  34. For further details on the syntax, see the fasttoggle_fasttoggle_labels()
  35. function. Additionally, you can write modules that override these strings by
  36. implementing hook_fasttoggle_labels().
  37. After you added your custom strings, make sure to select them on the
  38. configuration page.
  39. THEMING LINKS
  40. =============
  41. There is no dedicated theme function for altering the HTML code of fasttoggle
  42. links, however, the module applies classes to the tag in the form
  43. "fasttoggle-status--
  44. The status number always refers to the current state of the option (e.g. it's
  45. 0 for an unpublished node's "publish" link). Make sure that the throbbing
  46. graphic is appropriately displayed when overriding the background image.
  47. PERMISSIONS
  48. ===========
  49. It is possible to control what links are displayed in a very fine-grained way.
  50. Only users who have the ability to toggle a specific setting may update this
  51. setting. They can only change nodes they have admin access to. This means that
  52. fasttoggle.module plays nicely with node access modules as well.