Willkommen zur Dokumentation für FirstSpirit Entwickler
An welche Anwender richtet sich diese Dokumentation?
Diese Dokumentation beschäftigt sich mit der Vorlagenentwicklung und Plugin-Entwicklung in FirstSpirit. Durch die Verknüpfung unterschiedlicher Teilbereiche der Vorlagenentwicklung und der Unterteilung in zwei Schwierigkeitsstufen für Einsteiger (siehe Grundlagen der Vorlagenentwicklung) und für fortgeschrittene Anwender (siehe Vorlagenentwicklung) stellt diese Dokumentation übersichtlich strukturierte Informationen bereit und soll damit die Einarbeitung in die Vorlagensyntax von FirstSpirit erleichtern.
Teilbereiche der Online-Dokumentation
Diese Online-Dokumentation ist gegliedert in folgende Hauptabschnitte:
Vorlagenentwicklung
In diesem Abschnitt können alle wichtigen Aspekte für die Entwicklung eines FirstSpirit-Projektes in der Vorlagen-Verwaltung nachgeschlagen werden. Der Abschnitt ist in die entsprechenden Teilaspekte der Vorlagenentwicklung gegliedert. Dazu gehören:
- Formulare für die Definition von Eingabekomponenten.
- Regeln zur Beeinflussung von bestimmten Elementen oder Eigenschaften eines Formulars
- Schnipsel zur Beeinflussung von Objektanzeigen („Teaser“)
- Vorlagensyntax untergliedert in Anweisungen, Ausdrücke, Datentypen und Funktionen.
- Variablen zur Auswertung von Inhalten unterschiedlicher Bereiche.
- ContentCreator bietet Informationen zu Funktionalität, Voraussetzungen und Einschränkungen hinsichtlich der Redaktionsumgebung FirstSpirit ContentCreator. Zur Implementierung von EasyEdit / InlineEdit / LiveEdit siehe Kapitel Content Highlighting und EasyEdit, zu Entwicklungsmöglichkeiten per JavaScript-API siehe Kapitel JavaScript-API.
- Debugging mit Informationen zur Fehlersuche und -behebung in FirstSpirit-Projekten.
- Scripting zur Automatisierung von Bedienungsabläufen.
- FirstSpirit API als öffentliche Schnittstelle zu FirstSpirit.
- Sicherheit mit Hinweisen zu Sicherheitsaspekten für die Projekt- und Vorlagenentwicklung.
Vorlagen (Grundlagen)
- Grundlagen: Hier wird auf die Verwaltungs-Struktur und das Konzept der Mehrsparchigkeit eingegangen.
- Aufbau von Vorlagen: Hier werden die verschiedenen Arten von Vorlagen beschreiben, die dem Entwickler zur Verfügung stehen.
ContentCreator
In diesem Abschnitt werden
für die Verwendung der Redaktionsumgebung ContentCreator erläutert.
Darüber hinaus werden Themen behandelt, die die Vorlagenentwicklung für den ContentCreator betreffen:
- Vorlagenentwicklung
In erster Linie zur Vereinfachung der redaktionellen Arbeit in der Vorschau (EasyEdit / InlineEdit / LiveEdit). - Customization
Die Oberfläche des ContentCreator kann an die Anforderungen des jeweiligen Projekts angepasst werden. - JavaScript-API (WE_API)
Ermöglicht Interaktion mit der Benutzeroberfläche und anderen Funktionen des ContentCreator per JavaScript, z. B. aus Dokumenten in der Vorschau heraus. - Plugins
Kundenspezifische Erweiterungen (Module), die die Funktionalität des ContentCreator ausweiten.
Weiterführende Themen
In diesem Abschnitt werden übergreifende Aspekte hinsichtlich der Funktion von FirstSpirit erläutert.
- Generierung
- Serverseitige Freigabe
- Exif-Daten
- Remote-Zugriff
- Dokumentengruppen
- Änderungsverfolgung
- Eingabehilfen (Code-Vervollständigung)
Sukzessive wird dieser Abschnitt um weitere Themengebiete erweitert.
Tutorials
In diesem Abschnitt befinden sich Übungen zur Entwicklung von Vorlagen.
Und nun viel Vergnügen beim Arbeiten mit FirstSpirit!
FirstSpirit ist kein universelles „out-of-the-box“-Produkt, sondern eine Software, die sich in ständiger Entwicklung befindet. Es werden kontinuierlich neue Funktionalitäten eingebunden und Kundenanregungen verwirklicht. Diesem ständigen Aktualisierungsprozess kann die Dokumentation nur in begrenztem Umfang gerecht werden. So ist es möglich, dass aufgrund geringer Zeitverzögerungen manch eine Abbildung in dieser Dokumentation von der aktuellen Ansicht in FirstSpirit abweicht. Lassen Sie sich davon nicht verwirren und folgen Sie der Anleitung wie gewohnt. |