You are here

README.txt in Crumbs, the Breadcrumbs suite 6.2

Same filename and directory in other branches
  1. 6 README.txt
  2. 7.2 README.txt
  3. 7 README.txt
This text is horribly out of date, especially for the 2.x branch ...


The ultimate breadcrumbs solution. Powerful, flexible, and as simple and DRY as can be.
(code will come soon)

Breadcrumbs based on:
- menus
- taxonomy
- system path fragments
- existing path alias fragments
- not yet existent pathauto alias fragments
- organic groups
- forum paths

Features:
- easy to extend.
- admin form to rearrange rules. no further configuration needed.
- guaranteed consistency: If d's breadcrumb is "a > b > c > d", then d's breadcrumb is "a > b > c".
- infinite loop prevention.

Requirements:
- PHP 5.2

How it works:
A plugin is an object that takes a path and returns a parent path.
If the rule returns NULL, the next rule is tried.

This process is repeated with the parent path, until either
- no further parent can be found.
- the returned path is the frontpage.
- the path is its own parent path.
- there is a loop consisting of more than one path.

In addition, every rule object has a chance to set a different title for a breadcrumb item (default is obtained from core menu system), or to let the item be skipped in the trail.











File

README.txt
View source
  1. This text is horribly out of date, especially for the 2.x branch ...
  2. The ultimate breadcrumbs solution. Powerful, flexible, and as simple and DRY as can be.
  3. (code will come soon)
  4. Breadcrumbs based on:
  5. - menus
  6. - taxonomy
  7. - system path fragments
  8. - existing path alias fragments
  9. - not yet existent pathauto alias fragments
  10. - organic groups
  11. - forum paths
  12. Features:
  13. - easy to extend.
  14. - admin form to rearrange rules. no further configuration needed.
  15. - guaranteed consistency: If d's breadcrumb is "a > b > c > d", then d's breadcrumb is "a > b > c".
  16. - infinite loop prevention.
  17. Requirements:
  18. - PHP 5.2
  19. How it works:
  20. A plugin is an object that takes a path and returns a parent path.
  21. If the rule returns NULL, the next rule is tried.
  22. This process is repeated with the parent path, until either
  23. - no further parent can be found.
  24. - the returned path is the frontpage.
  25. - the path is its own parent path.
  26. - there is a loop consisting of more than one path.
  27. In addition, every rule object has a chance to set a different title for a breadcrumb item (default is obtained from core menu system), or to let the item be skipped in the trail.