Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reorganize appendices #1204

Closed
tsalo opened this issue Aug 16, 2022 · 9 comments · Fixed by #1256
Closed

Reorganize appendices #1204

tsalo opened this issue Aug 16, 2022 · 9 comments · Fixed by #1256
Labels
formatting Aesthetics and formatting of the spec

Comments

@tsalo
Copy link
Member

tsalo commented Aug 16, 2022

Here is the current order:

  1. Contributors
  2. Licenses
  3. Hierarchical Event Descriptors
  4. Entity table
  5. Units
  6. MEG file formats
  7. MEG systems
  8. Coordinate systems
  9. Entities
  10. File collections
  11. Quantitative MRI
  12. Arterial Spin Labeling
  13. Cross modality correspondence
  14. Glossary

I think we should reorganize it so that it moves from more general topics to more specific. For example, the glossary should be close to the top, along with general specification principles like entity descriptions and units.

  1. Contributors
  2. Licenses
  3. Glossary
  4. Entity table
  5. Entities
  6. Units
  7. File collections
  8. Hierarchical Event Descriptors
  9. MEG file formats
  10. MEG systems
  11. Coordinate systems
  12. Quantitative MRI
  13. Arterial Spin Labeling
  14. Cross modality correspondence
@tsalo tsalo added the formatting Aesthetics and formatting of the spec label Aug 16, 2022
@sappelhoff
Copy link
Member

I generally agree, but would it be worth breaking a lot of links?

@tsalo
Copy link
Member Author

tsalo commented Aug 16, 2022

Maybe we could forward the current URLs to the new ones automatically? I'm not sure how to do that in mkdocs, but if it's possible then that would solve the problem.

@tsalo
Copy link
Member Author

tsalo commented Aug 16, 2022

It looks like there's a mkdocs-redirects plugin that we could use.

@effigies
Copy link
Collaborator

Do we want to drop the NN- prefixes? The order is determined by mkdocs.yml, not the sort order of the source files.

@tsalo
Copy link
Member Author

tsalo commented Aug 23, 2022

Should the glossary be part of the main specification?

@Remi-Gau
Copy link
Collaborator

Should the glossary be part of the main specification?

I would say yes but maybe you have some alternative in mind.

@tsalo
Copy link
Member Author

tsalo commented Aug 23, 2022

I was just thinking that the glossary should be more easily accessible (i.e., a chapter in the main specification instead of an appendix), but I don't know if others feel the same way. As we start to link more terms in the main text to glossary items, it seems like the glossary should become more of a central part of the spec.

@Remi-Gau
Copy link
Collaborator

hahaha. I had understood the opposite of what you implied: that you wanted to take it completely out of the spec and make it standalone as if it was not related to the spec. I am tired...

But yeah I would not mind making it more central.

@sappelhoff
Copy link
Member

As we start to link more terms in the main text to glossary items, it seems like the glossary should become more of a central part of the spec.

sound like a good idea to me!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
formatting Aesthetics and formatting of the spec
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants