You are here

README.txt in Fieldset helper 6.2

Same filename and directory in other branches
  1. 6 README.txt
  2. 7.2 README.txt
======================================================================

CONTENTS
--------

 * Overview
 * Features
 * Requirements
 * Installation
 * Hooks
 * Usage
 * More Information


OVERVIEW
--------

The 'Fieldset helper' module saves the state of a collapsible fieldset
in a browser cookie. Being able to save the state of a collapsible fieldset
improves the usability of a website's forms and documents because users
are able to better customize what information is being presented to them.

For site administrator on the 'Modules' page, this module will save the
state of all the collasible fieldsets and add 'expand all' and 'collapse all'
links to the top page. These two tweaks make it easier for administrators to
enable and disable their modules.


FEATURES
--------

- Save the fieldset states on node add (node/add/*) and node edit (node/*/edit) as one page (node/form).
- Default fieldsets to be collapsible on specified or all pages.
- Default fieldsets to be collapsed on specified or all pages.
- Add 'Expand all | Collapse all' links on specified or all pages.
- Set the minimum number of collapsible fieldsets required to show 'Expand all | Collapse all' links.
- Allows specified collapsible fieldset's state to be saved across multiple pages by page or element id.
- Set the fieldset_helper_state_manager cookie duration.


REQUIREMENTS
------------

Optional modules

 - CCK fieldgroup - CCK's fieldset widget's collapsible state will also
   be stored by the 'Fieldset helper' module.


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

1. Copy/upload the fieldset_helper.module to the sites/all/modules directory
   of your Drupal installation.

2. Enable the fieldset_helper.module in Drupal (administer -> modules).

3. Set the 'save fieldset state' user permissions for the 'Fieldset helper' module.


HOOKS
-----

 - HOOK_fieldset_alter(&$element);
 - HOOK_fieldset_helper_path_alter(&$path);
 - HOOK_fieldset_helper_element_path_alter($element_id, &$path);

USAGE:
------

  The below code snippet can used to add a 'hand-coded' collapsible fieldset to a node or a block.

  The code snippet is based on 'Adding a collapsible fieldset to your nodes'
  (http://drupal.org/node/118343).

  Notes:

    - Make sure your input filter does not use the 'Line break converter'.
      This will break your fieldset's formatting.

    - Required javascript file will be dynamically added if the content or
      any region has a collapsible fieldset.

  Code Snippet:

    <fieldset id="static-xhtml-fieldset-example" class="collapsible">
      <legend>Static XHTML collapsible fieldset example.</legend>
      <div>This is an example of a static XHTML fieldset that is collapsible.</div>
    </fieldset>

    <fieldset id="static-xhtml-fieldset-example-collapsed" class="collapsible collapsed">
      <legend>Static XHTML collapsed fieldset example</legend>
      <div>This is an example of a static XHTML fieldset that is collapsed.</div>
    </fieldset>


MORE INFORMATION
----------------

 - Homepage
   http://thebigbluehouse.com

 - Download
   http://drupal.org/project/fieldset_helper

 - Changelog:
   http://cvs.drupal.org/viewvc.py/drupal/contributions/modules/fieldset_helper/CHANGELOG.txt?view=markup&pathrev=DRUPAL-6--2

 - CVS tree:
   http://cvs.drupal.org/viewvc.py/drupal/contributions/modules/fieldset_helper/?pathrev=DRUPAL-7--7

 - Demo site:
   http://drupal.bigbluedrop.com/admin/settings/fieldset_helper/test


AUTHOR/MAINTAINER
-----------------

 - Jacob Rockowitz
   http://drupal.org/user/371407

File

README.txt
View source
  1. ======================================================================
  2. CONTENTS
  3. --------
  4. * Overview
  5. * Features
  6. * Requirements
  7. * Installation
  8. * Hooks
  9. * Usage
  10. * More Information
  11. OVERVIEW
  12. --------
  13. The 'Fieldset helper' module saves the state of a collapsible fieldset
  14. in a browser cookie. Being able to save the state of a collapsible fieldset
  15. improves the usability of a website's forms and documents because users
  16. are able to better customize what information is being presented to them.
  17. For site administrator on the 'Modules' page, this module will save the
  18. state of all the collasible fieldsets and add 'expand all' and 'collapse all'
  19. links to the top page. These two tweaks make it easier for administrators to
  20. enable and disable their modules.
  21. FEATURES
  22. --------
  23. - Save the fieldset states on node add (node/add/*) and node edit (node/*/edit) as one page (node/form).
  24. - Default fieldsets to be collapsible on specified or all pages.
  25. - Default fieldsets to be collapsed on specified or all pages.
  26. - Add 'Expand all | Collapse all' links on specified or all pages.
  27. - Set the minimum number of collapsible fieldsets required to show 'Expand all | Collapse all' links.
  28. - Allows specified collapsible fieldset's state to be saved across multiple pages by page or element id.
  29. - Set the fieldset_helper_state_manager cookie duration.
  30. REQUIREMENTS
  31. ------------
  32. Optional modules
  33. - CCK fieldgroup - CCK's fieldset widget's collapsible state will also
  34. be stored by the 'Fieldset helper' module.
  35. INSTALLATION
  36. ------------
  37. 1. Copy/upload the fieldset_helper.module to the sites/all/modules directory
  38. of your Drupal installation.
  39. 2. Enable the fieldset_helper.module in Drupal (administer -> modules).
  40. 3. Set the 'save fieldset state' user permissions for the 'Fieldset helper' module.
  41. HOOKS
  42. -----
  43. - HOOK_fieldset_alter(&$element);
  44. - HOOK_fieldset_helper_path_alter(&$path);
  45. - HOOK_fieldset_helper_element_path_alter($element_id, &$path);
  46. USAGE:
  47. ------
  48. The below code snippet can used to add a 'hand-coded' collapsible fieldset to a node or a block.
  49. The code snippet is based on 'Adding a collapsible fieldset to your nodes'
  50. (http://drupal.org/node/118343).
  51. Notes:
  52. - Make sure your input filter does not use the 'Line break converter'.
  53. This will break your fieldset's formatting.
  54. - Required javascript file will be dynamically added if the content or
  55. any region has a collapsible fieldset.
  56. Code Snippet:
  57. Static XHTML collapsible fieldset example.
  58. This is an example of a static XHTML fieldset that is collapsible.
  59. Static XHTML collapsed fieldset example
  60. This is an example of a static XHTML fieldset that is collapsed.
  61. MORE INFORMATION
  62. ----------------
  63. - Homepage
  64. http://thebigbluehouse.com
  65. - Download
  66. http://drupal.org/project/fieldset_helper
  67. - Changelog:
  68. http://cvs.drupal.org/viewvc.py/drupal/contributions/modules/fieldset_helper/CHANGELOG.txt?view=markup&pathrev=DRUPAL-6--2
  69. - CVS tree:
  70. http://cvs.drupal.org/viewvc.py/drupal/contributions/modules/fieldset_helper/?pathrev=DRUPAL-7--7
  71. - Demo site:
  72. http://drupal.bigbluedrop.com/admin/settings/fieldset_helper/test
  73. AUTHOR/MAINTAINER
  74. -----------------
  75. - Jacob Rockowitz
  76. http://drupal.org/user/371407