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

Microsyntax for "abstract-op" links? #4376

Closed
dontcallmedom opened this issue Feb 1, 2023 · 3 comments · Fixed by #4439
Closed

Microsyntax for "abstract-op" links? #4376

dontcallmedom opened this issue Feb 1, 2023 · 3 comments · Fixed by #4439

Comments

@dontcallmedom
Copy link
Member

dontcallmedom commented Feb 1, 2023

Right now, when using the [= =] microsyntax for links, it only works if the target is a dfn definition; I think this makes sense when there exists a dedicated microsyntax for other types of definitions (e.g. {{ }}), especially when these other types are of a different nature (i.e. more code than prose).

But the type abstract-op is more on the prose side and doesn't have a microsyntax, so I think it should be possible to use [= =] links for them; the alternative would be to use the microsyntax that bikeshed uses for them [$ $].

@sidvishnoi
Copy link
Member

With speced/respec-web-services#207, we made abstract-op to be same as dfn, so it should be possible to use [= =] (i.e., there's no "abstract-op" in ReSpec xref database.
Is there something that's not linking right?

@dontcallmedom
Copy link
Member Author

That only works for links to outside of the spec, but not for links inside the spec itself I believe.

The following micro-spec illustrates it as it triggers a linking error.

<!doctype html>
<html>
  <title>Element definition</title>
    <script class="remove">
      var respecConfig = {
        specStatus: "base",
        shortName: "foo",
        editors: [{name: "foo"}],
      };
    </script>
    <script src="https://www.w3.org/Tools/respec/respec-w3c.js"></script>
  </head>
  <body>
    <section>
      <dfn class="abstract-op">define an algorithm locally</dfn>
      [= define an algorithm locally =]
    </section>
  </body>
</html>

@sidvishnoi
Copy link
Member

Ah, that makes sense.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants