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

Epic: Concept Page #1484

Open
27 of 60 tasks
joelit opened this issue Aug 22, 2023 · 4 comments
Open
27 of 60 tasks

Epic: Concept Page #1484

joelit opened this issue Aug 22, 2023 · 4 comments
Assignees
Labels
enhancement epic These are larger features that should be split to subtasks
Milestone

Comments

@joelit
Copy link
Contributor

joelit commented Aug 22, 2023

Description of the enhancement

This issue is for making sure the initial version of the concept page fulfills common requirements. It's OK if not all functionality is implemented.

  • Layout follows the static example
  • Main .twig -template exists
  • concept-info.inc exists
  • sidebar.inc exists
  • cypress tests exist
  • for deprecated concepts, show an alert + add a CSS class used for styling (e.g. for greying out)
  • message "no term for this concept in this language"
  • show breadcrumbs at top
  • in place of normal prefLabel property name ("Preferred term"), show preferredSubpropertyLabel or custom_label
  • show notation code next to prefLabel heading
  • integer notation codes should not break, see Integer notation code raises a TypeError on method_exists() in PHP 8.x #1381
  • prefLabel heading SKOS XL: SKOS XL functionality for Skosmos 3 concept page #1714
  • language tag next to prefLabel if applicable (e.g. explicit_langcodes is set)
  • copy to clipboard functionality for prefLabel
  • copy to clipboard functionality for notation if available
  • copy to clipboard buttons should show a message (e.g. "URI copied to clipboard"), like GitHub
  • copy to clipboard button should not wrap to next line if it can be avoided
  • hide subproperties of skos:hiddenLabel
  • custom labels for properties
  • property labels should be capitalized
  • property labels have tooltips
  • property values (e.g. skos:related with many values) should be sorted using locale-specific collation rules
  • properties with resource values (e.g. skos:broader):
    • show external vocabulary specifier, if applicable
    • special treatment for reified definitions (e.g. show tooltips with extra information)
    • show notation code next to label if applicable
    • show language tag next to value if applicable (e.g. explicit_langcodes is set)
    • show submembers when applicable (for ThesaurusArrays such as "clothes by time of year")
    • if suitable label not found, display label in another language, or shortened URI if all else fails
    • special treatment for concept type
      • type should not be a link
      • type should be translated (e.g. skos:Collection, iso-thes:ConceptGroup)
      • don't show type if it's just skos:Concept
  • properties with literal values (e.g. skos:note)
    • show SKOS XL: SKOS XL functionality for Skosmos 3 concept page #1714
    • show values with HTML content
    • show altLabels in italic
    • language tag next to value if applicable (e.g. explicit_langcodes is set)
    • show data types
    • format date property values such as xsd:date and xsd:dateTime according to the content language (or UI language?)
  • truncate property value lists that are longer than set number of items with "show all X values" button
  • foreign labels (pref & alt)
  • show URI
  • copy to clipboard functionality for URI (inc. button)
  • download links
    • bottom of download icon should be aligned with text baseline
  • created & modified date
  • make sure all values in the content language (as well as foreign labels) have appropriate language attributes in HTML, for e.g. screen readers
  • use h1/h2/h3... heading levels
  • enable Axe accessibility tests and make sure they pass
  • check responsiveness
  • refactor: rename CSS class termpage to something more appropriate, e.g. concept-page (needs to be done globally)
  • refactor: generate download URLs in PHP code, not in Twig template
  • Mappings
    • CSS(?) bugfix: when opening concept from the alphabetical index on vocabulary home page, the mappings should be displayed with a white background, just like when opening the concept page directly via URL.
    • show a spinner while mappings are loading
    • show notation codes next to concepts in mappings
@joelit joelit added this to the 3.0 milestone Aug 22, 2023
@osma osma self-assigned this Sep 21, 2023
@osma
Copy link
Member

osma commented Sep 21, 2023

Layout differs from the static example quite a bit.

@osma
Copy link
Member

osma commented Sep 28, 2023

I've started reworking the concept page template on the branch issue1484-concept-page-templates-cypress. There is still a lot to do, but here is a list of requirements for the concept page, based in part on examining the old Twig template:

(moved to the task list in OP, so that they can be tracked better)

@osma osma changed the title Concept Page twig-templates Concept Page Nov 21, 2023
@osma osma changed the title Concept Page Concept Page for Skosmos 3 Nov 21, 2023
@joelit
Copy link
Contributor Author

joelit commented Nov 21, 2023

Further additions to the requirement spec could be:

There's also one relevant open issue for 3.0 (#1538 ) for an enhancements to the concept page, that's relevant to the requirement list.

@osma
Copy link
Member

osma commented Nov 21, 2023

Thanks, I added these to the checklist above (with minor editing). I'm not sure if the content language is the right choice here for date values, so I kept both options.

There's also one relevant open issue for 3.0 (#1538 ) for an enhancements to the concept page, that's relevant to the requirement list.

Good point, but implementing that one goes much deeper than just the concept page template + JS + styles, and we already have a separate issue about it, so let's keep it filed there.

@joelit joelit moved this to In progress in Skosmos 3.0 Backlog Aug 8, 2024
@osma osma moved this from In progress to Skosmos 3.0 Backlog (not this sprint) in Skosmos 3.0 Backlog Dec 5, 2024
@osma osma changed the title Concept Page for Skosmos 3 Epic: Concept Page for Skosmos 3 Dec 11, 2024
@joelit joelit moved this from Skosmos 3.0 Backlog (not this sprint) to Current sprint backlog in Skosmos 3.0 Backlog Jan 21, 2025
@miguelvaara miguelvaara moved this from Current sprint backlog to Epics in Skosmos 3.0 Backlog Jan 22, 2025
@joelit joelit added the epic These are larger features that should be split to subtasks label Jan 22, 2025
@joelit joelit mentioned this issue Jan 23, 2025
4 tasks
@osma osma changed the title Epic: Concept Page for Skosmos 3 Epic: Concept Page Jan 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement epic These are larger features that should be split to subtasks
Projects
Status: Epics
Development

No branches or pull requests

2 participants