search

saa-ts-dacs / dacs

Describing Archives: A Content Standard
73 stars 32 forks source link

'converting to other formats' information unclear #29

Open laissezfarrell opened 4 years ago

laissezfarrell commented 4 years ago

While I like this approach to people converting DACS content into other formats, the documentation is a little unclear...e.g., Pandoc's pdf generator requires LaTeX (or another PDF Engine of one's choosing). This isn't hard to do if you're familar with CLI tools, Pandoc, and LaTeX, but it's a pretty big roadblock for others.

meau commented 4 years ago

It might be nice if a pdf and html file were included as part of each release.

laissezfarrell commented 4 years ago

That too! (though I'm all for forcing people to use the command line...)

helrond commented 4 years ago

The paragraph immediately above the "Converting to Other Formats" section includes the following text:

Converting the most up-to-date version of DACS into a given serialization (HTML, a typeset document, et cetera) is beyond the scope of responsibilities of the subcommittee. However, because the standard is maintained in Markdown, converting to other formats for a variety of publication purposes is a straightforward task and can be done by whatever person or body wishes to further publish DACS.

So I'd suggest that it might be better to remove the "Converting to Other Formats" section in its entirety, as it can lead to mistaken impressions.

michelsd commented 4 years ago

The whole readme needs to be reviewed now that the new website is up.