Problem/Motivation

Vocabularies by default have a Description field. In the case of other entities this descripition is displayed on their overview pages such as Content types admin/structure/types or Comment types admin/structure/comment, but the Vocabulary description is not displayed on the Taxonomy page where users would expect it.
Adding the description to the table on admin/structure/taxonomy would improve usability by allowing users to see which vocabulary was meant for what, and it would provide consistency between core modules.

Proposed resolution

Add the description as a column to the table on the Taxonomy page.

Remaining tasks

User interface changes

This is a UI change to improve usability.

before:

after:

API changes

N/A

Data model changes

N/A

Comments

ifrik created an issue. See original summary.

pashupathi nath gajawada’s picture

Assigned: Unassigned » pashupathi nath gajawada

Im looking into this issue.

pixelmord’s picture

Assigned: pashupathi nath gajawada » Unassigned
Issue summary: View changes
Status: Active » Needs review
StatusFileSize
new816 bytes
new91.44 KB

@pashupathi nath gajawada : I guess you did not have time to get to this issue, I created a patch.
display description for vocabulary

pixelmord’s picture

Issue tags: +DevDaysMilan, +sprint
ifrik’s picture

Status: Needs review » Reviewed & tested by the community

Thanks pixelmord,

this does exactly what I envisioned. This patch simply makes the list of vocabularies consistent with list of content types etc. by just adding a bit to the UI, as shown in the screenshot.

It doesn't change any existing functionality, so I don't think it need an extra usability review so I'll RTBC it.

jcnventura’s picture

It does what it says.. Just tested and saw the description column added to the vocabulary list page.

ifrik’s picture

Issue summary: View changes
StatusFileSize
new15.43 KB

Screenshots

before:

after:

xjm’s picture

Issue summary: View changes
Status: Reviewed & tested by the community » Needs work
Issue tags: +Needs tests

This is an extremely straightforward user interface improvement. Since this is adding text to the page in a new column, I asked myself three questions:

  1. Is this introducing a new pattern? It is not; the name/description/operations button columns for the list builder are also already used for content types, views, etc.
  2. Does the added text make the page more difficult to understand, or overwhelming? I do not think so; it is easily scanned and provides helpful context for each row.
  3. Does this make the table less mobile-friendly? I.e., are other similar listings responsive to hide the description column on a narrow screen. @ifrik tested and confirmed that the content type listing does not hide the description column. So, making that column responsive would be out of scope here. We could have a followup issue to decide whether make all these lists responsive so that the description column is lower priority.

I also discussed the issue aloud with @Bojhan and he thought it was a fine improvement. Great work!

One thing we do need is added test coverage to ensure the descriptions are displayed. Marking needs work for that (and maybe we can file that followup issue too).

Thanks everyone!

chandeepkhosa’s picture

Assigned: Unassigned » chandeepkhosa

assigning

chandeepkhosa’s picture

Assigned: chandeepkhosa » Unassigned
Status: Needs work » Needs review
Issue tags: -Needs tests
StatusFileSize
new2.29 KB
new1.37 KB

I have added descriptions to the tests.
Here is my patch & interdiff from the last patch

yoroy’s picture

Can somebody verify the added tests are ok? Thanks!

dawehner’s picture

Status: Needs review » Reviewed & tested by the community

These tests look perfect for me

xjm’s picture

Version: 8.2.x-dev » 8.3.x-dev
Issue summary: View changes
Status: Reviewed & tested by the community » Fixed
StatusFileSize
new44.19 KB

It occurred to me that we did not really have a precedent in core for whether a vocabulary description should be markup or plain text (since it does not use any text filter). The closest analogy is content types. I compared it to the content type list builder and confirmed they support markup for the description.

I tested manually and it looks great, including in a narrow window. I also confirmed that descriptions are XSS filtered but not escaped.

Committed 46e89b9 and pushed to 8.3.x. Thanks!

  • xjm committed 46e89b9 on 8.3.x
    Issue #2752849 by pixelmord, ChandeepKhosa, ifrik, xjm: Display...
ifrik’s picture

Thanks so much to everybody!

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.

gábor hojtsy’s picture

Issue tags: -sprint