Project

General

Profile

Feature #1710

Manual: add CIDOC links for entity classes

Added by Alexander Watzinger 5 months ago. Updated about 2 months ago.

Status:
Closed
Priority:
Normal
Assignee:
Category:
Documentation
Target version:
Start date:
2022-05-13
Estimated time:

Description

Jona from the INDIGO project kindly suggested to add CIDOC links to the entities documented in the manual.
This is a great suggestion and we will implemented it for the next version.

History

#2

Updated by Alexander Watzinger 5 months ago

  • Status changed from Acknowledged to Assigned
  • Assignee set to Nina Richards
If possible it would be good to define variables (probably in sphinx/source/conf.py) for the URL parts, e.g with https://cidoc-crm.org/entity/e5-event/version-7.1.1

So that we can build links like {cidoc_url}entity/e5-event/{cidoc_version}, which would be helpful e.g if the used version changes.
These links could be placed under the title of entity entries like e.g. CIDOC class: E5 Event (where the bold text is linked)

#3

Updated by Alexander Watzinger 4 months ago

  • Status changed from Assigned to In Progress

It bothered me to find a way to dynamically create links to e.g. the CIDOC documentation. I ended up using the Sphinx extlinks extension.
For that I activated the extension in config.py and defined cidoc_entity links:

extensions: List[str] = ['sphinx.ext.extlinks']
extlinks = {
    'cidoc_entity': ('https://www.cidoc-crm.org/Entity/%s/version-7.1.1', '')}

Now it can be used in templates like this (I added an example at entity/source.rst):

CIDOC documentation: :cidoc_entity:`e33-linguistic-object`

Code is already in the develop branch but not online.

#4

Updated by Alexander Watzinger 4 months ago

The implementation for CIDOC links with extlinks is just one suggestion.
Even better would be a function like e.g.

cidoc_entity_link(label, url_part)

which, when called like
cidoc_entity_link('E33 Linguistic Object', 'e33-linguistic-object')

would create the link https://www.cidoc-crm.org/Entity/e33-linguistic-object/version-7.1.1 with E33 Linguistic Object as label

#5

Updated by Alexander Watzinger 4 months ago

  • Target version changed from 7.4.0 to 7.5.0
#6

Updated by Alexander Watzinger 4 months ago

  • Subject changed from Add CIDOC links to manual to Manual: add CIDOC links for entity classes
#7

Updated by Nina Richards 3 months ago

  • Status changed from In Progress to Closed

I added the links to the manual and they will be public with the next release.

#8

Updated by Alexander Watzinger about 2 months ago

  • Category changed from UI to Documentation

Also available in: Atom PDF