You are here

README.txt in Quick Tabs 8.3

*******************************************************************************
Quicktabs

Description:
-------------------------------------------------------------------------------

This module provides a form for admins to create a block of tabbed content by
selecting a view, a node, a block or an existing Quicktabs instance as the
content of each tab. The module can be extended to display other types of
content.

Installation & Use:
-------------------------------------------------------------------------------

1.  Enable module in module list located at administer > structure > modules.
2.  Go to admin/structure/quicktabs and click on "Add Quicktabs Instance".
3.  Add a title (this will be the block title) and start entering information
    for your tabs
4.  Use the Add another tab button to add more tabs.
5.  Use the drag handles on the left to re-arrange tabs.
6.  Once you have defined all the tabs, click 'Save'.
7.  Be sure to FLUSH THE CACHE - when working with blocks you need to flush the
    cache whenever you make a change
8.  You new block will be available at admin/structure/blocks.
9.  Configure & enable it as required.

Note:
-------------------------------------------------------------------------------
Because Quicktabs allows your tabbed content to be pulled via ajax, it has its
own menu callback for getting this content and returning it in JSON format. For
node content, it uses the standard node_access check to make sure the user has
access to this content. It is important to note that ANY node can be viewed
from this menu callback; if you go to it directly at quicktabs/ajax/node/[nid]
it will return a JSON text string of the node information. If there are certain
fields in ANY of your nodes that are supposed to be private, these MUST be
controlled at admin/content/node-type/MY_NODE_TYPE/display by setting them to
be excluded on teaser and node view. Setting them as private through some other
mechanism, e.g., Panels, will not prevent them from being displayed in an ajax
Quicktab.

For Developers:
-------------------------------------------------------------------------------

One way to extend Quicktabs is to add a renderer plugin. Quicktabs comes with
3 renderer plugins: jQuery UI Tabs, jQuery UI Accordion, and classic Quicktabs.
A renderer plugin is a class that extends the QuickRenderer class and implements
the render() method, returning a render array that can be passed to
drupal_render(). See any of the existing renderer plugins for examples. Also see
Quicktabs' implementation of hook_quicktabs_renderers().

Lastly, Quicktabs can be extended by adding new types of entities that can be
loaded as tab content. Quicktabs itself provides the node, block, view, qtabs
and callback tab content types. Your contents plugins should extend the
QuickContent class. See the existing plugins and the hook_quicktabs_contents
implementation for guidance.


Author:
-------------------------------------------------------------------------------
Mike Garthwaite <michael@systemick.co.uk>
https://www.drupal.org/u/systemick

Maintainers
-------------------------------------------------------------------------------
Mike Garthwaite <michael@systemick.co.uk>
https://www.drupal.org/u/systemick

Shelane French
https://www.drupal.org/u/shelane

File

README.txt
View source
  1. *******************************************************************************
  2. Quicktabs
  3. Description:
  4. -------------------------------------------------------------------------------
  5. This module provides a form for admins to create a block of tabbed content by
  6. selecting a view, a node, a block or an existing Quicktabs instance as the
  7. content of each tab. The module can be extended to display other types of
  8. content.
  9. Installation & Use:
  10. -------------------------------------------------------------------------------
  11. 1. Enable module in module list located at administer > structure > modules.
  12. 2. Go to admin/structure/quicktabs and click on "Add Quicktabs Instance".
  13. 3. Add a title (this will be the block title) and start entering information
  14. for your tabs
  15. 4. Use the Add another tab button to add more tabs.
  16. 5. Use the drag handles on the left to re-arrange tabs.
  17. 6. Once you have defined all the tabs, click 'Save'.
  18. 7. Be sure to FLUSH THE CACHE - when working with blocks you need to flush the
  19. cache whenever you make a change
  20. 8. You new block will be available at admin/structure/blocks.
  21. 9. Configure & enable it as required.
  22. Note:
  23. -------------------------------------------------------------------------------
  24. Because Quicktabs allows your tabbed content to be pulled via ajax, it has its
  25. own menu callback for getting this content and returning it in JSON format. For
  26. node content, it uses the standard node_access check to make sure the user has
  27. access to this content. It is important to note that ANY node can be viewed
  28. from this menu callback; if you go to it directly at quicktabs/ajax/node/[nid]
  29. it will return a JSON text string of the node information. If there are certain
  30. fields in ANY of your nodes that are supposed to be private, these MUST be
  31. controlled at admin/content/node-type/MY_NODE_TYPE/display by setting them to
  32. be excluded on teaser and node view. Setting them as private through some other
  33. mechanism, e.g., Panels, will not prevent them from being displayed in an ajax
  34. Quicktab.
  35. For Developers:
  36. -------------------------------------------------------------------------------
  37. One way to extend Quicktabs is to add a renderer plugin. Quicktabs comes with
  38. 3 renderer plugins: jQuery UI Tabs, jQuery UI Accordion, and classic Quicktabs.
  39. A renderer plugin is a class that extends the QuickRenderer class and implements
  40. the render() method, returning a render array that can be passed to
  41. drupal_render(). See any of the existing renderer plugins for examples. Also see
  42. Quicktabs' implementation of hook_quicktabs_renderers().
  43. Lastly, Quicktabs can be extended by adding new types of entities that can be
  44. loaded as tab content. Quicktabs itself provides the node, block, view, qtabs
  45. and callback tab content types. Your contents plugins should extend the
  46. QuickContent class. See the existing plugins and the hook_quicktabs_contents
  47. implementation for guidance.
  48. Author:
  49. -------------------------------------------------------------------------------
  50. Mike Garthwaite
  51. https://www.drupal.org/u/systemick
  52. Maintainers
  53. -------------------------------------------------------------------------------
  54. Mike Garthwaite
  55. https://www.drupal.org/u/systemick
  56. Shelane French
  57. https://www.drupal.org/u/shelane