-
Notifications
You must be signed in to change notification settings - Fork 267
Consolidate Header Set and Body Set columns in document attribute reference to Header Only #24
Comments
It's true that there are certain attributes that can be modified even if they are locked. At the moment, this only includes |
* fix incorrect values and descriptions * consolidate Header Set and Body Set columns to Header Only * resolves asciidoctor#1 indicate implied values separated from default values * indicate implied value when value is empty * update description of fields * adjust column widths * add several missing attributes
This issue is intertwined with #1 and I think we should solve both in a single pull request (otherwise, we'll end up with merge hell). There are several concepts to represent:
We also may need to deal with whether an attribute is modifiable separately. I think that's out of scope for this change. |
There's also whether an attribute is set when running in embedded mode. There are only a few attributes affected by this, which are: |
As a follow-up, I think we should pull the implicit document attributes into this page. That puts all the known built-in attributes in a single place. And, besides, some of the attributes on this page are implicit and some on the implicit page are modifiable. So we're creating an artificial division. We will need to address that "modifiable" field though. Perhaps we can bold the attribute name to indicate it cannot be changed. Again, probably a separate issue. |
I feel like embedded mode is really overlooked/flying under the radar. Or I just keep missing all the documentation about it 👀 I feel like we need to have a little session where we start with "What is embedded mode", "What uses cases does embedded mode solve", "How do I prepare content that I want to embed", "How do I embed this content", "Where can I embed content", "What are the limitations of embedded mode", What can I configure in embedded mode" .... and so on
I'm down with with that 👍 It should definitely be a separate issue though!
Agreed
Definitely a separate issue |
* rewrite intro * fix incorrect values and descriptions * consolidate Header Set and Body Set columns to Header Only * resolves asciidoctor#1 indicate implied values separated from default values * clarify difference between effective value and implied value * update description of fields * adjust column widths * add several missing attributes * move any above empty in legend for document attributes table * remove outdated footnote and fix references to the remaining one * rename Values column to Allowable Values * rename Header Only column for security attributes to CLI/API only * configure content in table header to align to bottom
* rewrite intro * fix incorrect values and descriptions * consolidate Header Set and Body Set columns to Header Only * resolves #1 indicate implied values separated from default values * clarify difference between effective value and implied value * update description of fields * adjust column widths * add several missing attributes * move any above empty in legend for document attributes table * remove outdated footnote and fix references to the remaining one * rename Values column to Allowable Values * rename Header Only column for security attributes to CLI/API only * configure content in table header to align to bottom
When we're talking about document attributes, all the writer needs to know is whether the document attribute must be set by the end of the header (i.e., Header Only). Otherwise, its implied that the attribute can be set anywhere, assuming it is not locked by the CLI or API. This change will also simplify the visual complexity of these tables.
The text was updated successfully, but these errors were encountered: