-
Notifications
You must be signed in to change notification settings - Fork 12
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
new XProc for docs generation; cleanup and renaming #46
new XProc for docs generation; cleanup and renaming #46
Conversation
This branch includes a number of improvements to the docs generation pipeline, for maintainability. Although interfaces (especially names and arguments of scripts) should not have changed, due diligence is always warranted. |
75350bf
to
9a3a746
Compare
src/document/README.md
Outdated
|
||
### `METASCHEMA-DOCS-TRACE.xpl` | ||
For ease of configurability, this pipeline works like `METASCHEMA-DOCS-TESTSITE-write.xpl` except Given a `path` to write to and a key name (schema name), this pipeline serializes and writes a set of documentation rooted at HTML `div` elements, suitable for ingestion into Hugo or any other HTML-based publishing system. |
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.
Something doesn't look right.
- "except Given" looks like the first sentence is missing its ending.
- Is the sentence starting with "Given" supposed to be here?
- Is the first sentence supposed to compare this pipeline to
METASCHEMA-DOCS-DIVS-write.xpl
(the one above) orMETASCHEMA-DOCS-TESTSITE-write.xpl
(the one below, which refers back to this one)?
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.
Provided some non-blocking comments.
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.
As discussed, could you:
- Add the scripts to the
metaschema-xslt
command - Adjust the help output to use the
BASE_COMMAND
environment variable (look at the existing scripts in themetaschema-xslt
command for reference - Push up existing changes related to previous reviewer's comments
Committer Notes
Includes new XProcs and scripts for running them.
Revisions to the core docs XProc expose more (intermediate) ports. Also, we have new or modified XProc and scripts for:
The PR addresses #42, with the exception of the requirement for total CSS configurability.
The capability to create and skin a standalone site is provided.
All Submissions:
Changes to Core Features: