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.
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 5.5.7 „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.
Statisch:
Nein
Parameter:
Keine
Beispiel:
[element author]
o back Fügt einen Verweis ein, der aus dem Websiteordner heraus auf den ersten übergeordneten Nicht-Websiteordner führt.
Statisch: Ja
Parameter:
text (optional)
Standardmäßig wird der
Text für den back-Verweis auf den entsprechenden BSCW-Text in der
jeweiligen Sprache des Benutzers gesetzt (im Deutschen also auf „Zurück“). Mit
dem Parameter text können Sie eine andere Beschriftung des Verweises
angeben.
icon (optional)
Statt mit einem Text
können Sie den back-Verweis auch mit einem Symbol unterlegen. Geben Sie als Wert
für den Parameter icon die URL des Symbols an. Wenn sowohl icon als auch
text angegeben werden, wird der Aktionsverweis mit dem Symbol
unterlegt und der Text fungiert als Tooltip.
Beispiel:
[element back text="Nach oben"]
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.
Statisch:
Nein
Parameter:
Keine
Beispiel:
[element category]
o contents Fügt eine Liste aller Objekte, die im aktuellen Websiteordner enthalten sind, als klickbare Verweise ein. Nach einer Volltextsuche ersetzen die Suchergebnisse die Inhaltsliste.
Statisch: Ja
Parameter:
showlayout, showhome, showstyle (optional,
Standardwert False)
Standardmäßig erscheinen
Layoutseite, Startseite und Stildefinition nicht in der Inhaltsliste. Sie können
das erzwingen, indem Sie den entsprechenden Parameter auf True setzen.
onlytypes (optional, Standardwert
"text/html")
Der Parameter onlytypes ermöglicht es Ihnen,
Dokumente aus der Inhaltsliste auszuschließen, die nicht einen bestimmten
MIME-Typ haben. Spezifizieren Sie als Wert dieses Parameters eine
komma-separierte Liste mit den zulässigen Typen, z.B. text/html für
HTML-Dokumente. Die Spezifikation ganzer Gruppen von MIME-Typen ist auch
möglich, wobei * als Jokerzeichen eingesetzt werden kann, z.B. text/*. Ordner sind von diesem Filtern
nach MIME-Typ nicht betroffen. Wenn Sie den Filter ausstellen wollen, geben Sie
als Wert "*" an.
onlynames (optional, Standardwert
"*")
Wirkt wie onlytypes, nur wird auf der
Grundlage der Namen der Objekte gefiltert. Geben Sie eine komma-separierte
Liste der zulässigen Namen an, etwa *.html oder image??.jpg (dabei steht * für eine
beliebige Zeichenkette und ? für ein beliebiges Zeichen). Wiederum sind Ordner
von diesem Filtern nach Namen nicht betroffen. Sie können onlytypes
gleichzeitig mit onlynames verwenden. In diesem Fall werden nur
Dokumente angezeigt, die beide Kriterien erfüllen.
showfolders (optional, Standardwert
"webonly")
Legt
fest, welche Ordner zusätzlich zu den anderen Objekten angezeigt werden,
und kann einen der folgenden drei Werte haben:
o all Alle Ordner werden angezeigt.
o none Kein Ordner wird angezeigt.
o webonly Nur Websiteordner mit aktiver Startseite werden angezeigt.
showtemplatefolders (optional, Standardwert
False)
Standardmäßig werden
Vorlagenordner nicht in der Inhaltsliste angezeigt. Sie können das erzwingen,
indem Sie den Parameter showtemplatefolders auf True setzen, vorausgesetzt, dass diese
Ordner nach dem Wert des Parameters showfolders überhaupt angezeigt
würden.
showextensions (optional, Standardwert
False)
Standardmäßig werden Dateinamenerweiterungen (so wie .html) nicht in der Inhaltsliste
gezeigt. Sie können sich diese Erweiterungen jedoch anzeigen lassen, indem
Sie showextensions auf True setzen.
sort (optional, Standardwert "byName")
Legt die Sortierung der
Inhaltsliste fest und kann einen der folgenden Werte haben:
o byType Sortierung nach Objekttyp
o byName Sortierung nach Name
o bySize Sortierung nach Größe
o byDate Sortierung nach Datum der letzten Änderung
o byRating Sortierung nach Bewertung
Wenn sort nicht angegeben wird, wird nach Namen sortiert.
indextopmost (optional, Standardwert
True)
Standardmäßig wird
die Startseite eines Websiteordners als erste in der Inhaltsliste
angezeigt. Sie können die Startseite aber auch nach dem gültigen
Kriterium in die Inhaltsliste einsortieren, indem Sie den Parameter
indextopmost auf False setzen.
uplink (optional, Standardwert False)
Standardmäßig enthält die
Inhaltsliste für alle Unter-Websiteordner einen Verweis auf den
übergeordneten Websiteordner, jedoch nicht im Websiteordner auf oberster Ebene.
Sie können diesen Verweis unterdrücken, indem Sie den Parameter uplink
auf False setzen. Sie können den
Verweis auch auf oberster Ebene erscheinen lassen, indem Sie den Wert auf True setzen.
Beispiele:
[element contents
showlayout=True]
Zeigt eine
Inhaltsliste an, die auch die Layoutseite einschließt.
[element contents
onlynames="*.html"]
Zeigt eine Inhaltsliste an, die neben
Ordnern nur Objekte enthält, deren Namen auf .html endet.
[element contents
onlytypes="text/plain, text/html"]
Zeigt eine Inhaltsliste an, die neben Ordnern nur Text- und HTML-Dokumente
enthält.
o date Fügt das aktuelle Datum und die aktuelle Uhrzeit ein. Verfügbare Datumformate finden sich auch in 5.6.5 „Funktionen.
Statisch: Ja
Parameter:
format (optional)
Wenn Ihnen das
Standardformat für Datum und Zeit nicht gefällt (Beispiel: 2007-07-10 14:31) und
Sie mit Python-Programmierung vertraut sind, können Sie hier Ihr eigenes Format
angeben. Konsultieren Sie dazu das Python-Handbuch unter strftime (oder die oben angegebene
Referenz für einen Überblick).
Beispiel:
[element date
format="%A, %d. %B, %H:%M"]
Fügt das
aktuelle Datum und die aktuelle Uhrzeit in einem benutzerdefinierten Format ein,
das statt des obigen Standardformats Dienstag, 10. Juli, 14:31 ergibt.
o documentactions Fügt das Aktionsmenü der Benutzeroberfläche ohne JavaScript (siehe 4.3.1 „JavaScript, Stylesheets und Benutzersprache) für das aktuelle Dokument ein oder einen Verweis auf eine bestimmte Aktion.
Statisch: Nein
Parameter:
action (optional)
Wenn dieser Parameter
weggelassen wird, wird ein ganzes Aktionsmenü eingefügt. Sonst wird ein
direkter Verweis auf die angegebene Aktion erzeugt. Die zulässigen Werte für den
Parameter action sind weiter unten aufgeführt. Wenn die angegebene Aktion
für den aktuellen Benutzer nicht erlaubt ist, wird das
documentactions-Element durch den Wert der Parameter forbiddentext
bzw. forbiddenicon oder durch eine leere Zeichenkette ersetzt.
text (optional; wird nur verwendet, wenn action
gesetzt ist)
Der Text des
Verweises auf die angegebene Aktion entspricht dem Wert des Parameters
text. Wenn der Parameter text weggelassen wird, besteht der Text
des Verweises aus dem BSCW-Namen der Aktion in der Sprache des aktuellen
Benutzers. Denken Sie daran, dass ein Text, der Leerzeichen enthält, in
Anführungszeichen eingeschlossen werden muss.
forbiddentext (optional; wird nur verwendet, wenn
action gesetzt ist)
Wenn die angegebene Aktion für
den aktuellen Benutzer nicht erlaubt ist, wird der Wert dieses Parameters statt
dem Verweis auf die Aktion angezeigt. Wenn der Parameter weggelassen wird, wird
in diesem Fall eine leere Zeichenkette angezeigt.
icon (optional; wird nur verwendet, wenn
action gesetzt ist)
Mit dem
Parameter icon kann der Verweis auf die Aktion mit einem Symbol versehen
werden. Der Wert des Parameters ist eine URL, die auf das Symbol verweist.
Wenn der Wert auf True gesetzt wird, wird das
BSCW-eigene Symbol für die Aktion genommen. Wenn sowohl icon als auch
text angegeben werden, wird der Aktionsverweis mit dem Symbol unterlegt
und der Text fungiert als Tooltip.
forbiddenicon (optional; wird nur verwendet, wenn
action gesetzt ist)
Wenn die angegebene Aktion für
den aktuellen Benutzer nicht erlaubt ist, wird statt dem Verweis auf die Aktion
das Symbol angezeigt, auf das der Wert dieses Parameters verweist. angezeigt.
Beispiele:
[element
documentactions]
Fügt das Aktionsmenü der Benutzeroberfläche
ohne JavaScript für das aktuelle Dokument ein.
[element
documentactions action=get text="Quelltext"]
Fügt einen Verweis zum Öffnen des aktuellen
Dokuments mit dem Text „Quelltext“ ein. Diese Aktion zeigt den Quelltext
des Dokuments an, d.h. BSCW- und Textelemente werden nicht ausgewertet und
ersetzt.
[element
documentactions action=replace]
Fügt einen Verweis zum Ersetzen des aktuellen Dokuments mit dem
Standardtext, dem Aktionsnamen „Ersetzen“, ein.
Mögliche Aktionen:
addpage (Neue Seite), addrole
(Neue Rolle), addsubwebfolder (Neuer Unterordner), addtempl (Kopie von
Vorlage), attachnote (Notiz anhängen), checkout (Sperren), chrole (Rolle
zuweisen), chtype (Typ ändern), copy (Kopieren), cut (Ausschneiden),
cutattachment (Anhang ausschneiden), duplicate_edit (Kopie
bearbeiten), edit (Bearbeiten), editobject
(Eigenschaften ändern), editrole (Rolle ändern), export (Exportieren),
firstversion (Unter Versionskontrolle stellen), freeze (Einfrieren), get
(Öffnen), history (Historie zeigen), info (Mehr Information), link
(Verweisen in Ablage), make (Statische Kopie), printweb (Drucken), rate
(Bewerten), rename (Namen ändern), replace (Ersetzen), resubmit
(Wiedervorlegen), revert (Änderungen zurücknehmen), uploaddoc (Dokument
hochladen).
o folderactions Wirkt genau wie documentactions, jedoch ist der aktuelle Websiteordner der Gegenstand des Aktionsmenüs bzw. der einzelnen Aktionen, auf die verwiesen wird.
Statisch: Nein
Parameter:
Dieselben wie für documentactions.
Beispiele:
[element
folderactions]
Fügt das Aktionsmenü
der Benutzeroberfläche ohne JavaScript für den aktuellen Websiteordner ein.
[element
folderactions action=get text="Liste aller Objekte im BSCW-Stil"]
Fügt einen Verweis zum Öffnen des aktuellen Websiteordners mit dem Text
„Liste aller Objekte im BSCW-Stil“ ein. Diese Aktion zeigt die BSCW-übliche
Liste von Einträgen des Websiteordners an.
[element
folderactions action=history]
Fügt einen Verweis auf die Historie des
aktuellen Websiteordners mit dem Standardtext, dem Aktionsnamen
„Historie zeigen“, ein.
Mögliche Aktionen:
addcal (Neuer Gruppenkalender),
addctlist (Neue Kontaktliste), addpage (neue Seite), addsubwebfolder (Neuer
Ordner), addmember (Mitglied einladen), addnotes (Neues Diskussionsforum),
addocset (Neues DokSet), addrole (Neue Rolle), addSearch (Neuer
Suchordner), addurl (Neue URL), chbanner (Banner ändern), chrole (Rolle
zuweisen), copy (Kopieren), cut (Ausschneiden), editindex (Startseite
bearbeiten), editpobject (Eigenschaften ändern), editrole (Rolle
ändern), editstyle (Stildefinition bearbeiten), edittemplate
(Layoutseite bearbeiten), export (Exportieren), get (Öffnen),
getweb (Webansicht zeigen), history (Historie zeigen), info (Mehr
Information), link (Verweisen in Ablage), make (Statische Kopie)
pubaccess (Öffentlich machen), uploaddoc (Dokument
hochladen).
o goto Fügt das Anzeigen-Menü (obere Menüleiste) der Benutzeroberfläche ohne JavaScript ein.
Statisch: Nein
Parameter: Keine
Beispiel:
[element goto]
o history Fügt die Liste der zuletzt besuchten Dokumente als klickbare Verweise ein.
Statisch: Nein
Parameter:
divider (optional)
Standardmäßig werden die
Verweise in der Liste durch Komma und Leerzeichen getrennt. Mit dem
Parameter divider können Sie eine andere Zeichenkette als Trenner
angeben.
maxdocs (optional)
Standardmäßig werden höchstens 5 Dokumente in der Liste angezeigt. Mit
maxdocs können Sie eine andere Höchstzahl festlegen.
showextensions
(optional)
Standardmäßig werden
Dateinamenerweiterungen (so wie .html) nicht in der
history-Liste gezeigt. Sie können sich diese Erweiterungen jedoch
anzeigen lassen, indem Sie showextensions auf True setzen.
Example:
[element history divider=" | " maxdocs=7]
o lastmod Fügt Datum und Uhrzeit der letzten Änderung des aktuellen Dokuments ein.
Statisch: Ja
Parameter:
format (optional)
Sie können hier Ihr eigenes
Format angeben, wie es oben bei date erläutert wurde.
Beispiel:
[element lastmod]
o lastmodby Fügt den Namen des Benutzers ein, der das aktuelle Dokument zuletzt geändert hat.
Statisch: Ja
Parameter: Keine
Beispiel:
[element lastmodby]
o location Fügt den Pfad zum aktuellen Dokument als klickbare Verweise ein.
Statisch: Ja
Parameter: Keine
Beispiel:
[element location]
o message Fügt eine BSCW-Systemmeldung ein. Diese Meldungen werden in der vom aktuellen Benutzer eingestellten Sprache angezeigt.
Statisch: Ja
Parameter:
name (erforderlich)
Der Name der Meldung, die angezeigt werden soll. Die verfügbaren
Meldungen sind in der Datei
BSCW-Verzeichnis/messages/de/lg_msgconfig.py
auf Ihrem BSCW-Server enthalten. Fragen Sie Ihren
BSCW-Administrator nach der genauen Position dieser Datei in Ihrer
BSCW-Installation.
Beispiel:
[element message
name=location]
Zeigt die Meldung mit den Namen ‚location‘ an.
Auf Deutsch ergibt das „Ihre Position“.
o search Fügt den Eingabebereich für die Volltextsuche im Websiteordner ein. Die Ergebnisse der Suche ersetzen die Inhaltsliste bzw. den Inhaltsbaum, die mit contents bzw. tree erzeugt werden. Die Verwendung von search ist also nur sinnvoll, wenn gleichzeitig auch contents oder tree verwendet werden, weil sonst die Suchergebnisse nicht angezeigt werden.
Statisch: Nein
Parameter: Keine
Beispiel:
[element search]
o size Fügt die Größe eines Objekts ein.
Statisch: Ja
Parameter:
filename (optional)
Standardmäßig wird die Größe des
aktuellen Dokuments angezeigt. Sie können ein anderes Objekt bestimmen, dessen
Größe angezeigt werden soll, indem Sie seinen Namen im Parameter filename
angeben.
unit (optional)
Die Standardeinheit
ist Byte (B). Wenn Ihr Objekt recht groß ist, wäre eine andere Einheit
vielleicht angemessener. Gültige Einheiten sind B, KB, MB, GB.
Beispiel:
[element size
filename="files/dvd-image.iso" unit=GB]
Fügt die Größe des Objekts dvd-image.iso im Unterordner files des aktuellen
Ordners in Gigabyte ein.
o systembanner Fügt das Systembanner ein; standardmäßig handelt es sich dabei um das normale BSCW-Systembanner.
Statisch: Ja
Parameter: Keine
Beispiel:
[element 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.
Statisch:
Nein
Parameter:
Keine
Beispiel:
[element tags]
o tree Fügt einen Baum von klickbaren Verweisen ein, der den Inhalt des aktuellen Websiteordners von der obersten Ebene bis zum aktuellen Dokument zeigt. Nach einer Volltextsuche ersetzen die Suchergebnisse den Inhaltsbaum.
Statisch: Ja
Parameter:
Dieselben wie für contents.
Beispiele:
[element tree
showlayout=True]
Zeigt einen Inhaltsbaum mit
Layoutseiten an.
[element tree
onlynames=*.html]
Zeigt einen Inhaltsbaum an, der neben
Ordnern nur Objekte enthält, deren Namen auf .html endet.