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.
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.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.
• contents Fügt eine Liste aller Objekte, die im aktuellen Websiteordner enthalten sind, als klickbare Verweise ein.
Statisch: Ja
Parameter:
showlayout (optional)
Standardmäßig erscheint die Layoutseite nicht in der Inhaltsliste. Sie
können das erzwingen, indem Sie den Parameter showlayout auf
True setzen.
onlytypes (optional)
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.
onlynames (optional)
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)
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.
sort (optional)
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 das Sortierkriterium des aktuellen Benutzers für den aktuellen Ordner angewandt.
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.
• 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.
• documentactions Fügt das Aktionsmenü der Benutzeroberfläche ohne JavaScript (siehe 4.2.1.3 „Benutzeroberfläche ohne JavaScript) 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 des Parameters
forbiddentext unten 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.
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:
addrole (Neue Rolle),
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), editdescription (Beschreibung ändern), editmetadata
(Attribute ä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), rate (Bewerten), rename (Namen ändern), replace
(Ersetzen), resubmit (Wiedervorlegen).
• 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), adddocument (Neues Dokument),
addfolder (Neuer Ordner), addmember (Mitglied einladen), addnotes (Neue
Diskussion), addocset (Neues DokSet), addrole (Neue Rolle), addSearch
(Neuer Suchordner), addurl (Neue URL), addwebfolder (Neuer
Websiteordner), chbanner (Banner ändern), chrole (Rolle zuweisen),
copy (Kopieren), cut (Ausschneiden), editdescription (Beschreibung ändern),
editindex (Startseite bearbeiten), editmetadata (Attribute ändern),
editprop (Eigenschaften ändern), editrole (Rolle ändern), 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), rename (Namen ändern).
• goto Fügt das Anzeigen-Menü (obere Menüleiste) der Benutzeroberfläche ohne JavaScript ein.
Statisch: Nein
Parameter: Keine
Beispiel:
[element goto]
• 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]
• location Fügt den Pfad zum aktuellen Dokument als klickbare Verweise ein.
Statisch: Ja
Parameter: Keine
Beispiel:
[element location]
• 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/BSCW44/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“.
• 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.
• systembanner Fügt das Systembanner ein; standardmäßig handelt es sich dabei um das normale BSCW-Systembanner mit dem Verweis auf die BSCW-Hilfe.
Statisch: Nein
Parameter: Keine
Beispiel:
[element systembanner]