BSCW-Elemente verwenden

Websiteordner verfügen über ein eigenes System von Elementen mit einer wiki-ähnlichen Syntax ([element …]), das es Ihnen erlaubt, BSCW-Elemente in Ihren Seiten zu verwenden. Beispiele sind das Datum der letzten Änderung einer Seite, Verweise zum Bearbeiten einer Seite, die Anzeige der Historie einer Seite oder gar ganze Aktionsmenüs. BSCW-Elemente haben einen Namen und können auch noch Parameter mit Werten haben. Ein abstraktes Beispiel für die Syntax von BSCW-Elementen ist

[element name param1=True param2="Ein langer Text mit Leerzeichen"]

Dieses Element name hat zwei Parameter param1 und param2 mit den Werten True bzw. "Ein langer Text mit Leerzeichen". Beachten Sie die Anführungszeichen, die nur für Werte benötigt werden, die Leerzeichen enthalten. Ein konkretes Beispiel für ein BSCW-Element ist

[element documentactions action=edit text="Dokument bearbeiten"]

Dieses Element stellt die Aktion Bearbeiten dar, die auf das aktuelle Dokument angewandt wird. In der Webansicht eines HTML-Dokuments in einem Websiteordner werden die BSCW-Elemente ausgewertet und die Ergebnisse in das Dokument eingefügt. Im obigen Beispiel würde ein Verweis mit dem Text Dokument bearbeiten in das Dokument eingefügt; Klicken auf den Verweis würde die Aktion Bearbeiten auf dem Dokument selbst aufrufen.

Hinweis: Im Rahmen der Verwendung in BSCW-Elementen von Websiteordnern haben manche Aktionen andere Namen als gewöhnlich. Beispiele sind Änderungen zurücknehmen statt Versionen löschen und Neuer Unterordner statt Neuer Unter-Websiteordner.

Obwohl die BSCW-Elemente-Syntax eckige Klammern verwendet, können Sie eckige Klammern im Text von Dokumenten eines Websiteordners weiterhin verwenden. Lediglich die Zeichenkette [element wird als Beginn eines Websiteordner-Elements aufgefasst. Fehler in Spezifikationen von BSCW-Elementen führen zu Fehlermeldungen, die in den ausgewerteten Text einer Seite eingefügt werden, während der Rest der Seite sich immer noch so verhält wie erwartet.

Sie können ein BSCW-Element in beliebigen HTML-Text einbetten, der nur angezeigt wird, wenn die Auswertung des BSCW-Elements einen nicht-leeren Inhalt ergibt, wie das folgende Beispiel zeigt.

[decoration] <HTML-Text> [element ..] <HTML-Text> [/decoration]

Hier wird der gesamte Text zwischen [decoration] und [/decoration] nicht angezeigt, wenn das BSCW-Element keinen Inhalt liefert.

Im folgenden werden die verfügbaren BSCW-Elemente in alphabetischer Reihenfolge aufgeführt. Das Attribut ‚Statisch‘ zeigt an, ob das betreffende Element in eine statische Kopie des Websiteordners übernommen wird oder nicht (siehe 8.6.6 Websiteordner exportieren und öffentlich zugänglich machen). Sie können die BSCW-Elemente direkt in den Quelltext Ihrer Websiteordner-Seiten einfügen oder das diesbezügliche Menü im integrierten HTML-Editor benutzen.

Für eine detaillierte Definition der Parameter klicken Sie auf den Namen der Elemente.

o  authors Fügt eine Liste der Autoren von Dokumenten des aktuellen Websiteordners ein. Durch Klicken auf einen Autorennamen wird die Anzeige von Objekten in der durch contents erzeugten Inhaltsliste auf diejenigen Objekte eingeschränkt, die durch diesen Autor erzeugt wurden. Beachten Sie, dass das Klicken auf einen Autorennamen keine Wirkung auf hierarchische Listen hat, die mit tree erzeugt wurden.

o  back Fügt einen Verweis ein, der aus dem Websiteordner heraus auf den ersten übergeordneten Nicht-Websiteordner führt.

o  categories Fügt eine Liste der Kategorien ein, die Objekten des aktuellen Websiteordners zugewiesen wurden. Durch Klicken auf eine Kategorie wird die Anzeige von Objekten in der durch contents erzeugten Inhaltsliste auf diejenigen Objekte eingeschränkt, denen diese Kategorie zugewiesen wurde. Beachten Sie, dass das Klicken auf eine Kategorie keine Wirkung auf hierarchische Listen hat, die mit tree erzeugt wurden.

o  comments Listet die bestehenden Kommentare zur aktuellen Seite auf und bietet standardmäßig ein Eingabefeld für neue Kommentare an, sofern der Benutzer das Recht hat, Kommentare einzugeben. Eventuelle Antworten auf Kommentare werden nicht angezeigt.

o  contents Fügt eine Liste aller Objekte, die direkt im aktuellen Websiteordner enthalten sind, als klickbare Verweise ein. Nach einer Volltextsuche ersetzen die Suchergebnisse die Inhaltsliste, wenn keine eigene Suchergebnisseite mit searchresults definiert wurde.

o  contentsmetatable Fügt eine Tabelle mit ausgewählten Metadaten aller Objekte, die direkt im aktuellen Websiteordner enthalten sind, in das aktuelle Dokument ein. Diese Inhaltstabelle kann durch den Benutzer nach den angezeigten Metadaten sortiert werden. Die Spalten der Tabelle zeigen standardmäßig die Metadaten Name, Tags und Beschreibung der enthaltenen Objekte an. Sie können auch andere Metadaten anzeigen lassen. Metadatenattribute werden durch ihre Bezeichner identifiziert. Sie erhalten eine Liste der Metadatenbezeichner eines Metadatenprofils, indem Sie   Spezifikation ‌ im Aktionsmenü des Metadatenprofils aufrufen. Beispiele für Metadatenbezeichner finden Sie bei contents oben.

o  date Fügt das aktuelle Datum und die aktuelle Uhrzeit ein.

o  documentactions Fügt ein komplettes Aktionsmenü für das aktuelle Dokument ein oder einen Verweis auf eine bestimmte Aktion.

o  fileupload Fügt ein Interaktionselement zum Hochladen von Bildern in den aktuellen Ordner ein. Pro Seite ist nur ein Element fileupload zulässig.
Das Interaktionselement besteht aus drei Schaltflächen [Datei(en) zum Hochladen auswählen…], [Hochladen] und [Hochladen abbrechen] sowie einem Vorschaubereich für die hochzuladenden Dateien. Die erste Schaltfläche initiiert einen Standarddialog zur Auswahl von Dateien, die zweite Schaltfläche bewirkt das eigentliche Hochladen, die dritte Schaltfläche bricht den Hochladeprozess ab. Sie können hochzuladende Dateien auch über die Schaltfläche [Hochladen] ziehen und dort fallen lassen. Die zum Hochladen ausgesuchten Dateien werden im Vorschaubereich unterhalb der Schaltflächen angezeigt.   
Hinweis: Zur Zeit ist das Element fileupload nur für das Hochladen von Bilddateien vorgesehen.

o  folderactions Wirkt genau wie documentactions, jedoch ist der aktuelle Websiteordner der Gegenstand des Aktionsmenüs bzw. der einzelnen Aktionen, auf die verwiesen wird.

o  gallery Stellt die im aktuellen Websiteordner enthaltenen Bilder in Form einer Galerie mit miniaturisierten Ansichten dar. Unter Bildern werden Dokumente mit einem entsprechenden MIME-Typ (image/jpg, image/png usw.) verstanden.

o  history Fügt die Liste der zuletzt besuchten Dokumente als klickbare Verweise ein.

o  lastmod Fügt Datum und Uhrzeit der letzten Änderung des aktuellen Dokuments ein.

o  lastmodby Fügt den Namen des Benutzers ein, der das aktuelle Dokument zuletzt geändert hat.

o  location Fügt den Pfad zum aktuellen Dokument als klickbare Verweise ein.

o  message Fügt eine BSCW-Systemmeldung ein. Diese Meldungen werden in der vom aktuellen Benutzer eingestellten Sprache angezeigt.

o  metadata Fügt eine Liste mit den Metadaten des aktuellen Objekts ein, die nach den Gruppen des jeweiligen Metadatenprofils gegliedert ist, und bietet eine Schaltfläche zum Ändern der Metadaten. Im Unterschied zu contentsmetatable geht es hier um ein Objekt.

o  search Fügt den Eingabebereich für die Volltextsuche im Websiteordner ein. Wenn möglich, erscheint rechts neben dem Suchfeld eine Schaltfläche [Erweitert], die zum vollen Suchformular führt. Die Ergebnisse der Suche erscheinen auf einer Suchergebnisseite, die Sie mit searchresults zu dem aktuellen Websiteordner definiert haben. Ohne spezielle Suchergebnisseite ersetzen die Suchergebnisse Inhaltslisten bzw. Inhaltsbäume, die mit contents bzw. tree erzeugt wurden. Die Verwendung von search ist also nur sinnvoll, wenn gleichzeitig searchresults, contents oder tree verwendet werden, weil sonst die Suchergebnisse nicht angezeigt werden.

o  searchresults Definiert die Suchergebnisseite, die die Ergebnisse von Suchen im aktuellen Websiteordner anzeigt.

o  size Fügt die Größe eines Objekts ein.

o  systembanner Fügt das Systembanner ein; standardmäßig handelt es sich dabei um das normale BSCW-Systembanner.

o  tags Fügt eine Liste der Tags ein, die Objekten des aktuellen Websiteordners zugewiesen wurden. Durch Klicken auf einen Tag wird die Anzeige von Objekten in der durch contents erzeugten Inhaltsliste auf diejenigen Objekte eingeschränkt, denen dieser Tag zugewiesen wurde. Beachten Sie, dass das Klicken auf einen Tag keine Wirkung auf hierarchische Listen hat, die mit tree erzeugt wurden.

o  toc Zeigt ein Inhaltsverzeichnis des aktuellen Dokuments an, das aus den Überschriften als klickbaren Verweisen besteht, die eine Navigation im Dokument erlauben.

o  tree Fügt eine Baumansicht des aktuellen Ordners und aller übergeordneten Websiteordner ein, die aus klickbaren Verweisen besteht. Nach einer Volltextsuche ersetzen die Suchergebnisse den Inhaltsbaum, wenn keine eigene Suchergebnisseite mit searchresults definiert wurde.