Skip to content

Provide guidance on file naming for non-prose elements / additional elements stored in the "elements" directory of the repo #353

@thomasheritage

Description

@thomasheritage

Traditionally these files would be named per AG 02 e.g. st2999-2a-2025.xml

This would appear to be inappropriate in html-pub document authoring because:

  • Using versioned filenames for files inside a git repo is counter to normal practice when using git
  • When working with the GitHub repo or opening these files (if there are many) in other tools it's very unhelpful for them to have such opaque names
  • These "additional elements" files are manually assigned an element designator (letter) for file naming, but letters are assigned automatically in the prose document by the html-pub tooling -- this is brittle
  • Including the (unknown at time of drafting) publication year in the filename makes the workflow awkward

Therefore, I intend to use "meaningful" filenames for additional elements. This would be in-line with the example in AG 26 itself of sample.txt.

Is this best practice? I see some authors taking this approach and others using the AG 02 style file naming.

Please could guidance be provided in AG 26

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