Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/eagleoutice/sopra-collection

Eine Ansammlung (hoffentlich) wundertoller LaTeX2e Klassen und Pakete, für das Sopra an der Uni Ulm.
https://github.com/eagleoutice/sopra-collection

collection latex latex-class latex-package

Last synced: about 1 month ago
JSON representation

Eine Ansammlung (hoffentlich) wundertoller LaTeX2e Klassen und Pakete, für das Sopra an der Uni Ulm.

Awesome Lists containing this project

README 

        
[![made-with-latex](https://img.shields.io/badge/Made%20with-LaTeX-1f425f.svg)](https://www.latex-project.org/) [![GPL license](https://img.shields.io/badge/License-GPL-blue.svg)](http://perso.crans.org/besson/LICENSE.html) ![Compile all documentations and examples](https://github.com/EagleoutIce/sopra-collection/workflows/Compile%20all%20documentations%20and%20examples/badge.svg)



# sopra-collection



## Motivation



Dies ist eine Ansammlung (hoffentlich) wundertoller LaTeX2e Klassen und Pakete, für das Softwaregrundprojekt

im Rahmen des Informatikstudiums an der Universität Ulm im Wintersemester 2019/20 sowie dem sich anschließendem

Sommersemester.

Einige Pakete, wie `sopra-listings` wurden im Anschluss noch bedeutend Weiterentwickelt.



Es grüßt: Florian (`team-020`).



## Inhaltsübersicht



- [sopra-collection](#sopra-collection)

  - [Motivation](#motivation)

  - [Inhaltsübersicht](#inhaltsübersicht)

  - [Installation](#installation)

    - [Eigenständige Installation](#eigenständige-installation)

    - [Installation mit sltx](#installation-mit-sltx)

  - [Paketübersicht](#paketübersicht)

    - [sopra-base (Dokumentation)](#sopra-base-dokumentation)

    - [sopra-documentation (Dokumentation)](#sopra-documentation-dokumentation)

    - [sopra-models (Dokumentation)](#sopra-models-dokumentation)

    - [sopra-requirements (Dokumentation)](#sopra-requirements-dokumentation)

    - [sopra-tables (Dokumentation)](#sopra-tables-dokumentation)

    - [sopra-attachments (Dokumentation)](#sopra-attachments-dokumentation)

    - [sopra-listings (Dokumentation)](#sopra-listings-dokumentation)

    - [sopra-changelog (Dokumentation)](#sopra-changelog-dokumentation)

    - [sopra-standard (Dokumentation)](#sopra-standard-dokumentation)

    - [sopra-paper (Dokumentation)](#sopra-paper-dokumentation)

    - [sopra-seraphim (Dokumentation)](#sopra-seraphim-dokumentation)

    - [sopra-ntts (Dokumentation)](#sopra-ntts-dokumentation)



## Installation



### Eigenständige Installation



Die Installation kann entweder je nach Dokumentation, oder durch das mitgelieferte python-skript erfolgen. Bei

einem installierten python3.5+ Interpreter genügt:

`python3 installer.py`.



Genauere Informationen zur Angabe des Pfades lassen sich hier finden: [wikibooks](https://en.wikibooks.org/wiki/LaTeX/Installing_Extra_Packages).



### Installation mit sltx



Die Kollektion wird auch mit [sltx](https://github.com/EagleoutIce/sltx) geliefert.

Sie befindet sich hier in den vorgeschlagenen Paketquellen und im Docker-Container ab `tx-default`.

Die Verwendung wird hier über [lithie-util](https://github.com/EagleoutIce/lithie-util) eingerichtet.



## Paketübersicht



Bisher verfügt dieses Repository über die folgenden Klassen und Pakete, die alle jeweils ihre eigene Dokumentation

besitzen und weitestgehend unabhängig voneinander verwendet werden können:



### sopra-base ([Dokumentation](https://media.githubusercontent.com/media/EagleoutIce/sopra-collection/gh-pages/sopra-base/sopra-base.doc.pdf))



Die Basis Dokumentklasse: [sopra-base](sopra-base):

  Hier wird mittels `sopra-base.cls` die Basisklasse für alle Dokumente im Rahmen der Arbeit definiert.

  Es steht frei sie während der Arbeit hinsichtlich ihres Erscheinungsbild zu erweitern und/oder zu

  modifizieren. Hierbei soll die Kompatibilität mit bereits erstellten Dokumenten nicht verletzt werden:



- [sopra-base.cls](sopra-base/sopra-base.cls): Dies ist die versprochene Klassendatei.

- [sopra-base.doc.tex](sopra-base/sopra-base.doc.tex): Dieses Dokument erzeugt die zugehörige Dokumentation. Für sie wird das `sopra-listings`-Paket, sofern es installiert ist, reicht: `pdflatex sopra-base.doc.tex`.



### sopra-documentation ([Dokumentation](https://media.githubusercontent.com/media/EagleoutIce/sopra-collection/gh-pages/sopra-documentation/sopra-documentation.doc.pdf))



Dokumentieren mit: [sopra-documentation](sopra-documentation):

  Dieses Paket definiert alle Befehle die für die Dokumentation verwendet werden (auch die, für die Dokumentation über dieses Paket :smile:)



- [sopra-documentation.sty](sopra-documentation/sopra-documentation.sty): Dies ist das versprochene Paket.

- [sopra-documentation.doc.tex](sopra-documentation/sopra-documentation.doc.tex): Für sie wird das `sopra-listings`-Paket, sofern es installiert ist, reicht: `pdflatex sopra-documentation.doc.tex`.



### sopra-models ([Dokumentation](https://media.githubusercontent.com/media/EagleoutIce/sopra-collection/gh-pages/sopra-models/sopra-models.doc.pdf))



Modelle mit: [sopra-models](sopra-models):

  Dieses Paket erlaubt es, gemeinsam mit dem integrierten (modifizierten) [tikz-uml](https://perso.ensta-paris.fr/~kielbasi/tikzuml/) (UML)-Modelle zu setzen.



- [sopra-models.sty](sopra-models/sopra-models.sty): Dies ist das versprochene Paket.

- [sopra-models.doc.tex](sopra-models/sopra-models.doc.tex): Für sie wird das `sopra-listings`-Paket, sofern es installiert ist, reicht: `pdflatex sopra-models.doc.tex`.



### sopra-requirements ([Dokumentation](https://media.githubusercontent.com/media/EagleoutIce/sopra-collection/gh-pages/sopra-requirements/sopra-requirements.doc.pdf))



Anforderungsdefinitionen mit: [sopra-requirements](sopra-requirements):

  Dieses Paket erlaubt es, funktionale und nicht-funktionale Anforderungen zu definieren und zu referenzieren.



- [sopra-requirements.sty](sopra-requirements/sopra-requirements.sty): Dies ist das versprochene Paket.

- [sopra-requirements.doc.tex](sopra-requirements/sopra-requirements.doc.tex): Für sie wird das `sopra-listings`-Paket, sofern es installiert ist, reicht: `pdflatex sopra-requirements.doc.tex`.



### sopra-tables ([Dokumentation](https://media.githubusercontent.com/media/EagleoutIce/sopra-collection/gh-pages/sopra-tables/sopra-tables.doc.pdf))



Tabellen mit: [sopra-tables](sopra-tables):

  Dieses Paket erlaubt es, Tabellen hübsch zu gestalten:



- [sopra-tables.sty](sopra-tables/sopra-tables.sty): Dies ist das versprochene Paket.

- [sopra-tables.doc.tex](sopra-tables/sopra-tables.doc.tex): Für sie wird das `sopra-listings`-Paket, sofern es installiert ist, reicht: `pdflatex sopra-tables.doc.tex`.



### sopra-attachments ([Dokumentation](https://media.githubusercontent.com/media/EagleoutIce/sopra-collection/gh-pages/sopra-attachments/sopra-attachments.doc.pdf))



Dateien einbetten mit: [sopra-attachments](sopra-attachments):

  Dieses Paket erlaubt es, Dokumente in eine PDF einzubetten:



- [sopra-attachments.sty](sopra-attachments/sopra-attachments.sty): Dies ist das versprochene Paket.

- [sopra-attachments.doc.tex](sopra-attachments/sopra-attachments.doc.tex): Für sie wird das `sopra-listings`-Paket, sofern es installiert ist, reicht: `pdflatex sopra-attachments.doc.tex`.



### sopra-listings ([Dokumentation](https://media.githubusercontent.com/media/EagleoutIce/sopra-collection/gh-pages/sopra-listings/sopra-listings.doc.pdf))



Listings mit: [sopra-listings](sopra-listings):

  Dieses Paket erlaubt es, Quellcode in PDF mit Syntax-Highlighting zu setzen:



- [sopra-listings.sty](sopra-listings/sopra-listings.sty): Dies ist das versprochene Paket.

- [sopra-listings.doc.tex](sopra-listings/sopra-listings.doc.tex): Für sie wird das Paket selbst benötigt, dann reicht: `pdflatex sopra-listings.doc.tex`.



Das Paket bietet eine Unterstützung für [color-palettes](https://github.com/EagleoutIce/color-palettes), Beispiele befinden sich [hier](https://media.githubusercontent.com/media/EagleoutIce/sopra-collection/gh-pages/sopra-listings/examples/cp-listings.example.pdf) und [hier](https://media.githubusercontent.com/media/EagleoutIce/sopra-collection/gh-pages/sopra-tables/examples/cp-tables.example.pdf).



### sopra-changelog ([Dokumentation](https://media.githubusercontent.com/media/EagleoutIce/sopra-collection/gh-pages/sopra-changelog/sopra-changelog.doc.pdf))



Changelogs mit: [sopra-changelog](sopra-changelog):

  Dieses Paket erlaubt es, Änderungen in Dokumenten festzuhalten:



- [sopra-changelog.sty](sopra-changelog/sopra-changelog.sty): Dies ist das versprochene Paket.

- [sopra-changelog.doc.tex](sopra-changelog/sopra-changelog.doc.tex): Für sie wird das `sopra-listings`-Paket, sofern es installiert ist, reicht: `pdflatex sopra-changelog.doc.tex`.



### sopra-standard ([Dokumentation](https://media.githubusercontent.com/media/EagleoutIce/sopra-collection/gh-pages/sopra-standard/sopra-standard.doc.pdf))



Sopra-Standard mit: [sopra-standard](sopra-standard):

  Dieses Paket wurde für das Standardisierungsdokument verwendet:



- [sopra-standard.sty](sopra-standard/sopra-standard.sty): Dies ist das versprochene Paket.

- [sopra-standard.doc.tex](sopra-standard/sopra-standard.doc.tex): Für sie wird das `sopra-listings`-Paket, sofern es installiert ist, reicht: `pdflatex sopra-standard.doc.tex`.



### sopra-paper ([Dokumentation](https://media.githubusercontent.com/media/EagleoutIce/sopra-collection/gh-pages/sopra-paper/sopra-paper.doc.pdf))



Das Dokumentlayout mit: [sopra-paper](sopra-paper):

  Diese Dokumentklasse wurde für den Standard, und die Meilensteine von Team020 verwendet:



- [sopra-paper.cls](sopra-paper/sopra-paper.cls): Dies ist die versprochene Dokumentklasse.

- [sopra-paper.doc.tex](sopra-listings/sopra-paper.doc.tex): Für sie wird das Paket selbst benötigt, dann reicht: `pdflatex sopra-paper.doc.tex`.



### sopra-seraphim ([Dokumentation](https://media.githubusercontent.com/media/EagleoutIce/sopra-collection/gh-pages/sopra-seraphim/sopra-seraphim.doc.pdf))



Präsentationen mit: [sopra-seraphim](sopra-seraphim):

  Diese Dokumentklasse wurde für die Telegramme und die Abschlusspräsentation von Team020 verwendet:



- [sopra-seraphim.cls](sopra-changelog/sopra-seraphim.cls): Dies ist das versprochene Dokumentklasse.

- [sopra-seraphim.doc.tex](sopra-changelog/sopra-seraphim.doc.tex): Für sie wird das `sopra-listings`-Paket, sofern es installiert ist, reicht: `pdflatex sopra-seraphim.doc.tex`.



### sopra-ntts ([Dokumentation](https://media.githubusercontent.com/media/EagleoutIce/sopra-collection/gh-pages/sopra-ntts/sopra-ntts.doc.pdf))



Schriftzüge mit: [sopra-ntts](sopra-ntts):

  Dieses Paket enthält den ntts-Schriftzug.



- [sopra-ntts.cls](sopra-changelog/sopra-ntts.cls): Dies ist das versprochene Dokumentklasse.

- [sopra-ntts.doc.tex](sopra-changelog/sopra-ntts.doc.tex): Für sie wird das `sopra-listings`-Paket, sofern es installiert ist, reicht: `pdflatex sopra-ntts.doc.tex`.