search

samtools / hts-specs

Specifications of SAM/BAM and related high-throughput sequencing file formats
http://samtools.github.io/hts-specs/
655 stars 173 forks source link

Get rid of landscape oriented pages in the VCF spec #550

Open tskir opened 3 years ago

tskir commented 3 years ago

E.g. page 16 in https://samtools.github.io/hts-specs/VCFv4.3.pdf, as this significantly impairs readability.

As one option, just extract all examples into a separate document to avoid cluttering the specification.

jmarshall commented 3 years ago

VCF files are often very wide, so I think there is some utility in showing complicated examples in the specification text.

We could try \usepackage{pdflscape} instead of \usepackage{lscape}. With macOS Preview.app this causes p.16 to be displayed with the text the right way up (without needing the user to hit the button to rotate that page themselves); I haven't checked what happens if you try printing it, but I expect all will be well as this is using PDF native hints. That link suggests some other alternatives too.

tskir commented 3 years ago

One thing I had in mind was to reformat the examples by breaking the lines so that they fit into portrait A4.

However, if we can indeed solve this with that different package, that'd be even better. Thanks for the pointer, I'll try it out!

tskir commented 3 years ago

Oh, and just to clarify, the intent of this ticket was never to remove the examples entirely, I agree they're very useful. Just that the current formatting is unfortunate