Skip to content

Suggested minor improvements in the documentation 'Dynamic Metadata in Quarto Documents' #258

@joanbadia

Description

@joanbadia

The dynamic metadata documentation is very well written and the first example of use and its output it's very helpful.

I have minor suggestions:

  1. R chunks in the example do not properly show the #| options. This is probably simply a formatting thing because there's an explicit mention to it, e.g.: Note the #| output: asis chunk option - this is essential:)
  2. The examples chosen do not show the full range of possibilities that this new functionality offers. Even updating the parameters outside of the document via quarto render test.qmd -P ... benefits from this new functionality (thanks to the sequential order in which code is executed). There are two veiled references to this: This functionality addresses a key limitation where Quarto metadata must traditionally be static and defined in the document header and And so, it wll make the metadata available for use throughout the document., but I think the documentation would benefit from a more explicit mention.
  3. While the email variants example demonstrates the new functionality, readers unfamiliar with Posit Connect or the Quarto Email Extension might benefit from brief contextual links to related documentation.

I would say that had I read this documentation earlier, when I learnt about the existence of quarto::write_yaml_metadata_block, I wouldn't have required assistance applying this to my use case.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions