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

Change specification source from Respec to Markdown #554

Closed
zimeon opened this issue Jun 1, 2021 · 6 comments · Fixed by #596
Closed

Change specification source from Respec to Markdown #554

zimeon opened this issue Jun 1, 2021 · 6 comments · Fixed by #596
Assignees
Labels
Editorial Editorial issues (no changes to intent)

Comments

@zimeon
Copy link
Contributor

zimeon commented Jun 1, 2021

I think we should change the OCFL specifications from Respec to Markdown:

  • In Markdown we'd have better control of formatting and not end up fighting Respec (see issues and PRs)
  • We would immediately solve ocfl_1.0.txt #505 with the ability to add ocfl.md and/or ocfl.html to the Storage Root
  • Compilation with Jekyll is required (a downside) but then we would have a static HTML file that doesn't rely on JavaScript lookups for rendering (a big upside, meaning our spec is preservable)
  • We don't need the "looks like a W3C spec" fake authenticity
@zimeon zimeon added Editorial Editorial issues (no changes to intent) Needs Discussion labels Jun 1, 2021
@zimeon
Copy link
Contributor Author

zimeon commented Jun 1, 2021

Example of spec in Markdown: https://iiif.io/api/presentation/3.0/

@awoods
Copy link
Member

awoods commented Jun 15, 2021

On https://github.com/OCFL/spec/wiki/2021.06.15-Editors-Meeting, we decided that transitioning to Markdown would be a constructive move forward.

@zimeon zimeon self-assigned this Jun 15, 2021
@pwinckles
Copy link

If Markdown's limited features is an issue, asciidoc is an alternative.

https://docs.asciidoctor.org/asciidoc/latest/asciidoc-vs-markdown/

@zimeon
Copy link
Contributor Author

zimeon commented May 10, 2022

@zimeon
Copy link
Contributor Author

zimeon commented May 19, 2022

Decision at https://github.com/OCFL/spec/wiki/2022.05.19-Editors-Meeting is that we will not convert existing versions (notably 1.0). Future version, the draft spec, 1.1 etc., will be in Markdown

@zimeon
Copy link
Contributor Author

zimeon commented May 20, 2022

Things to consider after we have the first markdown version merged:

  • We should decide on styling of literals, I think it is good they are no longer red like the RFC2119 words, but not sure the current grey background is good
  • We can consider syntax highlighting options for the code segments

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Editorial Editorial issues (no changes to intent)
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants