diff --git a/README.txt b/README.txt index 6c72570..dfae90d 100644 --- a/README.txt +++ b/README.txt @@ -1,6 +1,17 @@ +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). + 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. @@ -32,36 +43,58 @@ Available group types: To submit bug reports and feature suggestions, or to track changes: http://drupal.org/project/issues/field_group --- 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. +REQUIREMENTS +------------ +Important for paragraph users: Make sure you apply the following paragraphs +patch: https://www.drupal.org/project/paragraphs/issues/2907094 + +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. +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. + 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. - 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. +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. + 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. + 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 -- +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 -- - +Inspirators: yched - http://drupal.org/user/39567