-
Notifications
You must be signed in to change notification settings - Fork 64
Add index to core spec #2288
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 index to core spec #2288
Conversation
|
Can be previewed here: https://raw.githack.com/w3c/epub-specs/feature/add-index/epub33/core/index.html#index |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overall, I think it is worth adding it, even if not perfect.
One tiny thing. The generated code seems to be:
<a class="index-term" href="....">
"container resource"
</a>for elements and then
<a class="index-term" href="....">
<code>meta</code>
</a>for elements. Would it be better if we added to our css something like
a.index-term code {
color: #c63501 !important;
}we use that colour all over the place for code, better keep it in the index, too...
Should this be raised against respec? It's respec that colours the code tags in the body, so if we manually override the index then we have to keep watch that the respec css doesn't change in the future. |
Oops, somehow I always thought that we set the color, not respec... Yes, that should be a respec issue. Not only for this case; I have added the following entries to our common css files to ensure the right colour when using xref: code a[data-type~="element"],
code a[data-type~="dfn"],
code a[data-type~="element-attr"]
{
color: #c63501 !important;
}These should be superfluous as well. Do we want to start by setting it for ourselves and raise an issue afterwards, or just raise an issue? I would be in favour of the former; I do not know whether such an issue would be taken care of with high priority... |
That works for me. I'll update the PR when I have a minute. |
|
Also: do we want to switch indexing on for RS? It does not define many new concepts, but I also found the generated list of external concept references useful... (I cannot judge the value for the A11y document). |
Although, looking at the result of adding custom CSS, I'm not so sure it's a good idea. Linked code is now hard to distinguish from unlinked code as there may only be a faint dotted underline. We also get links that are part orangey-red and part blue if they include a code-tagged word with other words. It's really quite messy. It might be better to remove the custom CSS and figure out with the respec/spec-prod folks what should be done. |
I'm of the opposite view: it's rather clunky and duplicative. It appears to take the text of every Here's a random sampling I spotted in the RS spec only looking at a few "p" entries: |
remove forced colouring of code in links
|
I'm opting for a middle road on this and adding indexes to the three rec-track specs but removing the CSS link overrides so we have consistent colouring of our links. |
Adds the respec-generated index of terms. I don't think this is useful for any of the other specs as they don't add similar numbers of new terms.
Fixes #2260
💥 Error: 500 Internal Server Error 💥
PR Preview failed to build. (Last tried on May 17, 2022, 11:44 AM UTC).
More
PR Preview relies on a number of web services to run. There seems to be an issue with the following one:
🚨 Spec Generator - Spec Generator is the web service used to build specs that rely on ReSpec.
🔗 Related URL
If you don't have enough information above to solve the error by yourself (or to understand to which web service the error is related to, if any), please file an issue.