Svarrers FAQ

Plugin für CMSimple

Version 0.1

Svarrers FAQ ist ein Plugin, das einfach und übersichtlich eine "Frequently Asked Questions" Seite anzeigt. Fragen können nach Themen geordnet werden, ein Klick auf ein Thema öffnet den dazugehörenden Fragenkatalog. Antworten werden durch Anklicken der entsprechenden Frage angezeigt (siehe Abbildung).

Example
FAQ Seite nach Klick auf Frage "Question 1"

 

1. Installation

Nach dem Entpacken des Plugins wird es in das Plugin-Unterverzeichnis von CMSimple kopiert. Das Anwählen des Plugins aus dem Konfigurationsmenü heraus bietet bis zu vier Optionen:

1) den Text Editor, mit dem die Fragen und Antworten erstellt werden. Die Daten werden in einer externen Datei gespeichert.

2) das Stylesheet des Plugins, das hier verändert werden kann

3) Zugriff zur Sprachdatei und

4) den Aufruf dieser Hilfe-Seite, falls der Hilfe Order ordnungsgemäß in das Plugin-Verzeichnis kopiert worden ist..

 

2. Aufruf der FAQ Seite

Die Seite, die die faq anzeigen soll, erhält z.B. die H1-Überschrift "FAQ". Um dieser Seite das Plugin zuzuordnen, gibt man hier folgendes Skript an:

#cmsimple $output .= faq();#

 

3. Struktur der "Fragen" und "Antworten"

Die Fragen und Antworten können mit dem Editor des Plugins eingegeben werden. Der Editor versteckt sich unter dem Knopf "Plugin-Einstellungen" oder "Plugin-Editor" (falls die alte admin.php Datei mit der modifizierten ausgetauscht worden ist) in der Konfiguration des Plugins. Die Daten werden im "content" Unterverzeichnis des Plugins als "faq_de.txt" gespeichert.

Der Aufbau der Themen, Fragen und Antworten sieht folgendermaßen aus.

Erstes Thema
Frage 1:Antwort 1
Frage 2:Antwort 2
Zweites Thema
Frage 1:Antwort 1
Frage 2:Antwort 2

Alleinstehende Begriffe (wie "Erstes Thema") bezeichnen einen thematischen Überbegriff zu einem bestimmten Fragenkomplex. Jeweils darunter folgen die einzelnen Fragen mit den dazugehörenden Antworten. Dabei werden die Antworten durch Doppelpunkt von den ihnen zugeordneteten Fragen getrennt.

 

© Hilfe-Datei von Tillman Schuster, NMuD, Juni 2008