Add HTML links for "synopsis" code blocks #559
Merged
Conversation
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
Extend and improve the "codebox" Asciidoc role:
* Rename "codebox" to "synopsis". My intent is to use this role
mostly to define the synopsis of an API.
* Create an Asciidoctor extension that enables HTML links for source
listings that use the "synopsis" role and also define an id like:
```
[source,role=synopsis,id=XXX]
```
In the HTML render, when you hover the mouse over a code synopsis, a
pound sign ("#") appears. Clicking on this gives you a link directly
to that code synopsis. This makes it easy to get a direct link to
any API that is defined with the "synopsis" role. Note that this
behavior is similar to the way section headers work in the HTML
render, where you can click on a "section sign" symbol to get a URL
directly to a section.
Add ids to the synopsis `[source]` blocks for the builtin math functions. As a result, the HTML render now allows you to get a link directly to the synopsis for any of these functions.
|
Merging as editorial. |
keryell
pushed a commit
that referenced
this pull request
Sep 10, 2024
Add HTML links for "synopsis" code blocks
gmlueck
added a commit
that referenced
this pull request
Nov 7, 2024
Add HTML links for "synopsis" code blocks (cherry picked from commit ae99673)
gmlueck
added a commit
that referenced
this pull request
Nov 7, 2024
Add HTML links for "synopsis" code blocks (cherry picked from commit ae99673)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Extend and improve the "codebox" Asciidoc role:
Rename "codebox" to "synopsis". My intent is to use this role
mostly to define the synopsis of an API.
Create an Asciidoctor extension that enables HTML links for source
listings that use the "synopsis" role and also define an id like:
In the HTML render, when you hover the mouse over a code synopsis, a
pound sign ("#") appears. Clicking on this gives you a link directly
to that code synopsis. This makes it easy to get a direct link to
any API that is defined with the "synopsis" role. Note that this
behavior is similar to the way section headers work in the HTML
render, where you can click on a "section sign" symbol to get a URL
directly to a section.
Change the synopses of the math builtin function sections to use this
new style.