Skip to content

Commit

Permalink
Add user manual for "links to item" view
Browse files Browse the repository at this point in the history
  • Loading branch information
pgrunewald committed May 23, 2023
1 parent 42dbb7d commit dd7ed64
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 0 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/source/user-manual/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,5 @@ Note that the audience for these sources may be a Developer, not an Editor, and
blocks
copy-paste-blocks
links-to-item
```
37 changes: 37 additions & 0 deletions docs/source/user-manual/links-to-item.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
myst:
html_meta:
"description": "User manual on how to find all links to the current item."
"property=og:description": "User manual on how to find all links to the current item."
"property=og:title": "Finding links to the current item."
"keywords": "Volto, Plone, frontend, React, User manual, links"
---

(links-to-item-label)=

# Finding links to the current item

Sometimes it can be hard to keep track from where a certain page is referenced.
This is especially true whenever you want to reconstruct your website with a greater number of objects being moved or deleted.
For this situation, you can visit the {guilabel}`Links to item` page, which is an overview of all objects that refererence a certain object.

```{note}
An item references another item by creating a hyperlink to this item, using the item in a block, or using it in the {guilabel}`Related Items` field.
```

# Links to item view

In the toolbar on the left side you can click on the item with the three horizontally-aligned dots (called {guilabel}`More Menu`).
Click then on the item labeled {guilabel}`Links to item`.

You can see now a table displaying all links to the current item.

```{image} ../_static/user-manual/manage/link-to-items.png
:alt: A panel captioned with "Links to My Summer Vacation - Day 2". A table with two columns (first column labeled with "linked by this item", second column labeled with "review state"). In the row appears a link titled "Links to My Summer Vacation - Day 1", because it is referencing the current item.
```

For editors this view gives insight, if those links are still relevant or not.
On second sight, it also helps to prevent potential broken links.

For example, when you try to delete this page with other pages linking to it, you will get a warning that this will cause broken links that lead to a "not found" error page.
If you receive such a warning, you can inspect this view and go through each referencing page, removing any references.

0 comments on commit dd7ed64

Please sign in to comment.