References (not just links) to item (view and menu item) – Update to released plone.restapi.relations #4842
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -1,37 +1,37 @@ | ||||||
| --- | ||||||
| myst: | ||||||
| html_meta: | ||||||
| "description": "User manual on how to find all links and relations to the current item." | ||||||
| "property=og:description": "User manual on how to find all links and relations to the current item." | ||||||
| "property=og:title": "Finding links and relations to the current item." | ||||||
| "keywords": "Volto, Plone, frontend, React, User manual, links, relations, references, related content" | ||||||
| --- | ||||||
|
|
||||||
| (links-to-item-label)= | ||||||
|
|
||||||
| # Finding links and references to the current page | ||||||
|
|
||||||
| 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 and references` page, which is an overview of all content items that refererence a certain content item. | ||||||
ksuess marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
|
|
||||||
| ```{note} | ||||||
| An item references another item by creating a hyperlink to this item, using the item in a block, referencing it in the {guilabel}`Related Items` field, or referencing it in a relation field. | ||||||
| ``` | ||||||
|
|
||||||
| ## {guilabel}`Links and references` 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 and references`. | ||||||
|
|
||||||
| You can see now a table displaying all links and references to the current item. | ||||||
|
|
||||||
| ```{image} ../_static/user-manual/manage/link-to-items.png | ||||||
| :alt: A panel captioned with "Links and references to 'My Summer Vacation - Day 2'". A table with three columns (first column labeled with "Linking / referencing this item…", second column labeled with "Review state", third column labeled with "Type"). In the row appears a link titled "Links to My Summer Vacation - Day 1", because it is referencing the current item. | ||||||
|
There was a problem hiding this comment.
Suggested change
There was a problem hiding this comment. I applied your suggestion and tried to find wording for the fact that the table is generative: the two relations "hyperlink in text" and "related items" and further more if there are custom relations and items that are relating with these custom relations. Hope that is understandable? There was a problem hiding this comment. If it is too difficult to describe in words, maybe the table is too complex? Maybe it would be easier to have three tables, instead of three sections in one table? Then we don't have do alt text gymnastics. I don't know whether mentioning the table is generative would be helpful, and would cause further confusion. Anyway, when I get stuck on what to do, I usually go with the simpler method. |
||||||
| ``` | ||||||
|
|
||||||
| For editors, this view gives insight to whether those links and references are still relevant. | ||||||
| On second sight, it also helps to prevent potential broken links and relations. | ||||||
|
|
||||||
| 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 or relations 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. | ||||||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would it be possible to reduce the image width by resizing the browser width for legibility? Images should be no wider than 740 pixels to fit within the documentation's main view port.
https://6.docs.plone.org/contributing/documentation/authors.html#plone-documentation-styleguide
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Of course, thanks for the hint. Changed in c4106b0