You are here

README.txt in Field Group 8.3

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

 * Introduction
 * Requirements
 * Installation
 * Configuration
 * Maintainers

INTRODUCTION
------------
History:
  Field_group was originally written when drupal 7 was released. For drupal 6,
  the module is located in the CCK module (http://drupal.org/project/cck).
  As drupal core has a fields API drupal > 6, the field_group module
  is considered a contribution.

Description:
  field_group is a module that will group a set of fields. In Drupal8,
  with fields, one means all fields that come from fieldable entities.
  You can add fieldgroups in several types with their own format settings.
  field_group uses plugins to add your own formatter and rendering for
  it.
  One of the biggest improvements to previous versions, is that fieldgroups
  have unlimited nesting, better display control.
  Note that field_group will only group fields, it can not be used to hide
  certain fields since this a permission matter.

Module project page:
  http://drupal.org/project/field_group

Documentation page (D7 version):
  http://drupal.org/node/1017838
  http://drupal.org/node/1017962

Available group types:
  - Html element
  - Fieldsets
  - Tabs (horizontal and vertical)
  - Accordions
  - Details (Use this if you want collapsible fieldsets)
  - Details Sidebar

To submit bug reports and feature suggestions, or to track changes:
  http://drupal.org/project/issues/field_group

REQUIREMENTS
------------
None.

INSTALLATION
------------
Install as you would normally install a contributed Drupal module. Visit:
https://www.drupal.org/documentation/install/modules-themes/modules-8
for further information.

CONFIGURATION
-------------
1. You can configure the field groups for different displays like, in
managed_form_display and managed_display of the entity type.
2. You can create different field groups under managed_form_display by
adding a new group under "Add new group" label and the format the
grouping using the desired formatter for displaying the same.
3. Same thing can be done in managed_display.
4. The field grouping done in managed display will be reflected on the
view detail page of the entity, while that done in the
managed_form_display will be reflected in the add/edit form of the entity.

-- Create field groups --
This section explains how to create groups of fields according to the type chosen.
    - Fieldsets : This group of fields makes the internal content in a fieldset.
                  It is possible to add a title and a caption (which appears at
                  the bottom of the fieldset).
    - Details : Similar to Fieldsets. You can configure them to be open (normal
                fieldset) or collapsed.
    - Details Sidebar: Similar to Details. You can configure them to be open
                (normal fieldset) or collapsed and move them in the sidebar on
                the node form.
    - Html element : This fieldgroup renders the inner content in a HTML element.
                     You can configure attributes and label element.
The following two groupings works differently because you must associate them with
an other grouping.
    - Accordions : This group of fields makes the child groups as a jQuery accordion.
                   As a first step you must create an Accordions group. You can set a
                   label and choose an effect. Then you can create an Accordion
                   Item as a child. This group can contain fields.
    - Tabs : This fieldgroup renders child groups in its own tabs wrapper.
             As a first step you must create an Tabs group. You can set
             choose if you want that your tabs are show horizontally or vertically.
             Then, you can create Tab as a child and choose one to be open by default.
             This group can contain fields.
For all groups, you can add id or classes.
You can also choose if you want to mark a group as required if one of his fields is
require (except for Accordions and Tabs : you must passed by their children).

MAINTAINERS
-----------
stalski - http://drupal.org/user/322618
zuuperman - http://drupal.org/user/361625
swentel - http://drupal.org/user/107403

Inspirators:
yched - http://drupal.org/user/39567

File

README.txt
View source
  1. CONTENTS OF THIS FILE
  2. ---------------------
  3. * Introduction
  4. * Requirements
  5. * Installation
  6. * Configuration
  7. * Maintainers
  8. INTRODUCTION
  9. ------------
  10. History:
  11. Field_group was originally written when drupal 7 was released. For drupal 6,
  12. the module is located in the CCK module (http://drupal.org/project/cck).
  13. As drupal core has a fields API drupal > 6, the field_group module
  14. is considered a contribution.
  15. Description:
  16. field_group is a module that will group a set of fields. In Drupal8,
  17. with fields, one means all fields that come from fieldable entities.
  18. You can add fieldgroups in several types with their own format settings.
  19. field_group uses plugins to add your own formatter and rendering for
  20. it.
  21. One of the biggest improvements to previous versions, is that fieldgroups
  22. have unlimited nesting, better display control.
  23. Note that field_group will only group fields, it can not be used to hide
  24. certain fields since this a permission matter.
  25. Module project page:
  26. http://drupal.org/project/field_group
  27. Documentation page (D7 version):
  28. http://drupal.org/node/1017838
  29. http://drupal.org/node/1017962
  30. Available group types:
  31. - Html element
  32. - Fieldsets
  33. - Tabs (horizontal and vertical)
  34. - Accordions
  35. - Details (Use this if you want collapsible fieldsets)
  36. - Details Sidebar
  37. To submit bug reports and feature suggestions, or to track changes:
  38. http://drupal.org/project/issues/field_group
  39. REQUIREMENTS
  40. ------------
  41. None.
  42. INSTALLATION
  43. ------------
  44. Install as you would normally install a contributed Drupal module. Visit:
  45. https://www.drupal.org/documentation/install/modules-themes/modules-8
  46. for further information.
  47. CONFIGURATION
  48. -------------
  49. 1. You can configure the field groups for different displays like, in
  50. managed_form_display and managed_display of the entity type.
  51. 2. You can create different field groups under managed_form_display by
  52. adding a new group under "Add new group" label and the format the
  53. grouping using the desired formatter for displaying the same.
  54. 3. Same thing can be done in managed_display.
  55. 4. The field grouping done in managed display will be reflected on the
  56. view detail page of the entity, while that done in the
  57. managed_form_display will be reflected in the add/edit form of the entity.
  58. -- Create field groups --
  59. This section explains how to create groups of fields according to the type chosen.
  60. - Fieldsets : This group of fields makes the internal content in a fieldset.
  61. It is possible to add a title and a caption (which appears at
  62. the bottom of the fieldset).
  63. - Details : Similar to Fieldsets. You can configure them to be open (normal
  64. fieldset) or collapsed.
  65. - Details Sidebar: Similar to Details. You can configure them to be open
  66. (normal fieldset) or collapsed and move them in the sidebar on
  67. the node form.
  68. - Html element : This fieldgroup renders the inner content in a HTML element.
  69. You can configure attributes and label element.
  70. The following two groupings works differently because you must associate them with
  71. an other grouping.
  72. - Accordions : This group of fields makes the child groups as a jQuery accordion.
  73. As a first step you must create an Accordions group. You can set a
  74. label and choose an effect. Then you can create an Accordion
  75. Item as a child. This group can contain fields.
  76. - Tabs : This fieldgroup renders child groups in its own tabs wrapper.
  77. As a first step you must create an Tabs group. You can set
  78. choose if you want that your tabs are show horizontally or vertically.
  79. Then, you can create Tab as a child and choose one to be open by default.
  80. This group can contain fields.
  81. For all groups, you can add id or classes.
  82. You can also choose if you want to mark a group as required if one of his fields is
  83. require (except for Accordions and Tabs : you must passed by their children).
  84. MAINTAINERS
  85. -----------
  86. stalski - http://drupal.org/user/322618
  87. zuuperman - http://drupal.org/user/361625
  88. swentel - http://drupal.org/user/107403
  89. Inspirators:
  90. yched - http://drupal.org/user/39567