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

Add ReSpec aliasing clarity in README.me's "Editorial Documentation" section #2287

Open
rahimabdi opened this issue Jul 18, 2024 · 1 comment
Assignees
Labels
Agenda-Editors editorial a change to an example, note, spelling, grammar, or is related to publishing or the repo

Comments

@rahimabdi
Copy link
Contributor

rahimabdi commented Jul 18, 2024

Describe the change

When linking to other specs using ReSpec syntax, there are scenarios where you need to provide alternative link text for the automatic external reference linking (xref).

For example, in the "Editorial Documentation" section, it's stated:

<section data-cite="webidl">
    <p>
        All ARIA attributes reflect in IDL as [=nullable type|nullable=]
        {{DOMString}} attributes.
    </p>
</section>

This means that nullable will be presented in spec text (not nullable type).

I'd like to add some clarity around 1) how to alias when referencing other specs and 2) what can/cannot be aliased per ReSpec syntax (see: https://respec.org/docs/#aliases-and-synonyms).

@rahimabdi rahimabdi added the editorial a change to an example, note, spelling, grammar, or is related to publishing or the repo label Jul 18, 2024
@rahimabdi rahimabdi self-assigned this Jul 18, 2024
@spectranaut
Copy link
Contributor

This is a great idea, and if you haven't seen it yet, I frequently use: https://respec.org/xref/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Agenda-Editors editorial a change to an example, note, spelling, grammar, or is related to publishing or the repo
Projects
None yet
Development

No branches or pull requests

3 participants