Styleguide: Übersichtsartikel für Module: Unterschied zwischen den Versionen
Jaeger (Diskussion | Beiträge) |
Jaeger (Diskussion | Beiträge) |
||
| Zeile 6: | Zeile 6: | ||
<code><nowiki> | <code><nowiki> | ||
[[Bild:Module.png|right|verweis=http://www.mauve.eu/]] | [[Bild:Module.png|right|verweis=http://www.mauve.eu/]] | ||
| − | </nowiki></code><br> | + | </nowiki></code><br><br> |
Danach kommt eine Table of Contents:<br> | Danach kommt eine Table of Contents:<br> | ||
<code><nowiki> | <code><nowiki> | ||
__TOC__ | __TOC__ | ||
| − | </nowiki></code> | + | </nowiki></code><br><br> |
Am Anfang gibt es einen kurzen einführenden Text. In diesem wird in zwei bis drei Sätzen erläutert, was das Modul macht und an welche Zielgruppe es sich richtet.<br> | Am Anfang gibt es einen kurzen einführenden Text. In diesem wird in zwei bis drei Sätzen erläutert, was das Modul macht und an welche Zielgruppe es sich richtet.<br> | ||
Sollten speziellere Vorbereitungen notwendig für die Nutzung des Moduls sein, wird ein entsprechender Bereich zusätzlich angegeben.<br> | Sollten speziellere Vorbereitungen notwendig für die Nutzung des Moduls sein, wird ein entsprechender Bereich zusätzlich angegeben.<br> | ||
Version vom 6. März 2012, 11:29 Uhr
Allgemeines
Modulartikel beginnen immer mit S3Modul-Bildlink:
[[Bild:Module.png|right|verweis=http://www.mauve.eu/]]
Danach kommt eine Table of Contents:
__TOC__
Am Anfang gibt es einen kurzen einführenden Text. In diesem wird in zwei bis drei Sätzen erläutert, was das Modul macht und an welche Zielgruppe es sich richtet.
Sollten speziellere Vorbereitungen notwendig für die Nutzung des Moduls sein, wird ein entsprechender Bereich zusätzlich angegeben.
Hierbei wird auf die entsprechenden Einstellungsdialog-Beschreibung verlinkt.
Danach folgt ein Textbereich mit einer ausführlichen Beschreibung des Arbeitsablaufs dieses Moduls. Ist dieser zu lang, wird dieser in einen entsprechenden Prozessartikel ausgelagert.
Am Ende wird eine Fußzeile des Artikels (wie unter Einfache Darstellung/Fußzeilen beschrieben) eingefügt. Als Kategorie wird Modul angegeben.
Beispiel:
[[Bild:Module.png|right|verweis=http://www.mauve.eu/]]
__TOC__
=Einführung=
Einleitender Text: Was macht das Modul? Für wen ist das Modul wichtig/interessant?
<br style="clear:both" />
=Vorausetzungen=
Spezielle Vorbereitungen (Freischaltung von Fremdanbietermodulen, Übermittlung von Zugangsdaten)
:''Hauptartikel: [[Einstellungen]]
<br style="clear:both" />
=Arbeitsablauf=
[[Bild:Arbeitsablauf-Schema.png|right]
Textbereich mit einer ausführlichen Beschreibung des Arbeitsablaufs dieses Moduls.
<br style="clear:both" />
[…]
Fußzeile des Artikels (wie unter Einfache Darstellung/Fußzeilen beschrieben)
[[Category:Module]]
- Siehe auch