You are here

README.txt in TableField 7.2

Same filename and directory in other branches
  1. 6 README.txt
  2. 7.3 README.txt
  3. 7 README.txt
# TableField #

Provides a simple, generic form/widget to input tabular data. The form allows
the user to select the number of rows/columns in the table, then enter the data
via textfields. Since this is a field it is revision capable,multi-value
capable and has integration with Views.


## INSTALLATION ##

- Copy tablefield directory to ../sites/all/modules.
- Enable module at ../admin/modules.


## GET STARTED ##

Add a tablefield to any entity:
- For nodes at ../admin/structure/types. Then click 'manage fields' for the
  desired content type.
- For users at ../admin/config/people/accounts/fields.
- For taxonomies at ../admin/structure/taxonomy. Then click 'edit vocabulary'
  for the desired vocabulary.
- For files using the File Entity (fieldable files) module
  (https://www.drupal.org/project/file_entity) at
  ../admin/structure/file-types. Then click 'manage fields' for the desired
  file type.


## FEATURES ##

### Per table (in Edit mode) ###

- Change number of rows/columns per table (even within multi-value instances).
  Optionally restict that to users with the permission 'Rebuild tablefied'
  (see field settings below).
- Rows can be rearranged with drag and drop.
- Upload a CSV file to be converted into a table on the fly. The used
  separator can be defined at ../admin/config/content/tablefield.
- Copy paste tables e.g. from Excel.
- Add a table caption.
- Easily remove tables from a multi-value field with the button. Just install
  and enable https://www.drupal.org/project/multiple_fields_remove_button.


### Per field (field settings) ###

For nodes field settings for some of the below options can be found through
'manage fields' at ../admin/structure/types. For others entities see above.

- Restrict rebuilding to users with the permission "rebuild tablefield"
- Lock table header so default values cannot be changed.
- Table cell processing (radios)
  * Plain text
  * Filtered text (user selects input format)


### Per display mode (display settings) ###

For nodes display settings for the below options can be found through
'manage display' at ../admin/structure/types. For others entities see above
under 'GET STARTED'. Display options can be set per view mode e.g. 'Default' or
'Teaser'.

The options of all of the below settings are 'Yes'/'No' (checkbox) unless
stated otherwise.


#### Tabular view ####

- Sticky header
- Hide table header
- Hide empty columns ignoring column header
- Trim empty trailing rows
- Trim empty trailing columns
- Hide empty rows
- Hide empty columns
- Show link to export table data as CSV depending on permission


#### Raw data (JSON) ####

This format is intended to provide table data as a service. For example when
using a View that outputs JSON the field configuration includes 'Formatter'.
When choosing 'Raw data (JSON)' it shows the below options.

- Use first row/column values as array keys (if not empty). (select)
  * No
  * Header only
  * Both first row and first column (two headers)
- Vertical header (first column instead of first row)
- Table data only (no caption)

Using this format for a display mode for a node content type will display the
JSON in pretty print. More logical is to use the regular 'Tabular view' for the
node display and use the 'Raw dat (JSON)' diplay only in a View. That would
expose the date of published tables on a site automatically as a service.


## CREDITS ##

- Original author: Kevin Hankens (http://www.kevinhankens.com)
- Maintainer: vitalie (https://www.drupal.org/u/vitalie)
- Maintainer: jenlampton (https://www.drupal.org/u/jenlampton)
- Maintainer D7: Martin Postma (https://www.drupal.org/u/lolandese)

File

README.txt
View source
  1. # TableField #
  2. Provides a simple, generic form/widget to input tabular data. The form allows
  3. the user to select the number of rows/columns in the table, then enter the data
  4. via textfields. Since this is a field it is revision capable,multi-value
  5. capable and has integration with Views.
  6. ## INSTALLATION ##
  7. - Copy tablefield directory to ../sites/all/modules.
  8. - Enable module at ../admin/modules.
  9. ## GET STARTED ##
  10. Add a tablefield to any entity:
  11. - For nodes at ../admin/structure/types. Then click 'manage fields' for the
  12. desired content type.
  13. - For users at ../admin/config/people/accounts/fields.
  14. - For taxonomies at ../admin/structure/taxonomy. Then click 'edit vocabulary'
  15. for the desired vocabulary.
  16. - For files using the File Entity (fieldable files) module
  17. (https://www.drupal.org/project/file_entity) at
  18. ../admin/structure/file-types. Then click 'manage fields' for the desired
  19. file type.
  20. ## FEATURES ##
  21. ### Per table (in Edit mode) ###
  22. - Change number of rows/columns per table (even within multi-value instances).
  23. Optionally restict that to users with the permission 'Rebuild tablefied'
  24. (see field settings below).
  25. - Rows can be rearranged with drag and drop.
  26. - Upload a CSV file to be converted into a table on the fly. The used
  27. separator can be defined at ../admin/config/content/tablefield.
  28. - Copy paste tables e.g. from Excel.
  29. - Add a table caption.
  30. - Easily remove tables from a multi-value field with the button. Just install
  31. and enable https://www.drupal.org/project/multiple_fields_remove_button.
  32. ### Per field (field settings) ###
  33. For nodes field settings for some of the below options can be found through
  34. 'manage fields' at ../admin/structure/types. For others entities see above.
  35. - Restrict rebuilding to users with the permission "rebuild tablefield"
  36. - Lock table header so default values cannot be changed.
  37. - Table cell processing (radios)
  38. * Plain text
  39. * Filtered text (user selects input format)
  40. ### Per display mode (display settings) ###
  41. For nodes display settings for the below options can be found through
  42. 'manage display' at ../admin/structure/types. For others entities see above
  43. under 'GET STARTED'. Display options can be set per view mode e.g. 'Default' or
  44. 'Teaser'.
  45. The options of all of the below settings are 'Yes'/'No' (checkbox) unless
  46. stated otherwise.
  47. #### Tabular view ####
  48. - Sticky header
  49. - Hide table header
  50. - Hide empty columns ignoring column header
  51. - Trim empty trailing rows
  52. - Trim empty trailing columns
  53. - Hide empty rows
  54. - Hide empty columns
  55. - Show link to export table data as CSV depending on permission
  56. #### Raw data (JSON) ####
  57. This format is intended to provide table data as a service. For example when
  58. using a View that outputs JSON the field configuration includes 'Formatter'.
  59. When choosing 'Raw data (JSON)' it shows the below options.
  60. - Use first row/column values as array keys (if not empty). (select)
  61. * No
  62. * Header only
  63. * Both first row and first column (two headers)
  64. - Vertical header (first column instead of first row)
  65. - Table data only (no caption)
  66. Using this format for a display mode for a node content type will display the
  67. JSON in pretty print. More logical is to use the regular 'Tabular view' for the
  68. node display and use the 'Raw dat (JSON)' diplay only in a View. That would
  69. expose the date of published tables on a site automatically as a service.
  70. ## CREDITS ##
  71. - Original author: Kevin Hankens (http://www.kevinhankens.com)
  72. - Maintainer: vitalie (https://www.drupal.org/u/vitalie)
  73. - Maintainer: jenlampton (https://www.drupal.org/u/jenlampton)
  74. - Maintainer D7: Martin Postma (https://www.drupal.org/u/lolandese)