From 0e469ec0b5aaef7084529d82a24fef44c4fe49ca Mon Sep 17 00:00:00 2001 From: Goutte Date: Fri, 15 Mar 2019 00:08:45 +0100 Subject: [PATCH] Add more information about the course file format. Also add a reference to unit.eu's protocol OAI-PMH. Looks nice. --- SPECIFICATIONS.md | 34 +++++++++++++++++++++++++++++++++- 1 file changed, 33 insertions(+), 1 deletion(-) diff --git a/SPECIFICATIONS.md b/SPECIFICATIONS.md index e1ed40b49..03af4494c 100644 --- a/SPECIFICATIONS.md +++ b/SPECIFICATIONS.md @@ -1,4 +1,8 @@ +# THIS DOCUMENT IS A DRAFT + +> Contributions welcome! + ## Courses Model Each Course MUST have: @@ -14,7 +18,35 @@ Each course MAY have - one or more Courses as dependencies - one or more Tags +Keep it simple, for now. There will be room for events (class projects, etc.) later. + +## Course File Format + +We should probably follow something akin to [what Grav does](https://learn.getgrav.org/15/content/content-pages). + +- A frontmatter in YAML holding metadata +- The course in Markdown + HTML + +The markdown enhancements should be documented here as well. + +Ideas: +- use gitlab's flavor as base, since it has latex and mermaid already +- https://zestedesavoir.com/ has a pretty good markdown flavor as well (information and warning bubbles), tailored for education + +## Possible driver implementations + +- with Grav +- with Moodle +- with schema.org (jsonld?) (may use Grav for this) +- with OAI-PMH (may use Grav for this?) + +Multiple frontends may be buit to display these courses. + +## Tips + +http://flagpedia.net/emoji ## TODO -- Look up https://schema.org/Course and comply somehow \ No newline at end of file +- Look up https://schema.org/Course and comply somehow +- Look up [OAI-PMH](ttp://www.unit.eu/ressources-educatives-libres/valoriser-des-rel) and comply somehow