You are here

README.txt in Field collection 7

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

 * Introduction
 * Requirements
 * Installation
 * Configuration
 * Using field collection with entity translation
 * 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:

 * Entity API (https://www.drupal.org/project/entity)


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

Install as you would normally install a contributed Drupal. See:
https://drupal.org/documentation/install/modules-themes/modules-7 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" project 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
    project might provide such widgets itself too.


USING FIELD COLLECTION WITH ENTITY TRANSLATION
-----------

  * Field Collection items must be selected as a translatable entity type at
    Admin -> Config -> Regional -> Entity Translation.

  * The common use case is to leave the field collection field untranslatable
    and set the necessary fields inside it to translatable.  There is currently
    a known issue where a host can not be translated unless it has at least
    one other field that is translatable, even if some fields inside one of
    its field collections are translatable.

  * The alternate use case is to make the field collection field in the host
    translatable.  If this is done it does not matter whether the inner fields
    are set to translatable or not, they will all be translatable as every
    language for the host will have a completely separate copy of the field
    collection item(s).

  * When using nested field collections, the configuration of the fields and
    field collections is very important. The recommended approach is to first
    enable entity translation as defined in step 1, and set the outer
    field collection field as translatable and all its sub-fields to language
    undefined. The sub-field collections and its sub-fields should also be
    set to language undefined. This will ensure that every language of the host
    will have a completely separate copy of the field collection item(s) and
    its fields.


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. * Introduction
  4. * Requirements
  5. * Installation
  6. * Configuration
  7. * Using field collection with entity translation
  8. * Maintainers
  9. INTRODUCTION
  10. ------------
  11. Provides a field collection field to which any number of fields can be attached.
  12. Each field collection item is internally represented as an entity, which is
  13. referenced via the field collection field in the host entity. While
  14. conceptually field collections are treated as part of the host entity, each
  15. field collection item may also be viewed and edited separately.
  16. REQUIREMENTS
  17. ------------
  18. This project require the following projects:
  19. * Entity API (https://www.drupal.org/project/entity)
  20. INSTALLATION
  21. ------------
  22. Install as you would normally install a contributed Drupal. See:
  23. https://drupal.org/documentation/install/modules-themes/modules-7 for further
  24. information.
  25. CONFIGURATION
  26. -------------
  27. * Add a field collection field to any entity, e.g. to a node. For that use the
  28. the usual "Manage fields" interface provided by the "field ui" project of
  29. Drupal, e.g "Admin -> Structure -> Content types -> Article -> Manage fields"
  30. * Then go to "Admin -> Structure-> Field Collection" to define some fields for
  31. the created field collection.
  32. * By the default, the field collection is not shown during editing of the host
  33. entity. However, some links for adding, editing or deleting field collection
  34. items is shown when the host entity is viewed.
  35. * Widgets for embedding the form for creating field collections in the
  36. host-entity can be provided by any module. In future the field collection
  37. project might provide such widgets itself too.
  38. USING FIELD COLLECTION WITH ENTITY TRANSLATION
  39. -----------
  40. * Field Collection items must be selected as a translatable entity type at
  41. Admin -> Config -> Regional -> Entity Translation.
  42. * The common use case is to leave the field collection field untranslatable
  43. and set the necessary fields inside it to translatable. There is currently
  44. a known issue where a host can not be translated unless it has at least
  45. one other field that is translatable, even if some fields inside one of
  46. its field collections are translatable.
  47. * The alternate use case is to make the field collection field in the host
  48. translatable. If this is done it does not matter whether the inner fields
  49. are set to translatable or not, they will all be translatable as every
  50. language for the host will have a completely separate copy of the field
  51. collection item(s).
  52. * When using nested field collections, the configuration of the fields and
  53. field collections is very important. The recommended approach is to first
  54. enable entity translation as defined in step 1, and set the outer
  55. field collection field as translatable and all its sub-fields to language
  56. undefined. The sub-field collections and its sub-fields should also be
  57. set to language undefined. This will ensure that every language of the host
  58. will have a completely separate copy of the field collection item(s) and
  59. its fields.
  60. MAINTAINERS
  61. -----------
  62. Current maintainers:
  63. * Joel Muzzerall (jmuzz) - https://www.drupal.org/user/2607886
  64. * Joel Farris (Senpai) - https://www.drupal.org/user/65470
  65. * Lee Rowlands (larowlan) - https://www.drupal.org/user/395439
  66. * Nedjo Rogers (nedjo) - https://www.drupal.org/user/4481
  67. * Ra Mänd (ram4nd) - https://www.drupal.org/user/601534
  68. * Renato Gonçalves (RenatoG) - https://www.drupal.org/user/3326031
  69. * Wolfgang Ziegler (fago) - https://www.drupal.org/user/16747