Référence OvML

Un article de OviWiki.

Sommaire

Présentation

OvML ( Ovidentia Markup Langage ) est un ensemble de balises, identiques par leur syntaxe à celles utilisées avec HTML. Elles permettent d’extraire des données Ovidentia, de les manipuler et de les présenter en utilisant HTML.

Les données à extraire peuvent être de plusieurs types, comme par exemple, les cinq derniers articles publiés, les dernières contributions d’un forum donné, les derniers fichiers chargés, etc …

On pourra ainsi s’en servir pour réorganiser complètement la page d'accueil d'un site Ovidentia en y insérant, par exemple, la liste des 3 derniers articles, la liste des 5 dernières contributions d'un forum, des images, le texte d'un article spécifique, ...

La conception d'une page OvML est identique à celle d'une page HTML. Elle peut ne contenir que des balises OvML ou un mélange HTML et OvML. On peut aussi partir d'une page HTML existante et y insérer des données Ovidentia en utilisant les balises OvML. Pour l’afficher, on utilisera l’url suivante :

http://url-du-site/index.php?tg=oml&file=fichier-ovml

Certaines balises OvML sont dites “Container". Un container est une balise OvML contenant une partie du fichier OvML comprise entre un tag d’ouverture et un tag de fermeture. Un container peut être une liste ou une condition. Dans le cas d’une liste, le contenu du container est répété autant de fois qu’il y a d’éléments dans la liste. Un container ‘condition’ n’affiche son contenu que dans le cas où la condition est vraie.

Les variables <OVxxxx>

Une variable OvML est de la forme:

<OVxxxx param1="value" param2="value" ...>

où xxxx est le nom de la variable.

Différents paramètres peuvent être utilisés pour modifier l’affichage du résultat de la variable.

Toute variable OvML peut être sauvegardée dans une autre variable en utilisant le paramètre saveas (voir ci-dessous).

Les fonctions <OFxxxx>

Les fonctions se présentent sous la forme :

<OFxxxx param1="value" param2="value" ...>

Elles permettent, entre autre, de traduire du texte, de faire des opérations arithmétiques, etc, …

Le résultat de ces fonctions peut être sauvegardé dans une variable OvML en utilisant le paramètre saveas (voir ci-dessus).

Les containers <OCxxxx> … </OCxxxx>

La syntaxe des containers est comme suit :

<OCxxxx param1="value" param2="value" ...>
    ...
</OCxxxx>

Remarque importante d'utilisation des containers :

  • Il est possible d’imbriquer les containers sauf s’ils ont le même nom. Dans le cas précédent, il existe l’astuce de rajouter un paramètre sans valeur différente dans les balises. Ce paramètre va permettre d'identifier l'ouverture et la fermeture des containers par le moteur d'Ovidentia. Le paramètre doit donc se retrouver dans la balise d'ouverture ainsi que dans la balise de fermeture.

Exemple :

<OCxxxx param1="value" param2="value" monparametre1>
    <OCxxxx param1="value" param2="value" monparametre2>
        ...
    </OCxxxx monparametre2>
</OCxxxx monparametre1>
  • Chaque paramètre d'un container est vu comme une variable par le moteur OvML; il faut donc éviter d'utiliser pour nom d'une variable OvML le nom d'un attribut d'un container pour supprimer des erreurs d'interprétation.

Les variables OvML

Les variables OvML peuvent être définies dans le fichier OvML, produites par un container ou passées comme paramètres dans l’url. Elles sont accessibles en utilisant la syntaxe :

<OVnom-de-la-variable>

On peut définir une variable OvML en utilisant la fonction PutVar :

<OFPutVar name="nbArticles" value="10">

Ceci définit une variable nbArticles initialisée à la valeur 10.

Pour récupérer la valeur dans une page OvML, il faut utiliser la syntaxe suivante :

<OVnbArticles>

On peut aussi définir une variable en utilisant une variable globale d’Ovidentia. Pour cela, il suffira d’omettre le deuxième paramètre :

<OFPutVar name="babSlogan">

Maintenant la variable <OVbabSlogan> existe dans OvML et contient le contenu du slogan du site.

On peut ainsi utiliser les variables d’Ovidentia pour récupérer le nom de l’utilisateur connecté ( BAB_SESS_USER ), son ID ( BAB_SESS_USERID ), etc.

Remarque :

  • babCurrentDate est une variable globale permettant de récupérer la date courante. Elle ne doit pas être déclarée par la fonction OFPutVar pour l'utiliser.
  • Les variables globales booléennes comme BAB_SESS_LOGGED ont la valeur nulle si la valeur est fausse (false) et vaut 1 si la valeur est vraie (true).

Il est parfois utile de tester l’existence d’une variable avant de la définir. On utilisera pour cela la fonction IfNotIsSet :

<OFIfNotIsSet name="page" value="1">

Dans ce cas, si la variable page n’est pas définie, elle sera définie avec la valeur initiale 1.

Toutes les variables produites par un container peuvent être jointes en utilisant la syntaxe d’une variable OvML <OVxxxx>.

On peut aussi passer des variables OvML à un fichier OvML en utilisant l’url :

http://url-du-site/index.php?tg=oml&file=fichier-ovml&total=1000

Dans la page OvML on peut donc utiliser la variable totale.

Toute variable OvML peut être modifiée ou sauvegardée dans une autre variable en utilisant les attributs suivants :

saveas

Permet de sauvegarder une variable dans une autre.

<OVnbArticles saveas="TotalArticles">

Une nouvelle variable TotalArticles est créée et sa valeur est la même que celle de nbArticles.

strlen

Permet de récupérer les n premiers caractères de la variable.

Value
n Récupère les n premiers caractères du contenu de la variable
<OVbabSlogan strlen="100">

Il est possible de spécifier une chaîne qui sera ajoutée à la fin du résultat si la variable a été tronquée. Par exemple "...“ pour indiquer une suite :

<OVbabSlogan strlen="100,...">

striptags

Supprime les tags HTML de la variable :

Value
1 Supprime les tags HTML de la variable
<OVbabSlogan striptags="1">

htmlentities

Value
1 Convertit les entities HTML ( < devient &lt; )
2 Convertit en inverse les entities HTML ( &lt; devient < )
<OVbabSlogan htmlentities="1">

stripslashes

Supprime les slashs doublés du contenu de la variable

Value
1 Supprime les slashs doublés du contenu de la variable
<OVbabSlogan stripslashes="1">

urlencode

Value
1 Encode la variable pour l'utilisation dans une url
<OVbabSlogan urlencode="1">

jsencode

Value
1 Encode la variable pour l'utilisation dans du javascript
<OVbabSlogan jsencode="1">

strcase

Value
upper Convertit le contenu de la variable en majuscule
lower Convertit le contenu de la variable en minuscule
<OVbabSlogan strcase="upper">

nlremove

Value
1 Supprime les retours chariots
<OVbabSlogan nlremove="1">

trim

Value
left Supprime les blancs en début de chaîne
right Supprime les blancs en fin de chaîne
all Supprime les blancs en début et en fin de chaîne
<OVbabSlogan trim="all">

nl2br

Value
1
Transforme les retours chariots en <BR>
<OVbabSlogan nl2br="1">

sprintf

Value
Voir la documentation PHP pour la fonction sprintf Retourne une chaîne formatée
<OVMoney sprintf="%01.2f">

date

Permet de formater une date Ovidentia

Value
S Format court de la date défini au niveau site ou au niveau utilisateur
L Format long de la date défini au niveau site ou au niveau utilisateur
T Format de l'heure défini au niveau site ou au niveau utilisateur
d Trois premières lettres du jour de la semaine Dim pour Dimanche
D Jour de la semaine Dimanche par exemple
j Jour du mois, sur deux chiffres (éventuellement avec un zéro) : "01" à "31"
m Mois, en trois lettres : par exemple "Avr" (pour Avril)
M Mois en lettres : Avril par exemple
n Mois; i.e. "01" à "12"
Y Année, 4 chiffres; i.e. "2003"
y Année, 2 chiffres; i.e. "03"
H heure, au format 24h, "00" à "23"
i Minutes; "00" à "59"
<OVArticleDate date="%d %j %m %Y">

Remarque :

<OVbabCurrentDate> est une variable permettant de récupérer la date courante.

Elle ne doit pas être déclarée par la fonction OFPutVar pour l'utiliser.

<OVbabCurrentDate date="%D %j %M" strcase="lower">

author

Permet de formater l’auteur d’un article, un commentaire etc, … quand la variable contient l’id de l’auteur.

Value
 %F Prénom
 %M Deuxième prénom
 %L Nom
<OVArticleAuthor author="%F %L" strcase="lower">

Les fonctions OvML

On reconnaît les fonctions par la syntaxe suivante :

<OFxxxx ...>

Les fonctions OvML disponibles sont :

OFTranslate

Permet de traduire une chaîne. Pour cela, il faut qu'un fichier se nommant lang-identifiant-de-la-langue.xml soit présent dans le dossier ovidentia-numéro-de-version/lang.

Il s'agit d'un fichier XML listant différentes expressions traduites dans la langue choisie pour le fichier. Il est composé d'un élément ayant le même nom que l'identifiant de la langue. Celui-ci est composé de multiples éléments string prenant un paramètre id indiquant l'identifiant du texte et contient le texte traduit.

Extrait du fichier langue pour l'anglais lang-en.xml :

<en>
    <string id="About your article">About your article</string>
    <string id="About your comment">About your comment</string>
    <string id="About your file">About your file</string>
</en>

Extrait du fichier langue pour le français lang-fr.xml :

<fr>
    <string id="About your article">Au sujet de votre article</string>
    <string id="About your comment">A propos de votre commentaire</string>
    <string id="About your file">A propos de votre fichier</string>
</fr>

Syntaxe

<OFTranslate text="" [lang=""] [folder=""]>

Paramètres

text
Identifiant du texte à traduire
lang (optionnel)
Identifiant de la langue dans laquelle doit être traduit le texte
Si omis, le texte sera traduit dans la langue sélectionnée par l'utilisateur
folder (optionnel)
Nom du module
Si omis, le fichier langue du noyau est utilisé

OFPutVar

Permet de déclarer une nouvelle variable.

Syntaxe

<OFPutVar name="" [value=""]>

Paramètres

name
Nom de la variable
value (optionnel)
Valeur à affecter à la variable

OFGetVar

Permet d'afficher une variable tout comme la syntaxe <OVnom-de-la-variable>.

Syntaxe

<OFGetVar name="">

Paramètres

name
Nom de la variable à afficher

OFIfNotIsSet

Permet de sauvegarder une variable si elle n’est pas déjà définie.

Syntaxe

<OFIfNotIsSet name="" [value=""]>

Paramètres

name
Nom de la variable
value (optionnel)
Valeur à affecter à la variable

OFInclude

Permet d'inclure un autre fichier OVML

Syntaxe

<OFInclude file="" [cache=""]>

Paramètres

file
Chemin du fichier OVML relatif au répertoire ovml du skin ou du répertoire ovml du noyau
cache (optionnel)
  • 0 (par défaut) : Le cache n'est pas utilisé pour afficher le fichier.
  • 1 : Le cache est utilisé.

OFUrlContent

Permet de récupérer le contenu d’une url. Très utile pour inclure dans Ovidentia des fichiers HTML d’un site Web statique

Syntaxe

<OFUrlContent url="">

Paramètres

url
url de la page à inclure

OFRecurse

La fonction OFRecurse permet d'exécuter un code tant qu'une condition est réalisée.

Syntaxe

<OFRecurse>

Paramètres

Cette fonction peut prendre tous les paramètres que peut prendre le container appelé récursivement.

Exemple

Cet exemple permet d'afficher l'arborescence des catégories et thèmes d'articles. Ici, la fonction OFRecurse est utilisée pour relancer le container <OCArticleCategories> autant de fois que désiré en lui précisant le paramètre parentid (voir container <OCArticleCategories>).

<ul>
    <OCArticleCategories>
        <li>
            <OVCategoryName>
            <ul>
                <OFRecurse parentid="&lt;OVCategoryId&gt;">
                <OCArticleTopics categoryid="&lt;OVCategoryId&gt;">
                    <li><OVTopicName></li>
                </OCArticleTopics>
            </ul>
        </li>
    </OCArticleCategories>
</ul>

Opérateurs arithmétiques

Permettent de faire des opérations arithmétiques sur des variables. Elles sont construites de la manière suivante :

<OFAOxxxxx expr1="X" expr2="Y">
<OFAOxxxxx expr1="10" expr2="50">

Ceci effectue l'opération souhaitée entre 10 et 50.

<OFAOxxxxx expr1="<OVTotal&gt;" expr2="50">

Ceci effectue l’opération souhaitée entre la valeur de Total et 50.

Toutefois, pour pouvoir stocker cette valeur dans une variable, il faut ajouter le paramètre saveas lors de l'appel de la fonction.

<OFAOxxxxx expr1="<OVTotal&gt;" expr2="50" saveas="NewTotal">

Ceci définit la variable NewTotal ayant pour valeur le résultat de l'opération souhaitée entre la valeur de Total et 50.

Les opérateurs disponibles sont :

OFAOAddition

Permet d’additionner expr1 et expr2.

Syntaxe

<OFAOAddition expr1="" expr2="">

Paramètres

expr1
Premier terme de l'addition
expr2
Second terme de l'addition

OFAOSubtraction

Permet de soustraire expr2 à expr1.

Syntaxe

<OFAOSubtraction expr1="" expr2="">

Paramètres

expr1
Premier terme de la soustraction
expr2
Second terme de la soustraction

Exemple

<OFAOSubtraction expr1="10" expr2="20">

Cette opération retourne le résultat de l'opération "10 - 20", soit -10.

OFAOMultiplication

Permet de faire le produit de expr1 et expr2.

Syntaxe

<OFAOMultiplication expr1="" expr2="">

Paramètres

expr1
Premier terme de la multiplication
expr2
Second terme de la multiplication

OFAODivision

Permet de diviser expr1 par expr2.

Syntaxe

<OFAODivision expr1="" expr2="">

Paramètres

expr1
Premier terme de la division
expr2
Second terme de la division

Exemple

<OFAODivision expr1="10" expr2="20">

Cette opération retourne le résultat de l'opération "10 / 20", soit 0.5.

OFAOModulus

Permet de récupérer le reste de la division de expr1 par expr2.

Syntaxe

<OFAOModulus expr1="" expr2="">

Paramètres

expr1
Premier terme du modulo
expr2
Second terme du modulo

Exemple

<OFAOModulus expr1="10" expr2="20">

Cette opération retourne le résultat de l'opération "10 % 20", soit 10, car 10 / 20 = 0 + 10.

OFHeader

Permet d'envoyer un header HTTP pour le fichier ovml.

Syntaxe

<OFHeader value="">

Paramètres

value
Valeur du header à modifier

Exemple

<OFHeader value="content-type:text/xml">

OFSetCookie

Permet de définir un cookie qui sera envoyé avec le reste des en-têtes.

Syntaxe

<OFSetCookie name="" expire="" [value=""]>

Paramètres

name
Nom du cookie
expire
Temps en secondes au bout duquel le cookie expire
value (optionnel)
Valeur à affecteur au cookie

OFGetCookie

Permet de récupérer la valeur d'un cookie. Une variable ayant le nom du cookie récupéré est créée automatiquement.

Syntaxe

<OFGetCookie name="">

Paramètres

name
Nom du cooke dont on souhatie récupérer la valeur

OFSetSessionVar

Permet de choisir le type de sections à afficher dans le portail.

Syntaxe

<OFSetSessionVar name="" value="">

Paramètres

name
Permet d'indiquer le type de filtre à appliquer sur les sections
  • "babSectionsType" définit le type des sections à afficher
  • "babOvmlCurrentDelegation" filtre sur les sections propres à une délégation
value
Permet de préciser les sections à afficher.
  • Si name vaut "babSectionsType" :
    • 1 : Section Administration et Utilisateur
    • 2 : Sections générées par les articles (sections de catégories et de thèmes d'articles)
    • 4 : Sections personnalisées
    • 8 : Sections générées par les modules
    • 15 : Toutes les sections
    • Remarque : les valeurs peuvent s'additionner. Pour afficher les sections des articles et les sections personnalisées, on utilisera la valeur 6 (2 + 4)
  • Si name vaut "babOvmlCurrentDelegation", value vaut l'id de la délégation

Exemples

<OFSetSessionVar name="babSectionsType" value="15">

affichera toutes les sections du portail

<OFSetSessionVar name="babSectionsType" value="4">

affichera uniquement les sections personnalisées du portail

<OFSetSessionVar name="babSectionsType" value="10">

affichera les sections générées par les modules et les sections générées par les articles

<OFSetSessionVar name="babOvmlCurrentDelegation" value="5">

affichera uniquement les sections générées par la délégation dont l'identifiant est 5

<OFSetSessionVar name="babOvmlCurrentDelegation" value="0">

cache toutes les sections générées dans les délégations

OFRequest

Permet de connaître la valeur d'un paramètre dans l'url (méthode GET) ou passé par un formulaire (méthode POST).

Syntaxe

<OFRequest name="" saveas="" [default=""]>

Paramètres

name
Nom du paramètre GET dont on souhaite récupérer la valeur. Depuis la version 8.1 il est possible de passer un tableau.
saveas
Permet d'enregistrer la valeur du paramètre dans une nouvelle variable OvML.
default (optionnel)
Permet d'attribuer une valeur à la variable lorsque celle-ci n'est pas définie.

OFPost

Permet de connaître la valeur d'un paramètre passé par un formulaire (méthode POST).

Syntaxe

<OFPost name="" saveas="" [default=""]>

Paramètres

name
Nom du paramètre POST dont on souhaite récupérer la valeur. Depuis la version 8.1 il est possible de passer un tableau.
saveas
Permet d'enregistrer la valeur du paramètre dans une nouvelle variable OvML.
default (optionnel)
Permet d'attribuer une valeur à la variable lorsque celle-ci n'est pas définie.

OFGet

Permet de connaître la valeur d'un paramètre dans l'url (méthode GET).

Syntaxe

<OFGet name="" saveas="" [default=""]>

Paramètres

name
Nom du paramètre GET dont on souhaite récupérer la valeur. Depuis la version 8.1 il est possible de passer un tableau.
saveas
Permet d'enregistrer la valeur du paramètre dans une nouvelle variable OvML.
default (optionnel)
Permet d'attribuer une valeur à la variable lorsque celle-ci n'est pas définie.

OFSitemapPosition

Retourne une liste au format HTML (ul, li) contenant le chemin dans le plan du site du nœud correspondant à la page courante d'Ovidentia (ou à l'élément de navigation passé en paramètre).

Syntaxe

<OFSitemapPosition [sitemap=""] [basenode=""] [node=""] [keeplastknown=""]>

Paramètres

langid (optionnel)
Permet de spécifier le nœud pour lequel on désire son chemin dans le plan du site en utilisant un identifiant de compatible avec le multilangue.


node (optionnel)
Permet de spécifier le nœud pour lequel on désire son chemin dans le plan du site. Si omis: la fonction retournera le chemin correspondant à la page courante d'Ovidentia
Exemple : babUserSection, babUserSectionAddons, babArticles, babFaqs, Custom...
basenode (optionnel)
Permet de spécifier le nœud à partir duquel le chemin commencera. Ceci permet d'éviter l'affichage des premiers niveaux de l'arborescence (entrées Accueil, Racine...).
Ce paramètre est aussi très utile dans le cas où un élément de navigation se retrouve à plusieurs reprises dans l'arborescence du plan du site. Préciser le nœud de base permet de retrouver le nœud qui nous intéresse (lorsque le paramètre node n'existe pas).
sitemap (optionnel)
Identifiant unique du plan du site utilisé, si l'attribut n'est pas renseigné, c'est le plan du site configuré au niveau du site qui sera utilisé.
keeplastknown (optionnel)
Active la sauvegarde du dernier chemin retourné. Ainsi, si la fonction ne trouve pas le nœud correspondant à la page courante d'Ovidentia, c'est l'ancien chemin qui sera affiché.
1 (par défaut) : activé.
0 : désactivé

OFSitemapMenu

Retourne une liste au format HTML (ul, li) contenant l'arborescence des entrées de navigation d'Ovidentia (Plan du site), ou l'arborescence des entrées de navigation sous le nœud spécifié (si le paramètre selectednode est indiqué).

Syntaxe

<OFSitemapMenu [sitemap=""] [baselangid=""] [basenode=""] [selectednode=""] [keeplastknown="1"] [maxdepth=""] [ignorelastlevel="0"] [mindepth="0"] [outerul="1"] [admindelegation="0"]>

Paramètres

sitemap (optionnel)
Identifiant unique du plan du site utilisé, si l'attribut n'est pas renseigné, c'est le plan du site configuré au niveau du site qui sera utilisé.


baselangid (optionnel)
Permet de spécifier le nœud à partir duquel le menu commencera en utilisant un identifiant compatible avec le multilangue


basenode (optionnel)
Permet de spécifier le nœud à partir duquel le menu commencera. Ceci permet d'éviter l'affichage des premiers niveaux de l'arborescence (entrées Accueil, Racine...).
Ce paramètre est aussi très utile dans le cas où un élément de navigation se retrouve à plusieurs reprises dans l'arborescence du plan du site. Préciser le nœud de base permet de retrouver le nœud qui nous intéresse (lorsque le paramètre node n'existe pas).
S'il n'est pas renseigné, c'est le nœud DGAll qui sera utilisé (le nœud racine de la branche contenant les éléments de toutes les délégations confondues) ou le noeud "Custom" si un plan du site fourni par le module sitemap_editor est utilisé.
selectednode (optionnel)
Permet de spécifier un nœud sélectionné dans le menu. La balise li correspondant à ce nœud se verra ajouter la classe css 'selected', et toutes ses balises li parentes ainsi qu'elle même auront la classe css 'active'. S'il n'est pas spécifié, c'est le nœud correspondant à la page courante qui est utilisé.
Exemple : babUserSection, babUserSectionAddons, babArticles, babFaqs, Custom...
keeplastknown (optionnel)
Active la sauvegarde du dernier chemin retourné. Ainsi, si la fonction ne trouve pas le nœud correspondant à la page courante d'Ovidentia, c'est l'ancien chemin qui sera affiché.
1 (par défaut) : activé
0 : désactivé
maxdepth (optionnel)
Permet de limiter le nombre de niveaux (sous-menus imbriqués). Pas de limite par défaut.
ignorelastlevel (optionnel)
Depuis Ovidentia 8.3.92
Permet de ne pas afficher les nœuds n'ayant pas d'enfants.
1 : activé
0 (par défaut) : désactivé
mindepth (optionnel)
Depuis Ovidentia 8.3.92
Permet de contourner 'ignorelastlevel' en forçant l’affichage des nœuds de niveau inférieur ou égal à cette valeur. 0 par défaut (désactivé).
outerul (optionnel)
Permet de de définir si le menu contient la balise <ul> de premier niveau.
1 (par défaut) : la balise <ul> de premier niveau est présente.
0 : la balise <ul> de premier niveau n'est pas présente.
admindelegation (optionnel)
Permet de définir que les nœuds d'administration ne seront affichés que si l'utilisateur à les droits de gestion correspondants.
1 : la délégation est prise en compte.
0 (par défaut) : la délégation n'est pas prise en compte.


OFCurrentNode

Retourne l'Id du nœud courant dans le plan de site.

OFThumbnail

Génère le thumbnail d'un fichier, de la photo d'une fiche utilisateur ou d'annuaire, ou de l'image associée d'un article et renvoie une url vers l'image générée.

Nécessite le module LibFileManagement.

Syntaxe

<OFThumbnail (id_directory_entry="" | id_user="" | id_article="" | id_file="" | path="absolute/path/to/image") [maxwidth="400"] [maxheight="400"] [resizemode="KEEP_ASPECT_RATIO | CROP_CENTER"] [resizeleft="0.0 .. 1.0"] [resizetop="0.0 .. 1.0"] [default="path/to/default/image.jpg"][innerborderwidth="0"] [innerbordercolor="#ffffff"] [innerborder="0,#ffffff"] [outerborderwidth="0"] [outerbordercolor="#ffffff"] [outerborder="0,#ffffff"] [saveas=""]>

Paramètres

id_directory_entry (optionnel)
Identifiant d'une fiche d'annuaire.
id_user (optionnel)
Identifiant d'un utilisateur.
id_article(optionnel)
Identifiant d'un article pour récupérer l'image de l'article.
id_file(optionnel)
Depuis LibFileManagement 0.3.7
Identifiant d'un fichier du gestionnaire de fichier.
path (optionnel)
Chemin absolu vers un fichier sur le serveur
maxwidth (optionnel)
Largeur maximale du thumbnail en pixels.
maxheight (optionnel)
Hauteur maximale du thumbnail en pixels.
resizemode (optionnel)
Définit la méthode utilisée pour ajuster la taille de l'image.
  • KEEP_ASPECT_RATIO (par défaut) : toute l'image est rétrécie de manière à tenir dans (maxwidth x maxheight)
  • CROP_CENTER : l'image est découpée de manière à tenir dans (maxwidth x maxheight) sans bandes vides.
resizeleft (optionnel)
Depuis LibFileManagement 0.2.42
Si resizemode=CROP_CENTER sélectionne la partie de l'image à découper : 0.0 prend la partie la plus à gauche, 1.0 la plus à droite de l'image originale. (0.5 par défaut, c'est-à-dire centrée horizontalement).
resizetop (optionnel)
Depuis LibFileManagement 0.2.42
Si resizemode=CROP_CENTER sélectionne la partie de l'image à découper : 0.0 prend la partie la plus en haut, 1.0 la plus en bas de l'image originale. (0.5 par défaut, c'est-à-dire centrée verticalement).
innerborderwidth (optionnel)
Largeur de la bordure intérieure en pixels.
innerbordercolor (optionnel)
Couleur de la bordure intérieure au format #xxxxxx.
innerborder (optionnel)
Raccourci de innerborderwidth et innerbordercolor avec les deux valeurs séparées par une virgule.
outerborderwidth (optionnel)
Largeur de la bordure extérieure en pixels
outerbordercolor (optionnel)
Couleur de la bordure extérieure au format #xxxxxx.
outerborder (optionnel)
Raccourci de outerborderwidth et outerbordercolor avec les deux valeurs séparées par une virgule.
saveas (optionnel)
Permet d'enregistrer le résultat de la fonction dans une variable, dans ce cas, le résultat n'est pas affiché.

OFImg

Génère le thumbnail d'un fichier, de la photo d'une fiche utilisateur ou d'annuaire, ou de l'image associée d'un article et renvoie du HTML contenant un tag img pour afficher l'image. Si aucune image ne peut être affichée, une chaine vide est retournée au lieu du tag img.

Les attributs non supportés par la fonction ovml serons reportés tel-quel en tant qu'attributs du tag img.

Nécessite le module LibFileManagement.

Syntaxe

<OFImg (src="" | ovsrc="" | id_directory_entry="" | id_user="" | id_article="" | id_file="" | path="absolute/path/to/image") [maxwidth="400"] [maxheight="400"] [resizemode="KEEP_ASPECT_RATIO | CROP_CENTER"] [resizeleft="0.0 .. 1.0"] [resizetop="0.0 .. 1.0"] [default="path/to/default/image.jpg"][innerborderwidth="0"] [innerbordercolor="#ffffff"] [innerborder="0,#ffffff"] [outerborderwidth="0"] [outerbordercolor="#ffffff"] [outerborder="0,#ffffff"] >

Paramètres

src (optionnel)
Url vers une image, si cet attribut est déclaré mais contient une chaîne vide, la valeur retournée sera une chaîne vide au lieu du tag img. Attention, les fonctionnalités du thumbnailer ne s'appliquent pas dans ce cas.
ovsrc (optionnel)
Permet de définir l'url d'une image en utilisant le nom d'une variable ovml. Attention, les fonctionnalités du thumbnailer ne s'appliquent pas dans ce cas.
id_directory_entry (optionnel)
Identifiant d'une fiche d'annuaire.
id_user (optionnel)
Identifiant d'un utilisateur.
id_article(optionnel)
Identifiant d'un article pour afficher l'image de l'article.
id_file(optionnel)
Depuis LibFileManagement 0.3.7
Identifiant d'un fichier du gestionnaire de fichier.
path (optionnel)
Chemin absolu vers un fichier sur le serveur
maxwidth (optionnel)
Largeur maximale du thumbnail en pixels.
maxheight (optionnel)
Hauteur maximale du thumbnail en pixels.
resizemode (optionnel)
Définit la méthode utilisée pour ajuster la taille de l'image.
  • KEEP_ASPECT_RATIO (par défaut) : toute l'image est rétrécie de manière à tenir dans (maxwidth x maxheight)
  • CROP_CENTER : l'image est découpée de manière à tenir dans (maxwidth x maxheight) sans bandes vides.
resizeleft (optionnel)
Depuis LibFileManagement 0.2.42
Si resizemode=CROP_CENTER sélectionne la partie de l'image à découper : 0.0 prend la partie la plus à gauche, 1.0 la plus à droite de l'image originale. (0.5 par défaut, c'est-à-dire centrée horizontalement).
resizetop (optionnel)
Depuis LibFileManagement 0.2.42
Si resizemode=CROP_CENTER sélectionne la partie de l'image à découper : 0.0 prend la partie la plus en haut, 1.0 la plus en bas de l'image originale. (0.5 par défaut, c'est-à-dire centrée verticalement).
innerborderwidth (optionnel)
Largeur de la bordure intérieure en pixels.
innerbordercolor (optionnel)
Couleur de la bordure intérieure au format #xxxxxx.
innerborder (optionnel)
Raccourci de innerborderwidth et innerbordercolor avec les deux valeurs séparées par une virgule.
outerborderwidth (optionnel)
Largeur de la bordure extérieure en pixels
outerbordercolor (optionnel)
Couleur de la bordure extérieure au format #xxxxxx.
outerborder (optionnel)
Raccourci de outerborderwidth et outerbordercolor avec les deux valeurs séparées par une virgule.

Exemples

Affiche l'image que si le paramètre img est fourni dans l'url :

<OFGet name="img" saveas="Image">
<OFImg ovsrc="Image" alt="Mon image">


Affiche la photo de l'utilisateur connecté :

<OFPutVar name="BAB_SESS_USERID">
<OFPutVar name="BAB_SESS_USER">
<OFImg id_user="<OVBAB_SESS_USERID>" maxwidth="48" maxheight="48" alt="<OVBAB_SESS_USER>" resizemode="CROP_CENTER">

OFSitemapCustomNodeId

Retourne l'ID du noeud trouvé dans le plan du site et qui a pour cible le nœud fourni par le paramètre nodeid dans le plan du site du noyau. Si aucun noeud est trouvé dans le plan du site, la valeur de l'attribut nodeid est retourné a la place.

Lors de la mise en place d'un skin cela permet d'indiquer un nœud connu dans le plan du site du noyau, ci celui-ci est inséré dans le plan du site personnalisé à l'aide d'une référence, le nouveau nœud sera automatiquement pris en compte.

Si il existe plusieurs nœuds avec la même cible dans le plan du site du noyau, le premier trouvé sera utilisé

Syntaxe

<OFSitemapCustomNodeId node="" [basenode=""] [saveas=""]>

Paramètres

node
ID du nœud dans le plan du site proposé par le noyau d'Ovidentia
basenode (optionnel)
Racine de la recherche dans le plan du site personnalisé.
saveas (optionnel)
Permet d'enregistrer le résultat de la fonction dans une variable, dans ce cas, le résultat n'est pas affiché


Exemple

<OFSitemapCustomNodeId node="bab_Articles" saveas="CustomNodeId">
<OFSitemapMenu basenode="<OVCustomNodeId>">

OFPreviousArticle

Retourne l'identifiant de l'article précédant l'article spécifié. L'article précédant dépend des paramètres passés à la fonction. Ces paramètres sont similaires à ceux passés au container OCArticles.

Syntaxe

<OFPreviousArticle articleid="" [topicid=""] [excludetopicid=""] [archive=""] [orderby=""] [order=""] [topicorder=""] [delegationid=""]>

Paramètres

articleid
Identifiant de l'article de référence, pour lequel on cherche l'article suivant.
topicid (optionnel)
Permet de spécifier le(s) thème(s) dans lesquels l'article suivant sera recherché.
  • Id du thème ou plusieurs Ids séparés par une virgule
  • Si omis, le container liste les articles tout thème confondu
excludetopicid (optionnel)
Permet de préciser les thèmes d'articles à exclure à la différence du paramètre topicid
  • Id du thème ou plusieurs Ids séparés par une virgule
archive (optionnel)
  • yes : Donne la liste des articles archivés
  • no (par défaut) : Donne la liste des articles non archivés
order (optionnel)
  • asc : Ordonne les articles par ordre croissant en fonction de la date
  • desc (par défaut) : Ordonne les articles par ordre décroissant en fonction de la date
  • rand : Ordonne les articles aléatoirement
orderby (optionnel)
Peut-être couplé avec l'attribut order.
  • creation : Ordonne les articles par ordre de création en fonction de la date
  • publication : Ordonne les articles par ordre de publication en fonction de la date
  • modification (par défaut) : Ordonne les articles par ordre de modification en fonction de la date
topicorder (optionnel)
  • yes : Utilise l'ordre défini par le gestionnaire du thème d'articles
  • no (par défaut) : N'utilise l'ordre défini par le gestionnaire du thème d'articles
delegationid (optionnel)
  • 0 (par défaut) : pas de filtre
  • Id de la délégation.

OFNextArticle

Retourne l'identifiant de l'article suivant l'article spécifié. L'article suivant dépend des paramètres passés à la fonction. Ces paramètres sont similaires à ceux passés au container OCArticles.

Syntaxe

<OFNextArticle articleid="" [topicid=""] [excludetopicid=""] [archive=""] [orderby=""] [order=""] [topicorder=""] [delegationid=""]>

Paramètres

articleid
Identifiant de l'article de référence, pour lequel on cherche l'article suivant.
topicid (optionnel)
Permet de spécifier le(s) thème(s) dans lesquels l'article suivant sera recherché.
  • Id du thème ou plusieurs Ids séparés par une virgule
  • Si omis, le container liste les articles tout thème confondu
excludetopicid (optionnel)
Permet de préciser les thèmes d'articles à exclure à la différence du paramètre topicid
  • Id du thème ou plusieurs Ids séparés par une virgule
archive (optionnel)
  • yes : Donne la liste des articles archivés
  • no (par défaut) : Donne la liste des articles non archivés
order (optionnel)
  • asc : Ordonne les articles par ordre croissant en fonction de la date
  • desc (par défaut) : Ordonne les articles par ordre décroissant en fonction de la date
  • rand : Ordonne les articles aléatoirement
orderby (optionnel)
Peut-être couplé avec l'attribut order.
  • creation : Ordonne les articles par ordre de création en fonction de la date
  • publication : Ordonne les articles par ordre de publication en fonction de la date
  • modification (par défaut) : Ordonne les articles par ordre de modification en fonction de la date
topicorder (optionnel)
  • yes : Utilise l'ordre défini par le gestionnaire du thème d'articles
  • no (par défaut) : N'utilise l'ordre défini par le gestionnaire du thème d'articles
delegationid (optionnel)
  • 0 (par défaut) : pas de filtre
  • Id de la délégation.

OFWebStat

Depuis Ovidentia 7.2.90

Permet d'enregistrer un évènement qui sera comptabilisé dans les statistiques. Ceci est particulièrement utile lors de l'affichage d'articles par OvML afin que ceux-ci soient correctement pris en compte dans les statistiques en tant qu'articles vus.

Syntaxe

<OFWebStat name="" value="">

Paramètres

name
Type d’évènement à enregistrer
  • bab_addon
  • bab_page
  • bab_articles
  • bab_artfiles
  • bab_ovml
  • bab_fmfolders
  • bab_fmfiles
  • bab_forums
  • bab_threads
  • bab_posts
  • bab_faqs
  • bab_faqsqr
  • bab_searchword
  • bab_xlinks
  • bab_dbdirectories
  • bab_ldapdirectories
value
Valeur correspondant au type d'évènement. Par exemple id de l'article pour bab_articles.

Exemple

<OCArticle articleid="<OVarticleid&gt;">
    <!-- Affichage de l'article -->
    <OFWebStat name="bab_articles" value="<OVarticleid&gt;">
</OCArticle>

OFAddStyleSheet

Depuis Ovidentia 7.5.93

Permet d'insérer un fichier CSS dans l'élément <head></head> de la page HTML.

Syntaxe

<OFAddStyleSheet file="">

Paramètres

file
Chemin de la feuille de style relatif au dossier styles du noyau d'Ovidentia


OFGetPath

Depuis Ovidentia 8.2.0

Renvoie un chemin relatif au répertoire racine d'ovidentia.

Syntaxe

<OFGetPath path="" file_relative="1" saveas="">

Paramètres

file_relative
Convertit un chemin relatif au fichier ovml en un chemin relatif au répertoire racine d'ovidentia.


OFGetSelectedSkinPath

Depuis Ovidentia 8.3.0

Renvoie le chemin du répertoire du thème sélectionné.

<OFGetSelectedSkinPath> doit remplacer skins/<OVbabSkin>/ dans les fichiers ovml.

Syntaxe

<OFGetSelectedSkinPath>


OFGetCsrfProtectToken

Depuis Ovidentia 8.4.91

Renvoie l'identifiant de protection contre les attaques CSRF, il doit être ajouté dans tous les formulaire utilisant la méthode POST.

Syntaxe

<input type="hidden" name="babCsrfProtect" value="<OFGetCsrfProtectToken>">


OFGetCurrentAdmGroup

Depuis Ovidentia 8.5.90

Renvoie l'identifiant de la délegation actuellement administré par l'utilisateur courrant.

Syntaxe

<OCDelegationManaged delegationid="<OFGetCurrentAdmGroup>"><OVDelegationName></OCDelegationManaged>

Les containers OvML

La syntaxe des containers est comme suit :

<OCxxxx param1="value" param2="value" ...>...</OCxxxx>

Les containers contiennent des tags OvML et du code HTML. Ce sont généralement des listes de données identiques ou des conditions.

A l'appel d'un container, OvML met à votre disposition des variables <OVxxxx>.

La liste des variables dépend du type de container.

Ces variables ne sont plus disponibles en dehors du container.

A l’intérieur de tout container de type liste, les variables suivantes sont disponibles :

Variable Valeur
OVCIndex Index de l’entrée courante en commençant par 0
OVCCount Le nombre total d’entrées dans le container

Les opérateurs de comparaison

Ces containers permettent d’effectuer des comparaisons entre les valeurs expr1 et expr2.

Si la condition est vrai, le contenu du container est parcouru.

Container Résultat
OCIfEqual Vrai si expr1 est égal à expr2
OCIfNotEqual Vrai si expr1 est différent expr2
OCIfLessThan Vrai si expr1 est strictement inférieur à expr2
OCIfLessThanOrEqual Vrai si expr1 est inférieur ou égal à expr2
OCIfGreaterThan Vrai si expr1 est strictement supérieur à expr2
OCIfGreaterThanOrEqual Vrai si expr1 est supérieur ou égal à expr2

Syntaxe

<OCxxxx expr1="" expr2="">...</OCxxxx>

Paramètres

expr1
Premier terme de la comparaison
expr2
Second terme de la comparaison

Exemple

<OFPutVar name="BAB_SESS_LOGGED">
<OCIfEqual expr1="<BAB_SESS_LOGGED&gt;" expr2="1">
    <p>Vous êtes connecté !</p>
</OCIfEqual>

Les opérateurs de test d'existence sur les variables

Ces containers permettent de vérifier l'existence ou non d'une variable.

Si la variable est définie ou non, selon le container, le container est parcouru.

Container Résultat
OCIfIsSet Vrai si la variable indiquée dans le paramètre name existe
OCIfNotIsSet Vrai si la variable indiquée dans le paramètre name n'existe pas

Syntaxe

<OCxxxx name="">...</OCxxxx>

Paramètres

name
Nom de la variable dont on doit tester l'existence

Exemple

<OCIfIsSet name="variable">
    Ce texte ne sera pas affiché.
</OCIfIsSet>
 
<OFPutVar name="variable" value="1">
<OCIfIsSet name="variable">
    Ce texte sera affiché.
</OCIfIsSet>

OCIfUserMemberOfGroups

Ce container est exécuté si l'utilisateur courant appartient à un groupe

Syntaxe

<OCIfUserMemberOfGroups groupid="" [userid=""] [all=""] [childs=""]>...</OCIfUserMemberOfGroups>

Paramètres

groupid
id du groupe ou plusieurs ids séparés par des virgules
userid (optionnel)
Cette variable permet de tester si un utilisateur spécifique appartient à des groupes en donnant un id utilisateur.
Si omis, elle prend la valeur de l'utilisateur courant.
all (optionnel)
yes : L'utilisateur courant doit appartenir à tous les groupes spécifiés dans groupid
no (par défaut) : L'utilisateur courant doit appartenir à au moins un des groupes spécifiés dans groupid
childs (optionnel)
yes : Pour chaque groupe, inclure ses enfants
no (par défaut) : Les enfants ne sont pas inclus

OCArticlesHomePages

Liste les articles des pages d’accueil privée ou publique.

Syntaxe

<OCArticlesHomePages type="" [order=""] [filter=""] [imageheightmax=""] [imagewidthmax=""]>...</OCArticlesHomePages>

Paramètres

type
private : Liste les articles de la page d’accueil privée
public : Liste les articles de la page d’accueil publique
order (optionnel)
asc (par défaut) : Ordonne les articles par ordre croissant en fonction de la date
desc : Ordonne les articles par ordre décroissant en fonction de la date
rand : Ordonne les articles aléatoirement
filter (optionnel)
yes : Filtre les articles selon le droit de visibilité
no (par défaut) : Ne filtre pas
imageheightmax (optionnel)
Valeur en pixels. Permet de préciser la hauteur maximum de l'image associée.
Si omis, l'image n'est pas redimensionnée et garde sa taille d'origine.
imagewidthmax (optionnel)
Valeur en pixels. Permet de préciser la largeur maximum de l'image associée.
Si omis, l'image n'est pas redimensionnée et garde sa taille d'origine.

Variables

Variable Valeur
OVArticleTitle Titre de l'article
OVArticleHead Introduction de l'article
OVArticleBody Corps de l'article
OVArticleReadMore 0 si l’article n’a pas de corps sinon 1
OVArticleId Id de l'article
OVArticleUrl Url pour atteindre le corps de l'article
OVArticleAuthor Auteur de l'article
OVArticleModifiedBy Utilisateur responsable de la dernière modification
OVArticleDate Date de publication de l'article
OVArticleTopicId Id du thème contenant l'article
OVArticleLanguage Langue de l'article
OVArticleTopicTitle Titre du thème contenant l'article
OVArticleFiles Nombre de fichiers joints
OVArticleEditUrl Url pour accéder à la modification de l'article (penser à ouvre ce lien dans une nouvelle fenêtre ou popup)
OVArticleEditName Nom associé au lien pour accéder à la modification de l'article
OVAssociatedImage 0 si aucune image est associée, 1 si une image est associée
OVImageUrl Url d'affichage de l'image (à utiliser dans une balise img), tient compte des paramètres imageheightmax et imagewidthmax
OVOriginalImageUrl Url d'affichage de l'image (à utiliser dans une balise img), ne tient compte d'aucune variable de hauteur et largeur et renvoi une image sans altération
OVImageWidth Largeur d'origine de l'image
OVImageHeight Hauteur d'origine de l'image
OVResizedImageWidth Largeur de l'image après redimensionnement
OVResizedImageHeight Hauteur de l'image après redimensionnement

OCRecentFiles

Liste les fichiers récemment déposés.

Syntaxe

<OCRecentFiles last="" path="" [folderid=""] [from_lastlog=""] [order=""] [delegationid=""]>...</OCRecentFiles>

Paramètres

last
Nombre de fichiers souhaité
path
Indique dans quel sous-répertoire il faut chercher.
folderid (optionnel)
Id de l’espace ou plusieurs ids séparés par des virgules.
Si omis, le container liste les fichiers récents de tous les répertoires.
from_lastlog (optionnel)
Indique combien de jours avant la dernière connexion de l'utilisateur
0 (par défaut) : depuis sa dernière connexion
order (optionnel)
asc : Ordonne les fichiers par ordre croissant en fonction de la date
desc (par défaut) : Ordonne les fichiers par ordre décroissant en fonction de la date
rand : Ordonne les fichiers aléatoirement
delegationid (optionnel)
Id de la délégation
0 (par défaut) : pas de filtre

Variables

Variable Valeur
OVFileId Id du fichier
OVFileName Nom du fichier
OVFilePath Chemin du fichier
OVFileDescription Description du fichier
OVFileUrl Url pour atteindre la description du fichier
OVFilePopupUrl Url pour afficher la description du fichier dans une fenêtre popup
OVFileUrlGet Url pour télécharger le fichier
OVFileAuthor Auteur du fichier
OVFileModifiedBy Dernière personne ayant modifié le fichier
OVFileDate Date de publication du fichier
OVFileFolderId Id du répertoire contenant le fichier
OVFileDelegationId Id de la délégation dans laquelle le fichier a été créé. Si nul (0), le fichier a été créé en dehors des délégations

OCRecentArticles

Liste les articles récents.

Syntaxe

<OCRecentArticles last="" [topicid=""] [excludetopicid=""] [categoryid=""] [from_lastlog=""] [order=""] [orderby=""] [topicorder=""] [archive=""] [delegationid=""] [imageheightmax=""] [imagewidthmax=""] [minrating=""]>...</OCRecentArticles>

Paramètres

last
Nombre d‘articles souhaité
topicid (optionnel)
Permet de préciser les thèmes d'articles concernés
Id du thème ou plusieurs Ids séparés par une virgule
Si omis, le container liste les articles tous thèmes confondus
excludetopicid (optionnel)
Permet de préciser les thèmes d'articles à exclure à la différence du paramètre topicid
Id du thème ou plusieurs Ids séparés par une virgule
categoryid (optionnel)
Id de la catégorie, tous les thèmes enfants seront utilisés
si categoryid est utilisé, topicid devient obsolète
from_lastlog (optionnel)
Indique combien de jours avant la dernière connexion de l'utilisateur
0 (par défaut) : depuis sa dernière connexion
order (optionnel)
Asc : Ordonne les articles par ordre croissant en fonction de la date
desc (par défaut) : Ordonne les articles par ordre décroissant en fonction de la date
rand : Ordonne les articles aléatoirement
orderby (optionnel)
Peut être couplé avec l'attribut order.
creation : Ordonne les articles par ordre de création en fonction de la date
publication : Ordonne les articles par ordre de publication en fonction de la date
modification (par défaut) : Ordonne les articles par ordre de modification en fonction de la date
rating : Ordonne les articles en fonction de la note moyenne attribuée dans les commentaires
topicorder (optionnel)
yes : Utilise l'ordre défini par le gestionnaire du thème d'articles
no (par défaut) : N'utilise pas l'ordre défini par le gestionnaire du thème d'articles
archive (optionnel)
yes : Donne la liste des articles archivés
no (par défaut) : Donne la liste des articles non archivés
delegationid (optionnel)
Id de la délégation.
0 (par défaut) : pas de filtre
imageheightmax (optionnel)
Valeur en pixels. Permet de préciser la hauteur maximum de l'image associée.
Si omis, l'image n'est pas redimensionnée et garde sa taille d'origine.
imagewidthmax (optionnel)
Valeur en pixels. Permet de préciser la largeur maximum de l'image associée.
Si omis, l'image n'est pas redimensionnée et garde sa taille d'origine.
minrating (optionnel)
Permet de filtrer les articles ayant une note moyenne dans les commentaires supérieure ou égale à la valeur fournie en paramètre
Valeur numérique.

Variables

Variable Valeur
OVArticleTitle Titre de l'article
OVArticleHead Introduction de l'article
OVArticleBody Corps de l'article
OVArticleReadMore 0 si l’article n’a pas de corps sinon 1
OVArticleId Id de l'article
OVArticleUrl Url pour atteindre le corps de l'article
OVArticleAuthor Auteur de l'article
OVArticleModifiedBy Utilisateur responsable de la dernière modification
OVArticleDate Date de publication de l'article
OVArticleDateCreation Date de création de l'article
OVArticleDatePublication Date de publication de l'article (vaut OVArticleDate)
OVArticleDateModification Date de modification de l'article
OVArticleTopicId Id du thème contenant l'article
OVArticleLanguage Langue de l'article
OVArticlePopupUrl Url pour afficher l’article dans une fenêtre popup
OVArticleFiles Nombre de fichiers joints
OVArticleDelegationId Id de la délégation dans laquelle l'article a été créé. Si nul (0), l'article a été créé en dehors des délégations
OVArticleEditUrl Url pour accéder à la modification de l'article (penser à ouvrir ce lien dans une nouvelle fenêtre ou popup)
OVArticleEditName Nom associé au lien pour accéder à la modification de l'article
OVAssociatedImage 0 si aucune image est associée, 1 si une image est associée
OVImageUrl Url d'affichage de l'image (à utiliser dans une balise img), tient compte des paramètres imageheightmax et imagewidthmax
OVOriginalImageUrl Url d'affichage de l'image (à utiliser dans une balise img), ne tient compte d'aucune variable de hauteur et largeur et renvoie une image sans altération
OVImageWidth Largeur d'origine de l'image
OVImageHeight Hauteur d'origine de l'image
OVResizedImageWidth Largeur de l'image après redimensionnement
OVResizedImageHeight Hauteur de l'image après redimensionnement
OVArticleAverageRating Note moyenne décimale de l'article entre 1 et 5 ; 0 si aucune note. Les notes proviennent des commentaires sur l'article
OVArticleNbRating Nombre de votes sur l'article dans les commentaires

OCRecentComments

Liste les derniers commentaires d'articles.

Syntaxe

<OCRecentComments last="" [articleid=""] [from_lastlog=""] [order=""] [delegationid=""]>...</OCRecentComments>

Paramètres

last
Nombre de commentaires souhaité
articleid (optionnel)
Id de l’article ou plusieurs Ids séparés par une virgule
Si omis, le container liste les commentaires tous articles confondus.
from_lastlog (optionnel)
Indique combien de jours avant la dernière connexion de l'utilisateur
0 (par défaut) : depuis sa dernière connexion )
order (optionnel)
asc : Ordonne les commentaires par ordre croissant en fonction de la date
desc (par défaut) : Ordonne les commentaires par ordre décroissant en fonction de la date
rand : Ordonne les commentaires aléatoirement
delegationid (optionnel)
Id de la délégation.
0 (par défaut) : pas de filtre

Variables

Variable Valeur
OVCommentTitle Titre du commentaire
OVCommentText Contenu du commentaire
OVCommentId Id du commentaire
OVCommentTopicId Id du thème contenant l'article contenant le commentaire
OVCommentArticleId Id de l'article contenant le commentaire
OVCommentDate Date du commentaire
OVCommentAuthor Auteur du commentaire
OVCommentUrl Url pour atteindre le commentaire
OVCommentLanguage Langue du commentaire
OVCommentPopupUrl Url pour visualiser le commentaire dans une fenêtre popup

OCRecentThreads

Liste les derniers fils de discussion de forums.

Syntaxe

<OCRecentThreads last="" [forumid=""] [from_lastlog=""] [order=""] [delegationid=""]>...</OCRecentThreads>

Paramètres

last
Nombre de fils de discussion souhaité
forumid (optionnel)
Id du forum ou plusieurs Ids séparés par une virgule
Si omis, le container liste les fils de discussion, tous forums confondus.
from_lastlog (optionnel)
Indique combien de jours avant la dernière connexion de l'utilisateur
0 (par défaut) : depuis sa dernière connexion )
order (optionnel)
Asc : Ordonne les fils de discussion par ordre croissant en fonction de la date
desc (par défaut) : Ordonne les fils de discussion par ordre décroissant en fonction de la date
rand : Ordonne les fils de discussion aléatoirement
delegationid (optionnel)
Id de la délégation.
0 (par défaut) : pas de filtre

Variables

Variable Valeur
OVPostTitle Titre de la contribution
OVPostText Contenu de la contribution
OVPostId Id de la contribution
OVPostThreadId Id du sujet de la contribution
OVPostForumId Id du forum de la contribution
OVPostAuthor Auteur de la contribution
OVPostDate Date de la contribution
OVPostUrl Url pour atteindre la contribution
OVPostPopupUrl Url pour visualiser la contribution dans une fenêtre popup
OVPostDelegationId Id de la délégation dans laquelle le fil a été créé. Si nul (0), le fil a été créé en dehors des délégations

OCRecentPosts

Liste des dernières contributions de forums.

Syntaxe

<OCRecentPosts last="" [forumid=""] [threadid=""] [from_lastlog=""] [order=""] [delegationid=""]>...</OCRecentPosts>

Paramètres

last
Nombre de contributions souhaité
forumid (optionnel)
Id du forum ou plusieurs Ids séparés par une virgule
Si omis, le container liste les dernières contributions tous forums confondus.
threadid (optionnel)
Id du fil de discussion
Si omis, le container liste les dernières contributions tous sujets confondus.
from_lastlog (optionnel)
Indique combien de jours avant la dernière connexion de l'utilisateur
0 (par défaut) : depuis sa dernière connexion
order (optionnel)
asc : Ordonne les contributions par ordre croissant en fonction de la date
desc (par défaut) : Ordonne les contributions par ordre décroissant en fonction de la date
rand : Ordonne les contributions aléatoirement
delegationid (optionnel)
Id de la délégation.
0 (par défaut) : pas de filtre

Variables

Variable Valeur
OVPostTitle Titre de la contribution
OVPostText Contenu de la contribution
OVPostId Id de la contribution
OVPostThreadId Id du sujet de la contribution
OVPostForumId Id du forum de la contribution
OVPostAuthor Auteur de la contribution
OVPostDate Date de la contribution
OVPostUrl Url pour atteindre la contribution
OVPostPopupUrl Url pour visualiser la contribution dans une fenêtre popup
OVPostDelegationId Id de la délégation dans laquelle le fil a été créé. Si nul (0), le fil a été créé en dehors des délégations

OCRecentFaqQuestions

Liste des dernières questions de faqs.

Syntaxe

<OCRecentFaqQuestions last="" [faqid=""] [from_lastlog=""] [faqsubcatid=""] [order=""] [delegationid=""]>...</OCRecentFaqQuestions>

Paramètres

last
Nombre de questions souhaité
faqid (optionnel)
Id de la faq ou plusieurs Ids séparés par une virgule
Si omis, le container liste les dernières questions, toutes faqs confondues
from_lastlog (optionnel)
Indique combien de jours avant la dernière connexion de l'utilisateur
0 (par défaut) : depuis sa dernière connexion
faqsubcatid (optionnel)
Id de la catégorie de faq
order (optionnel)
asc : Ordonne les contributions par ordre croissant en fonction de la date
desc (par défaut) : Ordonne les contributions par ordre décroissant en fonction de la date
delegationid (optionnel)
Id de la délégation.
0 (par défaut) : pas de filtre

Variables

Variable Valeur
OVFaqQuestion Question
OVFaqResponse Réponse
OVFaqQuestionId Id de la question en base de données
OVFaqQuestionUrl Adresse Web pour accéder à la question dans le portail
OVFaqQuestionPopupUrl Adresse Web pour accéder à la question en plein écran (destiné à une vue popup)
OVFaqQuestionDate Date de création de la question
OVFaqQuestionAuthor Auteur de la question

OCArticleCategories

Liste des catégories de sujets.

Syntaxe

<OCArticleCategories [parentid=""] [delegationid=""] [imageheightmax=""] [imagewidthmax=""]>...</OCArticleCategories>

Paramètres

parentid (optionnel)
Id de la catégorie parent ou plusieurs Ids séparés par une virgule
0 (par défaut) : le container liste les catégories de thèmes à la racine.
delegationid (optionnel)
Id de la délégation.
0 (par défaut) : pas de filtre
imageheightmax (optionnel)
Valeur en pixels. Permet de préciser la hauteur maximum de l'image associée.
Si omis, l'image n'est pas redimensionnée et garde sa taille d'origine.
imagewidthmax (optionnel)
Valeur en pixels. Permet de préciser la largeur maximum de l'image associée.
Si omis, l'image n'est pas redimensionnée et garde sa taille d'origine.

Variables

Variable Valeur
OVCategoryName Nom de la catégorie
OVCategoryDescription Description de la catégorie
OVCategoryId Id de la catégorie
OVCategoryParentId Id de la catégorie parent ( 0 si pas de parent )
OVTopicsUrl Url pour atteindre les sujets de la catégorie
OVCategoryDelegationId Id de la délégation dans laquelle la catégorie a été créée. Si nul (0), la catégorie a été créée en dehors des délégations
OVAssociatedImage 0 si aucune image n'est associée, 1 si une image est associée
OVImageUrl Url d'affichage de l'image (à utiliser dans une balise img), tient compte des paramètres imageheightmax et imagewidthmax
OVOriginalImageUrl Url d'affichage de l'image (à utiliser dans une balise img), ne tient compte d'aucune variable de hauteur et largeur et renvoie une image sans altération
OVImageWidth Largeur d'origine de l'image
OVImageHeight Hauteur d'origine de l'image
OVResizedImageWidth Largeur de l'image après redimensionnement
OVResizedImageHeight Hauteur de l'image après redimensionnement

OCArticleCategoryNext

Ce container est valable uniquement dans le container OCArticleCategories. Il permet de récupérer les informations de l’entrée suivante.

Syntaxe

<OCArticleCategoryNext>...</OCArticleCategoryNext>

Variables

Idendiques à celles du container OCArticleCategories.

OCArticleCategoryPrevious

Ce container est valable uniquement dans le container OCArticleCategories. Il permet de récupérer les informations de l’entrée précédente.

Syntaxe

<OCArticleCategoryPrevious>...</OCArticleCategoryPrevious>

Variables

Identiques à celles du container OCArticleCategories.

OCParentsArticleCategory

Liste des catégories de sujets parents.

Syntaxe

<OCParentsArticleCategory categoryid="" [reverse=""] [imageheightmax=""] [imagewidthmax=""]>...</OCParentsArticleCategory>

Paramètres

categoryid
Id de la catégorie.
reverse (optionnel)
1 si on souhaite la liste dans l’ordre inverse.
0 (par défaut) : Les catégories sont triées dans l'ordre
imageheightmax (optionnel)
Valeur en pixels. Permet de préciser la hauteur maximum de l'image associée.
Si omis, l'image n'est pas redimensionnée et garde sa taille d'origine.
imagewidthmax (optionnel)
Valeur en pixels. Permet de préciser la largeur maximum de l'image associée.
Si omis, l'image n'est pas redimensionnée et garde sa taille d'origine.

Variables

Variable Valeur
OVCategoryName Nom de la catégorie
OVCategoryDescription Description de la catégorie
OVCategoryId Id de la catégorie
OVCategoryParentId Id de la catégorie parent ( 0 si pas de parent )
OVTopicsUrl Url pour atteindre les sujets de la catégorie
OVCategoryDelegationId Id de la délégation dans laquelle la catégorie a été créée. Si nul (0), la catégorie a été créée en dehors des délégations
OVAssociatedImage 0 si aucune image n'est associée, 1 si une image est associée
OVImageUrl Url d'affichage de l'image (à utiliser dans une balise img), tient compte des paramètres imageheightmax et imagewidthmax
OVOriginalImageUrl Url d'affichage de l'image (à utiliser dans une balise img), ne tient compte d'aucune variable de hauteur et largeur et renvoie une image sans altération
OVImageWidth Largeur d'origine de l'image
OVImageHeight Hauteur d'origine de l'image
OVResizedImageWidth Largeur de l'image après redimensionnement
OVResizedImageHeight Hauteur de l'image après redimensionnement

OCArticleCategory

Donne les informations sur une ou plusieurs catégorie de sujet.

Syntaxe

<OCArticleCategory categoryid="" [imageheightmax=""] [imagewidthmax=""]>...</OCArticleCategory>

Paramètres

categoryid
Id de la catégorie ou plusieurs Ids séparés par une virgule
imageheightmax (optionnel)
Valeur en pixels. Permet de préciser la hauteur maximum de l'image associée.
Si omis, l'image n'est pas redimensionnée et garde sa taille d'origine.
imagewidthmax (optionnel)
Valeur en pixels. Permet de préciser la largeur maximum de l'image associée.
Si omis, l'image n'est pas redimensionnée et garde sa taille d'origine.

Variables

Variable Valeur
OVCategoryName Nom de la catégorie
OVCategoryDescription Description de la catégorie
OVCategoryId Id de la catégorie
OVCategoryParentId Id de la catégorie parent ( 0 si pas de parent )
OVTopicsUrl Url pour atteindre les sujets de la catégorie
OVCategoryDelegationId Id de la délégation dans laquelle la catégorie a été créée. Si nul (0), la catégorie a été créée en dehors des délégations
OVAssociatedImage 0 si aucune image n'est associée, 1 si une image est associée
OVImageUrl Url d'affichage de l'image (à utiliser dans une balise img), tient compte des paramètres imageheightmax et imagewidthmax
OVImageWidth Largeur d'origine de l'image
OVImageHeight Hauteur d'origine de l'image
OVResizedImageWidth Largeur de l'image après redimensionnement
OVResizedImageHeight Hauteur de l'image après redimensionnement

OCArticleTopics

Liste des thèmes d'articles d'une catégorie donnée.

Syntaxe

<OCArticleTopics categoryid="" [delegationid=""] [imageheightmax=""] [imagewidthmax=""]>...</OCArticleTopics>

Paramètres

categoryid
Id de la catégorie ou plusieurs Ids séparés par une virgule
delegationid (optionnel)
0 (par défaut) : pas de filtre
Id de la délégation.
imageheightmax (optionnel)
Valeur en pixels. Permet de préciser la hauteur maximum de l'image associée.
Si omis, l'image n'est pas redimensionnée et garde sa taille d'origine.
imagewidthmax (optionnel)
Valeur en pixels. Permet de préciser la largeur maximum de l'image associée.
Si omis, l'image n'est pas redimensionnée et garde sa taille d'origine.

Variables

Variable Valeur
OVTopicName Nom du thème d'articles
OVTopicDescription Description du thème d'articles
OVTopicId Id du thème d'article
OVTopicLanguage Langue du thème
OVArticlesListUrl Url pour atteindre la liste des articles
OVTopicCategoryId Id de la catégorie contenant le thème d'articles
OVTopicCategoryTitle Titre de la catégorie contenant le thème d'articles
OVTopicCategoryDelegationId Id de la délégation dans laquelle le thème a été créé. Si nul (0), le thème a été créé en dehors des délégations
OVTopicSubmitUrl Url pour accéder à la création d'un nouvel article dans le thème (prévoir d'afficher le lien dans une nouvelle fenêtre ou une popup). La variable est vide si l'utilisateur n'a pas le droit de créer un article dans le thème.
OVTopicSubmitName Nom associé au lien pour accéder à la création d'un nouvel article. La variable est vide si l'utilisateur n'a pas le droit de créer un article dans le thème.
OVTopicManageUrl Url pour accéder à la gestion des articles du thème (prévoir d'afficher le lien dans une nouvelle fenêtre ou une popup). La variable est vide si l'utilisateur n'a pas le droit de gérer les articles du thème.
OVTopicManageName Nom associé au lien pour accéder à la gestion des articles. La variable est vide si l'utilisateur n'a pas le droit de gérer les articles du thème.
OVAssociatedImage 0 si aucune image n'est associée, 1 si une image est associée
OVImageUrl Url d'affichage de l'image (à utiliser dans une balise img), tient compte des paramètres imageheightmax et imagewidthmax
OVOriginalImageUrl Url d'affichage de l'image (à utiliser dans une balise img), ne tient compte d'aucune variable de hauteur et largeur et renvoie une image sans altération
OVImageWidth Largeur d'origine de l'image
OVImageHeight Hauteur d'origine de l'image
OVResizedImageWidth Largeur de l'image après redimensionnement
OVResizedImageHeight Hauteur de l'image après redimensionnement

OCArticleTopicNext

Ce container est valable uniquement dans le container OCArticleTopics. Il permet de récupérer les informations de l’entrée suivante.

Syntaxe

<OCArticleTopicNext>...</OCArticleTopicNext>

Variables

Identiques à celles du container OCArticleTopics.

OCArticleTopicPrevious

Ce container est valable uniquement dans le container OCArticleTopics. Il permet de récupérer les informations de l’entrée précédente.

Syntaxe

<OCArticleTopicPrevious>....</OCArticleTopicPrevious>

Variables

Idem que ceux du container OCArticleTopics.

OCArticleTopic

Description d’un thème d'articles donné.

Syntaxe

<OCArticleTopic [topicid=""] [topicname=""] [imageheightmax=""] [imagewidthmax=""]>...</OCArticleTopic>

Paramètres

topicid (optionnel)
Id du thème d’articles ou plusieurs Ids séparés par une virgule
Si omis, le container liste tous les thèmes d’articles.
topicname (optionnel)
Nom du thème d’articles
Si omis, le container liste tous les thèmes d’articles ou s'appuie sur le paramètre topicid.
imageheightmax (optionnel)
Valeur en pixels. Permet de préciser la hauteur maximum de l'image associée.
Si omis, l'image n'est pas redimensionnée et garde sa taille d'origine.
imagewidthmax (optionnel)
Valeur en pixels. Permet de préciser la largeur maximum de l'image associée.
Si omis, l'image n'est pas redimensionnée et garde sa taille d'origine.

Variables

Variable Valeur
OVTopicName Nom du thème d'articles
OVTopicDescription Description du thème d'articles
OVTopicId Id du thème d'article
OVTopicLanguage Langue du thème
OVArticlesListUrl Url pour atteindre la liste des articles
OVTopicCategoryId Id de la catégorie contenant le thème d'articles
OVTopicCategoryTitle Titre de la catégorie contenant le thème d'articles
OVTopicCategoryDelegationId Id de la délégation dans laquelle le thème a été créé. Si nul (0), le thème a été créé en dehors des délégations
OVTopicSubmitUrl Url pour accéder à la création d'un nouvel article dans le thème (prévoir d'afficher le lien dans une nouvelle fenêtre ou une popup)
OVTopicSubmitName Nom associé au lien pour accéder à la création d'un nouvel article
OVTopicManageUrl Url pour accéder à la gestion des articles du thème (prévoir d'afficher le lien dans une nouvelle fenêtre ou une popup)
OVTopicManageName Nom associé au lien pour accéder à la gestion des articles
OVAssociatedImage 0 si aucune image est associée, 1 si une image est associée
OVImageUrl Url d'affichage de l'image (à utiliser dans une balise img), tient compte des paramètres imageheightmax et imagewidthmax
OVOriginalImageUrl Url d'affichage de l'image (à utiliser dans une balise img), ne tient compte d'aucune variable de hauteur et largeur et renvoie une image sans altération
OVImageWidth Largeur d'origine de l'image
OVImageHeight Hauteur d'origine de l'image
OVResizedImageWidth Largeur de l'image après redimensionnement
OVResizedImageHeight Hauteur de l'image après redimensionnement

Exemples

<OCArticleTopic topicname="essai">...</OCArticleTopic>

Recherche tous les thèmes dont l'utilisateur a le droit et ayant pour nom "essai"

<OCArticleTopic topicid="1,2,3" topicname="essai">...</OCArticleTopic>

Recherche les thèmes d'id 1,2 3 ayant pour nom essai.

<OCArticleTopic topicid="1,2,3" topicname="%essai">...</OCArticleTopic>

Recherche les thèmes d'id 1,2 3 et dont le nom se termine par essai

<OCArticleTopic topicid="1,2,3" topicname="essai%">...</OCArticleTopic>

Recherche les thèmes d'id 1,2 3 et dont le nom commence par essai

<OCArticleTopic topicid="1,2,3" topicname="%essai%">...</OCArticleTopic>

Recherche les thèmes d'id 1,2 3 et dont le nom contient la chaîne essai

OCArticles

Liste des articles d'un thème d'articles donné.

Syntaxe

<OCArticles [topicid=""] [excludetopicid=""] [archive=""] [offset=""] [rows=""] [order=""] [orderby=""] [topicorder=""] [delegationid=""] [imageheightmax=""] [imagewidthmax=""] [minrating=""]>...</OCArticles>

Paramètres

topicid (optionnel)
Permet de préciser les thèmes d'articles concernés
Id du thème ou plusieurs Ids séparés par une virgule
Si omis, le container liste les articles tout thème confondu
excludetopicid (optionnel)
Permet de préciser les thèmes d'articles à exclure à la différence du paramètre topicid
Id du thème ou plusieurs Ids séparés par une virgule
archive (optionnel)
yes : Donne la liste des articles archivés
no (par défaut) : Donne la liste des articles non archivés
offset (optionnel)
"n" indique le nombre d'articles à ignorer à partir du début de la liste
0 (par défaut) : aucune article n'est ignoré
rows (optionnel)
"n" combien il faut en prendre
-1 (par défaut) : toutes les lignes sont prises
order (optionnel)
asc : Ordonne les articles par ordre croissant en fonction de la date
desc (par défaut) : Ordonne les articles par ordre décroissant en fonction de la date
rand : Ordonne les articles aléatoirement
orderby (optionnel)
Peut être couplé avec l'attribut order.
creation : Ordonne les articles par ordre de création en fonction de la date
publication : Ordonne les articles par ordre de publication en fonction de la date
modification (par défaut) : Ordonne les articles par ordre de modification en fonction de la date
rating : Ordonne les articles en fonction de la note moyenne attribuée dans les commentaires
topicorder (optionnel)
yes : Utilise l'ordre défini par le gestionnaire du thème d'articles
no (par défaut) : N'utilise pas l'ordre défini par le gestionnaire du thème d'articles
delegationid (optionnel)
0 (par défaut) : pas de filtre
Id de la délégation.
imageheightmax (optionnel)
Valeur en pixels. Permet de préciser la hauteur maximum de l'image associée.
Si omis, l'image n'est pas redimensionnée et garde sa taille d'origine.
imagewidthmax (optionnel)
Valeur en pixels. Permet de préciser la largeur maximum de l'image associée.
Si omis, l'image n'est pas redimensionnée et garde sa taille d'origine.
minrating (optionnel)
Permet de filtrer les articles ayant une note moyenne dans les commentaires supérieure ou égale à la valeur fournie en paramètre
Valeur numérique.

Variables

Variable Valeur
OVArticleTitle Titre de l'article
OVArticleHead Introduction de l'article
OVArticleBody Corps de l'article
OVArticleReadMore 0 si l’article n’a pas de corps sinon 1
OVArticleId Id de l'article
OVArticleUrl Url pour atteindre le corps de l'article
OVArticleAuthor Auteur de l'article
OVArticleModifiedBy Utilisateur responsable de la dernière modification
OVArticleDate Date de publication de l'article
OVArticleDateCreation Date de création de l'article
OVArticleDatePublication Date de publication de l'article (vaut OVArticleDate)
OVArticleDateModification Date de modification de l'article
OVArticleTopicId Id du thème contenant l'article
OVArticleLanguage Langue de l'article
OVArticlePopupUrl Url pour afficher l’article dans une fenêtre popup
OVArticleFiles Nombre de fichiers joints
OVArticleEditUrl Url pour accéder à la modification de l'article (penser à ouvre ce lien dans une nouvelle fenêtre ou popup)
OVArticleEditName Nom associé au lien pour accéder à la modification de l'article
OVAssociatedImage 0 si aucune image est associée, 1 si une image est associée
OVImageUrl Url d'affichage de l'image (à utiliser dans une balise img), tient compte des paramètres imageheightmax et imagewidthmax
OVOriginalImageUrl Url d'affichage de l'image (à utiliser dans une balise img), ne tient compte d'aucune variable de hauteur et largeur et renvoie une image sans altération
OVImageWidth Largeur d'origine de l'image
OVImageHeight Hauteur d'origine de l'image
OVResizedImageWidth Largeur de l'image après redimensionnement
OVResizedImageHeight Hauteur de l'image après redimensionnement
OVArticleAverageRating Note moyenne décimale de l'article entre 1 et 5 ; 0 si aucune note. Les notes proviennent des commentaires sur l'article
OVArticleNbRating Nombre de votes sur l'article dans les commentaires

OCArticleNext

Ce container est valable uniquement dans le container OCArticles. Il permet de récupérer les informations de l’entrée suivante.

Syntaxe

<OCArticleNext>...</OCArticleNext>

Variables

Identiques à celles du container OCArticles.

OCArticlePrevious

Ce container est valable uniquement dans le container OCArticles. Il permet de récupérer les informations de l’entrée précédente.

Syntaxe

<OCArticlePrevious>...</OCArticlePrevious>

Variables

Identiques à celles du container OCArticles.

OCArticle

Donne les informations sur un article donné.

Syntaxe

<OCArticle articleid="" [imageheightmax=""] [imagewidthmax=""]>...</OCArticle>

Paramètres

articleid
Id de l’article ou plusieurs Ids séparés par une virgule
imageheightmax (optionnel)
Valeur en pixels. Permet de préciser la hauteur maximum de l'image associée.
Si omis, l'image n'est pas redimensionnée et garde sa taille d'origine.
imagewidthmax (optionnel)
Valeur en pixels. Permet de préciser la largeur maximum de l'image associée.
Si omis, l'image n'est pas redimensionnée et garde sa taille d'origine.

Variables

Variable Valeur
OVArticleTitle Titre de l'article
OVArticleHead Introduction de l'article
OVArticleBody Corps de l'article
OVArticleReadMore 0 si l’article n’a pas de corps sinon 1
OVArticleId Id de l'article
OVArticleUrl Url pour atteindre le corps de l'article
OVArticleAuthor Auteur de l'article
OVArticleModifiedBy Utilisateur responsable de la dernière modification
OVArticleDate Date de publication de l'article
OVArticleDateCreation Date de création de l'article
OVArticleDatePublication Date de publication de l'article (vaut OVArticleDate)
OVArticleDateModification Date de modification de l'article
OVArticleTopicId Id du thème contenant l'article
OVArticleLanguage Langue de l'article
OVArticlePopupUrl Url pour afficher l’article dans une fenêtre popup
OVArticleFiles Nombre de fichiers joints
OVArticleEditUrl Url pour accéder à la modification de l'article (penser à ouvre ce lien dans une nouvelle fenêtre ou popup)
OVArticleEditName Nom associé au lien pour accéder à la modification de l'article
OVAssociatedImage 0 si aucune image est associée, 1 si une image est associée
OVImageUrl Url d'affichage de l'image (à utiliser dans une balise img), tient compte des paramètres imageheightmax et imagewidthmax
OVOriginalImageUrl Url d'affichage de l'image (à utiliser dans une balise img), ne tient compte d'aucune variable de hauteur et largeur et renvoie une image sans altération
OVImageWidth Largeur d'origine de l'image
OVImageHeight Hauteur d'origine de l'image
OVResizedImageWidth Largeur de l'image après redimensionnement
OVResizedImageHeight Hauteur de l'image après redimensionnement
OVArticleAverageRating Note moyenne décimale de l'article entre 1 et 5 ; 0 si aucune note. Les notes proviennent des commentaires sur l'article
OVArticleNbRating Nombre de votes sur l'article dans les commentaires

OCArticleFiles

Donne les informations sur les fichiers joints à un article donné.

Syntaxe

<OCArticleFiles articleid="">...</OCArticleFiles>

Paramètres

articleid
Id de l’article ou plusieurs Ids séparés par une virgule

Variables

Variable Valeur
OVArticleFileName Nom du fichier
OVArticleFileDescription Description du fichier
OVArticleFileUrlGet Url pour atteindre le fichier

OCForums

Liste des forums.

Syntaxe

<OCForums [forumid=""] [delegationid=""]>...</OCForums>

Paramètres

forumid (optionnel)
Id du forum ou plusieurs Ids séparés par une virgule
Si omis, le container liste tous les forums.
delegationid (optionnel)
0 (par défaut) : pas de filtre
Id de la délégation.

Variables

Variable Valeur
OVForumName Nom du forum
OVForumDescription Description du forum
OVForumId Id du forum
OVForumUrl Url pour atteindre le forum
OVForumDelegationId Id de la délégation dans laquelle le forum a été créé. Si nul (0), le forum a été créé en dehors des délégations

OCForumNext

Ce container est valable uniquement dans le container OCForums. Il permet de récupérer les informations de l’entrée suivante.

Syntaxe

<OCForumNext>...</OCForumNext>

Variables

Identiques à celles du container OCForums.

OCForumPrevious

Ce container est valable uniquement dans le container OCForums. Il permet de récupérer les informations de l’entrée précédente.

Syntaxe

<OCForumPrevious>...</OCForumPrevious>

Variables

Identiques à celles du container OCForums.

OCForum

Donne les informations sur un forum donné.

Syntaxe

<OCForum forumid="">...</OCForum>

Paramètres

forumid 
Id du forum

Variables

Variable Valeur
OVForumName Nom du forum
OVForumDescription Description du forum
OVForumId Id du forum
OVForumUrl Url pour atteindre le forum
OVForumDelegationId Id de la délégation dans laquelle le forum a été créé. Si nul (0), le forum a été créé en dehors des délégations

OCThread

Donne les informations sur un fil de discussion donné.

Syntaxe

<OCThread threadid="" [order=""]>...</OCThread>

Paramètres

threadid
Id du forum
order (optionnel)
asc : Ordonne les fils de discussion par ordre croissant en fonction de la date
desc (par défaut) : Ordonne les fils de discussion par ordre décroissant en fonction de la date
rand : Ordonne les fils de discussion aléatoirement

Variables

Variable Valeur
OVThreadForumId Id du forum contenant le fil de discussion
OVThreadId Id du sujet du fil de discussion
OVThreadPostId Id de la contribution initiale
OVThreadLastPostId Id de la dernière contribution
OVThreadDate Date de la création du fil de discussion
OVThreadStarter Nom du l'initiateur du sujet
OVThreadStarterId ID de l'utilisateur ayant initié le sujet ( peut être égal à 0 s'il s'agit d'un utilisateur anonyme)
OVThreadUrl Url pour atteindre la contribution

OCPost

Donne les informations sur une contribution donnée ou plusieurs séparées par des virgules.

Syntaxe

<OCPost postid="" [order=""]>...</OCPost>

Paramètres

postid 
Id de la contribution ou plusieurs Ids séparés par des virgules
order (optionnel)
asc : Ordonne les commentaires par ordre croissant en fonction de la date
desc (par défaut) : Ordonne les commentaires par ordre décroissant en fonction de la date
rand : Ordonne les commentaires aléatoirement

Variables

Variable Valeur
OVPostTitle Titre de la contribution
OVPostText Contenu de la contribution
OVPostId Id de la contribution
OVPostThreadId Id du fil de la discussion
OVPostForumId Id du forum
OVPostAuthor Auteur de la contribution
OVPostAuthorId ID de l'auteur (peut être égal à 0 si l'auteur était un utilisateur anoyme)
OVPostDate Date de la contribution
OVPostUrl Url pour atteindre la contribution
OVPostPopupUrl Url pour visualiser la contribution à l'aide d'une fenêtre popup
OVPostReplyUrl Url pour répondre (sinon vide si pas de droit)
OVPostModifyUrl Url pour modifier (sinon vide si pas de droit)
OVPostConfirmUrl Url pour confirmer (sinon vide si pas de droit)
OVPostDeleteUrl Url pour supprimer la contribution (sinon vide si pas de droit)

OCPostFiles

Donne les informations de fichiers sur une contribution donnée.

Syntaxe

<OCPostFiles postid="">...</OCPost>

Paramètres

postid
Id de la contribution

Variables

Variable Valeur
OVPostFileName Nom du fichier
OVPostFileUrlGet Url pour atteindre le fichier

OCFolders

Liste les répertoires partageables.

Syntaxe

<OCFolders [folderid=""] [delegationid=""]>...</OCFolders>

Paramètres

folderid (optionnel)
Id du répertoire ou plusieurs Ids séparés par une virgule
Si omis, le container liste tous les répertoires partageables.
delegationid (optionnel)
0 (par défaut) : pas de filtre
Id de la délégation.

Variables

Variable Valeur
OVFolderName Nom du répertoire
OVFolderId Id du répertoire
OVFolderDelegationId Id de la délégation dans laquelle le répertoire a été créé. Si nul (0), le répertoire a été créé en dehors des délégations
OVFolderPath Chemin du répertoire à partir du répertoire racine (sans le nom du répertoire courant)
OVFolderPathname Chemin du répertoire à partir du répertoire racine (avec le nom du répertoire courant)
OVFolderBrowseUrl Url d'accès au répertoire dans l'interface du gestionnaire de fichiers

OCFolderNext

Ce container est valable uniquement dans le container OCFolders. Il permet de récupérer les informations de l’entrée suivante.

Syntaxe

<OCFolderNext>...</OCFolderNext>

Variables

Identique à celles du container OCFolders.

OCFolderPrevious

Ce container est valable uniquement dans le container OCFolders. Il permet de récupérer les informations de l’entrée précédente.

Syntaxe

<OCFolderPrevious>...</OCFolderPrevious>

Variables

Identique à celles du container OCFolders.

OCFolder

Donne les information sur un répertoire partageable donné.

Syntaxe

<OCFolder folderid="">...</OCFolder>

Paramètres

folderid
Id du répertoire

Variables

Variable Valeur
OVFolderName Nom du répertoire
OVFolderId Id du répertoire
OVFolderDelegationId Id de la délégation dans laquelle le répertoire a été créé. Si nul (0), le répertoire a été créé en dehors des délégations
OVFolderPath Chemin du répertoire à partir du répertoire racine (sans le nom du répertoire courant)
OVFolderPathname Chemin du répertoire à partir du répertoire racine (avec le nom du répertoire courant)
OVFolderBrowseUrl Url d'accès au répertoire dans l'interface du gestionnaire de fichiers

OCSubFolders

Liste les sous-répertoires du répertoire path d'un répertoire partageable donné.

Syntaxe

<OCSubFolders folderid="" [path=""] [order=""]>...</OCSubFolders>

Paramètres

folderid
Id du répertoire
path (optionnel)
Chemin du répertoire par rapport au répertoire partageable
Si omis, le container liste les sous-répertoire du répertoire partageable
order (optionnel)
asc (par défaut) : ordonne par ordre croissant
desc : ordonne par ordre décroissant

Variables

Variable Valeur
OVSubFolderName Nom du sous répertoire
OVSubFolderPath Chemin du répertoire à partir du répertoire racine (sans le nom du répertoire courant)
OVSubFolderPathname Chemin du répertoire à partir du répertoire racine (avec le nom du répertoire courant)
OVSubFolderBrowseUrl Url d'accès au répertoire dans l'interface du gestionnaire de fichiers

OCFiles

Donne la liste des fichiers d'un répertoire partageable donné.

Remarque : le paramètre inl=1 peut être ajouté à l'url de téléchargement du fichier afin d'ouvrir le fichier en utilisant les plugins du navigateur (Microsoft Word, Adobe Acrobat...) :

Exemple :

<a href="<OVFileUrl&gt;&inl=1"><OVFileName></a>

Syntaxe

<OCFiles folderid="" rows="" offset="" [path=""] [orderby=""] [order=""]>...</OCFiles>

Paramètres

folderid
Id du répertoire
offset
"n" indique le nième fichier à partir du début de la liste
rows
"n" combien il faut en prendre
path (optionnel)
Chemin du répertoire par rapport au répertoire partageable
Si omis, le container liste les fichiers du répertoire partageable
order (optionnel)
Depuis Ovidentia 8.0.91
En lien avec l'attribut orderby.
  • asc (par défaut) : Ordonne les fichiers par ordre croissant
  • desc : Ordonne les fichiers par ordre décroissant
orderby (optionnel)
Depuis Ovidentia 8.0.91
Peut être couplé avec l'attribut order.
  • name (par défaut) : Ordonne les fichiers par nom
  • creation : Ordonne les fichiers par date de création
  • modification : Ordonne les fichiers par date de modification
  • size : Ordonne les fichiers par taille
  • hits : Ordonne les fichiers par nombre de "hits"
  • manual : Ordonne les fichiers suivant l'ordre défini manuellement sur le répertoire.

Variables

Variable Valeur
OVFileName Nom du fichier
OVFileDescription Description du fichier
OVFileKeywords Les mots clés du fichier
OVFileId Id du fichier
OVFileFolderId Id du répertoire
OVFileUrl Url pour atteindre le fichier dans le gestionnaire de fichiers
OVImageUrl Url du fichier si celui-ci est une image (utilisation pour un affichage). Cette variable ne prend pas en compte les droits définis au niveau du gestionnaire de fichiers.
OVFilePopupUrl Url pour afficher le détail du fichier
OVFileUrlGet Url pour télécharger le fichier
OVFileAuthor Nom de l'auteur

OCFileNext

Ce container est valable uniquement dans le container OCFiles. Il permet de récupérer les informations de l’entrée suivante.

Syntaxe

<OCFileNext>...</OCFileNext>

Variables

Identiques à celles du container OCFiles.

OCFilePrevious

Ce container est valable uniquement dans le container OCFiles. Il permet de récupérer les informations de l’entrée précédente.

Syntaxe

<OCFilePrevious>...</OCFilePrevious>

Variables

Identiques à celles du container OCFolders.

OCFile

Donne les informations sur un fichier d'un répertoire partageable donné.

Remarque : le paramètre inl=1 peut être ajouté à l'url de téléchargement du fichier afin d'ouvrir le fichier en utilisant les plugins du navigateur (Microsoft Word, Adobe Acrobat...) :

Exemple :

<a href="<OVFileUrl&gt;&inl=1"><OVFileName></a>

Syntaxe

<OCFile fileid="">...</OCFile>

Paramètres

fileid
Id du fichier

Variables

Variable Valeur
OVFileName Nom du fichier
OVFileDescription Description du fichier
OVFileKeywords Les mots clés du fichier
OVFileId Id du fichier
OVFileFolderId Id du répertoire
OVFileUrl Url pour atteindre le fichier dans le gestionnaire de fichiers
OVFilePopupUrl Url pour afficher le détail du fichier
OVFileUrlGet Url pour télécharger le fichier
OVFileAuthor Nom de l'auteur

OCFileFields

Donne la liste des champs d'un fichier donné.

Syntaxe

<OCFileFields fileid="">...</OCFileFields>

Paramètres

fileid
Id du fichier

Variables

Variable Valeur
OVFileFieldName Nom du champ
OVFileFieldValue Valeur du champ

OCFaqs

Donne la liste des Faqs.

Syntaxe

<OCFaqs [faqid=""] [delegationid=""]>...</OCFaqs>

Paramètres

faqid (optionnel)
Id de la faq ou plusieurs Ids séparés par une virgule
Si omis, le container liste tous Faqs disponibles.
delegationid (optionnel)
0 (par défaut) : pas de filtre
Id de la délégation.

Variables

Variable Valeur
OVFaqName Nom de la Faq
OVFaqDescription Description du la Faq
OVFaqId Id de la Faq
OVFaqUrl Url pour atteindre la Faq
OVFaqLanguage Language de la Faq
OVFaqDelegationId Id de la délégation dans laquelle la faq a été créée. Si nul (0), la faq a été créée en dehors des délégations

OCFaqNext

Ce container est valable uniquement dans le container OCFaqs. Il permet de récupérer les informations de l’entrée suivante.

Syntaxe

<OCFaqNext>...</OCFaqNext>

Variables

Identiques à celles du container OCFaqs.

OCFaqPrevious

Ce container est valable uniquement dans le container OCFaqs. Il permet de récupérer les informations de l’entrée précédente.

Syntaxe

<OCFaqPrevious>...</OCFaqPrevious>

Variables

Identiques à celles du container OCFaqs.

OCFaq

Donne les informations sur une Faq donnée.

Syntaxe

<OCFaq faqid="">...</OCFaq>

Paramètres

faqid
Id de la Faq

Variables

Variable Valeur
OVFaqName Nom de la Faq
OVFaqDescription Description du la Faq
OVFaqId Id de la Faq
OVFaqUrl Url pour atteindre la Faq
OVFaqLanguage Language de la Faq
OVFaqDelegationId Id de la délégation dans laquelle la faq a été créée. Si nul (0), la faq a été créée en dehors des délégations

OCFaqSubCategories

Donne la liste des sous catégories d’une Faq.

Syntaxe

<OCFaqSubCategories faqid="" [delegationid=""]>...</OCFaqSubCategories>

Paramètres

faqid
Id de la faq
delegationid (optionnel)
0 (par défaut) : pas de filtre
Id de la délégation.

Variables

Variable Valeur
OVFaqSubCatName Nom de la sous catégorie
OVFaqSubCatId Id de la sous catégorie
OVFaqId Id de la Faq
OVFaqUrl Url pour atteindre la sous catégorie Faq

OCFaqSubCategory

Donne les informations des sous-catégories d’une faq.

Syntaxe

<OCFaqSubCategory faqsubcatid="">...</OCFaqSubCategory>

Paramètres

faqsubcatid
Id de la sous catégorie ou plusieurs Ids séparés par une virgule

Variables

Variable Valeur
OVFaqSubCatName Nom de la sous catégorie
OVFaqSubCatId Id de la sous catégorie
OVFaqId Id de la Faq
OVFaqUrl Url pour atteindre la sous catégorie Faq

OCFaqQuestions

Donne la liste des questions/réponses d'une faq.

Syntaxe

<OCFaqQuestions [faqid=""] [faqsubcatid=""]>...</OCFaqQuestions>

Paramètres

faqid (optionnel)
Id de la faq ou plusieurs Ids séparés par une virgule
Si omis, le container liste les questions/réponses de toutes les Faqs disponibles.
faqsubcatid (optionnel)
Id de la sous catégorie faq ou plusieurs Ids séparés par une virgule
Si omis, le container liste les questions/réponses de toutes les Faqs indiquées par le paramètre faqid.

Variables

Variable Valeur
OVFaqQuestion Intitulé de la question
OVFaqResponse Texte de la réponse
OVFaqQuestionId Id de la question
OVFaqQuestionUrl Url pour atteindre la question
OVFaqQuestionPopupUrl Url pour visualiser la question/réponse dans une fenêtre popup

OCFaqQuestionNext

Ce container est valable uniquement dans le container OCFaqQuestions. Il permet de récupérer les informations de l’entrée suivante.

Syntaxe

<OCFaqQuestionNext>...</OCFaqQuestionNext>

Variables

Identiques à celles du container OCFaqQuestions.

OCFaqQuestionPrevious

Ce container est valable uniquement dans le container OCFaqQuestions. Il permet de récupérer les informations de l’entrée précédente.

Syntaxe

<OCFaqQuestionPrevious>...</OCFaqQuestionPrevious>

Variables

Identiques à celles du container OCFaqQuestions.

OCFaqQuestion

Donne les informations sur une questions/réponses donnée.

Syntaxe

<OCFaqQuestion questionid="">...</OCFaqQuestion>

Paramètres

questionid
Id de la question/réponse de la Faq

Variables

Variable Valeur
OVFaqQuestion Intitulé de la question
OVFaqResponse Texte de la réponse
OVFaqQuestionId Id de la question
OVFaqQuestionUrl Url pour atteindre la question
OVFaqQuestionPopupUrl Url pour visualiser la question/réponse dans une fenêtre popup

OCWaitingArticles

Liste les articles d'un thème donné en attente d'approbation pour un utilisateur donné.

Syntaxe

<OCWaitingArticles [topicid=""] [userid=""] [delegationid=""] [imageheightmax=""] [imagewidthmax=""]>...</OCWaitingArticles>

Paramètres

topicid (optionnel)
Id du thème ou plusieurs Ids séparés par une virgule
Si omis, le container liste les articles en attente d'approbation tout thème confondu.
userid (optionnel)
Id de l'utilisateur
Si omis, le container liste les articles en attente d'approbation de l'utilisateur courant.
delegationid (optionnel)
0 (par défaut) : pas de filtre
Id de la délégation.
imageheightmax (optionnel)
Valeur en pixels. Permet de préciser la hauteur maximum de l'image associée.
Si omis, l'image n'est pas redimensionnée et garde sa taille d'origine.
imagewidthmax (optionnel)
Valeur en pixels. Permet de préciser la largeur maximum de l'image associée.
Si omis, l'image n'est pas redimensionnée et garde sa taille d'origine.

Variables

Variable Valeur
OVArticleTitle Titre de l'article
OVArticleHead Introduction de l'article
OVArticleBody Corps de l'article
OVArticleReadMore 0 si l’article n’a pas de corps sinon 1
OVArticleId Id de l'article
OVArticleUrl Url pour atteindre le corps de l'article
OVArticleAuthor Auteur de l'article
OVArticleDate Date de publication de l'article
OVArticleTopicId Id du thème contenant l'article
OVArticleLanguage Langue de l'article
OVArticlePopupUrl Url pour afficher l’article dans une fenêtre popup
OVArticleEditUrl Url pour accéder à la modification de l'article (penser à ouvre ce lien dans une nouvelle fenêtre ou popup)
OVArticleEditName Nom associé au lien pour accéder à la modification de l'article
OVAssociatedImage 0 si aucune image est associée, 1 si une image est associée
OVImageUrl Url d'affichage de l'image (à utiliser dans une balise img), tient compte des paramètres imageheightmax et imagewidthmax
OVOriginalImageUrl Url d'affichage de l'image (à utiliser dans une balise img), ne tient compte d'aucune variable de hauteur et largeur et renvoie une image sans altération
OVImageWidth Largeur de l'image après redimensionnement
OVImageHeight Hauteur de l'image après redimensionnement
OVResizedImageWidth Largeur d'origine de l'image
OVResizedImageHeight Hauteur d'origine de l'image

OCWaitingComments

Liste les commentaires en attente d'approbation d'un article donné ( articleid ) pour un utilisateur donné.

Syntaxe

<OCWaitingComments [articleid=""] [userid=""] [delegationid=""]>...</OCWaitingComments>

Paramètres

articleid (optionnel)
Id de l’article ou plusieurs Ids séparés par une virgule
Si omis, le container liste les commentaires en attente de tout article confondu.
userid (optionnel)
Id de l'utilisateur
Si omis, le container liste les commentaires en attente d'approbation de l'utilisateur courant.
delegationid (optionnel)
0 (par défaut) : pas de filtre
Id de la délégation.

Variables

Variable Valeur
OVCommentTitle Titre du commentaire
OVCommentText Contenu du commentaire
OVCommentId Id du commentaire
OVCommentTopicId Id du thème contenant l'article contenant le commentaire
OVCommentArticleId Id de l'article contenant le commentaire
OVCommentDate Date de publication du commentaire
OVCommentAuthor Auteur du commentaire
OVCommentUrl Url pour atteindre le commentaire
OVCommentLanguage Langue du commentaire
OVCommentPopupUrl Url pour visualiser le commentaire dans une fenêtre popup

OCWaitingFiles

Liste les fichiers en attente d'approbation d'un répertoire donné ( articleid ) pour un utilisateur donné.

Syntaxe

<OCWaitingFiles [folderid=""] [userid=""] [delegationid=""]>...</OCWaitingFiles>

Paramètres

folderid (optionnel)
Id du répertoire ou plusieurs Ids séparés par une virgule
Si omis, le container liste les fichiers en attente de tout répertoire confondu.
userid (optionnel)
Id de l'utilisateur
Si omis, le container liste les fichiers en attente d'approbation de l'utilisateur courant.
delegationid (optionnel)
0 (par défaut) : pas de filtre
Id de la délégation.

Variables

Variable Valeur
OVFileId Id du fichier
OVFileName Nom du fichier
OVFilePath Chemin du fichier
OVFileDescription Description du fichier
OVFileUrl Url pour atteindre la description du fichier
OVFilePopupUrl Url pour afficher la description du fichier dans une fenêtre popup
OVFileUrlGet Url pour télécharger le fichier
OVFileAuthor Auteur du fichier
OVFileDate Date de publication du fichier
OVFileFolderId Id du répertoire contenant le fichier

OCWaitingPosts

Liste les contributions en attente d'approbation d'un forum donné ( forumid ) pour un utilisateur donné.

Syntaxe

<OCWaitingPosts [forumid=""] [userid=""] [delegationid=""]>...</OCWaitingPosts>

Paramètres

forumid (optionnel)
Id du forum ou plusieurs Ids séparés par une virgule
Si omis, le container liste les contributions en attente de tout forum confondu.
userid (optionnel)
Id de l'utilisateur
Si omis, le container liste les contributions en attente d'approbation de l'utilisateur courant.
delegationid (optionnel)
0 (par défaut) : pas de filtre
Id de la délégation.

Variables

Variable Valeur
OVPostTitle Titre de la contribution
OVPostText Contenu de la contribution
OVPostId Id de la contribution
OVPostThreadId Id du sujet de la contribution
OVPostForumId Id du forum de la contribution
OVPostAuthor Auteur de la contribution
OVPostDate Date de la contribution
OVPostUrl Url pour visualiser la contribution dans une fenêtre popup
OVPostPopupUrl Langue du commentaire

OCCalendars

Liste les calendriers

Syntaxe

<OCCalendars [type=""] [calendarid=""] [delegationid=""]>...</OCCalendars>

Paramètres

type (optionnel)
Si omis, le container liste tous les agendas. type peut prendre les valeurs suivantes :
user: les agendas personnels
group: les agendas de groupes
resource: les agendas de ressources
calendarid (optionnel)
Un ou plusieurs id d'agendas séparés par des virgules
Si omis, le container liste tous les agendas.
delegationid (optionnel)
0 (par défaut) : pas de filtre
Id de la délégation.

Variables

Variable Valeur
OVCalendarId Id de l’agenda
OVCalendarName Intitulé de l’agenda
OVCalendarDescription Description de l'agenda
OVCalendarOwnerId Id du propriétaire de l’agenda
OVCalendarType Type de l’agenda ( user, group ou resource )
OVCalendarUrl Url pour accéder à la page Agenda

OCCalendarCategories

Liste les catégories d’événements des agendas

Syntaxe

<OCCalendarCategories [filter=""]>...</OCCalendarCategories>

Paramètres

filter (optionnel)
Si filter=«no», ne filtre pas selon les droits de visibilité

Variables

Variable Valeur
OVCalendarCategoryId Id de la catégorie
OVCalendarCategoryName Intitulé de la catégorie
OVCalendarCategoryDescription Description de la catégorie

OCCalendarUserEvents

Liste les événements d’un ou plusieurs agendas personnels

Syntaxe

<OCCalendarUserEvents [calendarid=""] [date=""] [limit=""] [categoryid=""] [filter=""] [holiday=""]>...</OCCalendarUserEvents>

Paramètres

calendarid (optionnel)
Si omis, le container liste les événements de l’agenda personnel de l’utilisateur courant.
date (optionnel)
Si omis, date courante.
Sinon le format de la date doit être aaaa-mm-jj
limit (optionnel)
Si omis, le container liste les événements de la date passée dans le paramètre date
Indique le nombre de jours à traiter avant et après la date date
Format «x,y»: x jours avant la date et y jours après la date
Remarque : si le paramètre date n'est pas précisé, limit="1,1" ramenera les événements à – 24h et + 24h de la date/heure courante
categoryid (optionnel)
Id d’une catégorie ou plusieurs séparés par des virgules.
Dans ce cas, le container ne liste que les événements de ce type de catégories
filter (optionnel)
Si filter=«no», ne filtre pas selon les droits de visibilité.Remarque : si le paramètre est à « no », les événements privés seront aussi remontés
holiday (optionnel)
Si holiday=«no», les jours fériés ne sont pas inclus.
userid (optionnel, déprécié)
Si omis, le container liste les événements de l’agenda personnel de l’utilisateur courant.
Cet attribut n'est plus utilisé depuis la version 6.0.4 d'ovidentia, il est recommandé d'utiliser calendarid

Variables

Variable Valeur
OVEventTitle Intitulé de l’événement
OVEventDescription Description de l’événement
OVEventLocation Lieu de l'événement
OVEventBeginDate Date de début
OVEventEndDate Date de fin
OVEventCategoryId Id de la catégorie de l’événement
OVEventCategoryColor Couleur de la catégorie sous forme de FFFFFF
OVEventCategoryName Nom de la catégorie
OVEventUrl Url pour accéder à l’événement (vide si filter=no)
OVEventCalendarUrl Url pour accéder à l’agenda au jour de l’événement (vide si filter=no)
OVEventCategoriesPopupUrl Url pour afficher les différentes catégories (vide si filter=no)
OVEventOwner Nom du propriétaire de l’agenda

OCCalendarGroupEvents

Liste les événements d’un ou plusieurs agendas collectifs (anciennement agendas de groupes)

Syntaxe

<OCCalendarGroupEvents [calendarid=""] [date=""] [limit=""] [categoryid=""] [filter=""] [delegationid=""] [holiday=""]>...</OCCalendarGroupEvents>

Paramètres

calendarid (optionnel)
Si omis, le container liste les événements de tous les agendas collectifs et de groupes pour lesquels l’utilisateur courant a le droit d’accès.
date (optionnel)
Si omis, date courante.
Sinon le format de la date doit être aaaa-mm-jj
limit (optionnel)
Si omis, le container liste les événements de la date passée dans le paramètre date
Indique le nombre de jours à traiter avant et après la date date
Format «x,y»: x jours avant la date et y jours après la date
Remarque : si le paramètre date n'est pas précisé, limit="1,1" ramenera les événements à – 24h et + 24h de la date/heure courante
categoryid (optionnel)
Id d’une catégorie ou plusieurs séparés par des virgules.
Dans ce cas, le container ne liste que les événements de ce type de catégories
filter (optionnel)
Si filter=«no», ne filtre pas selon les droits de visibilité
delegationid (optionnel)
Si omis ou 0 : pas de filtre
Id de la délégation.
holiday (optionnel)
Si holiday=«no», les jours fériés ne sont pas inclus.
groupid (optionnel, déprécié)
Si omis, le container liste les événements de tous les agendas collectifs et de groupes pour lesquels l’utilisateur courant a le droit d’accès.
Cet attribut n'est plus utilisé depuis la version 6.0.4 d'ovidentia, il est recommandé d'utiliser calendarid
Remarque : le paramètre groupid correspond à l'identifiant (grpid) de l'agenda lorsqu'on utilise les agendas collectifs.

Variables

Variable Valeur
OVEventTitle Intitulé de l’événement
OVEventDescription Description de l’événement
OVEventLocation Lieu de l'événement
OVEventBeginDate Date de début
OVEventEndDate Date de fin
OVEventCategoryId Id de la catégorie de l’événement
OVEventOwner Nom du propriétaire de l’agenda
OVEventCategoryColor Couleur de la catégorie sous forme de FFFFFF
OVEventCategoryName Nom de la catégorie
OVEventUrl Url pour accéder à l’événement (vide si filter=no)
OVEventCalendarUrl Url pour accéder à l’agenda au jour de l’événement (vide si filter=no)
OVEventCategoriesPopupUrl Url pour afficher les différentes catégories (vide si filter=no)

OCCalendarResourceEvents

Liste les événements d’un ou plusieurs agendas de ressources

Syntaxe

<OCCalendarResourceEvents [calendarid=""] [date=""] [limit=""] [categoryid=""] [filter=""] [delegationid=""] [holiday=""]>...</OCCalendarResourceEvents>

Paramètres

calendarid (optionnel)
Si omis, le container liste les événements de tous les agendas de ressources pour lesquels l’utilisateur courant a le droit d’accès.
date (optionnel)
Si omis, date courante.
Sinon le format de la date doit être aaaa-mm-jj
limit (optionnel)
Si omis, le container liste les événements de la date passée dans le paramètre date
Indique le nombre de jours à traiter avant et après la date date
Format «x,y»: x jours avant la date et y jours après la date
Remarque : si le paramètre date n'est pas précisé, limit="1,1" ramenera les événements à – 24h et + 24h de la date/heure courante
categoryid (optionnel)
Id d’une catégorie ou plusieurs séparées par des virgules.
Dans ce cas, le container ne liste que les événements de ce type de catégories
filter (optionnel)
Si filter=«no», ne filtre pas selon les droits de visibilité
delegationid (optionnel)
Si omis ou 0 : pas de filtre
Id de la délégation.
holiday (optionnel)
Si holiday=«no», les jours fériés ne sont pas inclus.
resourceid (optionnel, déprécié)
Si omis, le container liste les événements de tous les agendas de ressources pour lesquels l’utilisateur courant a le droit d’accès.
Cet attribut n'est plus utilisé depuis la version 6.0.4 d'ovidentia, il est recommandé d'utiliser calendarid

Variables

OVEventTitle Intitulé de l’événement
OVEventDescription Description de l’événement
OVEventLocation Lieu de l'événement
OVEventBeginDate Date de début
OVEventEndDate Date de fin
OVEventCategoryId Id de la catégorie de l’événement
OVEventOwner Nom du propriétaire de l’agenda
OVEventCategoryColor Couleur de la catégorie sous forme de FFFFFF
OVEventCategoryName Nom de la catégorie
OVEventUrl Url pour accéder à l’événement (vide si filter=no)
OVEventCalendarUrl Url pour accéder à l’agenda au jour de l’événement (vide si filter=no)
OVEventCategoriesPopupUrl Url pour afficher les différentes catégories (vide si filter=no)

OCCalendarEvents

Liste les événements d’un ou plusieurs agendas ( personnel, groupes ou de ressources )

Syntaxe

<OCCalendarEvents [calendarid=""] [date=""] [limit=""] [categoryid=""] [filter=""] [delegationid=""] [holiday=""]>...</OCCalendarEvents>

Paramètres

calendarid (optionnel)
Si omis, le container liste les événements de tous les agendas pour lesquels l’utilisateur courant a le droit d’accès.
date (optionnel)
Si omis date courante.
Sinon le format de la date doit être aaaa-mm-jj
limit (optionnel)
Si omis, le container liste les événements de la date passée dans le paramètre date
Indique le nombre de jours à traiter avant et après la date
Format «x,y»: x jours avant la date et y jours après la date
Remarque : si le paramètre date n'est pas précisé, limit="1,1" ramènera les événements à – 24h et + 24h de la date/heure courante
categoryid (optionnel)
Id d’une catégorie ou plusieurs séparés par des virgules.
Dans ce cas le container liste que les événements de ce type de catégories
filter (optionnel)
Si filter=«no», ne filtre pas selon les droits de visibilité
delegationid (optionnel)
Si omis ou 0 : pas de filtre
Id de la délégation.
holiday (optionnel)
Si holiday=«no», les jours fériés ne sont pas inclus.

Variables

OVEventTitle Intitulé de l’événement
OVEventDescription Description de l’événement
OVEventLocation Lieu de l'événement
OVEventBeginDate Date de début
OVEventEndDate Date de fin
OVEventCategoryId Id de la catégorie de l’événement
OVEventCategoryColor Couleur de la catégorie sous forme de FFFFFF
OVEventCategoryName Nom de la catégorie
OVEventUrl Url pour accéder à l’événement (vide si filter=no)
OVEventCalendarUrl Url pour accéder à l’agenda au jour de l’événement (vide si filter=no)
OVEventCalendarId Id numérique de l'agenda principal
OVEventCalendarUrlId Id de l'agenda principal contenant le type, exemple "personal/1"
OVEventCalendarName Nom de l'agenda principal
OVEventCalendarType type de l'agenda principal (exemple: "caldav_personal")
OVEventCategoriesPopupUrl Url pour afficher les différentes catégories (vide si filter=no)

OCDbDirectories

Liste les annuaires de base de données

Syntaxe

<OCDbDirectories [directoryid=""] [delegationid=""] [type=""]>...</OCDbDirectories>

Paramètres

directoryid (optionnel)
Id de l'annuaire ou plusieurs Ids séparés par une virgule
Si omis, le container liste tous les annuaires.
delegationid (optionnel)
Si omis ou 0 : pas de filtre
Id de la délégation.
type (optionnel)
« database » ou « group », si omis, le container liste tous les annuaires.

Variables

Variable Valeur
OVDirectoryName Intitulé de l’annuaire
OVDirectoryDescription Description de l'annuaire
OVDirectoryId Id de l'annuaire
OVDirectoryUrl Url pour accéder à la liste des membres de l'annuaire
OVDirectoryDelegationId Id de la délégation dans laquelle l'annuaire a été créé. Si nul (0), l'annuaire a été créé en dehors des délégations

OCDbDirectory

Liste les informations concernant un annuaire ( base de données )

Syntaxe

<OCDbDirectory directoryid="">...</OCDbDirectory>

Paramètres

directoryid
Id de l'annuaire


Variables

Variable Valeur
OVDirectoryName Intitulé de l’annuaire
OVDirectoryDescription Description de l'annuaire
OVDirectoryId Id de l'annuaire
OVDirectoryUrl Url pour accéder à la liste des membres de l'annuaire
OVDirectoryDelegationId Id de la délégation dans laquelle l'annuaire a été créé. Si nul (0), l'annuaire a été créé en dehors des délégations

OCDbDirectoryFields

Liste les différents champs d'un annuaire ( base de données )

Syntaxe

<OCDbDirectoryFields directoryid="" [all=""]>...</OCDbDirectoryFields>

Paramètres

directoryid
Id de l'annuaire
all (optionnel)
1 : Donne la liste de tous les champs
0 : Donne la liste de champs choisis pour l'affichage lors de la configuration du l'annuaire
Si omis, liste uniquement les champs choisis.

Variables

Variable Valeur
OVDirectoryFieldName Intitulé du champ
OVDirectoryFieldId Identifiant du champ

Le tableau ci-dessous donne la correspondance entre les champs et leurs identifiants :

Champ Identifiant
Surnom cn
Nom sn
Deuxième prénom mn
Prénom givenname
Photo jpegphoto
Adresse de messagerie email
Téléphone (bureau) btel
Tél. mobile mobile
Téléphone (domicile) htel
Télécopie (bureau) bfax
Titre title
Service departmentnumber
Société organisationname
Rue (bureau) bstreetaddress
Ville (bureau) bcity
Code postal (bureau) bpostalcode
Dép/Région (bureau) bstate
Pays (bureau) bcountry
Rue (domicile) hstreetaddress
Ville (domicile) hcity
Code postal (domicile) hpostalcode
Dép/Région (domicile) hstate
Pays (domicile) hcountry
Utilisateur 1 user1
Utilisateur 2 user2
Utilisateur 3 user3

Pour les champs additionnels, les identifiants sont de la forme babdirfXX ou XX est l'id du champ additionnel ( correspondant à fxid dans la liste des champs additionnels de l'annuaire ).

OCDbDirectoryMembers

Liste les membres d'un annuaire ( base de données )

Syntaxe

<OCDbDirectoryMembers directoryid="" [fields=""] [all=""] [orderby=""] [order=""] [like=""]>...</OCDbDirectoryMembers>

Paramètres

directoryid
Id de l'annuaire
all (optionnel)
Ignoré si l'attribut fields est spécifié
1 : Donne tous les champs pour chaque membre
0 : Donne uniquement les champs choisis pour l'affichage lors de la configuration du l'annuaire
Si omis, liste uniquement les champs choisis.
fields (optionnel)
liste des identifiants des champs souhaités séparés par des virgules ( exemple "sn,givenname,email" )
orderby (optionnel)
Identifiant du champ à utiliser pour ordonner la liste
order (optionnel)
asc : ordonne par ordre croissant
desc : ordonne par ordre décroissant
like (optionnel)
Restreint la liste des membres ayant le champ commençant par ce motif ( exemple like="A" )

Variables

Variable Valeur
OVDirectoryMemberId Identifiant du membre dans l'annuaire
OVDirectoryMemberUserId Identifiant du membre dans Ovidentia si l'annuaire est un annuaire des utilisateurs enregistrés.

Cette variable n'est pas fournie dans le cas des autres annuaires

OVDirectoryMemberUrl Url pour accéder à la fiche détaillée du membre
DirectoryMemberEmailUrl Url pour afficher la popup de composition de message
OVxxxxxxName Intitulé du champ ayant pour identifiant xxxxxxx ( ex <OVgivennameName> )
OVxxxxxxValue Contenu du champ ayant pour identifiant xxxxxxx ( ex <OVgivennameValue> )

OCDbDirectoryMemberFields

Ce container n'est valable que dans le contexte du container OCDirectoryMembers

Liste les différents champs pour le membre courant.

Syntaxe

<OCDbDirectoryMemberFields>...</OCDbDirectoryMemberFields>

Variables

Variable Valeur
OVDirectoryFieldName Intitulé du champ
OVDirectoryFieldValue Valeur du champ

OCDbDirectoryEntry

Liste les informations concernant un membre d'un annuaire ( base de données )

Syntaxe

<OCDbDirectoryEntry directoryid="" memberid="" userid="">...</OCDbDirectoryEntry>

Paramètres

directoryid
Id de l'annuaire
memberid
Id du membre dans l'annuaire
userid
Id Ovidentia de l'utilisateur s'il est enregistré
Ignoré si memberid renseigné.

Variables

Variable Valeur
OVDirectoryEntryMemberId Identifiant du membre dans l'annuaire
OVDirectoryEntryUserId Identifiant du membre dans Ovidentia si l'annuaire est un annuaire des utilisateurs enregistrés.

Cette variable n'est pas fournie dans le cas des autres annuaires

OVxxxxxxName Intitulé du champ ayant pour identifiant xxxxxxx ( ex <OVgivennameName> )
OVxxxxxxValue Contenu du champ ayant pour identifiant xxxxxxx ( ex <OVgivennameValue> )
OVDirectoryEntryMemberUrl Url vers la fiche annuaire du membre

OCDbDirectoryEntryFields

Ce container n'est valable que dans le contexte du container OCDirectoryEntry

Liste les différents champs pour le membre courant.

Syntaxe

<OCDbDirectoryEntryFields>...</OCDbDirectoryEntryFields>

Variables

Variable Valeur
OVDirectoryFieldName Intitulé du champ
OVDirectoryFieldValue Valeur du champ

OCDbDirectoryAcl

Liste les utilisateurs ayant des droits sur un annuaire.

Syntaxe

<OCDbDirectoryAcl directoryid="" type="">...</OCDbDirectoryAcl>

Paramètres

directoryid
Id de l'annuaire
type
modify : pour les utilisateurs ayant le droit de modifier une fiche
add : pour les utilisateurs ayant le droit d'ajouter une fiche
view : pour les utilisateurs ayant le droit de consulter l'annuaire

Variables

Variable Valeur
OVUserFullName Nom complet de l'utilisateur
OVUserEmail Adresse email de l'utilisateur
OVUserId Id de l'utilisateur dans la base de données

OCDelegations

Liste les délégations dont fait partie l'utilisateur courant.

Syntaxe

<OCDelegations [delegationid=""] [userid=""] [filter=""] [imageheightmax=""] [imagewidthmax=""]>...</OCDelegations>

Paramètres

delegationid (optionnel)
Id de la délégation ou plusieurs Ids séparés par une virgule
Si omis, le container liste toutes les délégations dont fait partie l'utilisateur.
userid (optionnel)
Id de l'utilisateur
Si omis, le container liste les délégations dont fait partie l'utilisateur courant.
filter (optionnel)
Si yes : le container tient compte des droits d'accès de l'utilisateur
Si no : le container ne tient pas compte des droits d'accès et ramène toutes les délégations créées dans le portail
Si omis, le container tient compte des droits d'accès
imageheightmax (optionnel)
Valeur en pixels. Permet de préciser la hauteur maximum de l'image associée.
Si omis, l'image n'est pas redimensionnée et garde sa taille d'origine.
imagewidthmax (optionnel)
Valeur en pixels. Permet de préciser la largeur maximum de l'image associée.
Si omis, l'image n'est pas redimensionnée et garde sa taille d'origine.

Variables

Variable Valeur
OVDelegationName Intitulé de la délégation
OVDelegationDescription Description de la délégation
OVDelegationColor Couleur associée à la délégation.
OVDelegationId Id de la délégation
OVDelegationGroupId Id du groupe sur lequel porte la délégation
OVDelegationGroupName Nom du groupe
OVDelegationCategoryId Id de la catégorie
OVDelegationCategoryName Nom de la catégorie
OVDelegationCategoryDescription Description de la catégorie
OVDelegationCategoryColor Couleur de la catégorie
OVDelegationImage 0 si aucune image est associée, 1 si une image est associée
OVDelegationImageUrl Url d'affichage de l'image (à utiliser dans une balise img), tient compte des paramètres imageheightmax et imagewidthmax
OVDelegationImageWidth Largeur d'origine de l'image
OVDelegationImageHeight Hauteur d'origine de l'image
OVDelegationResizedImageWidth Largeur de l'image après redimensionnement
OVDelegationResizedImageHeight Hauteur de l'image après redimensionnement

OCDelegation

Liste les informations d'une délégation dont fait partie l'utilisateur courant

Syntaxe

<OCDelegation delegationid="" [userid=""] [imageheightmax=""] [imagewidthmax=""]>...</OCDelegation>

Paramètres

delegationid
Id de la délégation
userid (optionnel)
Id de l'utilisateur
Si omis, le container utilise l'id de l'utilisateur courant.
imageheightmax (optionnel)
Valeur en pixels. Permet de préciser la hauteur maximum de l'image associée.
Si omis, l'image n'est pas redimensionnée et garde sa taille d'origine.
imagewidthmax (optionnel)
Valeur en pixels. Permet de préciser la largeur maximum de l'image associée.
Si omis, l'image n'est pas redimensionnée et garde sa taille d'origine.

Variables

Variable Valeur
OVDelegationName Intitulé de la délégation
OVDelegationDescription Description de la délégation
OVDelegationColor Couleur associée à la délégation.
OVDelegationId Id de la délégation
OVDelegationGroupId Id du groupe sur lequel porte la délégation
OVDelegationGroupName Nom du groupe
OVDelegationCategoryId Id de la catégorie
OVDelegationCategoryName Nom de la catégorie
OVDelegationCategoryDescription Description de la catégorie
OVDelegationCategoryColor Couleur de la catégorie
OVDelegationImage 0 si aucune image est associée, 1 si une image est associée
OVDelegationImageUrl Url d'affichage de l'image (à utiliser dans une balise img), tient compte des paramètres imageheightmax et imagewidthmax
OVDelegationImageWidth Largeur d'origine de l'image
OVDelegationImageHeight Hauteur d'origine de l'image
OVDelegationResizedImageWidth Largeur de l'image après redimensionnement
OVDelegationResizedImageHeight Hauteur de l'image après redimensionnement

OCDelegationsManaged

Liste les délégations dont l'utilisateur courant est administrateur délégué.

Syntaxe

<OCDelegationsManaged [delegationid=""] [userid=""] [imageheightmax=""] [imagewidthmax=""]>....</OCDelegationsManaged>

Paramètres

delegationid (optionnel)
Id de la délégation ou plusieurs Ids séparés par une virgule
Si omis, le container liste toutes les délégations dont fait partie l'utilisateur.
userid (optionnel)
Id de l'utilisateur
Si omis, le container liste les délégations dont l'utilisateur courant est administrateur.
imageheightmax (optionnel)
Valeur en pixels. Permet de préciser la hauteur maximum de l'image associée.
Si omis, l'image n'est pas redimensionnée et garde sa taille d'origine.
imagewidthmax (optionnel)
Valeur en pixels. Permet de préciser la largeur maximum de l'image associée.
Si omis, l'image n'est pas redimensionnée et garde sa taille d'origine.

Variables

Variable Valeur
OVDelegationName Intitulé de la délégation
OVDelegationDescription Description de la délégation
OVDelegationColor Couleur associée à la délégation.
OVDelegationId Id de la délégation
OVDelegationGroupId Id du groupe sur lequel porte la délégation
OVDelegationGroupName Nom du groupe
OVDelegationCategoryId Id de la catégorie
OVDelegationCategoryName Nom de la catégorie
OVDelegationCategoryDescription Description de la catégorie
OVDelegationCategoryColor Couleur de la catégorie
OVDelegationImage 0 si aucune image est associée, 1 si une image est associée
OVDelegationImageUrl Url d'affichage de l'image (à utiliser dans une balise img), tient compte des paramètres imageheightmax et imagewidthmax
OVDelegationImageWidth Largeur d'origine de l'image
OVDelegationImageHeight Hauteur d'origine de l'image
OVDelegationResizedImageWidth Largeur de l'image après redimensionnement
OVDelegationResizedImageHeight Hauteur de l'image après redimensionnement

OCDelegationManaged

Liste les informations d'une délégation dont l'utilisateur courant est administrateur délégué.

Syntaxe

<OCDelegationManaged delegationid="" [userid=""] [imageheightmax=""] [imagewidthmax=""]>...</OCDelegationManaged>

Paramètres

delegationid
Id de la délégation
userid (optionnel)
Id de l'utilisateur
Si omis, le container utilise l'id de l'utilisateur courant.
imageheightmax (optionnel)
Valeur en pixels. Permet de préciser la hauteur maximum de l'image associée.
Si omis, l'image n'est pas redimensionnée et garde sa taille d'origine.
imagewidthmax (optionnel)
Valeur en pixels. Permet de préciser la largeur maximum de l'image associée.
Si omis, l'image n'est pas redimensionnée et garde sa taille d'origine.

Variables

Variable Valeur
OVDelegationName Intitulé de la délégation
OVDelegationDescription Description de la délégation
OVDelegationColor Couleur associée à la délégation.
OVDelegationId Id de la délégation
OVDelegationGroupId Id du groupe sur lequel porte la délégation
OVDelegationGroupName Nom du groupe
OVDelegationCategoryId Id de la catégorie
OVDelegationCategoryName Nom de la catégorie
OVDelegationCategoryDescription Description de la catégorie
OVDelegationCategoryColor Couleur de la catégorie
OVDelegationImage 0 si aucune image est associée, 1 si une image est associée
OVDelegationImageUrl Url d'affichage de l'image (à utiliser dans une balise img), tient compte des paramètres imageheightmax et imagewidthmax
OVDelegationImageWidth Largeur d'origine de l'image
OVDelegationImageHeight Hauteur d'origine de l'image
OVDelegationResizedImageWidth Largeur de l'image après redimensionnement
OVDelegationResizedImageHeight Hauteur de l'image après redimensionnement

OCDelegationItems

Liste les fonctions déléguées aux administrateurs délégués d'une délégation.

Syntaxe

<OCDelegationItems delegationid="">...</OCDelegationItems>

Paramètres

delegationid
Id de la délégation

Variables

Variable Valeur
OVDelegationItemName Intitulé de la fonction
OVDelegationItemValue 1: si la fonction est déléguée, 0 sinon

OCDelegationAdministrators

Retourne la liste des administrateurs délégués d'une délégation.

Syntaxe

<OCDelegationAdministrators delegationid="">...</OCDelegationAdministrators>

Paramètres

delegationid
Id de la délégation

Variables

Variable Valeur
OVDelegationUserId Id de l'administrateur

OCDelegationsCategories

Liste les catégories de délégations.

Syntaxe

<OCDelegationsCategories [categoryid=""]>....</OCDelegationsCategories>

Paramètres

categoryid (optionnel)
Id de la délégation
Si omis, le container liste toutes les catégories

Variables

Variable Valeur
OVDelegationCategoryId Id de la catégorie
OVDelegationCategoryName Nom de la catégorie
OVDelegationCategoryDescription Description de la catégorie
OVDelegationCategoryColor Couleur de la catégorie

OCDelegationsCategory

Liste les informations d'une catégorie de délégations.

Syntaxe

<OCDelegationsCategory [categoryid=""]>...</OCDelegationsCategory>

Paramètres

categoryid
Id de la délégation

Variables

Variable Valeur
OVDelegationCategoryId Id de la catégorie
OVDelegationCategoryName Nom de la catégorie
OVDelegationCategoryDescription Description de la catégorie
OVDelegationCategoryColor Couleur de la catégorie

OCTmSpaces

Liste les espaces de projets du gestionnaire de tâches.

Syntaxe

<OCTmSpaces>...</OCTmSpaces>

Variables

Variable Valeur
OVSpaceId Id de l'espace de projet
OVSpaceName Nom de l'espace de projet
OVSpaceDescription Description de l'espace de projet

OCTmProjects

Liste les projets d'un espace de projets du gestionnaire de tâches.

Syntaxe

<OCTmProjects spaceid="">...</OCTmProjects>

Paramètres

spaceid
Id de l'espace de projets

Variables

Variable Valeur
OVProjectId Id du projet
OVProjectName Nom du projet
OVProjectDescription Description du projet

OCTmTasks

Liste les tâches d'un projet ou des tâches personnelles du gestionnaire de tâches.

Syntaxe

<OCTmTasks [projectid=""] [startdate=""] [enddate=""] [order=""] [orderby=""]>....</OCTmTasks>

Paramètres

projectid (optionnel)
Id du projet.
Si omis, le conteneur renvoie les tâches personnelles de l'utilisateur courant.
startdate (optionnel)
Filtre les tâches dont la date de début est postérieure à cette date.
Le format de la date doit être aaaa-mm-jj
enddate (optionnel)
Filtre les tâches dont la date de fin est antérieure à cette date.
Le format de la date doit être aaaa-mm-jj
order (optionnel)
asc: Ordonne les tâches par ordre croissant en fonction du champs sélectionné par l'attribut "orderby"
desc: Ordonne les tâches par ordre croissant en fonction du champs sélectionné par l'attribut "orderby".
orderby (optionnel)
Peut être couplé avec l'attribut order. La valeur par défault est "TaskNumber".
Cet attribut peur contenir le nom de n'importe laquelle des variables renvoyées sans le préfixe "OV", par exemple "TaskCategoryName" ou "TaskEndDate"

Variables

Variable Valeur
OVTaskId Id de la tâche
OVTaskProjectId Id du projet de la tâche
OVTaskNumber Numéro de la tâche
OVTaskShortDescription Description courte de la tâche
OVTaskStartDate Date de début de la tâche
OVTaskEndDate Date de fin de la tâche
OVTaskCategoryId Id de la catégorie de la tâche
OVTaskCategoryName Nom de la catégorie de la tâche
OVTaskCompletion Niveau d'avancement de la tâche (0-100)
OVTaskOwnerId Id de l'utilisateur propriétaire de la tâche
OVTaskClass Classe de la tâche

OCOrgUserEntities

Liste les entités d'organigrammes pour lesquelles un utilisateur à un rôle.

Syntaxe

<OCOrgUserEntities userId="" [orgChartId=""] [roleType=""]>...</OCOrgUserEntities>

Paramètres

userId
Identifiant (entier) de l'utilisateur.
orgChartId (optionnel)
Identifiant (entier) de l'organigramme.
Si ce paramètre est omis alors c'est l'organigramme par défaut (nommé à l'origine Ovidentia) qui est utilisé.
roleType (optionnel)
Si ce paramètre est omis alors tous les rôles seront utilisés.
Les rôles sont des valeurs de 0 à 3
0 étant les rôles personnalisés
1 étant le rôle supérieur
2 étant le rôle employé
3 étant le rôle membre

Variables

Variable Valeur
OVEntityId Identifiant (entier) de l'entité
OVEntityName Nom de l'entité
OVEntityDescription Description de l'entité

OCOrgPathToEntity

Liste toutes les entités parentes d'une entité d'un organigramme.

<OCOrgPathToEntity entityId="" [order=""] [includeEntity=""]>...</OCOrgPathToEntity>

Paramètres

entityId
Identifiant (entier) de l'entité.
order (optionnel)
Si ce paramètre est omis alors c'est l'ordre ascendant qui est utilisé.
Ordre dans lequel le chemin jusqu'à la racine sera retourné, les valeurs possible sont asc ou desc
includeEntity (optionnel)
Si ce paramètre est omis, alors l'entité ne sera pas incluse dans les résultats.
Les valeurs possibles sont :
0 pour ne pas inclure l'entité (valeur par défaut)
1 pour inclure l'entité

Variables

Variable Valeur
OVEntityId Identifiant (entier) de l'entité
OVEntityName Nom de l'entité
OVEntityDescription Description de l'entité

OCMultipages

Ce container permet de faciliter les calculs réalisés pendant un multi-pages. Ainsi selon le nombre total de résultats et le nombre de résultats à afficher par pages, le container permet de retourner le nombre de pages que contient le multi-pages.

Syntaxe

<OCMultipages total="" maxpages="" perpage="" currentpage="">...</OCMultipages>

Paramètres

total
Nombre total de résultats.
maxpages
Nombre maximum de pages à afficher
perpage
Nombre maximum de résultats à afficher par pages
currentpage
Numéro de la page en cours

Variables

Variable Valeur
OVCurrentPageNumber Numéro de la page courante
OVNextPageNumber Numéro de la page suivante si elle existe, valeur vide sinon
OVPreviousPageNumber Numéro de la page précédente si elle existe, valeur vide sinon
OVTotalPages Nombre total de pages
OVResultFirst Index du premier résultat de la page courante
OVResultLast Index du dernier résultat de la page courante
OVResultsPage Nombre de résultats sur la page courante

OCSitemapEntries

Liste les sous-entrées de navigation d'Ovidentia (Plan du site) d'une entrée parente. Utilisez le module sitemap_editor pour éditer l'arborescence du plan du site. Les éléments personnalisés sont ajoutés sous l'élément nommé Racine (identifiant du noeud : Custom).

Syntaxe

<OCSitemapEntries (node="" | langid="") [sitemap=""] [limit=""]>...</OCSitemapEntries>

Paramètres

node
Identifiant de l'élément parent (noeud du plan du site). Les éléments enfants seront retournés.
Exemple : babUserSection, babUserSectionAddons, babArticles, babFaqs, Custom...
langid
Identifiant multilangue de l'élément parent (noeud du plan du site). Les éléments enfants seront retournés.
peut être utilisé à la place de l'attribut node
sitemap (optionnel)
Identifiant unique du plan du site utilisé, si l'attribut n'est pas renseigné, c'est le plan du site configuré au niveau du site qui sera utilisé.
limit (optionnel)
Permet de limiter le nombre d'éléments renvoyés par le conteneur :
  • S'il y a une seule valeur spécifiée, celle-ci indique le nombre maximum d'élément renvoyés. Ex. limit="5" limite le conteneur au 5 premiers éléments
  • S'il y a 2 valeurs séparées par une virgule, la première valeur indique l'index du premier élément à renvoyer et la deuxième est le nombre maximum d'éléments renvoyés. Ex. limit="5,2" limite le conteneur à 2 éléments à partir du 5ème.

Variables

Variable Valeur
OVSitemapEntryId Identifiant unique de l'entrée (chaîne de caractères)
OVSitemapEntryUrl Adresse Web (url) de l'entrée
OVSitemapEntryText Nom de l'entrée
OVSitemapEntryDescription Description de l'entrée
OVSitemapEntryOnclick Code javascript à exécuter sur l'entrée (événement onclick sur le lien)
OVSitemapEntryFolder Vaut 1 si l'entrée contient d'autres entrées, 0 sinon
OVSitemapEntryPageTitle Titre de la page (pour le référencement)
OVSitemapEntryPageDescription Description de la page (pour le référencement)
OVSitemapEntryPageKeywords Mots-clés de la page (pour le référencement)
OVSitemapEntryClassnames Classes CSS de l'entrée
OVSitemapEntryMenuIgnore Depuis Ovidentia 7.9.0

Vaut 1 si l'entrée a été marquée comme ne devant pas apparaître dans les menus de navigation, chaîne vide sinon.

OVSitemapEntryBreadCrumbIgnore Depuis Ovidentia 7.9.0

Vaut 1 si l'entrée a été marquée comme ne devant pas apparaître dans le fil d'ariane, chaîne vide sinon.

OVSitemapEntryTarget Depuis Ovidentia 8.0.91

Identifiant de l'entrée cible si l'entrée courante est un lien, ou identifiant de l'entrée courante sinon (identique à OVSitemapEntryId dans ce cas)

OCSitemapEntry

Renvoie les information sur une entrée de navigation d'Ovidentia (Plan du site).

Syntaxe

<OCSitemapEntry node="" [sitemap=""]>...</OCSitemapEntry>

Paramètres

node
Identifiant de l'élément (noeud du plan du site).
Exemple : babUserSection, babUserSectionAddons, babArticles, babFaqs, Custom...
sitemap (optionnel)
Identifiant unique du plan du site utilisé, si l'attribut n'est pas renseigné, c'est le plan du site configuré au niveau du site qui sera utilisé.


Variables

Variable Valeur
OVSitemapEntryId Identifiant unique de l'entrée (chaîne de caractères)
OVSitemapEntryUrl Adresse Web (url) de l'entrée
OVSitemapEntryText Nom de l'entrée
OVSitemapEntryDescription Description de l'entrée
OVSitemapEntryOnclick Code javascript à exécuter sur l'entrée (événement onclick sur le lien)
OVSitemapEntryFolder Vaut 1 si l'entrée contient d'autres entrées, 0 sinon
OVSitemapEntryPageTitle Titre de la page (pour le référencement)
OVSitemapEntryPageDescription Description de la page (pour le référencement)
OVSitemapEntryPageKeywords Mots-clés de la page (pour le référencement)
OVSitemapEntryClassnames Classes CSS de l'entrée
OVSitemapEntryMenuIgnore Depuis Ovidentia 7.9.0

Vaut 1 si l'entrée a été marquée comme ne devant pas apparaître dans les menus de navigation, chaîne vide sinon.

OVSitemapEntryBreadCrumbIgnore Depuis Ovidentia 7.9.0

Vaut 1 si l'entrée a été marquée comme ne devant pas apparaître dans le fil d'ariane, chaîne vide sinon.

OVSitemapEntryTarget Depuis Ovidentia 8.0.91

Identifiant de l'entrée cible si l'entrée courante est un lien, ou identifiant de l'entrée courante sinon (identique à OVSitemapEntryId dans ce cas)

OCSitemapCustomNode

Depuis Ovidentia 8.3.95

Retourne la liste des noeuds ayant pour cible l'id spécifié dans l'attribut target

Dans le module sitemap_editor, la valeur à saisir dans l'attribut target est affiché dans l'entête sur la page de visualisation du nœud.

Syntaxe

<OCSitemapCustomNode [sitemap=""] [basenode=""] target="" [limit=""]>...</OCSitemapCustomNode>

Paramètres

target
Id du noeud cible
basenode (optionnel)
Identifiant du nœud qui servira de point de départ au chemin. s'il n'est pas renseigné, le noeur racine par défaut sera utilisé (Custom pour le plan du site fourni par sitemap_editor), DGAll pour le plan du site du noyau).
sitemap (optionnel)
Identifiant unique du plan du site utilisé, si l'attribut n'est pas renseigné, c'est le plan du site configuré au niveau du site qui sera utilisé.
limit (optionnel)
permet de limiter le nombre d'éléments retournés, par exemple, limit="0,1" pour obtenir seulement le premier noeud. La syntaxe est identique à l'attribut limit de OCSitemapPath
Variables
Variable Valeur
OVSitemapEntryId Identifiant unique de l'entrée (chaîne de caractères)
OVSitemapEntryUrl Adresse Web (url) de l'entrée
OVSitemapEntryText Nom de l'entrée
OVSitemapEntryDescription Description de l'entrée
OVSitemapEntryOnclick Code javascript à exécuter sur l'entrée (événement onclick sur le lien)
OVSitemapEntryFolder Vaut 1 si l'entrée contient d'autres entrées, 0 sinon
OVSitemapEntryPageTitle Titre de la page (pour le référencement)
OVSitemapEntryPageDescription Description de la page (pour le référencement)
OVSitemapEntryPageKeywords Mots-clés de la page (pour le référencement)
OVSitemapEntryClassnames Classes CSS de l'entrée
OVSitemapEntryMenuIgnore Vaut 1 si l'entrée a été marquée comme ne devant pas apparaître dans les menus de navigation, chaîne vide sinon.
OVSitemapEntryBreadCrumbIgnore Vaut 1 si l'entrée a été marquée comme ne devant pas apparaître dans le fil d'ariane, chaîne vide sinon.
OVSitemapEntryTarget Identifiant de l'entrée cible si l'entrée courante est un lien, ou identifiant de l'entrée courante sinon (identique à OVSitemapEntryId dans ce cas)

OCSitemapPath

Retourne le chemin de fer (rail) d'une entrée de navigation sous la forme d'une liste d'entrées de navigation d'Ovidentia (Plan du site).

Utilisez le module sitemap_editor pour éditer l'arborescence du plan du site. Les éléments personnalisés sont ajoutés sous l'élément nommé Racine (identifiant du noeud : Custom).

Syntaxe

<OCSitemapPath [node=""] [basenode=""] [sitemap=""] [limit=""] [keeplastknown=""]>...</OCSitemapPath>

Paramètres

node (optionnel)
Identifiant de l'élément parent (noeud du plan du site). Les éléments enfants seront retournés.

Exemple : babUserSection, babUserSectionAddons, babArticles, babFaqs, Custom...

basenode (optionnel)
Identifiant du nœud qui servira de point de départ au chemin.
sitemap (optionnel)
Identifiant unique du plan du site utilisé, si l'attribut n'est pas renseigné, c'est le plan du site configuré au niveau du site qui sera utilisé.
limit (optionnel)
Permet de limiter le nombre d'éléments renvoyés par le conteneur :
  • S'il y a une seule valeur spécifiée, celle-ci indique le nombre maximum d'élément renvoyés. Ex. limit="5" limite le conteneur au 5 premiers éléments
  • S'il y a 2 valeurs séparées par une virgule, la première valeur indique l'index du premier élément à renvoyer et la deuxième est le nombre maximum d'éléments renvoyés. Ex. limit="5,2" limite le conteneur à 2 éléments à partir du 5ème. Si la première valeur est négative, l'index du premier élément retourné sera calculé à partir du nombre d'élément total. Ex. limit="-1,1" affiche le dernier élément seulement. L'index négatif est supporté à partir d'ovidentia 8.3.95.
keeplastknown (optionnel)
Si la valeur est "1", le denier noeud du plan du site auquel on a accédé sera mémorisé et récupéré lors de l'accès a une page en dehors du plan du site.
La valeur par défaut est "1".
Variables
Variable Valeur
OVSitemapEntryId Identifiant unique de l'entrée (chaîne de caractères)
OVSitemapEntryUrl Adresse Web (url) de l'entrée
OVSitemapEntryText Nom de l'entrée
OVSitemapEntryDescription Description de l'entrée
OVSitemapEntryOnclick Code javascript à exécuter sur l'entrée (événement onclick sur le lien)
OVSitemapEntryFolder Vaut 1 si l'entrée contient d'autres entrées, 0 sinon
OVSitemapEntryPageTitle Titre de la page (pour le référencement)
OVSitemapEntryPageDescription Description de la page (pour le référencement)
OVSitemapEntryPageKeywords Mots-clés de la page (pour le référencement)
OVSitemapEntryClassnames Classes CSS de l'entrée
OVSitemapEntryMenuIgnore Depuis Ovidentia 7.9.0

Vaut 1 si l'entrée a été marquée comme ne devant pas apparaître dans les menus de navigation, chaîne vide sinon.

OVSitemapEntryBreadCrumbIgnore Depuis Ovidentia 7.9.0

Vaut 1 si l'entrée a été marquée comme ne devant pas apparaître dans le fil d'ariane, chaîne vide sinon.

OVSitemapEntryTarget Depuis Ovidentia 8.0.91

Identifiant de l'entrée cible si l'entrée courante est un lien, ou identifiant de l'entrée courante sinon (identique à OVSitemapEntryId dans ce cas)

Différentes méthodes d’utilisation d’un fichier OvML

Utilisation dans une url

Un fichier OvML peut être appellé en utilisant l’url suivante :


http://url-du-site/index.php?tg=oml&file=fichier-ovml


où fichier-ovml est le nom de votre fichier OvML qui doit se trouver dans le répertoire suivant :


skins/nom-du-skin/ovml


Le fichier ainsi appelé est parsé par Ovidentia et le résultat est affiché dans la partie centrale du portail.


Si l’on souhaite afficher le résultat en dehors du portail, par exemple dans une fenêtre popup, il faut ajouter le paramètre echo=1 comme suit :


http://url-du-site/index.php?tg=oml&file=fichier-ovml&echo=1


De plus, si l’on souhaite passer des paramètres au fichier OvML, on utilisera l’url comme suit :


http://url-du-site/index.php?tg=oml&file=fichier-ovml&echo=1&param=val


Dans ce cas, on peut utiliser la variable OVparam dans le fichier OvML.

Remarque : les paramètres peuvent être envoyés par formulaires en méthodes GET et POST.

Utilisation dans un fichier template

Dans tout fichier template d’Ovidentia, on peut utiliser un fichier OvML en utilisant la syntaxe suivante :


{ $OVML(path/nom-du-fichier-ovml,param1=val1,param2=val2,...) }


où path est le chemin par rapport au répertoire skins/nom-du-skin/ovml (sous-répertoires possibles)

et param1, param2, ... sont des paramètres optionnels passés au fichier OvML


Attention : la syntaxe avec les accolades ne permet pas l'utilisation de nouvelles accolades à l'intérieur.

{ $OVML({ mavariable }) } est impossible.


Remarque :

Il est possible de passer une variable template en tant que paramètre à un fichier OvML via la syntaxe { $OVML(...) } d'un fichier template :


Exemple : { $OVML(monFichier.html,param1="var1") }


si var1 est définie dans le template, le parseur la remplace avec sa valeur, sinon il utilise la valeur "var1".


Optimiser le temps d'exécution d'un script OvML (disponible à partir de la version 7.2 d'Ovidentia) :

Si votre script n'a pas besoin d'être réactualisé à chaque exécution, vous pouvez décider d'utiliser le cache via la syntaxe $OVMLCACHE.

$OVMLCACHE s'utilise dans les mêmes conditions que $OVML.

$OVMLCACHE peut recevoir un paramètre supplémentaire : _ovml_cache_duration=86400. Il permet d'indiquer le temps maximum pendant lequel le script ne sera pas réactualisé. Valeur en secondes.

Si ovml_cache_duration n'est pas renseigné, le script sera réactualisé toutes les 3600 secondes (1 heure).

Remarque : le cache est enregistré dans la session de l'utilisateur courant. Donc le script est systématiquement réactualisé si l'utilisateur se déconnecte.


Exemple :

{ $OVMLCACHE(monFichier.html,param1=3,_ovml_cache_duration=86400) }


Attention : pensez bien aux conséquences d'utilisation du cache OvML avant de l'appliquer sur vos scripts. Pendant 3600 secondes, vous pouvez modifier vos scripts et des données d'Ovidentia sans pouvoir le vérifier à l'affichage !


Autres types de cache possibles :

  • session : cache dans la session (default)
  • sitemap : cache dans un fichier basé sur le profile du plan du site
  • file : cache dans un fichier

Exemple d'utilisation avec un autre type de cache :

$OVMLCACHE(menu.html,_ovml_cache_type=sitemap)

Utilisation dans du contenu

On peut incorporer le résultat d’un fichier OvML dans du contenu Ovidentia ( article, section, faq etc… ). On utilisera la syntaxe suivante :


$OVML(path/nom-du-fichier-ovml,param1=val1,param2=val2,...)


où path est le chemin par rapport au répertoire skins/nom-du-skin/ovml (sous-répertoires possibles)

et param1, param2, ... sont des paramètres optionnels passés au fichier OvML


Utilisation pour les pages d’accueil

On peut utiliser un fichier OvML pour les pages d’accueil privée et publique. Pour cela, utilisez les fichiers spécifiques private.html et public.html.


Lors de l’affichage de la page public, Ovidentia cherche un fichier ayant le nom public.html dans le répertoire skins/nom-du-skin/ovml . S’il le trouve, il l’utilisera pour la page d’accueil public. Sinon, il affichera les articles définis par l'administrateur pour la page d’accueil public.


Il en est de même pour la page d’accueil privée.


Support d'OvML par les modules ( addons )

A partir de la version 5.4.2 d'Ovidentia, il est possible pour les modules de fournir des fonctionnalités basées sur OvML ( voir la documentation fournie avec le module ).

Afin d'utiliser ces fonctionnalités, on utilisera le container suivant :

Syntaxe

<OCAddon name="" param1="" param2="" ...>...</OCAddon>

Paramètres

name
Nom du module
param1
Nom d'un attribut du container du module

Pour la signification des paramètres, il faut consulter la documentation fournie avec le module.

La plupart du temps, le premier paramètre indique le nom du container que l'on veut utiliser et les paramètres suivants sont des attributs à ce container.

Depuis la version 5.6.3, il est aussi possible de créer des fonctions OvML pour un module. La syntaxe d'utilisation de ces fonctions est la suivante :

Syntaxe

<OFAddon name="" function="" param1="" ...>

Paramètres

name
Nom du module
function
Nom de la fonction
param1
Nom d'un attribut de la fonction utilisée

Support d'OvML dans l'éditeur Wysiwyg

L'éditeur Wysiwyg d'Ovidentia possède une option permettant d'utiliser un fichier OvML afin de l'intégrer dans l'affichage d'un article, d'une section... Par défaut, tous les fichiers OvML présents dans le dossier ovml de la skin courante sont affichés dans le formulaire de sélection. Il existe un moyen de cacher ces fichiers aux utilisateurs de l'éditeur en modifiant la racine de sélection des fichiers :

On ajoute un dossier nommé "editor" dans le dossier ovml de la skin courante, l'éditeur Wysiwyg ne proposera alors que les fichiers présents dans ce répertoire.


Remarque :

Il est toujours possible d'utiliser la syntaxe $OVML manuellement afin d'exécuter un fichier OvML ne se situant pas dans le dossier editor.