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

Links and references view via content menu [Add Links to item view] #4787

Merged
merged 24 commits into from
Jul 16, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
526ae34
Add `Links to item` view
pgrunewald May 18, 2023
5f45e83
Do not access outdated data from the storage
pgrunewald May 19, 2023
dfa4557
prettier
pgrunewald May 19, 2023
9aedb0f
Add test for LinksToItem component
pgrunewald May 19, 2023
3c9e143
Add user manual for "links to item" view
pgrunewald May 19, 2023
fa85c7e
Update docs/source/user-manual/links-to-item.md
stevepiercy May 23, 2023
1db5142
Update docs/source/user-manual/links-to-item.md
stevepiercy May 23, 2023
660ca52
Update docs/source/user-manual/links-to-item.md
stevepiercy May 23, 2023
8a8f29d
Add change log entry
pgrunewald May 25, 2023
d01d316
References (not just links) to item (view and menu item) – Update to …
ksuess Jun 14, 2023
60851df
yarn i18n
ksuess Jun 16, 2023
5aa22c6
Merge branch 'master' into links-to-item-view
ksuess Jun 20, 2023
40eae65
opt-out for "links and references" content menu item
ksuess Jun 20, 2023
6179f65
"Links and references" view also for site root
ksuess Jun 20, 2023
bb7b173
prettier
ksuess Jun 20, 2023
217f12a
Toolbar: Link to relations control panel (#4893)
ksuess Jun 20, 2023
4e0a0c3
Update 4842.feature
ksuess Jun 20, 2023
d1d8c9d
Apply suggestions from code review
ksuess Jun 21, 2023
07745f6
"Overview and management" -> "Overview" (management only for relation…
ksuess Jun 21, 2023
94602a4
Fix conditon for "links and references" menu item
ksuess Jun 30, 2023
914619f
Add one more relation type to test of 'links and references"
ksuess Jun 30, 2023
7315215
Merge branch 'master' into links-to-item-view
ksuess Jun 30, 2023
1c9f8b3
Merge branch 'master' into links-to-item-view
ksuess Jul 7, 2023
9ea3700
Merge branch 'master' into links-to-item-view
sneridagh Jul 16, 2023
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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 6 additions & 0 deletions docs/source/configuration/settings-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -381,6 +381,12 @@ additionalToolbarComponents
blockSettingsTabFieldsetsInitialStateOpen
A Boolean, `true` by default.
The fieldsets in the blocks settings tab start by default as non-collapsed (opened), you can decide to have them collapsed (closed) by default setting this to `false`.

excludeLinksAndReferencesMenuItem
A Boolean, `false` by default.
The content menu links to the {guilabel}`Links and references` view per default.
Exclude this menu item by setting `excludeLinksAndReferencesMenuItem` to `true`.

```


Expand Down
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 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 reference a certain content item.

```{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 to and references of the current item.

```{image} ../_static/user-manual/manage/link-to-items.png
:alt: A panel captioned with "Content that links to or references 'Supervisor Adélaïde Pickavance'". Below the caption, there is a table with one section per relation type, where each section has three columns. The first column's heading is the relation name, the second is "Review State", and the third is "Type". The sections are named, from top to bottom, "Linking this item with hyperlink in text", "Referencing the item as related item", and "Referencing this item with '[Name of Relation]'".
```

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.
39 changes: 39 additions & 0 deletions locales/ca/LC_MESSAGES/volto.po
Original file line number Diff line number Diff line change
Expand Up @@ -445,6 +445,7 @@ msgstr ""
#: components/manage/Controlpanels/UpgradeControlPanel
#: components/manage/Diff/Diff
#: components/manage/History/History
#: components/manage/LinksToItem/LinksToItem
#: components/manage/Multilingual/ManageTranslations
#: components/manage/Preferences/ChangePassword
#: components/manage/Preferences/PersonalPreferences
Expand Down Expand Up @@ -769,6 +770,11 @@ msgstr ""
msgid "Content rules from parent folders"
msgstr ""

#: components/manage/LinksToItem/LinksToItem
# defaultMessage: Content that links to or references {title}
msgid "Content that links to or references {title}"
msgstr ""

#: components/manage/Controlpanels/ContentTypes
# defaultMessage: Content type created
msgid "Content type created"
Expand Down Expand Up @@ -1959,6 +1965,17 @@ msgstr "Enllaç a"
msgid "Link translation for"
msgstr "Traducció d'enllaços per"

#: components/manage/LinksToItem/LinksToItem
# defaultMessage: Linking this item with hyperlink in text
msgid "Linking this item with hyperlink in text"
msgstr ""

#: components/manage/LinksToItem/LinksToItem
#: components/manage/Toolbar/More
# defaultMessage: Links and references
msgid "Links and references"
msgstr ""

#: components/manage/Blocks/Listing/schema
# defaultMessage: Listing
msgid "Listing"
Expand Down Expand Up @@ -2292,6 +2309,11 @@ msgstr "No s'han trobat articles en aquest contenidor."
msgid "No items selected"
msgstr "No s'ha seleccionat cap element"

#: components/manage/LinksToItem/LinksToItem
# defaultMessage: No links to this item found.
msgid "No links to this item found."
msgstr ""

#: components/manage/Blocks/Maps/MapsSidebar
# defaultMessage: No map selected
msgid "No map selected"
Expand Down Expand Up @@ -2420,6 +2442,11 @@ msgstr "Obre el navegador d'objectes"
msgid "Origin"
msgstr "Origen"

#: components/manage/LinksToItem/LinksToItem
# defaultMessage: Overview of relations of all content items
msgid "Overview of relations of all content items"
msgstr ""

#: components/manage/Toolbar/Toolbar
# defaultMessage: Page
msgid "Page"
Expand Down Expand Up @@ -2669,6 +2696,16 @@ msgstr ""
msgid "Reduce complexity"
msgstr "Disseny de taula minimalista"

#: components/manage/LinksToItem/LinksToItem
# defaultMessage: Referencing this item as related item
msgid "Referencing this item as related item"
msgstr ""

#: components/manage/LinksToItem/LinksToItem
# defaultMessage: Referencing this item with {relationship}
msgid "Referencing this item with {relationship}"
msgstr ""

#: components/theme/Anontools/Anontools
#: components/theme/Login/Login
#: components/theme/Register/Register
Expand Down Expand Up @@ -2844,6 +2881,7 @@ msgid "Revert to this revision"
msgstr "Torna a aquesta revisió"

#: components/manage/Contents/Contents
#: components/manage/LinksToItem/LinksToItem
# defaultMessage: Review state
msgid "Review state"
msgstr "Estat de revisió"
Expand Down Expand Up @@ -3721,6 +3759,7 @@ msgid "Triggering event field error. Please select a value"
msgstr ""

#: components/manage/Controlpanels/ContentTypes
#: components/manage/LinksToItem/LinksToItem
#: components/manage/Widgets/SchemaWidget
#: components/theme/View/TabularView
# defaultMessage: Type
Expand Down
39 changes: 39 additions & 0 deletions locales/de/LC_MESSAGES/volto.po
Original file line number Diff line number Diff line change
Expand Up @@ -442,6 +442,7 @@ msgstr "Verfügbare Inhaltsregeln:"
#: components/manage/Controlpanels/UpgradeControlPanel
#: components/manage/Diff/Diff
#: components/manage/History/History
#: components/manage/LinksToItem/LinksToItem
#: components/manage/Multilingual/ManageTranslations
#: components/manage/Preferences/ChangePassword
#: components/manage/Preferences/PersonalPreferences
Expand Down Expand Up @@ -766,6 +767,11 @@ msgstr "Inhaltsregeln für {title}"
msgid "Content rules from parent folders"
msgstr "Inhaltsregeln von übergeordneten Seiten"

#: components/manage/LinksToItem/LinksToItem
# defaultMessage: Content that links to or references {title}
msgid "Content that links to or references {title}"
msgstr "Zu {title} verlinkende oder referenzierende Inhalte"

#: components/manage/Controlpanels/ContentTypes
# defaultMessage: Content type created
msgid "Content type created"
Expand Down Expand Up @@ -1956,6 +1962,17 @@ msgstr "Link auf"
msgid "Link translation for"
msgstr "Übersetzung verbinden"

#: components/manage/LinksToItem/LinksToItem
# defaultMessage: Linking this item with hyperlink in text
msgid "Linking this item with hyperlink in text"
msgstr "Inhalte, die im Text auf diesen Inhalt verlinken"

#: components/manage/LinksToItem/LinksToItem
#: components/manage/Toolbar/More
# defaultMessage: Links and references
msgid "Links and references"
msgstr "Links und Referenzen"

#: components/manage/Blocks/Listing/schema
# defaultMessage: Listing
msgid "Listing"
Expand Down Expand Up @@ -2289,6 +2306,11 @@ msgstr "Keine Elemente gefunden"
msgid "No items selected"
msgstr "Kein Element ausgewählt"

#: components/manage/LinksToItem/LinksToItem
# defaultMessage: No links to this item found.
msgid "No links to this item found."
msgstr "Keine Links gefunden."

#: components/manage/Blocks/Maps/MapsSidebar
# defaultMessage: No map selected
msgid "No map selected"
Expand Down Expand Up @@ -2417,6 +2439,11 @@ msgstr "Objekt-Browser öffnen"
msgid "Origin"
msgstr "Quelle"

#: components/manage/LinksToItem/LinksToItem
# defaultMessage: Overview of relations of all content items
msgid "Overview of relations of all content items"
msgstr "Übersicht der Relationen aller Inhalte"

#: components/manage/Toolbar/Toolbar
# defaultMessage: Page
msgid "Page"
Expand Down Expand Up @@ -2666,6 +2693,16 @@ msgstr "Wiederholen"
msgid "Reduce complexity"
msgstr "Komplexität reduzieren"

#: components/manage/LinksToItem/LinksToItem
# defaultMessage: Referencing this item as related item
msgid "Referencing this item as related item"
msgstr "Inhalte, die diesen Inhalt als verwandten Inhalt referenzieren"

#: components/manage/LinksToItem/LinksToItem
# defaultMessage: Referencing this item with {relationship}
msgid "Referencing this item with {relationship}"
msgstr "Inhalte, die diesen Inhalt mit {relationship} referenzieren"

#: components/theme/Anontools/Anontools
#: components/theme/Login/Login
#: components/theme/Register/Register
Expand Down Expand Up @@ -2841,6 +2878,7 @@ msgid "Revert to this revision"
msgstr "Die aktuelle Version durch diese ersetzen"

#: components/manage/Contents/Contents
#: components/manage/LinksToItem/LinksToItem
# defaultMessage: Review state
msgid "Review state"
msgstr "Arbeitsablauf"
Expand Down Expand Up @@ -3718,6 +3756,7 @@ msgid "Triggering event field error. Please select a value"
msgstr "Fehler im auslösenden Ereignis. Bitte geben Sie einen Wert ein"

#: components/manage/Controlpanels/ContentTypes
#: components/manage/LinksToItem/LinksToItem
#: components/manage/Widgets/SchemaWidget
#: components/theme/View/TabularView
# defaultMessage: Type
Expand Down
39 changes: 39 additions & 0 deletions locales/en/LC_MESSAGES/volto.po
Original file line number Diff line number Diff line change
Expand Up @@ -436,6 +436,7 @@ msgstr ""
#: components/manage/Controlpanels/UpgradeControlPanel
#: components/manage/Diff/Diff
#: components/manage/History/History
#: components/manage/LinksToItem/LinksToItem
#: components/manage/Multilingual/ManageTranslations
#: components/manage/Preferences/ChangePassword
#: components/manage/Preferences/PersonalPreferences
Expand Down Expand Up @@ -760,6 +761,11 @@ msgstr ""
msgid "Content rules from parent folders"
msgstr ""

#: components/manage/LinksToItem/LinksToItem
# defaultMessage: Content that links to or references {title}
msgid "Content that links to or references {title}"
msgstr ""

#: components/manage/Controlpanels/ContentTypes
# defaultMessage: Content type created
msgid "Content type created"
Expand Down Expand Up @@ -1950,6 +1956,17 @@ msgstr ""
msgid "Link translation for"
msgstr ""

#: components/manage/LinksToItem/LinksToItem
# defaultMessage: Linking this item with hyperlink in text
msgid "Linking this item with hyperlink in text"
msgstr ""

#: components/manage/LinksToItem/LinksToItem
#: components/manage/Toolbar/More
# defaultMessage: Links and references
msgid "Links and references"
msgstr ""

#: components/manage/Blocks/Listing/schema
# defaultMessage: Listing
msgid "Listing"
Expand Down Expand Up @@ -2283,6 +2300,11 @@ msgstr ""
msgid "No items selected"
msgstr ""

#: components/manage/LinksToItem/LinksToItem
# defaultMessage: No links to this item found.
msgid "No links to this item found."
msgstr ""

#: components/manage/Blocks/Maps/MapsSidebar
# defaultMessage: No map selected
msgid "No map selected"
Expand Down Expand Up @@ -2411,6 +2433,11 @@ msgstr ""
msgid "Origin"
msgstr ""

#: components/manage/LinksToItem/LinksToItem
# defaultMessage: Overview of relations of all content items
msgid "Overview of relations of all content items"
msgstr ""

#: components/manage/Toolbar/Toolbar
# defaultMessage: Page
msgid "Page"
Expand Down Expand Up @@ -2660,6 +2687,16 @@ msgstr ""
msgid "Reduce complexity"
msgstr ""

#: components/manage/LinksToItem/LinksToItem
# defaultMessage: Referencing this item as related item
msgid "Referencing this item as related item"
msgstr ""

#: components/manage/LinksToItem/LinksToItem
# defaultMessage: Referencing this item with {relationship}
msgid "Referencing this item with {relationship}"
msgstr ""

#: components/theme/Anontools/Anontools
#: components/theme/Login/Login
#: components/theme/Register/Register
Expand Down Expand Up @@ -2835,6 +2872,7 @@ msgid "Revert to this revision"
msgstr ""

#: components/manage/Contents/Contents
#: components/manage/LinksToItem/LinksToItem
# defaultMessage: Review state
msgid "Review state"
msgstr ""
Expand Down Expand Up @@ -3712,6 +3750,7 @@ msgid "Triggering event field error. Please select a value"
msgstr ""

#: components/manage/Controlpanels/ContentTypes
#: components/manage/LinksToItem/LinksToItem
#: components/manage/Widgets/SchemaWidget
#: components/theme/View/TabularView
# defaultMessage: Type
Expand Down
Loading