Add Documentation for Contribution

_config.yml

@@ -11,11 +11,6 @@ github_username:  bujuhu
 # Build settings
 markdown: kramdown
 
-#Protcol Variables
-name: Juri Schreib
-class: 5CHIF
-reportTitle: Laborbericht
-
 exclude:
   - node_modules
   - CNAME
@@ -26,19 +21,45 @@ collections:
     short: NVS
     long: NVS Coufal 5CHIF 16/17
     output: true
-    permalink: /NVS/:name
   dbi_r:
     short: DBI
     long: DBI Resch 5CHIF 16/17
     output: true
-    permalink: /DBI_R/:name
   dbi_gt:
     short: DBI
     long: DBI Griesmayer 5CHIF 16/17
     output: true
-    permalink: /DBI_GT/:name
+  contributions:
+    short: Beiträge
+    long: Beiträge
+    output: true
 
-subjects:
-  - nvs
-  - dbi
-  - dbi resch
+defaults:
+  - scope:
+      path: ""
+      type: nvs
+    values:
+      layout: report
+      author: Juri Schreib
+      class: 5CHIF 16/17
+  - scope:
+      path: ""
+      type: dbi_r
+    values:
+      layout: report
+      author: Juri Schreib
+      class: 5CHIF 16/17
+  - scope:
+      path: ""
+      type: dbi_gt
+    values:
+      layout: report
+      author: Juri Schreib
+      class: 5CHIF 16/17
+  - scope:
+      path: ""
+      type: contributions
+    values:
+      layout: report
+      author: Anonym
+      class: Anonym

_contributions/Beispiel/anhang.txt

@@ -0,0 +1 @@
+Ein Beispielanhang

_contributions/Beispiel/index.md

@@ -0,0 +1,16 @@
+---
+title: Beispiel
+date: 1970-01-01
+author: Max Mustermann
+class: 5XHIF 17/18
+task: Aufgabenstellung
+taskHref: https://kaufensie.jetzt
+---
+
+Dies ist ein Beispiel um zu demonstrieren, wie man ein eigens erstellter Text ausschaut
+
+[Markdown Syntax Tutorial](https://guides.github.com/features/mastering-markdown/)
+
+Ein Beispielbild
+
+![](its_all_ogre_now.png)

_contributions/unterstuetzen/index.md

@@ -0,0 +1,101 @@
+---
+title: Unterstützen
+date: 1970-01-01
+author: Juri Schreib
+---
+
+# Unterstützen
+
+Es gibt 2 Möglichkeien eigene Beiträge auf nvs.schreib.at zu veröffentlichen
+
+## Methode 1, Markdown File einschicken
+
+Verfasst euren Beitrag im [Markdown Format](https://guides.github.com/features/mastering-markdown/) und schickt ihn dann an meine E-Mail Adresse - [[email protected]](mailto:[email protected]). Dabei zu beachten gibt es nur, dass Bilder und Anhnäge auf einem externen Server gehosted und im Dokument korrekt verlinkt werden müssen.
+
+Ich werde mich dann darum kümmern den Beitrag auf der Webseite einzubinden
+
+## Methode 2, Pull Request
+
+Die für mich viel weniger Arbeit verursachende Methode ist die erstellung eines Pull Requests auf Github. Ich werde versuchen hier Schrittweise zu erklären, wie man dies macht
+
+### Schritt 1, das Projekt Forken und clonen
+
+Dazu navigiert man zur [Github Seite des Projekts](https://github.com/Bujuhu/nvs) und klickt, wenn man eingeloggt ist, auf "Fork" am oberen rechten Bildschirmrand
+
+![](1.png)
+
+Danach sollte das Github Projekt auf eurem Github Benutzerkonto verfügbar sein.
+
+![](2.png)
+
+Ist das Geschafft, kann das Projekt mit dem Git Clienten deiner Wahl, das Projekt von eurem Profil geklont werden können.
+
+### Schritt 2, das Projekt bearbeiten
+
+Das Verzeichnis des Projekts sollte in etwa so aussehen
+
+![](3.png)
+
+Um einen neuen Beitrag zu erstellen muss man in den `_contributions` Ordner Navigieren und den Beispiel Ordner kopieren und umbenennen
+
+![](4.png)
+
+### Setzen der Variablen
+
+Innerhalb des neuen Ordners sollte dann eine Datei sein die `index.md` heißt und folgedndermaßen aussieht:
+
+```
+---
+title: Beispiel  # Titel des Dokuments
+date: 1970-01-01 # Veröffentlichungsdatum
+author: Max Mustermann # (Optional) Autor
+class: 5XHIF 17/18 # (Optional) Klasse und Jahrgang des Autors
+task: Aufgabenstellung # (Optional) Beschreibung der Aufgabenstellung
+taskHref: https://kaufensie.jetzt # (Optional) Link der Aufgabenstellung
+---
+
+Markdown Text
+
+```
+
+Am Anfang des Dokuments müssen Variablen definiert werden. Ein Titel `title` und ein Datum `date` im Format `YYYY-MM-DD` sind pflicht. Sollte als Datum ein Zeitpunkt in der Zukunft gewählt werden, wird das Dokument erst ab diesem Datum einsehbar.
+
+Nicht verwendete Variablen, welche optional sind, können einfach rausgelöscht werden.
+
+### Verfassen vom Text
+
+Unterhalb des Blocks beginnt dann der eigentliche Textinhalt des Dokuments. Innerhalb dieses Bereichs kann [Markdown](https://guides.github.com/features/mastering-markdown/) und HTML verwendet werden um das Dokument zu formatieren.
+
+### Einbinden von Bildern und Anhängen
+
+Um andere Datein anzuhängen, müssen diese - wie im Beispielprojekt Demonstriert - einfach im selben Verzeichnis liegen wie die Markdown Datei. Diese sind dann unterhalb des Textes auf der Webseite verfügbar.
+
+![](5.png)
+
+*Nur Bilder im PNG Format werden als Bilder erkannt, alle andern Bildformate werden als Anhänge, angezeigt*
+
+Bilder können auch mithilfe von Markdown direkt in den Text eingebunden werden. Dazu muss man einfach `![](bildname.png)` verwenden
+
+## Schritt 3, Testen
+
+Hat man den Text vervollständigt, ist es möglich, bevor man es mir zuschickt zu testen. Dazu muss [Jekyll](https://jekyllrb.com/) installiert sein und im Hauptverzeichnis mit dem Befehl `jekyll serve` ausgeführt werden. Danach sollte eine Testinstanz auf [http://localhost:4000](http://localhost:4000) erreichbar sein.
+
+Dort sollte dann unter der Kategorie **Beiträge**, das neue Dokument gelistet sein.
+
+![](6.png)
+
+## Schritt 4, einen Pull Request erstellen
+
+Nach dem Änderungen commited und auf Github gepushed worden sind, ist es möglich auf Github einen Pull-Request zu eröffnen um deinen Beitrag auf der Hauptseite einzubinden.
+
+Dazu gehe wieder auf die [Github Seite des Projekts](https://github.com/Bujuhu/nvs), klicke auf *Pull Requests*
+
+![](7.png)
+
+und dann auf *New Pull Request*
+
+![](8.png)
+
+Danach sollte es möglich sein, das Projekt auf deinem Profil als *Head Fork* und das Hauptprojekt auf meinem (Bujuhu) Profil als *Base Fork* auszuwählen und einen Pull Request zu erstellen.
+
+Danach muss ich nurmehr kontrollieren, ob alles richtig ist und dann kann ich die Datei auf meine Seite pushen!

_includes/attachments.html

@@ -1,6 +1,9 @@
-{% for file in site.static_files %}
-  {% assign urlparts = file.path | split: "/" %}
-  {% if file.path contains include.path and file.extname != ".png" %}
-    <li><a href="{{ site.baseurl }}{{ file.path }}" class="s-link">{{ urlparts.last }}</a></li>
+{% assign collectionMeta = site.collections | where: "label", {{page.collection}} | first %}
+
+{% for file in collectionMeta.files %}
+  {% assign path = include.path | split: "/"  %}
+  {% assign filepath = file.path | split: "/" %}
+  {% if filepath[2] == path[2] and file.extname != ".png" %}
+    <li><a href="{{ site.baseurl }}{{ file.path }}" class="s-link">{{ filepath.last }}</a></li>
   {% endif %}
 {% endfor %}

_includes/images.html

@@ -1,6 +1,9 @@
-{% for file in site.static_files %}
-  {% assign urlparts = file.path | split: "/" %}
-  {% if file.path contains include.path and file.extname == ".png" %}
-    <li><a href="{{ site.baseurl }}{{ file.path }}" class="s-link">{{ urlparts.last }}</a></li>
+{% assign collectionMeta = site.collections | where: "label", {{page.collection}} | first %}
+
+{% for file in collectionMeta.files %}
+{% assign path = include.path | split: "/"  %}
+{% assign filepath = file.path | split: "/" %}
+{% if filepath[2] == path[2] and file.extname == ".png" %}
+    <li><a href="{{ site.baseurl }}{{ file.path }}" class="s-link">{{ filepath.last }}</a></li>
   {% endif %}
 {% endfor %}

_includes/report-header.html

@@ -1,17 +1,19 @@
+{% assign collectionMeta = site.collections | where: "label", {{page.collection}} | first %}
+
 <div class="report-header">
 <div class="report-header-row">
   <div class="report-item">
     <h1 class="report-title">
-      {{ site.reportTitle }} - {{ page.subject | upcase }} - {{ site.class }}
+      Laborbericht - {{ collectionMeta.short | upcase }} - {{ page.class }}
     </h1>
     </div>
 </div>
   <div class="report-header-row">
     <div class="report-item report-name">
-        <b>Name:</b> {{ site.name }}
+        <b>Name:</b> {{ page.author }}
     </div>
     <div class="report-item report-date">
-      <b>Datum:</b> {{ page.date }}
+      <b>Datum:</b> {{ page.date | date: "%Y-%m-%d" }}
     </div>
   </div>
   {% if page.taskHref %}

_includes/subject.html

@@ -6,7 +6,7 @@ <h2 class="s-title subject-title">{{ collectionMeta.long | upcase }}</h2>
     {% assign orderedCollection = collection | sort: 'date' %}
     {% for report in collection %}
       <div class="coco-item__header">
-        {{ report.date | date_to_string }} <a href="{{ report.url }}" class="s-link">{{ report.title }}</a>
+        {{ report.date | date: "%Y-%m-%d"}} <a href="{{ report.url }}" class="s-link">{{ report.title }}</a>
       </div>
     {% endfor %}
   </div>

_sass/schreib.scss

@@ -42,3 +42,24 @@ body {
     display: none;
   }
 }
+
+.infobox {
+  margin-top: 20px;
+  border-radius: 5px;
+}
+.infobox-text {
+  margin: 1em;
+}
+.infobox-button {
+  display: inline-block;
+  margin: 1em;
+  padding: 10px;
+  background-color: $backdrop;
+  border-radius: 5px;
+  border: 1px solid $backdrop;
+
+}
+
+.infobox-button:hover {
+  border: 1px solid $assertive;
+}

index.html

@@ -3,6 +3,12 @@
 title: Home
 ---
 
+  <div class="infobox">
+    <p class="infobox-text">Da ich Maturiert habe, werde ich keine neuen Schulunterlagen mehr veröffentlichen. Ihr könnt aber eure eigenen Protokolle hinzufügen.</p>
+    <a href="/contributions/Unterstuetzen/" class="infobox-button s-link">Unterstützen</a>
+  </div>
+
   {% include subject.html collection="nvs" %}
   {% include subject.html collection="dbi_gt" %}
   {% include subject.html collection="dbi_r" %}
+  {% include subject.html collection="contributions" %}