-
Notifications
You must be signed in to change notification settings - Fork 664
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add basic support for tagging text in the spec
This adds two things: 1. Custom CSS to add a subtle dotted underline on hover to any element with an ID starting with `qx_` (an arbitrary prefix unlikely to be used by chance). 2. An example tag `qx_x0_is_zero`, tagging the text that specifies that x0 is hardwired to 0. This just adds a single tag as an exmaple, but the intention is that such tags would be added throughout the spec, allowing coverage, test plans, tests, documentation, etc. to all link to specific parts of the spec. The text of these tags can also be extracted via Asciidoc's docbook output format, enabling more use cases such as monitoring for spec changes.
- Loading branch information
Showing
3 changed files
with
25 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
<style> | ||
/* | ||
Any ID starting with 'qx_' (arbitrarily chosen to be unlikely to | ||
be used by accident) is a snippet of specification text that has been | ||
specifically tagged to allow referencing it robustly, for use cases | ||
such as: | ||
* Linking coverage, tests plans, tests, assertions etc. to parts of | ||
the spec that they cover. | ||
* Detecting when parts of the spec change. You can extract these | ||
snippets via Asciidoc's docbook output and parsing the XML. | ||
* Linking documentation (e.g. the implementation defined parameter list) | ||
to the spec. | ||
This adds a subtle decoration to make it easier to find tagged text. | ||
*/ | ||
[id^="qx_"]:hover { | ||
text-decoration: underline; | ||
text-decoration-style: dotted; | ||
text-decoration-color: gray; | ||
} | ||
</style> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters