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.

Sign up for GitHub

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

Jump to bottom

title reference is not correctly linked #1957

Closed
sebastiankb opened this issue Jan 18, 2024 · 4 comments · Fixed by #2014
Closed

title reference is not correctly linked #1957

sebastiankb opened this issue Jan 18, 2024 · 4 comments · Fixed by #2014
Assignees
@egekorkan
Labels
bug Editorial Issues with no technical impact on implementations ontology Semantics Semantics-related issues

Comments

@sebastiankb
Copy link
Contributor

WHAT

The title term in TD points to https://www.w3.org/2019/wot/td#title

However, clicking on this link does not take you to the "title" section (3.3.12) of the TD ontology document.

It seems that the id of this section is x3-3-12-title (https://www.w3.org/2019/wot/td#x3-3-12-title).

How

Fix the section id of 3.3.12 to id="title".
@sebastiankb sebastiankb added Editorial Issues with no technical impact on implementations Semantics Semantics-related issues ontology labels Jan 18, 2024
@github-actions github-actions bot added the needs-triage Automatically added to new issues. TF should triage them with proper labels label Jan 18, 2024
@egekorkan egekorkan added bug and removed needs-triage Automatically added to new issues. TF should triage them with proper labels labels Jan 18, 2024
@danielpeintner
Copy link
Contributor

This is indeed very strange.

Changing the following line

wot-thing-description/ontology/td.html

Line 145 in 4892019

<section id="title"><h4>title</h4><p>IRI: <code>https://www.w3.org/2019/wot/td#title</code></p><span>title of the TD element (Thing, interaction affordance or data schema)</span><table class="def numbered"><tbody><tr><td>Domain includes</td><td><code><a href="https://www.w3.org/2019/wot/json-schema#DataSchema">jsonschema:DataSchema</a></code><br><code><a href="#InteractionAffordance">td:InteractionAffordance</a></code><br><code><a href="#Thing">td:Thing</a></code></td></tr><tr><td>Range includes</td><td><code><a href="http://schema.org/Text">schema:Text</a></code></td></tr></tbody></table></section>

to

<section id="titleX">...

Allows the anchor td#titleX to work.

Is it somewhat forbidden to have an id="title"?

@danielpeintner
Copy link
Contributor

I think I found the issue. ReSpec generates an HTML that generates the following code

image

This means the id="title" is present twice... once in the very beginning of the document for the title of the document and once for the term we create. The anchor reference brings you to the first id which is at the top of the document.

@danielpeintner
Copy link
Contributor

Mhh, overriding it as shown in https://respec.org/docs/#h1-element via

<body>
    <h1 id="tdOntologyTitle">Thing Description (TD) Ontology</h1>
    <section id='abstract'>

Doesn't help either. The only simple solution that comes to my mind is that once we generate the static html we simply remove the first id="title" manually from the HTML code...

@egekorkan
Copy link
Contributor

We will remove it from the ontology files HTML

@egekorkan egekorkan self-assigned this May 8, 2024
This was referenced May 8, 2024
Open
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@egekorkan egekorkan

Labels
bug Editorial Issues with no technical impact on implementations ontology Semantics Semantics-related issues
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

remove title id from static files w3c/wot-thing-description
3 participants
@danielpeintner @sebastiankb @egekorkan