Skip to content

Conversation

@pchampin
Copy link
Contributor

@pchampin pchampin commented Jul 7, 2025

Address #152

I broke my own rule of systematically exporting normative definitions...
I strongly felt that the following terms were defined for internal purposes only,
more precisely to help define other terms, so I chose to not export them.

  • IRI equality
  • Blank node equality
  • Literal equality
  • Triple equality
  • isomorphic RDF-term mapping

I experimented with scoped definition [1]
for genetic terms such as 'atomic', 'node', 'subject'...
but I found that the ergonomic toll was not worth it.
In particular, there is no hint in the HTML
that the definition requires some additional context to be used.

[1] https://respec.org/docs/#scoped-concepts


Preview | Diff

pchampin added 2 commits July 7, 2025 11:43
I broke my own rule of systematically exporting normative definitions...
I strongly felt that the following terms were defined for internal purposes only,
more precisely to help define other terms, so I chose to not export them.

- IRI equality
- Blank node equality
- Literal equality
- Triple equality
- isomorphic RDF-term mapping

I experimented with scoped definition [1]
for genetic terms such as 'atomic', 'node', 'subject'...
but I found that the ergonomic toll was not worth it.
In particular, there is no hint in the HTML
that the definition requires some additional context to be used.

[1] https://respec.org/docs/#scoped-concepts
Copy link
Member

@TallTed TallTed left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A couple small tweaks

Co-authored-by: Ted Thibodeau Jr <[email protected]>
@pchampin pchampin requested review from TallTed, gkellogg and hartig July 8, 2025 17:08
@pchampin pchampin merged commit fbb7b8a into main Jul 17, 2025
2 checks passed
@hartig
Copy link
Contributor

hartig commented Jul 22, 2025

The export of "base direction", as introduced by this PR, causes a conflict for the SPARQL spec now. The issue can be observed in the Echidna run of w3c/sparql-query#245 where the "Generate Static HTML" step results in an error with the following error message.

  [INFO] Build respec document "spec/index.html" (gh)…
    $ respec -s "http://localhost:3000/spec/index.html?gitRevision=8019f11ab5c6d6e01ab954fb918535d0ff3d4ea0" -o "spec/index.html.built.html" --verbose -t 20 -e
      [INFO] [Timeout: 20000ms] Processing resource: http://localhost:3000/spec/index.html?gitRevision=8019f11ab5c6d6e01ab954fb918535d0ff3d4ea0 ...
      [INFO] [Timeout: 20000ms] Launching browser
      [INFO] [Timeout: 19705ms] Navigating to http://localhost:3000/spec/index.html?gitRevision=8019f11ab5c6d6e01ab954fb918535d0ff3d4ea0
      [INFO] [Timeout: 19172ms] Navigation complete.
      [INFO] [Timeout: 19133ms] Using ReSpec v35.4.3
      [INFO] [Timeout: 19132ms] Processing ReSpec document...
  Error: ROR] The term "base direction" is ambiguous because it's defined in [i18n-glossary] and [rdf-concepts].
         Count: 2
        Plugin: core/xref
          Hint: To fix, use the [data-cite](https://respec.org/docs/#data-cite) attribute to pick the one you mean from the appropriate specification. [See search matches for "base direction"](https://respec.org/xref/?term=base+direction&types=_CONCEPT_&specs=i18n-glossary%2Crdf-concepts) or [Learn about this error](https://respec.org/docs/#error-term-not-found).
      [INFO] [Timeout: 17996ms] Processed document.
      [INFO] [Timeout: 16982ms] Done.
      [FATAL] Error: Errors found during processing.
          at run (file:///home/runner/work/_actions/w3c/spec-prod/v2/node_modules/.pnpm/[email protected][email protected]/node_modules/respec/tools/respec2html.js:285:11)
          at async file:///home/runner/work/_actions/w3c/spec-prod/v2/node_modules/.pnpm/[email protected][email protected]/node_modules/respec/tools/respec2html.js:232:5
    Command `respec -s "http://localhost:3000/spec/index.html?gitRevision=8019f11ab5c6d6e01ab954fb918535d0ff3d4ea0" -o "spec/index.html.built.html" --verbose -t 20 -e` failed with exit code: 1.
  Error: Process completed with exit code 1.

So, it seems that "base direction" is also defined in [i18n-glossary] and we may run into the same issue for some of our other documents as well.

For my PR to the SPARQL spec (w3c/sparql-query#245), shall I apply the data-cite fix mentioned in the error message above?

@afs
Copy link
Contributor

afs commented Jul 22, 2025

the data-cite fix mentioned

Yes, that's probably the best thing to do.
It may take a bit time to sort out export-links given making changes might be fixing several things at the same time.

It should be stable, or sparql-query needs a general change anyway as sparql-query mostly has the form is
<a data-cite="RDF12-CONCEPTS#dfn-base-direction">base direction</a> and the two non-data-cite are from:

w3c/sparql-query@bc8ad60

@hartig
Copy link
Contributor

hartig commented Jul 22, 2025

the data-cite fix mentioned

Yes, that's probably the best thing to do.

Done (w3c/sparql-query@10a3019). No Echidna failure anymore in w3c/sparql-query#245 :-)

pchampin added a commit that referenced this pull request Jul 23, 2025
these IDs were modified by #215,
causing problems in other specs (see #221).
gkellogg pushed a commit that referenced this pull request Jul 31, 2025
these IDs were modified by #215,
causing problems in other specs (see #221).
@hartig hartig deleted the systematically-export-normative-terms branch October 2, 2025 16:40
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

Successfully merging this pull request may close these issues.

6 participants