Skip to content

Commit

Permalink
Breadcrumbs
Browse files Browse the repository at this point in the history
  • Loading branch information
rosiel committed May 2, 2024
1 parent 67d07a6 commit fec3a40
Show file tree
Hide file tree
Showing 4 changed files with 33 additions and 0 deletions.
Binary file added docs/assets/breadcrumbs-config-screen.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/breadcrumbs-example.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
32 changes: 32 additions & 0 deletions docs/user-documentation/breadcrumbs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Breadcrumbs

Breadcrumbs are a Drupal concept. They provide a hierarchical path
of links to "ancestors" of the current content item.

![example of breadcrumbs](../assets/breadcrumbs-example.png)

## Islandora Breadcrumbs

Islandora provides a module, "Islandora Breadcrumbs" (a submodule
of the Islandora module) that creates breadcrumbs based on the value
of configured reference fields (by default, `field_member_of`).
To use Islandora Breadcrumbs, simply enable
the module. Islandora breadcrumbs will apply to nodes that have
the configured Entity Reference fields.

There are a few configuration options for this module, accessible at
**Manage** > **Configuration** > **Islandora** > **Breadcrumbs
Settings** (`/admin/config/islandora/breadcrumbs`). These include:

* Maximum number of ancestor breadcrumbs - an optional feature to
stop adding "ancestor" links after a certain number
* Include the current node in the breadcrumbs?
* Entity Reference fields to follow - if you're using other fields
to refer to parents, you can add them here.

![configuration screen](../assets/breadcrumbs-config-screen.png)

## Troubleshooting Breadcrumbs

Breadcrumbs are cached, so if you aren't seeing the results that
you expect, try clearing the Drupal cache.
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -208,6 +208,7 @@ nav:
# Conceptual and pragmatic, for repository managers.
- Administering Islandora:
- 'Access control': 'user-documentation/access-control.md'
- 'Breadcrumbs': 'user-documentation/breadcrumbs.md'
- 'JWT authentication': 'user-documentation/jwt-authentication.md'
# moved from Developer documentation
- 'URL Aliases': 'user-documentation/url-aliases.md'
Expand Down

0 comments on commit fec3a40

Please sign in to comment.