Allow embedding of external resources when Respec saves a document #4971
Labels
Comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
{{ message }}
Is your feature request related to a problem? Please describe.
We want to publish self-contained releases of our standard documents. Currently, we save the documents and all HTML is "baked in". However, the HTML still has references to external resources, most notably stylesheets. Sometimes we update our stylesheets to add more functionality, for example dark mode. Adding dark mode functionality has sometimes "broken" (debatable and subjective) older documents which weren't expected to be dark mode compatibility. This can lead to contrast and other accessibility issues for older releases of our documents.
Describe the solution you'd like
We would like to, when Respec saves a document, to also allow us to say "for these external resources, make an embedded copy into this document". Sort of to say "take the current released version and start using the local copy, removing the external reference". At that point, even if the external resources is later updated, since the saved document uses a local copy, the document structure remains in tact.
Take the following HTML as example:
Here, we use a single stylesheet for several of our documents (similar to the W3C base stylesheet). We would like these to be embedded at the time of creation. Example solution using an attribute:
The
embedclass is similar to theremoveclass, but rather than removing it from the document it would save a local copy. The eventual HTML after saving the document would become:Additional context
Ideally we would do this for the W3C base styling as well, but I would first make this user opt-in for resources in their own documents rather than in Respec itself.
Describe any alternatives you've considered
We can copy all external resources to the local repository and only use local references. However, that gets unwieldy quite quickly if you have a couple of documents that all refer to the same resource. That makes updating and keeping them all in sync difficult and (in our opinion) unmaintainable.
Can you or your organization fund the work or help with development?
Yes we already maintain a fork of Respec and can both implement plus upstream the work. I haven't implemented in our fork yet, as this is a slightly bigger feature that I would like the wider Respec community to comment on first.
The text was updated successfully, but these errors were encountered: