Skip to content
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

AsciiDoc/Attributes capture in rendered output #573

Closed
bwgartner opened this issue Oct 26, 2020 · 1 comment
Closed

AsciiDoc/Attributes capture in rendered output #573

bwgartner opened this issue Oct 26, 2020 · 1 comment
Assignees

Comments

@bwgartner
Copy link

Problem description

Once engaged with the Documentation-as-Code approach, it is easy to set attributes (via DC and CLI) to provide conditional content. However, unless they are checked in as part of the DC, the resulting output may not be able to be recreated.

Expected behavior

Much like an autoconf/automake approach, would like the daps command, in the context of source=AsciiDoc/XML/DocBook, to capture/record any/all attributes that were provided (both via DC/CLI) to render the resulting output format. Even if just embedded as comments/metadate in the rendered output, this would be valuable to ensure another pass could consistently render the output.

Of course, just having multiple DC files is an option, but unsure if that is recorded in the generated output either (and suspect versioning may also be relevant in that sense as well).

Steps to reproduce problem

a) DC file:
ADOC_ATTRIBUTES+=" --attribute foo=1"
ADOC_ATTRIBUTES+=" --attribute bar=1"

b) then daps --force -d html

c) But then only editing/commenting DC (but not checking in)
ADOC_ATTRIBUTES+=" --attribute foo=0"
or CLI
daps --force -d --adocattr="attribute bar=0" html

would potentially provide a different, generated, rendered output, but difficult for others to recreate (since not recorded anywhere) if not done by this particular author.

@fsundermeyer
Copy link
Member

  • DAPS could post the "command line" including the DC file parameteers via xslt paramater
  • Stylesheets could create and appendix with the contents of that paramneter as text/screen

fsundermeyer added a commit that referenced this issue Nov 27, 2020
(issue #573); still WIP
* global parameter "--show adoc-attributes"?? missing
* documentation missing
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants