Improve documentation describing how to set document wide diagram attribute values

[brtjdcole]

I'd like to specify SVG as the default image rendering format for all my diagrams so I don't have to worry about selecting the /right/ resolution for images. Can't find a way to do this. From the look of it, Diagram extensions only respect :pos_attrs which, I assume, means the attribs must fall in the block description.

Am I missing something?

:generated-image-format: svg

[graphviz]
....
A->B;
....

vs.

[graphviz, save_name.svg, svg]
....
A->B:
....

[pepijnve]

To specify the default format for a diagram type you should use a document attribute of the form <diagram-type>-format so for graphviz :graphviz-format: svg. Could you give that a try?

[brtjdcole]

@pepijnve That does the trick. Did I miss this in the documentation or is it standard behavior for any attributes within an extension, i.e. -?

[pepijnve]

It’s documented but should probably be more explicit. Here’s the bit in question from the attributes section.

Each attribute can either be specified at the block level or at the document level. The attribute name at the block level should be prefixed with the name of the diagram type and a dash.

[pepijnve]

Rereading that sentence, it doesn’t actually make any sense. Should definitely be clarified.

[mojavelinux]

You might also point out that the reason there is a dedicated attribute per diagram engine is that each diagram engine has vastly different capabilities and a one-size-fits-all attribute just wouldn't work.

[brtjdcole]

Including an explicit example might be helpful as well. Perhaps being able to set the default, currently “image”, to another format might be tenable incurring warnings when that format isn’t applicable. In it’s current state I’ll probably just include::[] a config file in my document with the diagram formats called out explicitly. Thanks all.

…

On Oct 1, 2018, at 12:49 AM, Dan Allen ***@***.***> wrote: You might also point out that the reason there is a dedicated attribute per diagram engine is that each diagram engine has vastly different capabilities and a one-size-fits-all attribute just wouldn't work. — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#197 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AfVCYEgZJxl_rv5r855IoFJTdNBmEeE3ks5ugcj9gaJpZM4XAnPo>.