HUPO-PSI / mzIdentML

Repository for mzIdentML and the corresponding examples
23 stars 24 forks source link

file format for extension documents? #129

Closed colin-combe closed 1 year ago

colin-combe commented 2 years ago

the new version of the spec will refer to extension documents that describe additional features.

What file format do we want to use for these documents? Its been suggested to move away from .docx "to ASCIIDoctor format (to match mzTab) or failing that an enhanced Markdown". Something more text based that makes tracking changes in GH easier might be better than .docx

javizca commented 2 years ago

Nils Hoffmann is the person to ask about this, although we need to take a joint decision about how to proceed. I don't have any experience in using the ASCIIDoctor format

colin-combe commented 2 years ago

whats missing from 'normal' markdown that we might need? (@mobiusklein)

colin-combe commented 2 years ago

how do we contact Nils Hoffman?

colin-combe commented 1 year ago

discussed the file format for specification documents with @nilshoffmann.

Asciidoc has many advantages (github can render it, can properly track changes via git) compared to what we're currently doing with .docx files.

we will use asciidoc for the crosslinking extension document (possibly also other extension documents @mobiusklein ?) and potentially also move the main specification document to Asciidoc ( @javizca , @andrewrobertjones )

This will match what has been done with the mzTab specification.