Latest updates by Alexey #13
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
Significant remaining TBD:
Math markup
Greek letter attributes - define & expand in [source]
Tables
Links (https references)
Internal xrefs/anchors
Citations/references
Appendix titles / formats
Odd bit-packing diagrams
Figure out how to dynamically? incorporate REFERENCE.adoc (would be by
far easiest to statically generate it from wetzel repository and
commit here - can't imagine it will often change).
Add anchors to sections, matching titles (might also match Asciidoc default behavior if no explicit anchor). Remove some extraneous
github, rather than the local repository branch (since there may not be a local branch, depending on how the spec is built and viewed - and the master branch registry should be canonical, as well).
Makefile for building and intermediate generated files, and tweakups markup of the math-rendering URLs to work properly with asciidoctor.
… numbers Use npx to invoke wetzel now that it's in npm (@donmccurdy)
host the generated specification on github and are not constrained by the limitations of its asciidoctor implementation. Also cleans up the Makefile a bit to explain the wetzel invocation and the URL argument to it ($(SCHEMALINK)).
Try to use Github Actions for CI test that builds the spec targets.
With help from CesiumGS/wetzel#51
Add JSON schemas to AsciiDoctor output.
See discussion: #1907 (comment)
latexmath rendering vs. the image approaches previously used. See the generated HTML / PDF in the Actions artifacts download and search for "Latexmath" (followed by "Old") versions of each equation. Relevant points: * The HTML output is not self-contained. It introduces an external dependency on the MathJax package on a CDN outside our control. * MathJax runs after the HTML page is loaded and takes noticeable time - initially you will see the raw latex markup, replaced and re-laid-out with the formatted math. * The PDF output introduces a new dependency on the asciidoctor-mathematical gem (the Khronos Docker image already has this). * The PDF math rendering quality is noticeably lower than the HTML rendering quality.
Sectioned hanging text
See #1901 (comment) Note: doing this for HTML is harder.
Flip credits & copyrights
Co-authored-by: Ed Mackey <[email protected]>
* Integrate latest updates * More typography fixes * Apply suggestions from code review Co-authored-by: Gary Hsu <[email protected]> * Address feedback * Address feedback & add more clarifications * Address feedback Co-authored-by: Gary Hsu <[email protected]>
* Add license text of all licenses used under LICENSES/. * Add copyright statements that are readable by REUSE where reasonably possible. * Add .reuse/dep5 entry as fallback licenses for images etc. where explicit copyrights not possible. * Add 'reuse lint' check to github Actions CI * Use 'TBD' license on vendor extensions, none of which seem to have explicit licenses and may not be owned by Khronos. * Some minor whitespace / EOL convention changes. * Add boilerplate files missing from repo such as CONTRIBUTING and COPYING.
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.
No description provided.