Skip to content

Commit

Permalink
Merge branch 'main' into engine-kj
Browse files Browse the repository at this point in the history
  • Loading branch information
AdLer-Lukas committed Mar 5, 2024
2 parents 80555dd + 312d004 commit d95e466
Show file tree
Hide file tree
Showing 18 changed files with 163 additions and 15 deletions.
41 changes: 31 additions & 10 deletions AdLerDokumentation/Writerside/hi.tree
Original file line number Diff line number Diff line change
Expand Up @@ -15,17 +15,37 @@
</toc-element>
<toc-element topic="Autorentool-BG.md">
<toc-element topic="Funktionale-Anforderungen-Autorentool.md">
<toc-element topic="Lernwelt-CRUDSP-Autorentool.md">
<toc-element topic="ASE1.md"/>
<toc-element topic="ASE2.md"/>
<toc-element topic="ASE3.md"/>
<toc-element topic="ASE4.md"/>
<toc-element topic="ASE5.md"/>
<toc-element topic="ASE6.md">
<toc-element topic="ASE7.md"/>
<toc-element topic="ASE8.md"/>
<toc-element topic="Externes-Lernmaterial-Autorentool.md">
<toc-element topic="Externes-Lernmaterial-Eigenschaften-Autorentool.md"/>
<toc-element topic="Externes-Lernmaterial-Prozesse-Autorentool.md">
<toc-element topic="Externes-Lernmaterial-laden-Autorentool.md"/>
</toc-element>
</toc-element>
<toc-element topic="Lernelement-Autorentool.md">
<toc-element topic="Lernelement-Eigenschaften-Autorentool.md">
<toc-element topic="AWA3.md"/>
</toc-element>
<toc-element topic="Lernelement-CRUDSP-Autorentool.md">
<toc-element topic="AWA2.md"/>
</toc-element>
</toc-element>
<toc-element topic="Lernwelt-Autorentool.md">
<toc-element topic="Lernwelt-Eigenschaften-Autorentool.md"/>
<toc-element topic="Lernwelt-CRUDSP-Autorentool.md">
<toc-element topic="ASE1.md"/>
<toc-element topic="ASE2.md"/>
<toc-element topic="ASE3.md"/>
<toc-element topic="ASE4.md"/>
<toc-element topic="ASE5.md"/>
<toc-element topic="ASE6.md">
<toc-element topic="ASE7.md"/>
<toc-element topic="ASE8.md"/>
</toc-element>
</toc-element>
</toc-element>
<toc-element topic="Lernraum-CRUDSP-Autorentool.md">
<toc-element topic="AWA1.md"/>
</toc-element>
</toc-element>
<toc-element topic="Nicht-funktionale-Anforderungen-Autorentool.md">
<toc-element topic="Oberflächen.md"/>
Expand Down Expand Up @@ -184,6 +204,7 @@
</toc-element>
<toc-element topic="Templates.md">
<toc-element topic="Glossar-Templates.md">
<toc-element topic="Glossareintrag-2-0-Template.md"/>
<toc-element topic="Glossareintrag-Template.md"/>
</toc-element>
<toc-element topic="Spezifikation-Templates.md">
Expand All @@ -203,6 +224,6 @@
<toc-element topic="Funktionale-Anforderung-Plugin.md"/>
</toc-element>
</toc-element>
<toc-element topic="Benutzerdokumentation-Templates.md"/>
</toc-element>
<toc-element topic="Benutzerdokumentation-Templates.md"/>
</instance-profile>
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
17 changes: 17 additions & 0 deletions AdLerDokumentation/Writerside/topics/AWA1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Lernraum Create

## Definition:

Das Autorentool muss Lehrenden die Möglichkeit bieten, einen Lernraum zu erstellen.

## Akzeptanzkriterien:

### Name
- Darf nicht doppelt in Lernwelt existieren
- Muss mindestens 1 Zeichen enthalten
- Darf nicht länger als 60 Zeichen sein
- Darf nur aus Groß- und Kleinbuchstaben, Ziffern, Leerzeichen, Bindestriche und Unterstriche enthalten

## Aktivitätsdiagramm:

![imageAktivitätsdiagrammLernraumErstellen.png](imageAktivitätsdiagrammLernraumErstellen.png)
26 changes: 26 additions & 0 deletions AdLerDokumentation/Writerside/topics/AWA2.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Lernelement Create

## Definition:

Das Autorentool muss Lehrenden die Möglichkeit bieten, ein Lernelement zu erstellen.

## Akzeptanzkriterien:

Die folgenden erforderlichen Eigenschaften müssen angegeben werden:
- [Lernelementname](AWA3.md)
- Externes Lernmaterial

Die folgenden optionalen Eigenschaften können angepasst werden:
- Punkte
- Arbeitsaufwand
- Schwierigkeitsgrad
- 3D-Darstellung
- Lernziele
- Beschreibung


## Aktivitätsdiagramm:

![imageAktivitätsdiagrammLernelementErstellen](imageAktivitätsdiagrammLernelementErstellen.png)

Zuordnung zu Lernwelt/Lernraum (Muss noch im Akti abgebildet werden.)
11 changes: 11 additions & 0 deletions AdLerDokumentation/Writerside/topics/AWA3.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Lernelementname

Validierungsregeln für Lernelementnamen

Erlaubte Zeichenlänge:
- 1 - 60 Zeichen

Erlaubte Zeichen:
- Buchstaben
- Zahlen
- Sonderzeichen: Bindestriche, Unterstriche, Leerzeichen
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Externes Lernmaterial

Start typing here...
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Externes Lernmaterial Eigenschaften

Start typing here...
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Externes Lernmaterial Prozesse

Start typing here...
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Externes Lernmaterial laden

Start typing here...
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Glossareintrag 2.0

<table>
<tr>
<td></td>
<td>Beschreibung</td>
</tr>
<tr>
<td>Akronym</td>
<td>GE</td>
</tr>
<tr>
<td>Begriff</td>
<td>Glossareintrag</td>
</tr>
<tr>
<td>Englischer Begriff</td>
<td>Glossareintrag in englischer Übersetzung</td>
</tr>
<tr>
<td>Definition</td>
<td>Ein Glossareintrag muss eine Begriffsdefinition beinhalten.</td>
</tr>
<tr>
<td>Erlaubte Alternativbenennung</td>
<td>Hier werden erlaubte Alternativbenennungen aufgelistet (hier z.B. "Begriff")</td>
</tr>
<tr>
<td>Verbotene Terminologie</td>
<td>Hier wird verbotene Terminologie für den Glossareintrag aufgelistet (hier z.B. "Wort, Glossarbegriff, Glossi"</td>
</tr>
<tr>
<td>Quelle</td>
<td>Gibt es eine zitierbare Quelle für die Begriffsdefinition? Dann diese hier angeben</td>
</tr>
</table>
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Lernelement

Start typing here...
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Lernelement CRUDSP

Start typing here...
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Lernelement Eigenschaften

Start typing here...
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Lernraum CRUDSP

Start typing here...
3 changes: 3 additions & 0 deletions AdLerDokumentation/Writerside/topics/Lernwelt-Autorentool.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Lernwelt

Start typing here...
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Lernwelt Eigenschaften

Start typing here...
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,16 @@ Speziell für die Vergabe einer Anforderungs-ID beachtet bitte:
</p>
</tip>

## Nützliches zu Auszeichnungssprachen

- [Unterschied Markup und Markdown](https://websiteberater.com/der-unterschied-zwischen-markup-und-markdown/)

- [Was ist Markdown? Sowie tipps und tricks.](https://markdown-syntax.de/Was-ist-Markdown/)

- [Tabellen konvertieren](https://tableconvert.com/xml-to-markdown)

- [Online Markdown Editor (kollaboratives Arbeiten möglich)](https://onlinemarkdowneditor.dev/collaboration/#docec4f8f9abf)

## Templates

**Template anlegen:**
Expand All @@ -82,20 +92,17 @@ Aus jedem Writerside-Topic kann ein Template angelegt werden.

Wie wird ein Template lokal erstellt: Rechts-Klick auf das Topic im
[table of contents](https://www.jetbrains.com/help/writerside//table-of-contents.html)
anschließend wie folgt:
anschließend wie folgt:

![imageHinzufügenEinesTemplates.png](imageHinzufügenEinesTemplates.png)


**Template verwenden:**
Klicke mit rechter Maustaste an die Position in den
[table of contents](https://www.jetbrains.com/help/writerside//table-of-contents.html)
an der ein neues Template erstellt werden soll und dann:

![imageMitHilfeEinesWritersideTemplatesEinNeuesWritersideTopicErstellen.png](imageMitHilfeEinesWritersideTemplatesEinNeuesWritersideTopicErstellen.png)



## Tabellen

In Writerside können verschiedene Arten von Tabellen verwendet werden:
Expand Down Expand Up @@ -146,7 +153,7 @@ an der ein neuer Glossareintrag erstellt werden soll und dann:

## Bilder

[Generelles zu Links in Writerside.](https://www.jetbrains.com/help/writerside//visual-elements.html)
[Generelles zu visuellen Elementen in Writerside.](https://www.jetbrains.com/help/writerside//visual-elements.html)


<tip>
Expand Down

0 comments on commit d95e466

Please sign in to comment.