Skip to content

Commit

Permalink
Merge branch 'release/1.3.0'
Browse files Browse the repository at this point in the history
  • Loading branch information
Joshua27 committed Mar 6, 2017
2 parents 9f76e33 + 552dae1 commit 2fa920a
Show file tree
Hide file tree
Showing 4 changed files with 41 additions and 39 deletions.
2 changes: 1 addition & 1 deletion .bumpversion.cfg
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[bumpversion]
current_version = 1.2.0
current_version = 1.3.0
parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(-(?P<release>\w+))?
tag = False
commit = True
Expand Down
6 changes: 3 additions & 3 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ before_script:
script:
- make travis
after_success:
- cp handbook-1.2.0.pdf latest.pdf
- cp handbook-1.2.0.html latest.html
- travis-custom-deploy sftp handbook-1.2.0.pdf handbook-1.2.0.html latest.pdf latest.html
- cp handbook-1.3.0.pdf latest.pdf
- cp handbook-1.3.0.html latest.html
- travis-custom-deploy sftp handbook-1.3.0.pdf handbook-1.3.0.html latest.pdf latest.html
notification:
email:
on_success: never
Expand Down
10 changes: 5 additions & 5 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
MARKDOWN=$(filter-out README.md,$(wildcard *.md))

default: handbook.pdf handbook.html
travis: handbook-1.2.0.html handbook-1.2.0.pdf
travis: handbook-1.3.0.html handbook-1.3.0.pdf

.PHONY: dependencies
dependencies:
git submodule update --init

handbook-1.2.0.html: $(MARKDOWN) dependencies
handbook-1.3.0.html: $(MARKDOWN) dependencies
pandoc -f markdown -t html --css=markdown-css-themes/markdown10.css \
--standalone --self-contained $(MARKDOWN) -o $@

handbook.html: handbook-1.2.0.html
handbook.html: handbook-1.3.0.html
cp $< $@

handbook-1.2.0.pdf: $(MARKDOWN)
handbook-1.3.0.pdf: $(MARKDOWN)
pandoc --standalone -f markdown -t latex $(MARKDOWN) -o $@

handbook.pdf: handbook-1.2.0.pdf
handbook.pdf: handbook-1.3.0.pdf
cp $< $@

clean:
Expand Down
62 changes: 32 additions & 30 deletions dokumentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,13 +72,13 @@

Das Planungswerkzeug für überschneidungsfreies Studieren besteht aus **vier Hauptbestandteilen**:

1. **Zwei XML-Dokumente ( Modulbaum und Moduldaten)** ([Download](https://github.com/plues/data/tree/2.3.0/raw))
1. **Zwei XML-Dokumente ( Modulbaum und Moduldaten)** ([Download](https://github.com/plues/data/tree/master/raw))

2. **Mincer zum Zusammenfügen der Dokumente** ([Download](https://github.com/plues/mincer/releases/tag/2.1.0))
2. **Mincer zum Zusammenfügen der Dokumente** ([Windows](https://www3.hhu.de/stups/downloads/plues/mincer/mincer-2.3.0.exe) [MacOs/Linux](https://www3.hhu.de/stups/downloads/plues/mincer/mincer-2.3.0-standalone.jar))

3. **SQlite-Datenbank** ([Download](https://github.com/plues/data/releases/tag/2.3.0))
3. **SQlite-Datenbank** ([Download](https://github.com/plues/data/releases/tag/2.4.0))

4. **Hauptanwendung** ([Download](https://github.com/plues/plues/releases/tag/2.0.0))
4. **Hauptanwendung** ([Download](https://github.com/plues/plues/releases/tag/2.1.0))

Als Grundlage dienen zwei XML-Dokumente, der Modulbaum und die Moduldaten. Diese enthalten alle relevanten Informationen der einzelnen Kurse und Module eines Studienganges, sowie die genauen Veranstaltungszeiten. Die Anwendung mincer fügt diese beiden Dateien zu einer gemeinsamen SQlite- Datenbank zusammen, welche als Grundlage für die Hauptanwendung dient. Nachdem die SQlite-Datenbank von der Hauptanwendung geöffnet wurde, ist diese funktionsfähig.

Expand All @@ -103,7 +103,7 @@ Um ein vernünftiges Arbeiten mit dem Planungswerkzeug für überschneidungsfrei
### <a name="fa"></a> 2.1 Starten der Hauptanwendung und Einlesen der Daten


Die Hauptanwendung wird durch die Datei **plues-2.0.0** gestartet. Nach dem Starten erscheint folgender Bildschirm:
Die Hauptanwendung wird durch die Datei **plues-2.1.0** gestartet. Nach dem Starten erscheint folgender Bildschirm:


![](hauptanwendung1.jpg)
Expand Down Expand Up @@ -1132,22 +1132,22 @@ Bei dem Erstellen neuer Studiengänge müssen beide Dokumente, Modulbaum und Mod


##### Eintragung in die Modulgliederung des Dokuments Modulbaum

1. **Öffnen Datei Modulbaum.**
2. **Scrollen bis vorletze Zeile.**

1. **Öffnen Datei Modulbaum.**
2. **Scrollen bis vorletze Zeile.**
3. **Erstellen des Studiengangs:**
1. Ausdruck als vorletzte Zeile einfügen: `<b cp="" abschl="" stg="" kzfa="" pversion="" name="">` (bei der philosophischen Fakultät kann auf den Ausdruck `cp=""` verzichtet werden, da keine Credit Points angegeben werden).
2. Informationen über den Studiengang in die Anführungszeichen einsetzen (siehe [Abkürzungsverzeichnis](#abkmb)).
3. **Hinweis:** Bei der Eintragung darauf achten, dass der Ausdruck `</modulbaum>` weiterhin ganz am Ende des Dokuments steht
4. **Gliederung des Studienganges in verschiedene Modularten (Wahl-, Pflicht-, Aufbau-, Vertiefungsmodule usw.):**
1. Die Zeile: `<l name="" min-cp="" max-cp="">` für jede Modulart einfügen.
2. Informationen in die Anführungszeichen einfügen.
5. **Einfügen der einzelnen Module:**
1. Für jedes Modul wird die Zeile: `<m cp="" name="" pordnr=""/>` eingefügt.
2. Informationen in die Anführungszeichen einsetzen.
6. **Schließen der einzelnen Abschnitte:**
1. Nach dem Eintragen der einzelnen Module den Ausdruck `</l>` verwenden um die Gliederung in Modularten aus Schritt 4 zu beenden.
2. Zum Schließen des Studienganges den Ausdruck `</b>` verwenden.
1. Ausdruck als vorletzte Zeile einfügen: `<b cp="" abschl="" stg="" kzfa="" pversion="" name="">` (bei der philosophischen Fakultät kann auf den Ausdruck `cp=""` verzichtet werden, da keine Credit Points angegeben werden).
2. Informationen über den Studiengang in die Anführungszeichen einsetzen (siehe [Abkürzungsverzeichnis](#abkmb)).
3. **Hinweis:** Bei der Eintragung darauf achten, dass der Ausdruck `</modulbaum>` weiterhin ganz am Ende des Dokuments steht
4. **Gliederung des Studienganges in verschiedene Modularten (Wahl-, Pflicht-, Aufbau-, Vertiefungsmodule usw.):**
1. Die Zeile: `<l name="" min-cp="" max-cp="">` für jede Modulart einfügen.
2. Informationen in die Anführungszeichen einfügen.
5. **Einfügen der einzelnen Module:**
1. Für jedes Modul wird die Zeile: `<m cp="" name="" pordnr=""/>` eingefügt.
2. Informationen in die Anführungszeichen einsetzen.
6. **Schließen der einzelnen Abschnitte:**
1. Nach dem Eintragen der einzelnen Module den Ausdruck `</l>` verwenden um die Gliederung in Modularten aus Schritt 4 zu beenden.
2. Zum Schließen des Studienganges den Ausdruck `</b>` verwenden.
**Beispiel Bachelor Wirtschaftschemie (nur Pflichtmodule eingefügt)**


Expand All @@ -1158,17 +1158,19 @@ Bei dem Erstellen neuer Studiengänge müssen beide Dokumente, Modulbaum und Mod


![](anleitung1.jpg)
1. **Öffnen der Datei Moduldaten.**
2. **Scrollen bis zum Ende des 1. Abschnitts der Datei.**
Nachfolgende Eintragungen werden zwischen den Audrücken `<modules>` und `</modules>` in das Dokument eingetragen.
3. **Erstellen eines Moduls:**
1. Die Zeile `<module title="" id="" elective-units="" type="" pordnr="" cp="">` einfügen (Bei der philosophischen Fakultät kann auf den Ausdruck `cp=""` verzichtet werden, da die Module nicht auf Credit Points basieren).
2. Informationen in die Anführungszeichen einsetzen (siehe [Abkürzungsverzeichnis](#abkmd1)).
4. **Einfügen der einzelnen Kurse:**
1. Die Zeile `<abstract-unit title="" id="" type="" semester=""/>` für jeden Kurs einfügen.
2. Informationen in die Anführungszeichen einsetzen.

1. **Öffnen der Datei Moduldaten.**
2. **Scrollen bis zum Ende des 1. Abschnitts der Datei.**
Nachfolgende Eintragungen werden zwischen den Audrücken `<modules>` und `</modules>` in das Dokument eingetragen.
3. **Erstellen eines Moduls:**
1. Die Zeile `<module title="" id="" elective-units="" type="" pordnr="" cp="">` einfügen (Bei der philosophischen Fakultät kann auf den Ausdruck `cp=""` verzichtet werden, da die Module nicht auf Credit Points basieren).
2. Informationen in die Anführungszeichen einsetzen (siehe [Abkürzungsverzeichnis](#abkmd1)).
4. **Einfügen der einzelnen Kurse:**
1. Die Zeile `<abstract-unit title="" id="" type="" semester=""/>` für jeden Kurs einfügen.
2. Informationen in die Anführungszeichen einsetzen.
5. **Schließen des Moduls:**
Nach dem Eintragen aller Kurse wird das Modul durch den Ausdruck `</modules>` geschlossen.
Nach dem Eintragen aller Kurse wird das Modul durch den Ausdruck `</modules>` geschlossen.


**Beispiel Modul**

Expand Down

0 comments on commit 2fa920a

Please sign in to comment.