General:
- The term "branch" in reference to a map doesn't seem to be formally defined anywhere. It's used quite widely. Seems like we should formally define the meaning of "branch" or "map branch" to mean the tree of topicrefs descending from the root map element or a topicref in a map.
- I didn't find anything that desperately needed changing in the examples section-it seems pretty complete and reasonably clear (given the inherent complexity of this feature).
- The text does mention resource IDs as potentially being affected by <dvrResource*> elements but it's easy to miss. Might be useful to add an example that explicitly shows how the effective resource ID value could be adjusted by <dvrResource*>. This is stated explicitly in the processing expectations section of the <resourceid> reference topic.
I also agree with Robert's draft comment in the resourceid topic about moving the appid-role content to the arch spec. I can take that action.
Topic "Branch filtering"
* Need to say something about the ability to set effective source filenames (<dvrResource*>) and effective key scopes (<dvrKeyscope*>).
Topic "Overview of branch filtering"
- c/Maps or map branches can be filtered by adding a <ditavalref> element that specifies the DITAVAL document to use for that map or map branch/: Insert "direct child" before <ditavalref>: "by adding a direct child <ditavalref>..."
- Suggest adding new ending paragraph:
The <ditavalref> element can set the effective resource URIs of referenced resources in a branch, for example. The <ditavalref> can set the effective key scope for a branch.
Topic "Using metadata elements in the DITAVAL reference domain"
- Move example to an example section or subtopic. Could move it to the exisiting "Examples of branch filtering" topic with a cross ref.
- c/The attribute value keyref=/The attribute keyref=/
- Re draft comment "Comment by rodaande on 4 Apr 2022 Do we remember what "related attributes" are in the following note? Can we keep it simple and just say that keyref attribute is disallowed?"
@keyscope must also be disallowed. So maybe "@keyref and @keyscope"? - In the second bullet under "Processors should consider the following points...": c/specific to each operating system./specific to each platform./
Cheers,
Eliot
_____________________________________________
Eliot Kimber
Sr. Staff Content Engineer
O: 512 554 9368
servicenow
servicenow.com
LinkedIn | X | YouTube | Instagram