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

Some remarks about the current documentation "Zazuko Document 09 December 2021" #53

Open
14 tasks done
FabianCretton opened this issue Dec 22, 2021 · 2 comments
Open
14 tasks done
Assignees

Comments

@FabianCretton
Copy link

FabianCretton commented Dec 22, 2021

Here I give my remarks about the current document version ""Zazuko Document 09 December 2021".
Nothing "major", I hope it can help to clarify a few things

Typo:

To be clarified/proposals:

    <https://environment.ld.admin.ch/foen/fab_OFPP_POC_sheltersbasicdata> schema:hasPart ?cube .
      ?cube schema:version 1 .
semanticfire added a commit that referenced this issue Jan 18, 2022
related to issue #53
semanticfire added a commit that referenced this issue Jan 19, 2022
related to issue #53
- add all docs to meta namespace
- address remarks in issue
semanticfire added a commit that referenced this issue Jan 19, 2022
related to issue #53
- added abstract
- various link updates
- textual updates
@IsabelMeraner
Copy link

IsabelMeraner commented Jan 19, 2022

some additional remarks from my side. just a few small things, overall I think it's great and really helpful, thanks!

prefixes:

  • external namespaces to be added to overview: geo (geosparql), skos, xsd
  • internal prefix to be added: relation

general best practices:

  • make more explicit that translations should always be realized with schema:name (and not rdf:label):
    schema:name "Room 1101"@en, "Raum 1101"@de, "Pièce 1101"@fr ;
  • add a warning that without dimension schema:name no labels will be displayed in web apps such as viz-tool
  • add info on general IRI best practices / templates: eg. no hash uri should be used, etc. maybe the following template structure could be an example?
# cube
  <[NAMESPACE]/[CUBE_ID]/cube/[VERSION_NO]> 
# observation set
  <[NAMESPACE]/[CUBE_ID]/cube/[VERSION_NO]/observation/> 
# observation
  <[NAMESPACE]/[CUBE_ID]/cube/[VERSION_NO]/observation/[OBS_ID]> 
# constraint
  <[NAMESPACE]/[CUBE_ID]/cube/[VERSION_NO]/constraint>  

2.4.1.3 other properties:

  • clearly distinguish between mandatory and non-mandatory properties on cube-level, change the sentence "you are free to add other properties related to your Cube or the publication process of your Cube directly on the instance of the Cube."
  • make it explicit, which dimensions are mandatory for the vis-tool, for instance add a link to the required dimension for the visualization tool (eg. schema:creativeWorkStatus)
  • also list possibilities for cube-level properties other than schema:name, schema:description (for clarity, they are partially already listed in section on extension viz-tool or advanced topics):
cube:observationSet
cube:observationConstraint
schema:contactPoint
schema:Dataset
schema:contributor
schema:creativeWorkStatus
schema:creator
schema:dateCreated
schema:datePublished
schema:dateModified
schema:publisher
schema:version
schema:workExample
schema:expires

missing image:

  • "Our example can be visualized: Example of a hierarchy"

Standard error:

  • use standardError as dimension name instead of precision
PREFIX relation: <https://cube.link/relation/>
[ 
  sh:path <dimension/precision>  # should be standardError not precision
  # ... additional definitions for that sh:property
  meta:dimensionRelation [ 
    # We use a Class to indicate the e.g. the standard error.
    a relation:StandardError ;
    # A generic cube metadata property points to the relevant dimension.
    meta:relatesTo ex:dimension\/measurement;
  ]
]

semanticfire added a commit that referenced this issue Jan 20, 2022
related to issue #53
- Added relation namespace
- Created relation document
- Corrected reference to relation
semanticfire added a commit that referenced this issue Jan 20, 2022
@semanticfire
Copy link
Collaborator

@IsabelMeraner the open tasks of your comment relate more to the specific requirements of viz-tool and not so much to the core rdf cube schema vocabulary.
The finished tasks are incorporated in the working document

@semanticfire semanticfire assigned l00mi and unassigned semanticfire Mar 1, 2022
semanticfire added a commit that referenced this issue Mar 1, 2022
- Add clarifications to dimensions #53
- change title of viz to ux #40
semanticfire added a commit that referenced this issue Mar 23, 2022
related to #53
- Please review
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants