You are here

README.txt in Field Group Table 8

Same filename and directory in other branches
  1. 7 README.txt
SUMMARY
-------

This module extends the Field Group module and provides a "Table" group format,
which renders the fields it contains in a table. The first column of the table
contains the field labels and the second column contains the rendered fields.

COMPARISON WITH OTHER MODULES
-----------------------------

Field group multiple: this module also offers a "Table" group formatter, but it
was designed to deal with multivalued fields. As such, it renders every value
of multivalued fields in their own table cell. Every row containing value n of
all the fields in the group. This is an awesome way to un-clutter multivalued
fields, but it also means the module requires all fields it contains to have
the same cardinality and that some field types don't work very well. In
contrast, this module will render the field value normally, embedded in a
single table cell. For more information see: http://drupal.org/node/1480204

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

 * Field Group (http://drupal.org/project/field_group)

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

 * Ensure the module's dependencies are met
 * Install the module by placing it in sites/all/modules and enabling it
 * Profit!

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

Go to any "Manage form display" or "Manage display" page where you would like
to add your field group, and create a field group as usual. Now you can choose
"Table" as the group format.

### Label visibility

This option determines how to display the Field group label.

 * Hidden: doesn't print anything
 * Above table: prints the label above the table
 * Table caption: prints _only_ the label as a semantically correct <caption>
   element within the table
 * Below table: prints the label below the table

### Description visibility

This option determines how to display the Field group description text.

 * Hidden: doesn't print anything
 * Above table: prints the description text above the table
 * Below table: prints the description text below the table

### Column headers

Use "First column header" and "Second column header" to add a table header.

### Field label displaying

The module normally displays the field labels in the first column. But you can
control this behavior for every field in the table by configuring their "label
display". The default "Above" will display the label in the first column of the
table and the module will attempt to hide the label in the second column.
"Inline" and "Hidden" won't display the field label in the first column and the
module won't alter the display of the label in the second column.

In some cases it may be simpler to check the "Always show field label" option.
With this option, the module will attempt to display the field label for _every_
field in the first column. The label display option is ignored, and is best set
to "Hidden" to prevent the label from displaying in the second column as well.

### Empty label behavior

This setting determines how the module will deal with the situation of missing
labels, which happens in some cases or depending on your configuration of the
field label display. It can be set to always display the first cell of a row,
even if it will be empty, or you can choose to merge both cells. In that case
the cell will span the full width of the table.

HISTORY
-------

http://drupal.org/node/1320780

File

README.txt
View source
  1. SUMMARY
  2. -------
  3. This module extends the Field Group module and provides a "Table" group format,
  4. which renders the fields it contains in a table. The first column of the table
  5. contains the field labels and the second column contains the rendered fields.
  6. COMPARISON WITH OTHER MODULES
  7. -----------------------------
  8. Field group multiple: this module also offers a "Table" group formatter, but it
  9. was designed to deal with multivalued fields. As such, it renders every value
  10. of multivalued fields in their own table cell. Every row containing value n of
  11. all the fields in the group. This is an awesome way to un-clutter multivalued
  12. fields, but it also means the module requires all fields it contains to have
  13. the same cardinality and that some field types don't work very well. In
  14. contrast, this module will render the field value normally, embedded in a
  15. single table cell. For more information see: http://drupal.org/node/1480204
  16. REQUIREMENTS
  17. ------------
  18. * Field Group (http://drupal.org/project/field_group)
  19. INSTALLATION
  20. ------------
  21. * Ensure the module's dependencies are met
  22. * Install the module by placing it in sites/all/modules and enabling it
  23. * Profit!
  24. CONFIGURATION
  25. -------------
  26. Go to any "Manage form display" or "Manage display" page where you would like
  27. to add your field group, and create a field group as usual. Now you can choose
  28. "Table" as the group format.
  29. ### Label visibility
  30. This option determines how to display the Field group label.
  31. * Hidden: doesn't print anything
  32. * Above table: prints the label above the table
  33. * Table caption: prints _only_ the label as a semantically correct
  34. element within the table
  35. * Below table: prints the label below the table
  36. ### Description visibility
  37. This option determines how to display the Field group description text.
  38. * Hidden: doesn't print anything
  39. * Above table: prints the description text above the table
  40. * Below table: prints the description text below the table
  41. ### Column headers
  42. Use "First column header" and "Second column header" to add a table header.
  43. ### Field label displaying
  44. The module normally displays the field labels in the first column. But you can
  45. control this behavior for every field in the table by configuring their "label
  46. display". The default "Above" will display the label in the first column of the
  47. table and the module will attempt to hide the label in the second column.
  48. "Inline" and "Hidden" won't display the field label in the first column and the
  49. module won't alter the display of the label in the second column.
  50. In some cases it may be simpler to check the "Always show field label" option.
  51. With this option, the module will attempt to display the field label for _every_
  52. field in the first column. The label display option is ignored, and is best set
  53. to "Hidden" to prevent the label from displaying in the second column as well.
  54. ### Empty label behavior
  55. This setting determines how the module will deal with the situation of missing
  56. labels, which happens in some cases or depending on your configuration of the
  57. field label display. It can be set to always display the first cell of a row,
  58. even if it will be empty, or you can choose to merge both cells. In that case
  59. the cell will span the full width of the table.
  60. HISTORY
  61. -------
  62. http://drupal.org/node/1320780