You are here

Home » API reference » Views Accordion 6

README.txt in Views Accordion 6

Same filename and directory in other branches
  1. 8 README.txt
  2. 7 README.txt
  3. 2.0.x README.txt
/* DESCRIPTION */

Views Accordion provides a display style plugin for the Views module.
It will take the results and display them as a JQuery accordion. It supports grouping of fields and ajax pagination.


/* INSTALATION */

1. Place the views_accordion module in your modules directory (usually under /sites/all/modules/).
2. Go to /admin/build/modules, and activate the module (you will find it under the Views section).


/* USING VIEWS ACCORDION MODULE */

Your view must meet the following requirements:
  * Row style must be set to Fields
  * The header field can not be set to inline.
  * If you use a separator for inline fields, be sure to wrap it in a html tag, for example: <span>|<span>.
  * Provide at least two fields to show.

Choose Views Accordion in the Style dialog within your view, which will prompt you to configure:
  * Transition time: How fast you want the opening and closing of the sections to last for, in seconds.
    Default is half a second.
  * Start with the first row opened: Whether or not the first row of the view should start opened when the view is first shown.
    Uncheck this if you would like the accordion to start closed.
  * Use the module's default styling: If you disable this, the CSS file in the module's directory (views-accordion.css) will not be loaded.
    You can uncheck this if you plan on doing your own CSS styling.  

*        IMPORTANT       * 
The first field WILL be used as the header for each accordion section, all others will be displayed
when the header is clicked. The module creates an accordion section per row of results from the view.
If the first field includes a link, this link will not function, (the js returns false) Nothing will break though.
**************************


/* THEMING INFORMATION */

This module comes with a default style, which you can disable in the options (see above). Files included:
  * views-acordion.css - A default stylesheet with how the classes the author thought would be best used.
  * views-view-accordion.tpl.php - copy/paste into your theme directory - please the comments in this file for requirements/instructions.

Both files are commented to explain how things work. Do read them to speed things up.


/* ABOUT THE AUTHOR */

Views Accordion was created by Manuel Garcia
http://drupal.org/user/213194

File

README.txt
View source 
  1. 

  2. /* DESCRIPTION */

  3. 

  4. Views Accordion provides a display style plugin for the Views module.

  5. It will take the results and display them as a JQuery accordion. It supports grouping of fields and ajax pagination.

  6. 

  7. 

  8. /* INSTALATION */

  9. 

  10. 1. Place the views_accordion module in your modules directory (usually under /sites/all/modules/).

  11. 2. Go to /admin/build/modules, and activate the module (you will find it under the Views section).

  12. 

  13. 

  14. /* USING VIEWS ACCORDION MODULE */

  15. 

  16. Your view must meet the following requirements:

  17.   * Row style must be set to Fields

  18.   * The header field can not be set to inline.

  19.   * If you use a separator for inline fields, be sure to wrap it in a html tag, for example: |.

  20.   * Provide at least two fields to show.

  21. 

  22. Choose Views Accordion in the Style dialog within your view, which will prompt you to configure:

  23.   * Transition time: How fast you want the opening and closing of the sections to last for, in seconds.

  24.     Default is half a second.

  25.   * Start with the first row opened: Whether or not the first row of the view should start opened when the view is first shown.

  26.     Uncheck this if you would like the accordion to start closed.

  27.   * Use the module's default styling: If you disable this, the CSS file in the module's directory (views-accordion.css) will not be loaded.

  28.     You can uncheck this if you plan on doing your own CSS styling.  

  29. 

  30. *        IMPORTANT       * 

  31. The first field WILL be used as the header for each accordion section, all others will be displayed

  32. when the header is clicked. The module creates an accordion section per row of results from the view.

  33. If the first field includes a link, this link will not function, (the js returns false) Nothing will break though.

  34. **************************

  35. 

  36. 

  37. /* THEMING INFORMATION */

  38. 

  39. This module comes with a default style, which you can disable in the options (see above). Files included:

  40.   * views-acordion.css - A default stylesheet with how the classes the author thought would be best used.

  41.   * views-view-accordion.tpl.php - copy/paste into your theme directory - please the comments in this file for requirements/instructions.

  42. 

  43. Both files are commented to explain how things work. Do read them to speed things up.

  44. 

  45. 

  46. /* ABOUT THE AUTHOR */

  47. 

  48. Views Accordion was created by Manuel Garcia

  49. http://drupal.org/user/213194