Doku_mod
Hier steht unter der Überschrift eine kurze Beschreibung des Moduls, welchen Zweck es erfüllt und welche Features es eben bietet.
Inhaltsverzeichnis [verbergen]
Ansichten
Hier werden die Verschiedenen Ansichten aufgelistet und Erklärt (list, listcat, ect.)Adminstration
Verwaltung
(Allgemeine)Erklärung der Verwaltung des Moduls Zum Bild: Hier sollte natürlich der Screenshot der Verwaltung abgebildet werden![MEIST manage] z. B. Das Modul XXX bietet die Administratorischen Möglichkeiten XXXe zu erstellen, editieren, löschen und natürlich ihnen Rechte zu verschiedenen Kategorien zu geben. Die Inhalte werden Hauptsächslich in der Verwaltung bearbeitet. Bei diesem Modul hat man auch die Möglichkeit in den System Optionen allgemeine Änderungen der Übersicht einzustellen. (Oder so in der Art)Erstellung
Erstellung beschreiben Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nam elit diam, pharetra in fermentum ut, congue at urna. Ut ultricies nunc at est porta a aliquet mauris volutpat. Vestibulum accumsan lacinia placerat. Maecenas sed lectus libero, at ultricies risus. Sed sed ante magna. Proin non lorem venenatis lorem vulputate tempus at in sapien. Aliquam ut nisi tortor. Integer erat enim, pharetra ut venenatis sit amet, ultrices at elit. Etiam ut risus sed est dictum accumsan. In hac habitasse plateaEditierung
Editierung Beschreibung Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nam elit diam, pharetra in fermentum ut, congue at urna. Ut ultricies nunc at est porta a aliquet mauris volutpat. Vestibulum accumsan lacinia placerat. Maecenas sed lectus libero, at ultricies risus. Sed sed ante magna. Proin non lorem venenatis lorem vulputate tempus at in sapien. Aliquam ut nisi tortor. Integer erat enim, pharetra ut venenatis sit amet, ultrices at elit. Etiam ut risus sed est dictum accumsan. In hac habitasse plateaoder mehr
Wenn noch es noch mehr Verwaltungsmöglichkeiten gibt, dann hier Beschreiben. Je nach Wichtigkeit, bzw. Schwierigkeit, Ausführlich, sehr Ausführlich oder Kurz.Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nam elit diam, pharetra in fermentum ut, congue at urna. Ut ultricies nunc at est porta a aliquet mauris volutpat. Vestibulum accumsan lacinia placerat. Maecenas sed lectus libero, at ultricies risus. Sed sed ante magna. Proin non lorem venenatis lorem vulputate tempus at in sapien. Aliquam ut nisi tortor. Integer erat enim, pharetra ut venenatis sit amet, ultrices at elit. Etiam ut risus sed est dictum accumsan. In hac habitasse platea
System
Falls Einstellungen im System einstellbar sind, auch eine erklärung der SystemoptionenPlatzhalter
Wenn vorhanden, hier eine Auflistung aller Template Platzhalter und was diese bewirken. Evtl sogar bei interessanten mit Bild.Dateien
Modul-Teile
Das Modul "boardmods" besteht aus mehreren Teilen:- Sprachdatei (/lang/<SPRACHPAKET>/boardmods.php)
- Modul-Order (/mods/boardmods/)
- Themes-Order (/themes/<THEMENPAKET>/boardmods/)
- Kategorie Funktionsdatei (mods/categories/functions.php)
- Wird gebraucht für diese Dateien: mods/boardmods/create.php und mods/boardmods/edit.php
Beschreibung
| Ordner: mods/boardmods/ | |
| access.php | In dieser Datei wird das Mindestaccesslevel festgelegt, das man braucht, um eine bestimmte Datei innerhalb dieses Ordners aufzurufen. |
| create.php | Wird zum Erstellen eines Forenmoderators gebraucht. |
| Ordner: themes/[THEMESET]/boardmods/ | |
| create.tpl | Ausgabe der create.php (Hier der Zusatz wie z. B. User Themes Eingeloggt oder nichteingeloggt) |
| Ordner: lang/ | |
| de/boardmods.php | Die deutschen Sprachdateien zu dem Modul. |
| en/boardmods.php | Die englischen Sprachdateien zu dem Modul. |
FAQ
Hier können häufige Fragen zum Modul stehen. Viele davon werden sicherlich im Forum anfallen und sollten dann natürlich hier beantwortet werden, um in Zukunft im Forum darauf verweisen zu können. Dabei ist weniger an Probleme gedacht (siehe unten), mehr an wie geht das, wie geht das, und dies und jenes...Typische Probleme
Hier kommen dann alle typischen Probleme, jedes mit einer eigenen Überschrift, um die Navigation zu erleichtern. Natürlich sollte auch eine Hilfe bzw. Lösung angegeben werden. Überschriften sollten bitte auch eine Kurze Beschreibung enthaltenProblem 1 - Schlagwort
Beschreibung des Problems + LösungProblem 2 - Schlagwort
Beschreibung des Problems + LösungStand
Version 2009.0| « | Doku_mod | » |
Code für die Bilder: (Rechts)
[.html]
<div style="float:right; width:auto;">
<div style="width:160px; border:1px solid #D0D0D0; background-color:#FAFAFA; text-align: left; font-style: italic; font-size: 0.8em">
<a href="Link volles bild"><img src="Link Thumbnail" style="margin: 1px 5px" alt="Thumbnail Name" /></a><br />
ERKLAERUNG
</div>
</div>
[./html]
Code für die Bilder: (Links)
[.html]
<div style="float:Left; width:auto;">
<div style="width:160px; border:1px solid #D0D0D0; background-color:#FAFAFA; text-align: left; font-style: italic; font-size: 0.8em">
<a href="Thumbnail Name"><img src="Thumbnail Name" style="margin: 1px 5px" alt="Thumbnail Name" /></a><br />
ERKLAERUNG
</div>
</div>
[./html]
Natürlich darf die Breite Angepasst werden! In diesem Beispiel kommt es so rüber, dass das Thumbnail ein Auszug sein muss. Muss nicht! Bilder können aber auch im Text sein und nicht am Rand. Die Entscheidung bleibt euch überlassen. Auch könnte man neben dem Inhaltsverzeichniss Bilder des Moduls reinstellen. Kreativität auf eigene Gefahr^^
Rest:
Überschrift
<br /><br />
[TOC]
<br /><br />
==Ansichten==
==Adminstration==
===Verwaltung===
==== (Unterpunkt) ====
===System===
==Platzhalter==
==Dateien==
===Modul-Teile===
Das Modul "XXX" besteht aus mehreren Teilen:
* Sprachdatei (/lang/<SPRACHPAKET>/XXXX.php)
* Modul-Order (/mods/XXX/)
* Themes-Order (/themes/<THEMENPAKET>/XXX/)
* Kategorie Funktionsdatei (mods/categories/functions.php)
** Wird gebraucht für diese Dateien: mods/XXX/XXXX.php und mods/XXX/XXXX.php
=== Beschreibung ===
[.html]<center>
<table width="80%" border="1" cellspacing="0" cellpadding="1">
<tr>
<td colspan="2" valign="top">Ordner: mods/XXXX/</td>
</tr>
<tr>
<td width="124" valign="top">access.php</td>
<td valign="top">In dieser Datei wird das Mindestaccesslevel festgelegt, das man braucht, um eine bestimmte Datei innerhalb dieses Ordners aufzurufen.</td>
</tr>
<tr>
<td valign="top">XXX.php</td>
<td valign="top">XXXX</td>
</tr>
<tr>
<td colspan="2" valign="top" height="1"></td>
</tr>
<tr>
<td colspan="2" valign="top">Ordner: themes/[THEMESET]/XXXX/</td>
</tr>
<tr>
<td valign="top">XXXX.tpl</td>
<td valign="top">XXXX</td>
</tr>
<tr>
<td colspan="2" valign="top" height="1"></td>
</tr>
<tr>
<td colspan="2" valign="top">Ordner: lang/</td>
</tr>
<tr>
<td valign="top">de/XXXX.php</td>
<td valign="top">Die deutschen Sprachdateien zu dem Modul.</td>
</tr>
<tr>
<td valign="top">en/XXXX.php</td>
<td valign="top">Die englischen Sprachdateien zu dem Modul.</td>
</tr>
</table></center>
[./html]
==FAQ==
==Typische Probleme==
===Problem 1 - XXXX===
===Problem 2 - XXXX===
== Stand ==
Version 20xx.x
<<Module_Trails>>
