References (not just links) to item (view and menu item) – Update to released plone.restapi.relations #4842

ksuess · 2023-06-02T13:13:06Z

PLIP #4339

Update to PR #4787

Nice to have

Show relation name (relation field title) instead relation field id.

Made some refactoring:

queryRelations can be done with list of paths of targets. No need to go via UID.
- no need to check if items back links are already available in store. Just fetch if itempath changes (hook dependency)
title: getContent, if no title (request /links-to-item without referer)
no reset of REDUX store (content, relations). Just leave it.
I've added a column with the content type. Does not distuorb. Thought it would be of interest.

netlify · 2023-06-02T13:13:10Z

✅ Deploy Preview for volto ready!

Name	Link
🔨 Latest commit	`a739d7f`
🔍 Latest deploy log	https://app.netlify.com/sites/volto/deploys/64882e10e0f7590008b57d6a
😎 Deploy Preview	https://deploy-preview-4842--volto.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

cypress · 2023-06-02T13:35:33Z

Passing run #5592 ↗︎

0	503	20	0	0

Details:

Update illustration with new wording
Project: Volto	Commit: `a739d7fa27`
Status: Passed	Duration: 12:11 💡
Started: Jun 13, 2023 8:54 AM	Ended: Jun 13, 2023 9:06 AM

_{This comment has been generated by cypress-bot as a result of this
project's GitHub integration settings.}

stevepiercy

I like where this is headed. I suggested a few things to condense the layout and clean up grammar.

stevepiercy · 2023-06-02T22:16:34Z

docs/source/_static/user-manual/manage/link-to-items.png

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

Of course, thanks for the hint. Changed in c4106b0

stevepiercy · 2023-06-02T22:29:48Z

locales/volto.pot

+# defaultMessage: Content that link to this item
+msgid "Content that link to this item"
+msgstr ""
+


I think this message is redundant to the heading above it in the image, Links to "Supervisor Adélaïde Pickavance", and I find it confusing. I would remove it.

Me too. It evolved to a state where a description is superfluous.

stevepiercy · 2023-06-02T22:41:56Z

src/components/manage/LinksToItem/LinksToItem.jsx

-                id="Whenever this item is being referenced from some different item by a hyperlink, block or similar, it appears here in this list."
-                defaultMessage="Whenever this item is being referenced from some different item by a hyperlink, block or similar, it appears here in this list."
+                id="Content that link to this item"
+                defaultMessage="Content that link to this item"
              />
            </Segment>


I think this is redundant to the heading above it in the table and should be removed.

stevepiercy · 2023-06-02T22:49:45Z

docs/source/user-manual/links-to-item.md

@@ -27,7 +27,7 @@ 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.
+:alt: A panel captioned with "Links to My Summer Vacation - Day 2". A table with two columns (first column labeled with "Linking 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.


This summarizes the language that I would like to see used and adapted in the code for the panel. I probably missed exactly where the updates would be necessary in the code.

I think the row Content that link to this item can be merged with the heading above the table, into Content that links to {ITEM_NAME}.

Suggested change

:alt: A panel captioned with "Links to My Summer Vacation - Day 2". A table with two columns (first column labeled with "Linking 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.

:alt: A panel with the heading "Content that links to {ITEM_NAME}", followed by a table describing the content.

The table has sections that show the content is linked by either a hyperlink or a reference.

The first column is labeled "LINKED BY HYPERLINK" or "LINKED BY REFERENCE '{REF_NAME}'".

The second and third columns are labeled "REVIEW STATE" and "TYPE".

ksuess · 2023-06-12T13:58:40Z

Thank you @stevepiercy for reviewing. I updated the wording according your suggestions and made some more changes. Can you have a look again, please.

@pgrunewald and @danalvrz, please take some minutes and share your thoughts, thank you.

Preview of docs: https://deploy-preview-4842--volto.netlify.app/user-manual/links-to-item.html

stevepiercy

A spelling correction, a grammar correction (that needs to be applied throughout), and an alt text that aligns with the new image.

This is good. Once these changes are made, I approve. Thank you!

docs/source/user-manual/links-to-item.md

stevepiercy · 2023-06-13T06:25:26Z

docs/source/user-manual/links-to-item.md


 ```{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.
+: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.


Suggested change

: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.

:alt: A panel captioned with "Content that links to or references 'Supervisor Adélaïde Pickavance'". Below the caption, there is a table with three sections, where each section has three columns. The first column's heading is the section name, the second is "Review State", and the third is "Type". The three 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 Field]'".

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?
99af3e5

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. ¯\_(ツ)_/¯

locales/volto.pot

src/components/manage/LinksToItem/LinksToItem.jsx

src/components/manage/LinksToItem/__snapshots__/LinksToItem.test.jsx.snap

Co-authored-by: Steve Piercy <web@stevepiercy.com>

stevepiercy

LGTM! Thank you!

danalvrz · 2023-06-13T21:50:57Z

Thank you @stevepiercy for reviewing. I updated the wording according your suggestions and made some more changes. Can you have a look again, please.

@pgrunewald and @danalvrz, please take some minutes and share your thoughts, thank you.

Preview of docs: https://deploy-preview-4842--volto.netlify.app/user-manual/links-to-item.html

@ksuess it looks great! 🎉

…released plone.restapi.relations (#4842) Co-authored-by: Steve Piercy <web@stevepiercy.com>

pgrunewald · 2023-06-16T08:37:39Z

Thanks for this great addition, @ksuess!

Update to released plone.restapi.relations format. And some refactoring.

86eea2b

ksuess added 3 commits June 2, 2023 15:16

Update snapshot with new column "Type"

bbb3aff

Update locales (references where msgids are applied)

5e705e1

remove lodash smuggler

35a529c

ksuess marked this pull request as draft June 2, 2023 15:16

ksuess added 2 commits June 2, 2023 21:13

Show all relation types.

64052be

wording description 'links to item'

4829ab5

ksuess marked this pull request as ready for review June 2, 2023 19:26

Update LinksToItem.test.jsx.snap

042b75e

ksuess requested a review from pgrunewald June 2, 2023 19:38

Update user manual

83fb8ce

stevepiercy requested changes Jun 2, 2023

View reviewed changes

ksuess marked this pull request as draft June 5, 2023 08:05

Enhance wording

c4106b0

ksuess marked this pull request as ready for review June 12, 2023 13:39

ksuess added 2 commits June 12, 2023 15:51

Fix test snapshots

89cb268

Merge branch 'links-to-item-view' into references-to-item-view

f96127c

ksuess requested review from stevepiercy, avoinea, pnicolli and sneridagh June 12, 2023 13:59

stevepiercy requested changes Jun 13, 2023

View reviewed changes

ksuess and others added 3 commits June 13, 2023 08:44

Apply suggestions from code review

8875ea7

Co-authored-by: Steve Piercy <web@stevepiercy.com>

Grammar fix

e05b1a4

Wording of alt text of illustration in docs

99af3e5

stevepiercy approved these changes Jun 13, 2023

View reviewed changes

Update illustration with new wording

a739d7f

ksuess merged commit 7676a4b into links-to-item-view Jun 14, 2023

ksuess deleted the references-to-item-view branch June 14, 2023 17:26

ksuess mentioned this pull request Jun 14, 2023

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

Merged

4 tasks

pgrunewald pushed a commit that referenced this pull request Jun 16, 2023

References (not just links) to item (view and menu item) – Update to …

d01d316

…released plone.restapi.relations (#4842) Co-authored-by: Steve Piercy <web@stevepiercy.com>

ksuess added this to the 17.x.x milestone Oct 6, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

References (not just links) to item (view and menu item) – Update to released plone.restapi.relations #4842

References (not just links) to item (view and menu item) – Update to released plone.restapi.relations #4842

ksuess commented Jun 2, 2023 •

edited

Loading

netlify bot commented Jun 2, 2023 •

edited

Loading

cypress bot commented Jun 2, 2023 •

edited

Loading

stevepiercy left a comment

stevepiercy Jun 2, 2023

ksuess Jun 12, 2023

stevepiercy Jun 2, 2023

ksuess Jun 12, 2023

stevepiercy Jun 2, 2023

stevepiercy Jun 2, 2023

ksuess commented Jun 12, 2023 •

edited

Loading

stevepiercy left a comment

stevepiercy Jun 13, 2023

ksuess Jun 13, 2023

stevepiercy Jun 13, 2023

stevepiercy left a comment

danalvrz commented Jun 13, 2023

pgrunewald commented Jun 16, 2023

-:alt: A panel captioned with "Links to My Summer Vacation - Day 2". A table with two columns (first column labeled with "Linking 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.
+:alt: A panel with the heading "Content that links to {ITEM_NAME}", followed by a table describing the content.
+      The table has sections that show the content is linked by either a hyperlink or a reference.
+      The first column is labeled "LINKED BY HYPERLINK" or "LINKED BY REFERENCE '{REF_NAME}'".
+      The second and third columns are labeled "REVIEW STATE" and "TYPE".

References (not just links) to item (view and menu item) – Update to released plone.restapi.relations #4842

References (not just links) to item (view and menu item) – Update to released plone.restapi.relations #4842

Conversation

ksuess commented Jun 2, 2023 • edited Loading

netlify bot commented Jun 2, 2023 • edited Loading

✅ Deploy Preview for volto ready!

cypress bot commented Jun 2, 2023 • edited Loading

Passing run #5592 ↗︎

stevepiercy left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ksuess commented Jun 12, 2023 • edited Loading

stevepiercy left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

stevepiercy left a comment

Choose a reason for hiding this comment

danalvrz commented Jun 13, 2023

pgrunewald commented Jun 16, 2023

ksuess commented Jun 2, 2023 •

edited

Loading

netlify bot commented Jun 2, 2023 •

edited

Loading

cypress bot commented Jun 2, 2023 •

edited

Loading

ksuess commented Jun 12, 2023 •

edited

Loading