| ... | @@ -2,11 +2,12 @@ |
... | @@ -2,11 +2,12 @@ |
|
|
|
|
|
|
|
The Sharing Platform is an open platform to provide and exchange material for teaching programming to students from universities and secondary schools. The material can comprise text exercises, programming exercises, lecture material (e.g. slides), or other useful topics (as e.g. links to other valuable tools or sources outside the sharing platform).
|
|
The Sharing Platform is an open platform to provide and exchange material for teaching programming to students from universities and secondary schools. The material can comprise text exercises, programming exercises, lecture material (e.g. slides), or other useful topics (as e.g. links to other valuable tools or sources outside the sharing platform).
|
|
|
|
|
|
|
|
|
Beyond single entries you can also publish a collections of materials in order to provide e.g. complete courses. See [the section "Decide on the structure of your contribution"](#3. Decide on the structure of your contribution) for a reference to more detailed information.
|
|
|
|
|
|
|
You are welcome to contribute. In the following we want to guide you through the process of material sharing. Please note that the sharing platform is still evolving. If you have any proposals how to improve the sharing and finding of contents, do not hesitate to open an new issue in the [sharing plattform project](https://sharing-codeability.uibk.ac.at/sharing/codeability-sharing-platform/).
|
|
You are welcome to contribute. In the following we want to guide you through the process of material sharing. Please note that the sharing platform is still evolving. If you have any proposals how to improve the sharing and finding of contents, do not hesitate to open an new issue in the [sharing plattform project](https://sharing-codeability.uibk.ac.at/sharing/codeability-sharing-platform/).
|
|
|
|
|
|
|
|
In the following we try to guide you through the basic process of publishing on the sharing plattform.
|
|
In the following we try to guide you through the basic process of publishing on the sharing plattform.
|
|
|
|
|
|
|
|
[[_TOC_]]
|
|
|
|
|
|
|
|
|
|
## 1. Decide on the format of the material you want to share
|
|
## 1. Decide on the format of the material you want to share
|
|
|
|
|
|
| ... | @@ -15,22 +16,21 @@ You share your material via a gitlab repository. So there are little technical r |
... | @@ -15,22 +16,21 @@ You share your material via a gitlab repository. So there are little technical r |
|
|
The recommended format highly depends on the context how your material was historically developed, and how you expect it to be used by your colleagues.
|
|
The recommended format highly depends on the context how your material was historically developed, and how you expect it to be used by your colleagues.
|
|
|
|
|
|
|
|
For **text exercises** we recommend the presentation with the following priorities
|
|
For **text exercises** we recommend the presentation with the following priorities
|
|
|
1. **LaTeX** or **MarkDown** Format
|
|
1. **LaTeX** or **MarkDown** format
|
|
|
2. **Microsoft Office** (or **Open Office**) Format
|
|
2. **Microsoft Office** (or **Open Office**) format
|
|
|
3. **Plain Text**
|
|
3. **Plain Text**
|
|
|
4. _less recommended_: pdf format, because it does not really support reuse of content
|
|
4. _less recommended_: pdf format, because it does not really support easy reuse of content by others
|
|
|
|
|
|
|
|
Additionally for images:
|
|
Additionally for images:
|
|
|
1. Some editable format that can be reused and adapted by other users: e.g. PlantUML (as used here in GitLab, SVG, ...) that can be easily embedded in the rendered (HTML) text.
|
|
1. Some editable format that can be reused and adapted by other users: e.g. PlantUML (as used here in GitLab, SVG, ...) that can be easily embedded in the rendered (HTML) text.
|
|
|
2. Commonly used image formats: jpeg, png, gif
|
|
2. Commonly used image formats: jpeg, png, gif
|
|
|
- consider also in this case to provide the image sources that can be edited
|
|
- consider also in this case to also provide the image sources that can be edited
|
|
|
|
|
|
|
|
|
|
|
|
|
For **programming exercises** we recommend, that the problem statement should follow the recommendations of a text exercise as above. The format of additional information, as e.g. programming templates provided to the students, a sample solution or specific automated tests may be language specific. We recommend a specific file/folder structure for these exercises (see below). Artemis already provides some export functionality in the recommended format (see [here](en/documentation/SharingFromArtemis)).
|
|
For **programming exercises** we recommend, that the problem statement should follow the recommendations of a text exercise as above. The format of additional information, as e.g. programming templates provided to the students, a sample solution or specific automated tests may be language specific. We recommend a specific file/folder structure for these exercises (see below). Artemis already provides some export functionality in the recommended format (see [here](en/documentation/SharingFromArtemis)).
|
|
|
|
|
|
|
|
For **lecture material** we recommend the following formatting priorities
|
|
For **lecture material** we recommend the following formatting priorities
|
|
|
1. **SliTeX** together with the relevant additional image and formatting files
|
|
1. **SliTeX** together with the relevant additional image and formatting files
|
|
|
2. **Microsoft Office** (or **Open Office**) Format
|
|
2. **Microsoft Office** (or **Open Office**) formats
|
|
|
3. **Plain Text**
|
|
3. **Plain Text**
|
|
|
4. Online Formats: Google Slide, etc.
|
|
4. Online Formats: Google Slide, etc.
|
|
|
5. _less recommended_: pdf format, because it does not really support reuse of content
|
|
5. _less recommended_: pdf format, because it does not really support reuse of content
|
| ... | @@ -40,7 +40,7 @@ For **other material** decide what is best suited for a potential users. Most pr |
... | @@ -40,7 +40,7 @@ For **other material** decide what is best suited for a potential users. Most pr |
|
|
## 2. Decide on the location of your contribution
|
|
## 2. Decide on the location of your contribution
|
|
|
|
|
|
|
|
The backbone of the sharing platform is a gitlab instance at https://sharing-codeability.uibk.ac.at/.
|
|
The backbone of the sharing platform is a gitlab instance at https://sharing-codeability.uibk.ac.at/.
|
|
|
You should locate your contribution in an appropriate sub folder below your institution (e.g. https://sharing-codeability.uibk.ac.at/sharing/johannes-kepler-university-linz)
|
|
You should locate your contribution in an appropriate sub folder below your institution (e.g. https://sharing-codeability.uibk.ac.at/sharing/johannes-kepler-university-linz/java/Einfuehrung1/...)
|
|
|
|
|
|
|
|
## 3. Decide on the structure of your contribution
|
|
## 3. Decide on the structure of your contribution
|
|
|
|
|
|
| ... | @@ -128,4 +128,5 @@ Every time you push a new commit to the master branch, the project is checked fo |
... | @@ -128,4 +128,5 @@ Every time you push a new commit to the master branch, the project is checked fo |
|
|
|
|
|
|
|
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.
|
|
|
|
|
|
|
|
Please take care for your contribution over time. Currently you have to check on your own, whether the material is still valid and accurate (e.g. with progressing versions of a programming language). In the future we will also provide better infrastructure (e.g. discussion forums) to exchange with potential user's of your contribution, or to review your content by quality assurance. |
|
Please take care for your contribution over time. Currently you have to check on your own, whether the material is still valid and accurate (e.g. with progressing versions of a programming language). In the future we will also provide better infrastructure (e.g. discussion forums) to exchange with potential user's of your contribution, or to review your content by quality assurance.
|
|
\ No newline at end of file |
|
|