You are here

Home » API reference » Menu Entity Index 8

README.txt in Menu Entity Index 8 

CONTENTS OF THIS FILE
---------------------

 * Introduction
 * Requirements
 * Recommended modules
 * Installation
 * Configuration
 * Maintainers


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

The Menu Entity Index module builds and maintains an index of Menu Link Content
entities and their referenced entities. It also provides some basic Views
integration for Menu Link Content entities.

Features provided by the module:

  * A database table that contains menu items and entities referenced by these
    menu items. Tracked information for each menu item includes menu name, menu
    level, entity type, bundle, entity id, uuid, langcode, parent entity type,
    parent id, parent uuid, target entity type, target bundle, target entity id
    and target langcode.

  * Basic Views integration for Menu Link Content entities.

  * A form field widget for entity forms that can be used to show a listing of
    all menu items that reference the entity on entity edit forms.

For a full description of the module, visit the project page:
https://www.drupal.org/menu_entity_index

To submit bug reports and feature suggestions, or to track changes:
https://www.drupal.org/node/add/project-issue/menu_entity_index


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

This module depends on the menu_link_content module provided by Drupal Core. If
you want to use the views integration, you also need the views module provided
by Drupal Core.


RECOMMENDED MODULES
-------------------

 * Views (provided by Drupal Core), if you want to use the views integration.


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

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


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

 * Go to the configuration page of the module at Configuration > Search and
   metadata > Menu Entity Index.

 * Configure the menus and entity types that should be included in Menu Entity
   Index. For example, to track all menu items in the main menu, that reference
   content or taxonomy term entities, add 'Main navigation' as a tracked menu
   and 'Content' and 'Taxonomy term' as tracked entity types and click on
   'Save configuration'.

 * A batch process that scans the selected menus for referenced entities will be
   initiated. Once this batch process has finished, the module will keep track
   of additions, updates or deletions of menu items itself and the module is
   ready to use.

 * If you want to show a listing of all menu items of an entity on its edit
   form, go to the 'Manage form display page' of its bundle/entity type. If
   tracking is enabled for that entity type, you'll see a new 'Menu links' field
   in the 'Disabled' region. Move it to the desired position to enable it and
   click on the 'Save' button.

 * Make sure to look over the permissions of the module. There is one permission
   to configure module settings and one permission to view the menu links form
   widget on entity edit forms.

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

Current maintainers:
 * Patrick Fey (feyp) - https://drupal.org/u/feyp
 * David Franke (mirroar) - https://drupal.org/u/mirroar

This project has been partly sponsored by:
 * werk21 GmbH
   werk21 is a full service agency from Berlin, Germany, for politics,
   government, organizations and NGOs. Together with its customers,
   werk21 has realized over 60 Drupal web sites (since version 5).
   Visit http://www.werk21.de for more information.

File

README.txt
View source 
  1. CONTENTS OF THIS FILE

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

  3. 

  4.  * Introduction

  5.  * Requirements

  6.  * Recommended modules

  7.  * Installation

  8.  * Configuration

  9.  * Maintainers

  10. 

  11. 

  12. INTRODUCTION

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

  14. 

  15. The Menu Entity Index module builds and maintains an index of Menu Link Content

  16. entities and their referenced entities. It also provides some basic Views

  17. integration for Menu Link Content entities.

  18. 

  19. Features provided by the module:

  20. 

  21.   * A database table that contains menu items and entities referenced by these

  22.     menu items. Tracked information for each menu item includes menu name, menu

  23.     level, entity type, bundle, entity id, uuid, langcode, parent entity type,

  24.     parent id, parent uuid, target entity type, target bundle, target entity id

  25.     and target langcode.

  26. 

  27.   * Basic Views integration for Menu Link Content entities.

  28. 

  29.   * A form field widget for entity forms that can be used to show a listing of

  30.     all menu items that reference the entity on entity edit forms.

  31. 

  32. For a full description of the module, visit the project page:

  33. https://www.drupal.org/menu_entity_index

  34. 

  35. To submit bug reports and feature suggestions, or to track changes:

  36. https://www.drupal.org/node/add/project-issue/menu_entity_index

  37. 

  38. 

  39. REQUIREMENTS

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

  41. 

  42. This module depends on the menu_link_content module provided by Drupal Core. If

  43. you want to use the views integration, you also need the views module provided

  44. by Drupal Core.

  45. 

  46. 

  47. RECOMMENDED MODULES

  48. -------------------

  49. 

  50.  * Views (provided by Drupal Core), if you want to use the views integration.

  51. 

  52. 

  53. INSTALLATION

  54. ------------

  55. 

  56.  * Install as you would normally install a contributed Drupal module. See:

  57.    https://www.drupal.org/documentation/install/modules-themes/modules-8

  58.    for further information.

  59. 

  60. 

  61. CONFIGURATION

  62. -------------

  63. 

  64.  * Go to the configuration page of the module at Configuration > Search and

  65.    metadata > Menu Entity Index.

  66. 

  67.  * Configure the menus and entity types that should be included in Menu Entity

  68.    Index. For example, to track all menu items in the main menu, that reference

  69.    content or taxonomy term entities, add 'Main navigation' as a tracked menu

  70.    and 'Content' and 'Taxonomy term' as tracked entity types and click on

  71.    'Save configuration'.

  72. 

  73.  * A batch process that scans the selected menus for referenced entities will be

  74.    initiated. Once this batch process has finished, the module will keep track

  75.    of additions, updates or deletions of menu items itself and the module is

  76.    ready to use.

  77. 

  78.  * If you want to show a listing of all menu items of an entity on its edit

  79.    form, go to the 'Manage form display page' of its bundle/entity type. If

  80.    tracking is enabled for that entity type, you'll see a new 'Menu links' field

  81.    in the 'Disabled' region. Move it to the desired position to enable it and

  82.    click on the 'Save' button.

  83. 

  84.  * Make sure to look over the permissions of the module. There is one permission

  85.    to configure module settings and one permission to view the menu links form

  86.    widget on entity edit forms.

  87. 

  88. MAINTAINERS

  89. -----------

  90. 

  91. Current maintainers:

  92.  * Patrick Fey (feyp) - https://drupal.org/u/feyp

  93.  * David Franke (mirroar) - https://drupal.org/u/mirroar

  94. 

  95. This project has been partly sponsored by:

  96.  * werk21 GmbH

  97.    werk21 is a full service agency from Berlin, Germany, for politics,

  98.    government, organizations and NGOs. Together with its customers,

  99.    werk21 has realized over 60 Drupal web sites (since version 5).

  100.    Visit http://www.werk21.de for more information.