DeskClient 5

Dokumente anlegen und bearbeiten

Anleitung zur Dokumenterstellung und Veröffentlichung, zum Schutz und zur Zeitplanung eines Dokuments, sowie zum Dokumenteditor.

Dokumente erstellen

Jedes Dokument benötigt eine eindeutige ID. Diese besteht aus einem Wort und einer vom System generierten Zahl, die an das Wort angehängt wird.

Um ein neues Dokument zu erstellen, gehe wie folgt vor:

  • Über das Neu-Menü in der Toolbar einen Dokumenttyp (z.B. Story) auswählen.
  • Verortung auswählen - Ein Fenster erscheint, in dem Du den Strukturbaum sehen kannst. Wähle den Strukturknoten aus, an dem Du Dein Dokument verorten möchten, wo es also beheimatet sein soll.
  • ID-Stamm vergeben - Trage eine sinnvolle Zeichenkette ein, die das Hauptthema des Dokumentes beschreibt. Erlaubt sind Buchstaben aus dem lateinischen Alphabet (ohne Umlaute oder ß) und Ziffern (nicht am Ende des ID-Stamms). Leerzeichen sind nicht erlaubt; möchtest Du also eine ID aus mehreren Wörtern angeben, musst Du diese mit Binde- oder Unterstrichen trennen oder zusammenschreiben. Alle anderen Sonderzeichen oder auch Klammern sind ebenfalls nicht erlaubt. Der ID-Stamm sollte eine Länge von 240 Zeichen nicht überschreiten.

Der ID-Stamm wird nach dem Speichern automatisch durch eine Nummernfolge zur Sophora-ID des Dokumentes ergänzt. Aus dem ID-Stamm london wird dann z.B. die Sophora-ID london100. Ist diese Zeichenfolge ungünstig, wie beispielsweise zwillingsforschung1944, kann sie später per Hand über den Eintrag ID-Stamm ändern im Dokumenteditor geändert werden. Durch die Änderung des ID-Stammes, wird auch die Sophora-ID des Dokumentes geändert. Die generierte Sophora-ID wird für die Ausspielung der Seiten als Name in der URL verwendet. Die Adresse zu dem Dokument aus dem Screenshot lautet somit http://demo.sophoracms.com/trendcities/london/london-2016-september100.html.

Dokument-anlegen
Dokument-anlegen (Bild: subshell/CC BY)

Dokumente aus Vorlagen erstellen

Vorlagen können benutzt werden, um neue Dokumente aus alten zu erstellen. Enthält die Vorlage bereits Inhalt, wird dieser in das neue Dokument kopiert. Vorlagen können auch einen ID-Stamm und/oder einen Strukturknoten vorgeben, die in das neu aus einer Vorlage erstellte Dokument übernommen werden. Du kannst alle aus einer Vorlage übernommenen Inhalte, sowie ID-Stamm und Strukturknoten sofort oder auch im Nachhinein ändern.

In der Suchansicht, sowie in den Dokument-Tooltips werden Vorlagen-Dokumente mit einem gestreiften Hintergrund angezeigt. Ebenso ist der Hintergrund des Dokument-Editors einer Vorlage gestreift.

Um ein Dokument als Instanz einer Vorlage zu erstellen, öffne den Neu-Dialog, als ob Du ein gewöhnliches neues Dokument erstellen würdest. Wähle daraufhin über das Vorlagen-Drop-Down die Vorlage aus, die Du benutzen möchtest.

Dokument Vorlagen
Dokument Vorlagen (Bild: subshell/CC BY)

Vorlagen erstellen

Um eine Dokumentvorlage aus einem bereits existierenden Dokument zu erstellen, öffnen dieses zunächst. Aktiviere anschließend auf dem Tab Vorlage die Checkbox Als Vorlage verwenden, und gebe einen Namen ein. Nun kannst Du das Dokument als Vorlage verwenden. Du kannst zusätzlich auch einen ID-Stamm und einen Strukturknotenpfad für aus der Vorlage erstellte Dokumente vorgeben. Außerdem kannst Du auswählen, in welchen Strukturknoten das aktuelle Dokument als Standardvorlage verwendet werden soll; erstellst Du später in diesen Strukturknoten ein neues Dokument desselben Typs, ist diese Vorlage standardmäßig im Neu-Dialog ausgewählt.

Bis auf den Namen, der auch im Neu-Dialog bei der Auswahl einer Vorlage angezeigt wird, sind alle Felder übrigens keine Pflichtfelder. Wird ein Dokument als Vorlage verwendet, erscheint der Hintergrund gestrichelt.

Um eine komplett neue Dokumentvorlage zu erstellen, erstelle zunächst ein neues Dokument des gewünschten Typs und gehe dann wie beschrieben vor. Um ein Dokument von einer Vorlage wieder in ein normales Dokument zu verwandeln, entferne den Haken aus dem Kontrollkästchen Als Vorlage verwenden wieder.

Feldvalidierung

Feldinhalte von Dokumentvorlagen müssen nicht notwendigerweise gültig sein. Das heißt, dass z.B. ein Pflichtfeld "Überschrift" nicht ausgefüllt sein muss, damit die Dokumentvorlage abgespeichert werden kann. Dies trifft jedoch nicht auf die Dokumente zu, die aus einer Vorlage heraus erstellt wurden. In diesen Dokumenten müssen die Pflichtfelder wieder ausgefüllt werden.

+++
+++ (Bild: subshell/CC BY)

Konfiguration

Um Dokumentvorlagen nutzen zu können, folge diesen Schritten um sie zu konfigurieren.

  1. Erstelle ein neues Tabdokument Vorlage und aktiviere alle Dokumenttypen, die als Vorlage benutzbar sein sollen.
  2. Füge den Dokumenttypen aus Punkt 1 in der NodeType-Konfiguration jeweils das Mixin sophora-mix:documentTemplate hinzu.
  3. Füge daraufhin die Formularfeldgruppe "Vorlage" dem Vorlagen-Tab hinzu.

Nun solltest Du die Vorlagen-Eigenschaften auf dem Vorlage-Tab in diesen Dokumenten sehen können und es sollte Die möglich sein, Vorlagen daraus zu erstellen.

Zusätzlich kannst Du eine spezielle Suche nach allen Dokumentvorlagen für Benutzer bereitstellen, indem Du dem Schlüssel search.modifiers im Konfigurationsdokument den Wert All templates;§[@sophora:isDocumentTemplate='true' and not(@sophora:isDeleted='true')] hinzufügst.

Dokumente importieren

Du kannst auch bereits bestehende Dokumente importieren. Klicke dazu in der Haupttoolbar auf (Tools) und wähle Importieren.

Sophora-XML erforderlich: Es können nur Dokumente mit gültigem Sophora-XML importiert werden. Eine Spezifikation dieser XML-Variante befindet sich in der Importer Dokumentation (in englischer Sprache).

Importieren Sophora CMS
Importieren Sophora CMS (Bild: subshell/CC BY)

In dem erscheinenden Dialog wirst Du aufgefordert, die zu importierenden Dateien auszuwählen.

Nachdem die Dokumente importiert wurden, bekmmost Du einen Bericht darüber, ob der Import erfolgreich war. Falls es beim Import zu Fehlern kam, wirst Du über diese informiert.

+++
+++ (Bild: subshell/CC BY)

Dokumenteditor

Der Dokumenteditor ist das Herz des Sophora DeskClients. Mithilfe des Editors kannst Du den Text eines Dokumentes bearbeiten, die Zeitplanung verändern oder Komponenten hinzufügen. Der Editor ist durch verschiedene Tabs gegliedert; auf den Tabs befinden sich verschiedene Eingabefelder. Du kannst die Tabs am unteren Rand des Editors wechseln. Welche Felder auf welchen Tabs zu finden sind, ist dabei für die Administration konfigurierbar. Felder, deren Beschriftung fett dargestellt ist, sind dabei Pflichtfelder. Sind diese Felder nicht ausgefüllt, kannst Du das Dokument nicht abspeichern.

Eine ausführliche Dokumentation über die Funktionen des Texteditors findest Du hier.

Basis-Tab

Hier findest Du alle Basisinformationen des Dokumentes (meistens den eigentlichen Inhalt) und den Texteditor.

Metadaten-Tab

Dieser Reiter enthält die Meta-Informationen über das Dokument. Beachte, dass hier Felder auftauchen können, die von Sophora automatisch erstellt werden und auf die Du keinen Zugriff hast (dargestellt in grau und nicht editierbar).

Zu diesen Feldern gehören beispielsweise der Ersteller des Dokuments oder die Zeit der letzten Änderung.

Editor-Toolbar

In der Editor-Toolbar (s. obere Markierung in der Abbildung) kannst Du alle für das Bearbeiten des Dokumentes relevanten Aktionen auswählen. Dort kannst Du beispielsweise Text kursiv oder fett markieren, das Dokument veröffentlichen oder anbieten und vieles mehr. Achte auch auf die drei Punkte in der rechten oberen Ecke - das dort verortete Menü hält weitere Aktionen für Dich bereit.

Suchen und Ersetzen[search-replace]

Das gesamte Dokument kann nach einem Text durchsucht werden. Die Suche ignoriert Groß-/Kleinschreibung und findet auch Teilworte. Die Suchergebnisse werden im Editor hervorgehoben und in dem Bereich Suche im Dokument aufgelistet. Dort sind die Suchergebnisse nach Editortabs und Formularfeldern gruppiert.

Um eine Suche zu beginnen, öffne den Dialog "Suchen/Ersetzen" mit dem Tastenkürzel Strg + F, oder über das Icon in der Editor-Toolbar (s. Screenshot), und gebe einen Suchtext ein. Durch Klick auf den Button Suchen kann dann eine Suche gestartet werden. Ein erneutes Klicken auf den Button navigiert zum nächsten Suchtreffer. Um das Suchergebnis zu löschen, klicke auf den entsprechenden Eintrag aus dem Punkte-Menü im Bereich Suche im Dokument .

Die gefundenen Suchergebnisse können über den Dialog durch einen anderen Text ersetzt werden. Mit einem Klick auf den Ersetzen-Button können sowohl einzelne, als auch mehrere selektierte Ergebnisse ersetzt werden. Klickst Du auf Ersetzen/Suchen, wird das aktuell markierte Suchergebnis ersetzt und die Markierung springt sofort zum nächsten Ergebnis. Mit einem Klick auf den Alle ersetzen-Button werden alle Suchergebnisse ersetzt.

suchen und ersetzen
suchen und ersetzen (Bild: subshell/CC BY)

Speichern, Fertigstellen und Veröffentlichen

Editor Toolbar
Editor Toolbar (Bild: subshell/CC BY)
  • Speichern: – Um den derzeitigen Stand der Bearbeitung in der Vorschau sehen zu können, ist es notwendig das Dokument zu speichern. Die Änderungen am Dokument sind nur intern zu sehen.
  • Fertigstellen: – (Abhängig von der Konfiguration des DeskClients.) Dieser Dokumentenstatus ist für Redakteure und andere Anwender vorgesehen, die nicht das Recht besitzen, Dokumente zu veröffentlichen. Nach Beendigung der Arbeiten wird das Dokument als „fertig" markiert. Der RvD kann nun das Dokument platzieren und veröffentlichen. Die Änderungen am Dokument sind nur intern zu sehen.
  • Veröffentlichen: – Mit „Veröffentlichen" wird das Dokument auf die Live-Server übertragen. Diese Übertragung dauert nur wenige Sekunden.
  • Je nach Konfiguration des Sophora Servers ist es auch möglich, dass durch die Aktion "Veröffentlichen" das Dokument nicht sofort veröffentlicht wird, sondern in einen der Zustände fertiggestellt, veröffentlichen um, oder vorveröffentlicht gestellt wird.

Automatisches Veröffentlichen

Dokumente können ebenfalls automatisiert veröffentlicht werden. Trage dazu in dem Dokument in dem Feld "Veröffentlichen am" auf dem Meta-Tab das geplante Datum für die Veröffentlichung ein.

Falls dieses Feld bei Dir nicht sichtbar ist oder nicht unter dem Namen auffindbar, wenden Dich sich bitte an Deine Sophora Administration.

Veröffentliche im Anschluss das Dokument. Es wird dann im Zustand veröffentlichen am sein und am eingestellten Datum automatisch veröffentlicht.

Falls das Feld "Veröffentlichen am" in Deiner Sophora-Installation an das Veröffentlichen-Recht gekoppelt ist, kannst Du das Feld nur bearbeiten, wenn Du das Veröffentlichen-Recht für das Dokument hast.

Liste aller Zustände, die ein Dokument im System annehmen kann

Ein Dokument kann viele verschieden Zustände haben. Um auf einen Blick erkennen zu können, in welchem Zustand sich ein Dokument gerade befindet, gibt es für jeden Zustand ein Icon; diese können auch in Kombinationen auftreten. Eine komplette Übersicht über alle Dokumentstatus-Icons findest Du hier.

Es kann sein, dass in Deinem System nicht all diese Status zur Verfügung stehen. Dies hängt von den verwendeten Einstellungen ab.

Zeitplanung bei Dokumenten

Bei Dokumenten erfolgt die Zeitplanung üblicherweise auf dem Meta-Tab. Dort befinden sich die Felder "Online ab", "Online bis" und "Tage bis offline" sowie weitere kundenspezifische Felder, die ebenfalls den Dokumentlebenszyklus betreffen können.

Beachte, dass die Verfügbarkeit dieser Felder stark von der Konfiguration ihrer Sophora-Installation abhängt. Beachte ebenfalls, dass sich der Zeitplanungs-Tab nicht auf das im Editor geöffnete Dokument bezieht, sondern auf seine Komponenten. Siehe dazu auch hier.

Zur Darstellung...
Bei den relativen Zeitangaben sind vererbte Definitionen aus Strukturknoten in grau dargestellt. Um das Erben des Wertes von dem Strukturknoten zu verhindern, kann ein Minuszeichen ('-') in das Feld eingetragen werden. Ein ausgegrautes Minuszeichen bedeutet, dass ein übergeordneter Strukturknoten die Vererbungshierarchie unterbrochen hat.

Es ist auch möglich, vererbte Werte zu überschreiben. Dazu trage bitte eine Anzahl von Tagen in das entsprechende Feld ein. Stehen die Angaben in den Feldern "Online bis" und "Tage bis offline" in Konflikt, findet die Angabe aus dem Feld "Online bis" Anwendung.

Bei kundenspezifischen Feldern, die sich auf ein Referenzdatum beziehen, wird neben dem Namen des entsprechenden Datumfelds auch die Anzahl der verbleibenden Tage angezeigt.

Zeitplanung
Zeitplanung (Bild: subshell/CC BY)

Dokumente schützen

Im Sophora DeskClient können sowohl Dokumente, als auch einzelne Inhalte vor Veränderungen geschützt werden.

Dies ist zum Beispiel nützlich, um bestimmte Felder vor Veränderungen durch Importe zu schützen oder andere Benutzer darauf hinzuweisen, dass bestimmte Felder oder auch das gesamte Dokument nicht ohne Weiteres verändert werden sollten.

Sollte das Schützen von Inhalten nicht möglich sein, muss dies zunächst von einem Administrator für den gewünschten Dokumenttyp freigegeben werden.

Ein Dokument schützen

Um das komplette Dokument vor Veränderungen zu schützen, wähle über das Punkte-Menü in der Editor-Toolbar den Menüpunkt Schützen.

Um den Schutz wieder aufzuheben, klicke auf denselben Menüpunkt.

Ist das Dokument geschützt, ist dort das Schloss blau hinterlegt. Geschützte Dokumente erkennt man an einer Benachrichtigung im oberen Bereich des Dokumenteditors, sowie am Schloßsymbol neben dem Status-Icon des Dokumentes.

Dokument schuetzen
Dokument schuetzen (Bild: subshell/CC BY)

Schützen von Feldern

Einzelne Felder eines Dokumentes können vor einer automatischen Aktualisierung durch den Importer geschützt werden.

Ein geschütztes Feld ist im Read-Only Modus und kann zunächst nicht verändert werden. Um das Feld dennoch zu verändern ist es notwendig, den Schutz des Feldes aufzuheben.

Um ein einzelnes Feld zu schützen, öffne das Kontextmenü des Feldes mit einem Klick mit der rechten Maustaste auf die Beschriftung des Feldes. Das Entschützen funktioniert auf dieselbe Weise.

Ist ein Feld geschützt, ist der Inhalt ausgegraut und ein Schloss-Symbol wird neben dem Feld angezeigt.

+++
+++ (Bild: subshell/CC BY)

Zuletzt geändert am 16.10.20

Der Inhalt dieser Seite steht unter der Creative Commons Attribution 4.0 License. Code-Beispiele stehen unter der MIT License.

Icon