Commit f22e061a authored by renatog's avatar renatog Committed by Renato Gonçalves H
Browse files

Issue #3029518 by RenatoG: Update documentation of Field Collection

parent 0a33fc68
Field collection
-----------------
Provides a field collection field, to which any number of fields can be attached.
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
......@@ -8,27 +20,43 @@ conceptually field collections are treated as part of the host entity, each
field collection item may also be viewed and edited separately.
Usage
------
REQUIREMENTS
------------
This project require the following projects:
* Entity API (https://www.drupal.org/project/entity)
* 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" module of
Drupal, e.g. "Admin -> Structure-> Content types -> Article -> Manage fields".
INSTALLATION
------------
* Then go to "Admin -> Structure-> Field collection" to define some fields for
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
* 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
* 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.
project might provide such widgets itself too.
Using field collection with entity translation
-----------------------------------------------
USING FIELD COLLECTION WITH ENTITY TRANSLATION
-----------
* Field collection items must be selected as a translatable entity type at
Admin -> Config -> Regional -> Entity Translation.
......@@ -52,4 +80,17 @@ field collection item may also be viewed and edited separately.
undefined. Also the sub-field collections and it’s sub-fields should 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
it’s fields.
\ No newline at end of file
it’s 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
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment