You are here

Home » API reference » FooTable 7.2

README.txt in FooTable 7.2

Same filename and directory in other branches
  1. 8.2 README.txt
  2. 8 README.txt
CONTENTS OF THIS FILE
---------------------

 * Introduction
 * Requirements
 * Installation
 * Configuration
 * Credits
 * Maintainers


INTRODUCTION
------------

The FooTable module integrates the FooTable jQuery plugin into Drupal which
provides a responsive table plugin.

 * For a full description of the module, visit the project page:
   https://drupal.org/project/footable

 * To submit bug reports and feature suggestions, or to track changes:
   https://drupal.org/project/issues/search/footable


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

This module requires the following modules:

 * Chaos tool suite (ctools) (https://drupal.org/project/ctools)
 * Views (https://drupal.org/project/views)
 * Libraries API (https://drupal.org/project/libraries)

The FooTable plugin also requires atleast jQuery version 1.7 which requires
either one of the following modules:

 * jQuery Update (https://drupal.org/project/jquery_update)
 * jQuery Multi (https://drupal.org/project/jqmulti)

If you're using the standalone version of the FooTable plugin, which can be
configured via Configuration » User interface » FooTable » Settings, you need
to include the Font Awesome (https://fortawesome.github.io/Font-Awesome)font in
your project. The easiest way to do this is by installing the following module:

 * Font Awesome Icons (https://www.drupal.org/project/fontawesome)


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

 * Module: Install as you would normally install a contributed Drupal module.
   See: https://drupal.org/documentation/install/modules-themes/modules-7 for
   further information.

 * Plugin: Download the most recent 3.x.x version of the FooTable jQuery plugin
   from https://github.com/fooplugins/FooTable/archive/V3.zip and move the
   contents of the compiled directory into the sites/all/libraries/footable
   directory.

 * jQuery: Download jQuery Update or jQuery Multi and Install as you would
   normally install a contributed Drupal module. See:
   https://drupal.org/documentation/install/modules-themes/modules-7 for
   further inforamtion.


CONFIGURATION
-------------

 * Configure user permissions in Administration » People » Permissions:

   - Administer FooTable

     Users in roles with the "Administer FooTable" permission will be able to
     change the configuration of the FooTable module via Configuration »
     User interface » FooTable.

 * Customize the module in Configuration » User interface » FooTable.

   - Breakpoints
   - Settings

 * Enable the FooTable module for a view using the following steps:

   - When creating a view, select the *FooTable* format.
   - Click on the *Settings* link, under the *Format* section.
   - Scroll down to the *FooTable Settings* section.
   - Configure the general FooTable settings accordingly.
   - Under the *Collapsed Columns* section, choose the "breakpoints" for which
     each column should be hidden.


CREDITS
-------

This module would not be possible without the FooTable plugin itself. Thanks to
Bradvin & Steveush (https://github.com/orgs/fooplugins/people) for making it
available and to all the others who helped inspire it.

This module is largely based on code from the DataTables
(http://drupal.org/project/datatables) module. Many thanks to Duellj
(http://drupal.org/user/168159) for developing and contributing that module.


MAINTAINERS
-----------

Current maintainers:
 * Mitch Portier (Arkener) - https://drupal.org/user/2284182
 * Matt Vance (Matt V.) - https://drupal.org/user/88338

File

README.txt
View source 
  1. CONTENTS OF THIS FILE

  2. ---------------------

  3. 

  4.  * Introduction

  5.  * Requirements

  6.  * Installation

  7.  * Configuration

  8.  * Credits

  9.  * Maintainers

  10. 

  11. 

  12. INTRODUCTION

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

  14. 

  15. The FooTable module integrates the FooTable jQuery plugin into Drupal which

  16. provides a responsive table plugin.

  17. 

  18.  * For a full description of the module, visit the project page:

  19.    https://drupal.org/project/footable

  20. 

  21.  * To submit bug reports and feature suggestions, or to track changes:

  22.    https://drupal.org/project/issues/search/footable

  23. 

  24. 

  25. REQUIREMENTS

  26. ------------

  27. 

  28. This module requires the following modules:

  29. 

  30.  * Chaos tool suite (ctools) (https://drupal.org/project/ctools)

  31.  * Views (https://drupal.org/project/views)

  32.  * Libraries API (https://drupal.org/project/libraries)

  33. 

  34. The FooTable plugin also requires atleast jQuery version 1.7 which requires

  35. either one of the following modules:

  36. 

  37.  * jQuery Update (https://drupal.org/project/jquery_update)

  38.  * jQuery Multi (https://drupal.org/project/jqmulti)

  39. 

  40. If you're using the standalone version of the FooTable plugin, which can be

  41. configured via Configuration » User interface » FooTable » Settings, you need

  42. to include the Font Awesome (https://fortawesome.github.io/Font-Awesome)font in

  43. your project. The easiest way to do this is by installing the following module:

  44. 

  45.  * Font Awesome Icons (https://www.drupal.org/project/fontawesome)

  46. 

  47. 

  48. INSTALLATION

  49. ------------

  50. 

  51.  * Module: Install as you would normally install a contributed Drupal module.

  52.    See: https://drupal.org/documentation/install/modules-themes/modules-7 for

  53.    further information.

  54. 

  55.  * Plugin: Download the most recent 3.x.x version of the FooTable jQuery plugin

  56.    from https://github.com/fooplugins/FooTable/archive/V3.zip and move the

  57.    contents of the compiled directory into the sites/all/libraries/footable

  58.    directory.

  59. 

  60.  * jQuery: Download jQuery Update or jQuery Multi and Install as you would

  61.    normally install a contributed Drupal module. See:

  62.    https://drupal.org/documentation/install/modules-themes/modules-7 for

  63.    further inforamtion.

  64. 

  65. 

  66. CONFIGURATION

  67. -------------

  68. 

  69.  * Configure user permissions in Administration » People » Permissions:

  70. 

  71.    - Administer FooTable

  72. 

  73.      Users in roles with the "Administer FooTable" permission will be able to

  74.      change the configuration of the FooTable module via Configuration »

  75.      User interface » FooTable.

  76. 

  77.  * Customize the module in Configuration » User interface » FooTable.

  78. 

  79.    - Breakpoints

  80.    - Settings

  81. 

  82.  * Enable the FooTable module for a view using the following steps:

  83. 

  84.    - When creating a view, select the *FooTable* format.

  85.    - Click on the *Settings* link, under the *Format* section.

  86.    - Scroll down to the *FooTable Settings* section.

  87.    - Configure the general FooTable settings accordingly.

  88.    - Under the *Collapsed Columns* section, choose the "breakpoints" for which

  89.      each column should be hidden.

  90. 

  91. 

  92. CREDITS

  93. -------

  94. 

  95. This module would not be possible without the FooTable plugin itself. Thanks to

  96. Bradvin & Steveush (https://github.com/orgs/fooplugins/people) for making it

  97. available and to all the others who helped inspire it.

  98. 

  99. This module is largely based on code from the DataTables

  100. (http://drupal.org/project/datatables) module. Many thanks to Duellj

  101. (http://drupal.org/user/168159) for developing and contributing that module.

  102. 

  103. 

  104. MAINTAINERS

  105. -----------

  106. 

  107. Current maintainers:

  108.  * Mitch Portier (Arkener) - https://drupal.org/user/2284182

  109.  * Matt Vance (Matt V.) - https://drupal.org/user/88338