Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document Breadcrumbs #2300

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
- 'Usage statistics': 'user-documentation/usage-stats.md'
Expand Down
Loading