Utilisation des éléments BSCW

Les dossiers de site Web ont un système d’éléments intégré avec une syntaxe [element] de type wiki, ce qui vous permet d’inclure des éléments BSCW dans vos pages, par exemple la date de la dernière modification d’une page, des liens pour éditer la page, un affichage de l’historique de la page ou même des menus d’action au complet. Les éléments BSCW ont un nom et peuvent aussi avoir des paramètres avec des valeurs. Un exemple abstrait de la syntaxe d’un élément BSCW est représenté comme suit :

[element nom param1=True param2="Un long texte avec des espaces"]

représente l’élément BSCW nom avec deux paramètres. L’un est nommé param1 avec pour va­leur true, l’autre est nommé param2 avec la valeur "Un long texte avec des espaces". Notez les guillemets, qui ne sont nécessaires que pour les valeurs contenant des espaces. Un exemple concret d’un élément de BSCW est :

[element documentactions action=edit text="Éditez-moi!"]

représente l’action de éditer à appliquer au document en cours. Dans l’affichage Web d’un document HTML dans un dossier de site Web, les éléments BSCW sont évalués et les résul­tats sont insérés dans la page. Dans l’exemple ci-dessus, un lien cliquable étiqueté Éditez-moi! serait inséré dans le document qui invoquerait l’action Éditer sur le document lui-même.

Remarque : Dans le contexte des éléments BSCW dans les dossiers de site Web, certaines ac­tions ont des noms qui diffèrent de leurs noms usuels dans BSCW. Des exemples sont : An­nu­ler les modifications au lieu de Détruire les versions et Nouveau sous-dossier au lieu d’Ajou­ter un dossier de site Web supplémentaire.

Même si tous les éléments BSCW sont entre crochets, vous pouvez toujours utiliser des cro­chets dans les documents d’un dossier de site Web comme du texte normal. Seule la chaîne de caractère [element sera reconnue comme le début d’un élément de dossier de site Web. Les erreurs dans les spécifications des éléments BSCW donnent lieu à des messages d’erreur insé­rés dans la page tandis que le reste de la page fonctionnera encore comme prévu.

Dans ce qui suit, les éléments BSCW disponibles sont listés dans l’ordre alphabétique. L’at­tri­but « Statique » indique si l’élément en particulier sera inclus dans une copie statique du dos­sier de site Web ou non (voir 8.6.7 « Exporter et publier des dossiers de site Web). Vous pouvez saisir des éléments BSCW directement dans le fichier source des pages de votre dos­sier de site Web ou utilisez les menus déroulants de dans l’éditeur HTML intégré.

Cliquez sur le nom d’un élément pour avoir une définition détaillée de ses paramètres af­fi­chés.

authors (auteurs) insère une liste d’auteurs d’objets du dossier de site Web actif. Le fait de cliquer sur un nom d’auteur limite la liste des objets affichés dans la liste générée par contents aux objets générés par un auteur spécifique. Notez que cliquer sur un nom d’auteur n’a pas d’effet sur les listes hiérarchiques générées par tree.

Statique :  Non        
Paramètres :  Aucun

Exemple :

[element authors]

back (retour) insère un lien qui mène de l’intérieur du dossier de site Web au dossier parent qui n’est pas un dossier de site Web.

Statique :  Oui         
Paramètres :

text (optionnel)   
Par défaut, l’étiquette du lien retour provient du fichier langue de BSCW selon la langue d’usage de l’utilisateur (en français ceci sera « Retour »). Vous devez saisir une étiquette alternative dans les paramètres texte.

icon (optionnel)  
Au lieu du texte, vous pouvez aussi étiqueter le lien à un icône. Saisir l’URL de l’icône comme valeur dans ses paramètres. Si le texte et l’icône sont indi­qués, le lien sera étiquetté avec l’icône et le texte sera utilisé dans l’info-bulle.

Exemple :

[element text retour="Haut et éloigné"]

categories insère une liste de catégories assignées aux objets du dossier de site Web courant. Cliquer sur une catégorie limite la liste des objets affichés dans une liste gé­né­rée par contents aux objets avec une catégorie spécifique. Notez le fait de cliquer sur une catégorie n’a pas d’effet sur les listes hiérarchiques générés par tree.

Statique :  Non        
Paramètres : Aucun

Exemple :

[element categories]

contents (contenus) insère une liste de tous les objets contenus dans le dossier de site Web courant sous forme de liens cliquables. Dans le cas d’une recherche en texte inté­gral la liste sera remplacée par les résultats de la recherche.

Statique :  Oui                  
Paramètres :

showlayout, showstyle (optionnel, défaut False)      

Par défaut, la page de disposition et la définition de style n’apparaissent pas dans la liste du contenu. Vous pouvez forcer leur apparence en ajustant le paramètre à True.

showhome (optionnel, défaut True)    
Par défaut, la page d’accueil apparaît dans la liste du contenu. Vous devez con-tourner la procédure en modifiant le paramètre à False.

onlytypes (optionnel, défaut "text/html")    
Le paramètre onlytypes vous permet de masquer tous les documents qui n’ont pas un certain type MIME. Spécifiez une liste séparée par des virgules de types autorisés, par exemple text/html pour documents HTML. La spécification de tous les groupes de types MIME est aussi possible en utilisant le caractère gé­né­rique * (par exemple text/*). Les dossiers ne sont pas affectés par ce type de filtrage par types. Si vous voulez arrêter le filtrage, fixer le paramètre à "*".

onlynames (optionnel, défaut "*")      
Cela fonctionne comme onlytypes, à l’exception que le filtrage fonctionne sur la base du nom des objets. Spécifiez une liste de noms autorisés séparée par des virgules, par exemple image??.jpg ou *.html (* représente une chaine de ca­rac­tères arbitraire, tandis que ? représente un caractère arbitraire). Encore une fois, les dossiers ne sont pas touchés par ce filtrage par noms. À un mo¬ment donné, vous pouvez utiliser onlytypes ensemble avec onlynames. Dans ce cas, les seuls documents qui vont passer les deux critères seront affichés.

showfolders (optionnel, défaut "webonly")    
Détermine quels dossiers apparaissent en ajout aux autres objets et ils pour-raient avoir une des trois valeurs suivantes:

o  all      Tous les dossiers sont affichés.

o  none     Aucun dossier n’est affiché.

o  webonly  Seuls les dossiers de sites web ayant une page d’accueil ac-tive sont affichés.

showtemplatefolders (optionnel, défaut False)        
Par défaut, les dossiers de modèles ne sont pas affichés dans la liste de con­tenus. Vous pouvez forcer leur affichage en définissant le paramètre showtem-platefolders à True étant donné que tous ces dossiers seraient selon les rég­lages du paramètre showfolders.

showextensions (optionnel, défaut False)      
Par défaut, les noms d’extensions de fichiers (comme .html) ne s’affichent pas dans le liste de contenus. Vous pouvez forcer l’affichage des extensions en changeant le paramètre showextensions à True.

sort (optionnel, défaut "byName")       
Cela détermine comment le contenant de la liste est classé et il se peut qu’il est les valeurs suivantes.

o  byType    Les objets sont classés par types.

o  byName    Les objets sont classés par noms.

o  bySize    Les objets sont classés par grosseurs.

o  byDate    Les objets sont classés par la dernière date de modification.

o  byRating  Les objets sont classés par évaluations.

     Si le classement n’est pas spécifique, le contenant est classé par noms.

indextopmost (optionnel, défaut True
Par default, la page d’accueil d’un site web arrive en premier avec la liste de contenus indépendamment des critères de classement. Vous pouvez avoir la page d’accueil inséré dans la liste de contenus selon les critères de classement courant en programmant le paramètre indextopmost à False.

uplink (optionnel, défaut False)
Par défaut, la liste du contenu contient un lien vers le dossier du site Web pa-rent dans tous les dossiers site Web subsidiaires, mais pas dans le dossier de niveau supérieur. Vous pouvez supprimer ce lien en définissant le paramètre uplink à False. Vous pouvez également forcer le lien à apparaître dans tous les dossiers de sites, y compris ceux de haut niveau en définissant la valeur à True.

Exemples :

[element contents showlayout=True]       
Affiche une liste du contenu qui inclut la page de disposition.

[element contents onlynames="*.html"]  
Affiche une liste du contenu cachant tous les objets non-dossier avec les noms qui ne finissent pas avec « .html ».

[element contents onlytypes="text/plain, text/html"]       
Affiche une liste du contenu cachant tous les objets non-dossier autres que des documents de texte et HTML.

date insère la date et/ou l’heure actuelle. Pour les formats de date disponibles voir égale­ment 8.7.5 « Fonctions.

Statique :  Oui         
Paramètres :

format (optionnel)        
Si vous n’aimez pas le format de la date et l’heure choisie par défaut (comme réglé à 2007-07-13 14:31) et que vous êtes familier avec la programmation Python, vous pouvez spécifier votre propre format. S’il vous plait référez-vous au manuel Python sous strftime (ou voir la référence donnée plus haut pour le résumé).

Exemple :

[element date format="%A, %B %d, %I:%M %p"]  
Insère la date et l’heure actuelle au format utilisateur, affichant Mardi, Juillet 13, 02:31 PM au lieu du format standard indiqué ci-dessous.

documentactions (actions document) insère le menu actions non-JavaScript (voir 3.9.1 « JavaScript, feuilles de style et langue d’interface utilisateur) pour le do­cu­ment courant ou un lien direct vers une action spécifique.

Statique :  Non        
Paramètres :

action (optionnel)
Si le paramètre est omis, un menu actions complet sera inséré. Dans le cas con­traire, un lien direct vers l’action spécifiée sera créé. Voir ci-dessous pour les valeurs admissibles du paramètre action. Si l’action indiquée n’est pas auto­ri­sée pour l’utilisateur courant, l'élément documentations sera remplacé par la va­leur respectivement de forbiddentext ou forbiddenicon ou une chaîne vide.

text (optionnel et seulement utilisé si action est spécifiée)    
Le lien à l’action spécifié va être étiqueté avec la valeur de paramètre text. Si le paramètre text est omis, le lien va être étiqueté avec le nom de l’action BSCW selon la langue préférée de l’utilisateur. Souvenez-vous qu’un texte contenant des espaces doit être entre guillemets.

forbiddentext (optionnel et seulement utilisé si action est spécifiée) 
Si l’action indiquée n’est pas autorisée pour l’utilisateur actif, la valeur du para­mètre s’affiche à la place du lien d’action. La valeur par défaut de for­bid­den­text est une chaîne vide.

icon (optionnel et utilisée seulement si action est spécifiée)  
Le lien vers l’action spécifiée sera marqué par une icône. La valeur du pa­ra­mètre icon est une URL qui fait référence à l’icône. La valeur peut également être True et dans ce cas, l’icône BSCW de l’action est activée. Si tous les deux paramètres icon et text sont donnés, le lien est marqué par l’icône et le texte est utilisé comme info-bulle.

forbiddenicon (optionnel et utilisée seulement si action est spécifiée)         
Si l’action indiquée n’est pas autorisée pour l’utilisateur actif, l’icône visée par la valeur du paramètre sera affichée à la place du lien d’action.

Exemples :

[element documentactions]  
Insère le menu action non-JavaScript pour le document en cours.

[element documentactions action=get text="Source"] 
Insère un lien pour ouvrir le document avec le lien intitulé « Source ». Cette action va afficher le code source du document, à savoir les éléments BSCW ou des éléments de texte ne sont pas évaluées et remplacées.

[element documentactions action=replace]       
Insère un lien d’action pour remplacer le document actuel avec le libellé du lien par défaut « Remplacer ».

Actions possibles :   
addpage (Ajouter une page), addrole (Ajouter un rôle), addsubwebfolder (Ajouter un sous-dossier), add¬templ (Copier depuis un modèle), attachnote (Joindre une note), checkout (Verrouiller), chrole (Affecter un rôle), chtype (Modifier le type), copy (Copier), cut (Couper), cut¬attachment (Couper une pièce jointe), duplicate­_edit (Éditer la copie), edit (Éditer), editobject (Modifier les propriétés), edit­role (Modifier un rôle), export (Exporter PDF), firstversion (Lancer le contrôle de ver­sion), freeze (Geler), get (Ouvrir), history (Afficher l’historique), info (Plus d’in­formations), link (Lien vers le presse-pappier), make (Copie statique), print­web (Imprimer), rate (Évaluer), rename (Changer le nom), replace (Remplacer), resubmit (Se réinscrire), revise (Réviser), uploaddoc (Télécharger le document).

folderactions (actions dossier) fonctionne exactement comme documentactions, mais considère le dossier de site Web courant comme l’objet de référence pour le menu actions ou les liens d’action.

Statique :  Non        
Paramètres :

Mêmes que pour documentactions.

Exemples :

[element folderactions]     
Insère le menu action non-JavaScript pour le dossier de site Web actuel.

[element folderactions action=get text="Liste tous les objets dans le style BSCW"]         
Insère un lien pour ouvrir le dossier du site Web actuel avec l’étiquette « Liste tous les objets dans le style BSCW », résultant en une liste de dossier nor¬mal.

[element folderactions action=history] 
Insère un lien à l'historique de dossier de site Web courant avec le libellé du lien par défaut « Afficher l’historique ».

Actions possibles :   
addcal (Ajouter un agenda de groupe), addctlist (Ajouter une liste de contacts), addfolder (Ajouter un dossier) addmember (Inviter un membre), addnotes (Ajouter un forum de discussion), addocset (Ajouter un ensemble de docu­ments), addrole (Ajouter un rôle), addSearch (Ajouter un dossier de recherche), addurl (Ajouter une URL), addwebfolder (Ajouter un dossier de site Web), chbanner (Changer la ban¬nière), chrole (Affecter un rôle), copy (Copier), cut (Couper), editdescription (Mo¬di¬fier la description), editindex (Éditer la page d’accueil), editmetadata (Mo¬di-fi¬er les attributs), editobject (Modifier les propriétés), editrole (Modifier un rôle), editstyle (Éditer la définition de style), edittemplate (Éditer la page de dis¬po-sition), export (Exporter PDF), get (Ouvrir), getweb (Afficher la vue Web), history (Afficher l’historique), info (Plus d’informations), link (Lien vers le presse-pa¬piers), make (Copie statique) pubaccess (Accès public), rename (Changer le nom), uploaddoc (Télécharger le document).

goto (aller à) insère le menu non-JavaScript « Aller à ».

Statique :  Non        
Paramètres : Aucun

Exemple :

[element goto]

history (historique) insère une liste des derniers documents qui ont été visités der­nière­ment comme une liste de liens cliquables.

Statique :  Non        
Paramètres :

divider (optionnel)        
Par défaut, les liens de la liste sont séparés par une virgule et un espace. En uti­li¬sant le paramètre divider, vous pouvez saisir une chaîne de séparation al­ter¬native.

maxdocs (optionnel)      
Par défaut, au plus 5 documents seront listés. Avec le paramètre maxdocs vous pouvez définir un maximum différent.

showextensions (optionnel)      
Par défaut, les extensions de fichiers (tel que .html) ne figurent pas dans la liste d’historique. En fixant la valeur True pour showextensions vous pouvez af¬ficher les extensions de fichier.

Exemple :

[element history divider=" | " maxdocs=7]

lastmod (dernière modification) insère la date et/ou l’heure de dernière modification du document en courant.

Statique :  Oui         
Paramètre :

format (optionnel)        
Vous pouvez spécifier votre propre format (date et heure) comme il est ex¬pli-qué ci-dessus, sous date.

Exemple :

[element lastmod]

lastmodby (auteur de dernière modification) insère le nom de l’utilisateur qui a modi­fié le dernier le document en cours.

Statique :  Oui         
Paramètres : Aucun

Exemple :

[element lastmodby]

location (position) insère le chemin d’accès au document courant sous forme de liens cliquables.

Statique :  Oui         
Paramètres : Aucun

Exemple :

[element location]

message insère un message du système BSCW. Ces messages sont affichés dans la langue préférée de l’utilisateur courant.

Statique :  Oui         
Paramètre :

name (requis)    
Le nom du message à afficher. Les messages disponibles sont contenus dans le fichier sur votre serveur BSCW à      
répertoire-bscw/messages/fr/lg_msgconfig.py.   
Demandez à votre administrateur système BSCW pour la localisation précise de ce fichier dans votre installation BSCW.

Exemple:

[element message name=location] 
affiche le message nommé « location ». En français, cela donne « Votre posi-tion ».

metadata (métadonnées) insère un tableau listant toutes les métadonnées (balises, attributs) de l’objet actif.

Statique :  Oui         
Paramètres : Aucun

Exemple :

[element metadata]

search (recherche) insère un champ de saisie pour la recherche en texte intégral dans le dossier de site Web. Les résultats de la recherche remplacent les listes de contenu de l’ar­borescence qui étaient générées en utilisant contents ou tree. L’utilisation de search n’a de sens que si vous utilisez contents ou tree en même temps, sinon les ré­sul­tats de la recherche ne seront pas affichés.

Statique :  Non        
Paramètres : Aucun

Exemple :

[element search]

size (taille) insère la taille d’un objet.

Statique :  Oui         
Paramètres :

filename (optionnel)      
Par défaut, la taille du document en cours est utilisée. Vous pouvez spécifier un autre objet en donnant son nom dans le paramètre filename.

unit (optionnel)   
L’unité par défaut est en octets (B). Si votre document est assez grand, une autre unité peut être plus appropriée. Les unités valides sont B, KB, MB et GB.

Exemple :

[element size filename="files/dvd-image.iso" unit=GB]     
Insère la taille de l’objet dvd-image.iso dans le sous-dossier files du dossier actuel, mesurée en giga-octets.

systembanner (bannière de système) insère la bannière du système, par défaut la ban­nière du système BSCW.

Statique :  Oui         
Paramètres : Aucun

Exemple :

[element systembanner]

tags (balises) insère une liste de balises assignées aux objets du dossier de site Web actuel. Cliquer sur une balise restreint la liste des objets affichés dans une liste générée par contents aux objets ayant une balise spécifique assignée. Notez que cliquer sur une balise n’a pas d’effet sur les listes hiérarchiques générées par tree.

Statique :  Non        
Paramètres : Aucun

Exemple :

[element tags]

tree (arborescence) insère un arbre de liens cliquables affichant les contenus du dos­sier de site Web actif à partir du plus haut niveau vers le document actuel. Après une re­cherche en texte intégral, l’arbre sera remplacé par les résultats de la re­cherche.

Statique :  Oui         
Paramètres :

Même que pour contents, à une exception concernant la valeur par défaut:

showhome (optionnel ; voir ci-dessous pour la procédure par défaut)        
Par défaut, la page d’accueil est affichée pour le dossier de niveau supérieur, mais pas pour les sous-dossiers de l’arborescence. Vous pouvez déroger de cette procédure en réglant le paramètre sur True ou False.

Exemples :

[element tree showlayout=True]    
Affiche l’arborescence des contenus qui inclut les pages de disposition.

[element tree onlynames=*.html]  
Affiche l’arborescence des contenus sans les objets non-dossiers avec des noms qui ne se terminent pas par « .html ».