Include `indexable_metadata` in the specification

bids-standard / bep001

Project management repository (primarily issues) for BIDS Extension Proposal 001

Creative Commons Attribution 4.0 International

8 stars 11 forks source link

Include `indexable_metadata` in the specification #26

Closed Gilles86 closed 5 years ago

Gilles86 commented 5 years ago

In bep001-naming-conventions.md we have a 'meta'-key (belonging to a value), defined as [_indexablemetadata-]. This is not ok since it hat an underscore (`). We should replace it withfa,inv,echoandtsl`.

chrisgorgo commented 5 years ago

Since it is a placeholder for a list of allowed keys I would suggest replacing this with <indexable_metadata>

agahkarakuzu commented 5 years ago

Resolved here.

KirstieJane commented 5 years ago

Action needed:

Make explicit the fact that the 4 (current) options for the indexable_metadata MUST be entered in alphabetical order.
- For example if there is more than one indexable_metadata field then they should appear in the file name in alphabetical order 😄
- Need to update the table to put echo, fa, inv, tsl in order.
Make explict the fact that these are not free text entries, that to extend the keys for indexable_metadata there needs to be an update to the specification.

KirstieJane commented 5 years ago

Reopened as this needs to be documented in the ProposedChangesToSpecification.md file 😭

I (@KirstieJane) have kinda started in #25 (bad git management rather than on purpose) see here but it isn't complete.

Gilles86 commented 5 years ago

https://github.com/bids-standard/bep001/blob/master/ProposedChangesToSpecification.md#indexable-metadata