You are here

Home » API reference » Field collection 8.3

README.txt in Field collection 8.3

Same filename and directory in other branches
  1. 8 README.txt
  2. 8.2 README.txt
  3. 7 README.txt
CONTENTS OF THIS FILE
---------------------
   
 * Introduction
 * Requirements
 * Installation
 * Configuration
 * Restrictions
 * Maintainers


INTRODUCTION
------------

Provides a field collection field to which any number of fields can be attached.

Each field collection item is internally represented as an entity, which is
referenced via the field collection field in the host entity. While
conceptually field collections are treated as part of the host entity, each
field collection item may also be viewed and edited separately.


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

This project require the following projects:

 * Field (https://www.drupal.org/docs/8/core/modules/field)


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

Install as you would normally install a contributed Drupal projects. See:
https://drupal.org/documentation/install/modules-themes/modules-8 for further
information.


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

 * Add a field collection field to any entity, e.g. to a node. For that use the
   the usual "Manage fields" interface provided by the "field ui" of Drupal
   E.g. "Admin -> Structure-> Content types -> Article -> Manage fields".
    
 * Then go to "Admin -> Structure-> Field collection" to define some fields for
   the created field collection.
   
 * By the default, the field collection is not shown during editing of the host
    entity. However, some links for adding, editing or deleting field collection
    items is shown when the host entity is viewed.
  
 * Widgets for embedding the form for creating field collections in the
    host-entity can be provided by any module. In future the field collection
    module might provide such widgets itself too.


RESTRICTIONS
-------------

 * As of now, the field collection field does not properly respect different
   languages of the host entity. Thus, for now it is suggested to only use the
   field for entities that are not translatable.


MAINTAINERS
-----------

Current maintainers:
 * Joel Muzzerall (jmuzz) - https://www.drupal.org/user/2607886
 * Joel Farris (Senpai) - https://www.drupal.org/user/65470
 * Lee Rowlands (larowlan) - https://www.drupal.org/user/395439
 * Nedjo Rogers (nedjo) - https://www.drupal.org/user/4481
 * Ra Mänd (ram4nd) - https://www.drupal.org/user/601534
 * Renato Gonçalves (RenatoG) - https://www.drupal.org/user/3326031
 * Wolfgang Ziegler (fago) - https://www.drupal.org/user/16747

File

README.txt
View source 
  1. CONTENTS OF THIS FILE

  2. ---------------------

  3.    

  4.  * Introduction

  5.  * Requirements

  6.  * Installation

  7.  * Configuration

  8.  * Restrictions

  9.  * Maintainers

  10. 

  11. 

  12. INTRODUCTION

  13. ------------

  14. 

  15. Provides a field collection field to which any number of fields can be attached.

  16. 

  17. Each field collection item is internally represented as an entity, which is

  18. referenced via the field collection field in the host entity. While

  19. conceptually field collections are treated as part of the host entity, each

  20. field collection item may also be viewed and edited separately.

  21. 

  22. 

  23. REQUIREMENTS

  24. ------------

  25. 

  26. This project require the following projects:

  27. 

  28.  * Field (https://www.drupal.org/docs/8/core/modules/field)

  29. 

  30. 

  31. INSTALLATION

  32. ------------

  33. 

  34. Install as you would normally install a contributed Drupal projects. See:

  35. https://drupal.org/documentation/install/modules-themes/modules-8 for further

  36. information.

  37. 

  38. 

  39. CONFIGURATION

  40. -------------

  41. 

  42.  * Add a field collection field to any entity, e.g. to a node. For that use the

  43.    the usual "Manage fields" interface provided by the "field ui" of Drupal

  44.    E.g. "Admin -> Structure-> Content types -> Article -> Manage fields".

  45.     

  46.  * Then go to "Admin -> Structure-> Field collection" to define some fields for

  47.    the created field collection.

  48.    

  49.  * By the default, the field collection is not shown during editing of the host

  50.     entity. However, some links for adding, editing or deleting field collection

  51.     items is shown when the host entity is viewed.

  52.   

  53.  * Widgets for embedding the form for creating field collections in the

  54.     host-entity can be provided by any module. In future the field collection

  55.     module might provide such widgets itself too.

  56. 

  57. 

  58. RESTRICTIONS

  59. -------------

  60. 

  61.  * As of now, the field collection field does not properly respect different

  62.    languages of the host entity. Thus, for now it is suggested to only use the

  63.    field for entities that are not translatable.

  64. 

  65. 

  66. MAINTAINERS

  67. -----------

  68. 

  69. Current maintainers:

  70.  * Joel Muzzerall (jmuzz) - https://www.drupal.org/user/2607886

  71.  * Joel Farris (Senpai) - https://www.drupal.org/user/65470

  72.  * Lee Rowlands (larowlan) - https://www.drupal.org/user/395439

  73.  * Nedjo Rogers (nedjo) - https://www.drupal.org/user/4481

  74.  * Ra Mänd (ram4nd) - https://www.drupal.org/user/601534

  75.  * Renato Gonçalves (RenatoG) - https://www.drupal.org/user/3326031

  76.  * Wolfgang Ziegler (fago) - https://www.drupal.org/user/16747