You are here

Home » API reference » FooTable 8

README.txt in FooTable 8

Same filename and directory in other branches
  1. 8.2 README.txt
  2. 7.2 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 module(s):

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

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://www.drupal.org/documentation/install/modules-themes/modules-8
   for further information.

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


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.

Thanks to Matt Vance (https://drupal.org/user/88338) for all his on the 7.x-1.x
branch and the initial setup of this project.

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

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 module(s):

  29. 

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

  31. 

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

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

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

  35. in your project. The easiest way to do this is by installing the following

  36. module:

  37. 

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

  39. 

  40. 

  41. INSTALLATION

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

  43. 

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

  45.    See: https://www.drupal.org/documentation/install/modules-themes/modules-8

  46.    for further information.

  47. 

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

  49.    from https://github.com/fooplugins/FooTable/tags and move the contents of

  50.    the compiled directory into the libraries/footable directory.

  51. 

  52. 

  53. CONFIGURATION

  54. -------------

  55. 

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

  57. 

  58.    - Administer FooTable

  59. 

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

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

  62.      User interface » FooTable.

  63. 

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

  65. 

  66.    - Breakpoints

  67.    - Settings

  68. 

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

  70. 

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

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

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

  74.    - Configure the general FooTable settings accordingly.

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

  76.      each column should be hidden.

  77. 

  78. 

  79. CREDITS

  80. -------

  81. 

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

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

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

  85. 

  86. Thanks to Matt Vance (https://drupal.org/user/88338) for all his on the 7.x-1.x

  87. branch and the initial setup of this project.

  88. 

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

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

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

  92. 

  93. 

  94. MAINTAINERS

  95. -----------

  96. 

  97. Current maintainers:

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