You are here

Home » API reference » Quick Tabs 8.3

README.txt in Quick Tabs 8.3

Same filename and directory in other branches
  1. 5 README.txt
  2. 6.3 README.txt
  3. 6 README.txt
  4. 6.2 README.txt
  5. 7.3 README.txt
  6. 7.2 README.txt
*******************************************************************************
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. 

  4. Description:

  5. -------------------------------------------------------------------------------

  6. 

  7. This module provides a form for admins to create a block of tabbed content by

  8. selecting a view, a node, a block or an existing Quicktabs instance as the

  9. content of each tab. The module can be extended to display other types of

  10. content.

  11. 

  12. Installation & Use:

  13. -------------------------------------------------------------------------------

  14. 

  15. 1.  Enable module in module list located at administer > structure > modules.

  16. 2.  Go to admin/structure/quicktabs and click on "Add Quicktabs Instance".

  17. 3.  Add a title (this will be the block title) and start entering information

  18.     for your tabs

  19. 4.  Use the Add another tab button to add more tabs.

  20. 5.  Use the drag handles on the left to re-arrange tabs.

  21. 6.  Once you have defined all the tabs, click 'Save'.

  22. 7.  Be sure to FLUSH THE CACHE - when working with blocks you need to flush the

  23.     cache whenever you make a change

  24. 8.  You new block will be available at admin/structure/blocks.

  25. 9.  Configure & enable it as required.

  26. 

  27. Note:

  28. -------------------------------------------------------------------------------

  29. Because Quicktabs allows your tabbed content to be pulled via ajax, it has its

  30. own menu callback for getting this content and returning it in JSON format. For

  31. node content, it uses the standard node_access check to make sure the user has

  32. access to this content. It is important to note that ANY node can be viewed

  33. from this menu callback; if you go to it directly at quicktabs/ajax/node/[nid]

  34. it will return a JSON text string of the node information. If there are certain

  35. fields in ANY of your nodes that are supposed to be private, these MUST be

  36. controlled at admin/content/node-type/MY_NODE_TYPE/display by setting them to

  37. be excluded on teaser and node view. Setting them as private through some other

  38. mechanism, e.g., Panels, will not prevent them from being displayed in an ajax

  39. Quicktab.

  40. 

  41. For Developers:

  42. -------------------------------------------------------------------------------

  43. 

  44. One way to extend Quicktabs is to add a renderer plugin. Quicktabs comes with

  45. 3 renderer plugins: jQuery UI Tabs, jQuery UI Accordion, and classic Quicktabs.

  46. A renderer plugin is a class that extends the QuickRenderer class and implements

  47. the render() method, returning a render array that can be passed to

  48. drupal_render(). See any of the existing renderer plugins for examples. Also see

  49. Quicktabs' implementation of hook_quicktabs_renderers().

  50. 

  51. Lastly, Quicktabs can be extended by adding new types of entities that can be

  52. loaded as tab content. Quicktabs itself provides the node, block, view, qtabs

  53. and callback tab content types. Your contents plugins should extend the

  54. QuickContent class. See the existing plugins and the hook_quicktabs_contents

  55. implementation for guidance.

  56. 

  57. 

  58. Author:

  59. -------------------------------------------------------------------------------

  60. Mike Garthwaite 

  61. https://www.drupal.org/u/systemick

  62. 

  63. Maintainers

  64. -------------------------------------------------------------------------------

  65. Mike Garthwaite 

  66. https://www.drupal.org/u/systemick

  67. 

  68. Shelane French

  69. https://www.drupal.org/u/shelane