You are here

Home » API reference » Menu Breadcrumb 2.0.x

README.txt in Menu Breadcrumb 2.0.x

Same filename and directory in other branches
  1. 8 README.txt
  2. 6 README.txt
  3. 7 README.txt
MENU BREADCRUMBS
================

Introduction
------------
The Drupal 7 version of this module implemented the Drupal 6 behaviour of
using the menu position of the current page for the breadcrumb.  It also
added an option to append the page title to the breadcrumb (either as
a clickable url or not), saving the trouble of doing this in the theme,
and hiding the breadcrumb if it only contained the link to the front page.

The Drupal 8 version also supports "Taxonomy Attachment" for each
menu, which provides the same breadcrumb trail to the current
page as to a taxonomy of which it is a member: effectively giving
menu based breadcrumbs to items that aren't on a menu (e.g., blog
entries). Effectively these are "attached" to the breadcrumb trail by
taxonomy membership, inheriting the breadcrumbs of their taxonomy.

Options in the Drupal 8 version therefore also include the ability to
add the current page title, linked or not, as an additional breadcrumb
when a taxonomy attachment has taken place.  More detailed options are
given for dealing with the front page, allowing it to be added or removed.

Installation & Upgrading - RECOMMENDED
--------------------------------------
Follow current instructions on this Drupal documentation page
to install Menu Breadcrumb as a site dependency and upgrade it
along with other site dependencies (as well as Drupal Core itself):

* https://www.drupal.org/node/2718229

IF YOU SEE AN ERROR PAGE similar to the following after up- or down-grading the module:

TypeError: Argument <X> passed to Drupal\menu_breadcrumb\MenuBasedBreadcrumbBuilder::__construct() ...

... you probably just need to rebuild the cache between two versions that use
different argument lists (i.e. system services).  See here for how to rebuild cache:

https://www.drupal.org/docs/user_guide/en/prevent-cache-clear.html

Installation & Upgrading - without Composer
-------------------------------------------

Installation, on older Drupal versions & sites:
1. Copy the menu_breadcrumb folder to your modules/contrib directory.
2. At Administer -> Extend (admin/modules) enable the module.
3. Configure the module settings at Administer -> Configuration ->
     User Interface (admin/config/user-interface/menu-breadcrumb).

Upgrading on older Drupal versions & sites:
Recommended: install drush and run "drush up"

Manually: replace the older menu_breadcrumb folder with the newer version;
then run "update.php" if present (to install any configuration changes).

Since different versions of the module may use different services, if you see
errors:

- Try clearing the cache, which fixes breacrumb on taxonomy pages (since this
  module's breadcrumb builder needs to be acknolwedged as higher priority).
- Clearing the cache (at least the router cache) should clear up messages about
  any services missing (known issue upgrading beta1 to beta2).
- If all else fails, try uninstalling & reinstalling the module.


Features
--------
- For a high-level description, see the Drupal 8 Help screen for this module.
- All other features are described by each checkbox on the Configuration page,
  and in the notes on the re-orderable menu list below.

Issues / Feature requests
-------------------------
If you find a bug, or have a feature request, please go to :

http://drupal.org/project/issues/menu_breadcrumb

File

README.txt
View source 
  1. 

  2. MENU BREADCRUMBS

  3. ================

  4. 

  5. Introduction

  6. ------------

  7. The Drupal 7 version of this module implemented the Drupal 6 behaviour of

  8. using the menu position of the current page for the breadcrumb.  It also

  9. added an option to append the page title to the breadcrumb (either as

  10. a clickable url or not), saving the trouble of doing this in the theme,

  11. and hiding the breadcrumb if it only contained the link to the front page.

  12. 

  13. The Drupal 8 version also supports "Taxonomy Attachment" for each

  14. menu, which provides the same breadcrumb trail to the current

  15. page as to a taxonomy of which it is a member: effectively giving

  16. menu based breadcrumbs to items that aren't on a menu (e.g., blog

  17. entries). Effectively these are "attached" to the breadcrumb trail by

  18. taxonomy membership, inheriting the breadcrumbs of their taxonomy.

  19. 

  20. Options in the Drupal 8 version therefore also include the ability to

  21. add the current page title, linked or not, as an additional breadcrumb

  22. when a taxonomy attachment has taken place.  More detailed options are

  23. given for dealing with the front page, allowing it to be added or removed.

  24. 

  25. Installation & Upgrading - RECOMMENDED

  26. --------------------------------------

  27. Follow current instructions on this Drupal documentation page

  28. to install Menu Breadcrumb as a site dependency and upgrade it

  29. along with other site dependencies (as well as Drupal Core itself):

  30. 

  31. * https://www.drupal.org/node/2718229

  32. 

  33. IF YOU SEE AN ERROR PAGE similar to the following after up- or down-grading the module:

  34. 

  35. TypeError: Argument  passed to Drupal\menu_breadcrumb\MenuBasedBreadcrumbBuilder::__construct() ...

  36. 

  37. ... you probably just need to rebuild the cache between two versions that use

  38. different argument lists (i.e. system services).  See here for how to rebuild cache:

  39. 

  40. https://www.drupal.org/docs/user_guide/en/prevent-cache-clear.html

  41. 

  42. Installation & Upgrading - without Composer

  43. -------------------------------------------

  44. 

  45. Installation, on older Drupal versions & sites:

  46. 1. Copy the menu_breadcrumb folder to your modules/contrib directory.

  47. 2. At Administer -> Extend (admin/modules) enable the module.

  48. 3. Configure the module settings at Administer -> Configuration ->

  49.      User Interface (admin/config/user-interface/menu-breadcrumb).

  50. 

  51. Upgrading on older Drupal versions & sites:

  52. Recommended: install drush and run "drush up"

  53. 

  54. Manually: replace the older menu_breadcrumb folder with the newer version;

  55. then run "update.php" if present (to install any configuration changes).

  56. 

  57. Since different versions of the module may use different services, if you see

  58. errors:

  59. 

  60. - Try clearing the cache, which fixes breacrumb on taxonomy pages (since this

  61.   module's breadcrumb builder needs to be acknolwedged as higher priority).

  62. - Clearing the cache (at least the router cache) should clear up messages about

  63.   any services missing (known issue upgrading beta1 to beta2).

  64. - If all else fails, try uninstalling & reinstalling the module.

  65. 

  66. 

  67. Features

  68. --------

  69. - For a high-level description, see the Drupal 8 Help screen for this module.

  70. - All other features are described by each checkbox on the Configuration page,

  71.   and in the notes on the re-orderable menu list below.

  72. 

  73. Issues / Feature requests

  74. -------------------------

  75. If you find a bug, or have a feature request, please go to :

  76. 

  77. http://drupal.org/project/issues/menu_breadcrumb