README.md | 31 ++++++++++++++++--------------- entity_embed.info.yml | 2 +- 2 files changed, 17 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 75fc586..db06db2 100644 --- a/README.md +++ b/README.md @@ -2,41 +2,42 @@ [![Travis build status](https://img.shields.io/travis/drupal-media/entity_embed/8.x-1.x.svg)](https://travis-ci.org/drupal-media/entity_embed) [![Scrutinizer code quality](https://img.shields.io/scrutinizer/g/drupal-media/entity_embed/8.x-1.x.svg)](https://scrutinizer-ci.com/g/drupal-media/entity_embed) -[Entity Embed](https://www.drupal.org/project/entity_embed) module allows any entity to be embedded using a WYSIWYG and text format. +[Entity Embed](https://www.drupal.org/project/entity_embed) module allows any entity to be embedded using a text editor. ## Requirements -* Latest dev release of Drupal 8.x as this module will not work with the last - alpha release. +* Drupal 8 * [Embed](https://www.drupal.org/project/embed) module ## Installation -* Entity Embed can be installed via the [standard Drupal installation process](http://drupal.org/node/895232) +Entity Embed can be installed via the [standard Drupal installation process](http://drupal.org/node/895232). ## Configuration * Install and enable [Embed](https://www.drupal.org/project/embed) module. * Install and enable [Entity Embed](https://www.drupal.org/project/entity_embed) module. -* Enable the entity-embed filter 'Display embedded entities' for the desired text formats from the configuration page: `/admin/config/content/formats`. -* Add `````` to the 'Allowed HTML tags' -* To enable the WYSIWYG plugin, drag and drop the entity-embed 'E' button into the Active toolbar for the desired text formats from the configuration page: `/admin/config/content/formats/manage/`. +* Go to the 'Text formats and editors' configuration page: `/admin/config/content/formats`, and for each text format/editor combo where you want to embed entities, do the following: + * Enable the 'Display embedded entities' filter. + * Drag and drop the 'E' button into the Active toolbar. + * If the text format uses the 'Limit allowed HTML tags and correct faulty HTML' filter, ensure the necessary tags and attributes are whitelisted: add `````` to the 'Allowed HTML tags' setting. (Will happen automatically after https://www.drupal.org/node/2554687.) ## Usage -* Create a new content, in body click over entity-embed E button. -* Enter title and choose one from suggestions. -* Choose **Display as** from following options: +* For example, create a new *Article* content. +* Click on the 'E' button in the text editor. +* Enter part of the title of the entity you're looking for and select one of the search results. +* For **Display as**, choose one of the following options: * Rendered Entity * Entity ID * Label -* Choose **View mode** (if chosen **Rendered Entity**) from following options: +* If chosen **Rendered Entity**, choose one of the following options for **View mode**: * Default * Full content * RSS * Search index * Search result highlighting input -* Choose alignment: none, left, center or right. +* Optionally, choose to align left, center or right. ## Embedding entities without WYSIWYG @@ -44,15 +45,15 @@ Users should be embedding entities using the CKEditor WYSIWYG button as describe ### Embed by UUID (recommended): ```html -
+ ``` ### Embed by ID (not recommended): ```html -
+ ``` -### Display Plugins +### Entity Embed Display Plugins Embedding entities uses an entity embed display plugin, provided in the `data-entity-embed-display` attribute. By default we provide four different display plugins out of the box: diff --git a/entity_embed.info.yml b/entity_embed.info.yml index 54f0b3b..4868f1e 100644 --- a/entity_embed.info.yml +++ b/entity_embed.info.yml @@ -1,6 +1,6 @@ name: Entity Embed type: module -description: 'Allows entities to be rendered using a text format.' +description: 'Allows entities to be embedded using a text editor.' core: 8.x package: Filters dependencies: