| ... | @@ -64,19 +64,22 @@ If you decide to make your exercise public, please note that also every parent g |
... | @@ -64,19 +64,22 @@ If you decide to make your exercise public, please note that also every parent g |
|
|
The metadata.yaml is _mandatory_ (alternatively a metadata.yml or a metadata.js is also appropriate).
|
|
The metadata.yaml is _mandatory_ (alternatively a metadata.yml or a metadata.js is also appropriate).
|
|
|
It contains information about your exercise, necessary to discover it by an interested user.
|
|
It contains information about your exercise, necessary to discover it by an interested user.
|
|
|
|
|
|
|
|
The details of the content can be found [here](technical/MetaData Documentation).
|
|
A full description of the metadata format can be found [here](https://sharing-codeability.uibk.ac.at/sharing/codeability-sharing-platform/-/wikis/technical/MetaData-Documentation).
|
|
|
|
|
|
|
|
We list here the most relevant content. Please feel free to add further attributes.
|
|
Some fields in the metadata are required and some are optional. We encourage you to have a look at what is available and to include the data relevant for the content you upload.
|
|
|
|
|
|
|
|
The following is an example showing the specification of a C programming exercise.
|
|
|
```yaml
|
|
```yaml
|
|
|
metadataVersion: "0.2"
|
|
metadataVersion: "0.4"
|
|
|
type: programming exercise
|
|
learningResourceType: programming exercise
|
|
|
title: C Artemis Tutorial Compile
|
|
title: C Artemis Tutorial Compile
|
|
|
description: Find a compilation error in a given program. A semicolon is missing in the provided file. Students should fix this issue by looking at the compiler feedback provided by Artemis.
|
|
description: Find a compilation error in a given program. A semicolon is missing in the provided file. Students should fix this issue by looking at the compiler feedback provided by Artemis.
|
|
|
license: CC-SA-BY 4.0
|
|
license: CC-SA-BY 4.0
|
|
|
keyword:
|
|
keyword:
|
|
|
- Artemis
|
|
- Artemis
|
|
|
- tutorial
|
|
- tutorial
|
|
|
format:
|
|
format:
|
|
|
|
- md
|
|
|
- artemis
|
|
- artemis
|
|
|
structure: atomic
|
|
structure: atomic
|
|
|
language:
|
|
language:
|
| ... | @@ -86,46 +89,34 @@ programmingLanguage: |
... | @@ -86,46 +89,34 @@ programmingLanguage: |
|
|
creator:
|
|
creator:
|
|
|
- name: Priller Simon
|
|
- name: Priller Simon
|
|
|
affiliation: "Universität Innsbruck"
|
|
affiliation: "Universität Innsbruck"
|
|
|
email: e.mail@somewhere.edu
|
|
email: email@nospam.ac.at
|
|
|
|
- name: Kaltenbrunner Lukas
|
|
|
|
affiliation: "Universität Innsbruck"
|
|
|
|
email: email@nospam.ac.at
|
|
|
|
publisher:
|
|
|
|
- name: Priller Simon
|
|
|
|
affiliation: "Universität Innsbruck"
|
|
|
|
email: email@nospam.ac.at
|
|
|
- name: Kaltenbrunner Lukas
|
|
- name: Kaltenbrunner Lukas
|
|
|
affiliation: "Universität Innsbruck"
|
|
affiliation: "Universität Innsbruck"
|
|
|
email: e.mail2@somewhere.edu
|
|
email: email@nospam.ac.at
|
|
|
difficulty: simple
|
|
difficulty: simple
|
|
|
|
educationalLevel:
|
|
|
|
- beginners
|
|
|
image: "https://en.wikipedia.org/wiki/C_(programming_language)#/media/File:The_C_Programming_Language_logo.svg"
|
|
image: "https://en.wikipedia.org/wiki/C_(programming_language)#/media/File:The_C_Programming_Language_logo.svg"
|
|
|
|
|
status: final
|
|
|
|
isBasedOn:
|
|
|
|
- "https://artemis.codeability.uibk.ac.at/course-management/51/programming-exercises/652"
|
|
|
|
identifier: at.ac.uibk.eidp.s21.s00e03
|
|
|
|
subject:
|
|
|
|
- "Universität Innsbruck-Einführung in die Programmierung"
|
|
|
```
|
|
```
|
|
|
|
|
|
|
|
**metadataVersion**: is currently fixed to "0.2". The version may evolve over time. We will try to provide aids to upgrade the meta data automatically.
|
|
Please refer to the documentation of [metadata version 0.4](https://sharing-codeability.uibk.ac.at/sharing/codeability-sharing-platform/-/wikis/technical/Metadata-Version-0.4-Documentation) for a full reference of the available fields.
|
|
|
|
|
|
|
|
**type**: Enumeration. Can be one of `programming exercise`, `exercise`, `collection` or `other`.
|
|
|
|
|
|
|
|
|
|
**title**: just a nice title. Will be the most visible attribute of your contribution.
|
|
|
|
|
|
|
|
|
|
**description**: a one or two sentences synopsis of your contribution. Will be displayed as a summary.
|
|
|
|
|
|
|
|
|
|
**format**: a list that indicates the major file type(s): e.g. `latex`, `doc`, `ppt`, or special formats as e.g. `artemis`
|
|
|
|
|
|
|
|
|
|
**license**: The name of the license, under which you provide your material. We currently recommend `CC-SA-BY 4.0`
|
|
|
|
|
|
|
|
|
|
**keyword**: A list of keywords, helping to find and to describe your contribution
|
|
|
|
|
|
|
|
|
|
**structure**: Enumeration: `atomic` for a single exercise or `collection` for a set of exercises (e.g. a complete course). (`collection` is not yet supported).
|
|
|
|
|
|
|
|
|
|
**language**: either `de` or `en` (or both, if bi-lingual)
|
|
|
|
|
|
|
|
|
|
**programmingLanguage**: (optional) the programming language for this exercise: e.g. `C` or `Java`
|
|
|
|
|
|
|
|
|
|
**creator**: one or more authors for this material: the name, institution and email
|
|
|
|
|
|
|
|
|
|
**difficulty**: The difficulty of the exercise: One of `simple`, `medium`, `advanced`
|
|
|
|
|
|
|
|
|
|
**image**: A link to an illustrative image for this course. It will be displayed prominently next to the title of your contribution.
|
|
|
|
|
|
|
|
|
|
There are further attributes to describe your contribution in more detail.
|
|
|
|
|
|
|
|
|
|
## 6. Maintain your contents
|
|
## 6. Maintain your contents
|
|
|
|
|
|
|
|
Everytime you commit your content in the master branch, the project is checked for the presence of `metadata.yaml`. If it is not present, or its content is not valid, you will get an error mail, pointing out the problem.
|
|
Every time you push a new commit to the master branch, the project is checked for the presence of the metadata file. If it is not present, or its content is not valid, you will get an error mail, pointing out the problem.
|
|
|
|
|
|
|
|
As long as there are errors in you meta data, the last valid version is reused (or it is not listed at all, if no previous valid version exists). So please correct these errors.
|
|
As long as there are errors in you meta data, the last valid version is reused (or it is not listed at all, if no previous valid version exists). So please correct these errors.
|
|
|
|
|
|
| ... | | ... | |