From b73bde3ac98fbd2bce74237d0e5b4afb7733277d Mon Sep 17 00:00:00 2001 From: Tobias Wylega Date: Sun, 14 Apr 2024 12:19:22 +0200 Subject: [PATCH] Typos / minor changes --- Chapters/2-Planung.typ | 4 ++-- Chapters/3-Entwurf.typ | 32 ++++++++++++++++++-------------- Diagrams/ER.typ | 33 ++++++++++++++++++--------------- Diagrams/ER_Translation.typ | 18 +++++++++++------- Template/customFunctions.typ | 3 ++- sources.bib | 17 +++++++++++++++++ 6 files changed, 68 insertions(+), 39 deletions(-) diff --git a/Chapters/2-Planung.typ b/Chapters/2-Planung.typ index a924f24..37e24d6 100644 --- a/Chapters/2-Planung.typ +++ b/Chapters/2-Planung.typ @@ -101,7 +101,7 @@ Die Ergebnisse aus den vorherigen Abschnitten werden mithilfe der Use–Case–M */ #useCase(1)[ - Studiengang per Suche finden + Studiengang per Suche finden ][ Studieninteressierte Person ][ @@ -296,7 +296,7 @@ Die Nicht-Funktionalen Anforderungen ergeben sich aus einem Brainstorming unter ] #task(title: [Benutzbarkeit])[ #narrowTrack("Aktueller Pfad", type:"N", label: )[ - System könnte anzeigen, welcher Pfad aufgerufen wurde (Fakultät->Studiengang->Modul). + System könnte anzeigen, welcher Pfad aufgerufen wurde \ (z.B. Fakultät->Studiengang->Modul). ] #narrowTrack("Rückfragen", type:"N", label:)[ diff --git a/Chapters/3-Entwurf.typ b/Chapters/3-Entwurf.typ index ee0a03e..ee7da68 100644 --- a/Chapters/3-Entwurf.typ +++ b/Chapters/3-Entwurf.typ @@ -20,16 +20,16 @@ Das Modul enthält zunächst grundlegende Informationen: ] #track("Modulniveau")[ - Hier steht entweder Grundlagenmodul oder Vertiefungsmodul. + Hier ist angegeben, ob das Modul ein Grundlagenmodul oder Vertiefungsmodul ist. ] #track("Pflicht / Wahlpflicht")[ - Hier steht entweder Pflichtmodul oder Wahlpflichtmodul. - Studierende müssen alle Pflichtmodule absolvieren und müssen eine bestimmte Anzahl an selbstausgewählten Wahlpflichtmodul absolieren. + Hier ist angegeben, ob das Modul ein Pflichtmodul oder Wahlpflichtmodul ist. + Studierende müssen alle Pflichtmodule absolvieren und müssen eine bestimmte Anzahl an selbst ausgewählten Wahlpflichtmodulen absolvieren. ] #track("Teilmodule")[ - Auflistung aller Teilmodule. + Eine Auflistung aller Teilmodule. ] #track("Verantwortliche(r)", example: "Wohlfeil, Stefan, Prof. Dr.")[ @@ -41,15 +41,15 @@ Das Modul enthält zunächst grundlegende Informationen: ] #track("Präsenzstunden / Selbststudium", example: "68 h / 112 h")[ - Aufwand des Studiums, aufgeteilt nach der Zeit die in der Hochschule verbracht wird und der Zeit, die im Selbststudium verbracht wird (Arbeit an Übungen, Prüfungsvorbereitung...). + Aufwand des Studiums, aufgeteilt nach der Zeit, die in der Hochschule verbracht wird und der Zeit, die im Selbststudium verbracht wird (Arbeit an Übungen, Prüfungsvorbereitung …). ] #track("Studiensemester")[ Vorgeschlagenes Semester. Anhand dieser Information wird das Curriculum generiert (@mdiCurr). ] -#track("Moduldauer")[ - In der Regel "1 Semester". +#track("Moduldauer", example: "1 Semester")[ + Hier ist angegeben, wie lange es dauert das Modul zu absolvieren. ] #track("Voraussetzungen nach Prüfungsordnung", example: "Alle Modulprüfungen des 1. bis 3. Semesters")[ @@ -61,11 +61,11 @@ Das Modul enthält zunächst grundlegende Informationen: ] #track("Studien-/ Prüfungsleistungen", example: "Referat (Hausarbeit plus Präsentation/Vortrag), Anwesenheitspflicht")[ - Kommagetrennte Auflistung der zu erbringenden Leistungen. + Eine kommagetrennte Auflistung der zu erbringenden Leistungen. ] #track("Angestrebte Lernergebnisse", example: "Die Studierenden sind in der Lage, dreidimensionale Objekte zu gestalten, zu bewegen und zueinander in Beziehung zu setzen.", label:)[ - Eine Stichpunktartige, Kommagetrennte Auflistung der Kompetenzen. + Eine stichpunktartige, kommagetrennte Auflistung der Kompetenzen, die in diesem Modul erworben werden. ] #text(" ") @@ -79,12 +79,16 @@ Die Teilmodule enthalten zusätzlich weitere Informationen: } ] -#track("Sprache")[ - Hier steht immer entweder "nach Vereinbarung" oder "deutsch". +#track("Titel", example: "BIN-100-01 Mathematik 1")[ + Der Titel des Teilmoduls setzt sich zusammen aus dem Kürzel des übergeordneten Moduls, einer eigenen Nummer und dem Namen des Teilmoduls. +] + +#track("Sprache", example: ["nach Vereinbarung" oder "deutsch"])[ + Hier ist angegeben, in welcher Sprache die Veranstaltung stattfindet. ] #track("Zuordnung zu Curricula", example: "BIN, MDI")[ - Auflistung aller Studiengänge, in denen dieses Teilmodul verwendet wird. + Eine kommagetrennte Auflistung aller Studiengänge, in denen dieses Teilmodul verwendet wird. ] #track("Veranstaltungsart, SWS", example: "Vorlesung mit Übung, 4 SWS")[ @@ -120,8 +124,8 @@ Reges, S., Stepp, M.: Building Java Programs, Prentice Hall")[ == Datenbankschema -Um die Datenstruktur zu planen wurde zunächst ein ER-Diagramm erstellt (@ER). -Hierfür wurden im ersten Schritt Tabellen für Module und Teilmodule geplant. Damit das System auch für alle Fakultäten und alle Studiengänge nutzbar ist wurden zusätzlich die Tabellen Faculty und Course geplant. +Die Erstellung eines Datenbankschemas ist ein wichtiger Schritt. Mit einem vollständigen Datenbankschema wird sichergestellt, dass alle benötigten Daten in der Datenbank gespeichert werden können, dass auf die Daten effizient zugegriffen werden kann und dass die Datenkonsistenz gewährleistet ist. @relationaleDb[Kapitel 3] \ Bei der Konzeption wurde darauf geachtet, dass die entstehende Datenbank in der dritten Normalform vorliegen wird, um Anomalien zu vermeiden. @relationaleDb[Kapitel 9]\ +Im ersten Schritt wurden Tabellen für Module und Teilmodule geplant. Damit das System auch für alle Fakultäten und alle Studiengänge nutzbar ist wurden zusätzlich die Tabellen Faculty und Course geplant. Um die Anforderungen @SHOWCHANGES und @REVERT vorzubereiten wurde die Tabelle Changelog genutzt. Die bestehende User-Tabelle wurden an verschiedenen Stellen referenziert, um beispielsweise die Verantwortlichen Personen anzugeben. Eigenschaften die aus @requirements oder aus @properties hervorgehen sind dementsprechend markiert. diff --git a/Diagrams/ER.typ b/Diagrams/ER.typ index d975a0f..1c3c98f 100644 --- a/Diagrams/ER.typ +++ b/Diagrams/ER.typ @@ -9,13 +9,15 @@ erDiagram Course { INTEGER Id TEXT Title - VARCHAR Shortcut + VARCHAR Shortcut(E1) } Module { INTEGER Id + INTEGER Number(E1) TEXT Title(E1) TEXT Subtitle(E2) + VARCHAR Shortcut(E2) TEXT Niveau(E3) TEXT Type(E4) INTEGER Credits(E7) @@ -32,15 +34,16 @@ erDiagram SubModule { INTEGER Id - TEXT Language(E15) - TEXT Type(E17) - INTEGER PresenceHoursPerWeek(E17) - TEXT LearningRecommendations(E18) - INTEGER GroupSize(E19) - TEXT Content(E20) - TEXT PresenceRequirements(E21) - TEXT LearningRequirements(E22) - TEXT Literature(E23) + INTEGER Number(E15) + TEXT Language(E16) + TEXT Type(E18) + INTEGER PresenceHoursPerWeek(E18) + TEXT LearningRecommendations(E19) + INTEGER GroupSize(20) + TEXT Content(E21) + TEXT PresenceRequirements(E22) + TEXT LearningRequirements(E23) + TEXT Literature(E24) } User { @@ -67,14 +70,14 @@ ChangelogItem { Faculty ||--o{ Course : "Courses" -Course ||--o{ Module : "Modules(E16)" +Course ||--o{ Module : "Modules(E17)" -Module ||--o{ SubModule : "Submodules(E5)" +Module }o--o{ SubModule : "Submodules(E5)" -Module ||--o{ User : "Responsible(E6)" -Course ||--o{ User : "Responsible" +Module }o--|| User : "Responsible(E6)" +Course }o--|| User : "Responsible" -Changelog ||--o{ User : "Author(F15)" +Changelog }o--|| User : "Author(F15)" Changelog ||--o{ ChangelogItem : "Changes(F16)" ``` \ No newline at end of file diff --git a/Diagrams/ER_Translation.typ b/Diagrams/ER_Translation.typ index 346bcb9..687c45c 100644 --- a/Diagrams/ER_Translation.typ +++ b/Diagrams/ER_Translation.typ @@ -3,8 +3,7 @@ erDiagram TranslatedText { INTEGER Id - VARCHAR Default - VARCHAR English + VARCHAR Text } Module { @@ -23,15 +22,20 @@ erDiagram INTEGER Id } + Language { + INTEGER Id + VARCHAR Name + VARCHAR ISOCode +} + -Module ||--o{ ModuleTitle : "Title(E1)" -Module ||--o{ ModuleSubtitle : "Subtitle(E2)" -Module ||--o{ ModuleNiveau : "Niveau(E3)" +Module ||--|| ModuleTitle : "Title(E1)" +Module ||--|| ModuleSubtitle : "Subtitle(E2)" +Module }o--|| ModuleNiveau : "Niveau(E3)" ModuleTitle ||--o{ TranslatedText : "Translated_Title" ModuleSubtitle ||--o{ TranslatedText : "Translated_Title" ModuleNiveau ||--o{ TranslatedText : "Translated_Title" - - +TranslatedText }o--|| Language : "Language" ``` \ No newline at end of file diff --git a/Template/customFunctions.typ b/Template/customFunctions.typ index ec2e3b4..1777c34 100644 --- a/Template/customFunctions.typ +++ b/Template/customFunctions.typ @@ -66,7 +66,8 @@ [Kurzbeschreibung], kurzbeschreibung, [Akteur], akteur, [Vorbedingungen], vorbedingungen, - [Hauptszenario], hauptszenario + [Hauptszenario], hauptszenario, + // [Nachbedingung], nachbedingung ) ]]] ] diff --git a/sources.bib b/sources.bib index 896d7d1..744478e 100644 --- a/sources.bib +++ b/sources.bib @@ -187,3 +187,20 @@ @online{angularStructure urldate = {2024-03-19}, file = {Angular - Workspace and project file structure:C\:\\Users\\lepha\\Zotero\\storage\\DMQ9769E\\file-structure.html:text/html}, } + + +@book{relationaleDb, + address = {Berlin, Heidelberg}, + title = {Relationale {Datenbanken}: {Von} den theoretischen {Grundlagen} zu {Anwendungen} mit {PostgreSQL}}, + copyright = {http://www.springer.com/tdm}, + isbn = {978-3-662-58975-5 978-3-662-58976-2}, + shorttitle = {Relationale {Datenbanken}}, + url = {http://link.springer.com/10.1007/978-3-662-58976-2}, + language = {de}, + urldate = {2024-04-14}, + publisher = {Springer Berlin Heidelberg}, + author = {Studer, Thomas}, + year = {2019}, + doi = {10.1007/978-3-662-58976-2}, + file = {Studer - 2019 - Relationale Datenbanken Von den theoretischen Gru.pdf:C\:\\Users\\lepha\\Zotero\\storage\\27YN9YGC\\Studer - 2019 - Relationale Datenbanken Von den theoretischen Gru.pdf:application/pdf}, +}