Référence OvML : Différence entre versions

De OviWiki
Aller à : navigation, rechercher
(→‎Recurse)
(→‎Variables)
 
(336 révisions intermédiaires par 6 utilisateurs non affichées)
Ligne 1 : Ligne 1 :
−
= Introduction =
+
[[Catégorie:Développement de skins]]
 +
= 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.
+
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 …
 
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 …
Ligne 13 : Ligne 14 :
 
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.
 
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.
  
−
On distingue trois types de tags OvML :
+
== Les variables <OVxxxx> ==
  
−
== Les variables <OVxxxx>  ==
+
Une variable OvML est de la forme:
  
−
Une variable OvML est de la fome:
+
<source lang="ovml">
−
 
+
<OVxxxx param1="value" param2="value" ...>
−
<nowiki><OVxxxx param1="value" param2="value" …> </nowiki>
+
</source>
  
 
où xxxx est le nom de la variable.
 
où xxxx est le nom de la variable.
Ligne 27 : Ligne 28 :
 
Toute variable OvML peut être sauvegardée dans une autre variable en utilisant le paramètre saveas (voir ci-dessous).
 
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 <OFxxxx> ==
  
 
Les fonctions se présentent sous la forme :
 
Les fonctions se présentent sous la forme :
  
−
<nowiki><OFxxxx param1="value" param2="value" …> </nowiki>
+
<source lang="ovml">
 +
<OFxxxx param1="value" param2="value" ...>
 +
</source>
  
 
Elles permettent, entre autre, de traduire du texte, de faire des opérations arithmétiques, etc, …
 
Elles permettent, entre autre, de traduire du texte, de faire des opérations arithmétiques, etc, …
Ligne 37 : Ligne 40 :
 
Le résultat de ces fonctions peut être sauvegardé dans une variable OvML en utilisant le paramètre saveas (voir ci-dessus).
 
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> ==
+
== Les containers <OCxxxx> … </OCxxxx> ==
  
 
La syntaxe des containers est comme suit :
 
La syntaxe des containers est comme suit :
  
−
<nowiki><OCxxxx param1="value" param2="value" …>...</OCxxxx> </nowiki>
+
<source lang="ovml">
 +
<OCxxxx param1="value" param2="value" ...>
 +
    ...
 +
</OCxxxx>
 +
</source>
  
 
'''Remarque importante d'utilisation des containers :'''
 
'''Remarque importante d'utilisation des containers :'''
Ligne 49 : Ligne 56 :
 
'''Exemple :'''
 
'''Exemple :'''
  
−
<OCxxxx param1="value" param2="value" monparametre1>
+
<source lang="ovml">
−
    <OCxxxx param1="value" param2="value" monparametre2>
+
<OCxxxx param1="value" param2="value" monparametre1>
−
        ...
+
    <OCxxxx param1="value" param2="value" monparametre2>
−
    </OCxxxx monparametre2>
+
        ...
−
</OCxxxx monparametre1>
+
    </OCxxxx monparametre2>
 +
</OCxxxx monparametre1>
 +
</source>
  
−
* 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.
+
* 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 =
  
−
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&nbsp;:
+
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 :
  
−
<nowiki><OVnom-de-la variable></nowiki>
+
<pre>
 +
<OVnom-de-la-variable>
 +
</pre>
  
 
On peut définir une variable OvML en utilisant la fonction PutVar :
 
On peut définir une variable OvML en utilisant la fonction PutVar :
  
−
<nowiki><OFPutVar name="nbArticles" value="10"></nowiki>
+
<pre>
 +
<OFPutVar name="nbArticles" value="10">
 +
</pre>
  
 
Ceci définit une variable nbArticles initialisée à la valeur 10.
 
Ceci définit une variable nbArticles initialisée à la valeur 10.
Ligne 71 : Ligne 84 :
 
Pour récupérer la valeur dans une page OvML, il faut utiliser la syntaxe suivante :
 
Pour récupérer la valeur dans une page OvML, il faut utiliser la syntaxe suivante :
  
−
<nowiki><OVnbArticles></nowiki>
+
<pre>
 +
<OVnbArticles>
 +
</pre>
  
 
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 :
 
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 :
  
−
<nowiki><OFPutVar name="babSlogan"></nowiki>
+
<pre>
 +
<OFPutVar name="babSlogan">
 +
</pre>
  
−
Maintenant la variable <nowiki><OVbabSlogan></nowiki> existe dans OvML et contient le contenu du slogan du site.
+
Maintenant la variable <code><OVbabSlogan></code> 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.
 
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.
Ligne 88 : Ligne 105 :
 
Il est parfois utile de tester l’existence d’une variable avant de la définir. On utilisera pour cela la fonction '''IfNotIsSet''' :
 
Il est parfois utile de tester l’existence d’une variable avant de la définir. On utilisera pour cela la fonction '''IfNotIsSet''' :
  
−
<nowiki><OFIfNotIsSet name="page" value="1"></nowiki>
+
<pre>
 +
<OFIfNotIsSet name="page" value="1">
 +
</pre>
  
 
Dans ce cas, si la variable page n’est pas définie, elle sera définie avec la valeur initiale 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 <nowiki><OVxxxx></nowiki>.
+
Toutes les variables produites par un container peuvent être jointes en utilisant la syntaxe d’une variable OvML <code><OVxxxx></code>.
  
 
On peut aussi passer des variables OvML à un fichier OvML en utilisant l’url :
 
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
+
http://url-du-site/index.php?tg=oml&file=fichier-ovml&total=1000
  
 
Dans la page OvML on peut donc utiliser la variable totale.
 
Dans la page OvML on peut donc utiliser la variable totale.
Ligne 104 : Ligne 123 :
 
== saveas ==
 
== saveas ==
  
−
Permet de sauvegarder une variable dans une autre :
+
Permet de sauvegarder une variable dans une autre.
  
−
<nowiki><OVnbArticles saveas="TotalArticles"></nowiki>
+
<pre>
 +
<OVnbArticles saveas="TotalArticles">
 +
</pre>
  
 
Une nouvelle variable TotalArticles est créée et sa valeur est la même que celle de nbArticles.
 
Une nouvelle variable TotalArticles est créée et sa valeur est la même que celle de nbArticles.
Ligne 122 : Ligne 143 :
 
|}
 
|}
  
−
<nowiki><OVbabSlogan strlen="100"></nowiki>
+
<pre>
 +
<OVbabSlogan strlen="100">
 +
</pre>
  
 
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 :
 
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 :
  
−
<nowiki><OVbabSlogan strlen="100,..."></nowiki>
+
<pre>
 +
<OVbabSlogan strlen="100,...">
 +
</pre>
  
 
== striptags ==
 
== striptags ==
Ligne 140 : Ligne 165 :
 
|}
 
|}
  
−
<nowiki><OVbabSlogan striptags="1"></nowiki>
+
<pre>
 +
<OVbabSlogan striptags="1">
 +
</pre>
  
 
== htmlentities ==
 
== htmlentities ==
Ligne 149 : Ligne 176 :
 
|-
 
|-
 
| 1
 
| 1
−
| <nowiki>Convertit les entities HTML ( < devient &lt; )</nowiki>
+
| <nowiki>Convertit les entities HTML ( < devient &amp;lt; )</nowiki>
 
|-
 
|-
 
| 2
 
| 2
−
| <nowiki>Convertit en inverse les entities HTML ( &lt; devient < )</nowiki>
+
| <nowiki>Convertit en inverse les entities HTML ( &amp;lt; devient < )</nowiki>
 
|}
 
|}
  
−
<nowiki><OVbabSlogan htmlentities="1"></nowiki>
+
<pre>
 +
<OVbabSlogan htmlentities="1">
 +
</pre>
  
 
== stripslashes ==
 
== stripslashes ==
Ligne 169 : Ligne 198 :
 
|}
 
|}
  
−
<nowiki><OVbabSlogan stripslashes="1"></nowiki>
+
<pre>
 +
<OVbabSlogan stripslashes="1">
 +
</pre>
  
 
== urlencode ==
 
== urlencode ==
Ligne 181 : Ligne 212 :
 
|}
 
|}
  
−
<nowiki><OVbabSlogan urlencode="1"></nowiki>
+
<pre>
 +
<OVbabSlogan urlencode="1">
 +
</pre>
  
 
== jsencode ==
 
== jsencode ==
Ligne 193 : Ligne 226 :
 
|}
 
|}
  
−
<nowiki><OVbabSlogan jsencode="1"></nowiki>
+
<pre>
 +
<OVbabSlogan jsencode="1">
 +
</pre>
  
 
== strcase ==
 
== strcase ==
Ligne 208 : Ligne 243 :
 
|}
 
|}
  
−
<nowiki><OVbabSlogan strcase="upper"></nowiki>
+
<pre>
 +
<OVbabSlogan strcase="upper">
 +
</pre>
  
 
== nlremove ==
 
== nlremove ==
Ligne 220 : Ligne 257 :
 
|}
 
|}
  
−
<nowiki><OVbabSlogan nlremove="1"></nowiki>
+
<pre>
 +
<OVbabSlogan nlremove="1">
 +
</pre>
  
 
== trim ==
 
== trim ==
Ligne 238 : Ligne 277 :
 
|}
 
|}
  
−
<nowiki><OVbabSlogan trim="all"></nowiki>
+
<pre>
 +
<OVbabSlogan trim="all">
 +
</pre>
  
 
== nl2br ==
 
== nl2br ==
Ligne 250 : Ligne 291 :
 
|}
 
|}
  
−
<nowiki><OVbabSlogan nl2br="1"></nowiki>
+
<pre>
 +
<OVbabSlogan nl2br="1">
 +
</pre>
  
 
== sprintf ==
 
== sprintf ==
Ligne 262 : Ligne 305 :
 
|}
 
|}
  
−
<nowiki><OVMoney sprintf="%01.2f"></nowiki>
+
<pre>
 +
<OVMoney sprintf="%01.2f">
 +
</pre>
  
 
== date ==
 
== date ==
Ligne 312 : Ligne 357 :
 
|}
 
|}
  
−
<nowiki><OVArticleDate date="%d %j %m %Y"></nowiki>
+
<pre>
 +
<OVArticleDate date="%d %j %m %Y">
 +
</pre>
  
 
'''Remarque :'''
 
'''Remarque :'''
  
−
<nowiki><OVbabCurrentDate></nowiki> est une variable permettant de récupérer la date courante.
+
<code><OVbabCurrentDate></code> 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.
 
Elle ne doit pas être déclarée par la fonction OFPutVar pour l'utiliser.
  
−
<nowiki><OVbabCurrentDate date="%D %j %M" strcase="lower"></nowiki>
+
<pre>
 +
<OVbabCurrentDate date="%D %j %M" strcase="lower">
 +
</pre>
  
 
== author ==
 
== author ==
Ligne 328 : Ligne 377 :
 
{| class="prettytable"
 
{| class="prettytable"
 
! Value
 
! Value
−
! style="border:0.002cm solid #000000;padding:0.097cm;"|
+
!  
 
|-
 
|-
 
| %F
 
| %F
Ligne 340 : Ligne 389 :
 
|}
 
|}
  
−
<nowiki><OVArticleAuthor author="%F %L" strcase="lower"></nowiki>
+
<pre>
 +
<OVArticleAuthor author="%F %L" strcase="lower">
 +
</pre>
  
 
= Les fonctions OvML =
 
= Les fonctions OvML =
Ligne 346 : Ligne 397 :
 
On reconnaît les fonctions par la syntaxe suivante :
 
On reconnaît les fonctions par la syntaxe suivante :
  
−
<nowiki><OFxxxx ... ></nowiki>
+
<pre>
 +
<OFxxxx ...>
 +
</pre>
  
 
Les fonctions OvML disponibles sont :
 
Les fonctions OvML disponibles sont :
  
−
== Translate ==
+
== 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 <code>string</code> prenant un paramètre <code>id</code> indiquant l'identifiant du texte et contient le texte traduit.
 +
 
 +
'''Extrait du fichier langue pour l'anglais ''lang-en.xml'' :'''
 +
 
 +
<source lang="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>
 +
</pre>
 +
 
 +
'''Extrait du fichier langue pour le français ''lang-fr.xml'' :'''
 +
 
 +
<source lang="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>
 +
</pre>
 +
 
 +
=== Syntaxe ===
 +
 
 +
<pre>
 +
<OFTranslate text="" [lang=""] [folder=""]>
 +
</pre>
  
−
Permet de traduire une chaîne
+
=== Paramètres ===
  
−
<nowiki><OFTranslate text="Bonjour tout le monde" lang="nl-be"></nowiki>
+
; text
 +
: Identifiant du texte à traduire
  
−
Ceci traduit la chaîne en nl-be.
+
; 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
  
−
L’attribut lang est optionnel. Dans ce cas, Ovidentia utilisera la langue choisie par l'utilisateur courant.
+
; folder ''(optionnel)''
 +
: Nom du module
 +
: Si omis, le fichier langue du noyau est utilisé
  
−
== PutVar ==
+
== OFPutVar ==
  
 
Permet de déclarer une nouvelle variable.
 
Permet de déclarer une nouvelle variable.
  
−
<nowiki><OFPutVar name="nom-de-la variable" value="valeur-de-la-variable"></nowiki>
+
=== Syntaxe ===
  
−
L’attribut value est optionnel. Dans ce cas, Ovidentia utilisera la valeur de la variable globale Ovidentia ayant le même nom si elle existe :
+
<pre>
 +
<OFPutVar name="" [value=""]>
 +
</pre>
  
−
<nowiki><OFPutVar name="babSiteName"></nowiki>
+
=== Paramètres ===
  
−
Dans ce cas, <nowiki><OVbabSiteName></nowiki> contient le nom du site Ovidentia.
+
; name
 +
: Nom de la variable
  
−
== GetVar  ==
+
; value ''(optionnel)''
 +
: Valeur à affecter à la variable
  
−
Permet d'utiliser une variable tout comme la syntaxe <nowiki><OVnom-de-la-variable></nowiki>.
+
== OFGetVar ==
  
−
<nowiki><OFGetVar name="nom-de-la variable"></nowiki>
+
Permet d'afficher une variable tout comme la syntaxe <code><OVnom-de-la-variable></code>.
  
−
== IfNotIsSet  ==
+
=== Syntaxe ===
 +
 
 +
<pre>
 +
<OFGetVar name="">
 +
</pre>
 +
 
 +
=== Paramètres ===
 +
 
 +
; name
 +
: Nom de la variable à afficher
 +
 
 +
== OFIfNotIsSet ==
  
 
Permet de sauvegarder une variable si elle n’est pas déjà définie.
 
Permet de sauvegarder une variable si elle n’est pas déjà définie.
  
−
<nowiki><OFIfNotIsSet name="nom-de-la variable" value="valeur-de-la-variable"></nowiki>
+
=== Syntaxe ===
  
−
L’attribut value est optionnel. Dans ce cas, Ovidentia utilisera la valeur de la variable Ovidentia ayant le même nom :
+
<pre>
 +
<OFIfNotIsSet name="" [value=""]>
 +
</pre>
  
−
<nowiki><OFIfNotIsSet name="length" value="100"></nowiki>
+
=== Paramètres ===
  
−
== UrlContent ==
+
; name
 +
: Nom de la variable
 +
 
 +
; value ''(optionnel)''
 +
: Valeur à affecter à la variable
 +
 
 +
== OFInclude ==
 +
 
 +
Permet d'inclure un autre fichier OVML
 +
 
 +
=== Syntaxe ===
 +
 
 +
<pre>
 +
<OFInclude file="" [cache=""]>
 +
</pre>
 +
 
 +
=== 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
 
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
  
−
<nowiki><OFUrlContent url="</nowiki>[http://www.mysite/page.html http://www.mysite/page.html]">
+
=== Syntaxe ===
  
−
== Recurse ==
+
<pre>
 +
<OFUrlContent url="">
 +
</pre>
  
−
La fonction OFRecurse permet d'exécuter un code tant qu'une condition est réalisée. Voici un exemple avec l'affichage de l'arborescence des catégories et thèmes d'articles. Ici, la fonction OFRecurse est utilisée pour relancer le container <nowiki><OCArticleCategories></nowiki> autant de fois que désiré en lui précisant le paramètre parentid (voir container <nowiki><OCArticleCategories></nowiki>).
+
=== Paramètres ===
  
−
Exemple avec une liste :  
+
; url
 +
: url de la page à inclure
  
−
<source lang="ovml">
+
== OFRecurse ==
 +
 
 +
La fonction OFRecurse permet d'exécuter un code tant qu'une condition est réalisée.
 +
 
 +
=== Syntaxe ===
 +
 
 +
<pre>
 +
<OFRecurse>
 +
</pre>
 +
 
 +
=== 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 <code>OFRecurse</code> est utilisée pour relancer le container <code><OCArticleCategories></code> autant de fois que désiré en lui précisant le paramètre parentid (voir container <code><OCArticleCategories></code>).
 +
 
 +
<pre>
 
<ul>
 
<ul>
 
     <OCArticleCategories>
 
     <OCArticleCategories>
Ligne 406 : Ligne 559 :
 
             <OVCategoryName>
 
             <OVCategoryName>
 
             <ul>
 
             <ul>
−
                 <OFRecurse parentid="<OVCategoryId&gt;">
+
                 <OFRecurse parentid="&lt;OVCategoryId&gt;">
−
                 <OCArticleTopics categoryid="<OVCategoryId&gt;">
+
                 <OCArticleTopics categoryid="&lt;OVCategoryId&gt;">
 
                     <li><OVTopicName></li>
 
                     <li><OVTopicName></li>
 
                 </OCArticleTopics>
 
                 </OCArticleTopics>
Ligne 414 : Ligne 567 :
 
     </OCArticleCategories>
 
     </OCArticleCategories>
 
</ul>
 
</ul>
−
</source>
+
</pre>
  
 
== Opérateurs arithmétiques ==
 
== Opérateurs arithmétiques ==
 +
 
Permettent de faire des opérations arithmétiques sur des variables. Elles sont construites de la manière suivante :
 
Permettent de faire des opérations arithmétiques sur des variables. Elles sont construites de la manière suivante :
  
 +
<pre>
 +
<OFAOxxxxx expr1="X" expr2="Y">
 +
</pre>
  
−
<nowiki><OFAOxxxxx expr1="X" expr2="Y"></nowiki>
+
<pre>
 +
<OFAOxxxxx expr1="10" expr2="50">
 +
</pre>
  
 +
Ceci effectue l'opération souhaitée entre 10 et 50.
 +
 +
<pre>
 +
<OFAOxxxxx expr1="<OVTotal&gt;" expr2="50">
 +
</pre>
 +
 +
Ceci effectue l’opération souhaitée entre la valeur de <code>Total</code> et 50.
 +
 +
Toutefois, pour pouvoir stocker cette valeur dans une variable, il faut ajouter le paramètre <code>saveas</code> lors de l'appel de la fonction.
 +
 +
<pre>
 +
<OFAOxxxxx expr1="<OVTotal&gt;" expr2="50" saveas="NewTotal">
 +
</pre>
 +
 +
Ceci définit la variable <code>NewTotal</code> ayant pour valeur le résultat de l'opération souhaitée entre la valeur de <code>Total</code> et 50.
  
 
Les opérateurs disponibles sont :
 
Les opérateurs disponibles sont :
  
 +
=== OFAOAddition ===
 +
 +
Permet d’additionner expr1 et expr2.
 +
 +
==== Syntaxe ====
 +
 +
<pre>
 +
<OFAOAddition expr1="" expr2="">
 +
</pre>
 +
 +
==== Paramètres ====
 +
 +
; expr1
 +
: Premier terme de l'addition
 +
 +
; expr2
 +
: Second terme de l'addition
 +
 +
=== OFAOSubtraction ===
 +
 +
Permet de soustraire expr2 à expr1.
 +
 +
==== Syntaxe ====
 +
 +
<pre>
 +
<OFAOSubtraction expr1="" expr2="">
 +
</pre>
 +
 +
==== Paramètres ====
 +
 +
; expr1
 +
: Premier terme de la soustraction
 +
 +
; expr2
 +
: Second terme de la soustraction
 +
 +
==== Exemple ====
 +
 +
<pre>
 +
<OFAOSubtraction expr1="10" expr2="20">
 +
</pre>
 +
 +
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 ====
 +
 +
<pre>
 +
<OFAOMultiplication expr1="" expr2="">
 +
</pre>
 +
 +
==== Paramètres ====
 +
 +
; expr1
 +
: Premier terme de la multiplication
  
−
=== Addition ===
+
; expr2
−
Permet d’additionner expr1 et expr2:
+
: Second terme de la multiplication
  
 +
=== OFAODivision ===
  
−
<nowiki><OFAOAddition expr1="10" expr2="50"></nowiki>
+
Permet de diviser expr1 par expr2.
  
 +
==== Syntaxe ====
  
−
Ceci fait l'addition de 10 et de 50. Le résultat doit être sauvegardé dans une variable via le paramètre saveas.
+
<pre>
 +
<OFAODivision expr1="" expr2="">
 +
</pre>
  
 +
==== Paramètres ====
  
−
<nowiki><OFAOAddition expr1="<OVTotal>" expr2="50"></nowiki>
+
; expr1
 +
: Premier terme de la division
  
 +
; expr2
 +
: Second terme de la division
  
−
Ceci fait l’addition de 50 avec la valeur de la variable Total. Le résultat doit être sauvegardé dans une variable via le paramètre saveas.
+
==== Exemple ====
  
 +
<pre>
 +
<OFAODivision expr1="10" expr2="20">
 +
</pre>
  
−
<nowiki><OFAOAddition expr1="<OVTotal>" expr2="50" saveas="NewTotal"></nowiki>
+
Cette opération retourne le résultat de l'opération "10 / 20", soit 0.5.
  
 +
=== OFAOModulus ===
  
−
Ceci définit la variable NewTotal ayant pour valeur la somme de 50 avec le contenu de la variable Total.
+
Permet de récupérer le reste de la division de expr1 par expr2.
  
 +
==== Syntaxe ====
  
−
=== Soustraction ===
+
<pre>
−
Permet de soustraire expr1 et expr2 :
+
<OFAOModulus expr1="" expr2="">
 +
</pre>
  
 +
==== Paramètres ====
  
−
<nowiki><OFAOSubtraction expr1="100" expr2="50"></nowiki>
+
; expr1
 +
: Premier terme du modulo
  
 +
; expr2
 +
: Second terme du modulo
  
−
=== Multiplication  ===
+
==== Exemple ====
−
Permet de faire le produit de expr1 et expr2 :
+
  
 +
<pre>
 +
<OFAOModulus expr1="10" expr2="20">
 +
</pre>
  
−
<nowiki><OFAOMultiplication expr1="100" expr2="50"></nowiki>
+
Cette opération retourne le résultat de l'opération "10 % 20", soit 10, car 10 / 20 = 0 + '''10'''.
  
 +
== OFHeader ==
  
−
=== Division  ===
+
Permet d'envoyer un header HTTP pour le fichier ovml.
−
Permet de diviser expr1 par expr2 :
+
  
 +
=== Syntaxe ===
  
−
<nowiki><OFAODivision expr1="100" expr2="50"></nowiki>
+
<pre>
 +
<OFHeader value="">
 +
</pre>
  
 +
=== Paramètres ===
  
−
=== Modulo  ===
+
; value
−
Permet de récupérer le reste de expr1 divisé par expr2 :
+
: Valeur du header à modifier
  
 +
=== Exemple ===
  
−
<nowiki><OFAOModulus expr1="100" expr2="50"></nowiki>
+
<pre>
 +
<OFHeader value="content-type:text/xml">
 +
</pre>
  
 +
== OFSetCookie ==
  
−
== Header  ==
+
Permet de définir un cookie qui sera envoyé avec le reste des en-têtes.
−
Permet d'envoyer un header HTTP pour le fichier ovml :
+
  
 +
=== Syntaxe ===
  
−
<nowiki><OFHeader value="content-type:text/xml"></nowiki>
+
<pre>
 +
<OFSetCookie name="" expire="" [value=""]>
 +
</pre>
  
−
== SetCookie  ==
+
=== Paramètres ===
−
Permet de définir un cookie qui sera envoyé avec le reste des en-têtes :
+
  
 +
; name
 +
: Nom du cookie
  
−
<nowiki><OFSetCookie name="" value="" expire=""></nowiki>
+
; expire
 +
: Temps en secondes au bout duquel le cookie expire
  
 +
; value ''(optionnel)''
 +
: Valeur à affecteur au cookie
  
−
''name'' est le nom du cookie, ''value'' est la valeur du cookie et est optionnel.
+
== OFGetCookie ==
  
−
''expire'' est une valeur en secondes et indique le temps après lequel le cookie expire.
+
Permet de récupérer la valeur d'un cookie. Une variable ayant le nom du cookie récupéré est créée automatiquement.
  
−
== GetCookie  ==
+
=== Syntaxe ===
−
Permet de récupérer la valeur d'un cookie :
+
  
 +
<pre>
 +
<OFGetCookie name="">
 +
</pre>
  
−
<nowiki><OFGetCookie name="moncookie"></nowiki>
+
=== Paramètres ===
  
 +
; name
 +
: Nom du cooke dont on souhatie récupérer la valeur
  
−
''name''<nowiki> est le nom du cookie. La valeur du cookie peut être récupérée par ovml en utilisant la variable <OVmoncookie>.</nowiki>
+
== OFSetSessionVar ==
  
−
== SetSessionVar  ==
+
Permet de choisir le type de sections à afficher dans le portail.
−
Permet de choisir le type de sections à afficher dans le portail :
+
  
 +
=== Syntaxe ===
  
−
<nowiki><OFSetSessionVar name=""></nowiki>
+
<pre>
 +
<OFSetSessionVar name="" value="">
 +
</pre>
  
 +
=== Paramètres ===
  
−
''name'' peut prendre 2 valeurs : babSectionsType et babOvmlCurrentDelegation.
+
; 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
  
−
- babSectionsType définit le type des sections à afficherValeurs possibles :1 : Section Administration et Utilisateur
+
; 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
  
−
2 : Sections générées par les articles (sections de catégories et de thèmes d'articles)4 : Sections personnalisées8 : Sections générées par les modules15 : Toutes les sectionsRemarque : les valeurs peuvent s'additionner. Pour afficher les sections des articles et les sections personnalisées, on utilisera la valeur 6 (2 + 4)
+
=== Exemples ===
  
−
- babOvmlCurrentDelegation filtre sur les sections propres à une délégation
+
<pre>
 +
<OFSetSessionVar name="babSectionsType" value="15">
 +
</pre>
  
 +
affichera toutes les sections du portail
  
−
Exemples :
+
<pre>
 +
<OFSetSessionVar name="babSectionsType" value="4">
 +
</pre>
 +
 +
affichera uniquement les sections personnalisées du portail
  
 +
<pre>
 +
<OFSetSessionVar name="babSectionsType" value="10">
 +
</pre>
  
−
<nowiki><OFSetSessionVar name="babSectionsType" value="15"></nowiki>affichera toutes les sections du portail
+
affichera les sections générées par les modules et les sections générées par les articles
  
 +
<pre>
 +
<OFSetSessionVar name="babOvmlCurrentDelegation" value="5">
 +
</pre>
  
−
<nowiki><OFSetSessionVar name="babSectionsType" value="4"></nowiki>affichera uniquement les sections personnalisées du portail
+
affichera uniquement les sections générées par la délégation dont l'identifiant est 5
  
 +
<pre>
 +
<OFSetSessionVar name="babOvmlCurrentDelegation" value="0">
 +
</pre>
  
−
<nowiki><OFSetSessionVar name="babSectionsType" value="10"></nowiki>affichera les sections générées par les modules et les sections générées par les articles
+
cache toutes les sections générées dans les délégations
  
 +
== OFRequest ==
  
−
<nowiki><OFSetSessionVar name="babOvmlCurrentDelegation" value="5"></nowiki>affichera uniquement les sections générées par la délégation dont l'identifiant est 5<nowiki><OFSetSessionVar name="babOvmlCurrentDelegation" value="0"></nowiki>cache toutes les sections générées dans les délégations
+
Permet de connaître la valeur d'un paramètre dans l'url (méthode GET) ou passé par un formulaire (méthode POST).
  
−
== Request ==
+
=== Syntaxe ===
−
Permet de connaître la valeur d'un paramètre dans l'url (méthode GET) ou passer par un formulaire (méthode POST).
+
  
 +
<pre>
 +
<OFRequest name="" saveas="" [default=""]>
 +
</pre>
  
−
<nowiki><OFRequest name="tg" default="" saveas="mavariable"></nowiki>
+
=== 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.
  
−
Le paramètre name indique le nom du paramètre GET ou POST dont on veut connaître la valeur.
+
; saveas
 +
: Permet d'enregistrer la valeur du paramètre dans une nouvelle variable OvML.
  
−
Le paramètre default est optionnel, il permet d'attribuer une valeur à la variable lorsque celle-ci n'est pas définie.
+
; default ''(optionnel)''
 +
: Permet d'attribuer une valeur à la variable lorsque celle-ci n'est pas définie.
  
−
<nowiki>Le paramètre saveas est utilisé pour enregistrer la valeur du paramètre dans une nouvelle variable OVML. La variable pourra s'utiliser comme ceci : <Ovmavariable>.</nowiki>
+
== OFPost ==
  
−
== Post ==
 
 
Permet de connaître la valeur d'un paramètre passé par un formulaire (méthode POST).
 
Permet de connaître la valeur d'un paramètre passé par un formulaire (méthode POST).
  
 +
=== Syntaxe ===
  
−
<nowiki><OFPost name="tg" default="" saveas="mavariable"></nowiki>
+
<pre>
 +
<OFPost name="" saveas="" [default=""]>
 +
</pre>
  
 +
=== Paramètres ===
  
−
Le paramètre name indique le nom du paramètre POST dont on veut connaître la valeur.
+
; 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.
  
−
Le paramètre default est optionnel, il permet d'attribuer une valeur à la variable lorsque celle-ci n'est pas définie.
+
; saveas
 +
: Permet d'enregistrer la valeur du paramètre dans une nouvelle variable OvML.
  
−
<nowiki>Le paramètre saveas est utilisé pour enregistrer la valeur du paramètre dans une nouvelle variable OVML. La variable pourra s'utiliser comme ceci : <Ovmavariable>.</nowiki>
+
; default ''(optionnel)''
 +
: Permet d'attribuer une valeur à la variable lorsque celle-ci n'est pas définie.
 +
 
 +
== OFGet ==
  
−
== Get ==
 
 
Permet de connaître la valeur d'un paramètre dans l'url (méthode GET).
 
Permet de connaître la valeur d'un paramètre dans l'url (méthode GET).
  
 +
=== Syntaxe ===
  
−
<nowiki><OFGet name="tg" default="" saveas="mavariable"></nowiki>
+
<pre>
 +
<OFGet name="" saveas="" [default=""]>
 +
</pre>
  
 +
=== Paramètres ===
  
−
Le paramètre name indique le nom du paramètre GET dont on veut connaître la valeur.
+
; 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.
  
−
Le paramètre default est optionnel, il permet d'attribuer une valeur à la variable lorsque celle-ci n'est pas définie.
+
; saveas
 +
: Permet d'enregistrer la valeur du paramètre dans une nouvelle variable OvML.
  
−
<nowiki>Le paramètre saveas est utilisé pour enregistrer la valeur du paramètre dans une nouvelle variable OVML. La variable pourra s'utiliser comme ceci : <Ovmavariable>.</nowiki>
+
; 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).
  
−
== SitemapPosition ==
+
=== Syntaxe ===
  
−
<OFSitemapPosition [sitemap=""] [basenode=""] [node=""] [keeplastknown=""]>
+
<pre>
−
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).
+
<OFSitemapPosition [sitemap=""] [basenode=""] [node=""] [keeplastknown=""]>
 +
</pre>
  
−
===== Paramètres =====
+
=== 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.
  
−
<dl>
 
−
<dt>node ''(optionnel)'' :
 
−
<dd>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...
 
  
−
<dt>basenode ''(optionnel)'' :
+
; node ''(optionnel)''
−
<dd>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...).
+
: 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
−
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).
+
: Exemple : babUserSection, babUserSectionAddons, babArticles, babFaqs, Custom...
  
−
<dt>sitemap ''(optionnel)'' :
+
; basenode ''(optionnel)''
−
<dd>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é.
+
: 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).
  
−
<dt>keeplastknown ''(optionnel)'' :
+
; sitemap ''(optionnel)''
−
<dd>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é.
+
: 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é.
−
La valeur par défaut est "1" (activé).
+
 
−
</dl>
+
; 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 ==
  
−
== SitemapMenu ==
 
 
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é).
 
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é).
  
−
===== Exemple =====
+
=== Syntaxe ===
−
<OFSitemapMenu sitemap="" basenode="" selectednode="" keeplastknown="" maxdepth="">
+
  
−
===== Paramètres =====
+
<pre>
 +
<OFSitemapMenu [sitemap=""] [baselangid=""] [basenode=""] [selectednode=""] [keeplastknown="1"] [maxdepth=""] [ignorelastlevel="0"] [mindepth="0"] [outerul="1"] [admindelegation="0"]>
 +
</pre>
  
 +
=== Paramètres ===
  
−
<dl>
+
; sitemap ''(optionnel)''
−
<dt>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é.
−
<dd>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é.
+
  
−
<dt>basenode ''(optionnel)'' :
 
−
<dd>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).
 
−
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).
 
  
−
<dt>selectednode ''(optionnel)'' :
+
; baselangid ''(optionnel)''
−
<dd>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é.
+
: Permet de spécifier le nœud à partir duquel le menu commencera en utilisant un identifiant compatible avec le multilangue
−
Exemple : babUserSection, babUserSectionAddons, babArticles, babFaqs, Custom...
+
  
−
<dt>keeplastknown ''(optionnel)'' :
 
−
<dd>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é.
 
−
La valeur par défaut est "1" (activé).
 
  
−
<dt>maxdepth ''(optionnel)'' :
+
; basenode ''(optionnel)''
−
<dd>Permet de limiter le nombre de niveaux (sous-menus imbriqués). Pas de limite par défaut.
+
: 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...).
−
</dl>
+
: 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).
−
== NextArticle ==
+
: 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é.
−
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
+
  
−
===== Exemple =====
+
; selectednode ''(optionnel)''
−
<OFNextArticle articleid="12" topicid="7" orderby="modification" order=desc">
+
: 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...
  
−
===== Paramètres =====
+
; 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.
  
−
<dl>
+
; ignorelastlevel  ''(optionnel)''
−
<dt>articleid :
+
: ''Depuis Ovidentia '''<span class="version">8.3.92</span>'''''
−
<dd>Identifiant de l'article de référence, pour lequel on cherche l'article suivant.
+
: Permet de ne pas afficher les nœuds n'ayant pas d'enfants.
 +
: 1 : activé
 +
: 0 ''(par défaut)'' : désactivé
  
−
<dt>topicid ''(optionnel)'' :
+
; mindepth ''(optionnel)''
−
<dd>Permet de spécifier le(s) thème(s) dans lesquels l'article suivant sera recherché.
+
: ''Depuis Ovidentia '''<span class="version">8.3.92</span>'''''
−
* Id du thème ou plusieurs Ids séparés par une virgule
+
: 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é).
−
* Si omis, le container liste les articles tout thème confondu
+
  
−
<dt>excludetopicid ''(optionnel)'' :
+
; outerul ''(optionnel)''
−
<dd>Permet de préciser les thèmes d'articles à exclure à la différence du paramètre topicid
+
: Permet de de définir si le menu contient la balise &lt;ul&gt; de premier niveau.
−
* Id du thème ou plusieurs Ids séparés par une virgule
+
: 1 ''(par défaut)'' : la balise &lt;ul&gt; de premier niveau est présente.
 +
: 0 : la balise &lt;ul&gt; de premier niveau n'est pas présente.
  
−
<dt>archive:
+
; admindelegation ''(optionnel)''
−
<dd>
+
: Permet de définir que les nœuds d'administration ne seront affichés que si l'utilisateur à les droits de gestion correspondants.
−
* Yes : Donne la liste des articles archivés
+
: 1 : la délégation est prise en compte.
−
* No: Donne la liste des articles non archivés
+
: 0 ''(par défaut)'' : la délégation n'est pas prise en compte.
−
* Si omis, liste uniquement les articles non archivés.
+
  
−
<dt>order ''(optionnel)'' :
 
−
<dd>
 
−
* asc: Ordonne les articles par ordre croissant en fonction de la date
 
−
* desc: Ordonne les articles par ordre décroissant en fonction de la date (valeur par défaut)
 
−
* rand: Ordonne les articles aléatoirement
 
  
−
<dt>orderby ''(optionnel)'' :
+
== OFCurrentNode ==
−
<dd>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: Ordonne les articles par ordre de modification en fonction de la date
+
  
−
<dt>topicorder ''(optionnel)'' :
+
Retourne l'Id du nœud courant dans le plan de site.
−
<dd>
+
−
* yes: Utilise l'ordre défini par le gestionnaire du thème d'articles
+
−
* no: N'utilise l'ordre défini par le gestionnaire du thème d'articles
+
  
−
<dt>delegationid ''(optionnel)'' :
+
== OFThumbnail ==
−
<dd>
+
−
* Si omis ou 0 : pas de filtre
+
−
* Id de la délégation.
+
−
</dl>
+
  
−
= Les containers OvML =
+
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.
−
La syntaxe des containers est comme suit :
+
  
 +
Nécessite le module [[LibFileManagement]].
  
−
<nowiki><OCxxxx param1="value" param2="value" …> ….. </OCxxxx> </nowiki>
+
=== Syntaxe ===
  
 +
<pre>
 +
<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=""]>
 +
</pre>
  
−
Les containers contiennent des tags OvML et du code HTML. Ce sont généralement des listes de données identiques ou des conditions.
+
=== Paramètres ===
  
 +
; id_directory_entry ''(optionnel)''
 +
: Identifiant d'une fiche d'annuaire.
  
−
<nowiki>A l'appel d'un container, OvML met à votre disposition des variables <OVxxxx>.</nowiki>
+
; id_user ''(optionnel)''
 +
: Identifiant d'un utilisateur.
  
−
La liste des variables dépend du type de container.
+
; id_article''(optionnel)''
 +
: Identifiant d'un article pour récupérer l'image de l'article.
  
−
Ces variables ne sont plus disponibles en dehors du container
+
; id_file''(optionnel)''
 +
:''Depuis LibFileManagement '''<span class="version">0.3.7</span>'''''
 +
: Identifiant d'un fichier du gestionnaire de fichier.
  
 +
; path ''(optionnel)''
 +
: Chemin absolu vers un fichier sur le serveur
  
−
A l’intérieur de tout container de type liste, les variables suivantes sont disponibles :
+
; maxwidth ''(optionnel)''
 +
: Largeur maximale du thumbnail en pixels.
  
 +
; maxheight ''(optionnel)''
 +
: Hauteur maximale du thumbnail en pixels.
  
−
- OVCIndex: index de l’entrée courante en commençant par 0
+
; 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.
  
−
- OVCCount: Le nombre total d’entrées dans le container
+
; resizeleft ''(optionnel)''
 +
:''Depuis LibFileManagement '''<span class="version">0.2.42</span>'''''
 +
: 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).
  
−
== Les opérateurs de comparaison  ==
+
; resizetop ''(optionnel)''
−
<nowiki><OCxxxx expr1="value" expr2="value"> ….. </OCxxxx> </nowiki>
+
:''Depuis LibFileManagement '''<span class="version">0.2.42</span>'''''
 +
: 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.
  
−
Ces containers permettent d’effectuer des comparaisons entre les valeurs expr1 et expr2.
+
; 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.
  
−
Si la condition est vrai, le contenu du container est parcouru.
+
; outerborderwidth ''(optionnel)''
 +
: Largeur de la bordure extérieure en pixels
  
 +
; outerbordercolor ''(optionnel)''
 +
: Couleur de la bordure extérieure au format #xxxxxx.
  
−
{| style="border-spacing:0;"
+
; outerborder ''(optionnel)''
−
| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| OCIfEqual
+
: Raccourci de outerborderwidth et outerbordercolor avec les deux valeurs séparées par une virgule.
−
| style="border:0.002cm solid #000000;padding:0.097cm;"| Vrai si expr1 est égal à expr2
+
  
−
|-
+
; saveas ''(optionnel)''
−
| OCIfNotEqual
+
: Permet d'enregistrer le résultat de la fonction dans une variable, dans ce cas, le résultat n'est pas affiché.
−
| Vrai si expr1 est différent expr2
+
  
−
|-
+
== OFImg ==
−
| OCIfLessThan
+
−
| Vrai si expr1 plus petit strictement que expr2
+
  
−
|-
+
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 <code>img</code> pour afficher l'image. Si aucune image ne peut être affichée, une chaine vide est retournée au lieu du tag <code>img</code>.
−
| OCIfLessThanOrEqual
+
−
| Vrai si expr1 plus petit ou égal que expr2
+
  
−
|-
+
Les attributs non supportés par la fonction ovml serons reportés tel-quel en tant qu'attributs du tag <code>img</code>.
−
| OCIfGreaterThan
+
−
| Vrai si expr1 plus grande strictement que expr2
+
  
−
|-
+
Nécessite le module [[LibFileManagement]].
−
| OCIfGreaterThanOrEqual
+
−
| Vrai si expr1 plus grande ou égal que expr2
+
  
−
|}
+
=== Syntaxe ===
−
Exemple :
+
  
−
<nowiki><OCIfEqual expr1="<OVCategoryId>" expr2="<OVcat>"></nowiki>
+
<pre>
 +
<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"] >
 +
</pre>
  
−
<nowiki><tr bgcolor="#6B9DCA"> </nowiki>
+
=== Paramètres ===
  
−
<nowiki><td width="10"></td></nowiki>
 
  
−
<nowiki><td class="BabBodySection" valign="middle"><OVbabsectionbullet></td></nowiki>
+
; 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.
  
−
<nowiki><td width="5"></td></nowiki>
+
; 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.
  
−
<nowiki><td class="BabBodySection"></nowiki>
+
; id_directory_entry ''(optionnel)''
 +
: Identifiant d'une fiche d'annuaire.
  
−
<nowiki><OVTopicName></nowiki>
+
; id_user ''(optionnel)''
 +
: Identifiant d'un utilisateur.
  
−
<nowiki></td></nowiki>
+
; id_article''(optionnel)''
 +
: Identifiant d'un article pour afficher l'image de l'article.
  
−
<nowiki></tr></nowiki>
+
; id_file''(optionnel)''
 +
:''Depuis LibFileManagement '''<span class="version">0.3.7</span>'''''
 +
: Identifiant d'un fichier du gestionnaire de fichier.
  
−
<nowiki></OCIfEqual></nowiki>
+
; path ''(optionnel)''
 +
: Chemin absolu vers un fichier sur le serveur
  
 +
; maxwidth ''(optionnel)''
 +
: Largeur maximale du thumbnail en pixels.
  
−
== Les opérateurs de test d'existence sur les variables  ==
+
; maxheight ''(optionnel)''
−
Ces containers permettent de vérifier l'existence ou non d'une variable.
+
: Hauteur maximale du thumbnail en pixels.
  
−
Si la variable est définie ou non, selon le container, le container est parcouru.
+
; 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 '''<span class="version">0.2.42</span>'''''
 +
: 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).
  
−
<nowiki><OCIfIsSet name="nom-de-la-variable"> ….. </OCIfIsSet></nowiki>
+
; resizetop ''(optionnel)''
 +
:''Depuis LibFileManagement '''<span class="version">0.2.42</span>'''''
 +
: 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).
  
−
Si la variable est définie le contenu du container est parcouru.
+
; innerborderwidth ''(optionnel)''
 +
: Largeur de la bordure intérieure en pixels.
  
 +
; innerbordercolor ''(optionnel)''
 +
: Couleur de la bordure intérieure au format #xxxxxx.
  
−
<nowiki><OCIfNotIsSet name="nom-de-la-variable"> ….. </OCIfNotIsSet></nowiki>
+
; innerborder ''(optionnel)''
 +
: Raccourci de innerborderwidth et innerbordercolor avec les deux valeurs séparées par une virgule.
  
−
Si la variable n'est pas définie, le contenu du container n'est pas parcouru.
+
; outerborderwidth ''(optionnel)''
 +
: Largeur de la bordure extérieure en pixels
  
 +
; outerbordercolor ''(optionnel)''
 +
: Couleur de la bordure extérieure au format #xxxxxx.
  
−
== OCIfUserMemberOfGroups  ==
+
; outerborder ''(optionnel)''
−
Ce container est exécuté si l'utilisateur courant appartient à un groupe
+
: Raccourci de outerborderwidth et outerbordercolor avec les deux valeurs séparées par une virgule.
  
−
<nowiki><OCIfUserMemberOfGroups userid="" groupid="" all="" childs=""> ....</OCIfUserMemberOfGroups></nowiki>
+
=== Exemples ===
  
 +
Affiche l'image que si le paramètre img est fourni dans l'url :
  
−
Attributs :
+
<pre>
  
−
groupid :
+
<OFGet name="img" saveas="Image">
 +
<OFImg ovsrc="Image" alt="Mon image">
  
−
* id du groupe ou plusieurs ids séparés par une virgule
 
  
−
userid :
+
</pre>
  
−
* Optionnel
 
  
−
Cette variable permet de tester si un utilisateur spécifique appartient à des groupes en donnant un id utilisateur.
+
Affiche la photo de l'utilisateur connecté :
  
−
Si omis, elle prend la valeur de l'utilisateur courant.
+
<pre>
 +
<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">
 +
</pre>
  
 +
== OFSitemapCustomNodeId ==
  
−
All :
+
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.
  
−
* yes : L'utilisateur courant doit appartenir à tous les groupes spécifiés dans groupid
+
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.
−
* no : L'utilisateur courant doit appartenir à au moins un des groupes spécifiés dans groupid
+
−
* si omis, il suffit que l'utilisateur appartienne à au moins un des groupes
+
  
−
childs :
+
Si il existe plusieurs nœuds avec la même cible dans le plan du site du noyau, le premier trouvé sera utilisé
  
−
Optionnel
+
=== Syntaxe ===
  
−
* yes : Pour chaque groupe, inclure ses enfants
+
<pre>
−
* no ou si omis : Les enfants ne sont pas inclus
+
<OFSitemapCustomNodeId node="" [basenode=""] [saveas=""]>
 +
</pre>
  
−
== OCArticlesHomePages  ==
+
=== Paramètres ===
−
Liste les articles des pages d’accueil privée ou publique.
+
  
 +
; node
 +
: ID du nœud dans le plan du site proposé par le noyau d'Ovidentia
  
−
<nowiki><OCArticlesHomePages type="" order="" filter="">....</OCArticlesHomePages></nowiki>
+
; 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é
  
−
Attributs :
 
  
−
type :
+
=== Exemple ===
  
−
* private : Liste les articles de la page d’accueil privée
 
−
* public : Liste les articles de la page d’accueil publique
 
  
−
order :
+
<pre>
 +
<OFSitemapCustomNodeId node="bab_Articles" saveas="CustomNodeId">
 +
<OFSitemapMenu basenode="<OVCustomNodeId>">
 +
</pre>
  
−
Optionnel
+
== OFPreviousArticle ==
  
−
* asc : Ordonne les articles par ordre croissant en fonction de la date
+
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.
−
* desc : Ordonne les articles par ordre décroissant en fonction de la date
+
−
* rand : Ordonne les articles aléatoirement
+
  
−
Si omis, le container ordonne par ordre croissant en fonction de la date.
+
=== Syntaxe ===
  
−
Filter :
+
<pre>
 +
<OFPreviousArticle articleid="" [topicid=""] [excludetopicid=""] [archive=""] [orderby=""] [order=""] [topicorder=""] [delegationid=""]>
 +
</pre>
  
−
Optionnel
+
=== Paramètres ===
  
−
* yes : Filtre les articles selon le droit de visibilité
+
; articleid
−
* no : Ne filtre pas
+
: Identifiant de l'article de référence, pour lequel on cherche l'article suivant.
  
−
Si omis, le container ne filtre pas les articles.
+
; 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
  
−
Imageheightmax :
+
; 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
  
−
Optionnel
+
; archive ''(optionnel)''
 +
:
 +
:* yes : Donne la liste des articles archivés
 +
:* no ''(par défaut)'' : Donne la liste des articles non archivés
  
−
Valeur en pixels. Permet de préciser la hauteur maximum de l'image associée.
+
; 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
  
−
Si omis, l'image n'est pas redimensionnée et garde sa taille d'origine.
+
; 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
  
−
Imagewidthmax :
+
; 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
  
−
Optionnel
+
; delegationid ''(optionnel)''
 +
:
 +
:* 0 ''(par défaut)'' : pas de filtre
 +
:* Id de la délégation.
  
−
Valeur en pixels. Permet de préciser la largeur maximum de l'image associée.
+
== OFNextArticle ==
  
−
Si omis, l'image n'est pas redimensionnée et garde sa taille d'origine.
+
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.
  
−
Variables :
+
=== Syntaxe ===
  
 +
<pre>
 +
<OFNextArticle articleid="" [topicid=""] [excludetopicid=""] [archive=""] [orderby=""] [order=""] [topicorder=""] [delegationid=""]>
 +
</pre>
  
 +
=== Paramètres ===
  
−
{| style="border-spacing:0;"
+
; articleid
−
| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| OVArticleTitle
+
: Identifiant de l'article de référence, pour lequel on cherche l'article suivant.
−
| style="border:0.002cm solid #000000;padding:0.097cm;"| Titre de l'article
+
  
 +
; 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 '''<span class="version">7.2.90</span>'''''
 +
 +
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 ===
 +
 +
<pre>
 +
<OFWebStat name="" value="">
 +
</pre>
 +
 +
=== 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 ===
 +
 +
<pre>
 +
<OCArticle articleid="<OVarticleid&gt;">
 +
    <!-- Affichage de l'article -->
 +
    <OFWebStat name="bab_articles" value="<OVarticleid&gt;">
 +
</OCArticle>
 +
</pre>
 +
 +
== OFAddStyleSheet ==
 +
 +
''Depuis Ovidentia '''<span class="version">7.5.93</span>'''''
 +
 +
Permet d'insérer un fichier CSS dans l'élément <code><head></head></code> de la page HTML.
 +
 +
=== Syntaxe ===
 +
 +
<pre>
 +
<OFAddStyleSheet file="">
 +
</pre>
 +
 +
=== Paramètres ===
 +
 +
; file
 +
: Chemin de la feuille de style relatif au dossier '''styles''' du noyau d'Ovidentia
 +
 +
 +
== OFGetPath ==
 +
 +
''Depuis Ovidentia '''<span class="version">8.2.0</span>'''''
 +
 +
Renvoie un chemin relatif au répertoire racine d'ovidentia.
 +
 +
=== Syntaxe ===
 +
 +
<pre>
 +
<OFGetPath path="" file_relative="1" saveas="">
 +
</pre>
 +
 +
=== Paramètres ===
 +
 +
; file_relative
 +
: Convertit un chemin relatif au fichier ovml en un chemin relatif au répertoire racine d'ovidentia.
 +
 +
 +
== OFGetSelectedSkinPath ==
 +
 +
''Depuis Ovidentia '''<span class="version">8.3.0</span>'''''
 +
 +
Renvoie le chemin du répertoire du thème sélectionné.
 +
 +
'''<OFGetSelectedSkinPath>''' doit remplacer '''skins/<OVbabSkin>/''' dans les fichiers ovml.
 +
 +
=== Syntaxe ===
 +
 +
<pre>
 +
<OFGetSelectedSkinPath>
 +
</pre>
 +
 +
 +
== OFGetCsrfProtectToken ==
 +
 +
''Depuis Ovidentia '''<span class="version">8.4.91</span>'''''
 +
 +
Renvoie l'identifiant de protection contre les attaques CSRF, il doit être ajouté dans tous les formulaire utilisant la méthode POST.
 +
 +
=== Syntaxe ===
 +
 +
<pre>
 +
<input type="hidden" name="babCsrfProtect" value="<OFGetCsrfProtectToken>">
 +
</pre>
 +
 +
 +
== OFGetCurrentAdmGroup ==
 +
 +
''Depuis Ovidentia '''<span class="version">8.5.90</span>'''''
 +
 +
Renvoie l'identifiant de la délegation actuellement administré par l'utilisateur courrant.
 +
 +
=== Syntaxe ===
 +
 +
<pre>
 +
<OCDelegationManaged delegationid="<OFGetCurrentAdmGroup>"><OVDelegationName></OCDelegationManaged>
 +
</pre>
 +
 +
== OFPortletContainer ==
 +
 +
''Nécessite l'installation du module '''portlets'''''
 +
 +
Permet l'intégration d'une zone de portlet dans la page.
 +
 +
=== Syntaxe ===
 +
 +
<pre>
 +
<OFPortletContainer id="" [mode="static"] [placeholder=""] [editplaceholder=""] [description=""] [classname=""]>
 +
</pre>
 +
 +
=== Paramètres ===
 +
 +
; id
 +
: L'identifiant unique du portlet
 +
 +
; mode ''(optionnel)''
 +
: Le type de portlet
 +
:* static ''(par défaut)'' : Le portlet est personnel, chaque utilisateur peut configurer son portlet
 +
:* locked : Le portlet est le même pour tout les utilisateurs
 +
 +
; placeholder ''(optionnel)''
 +
: Un texte à afficher lorsque la zone de portlet est vide
 +
 +
; editplaceholder ''(optionnel)''
 +
: Un texte à afficher lorsque l'utilisateur édite la zone de portlet
 +
 +
; description ''(optionnel)''
 +
: Un texte toujours affiché
 +
 +
; classname''(optionnel)''
 +
: Une classe est ajoutée sur la div
 +
 +
;categories
 +
 +
;initwith
 +
 +
 +
== OFGetRegistryValue ==
 +
 +
Renvoie une valeur de configuration gérée par la bab_Registry.
 +
: ''Depuis Ovidentia '''<span class="version">8.6.97</span>'''''
 +
 +
=== Syntaxe ===
 +
 +
<pre>
 +
<OFGetRegistryValue path="/path/to/value">
 +
</pre>
 +
 +
=== Paramètres ===
 +
 +
; path
 +
: Le chemin de la registry correspondant à la valeur recherchée
 +
 +
= Les containers OvML =
 +
 +
La syntaxe des containers est comme suit :
 +
 +
<pre>
 +
<OCxxxx param1="value" param2="value" ...>...</OCxxxx>
 +
</pre>
 +
 +
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 <code><OVxxxx></code>.
 +
 +
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 :
 +
 +
{| class="prettytable"
 +
! 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.
 +
 +
{| class="prettytable"
 +
! 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 ===
 +
 +
<pre>
 +
<OCxxxx expr1="" expr2="">...</OCxxxx>
 +
</pre>
 +
 +
=== Paramètres ===
 +
 +
; expr1
 +
: Premier terme de la comparaison
 +
; expr2
 +
: Second terme de la comparaison
 +
 +
=== Exemple ===
 +
 +
<pre>
 +
<OFPutVar name="BAB_SESS_LOGGED">
 +
<OCIfEqual expr1="<BAB_SESS_LOGGED&gt;" expr2="1">
 +
    <p>Vous êtes connecté !</p>
 +
</OCIfEqual>
 +
</pre>
 +
 +
== 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.
 +
 +
{| class="prettytable"
 +
! 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 ===
 +
 +
<pre>
 +
<OCxxxx name="">...</OCxxxx>
 +
</pre>
 +
 +
=== Paramètres ===
 +
 +
; name
 +
: Nom de la variable dont on doit tester l'existence
 +
 +
=== Exemple ===
 +
 +
<pre>
 +
<OCIfIsSet name="variable">
 +
    Ce texte ne sera pas affiché.
 +
</OCIfIsSet>
 +
 +
<OFPutVar name="variable" value="1">
 +
<OCIfIsSet name="variable">
 +
    Ce texte sera affiché.
 +
</OCIfIsSet>
 +
</pre>
 +
 +
== OCIfUserMemberOfGroups ==
 +
 +
Ce container est exécuté si l'utilisateur courant appartient à un groupe
 +
 +
=== Syntaxe ===
 +
 +
<pre>
 +
<OCIfUserMemberOfGroups groupid="" [userid=""] [all=""] [childs=""]>...</OCIfUserMemberOfGroups>
 +
</pre>
 +
 +
=== 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 ===
 +
 +
<pre>
 +
<OCArticlesHomePages type="" [order=""] [filter=""] [imageheightmax=""] [imagewidthmax=""]>...</OCArticlesHomePages>
 +
</pre>
 +
 +
=== 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 ===
 +
 +
{| class="prettytable"
 +
! Variable
 +
! Valeur
 +
|-
 +
| OVArticleTitle
 +
| Titre de l'article
 
|-
 
|-
 
| OVArticleHead
 
| OVArticleHead
 
| Introduction de l'article
 
| Introduction de l'article
−
 
 
|-
 
|-
 
| OVArticleBody
 
| OVArticleBody
 
| Corps de l'article
 
| Corps de l'article
−
 
 
|-
 
|-
 
| OVArticleReadMore
 
| OVArticleReadMore
 
| 0 si l’article n’a pas de corps sinon 1
 
| 0 si l’article n’a pas de corps sinon 1
−
 
 
|-
 
|-
 
| OVArticleId
 
| OVArticleId
 
| Id de l'article
 
| Id de l'article
−
 
 
|-
 
|-
 
| OVArticleUrl
 
| OVArticleUrl
 
| Url pour atteindre le corps de l'article
 
| Url pour atteindre le corps de l'article
−
 
 
|-
 
|-
 
| OVArticleAuthor
 
| OVArticleAuthor
 
| Auteur de l'article
 
| Auteur de l'article
−
 
 
|-
 
|-
 
| OVArticleModifiedBy
 
| OVArticleModifiedBy
 
| Utilisateur responsable de la dernière modification
 
| Utilisateur responsable de la dernière modification
−
 
 
|-
 
|-
 
| OVArticleDate
 
| OVArticleDate
 
| Date de publication de l'article
 
| Date de publication de l'article
−
 
+
|-
 +
| OVArticleCategoryId
 +
| Id de la catégorie du thème contenant l'article
 
|-
 
|-
 
| OVArticleTopicId
 
| OVArticleTopicId
 
| Id du thème contenant l'article
 
| Id du thème contenant l'article
−
 
 
|-
 
|-
 
| OVArticleLanguage
 
| OVArticleLanguage
 
| Langue de l'article
 
| Langue de l'article
−
 
 
|-
 
|-
 
| OVArticleTopicTitle
 
| OVArticleTopicTitle
 
| Titre du thème contenant l'article
 
| Titre du thème contenant l'article
−
 
 
|-
 
|-
 
| OVArticleFiles
 
| OVArticleFiles
 
| Nombre de fichiers joints
 
| Nombre de fichiers joints
−
 
 
|-
 
|-
 
| OVArticleEditUrl
 
| OVArticleEditUrl
−
| Url pour accéder à la modification de l'article (penser à ouvre ce lien dans une nouvelle fenêtre ou popup)
+
| Url pour accéder à la modification de l'article (penser à ouvrir ce lien dans une nouvelle fenêtre ou popup)
−
 
+
 
|-
 
|-
 
| OVArticleEditName
 
| OVArticleEditName
 
| Nom associé au lien pour accéder à la modification de l'article
 
| Nom associé au lien pour accéder à la modification de l'article
−
 
+
|-
 +
| OVArticleCopyUrl
 +
| Url pour accéder à la duplication de l'article (penser à ouvrir ce lien dans une nouvelle fenêtre ou popup)
 +
|-
 +
| OVArticleCopyName
 +
| Nom associé au lien pour accéder à la duplication de l'article
 
|-
 
|-
 
| OVAssociatedImage
 
| OVAssociatedImage
 
| 0 si aucune image est associée, 1 si une image est associée
 
| 0 si aucune image est associée, 1 si une image est associée
−
 
 
|-
 
|-
 
| OVImageUrl
 
| OVImageUrl
 
| Url d'affichage de l'image (à utiliser dans une balise img), tient compte des paramètres imageheightmax et imagewidthmax
 
| Url d'affichage de l'image (à utiliser dans une balise img), tient compte des paramètres imageheightmax et imagewidthmax
−
 
 
|-
 
|-
 
| OVOriginalImageUrl
 
| 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
 
| 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
 
| OVImageWidth
 
| Largeur d'origine de l'image
 
| Largeur d'origine de l'image
−
 
 
|-
 
|-
 
| OVImageHeight
 
| OVImageHeight
 
| Hauteur d'origine de l'image
 
| Hauteur d'origine de l'image
−
 
 
|-
 
|-
 
| OVResizedImageWidth
 
| OVResizedImageWidth
 
| Largeur de l'image après redimensionnement
 
| Largeur de l'image après redimensionnement
−
 
 
|-
 
|-
 
| OVResizedImageHeight
 
| OVResizedImageHeight
 
| Hauteur de l'image après redimensionnement
 
| Hauteur de l'image après redimensionnement
−
 
 
|}
 
|}
−
== OCRecentFiles  ==
 
−
Liste les fichiers récemment déposés.
 
  
 +
== OCRecentFiles ==
  
−
<nowiki><OCRecentFiles folderid="xx" from_lastlog="xx" last="xx">....</OCRecentFiles></nowiki>
+
Liste les fichiers récemment déposés.
−
 
+
−
 
+
−
Attributs :
+
−
 
+
−
folderid :
+
  
−
Optionnel.
+
=== Syntaxe ===
  
−
* Id de l’espace ou plusieurs ids séparés par des virgules.
+
<pre>
−
* Si omis, le container liste les fichiers récents de tous les répertoires.
+
<OCRecentFiles last="" path="" [folderid=""] [from_lastlog=""] [order=""] [delegationid=""]>...</OCRecentFiles>
 +
</pre>
  
−
from_lastlog :
+
=== Paramètres ===
  
−
Optionnel.
+
; last
 +
: Nombre de fichiers souhaité
  
−
* Indique combien de jours avant la dernière connexion de l'utilisateur
+
; path
−
* ( 0 = depuis sa dernière connexion )
+
: Indique dans quel sous-répertoire il faut chercher.
  
−
last :
+
; 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.
  
−
* Nombre de fichiers souhaité
+
; 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&nbsp;:
+
; 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
  
−
Optionnel.
+
; delegationid ''(optionnel)''
 +
: Id de la délégation
 +
: 0 ''(par défaut)'' : pas de filtre
  
−
* Asc : Ordonne les fichiers par ordre croissant en fonction de la date
+
=== Variables ===
−
 
+
−
* desc : Ordonne les fichiers par ordre décroissant en fonction de la date (default)
+
−
* rand : Ordonne les fichiers aléatoirement
+
−
 
+
−
path :
+
−
 
+
−
* Indique dans quel sous-répertoire il faut chercher.
+
−
 
+
−
Delegationid :
+
−
 
+
−
Optionnel.
+
−
 
+
−
* Si omis ou 0 : pas de filtre
+
−
* Id de la délégation.
+
−
 
+
−
Variables :
+
−
 
+
−
 
+
−
 
+
−
{| style="border-spacing:0;"
+
−
| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| OVFileId
+
−
| style="border:0.002cm solid #000000;padding:0.097cm;"| Id du fichier
+
  
 +
{| class="prettytable"
 +
! Variable
 +
! Valeur
 +
|-
 +
| OVFileId
 +
| Id du fichier
 
|-
 
|-
 
| OVFileName
 
| OVFileName
 
| Nom du fichier
 
| Nom du fichier
−
 
 
|-
 
|-
 
| OVFilePath
 
| OVFilePath
 
| Chemin du fichier
 
| Chemin du fichier
−
 
 
|-
 
|-
 
| OVFileDescription
 
| OVFileDescription
 
| Description du fichier
 
| Description du fichier
−
 
 
|-
 
|-
 
| OVFileUrl
 
| OVFileUrl
 
| Url pour atteindre la description du fichier
 
| Url pour atteindre la description du fichier
−
 
 
|-
 
|-
 
| OVFilePopupUrl
 
| OVFilePopupUrl
 
| Url pour afficher la description du fichier dans une fenêtre popup
 
| Url pour afficher la description du fichier dans une fenêtre popup
−
 
 
|-
 
|-
 
| OVFileUrlGet
 
| OVFileUrlGet
 
| Url pour télécharger le fichier
 
| Url pour télécharger le fichier
−
 
 
|-
 
|-
 
| OVFileAuthor
 
| OVFileAuthor
 
| Auteur du fichier
 
| Auteur du fichier
−
 
 
|-
 
|-
 
| OVFileModifiedBy
 
| OVFileModifiedBy
 
| Dernière personne ayant modifié le fichier
 
| Dernière personne ayant modifié le fichier
−
 
 
|-
 
|-
 
| OVFileDate
 
| OVFileDate
 
| Date de publication du fichier
 
| Date de publication du fichier
−
 
 
|-
 
|-
 
| OVFileFolderId
 
| OVFileFolderId
 
| Id du répertoire contenant le fichier
 
| Id du répertoire contenant le fichier
−
 
 
|-
 
|-
 
| OVFileDelegationId
 
| 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
 
| 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.
 
  
 +
== OCRecentArticles ==
  
−
<nowiki><OCRecentArticles from_lastlog="" last="" topicid="" order="" minrating=</nowiki>""<nowiki>>....</OCRecentArticles></nowiki>
+
Liste les articles récents.
−
 
+
−
 
+
−
Attributs :
+
−
 
+
−
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 = depuis sa dernière connexion )
+
−
 
+
−
last :
+
−
 
+
−
* Nombre d‘articles souhaité
+
−
 
+
−
order&nbsp;:
+
−
 
+
−
Optionnel.
+
−
 
+
−
* Asc : Ordonne les articles par ordre croissant en fonction de la date
+
−
* desc : Ordonne les articles par ordre décroissant en fonction de la date (valeur par défaut)
+
−
* rand : Ordonne les articles aléatoirement
+
−
 
+
−
orderby&nbsp;:
+
−
 
+
−
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 : 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&nbsp;:
+
−
 
+
−
Optionnel.
+
  
−
* Yes : Utilise l'ordre défini par le gestionnaire du thème d'articles
+
=== Syntaxe ===
−
* no : N'utilise l'ordre défini par le gestionnaire du thème d'articles
+
  
−
archive :
+
<pre>
 +
<OCRecentArticles last="" [topicid=""] [excludetopicid=""] [categoryid=""] [from_lastlog=""] [order=""] [orderby=""] [topicorder=""] [archive=""] [delegationid=""] [imageheightmax=""] [imagewidthmax=""] [minrating=""]>...</OCRecentArticles>
 +
</pre>
  
−
Optionnel.
+
=== Paramètres ===
  
−
* Yes : Donne la liste des articles archivés
+
; last
−
* No : Donne la liste des articles non archivés
+
: Nombre d‘articles souhaité
−
* Si omis, liste uniquement les articles non archivés
+
  
−
delegationid :
+
; 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
  
−
Optionnel.
+
; 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
  
−
* Si omis ou 0 : pas de filtre
+
; categoryid ''(optionnel)''
−
* Id de la délégation.
+
: Id de la catégorie, tous les thèmes enfants seront utilisés
 +
: si categoryid est utilisé, topicid devient obsolète
  
−
Imageheightmax :
+
; from_lastlog ''(optionnel)''
 +
: Indique combien de jours avant la dernière connexion de l'utilisateur
 +
: 0 ''(par défaut)'' : depuis sa dernière connexion
  
−
Optionnel
+
; 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
  
−
Valeur en pixels. Permet de préciser la hauteur maximum de l'image associée.
+
; 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
  
−
Si omis, l'image n'est pas redimensionnée et garde sa taille d'origine.
+
; 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
  
−
Imagewidthmax :
+
; archive ''(optionnel)''
 +
: yes : Donne la liste des articles archivés
 +
: no ''(par défaut)'' : Donne la liste des articles non archivés
  
−
Optionnel
+
; delegationid ''(optionnel)''
 +
: Id de la délégation.
 +
: 0 ''(par défaut)'' : pas de filtre
  
−
Valeur en pixels. Permet de préciser la largeur maximum de l'image associée.
+
; 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.
  
−
Si omis, l'image n'est pas redimensionnée et garde sa taille d'origine.Minrating :OptionnelValeur numérique. Permet de filtrer les articles ayant une note moyenne dans les commentaires supérieure ou égale à la valeur fournie en paramètre
+
; 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 :
+
=== Variables ===
−
 
+
−
 
+
−
 
+
−
{| style="border-spacing:0;"
+
−
| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| OVArticleTitle
+
−
| style="border:0.002cm solid #000000;padding:0.097cm;"| Titre de l'article
+
  
 +
{| class="prettytable"
 +
! Variable
 +
! Valeur
 +
|-
 +
| OVArticleTitle
 +
| Titre de l'article
 
|-
 
|-
 
| OVArticleHead
 
| OVArticleHead
 
| Introduction de l'article
 
| Introduction de l'article
−
 
 
|-
 
|-
 
| OVArticleBody
 
| OVArticleBody
 
| Corps de l'article
 
| Corps de l'article
−
 
 
|-
 
|-
 
| OVArticleReadMore
 
| OVArticleReadMore
 
| 0 si l’article n’a pas de corps sinon 1
 
| 0 si l’article n’a pas de corps sinon 1
−
 
 
|-
 
|-
 
| OVArticleId
 
| OVArticleId
 
| Id de l'article
 
| Id de l'article
−
 
 
|-
 
|-
 
| OVArticleUrl
 
| OVArticleUrl
 
| Url pour atteindre le corps de l'article
 
| Url pour atteindre le corps de l'article
−
 
 
|-
 
|-
 
| OVArticleAuthor
 
| OVArticleAuthor
 
| Auteur de l'article
 
| Auteur de l'article
−
 
 
|-
 
|-
 
| OVArticleModifiedBy
 
| OVArticleModifiedBy
 
| Utilisateur responsable de la dernière modification
 
| Utilisateur responsable de la dernière modification
−
 
 
|-
 
|-
 
| OVArticleDate
 
| OVArticleDate
 
| Date de publication de l'article
 
| Date de publication de l'article
−
 
 
|-
 
|-
 
| OVArticleDateCreation
 
| OVArticleDateCreation
 
| Date de création de l'article
 
| Date de création de l'article
−
 
 
|-
 
|-
 
| OVArticleDatePublication
 
| OVArticleDatePublication
 
| Date de publication de l'article (vaut OVArticleDate)
 
| Date de publication de l'article (vaut OVArticleDate)
−
 
 
|-
 
|-
 
| OVArticleDateModification
 
| OVArticleDateModification
 
| Date de modification de l'article
 
| Date de modification de l'article
−
 
 
|-
 
|-
 
| OVArticleTopicId
 
| OVArticleTopicId
 
| Id du thème contenant l'article
 
| Id du thème contenant l'article
−
 
 
|-
 
|-
 
| OVArticleLanguage
 
| OVArticleLanguage
 
| Langue de l'article
 
| Langue de l'article
−
 
 
|-
 
|-
 
| OVArticlePopupUrl
 
| OVArticlePopupUrl
 
| Url pour afficher l’article dans une fenêtre popup
 
| Url pour afficher l’article dans une fenêtre popup
−
 
 
|-
 
|-
 
| OVArticleFiles
 
| OVArticleFiles
 
| Nombre de fichiers joints
 
| Nombre de fichiers joints
−
 
 
|-
 
|-
 
| OVArticleDelegationId
 
| 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
 
| 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
 
| OVArticleEditUrl
 
| Url pour accéder à la modification de l'article (penser à ouvrir ce lien dans une nouvelle fenêtre ou popup)
 
| Url pour accéder à la modification de l'article (penser à ouvrir ce lien dans une nouvelle fenêtre ou popup)
−
 
 
|-
 
|-
 
| OVArticleEditName
 
| OVArticleEditName
 
| Nom associé au lien pour accéder à la modification de l'article
 
| Nom associé au lien pour accéder à la modification de l'article
−
 
+
|-
 +
| OVArticleCopyUrl
 +
| Url pour accéder à la duplication de l'article (penser à ouvrir ce lien dans une nouvelle fenêtre ou popup)
 +
|-
 +
| OVArticleCopyName
 +
| Nom associé au lien pour accéder à la duplication de l'article
 
|-
 
|-
 
| OVAssociatedImage
 
| OVAssociatedImage
 
| 0 si aucune image est associée, 1 si une image est associée
 
| 0 si aucune image est associée, 1 si une image est associée
−
 
 
|-
 
|-
 
| OVImageUrl
 
| OVImageUrl
 
| Url d'affichage de l'image (à utiliser dans une balise img), tient compte des paramètres imageheightmax et imagewidthmax
 
| Url d'affichage de l'image (à utiliser dans une balise img), tient compte des paramètres imageheightmax et imagewidthmax
−
 
 
|-
 
|-
 
| OVOriginalImageUrl
 
| 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
 
| 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
 
| OVImageWidth
 
| Largeur d'origine de l'image
 
| Largeur d'origine de l'image
−
 
 
|-
 
|-
 
| OVImageHeight
 
| OVImageHeight
 
| Hauteur d'origine de l'image
 
| Hauteur d'origine de l'image
−
 
 
|-
 
|-
 
| OVResizedImageWidth
 
| OVResizedImageWidth
 
| Largeur de l'image après redimensionnement
 
| Largeur de l'image après redimensionnement
−
 
 
|-
 
|-
 
| OVResizedImageHeight
 
| OVResizedImageHeight
 
| Hauteur de l'image après redimensionnement
 
| Hauteur de l'image après redimensionnement
−
 
 
|-
 
|-
 
| OVArticleAverageRating
 
| OVArticleAverageRating
 
| Note moyenne décimale de l'article entre 1 et 5 ; 0 si aucune note. Les notes proviennent des commentaires sur l'article
 
| Note moyenne décimale de l'article entre 1 et 5 ; 0 si aucune note. Les notes proviennent des commentaires sur l'article
−
 
 
|-
 
|-
 
| OVArticleNbRating
 
| OVArticleNbRating
 
| Nombre de votes sur l'article dans les commentaires
 
| Nombre de votes sur l'article dans les commentaires
−
 
 
|}
 
|}
−
== OCRecentComments  ==
 
−
Liste les derniers commentaires d'articles.
 
  
 +
== OCRecentComments ==
  
−
<nowiki><OCRecentComments from_lastlog="" last="" articleid="">....</OCRecentComments></nowiki>
+
Liste les derniers commentaires d'articles.
  
 +
=== Syntaxe ===
  
−
Attributs :
+
<pre>
 +
<OCRecentComments last="" [articleid=""] [from_lastlog=""] [order=""] [delegationid=""]>...</OCRecentComments>
 +
</pre>
  
−
articleid :
+
=== Paramètres ===
  
−
Optionnel.
+
; last
 +
: Nombre de commentaires souhaité
  
−
* Id de l’article ou plusieurs Ids séparés par une virgule
+
; articleid ''(optionnel)''
−
* Si omis, le container liste les commentaires tous articles confondus.
+
: 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 :
+
; from_lastlog ''(optionnel)''
 +
: Indique combien de jours avant la dernière connexion de l'utilisateur
 +
: 0 ''(par défaut)'' : depuis sa dernière connexion )
  
−
Optionnel.
+
; 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
  
−
* Indique combien de jours avant la dernière connexion de l'utilisateur
+
; delegationid ''(optionnel)''
−
* ( 0 = depuis sa dernière connexion )
+
: Id de la délégation.
 +
: 0 ''(par défaut)'' : pas de filtre
  
−
last :
+
=== Variables ===
−
 
+
−
* Nombre de commentaires souhaité
+
−
 
+
−
order&nbsp;:
+
−
 
+
−
Optionnel.
+
−
 
+
−
* Asc : Ordonne les commentaires par ordre croissant en fonction de la date
+
−
* desc : Ordonne les commentaires par ordre décroissant en fonction de la date (défaut)
+
−
* rand : Ordonne les commentaires aléatoirement
+
−
 
+
−
delegationid :
+
−
 
+
−
Optionnel.
+
−
 
+
−
* Si omis ou 0 : pas de filtre
+
−
* Id de la délégation.
+
−
 
+
−
Variables :
+
−
 
+
−
 
+
−
 
+
−
{| style="border-spacing:0;"
+
−
| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| OVCommentTitle
+
−
| style="border:0.002cm solid #000000;padding:0.097cm;"| Titre du commentaire
+
  
 +
{| class="prettytable"
 +
! Variable
 +
! Valeur
 +
|-
 +
| OVCommentTitle
 +
| Titre du commentaire
 
|-
 
|-
 
| OVCommentText
 
| OVCommentText
 
| Contenu du commentaire
 
| Contenu du commentaire
−
 
 
|-
 
|-
 
| OVCommentId
 
| OVCommentId
 
| Id du commentaire
 
| Id du commentaire
−
 
 
|-
 
|-
 
| OVCommentTopicId
 
| OVCommentTopicId
 
| Id du thème contenant l'article contenant le commentaire
 
| Id du thème contenant l'article contenant le commentaire
−
 
 
|-
 
|-
 
| OVCommentArticleId
 
| OVCommentArticleId
 
| Id de l'article contenant le commentaire
 
| Id de l'article contenant le commentaire
−
 
 
|-
 
|-
 
| OVCommentDate
 
| OVCommentDate
 
| Date du commentaire
 
| Date du commentaire
−
 
 
|-
 
|-
 
| OVCommentAuthor
 
| OVCommentAuthor
 
| Auteur du commentaire
 
| Auteur du commentaire
−
 
 
|-
 
|-
 
| OVCommentUrl
 
| OVCommentUrl
 
| Url pour atteindre le commentaire
 
| Url pour atteindre le commentaire
−
 
 
|-
 
|-
 
| OVCommentLanguage
 
| OVCommentLanguage
 
| Langue du commentaire
 
| Langue du commentaire
−
 
 
|-
 
|-
 
| OVCommentPopupUrl
 
| OVCommentPopupUrl
 
| Url pour visualiser le commentaire dans une fenêtre popup
 
| Url pour visualiser le commentaire dans une fenêtre popup
−
 
 
|}
 
|}
−
== OCRecentThreads  ==
 
−
Liste les derniers fils de discussion de forums.
 
  
 +
== OCRecentThreads ==
  
−
<nowiki><OCRecentThreads from_lastlog="" last="" forumid="">....</OCRecentThreads></nowiki>
+
Liste les derniers fils de discussion de forums.
  
 +
=== Syntaxe ===
  
−
Attributs :
+
<pre>
 +
<OCRecentThreads last="" [forumid=""] [from_lastlog=""] [order=""] [delegationid=""]>...</OCRecentThreads>
 +
</pre>
  
−
forumid :
+
=== Paramètres ===
  
−
Optionnel.
+
; last
 +
: Nombre de fils de discussion souhaité
  
−
* Id du forum ou plusieurs Ids séparés par une virgule
+
; forumid ''(optionnel)''
−
* Si omis, le container liste les fils de discussion, tous forums confondus.
+
: 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 :
+
; from_lastlog ''(optionnel)''
 +
: Indique combien de jours avant la dernière connexion de l'utilisateur
 +
: 0 ''(par défaut)'' : depuis sa dernière connexion )
  
−
Optionnel.
+
; 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
  
−
* Indique combien de jours avant la dernière connexion de l'utilisateur
+
; delegationid ''(optionnel)''
−
* ( 0 = depuis sa dernière connexion )
+
: Id de la délégation.
 +
: 0 ''(par défaut)'' : pas de filtre
  
−
last :
+
=== Variables ===
−
 
+
−
* Nombre de fils de discussion souhaité
+
−
 
+
−
order&nbsp;:
+
−
 
+
−
Optionnel.
+
−
 
+
−
* Asc : Ordonne les fils de discussion par ordre croissant en fonction de la date
+
−
* desc : Ordonne les fils de discussion par ordre décroissant en fonction de la date (default)
+
−
* rand : Ordonne les fils de discussion aléatoirement
+
−
 
+
−
delegationid :
+
−
 
+
−
Optionnel.
+
−
 
+
−
* Si omis ou 0 : pas de filtre
+
−
* Id de la délégation.
+
−
 
+
−
Variables :
+
−
 
+
−
 
+
−
 
+
−
{| style="border-spacing:0;"
+
−
| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| OVPostTitle
+
−
| style="border:0.002cm solid #000000;padding:0.097cm;"| Titre de la contribution
+
  
 +
{| class="prettytable"
 +
! Variable
 +
! Valeur
 +
|-
 +
| OVPostTitle
 +
| Titre de la contribution
 
|-
 
|-
 
| OVPostText
 
| OVPostText
 
| Contenu de la contribution
 
| Contenu de la contribution
−
 
 
|-
 
|-
 
| OVPostId
 
| OVPostId
 
| Id de la contribution
 
| Id de la contribution
−
 
 
|-
 
|-
 
| OVPostThreadId
 
| OVPostThreadId
 
| Id du sujet de la contribution
 
| Id du sujet de la contribution
−
 
 
|-
 
|-
 
| OVPostForumId
 
| OVPostForumId
 
| Id du forum de la contribution
 
| Id du forum de la contribution
−
 
 
|-
 
|-
 
| OVPostAuthor
 
| OVPostAuthor
 
| Auteur de la contribution
 
| Auteur de la contribution
−
 
 
|-
 
|-
 
| OVPostDate
 
| OVPostDate
 
| Date de la contribution
 
| Date de la contribution
−
 
 
|-
 
|-
 
| OVPostUrl
 
| OVPostUrl
 
| Url pour atteindre la contribution
 
| Url pour atteindre la contribution
−
 
 
|-
 
|-
 
| OVPostPopupUrl
 
| OVPostPopupUrl
 
| Url pour visualiser la contribution dans une fenêtre popup
 
| Url pour visualiser la contribution dans une fenêtre popup
−
 
 
|-
 
|-
 
| OVPostDelegationId
 
| 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
 
| 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.
 
  
 +
== OCRecentPosts ==
  
−
<nowiki><OCRecentPosts from_lastlog="" last="" forumid="" threadid=</nowiki>""<nowiki>>....</OCRecentPosts></nowiki>
+
Liste des dernières contributions de forums.
  
 +
=== Syntaxe ===
  
−
Attributs :
+
<pre>
 +
<OCRecentPosts last="" [forumid=""] [threadid=""] [from_lastlog=""] [order=""] [delegationid=""]>...</OCRecentPosts>
 +
</pre>
  
−
forumid :
+
=== Paramètres ===
  
−
Optionnel.
+
; last
 +
: Nombre de contributions souhaité
  
−
* Id du forum ou plusieurs Ids séparés par une virgule
+
; forumid ''(optionnel)''
−
* Si omis, le container liste les dernières contributions tous forums confondus.
+
: 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 :
+
; threadid ''(optionnel)''
 +
: Id du fil de discussion
 +
: Si omis, le container liste les dernières contributions tous sujets confondus.
  
−
Optionnel.
+
; from_lastlog ''(optionnel)''
 +
: Indique combien de jours avant la dernière connexion de l'utilisateur
 +
: 0 ''(par défaut)'' : depuis sa dernière connexion
  
−
* Id du fil de discussion
+
; order ''(optionnel)''
−
* Si omis, le container liste les dernières contributions tous sujets confondus.
+
: 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
  
−
from_lastlog :
+
; delegationid ''(optionnel)''
 +
: Id de la délégation.
 +
: 0 ''(par défaut)'' : pas de filtre
  
−
Optionnel.
+
=== Variables ===
−
 
+
−
* Indique combien de jours avant la dernière connexion de l'utilisateur
+
−
* ( 0 = depuis sa dernière connexion )
+
−
 
+
−
last :
+
−
 
+
−
* Nombre de contributions souhaité
+
−
 
+
−
order&nbsp;:
+
−
 
+
−
Optionnel.
+
−
 
+
−
* Asc : Ordonne les contributions par ordre croissant en fonction de la date
+
−
* desc : Ordonne les contributions par ordre décroissant en fonction de la date (default)
+
−
* rand : Ordonne les contributions aléatoirement
+
−
 
+
−
delegationid :
+
−
 
+
−
Optionnel.
+
−
 
+
−
* Si omis ou 0 : pas de filtre
+
−
* Id de la délégation.
+
−
 
+
−
Variables :
+
−
 
+
−
 
+
−
 
+
−
{| style="border-spacing:0;"
+
−
! OVPostTitle
+
−
! Titre de la contribution
+
  
 +
{| class="prettytable"
 +
! Variable
 +
! Valeur
 +
|-
 +
| OVPostTitle
 +
| Titre de la contribution
 
|-
 
|-
 
| OVPostText
 
| OVPostText
 
| Contenu de la contribution
 
| Contenu de la contribution
−
 
 
|-
 
|-
 
| OVPostId
 
| OVPostId
 
| Id de la contribution
 
| Id de la contribution
−
 
 
|-
 
|-
 
| OVPostThreadId
 
| OVPostThreadId
 
| Id du sujet de la contribution
 
| Id du sujet de la contribution
−
 
 
|-
 
|-
 
| OVPostForumId
 
| OVPostForumId
 
| Id du forum de la contribution
 
| Id du forum de la contribution
−
 
 
|-
 
|-
 
| OVPostAuthor
 
| OVPostAuthor
 
| Auteur de la contribution
 
| Auteur de la contribution
−
 
 
|-
 
|-
 
| OVPostDate
 
| OVPostDate
 
| Date de la contribution
 
| Date de la contribution
−
 
 
|-
 
|-
 
| OVPostUrl
 
| OVPostUrl
 
| Url pour atteindre la contribution
 
| Url pour atteindre la contribution
−
 
 
|-
 
|-
 
| OVPostPopupUrl
 
| OVPostPopupUrl
 
| Url pour visualiser la contribution dans une fenêtre popup
 
| Url pour visualiser la contribution dans une fenêtre popup
−
 
 
|-
 
|-
 
| OVPostDelegationId
 
| 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
 
| 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.
 
  
 +
== OCRecentFaqQuestions ==
  
−
<nowiki><OCRecentFaqQuestions from_lastlog="" last="" faqid="" faqsubcatid="" order="" delegationid=""> ... </OCRecentFaqQuestions></nowiki>
+
Liste des dernières questions de faqs.
  
 +
=== Syntaxe ===
  
−
Attributs :
+
<pre>
 +
<OCRecentFaqQuestions last="" [faqid=""] [from_lastlog=""] [faqsubcatid=""] [order=""] [delegationid=""]>...</OCRecentFaqQuestions>
 +
</pre>
  
−
faqid :
+
=== Paramètres ===
  
−
Optionnel.
+
; last
 +
: Nombre de questions souhaité
  
−
* Id de la faq ou plusieurs Ids séparés par une virgule
+
; faqid ''(optionnel)''
−
* Si omis, le container liste les dernières questions, toutes faqs confondues
+
: 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 :
+
; from_lastlog ''(optionnel)''
 +
: Indique combien de jours avant la dernière connexion de l'utilisateur
 +
: 0 ''(par défaut)'' : depuis sa dernière connexion
  
−
Optionnel.
+
; faqsubcatid ''(optionnel)''
 +
: Id de la catégorie de faq
  
−
* Indique combien de jours avant la dernière connexion de l'utilisateur
+
; order ''(optionnel)''
−
* ( 0 = depuis sa dernière connexion )
+
: 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
  
−
last :
+
; delegationid ''(optionnel)''
 +
: Id de la délégation.
 +
: 0 ''(par défaut)'' : pas de filtre
  
−
* Nombre de questions souhaité
+
=== Variables ===
−
 
+
−
faqsubcatid :
+
−
 
+
−
Optionnel
+
−
 
+
−
* Id de la catégorie de faq
+
−
 
+
−
order&nbsp;:
+
−
 
+
−
Optionnel.
+
−
 
+
−
* Asc : Ordonne les contributions par ordre croissant en fonction de la date
+
−
* desc : Ordonne les contributions par ordre décroissant en fonction de la date (default)
+
−
* rand : Ordonne les contributions aléatoirement
+
−
 
+
−
delegationid :
+
−
 
+
−
Optionnel.
+
−
 
+
−
* Si omis ou 0 : pas de filtre
+
−
* Id de la délégation.
+
−
 
+
−
Variables :
+
−
 
+
−
 
+
−
 
+
−
{| style="border-spacing:0;"
+
−
! OVFaqQuestion
+
−
! Question
+
  
 +
{| class="prettytable"
 +
! Variable
 +
! Valeur
 +
|-
 +
| OVFaqQuestion
 +
| Question
 
|-
 
|-
 
| OVFaqResponse
 
| OVFaqResponse
 
| Réponse
 
| Réponse
−
 
 
|-
 
|-
 
| OVFaqQuestionId
 
| OVFaqQuestionId
 
| Id de la question en base de données
 
| Id de la question en base de données
−
 
 
|-
 
|-
 
| OVFaqQuestionUrl
 
| OVFaqQuestionUrl
 
| Adresse Web pour accéder à la question dans le portail
 
| Adresse Web pour accéder à la question dans le portail
−
 
 
|-
 
|-
 
| OVFaqQuestionPopupUrl
 
| OVFaqQuestionPopupUrl
 
| Adresse Web pour accéder à la question en plein écran (destiné à une vue popup)
 
| Adresse Web pour accéder à la question en plein écran (destiné à une vue popup)
−
 
 
|-
 
|-
 
| OVFaqQuestionDate
 
| OVFaqQuestionDate
 
| Date de création de la question
 
| Date de création de la question
−
 
 
|-
 
|-
 
| OVFaqQuestionAuthor
 
| OVFaqQuestionAuthor
 
| Auteur de la question
 
| Auteur de la question
−
 
 
|}
 
|}
−
== OCArticleCategories  ==
 
−
Liste des catégories de sujets.
 
  
 +
== OCArticleCategories ==
  
−
<nowiki><OCArticleCategories parentid="">....</OCArticleCategories></nowiki>
+
Liste des catégories de sujets.
  
 +
=== Syntaxe ===
  
−
Attributs :
+
<pre>
 +
<OCArticleCategories [parentid=""] [delegationid=""] [imageheightmax=""] [imagewidthmax=""]>...</OCArticleCategories>
 +
</pre>
  
−
parentid :
+
=== Paramètres ===
  
−
Optionnel.
+
; 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.
  
−
* Id de la catégorie parent ou plusieurs Ids séparés par une virgule
+
; delegationid ''(optionnel)''
−
* Si omis ou égale à 0, le container liste les catégories de thèmes à la racine.
+
: Id de la délégation.
 +
: 0 ''(par défaut)'' : pas de filtre
  
−
Delegationid :
+
; 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.
  
−
Optionnel.
+
; 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.
  
−
* Si omis ou 0 : pas de filtre
+
=== Variables ===
−
* 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 :
+
−
 
+
−
 
+
−
 
+
−
{| style="border-spacing:0;"
+
−
| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| OVCategoryName
+
−
| style="border:0.002cm solid #000000;padding:0.097cm;"| Nom de la catégorie
+
  
 +
{| class="prettytable"
 +
! Variable
 +
! Valeur
 +
|-
 +
| OVCategoryName
 +
| Nom de la catégorie
 
|-
 
|-
 
| OVCategoryDescription
 
| OVCategoryDescription
 
| Description de la catégorie
 
| Description de la catégorie
−
 
 
|-
 
|-
 
| OVCategoryId
 
| OVCategoryId
 
| Id de la catégorie
 
| Id de la catégorie
−
 
 
|-
 
|-
 
| OVCategoryParentId
 
| OVCategoryParentId
 
| Id de la catégorie parent ( 0 si pas de parent )
 
| Id de la catégorie parent ( 0 si pas de parent )
−
 
 
|-
 
|-
 
| OVTopicsUrl
 
| OVTopicsUrl
 
| Url pour atteindre les sujets de la catégorie
 
| Url pour atteindre les sujets de la catégorie
−
 
 
|-
 
|-
 
| OVCategoryDelegationId
 
| 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
 
| 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
 
| OVAssociatedImage
 
| 0 si aucune image n'est associée, 1 si une image est associée
 
| 0 si aucune image n'est associée, 1 si une image est associée
−
 
 
|-
 
|-
 
| OVImageUrl
 
| OVImageUrl
 
| Url d'affichage de l'image (à utiliser dans une balise img), tient compte des paramètres imageheightmax et imagewidthmax
 
| Url d'affichage de l'image (à utiliser dans une balise img), tient compte des paramètres imageheightmax et imagewidthmax
−
 
 
|-
 
|-
 
| OVOriginalImageUrl
 
| 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
 
| 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
 
| OVImageWidth
 
| Largeur d'origine de l'image
 
| Largeur d'origine de l'image
−
 
 
|-
 
|-
 
| OVImageHeight
 
| OVImageHeight
 
| Hauteur d'origine de l'image
 
| Hauteur d'origine de l'image
−
 
 
|-
 
|-
 
| OVResizedImageWidth
 
| OVResizedImageWidth
 
| Largeur de l'image après redimensionnement
 
| Largeur de l'image après redimensionnement
−
 
 
|-
 
|-
 
| OVResizedImageHeight
 
| OVResizedImageHeight
 
| Hauteur de l'image après redimensionnement
 
| Hauteur de l'image après redimensionnement
−
 
 
|}
 
|}
−
== OCArticleCategoryNext ==
+
 
 +
== OCArticleCategoryNext ==
 +
 
 
Ce container est valable uniquement dans le container OCArticleCategories. Il permet de récupérer les informations de l’entrée suivante.
 
Ce container est valable uniquement dans le container OCArticleCategories. Il permet de récupérer les informations de l’entrée suivante.
  
 +
=== Syntaxe ===
  
−
<nowiki><OCArticleCategoryNext>....</OCArticleCategoryNext></nowiki>
+
<pre>
 +
<OCArticleCategoryNext>...</OCArticleCategoryNext>
 +
</pre>
  
 +
=== Variables ===
  
−
Variables :
+
Idendiques à celles du container [[#OCArticleCategories|OCArticleCategories]].
  
−
Idem que ceux du container OCArticleCategories
+
== OCArticleCategoryPrevious ==
  
−
 
−
== 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.
 
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 ===
  
−
<nowiki><OCArticleCategoryPrevious>....</OCArticleCategoryPrevious></nowiki>
+
<pre>
 +
<OCArticleCategoryPrevious>...</OCArticleCategoryPrevious>
 +
</pre>
  
 +
=== Variables ===
  
−
Variables :
+
Identiques à celles du container [[#OCArticleCategories|OCArticleCategories]].
  
−
Idem que ceux du container OCArticleCategories
+
== OCParentsArticleCategory ==
  
−
== OCParentsArticleCategory  ==
 
 
Liste des catégories de sujets parents.
 
Liste des catégories de sujets parents.
  
 +
=== Syntaxe ===
  
−
<nowiki><OCParentsArticleCategory categoryid="" reverse="">....</OCParentsArticleCategory></nowiki>
+
<pre>
 +
<OCParentsArticleCategory categoryid="" [reverse=""] [imageheightmax=""] [imagewidthmax=""]>...</OCParentsArticleCategory>
 +
</pre>
  
 +
=== Paramètres ===
  
−
Attributs :
+
; categoryid
 +
: Id de la catégorie.
  
−
categoryid :
+
; 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
  
−
* Id de la catégorie.
+
; 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.
  
−
Reverse :
+
; 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.
  
−
* 1 si on souhaite la liste dans l’ordre inverse.
+
=== Variables ===
−
 
+
−
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 :
+
−
 
+
−
 
+
−
 
+
−
{| style="border-spacing:0;"
+
−
| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| OVCategoryName
+
−
| style="border:0.002cm solid #000000;padding:0.097cm;"| Nom de la catégorie
+
  
 +
{| class="prettytable"
 +
! Variable
 +
! Valeur
 +
|-
 +
| OVCategoryName
 +
| Nom de la catégorie
 
|-
 
|-
 
| OVCategoryDescription
 
| OVCategoryDescription
 
| Description de la catégorie
 
| Description de la catégorie
−
 
 
|-
 
|-
 
| OVCategoryId
 
| OVCategoryId
 
| Id de la catégorie
 
| Id de la catégorie
−
 
 
|-
 
|-
 
| OVCategoryParentId
 
| OVCategoryParentId
 
| Id de la catégorie parent ( 0 si pas de parent )
 
| Id de la catégorie parent ( 0 si pas de parent )
−
 
 
|-
 
|-
 
| OVTopicsUrl
 
| OVTopicsUrl
 
| Url pour atteindre les sujets de la catégorie
 
| Url pour atteindre les sujets de la catégorie
−
 
 
|-
 
|-
 
| OVCategoryDelegationId
 
| 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
 
| 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
 
| OVAssociatedImage
 
| 0 si aucune image n'est associée, 1 si une image est associée
 
| 0 si aucune image n'est associée, 1 si une image est associée
−
 
 
|-
 
|-
 
| OVImageUrl
 
| OVImageUrl
 
| Url d'affichage de l'image (à utiliser dans une balise img), tient compte des paramètres imageheightmax et imagewidthmax
 
| Url d'affichage de l'image (à utiliser dans une balise img), tient compte des paramètres imageheightmax et imagewidthmax
−
 
 
|-
 
|-
 
| OVOriginalImageUrl
 
| 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
 
| 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
 
| OVImageWidth
 
| Largeur d'origine de l'image
 
| Largeur d'origine de l'image
−
 
 
|-
 
|-
 
| OVImageHeight
 
| OVImageHeight
 
| Hauteur d'origine de l'image
 
| Hauteur d'origine de l'image
−
 
 
|-
 
|-
 
| OVResizedImageWidth
 
| OVResizedImageWidth
 
| Largeur de l'image après redimensionnement
 
| Largeur de l'image après redimensionnement
−
 
 
|-
 
|-
 
| OVResizedImageHeight
 
| OVResizedImageHeight
 
| Hauteur de l'image après redimensionnement
 
| Hauteur de l'image après redimensionnement
−
 
 
|}
 
|}
−
== OCArticleCategory  ==
 
−
Donne les informations sur une ou plusieurs catégorie de sujet.
 
  
−
<nowiki><OCArticleCategory categoryid="">...</OCArticleCategory></nowiki>
+
== OCArticleCategory ==
  
 +
Donne les informations sur une ou plusieurs catégorie de sujet.
  
−
Attributs :
+
=== Syntaxe ===
  
−
categoryid :
+
<pre>
 +
<OCArticleCategory categoryid="" [imageheightmax=""] [imagewidthmax=""]>...</OCArticleCategory>
 +
</pre>
  
−
Id de la catégorie ou plusieurs Ids séparés par une virgule
+
=== Paramètres ===
  
−
imageheightmax :
+
; categoryid
 +
: Id de la catégorie ou plusieurs Ids séparés par une virgule
  
−
Optionnel
+
; 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.
  
−
Valeur en pixels. Permet de préciser la hauteur maximum de l'image associée.
+
; 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.
  
−
Si omis, l'image n'est pas redimensionnée et garde sa taille d'origine.
+
=== Variables ===
−
 
+
−
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 :
+
−
 
+
−
 
+
−
 
+
−
{| style="border-spacing:0;"
+
−
| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| OVCategoryName
+
−
| style="border:0.002cm solid #000000;padding:0.097cm;"| Nom de la catégorie
+
  
 +
{| class="prettytable"
 +
! Variable
 +
! Valeur
 +
|-
 +
| OVCategoryName
 +
| Nom de la catégorie
 
|-
 
|-
 
| OVCategoryDescription
 
| OVCategoryDescription
 
| Description de la catégorie
 
| Description de la catégorie
−
 
 
|-
 
|-
 
| OVCategoryId
 
| OVCategoryId
 
| Id de la catégorie
 
| Id de la catégorie
−
 
 
|-
 
|-
 
| OVCategoryParentId
 
| OVCategoryParentId
 
| Id de la catégorie parent ( 0 si pas de parent )
 
| Id de la catégorie parent ( 0 si pas de parent )
−
 
 
|-
 
|-
 
| OVTopicsUrl
 
| OVTopicsUrl
 
| Url pour atteindre les sujets de la catégorie
 
| Url pour atteindre les sujets de la catégorie
−
 
 
|-
 
|-
 
| OVCategoryDelegationId
 
| 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
 
| 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
 
| OVAssociatedImage
 
| 0 si aucune image n'est associée, 1 si une image est associée
 
| 0 si aucune image n'est associée, 1 si une image est associée
−
 
 
|-
 
|-
 
| OVImageUrl
 
| OVImageUrl
 
| Url d'affichage de l'image (à utiliser dans une balise img), tient compte des paramètres imageheightmax et imagewidthmax
 
| Url d'affichage de l'image (à utiliser dans une balise img), tient compte des paramètres imageheightmax et imagewidthmax
−
 
 
|-
 
|-
 
| OVImageWidth
 
| OVImageWidth
 
| Largeur d'origine de l'image
 
| Largeur d'origine de l'image
−
 
 
|-
 
|-
 
| OVImageHeight
 
| OVImageHeight
 
| Hauteur d'origine de l'image
 
| Hauteur d'origine de l'image
−
 
 
|-
 
|-
 
| OVResizedImageWidth
 
| OVResizedImageWidth
 
| Largeur de l'image après redimensionnement
 
| Largeur de l'image après redimensionnement
−
 
 
|-
 
|-
 
| OVResizedImageHeight
 
| OVResizedImageHeight
 
| Hauteur de l'image après redimensionnement
 
| Hauteur de l'image après redimensionnement
−
 
 
|}
 
|}
−
== OCArticleTopics  ==
 
−
Liste des thèmes d'articles d'une catégorie donnée.
 
  
 +
== OCArticleTopics ==
  
−
<nowiki><OCArticleTopics categoryid="">....</OCArticleTopics></nowiki>
+
Liste des thèmes d'articles d'une catégorie donnée.
  
 +
=== Syntaxe ===
  
−
Attributs :
+
<pre>
 +
<OCArticleTopics categoryid="" [delegationid=""] [imageheightmax=""] [imagewidthmax=""]>...</OCArticleTopics>
 +
</pre>
  
−
categoryid :
+
=== Paramètres ===
  
−
* Id de la catégorie ou plusieurs Ids séparés par une virgule
+
; categoryid
 +
: Id de la catégorie ou plusieurs Ids séparés par une virgule
  
−
delegationid :
+
; delegationid ''(optionnel)''
 +
: 0 ''(par défaut)'' : pas de filtre
 +
: Id de la délégation.
  
−
Optionnel.
+
; 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.
  
−
* Si omis ou 0 : pas de filtre
+
; imagewidthmax ''(optionnel)''
−
* Id de la délégation.
+
: 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.
  
−
Imageheightmax :
+
=== Variables ===
−
 
+
−
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:
+
−
 
+
−
 
+
−
 
+
−
{| style="border-spacing:0;"
+
−
| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| OVTopicName
+
−
| style="border:0.002cm solid #000000;padding:0.097cm;"| Nom du thème d'articles
+
  
 +
{| class="prettytable"
 +
! Variable
 +
! Valeur
 +
|-
 +
| OVTopicName
 +
| Nom du thème d'articles
 
|-
 
|-
 
| OVTopicDescription
 
| OVTopicDescription
 
| Description du thème d'articles
 
| Description du thème d'articles
−
 
 
|-
 
|-
 
| OVTopicId
 
| OVTopicId
 
| Id du thème d'article
 
| Id du thème d'article
−
 
 
|-
 
|-
 
| OVTopicLanguage
 
| OVTopicLanguage
 
| Langue du thème
 
| Langue du thème
−
 
 
|-
 
|-
 
| OVArticlesListUrl
 
| OVArticlesListUrl
 
| Url pour atteindre la liste des articles
 
| Url pour atteindre la liste des articles
−
 
 
|-
 
|-
 
| OVTopicCategoryId
 
| OVTopicCategoryId
 
| Id de la catégorie contenant le thème d'articles
 
| Id de la catégorie contenant le thème d'articles
−
 
 
|-
 
|-
 
| OVTopicCategoryTitle
 
| OVTopicCategoryTitle
 
| Titre de la catégorie contenant le thème d'articles
 
| Titre de la catégorie contenant le thème d'articles
−
 
 
|-
 
|-
 
| OVTopicCategoryDelegationId
 
| 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
 
| 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
 
| 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)
+
| 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
 
| OVTopicSubmitName
−
| Nom associé au lien pour accéder à la création d'un nouvel article
+
| 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
 
| 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)
+
| 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
 
| OVTopicManageName
−
| Nom associé au lien pour accéder à la gestion des articles
+
| 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
 
| OVAssociatedImage
 
| 0 si aucune image n'est associée, 1 si une image est associée
 
| 0 si aucune image n'est associée, 1 si une image est associée
−
 
 
|-
 
|-
 
| OVImageUrl
 
| OVImageUrl
 
| Url d'affichage de l'image (à utiliser dans une balise img), tient compte des paramètres imageheightmax et imagewidthmax
 
| Url d'affichage de l'image (à utiliser dans une balise img), tient compte des paramètres imageheightmax et imagewidthmax
−
 
 
|-
 
|-
 
| OVOriginalImageUrl
 
| 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
 
| 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
 
| OVImageWidth
 
| Largeur d'origine de l'image
 
| Largeur d'origine de l'image
−
 
 
|-
 
|-
 
| OVImageHeight
 
| OVImageHeight
 
| Hauteur d'origine de l'image
 
| Hauteur d'origine de l'image
−
 
 
|-
 
|-
 
| OVResizedImageWidth
 
| OVResizedImageWidth
 
| Largeur de l'image après redimensionnement
 
| Largeur de l'image après redimensionnement
−
 
 
|-
 
|-
 
| OVResizedImageHeight
 
| OVResizedImageHeight
 
| Hauteur de l'image après redimensionnement
 
| Hauteur de l'image après redimensionnement
 +
|}
 +
 +
== OCArticleTopicNext ==
  
−
|}
 
−
== OCArticleTopicNext  ==
 
 
Ce container est valable uniquement dans le container OCArticleTopics. Il permet de récupérer les informations de l’entrée suivante.
 
Ce container est valable uniquement dans le container OCArticleTopics. Il permet de récupérer les informations de l’entrée suivante.
  
 +
=== Syntaxe ===
  
−
<nowiki><OCArticleTopicNext>....</OCArticleTopicNext></nowiki>
+
<pre>
 +
<OCArticleTopicNext>...</OCArticleTopicNext>
 +
</pre>
  
 +
=== Variables ===
  
−
Variables :
+
Identiques à celles du container [[#OCArticleTopics|OCArticleTopics]].
  
−
Idem que ceux du container OCArticleTopics
+
== OCArticleTopicPrevious ==
  
−
 
−
== 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.
 
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 ===
  
−
<nowiki><OCArticleTopicPrevious>....</OCArticleTopicPrevious></nowiki>
+
<pre>
 +
<OCArticleTopicPrevious>....</OCArticleTopicPrevious>
 +
</pre>
  
 +
=== Variables ===
  
−
Variables :
+
Idem que ceux du container [[#OCArticleTopics|OCArticleTopics]].
  
−
Idem que ceux du container OCArticleTopics
+
== OCArticleTopic ==
  
−
== OCArticleTopic  ==
 
 
Description d’un thème d'articles donné.
 
Description d’un thème d'articles donné.
  
 +
=== Syntaxe ===
  
−
<nowiki><OCArticleTopic topicid="">....</OCArticleTopic></nowiki>
+
<pre>
 +
<OCArticleTopic [topicid=""] [topicname=""] [imageheightmax=""] [imagewidthmax=""]>...</OCArticleTopic>
 +
</pre>
  
 +
=== Paramètres ===
  
−
Attributs :
+
; 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.
  
−
topicid :
+
; 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.
  
−
Optionnel.
+
; 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.
  
−
* Id du thème d’articles ou plusieurs Ids séparés par une virgule
+
; imagewidthmax ''(optionnel)''
−
* Si omis, le container liste tous les thèmes d’articles.
+
: 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.
  
−
topicname :
+
=== Variables ===
−
 
+
−
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.
+
−
 
+
−
Détails :
+
−
 
+
−
<nowiki><OCArticleTopic topicname="essai">...</OCArticleTopic></nowiki>Recherche tous les thèmes dont l'utilisateur a le droit et ayant pour nom "essai"<nowiki><OCArticleTopic topicid="1,2,3" topicname="essai">...</OCArticleTopic></nowiki>Recherche les thèmes d'id 1,2 3 ayant pour nom essai.<nowiki><OCArticleTopic topicid="1,2,3" topicname="</nowiki>'''%'''essai<nowiki>">...</OCArticleTopic></nowiki>Recherche les thèmes d'id 1,2 3 et dont le nom se termine par essai<nowiki><OCArticleTopic topicid="1,2,3" topicname="essai</nowiki>'''%'''<nowiki>">...</OCArticleTopic></nowiki>Recherche les thèmes d'id 1,2 3 et dont le nom commence par essai<nowiki><OCArticleTopic topicid="1,2,3" topicname="</nowiki>'''%'''essai'''%'''<nowiki>">...</OCArticleTopic></nowiki>Recherche les thèmes d'id 1,2 3 et dont le nom contient la chaîne essai
+
−
 
+
−
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 :
+
−
 
+
−
 
+
−
 
+
−
{| style="border-spacing:0;"
+
−
| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| OVTopicName
+
−
| style="border:0.002cm solid #000000;padding:0.097cm;"| Nom du thème d'articles
+
  
 +
{| class="prettytable"
 +
! Variable
 +
! Valeur
 +
|-
 +
| OVTopicName
 +
| Nom du thème d'articles
 
|-
 
|-
 
| OVTopicDescription
 
| OVTopicDescription
 
| Description du thème d'articles
 
| Description du thème d'articles
−
 
 
|-
 
|-
 
| OVTopicId
 
| OVTopicId
 
| Id du thème d'article
 
| Id du thème d'article
−
 
 
|-
 
|-
 
| OVTopicLanguage
 
| OVTopicLanguage
 
| Langue du thème
 
| Langue du thème
−
 
 
|-
 
|-
 
| OVArticlesListUrl
 
| OVArticlesListUrl
 
| Url pour atteindre la liste des articles
 
| Url pour atteindre la liste des articles
−
 
 
|-
 
|-
 
| OVTopicCategoryId
 
| OVTopicCategoryId
 
| Id de la catégorie contenant le thème d'articles
 
| Id de la catégorie contenant le thème d'articles
−
 
 
|-
 
|-
 
| OVTopicCategoryTitle
 
| OVTopicCategoryTitle
 
| Titre de la catégorie contenant le thème d'articles
 
| Titre de la catégorie contenant le thème d'articles
−
 
 
|-
 
|-
 
| OVTopicCategoryDelegationId
 
| 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
 
| 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
 
| 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)
 
| 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
 
| OVTopicSubmitName
 
| Nom associé au lien pour accéder à la création d'un nouvel article
 
| Nom associé au lien pour accéder à la création d'un nouvel article
−
 
 
|-
 
|-
 
| OVTopicManageUrl
 
| 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)
 
| 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
 
| OVTopicManageName
 
| Nom associé au lien pour accéder à la gestion des articles
 
| Nom associé au lien pour accéder à la gestion des articles
−
 
 
|-
 
|-
 
| OVAssociatedImage
 
| OVAssociatedImage
 
| 0 si aucune image est associée, 1 si une image est associée
 
| 0 si aucune image est associée, 1 si une image est associée
−
 
 
|-
 
|-
 
| OVImageUrl
 
| OVImageUrl
 
| Url d'affichage de l'image (à utiliser dans une balise img), tient compte des paramètres imageheightmax et imagewidthmax
 
| Url d'affichage de l'image (à utiliser dans une balise img), tient compte des paramètres imageheightmax et imagewidthmax
−
 
 
|-
 
|-
 
| OVOriginalImageUrl
 
| 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
 
| 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
 
| OVImageWidth
 
| Largeur d'origine de l'image
 
| Largeur d'origine de l'image
−
 
 
|-
 
|-
 
| OVImageHeight
 
| OVImageHeight
 
| Hauteur d'origine de l'image
 
| Hauteur d'origine de l'image
−
 
 
|-
 
|-
 
| OVResizedImageWidth
 
| OVResizedImageWidth
 
| Largeur de l'image après redimensionnement
 
| Largeur de l'image après redimensionnement
−
 
 
|-
 
|-
 
| OVResizedImageHeight
 
| OVResizedImageHeight
 
| Hauteur de l'image après redimensionnement
 
| Hauteur de l'image après redimensionnement
−
 
 
|}
 
|}
−
== OCArticles  ==
 
−
Liste des articles d'un thème d'articles donné.
 
  
 +
=== Exemples ===
  
−
<nowiki><OCArticles topicid="" rows="" offset="n" archive="" minrating=</nowiki>""<nowiki>>....</OCArticles></nowiki>
+
<pre>
 +
<OCArticleTopic topicname="essai">...</OCArticleTopic>
 +
</pre>
 +
Recherche tous les thèmes dont l'utilisateur a le droit et ayant pour nom "essai"
  
 +
<pre>
 +
<OCArticleTopic topicid="1,2,3" topicname="essai">...</OCArticleTopic>
 +
</pre>
 +
Recherche les thèmes d'id 1,2 3 ayant pour nom essai.
  
−
Attributs :
+
<pre>
 +
<OCArticleTopic topicid="1,2,3" topicname="%essai">...</OCArticleTopic>
 +
</pre>
 +
Recherche les thèmes d'id 1,2 3 et dont le nom se termine par essai
  
−
topicid :
+
<pre>
 +
<OCArticleTopic topicid="1,2,3" topicname="essai%">...</OCArticleTopic>
 +
</pre>
 +
Recherche les thèmes d'id 1,2 3 et dont le nom commence par essai
  
−
Optionnel.
+
<pre>
 +
<OCArticleTopic topicid="1,2,3" topicname="%essai%">...</OCArticleTopic>
 +
</pre>
 +
Recherche les thèmes d'id 1,2 3 et dont le nom contient la chaîne essai
  
−
Permet de préciser les thèmes d'articles concernés
+
== OCArticles ==
  
−
* Id du thème ou plusieurs Ids séparés par une virgule
+
Liste des articles d'un thème d'articles donné.
−
* Si omis, le container liste les articles tout thème confondu
+
  
−
excludetopicid :
+
Depuis la version 8.6.94 d'Ovidentia, les paramètres ajoutés à ce container devrait permettre de replacer OCRecentArticles, OCArticlesHomePage et OCArticle.
  
−
Optionnel.
+
=== Syntaxe ===
  
−
Permet de préciser les thèmes d'articles à exclure à la différence du paramètre topicid
+
<pre>
 +
<OCArticles [delegationid=""] [categoryid=""] [topicid=""] [articleid=""] [excludetopicid=""] [homepage="public|private"] [archive=""] [offset=""] [rows=""] [limit="[offset,]rows"] [order="asc | desc"] [orderby=""] [topicorder=""] [imageheightmax=""] [imagewidthmax=""] [minrating=""]>...</OCArticles>
 +
</pre>
  
−
* Id du thème ou plusieurs Ids séparés par une virgule
+
=== Paramètres ===
  
−
archive :
+
; delegationid ''(optionnel)''
 +
: 0 ''(par défaut)'' : pas de filtre
 +
: Id de la délégation.
  
−
Optionnel
+
; categoryid ''(optionnel)''
 +
: ''Depuis Ovidentia '''<span class="version">8.6.94</span>'''''
 +
:: Id de la catégorie, tous les thèmes enfants seront utilisés
 +
:: si categoryid est utilisé, topicid devient obsolète
  
−
* Yes : Donne la liste des articles archivés
+
; topicid ''(optionnel)''
−
* No: Donne la liste des articles non archivés
+
: Permet de préciser les thèmes d'articles concernés
−
* Si omis, liste uniquement les articles non archivé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
  
−
Offset :
+
; articleid ''(optionnel)''
 +
: ''Depuis Ovidentia '''<span class="version">8.6.94</span>'''''
 +
: Id de l’article ou plusieurs Ids séparés par une virgule
  
−
Optionnel
+
; 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
  
−
* "n" indique le nième article à partir du début de la liste
+
; homepage ''(optionnel)''
 +
: ''Depuis Ovidentia '''<span class="version">8.6.94</span>'''''
 +
: private : Liste les articles de la page d’accueil privée
 +
: public : Liste les articles de la page d’accueil publique
  
−
rows :
+
; archive ''(optionnel)''
 +
: yes : Donne la liste des articles archivés
 +
: no ''(par défaut)'' : Donne la liste des articles non archivés
  
−
Optionnel
+
; 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é
  
−
* "n" combien il faut en prendre
+
; rows ''(optionnel)''
 +
: "n" combien il faut en prendre
 +
: -1 ''(par défaut)'' : toutes les lignes sont prises
  
−
order&nbsp;:
+
; limit ''(optionnel)''
 +
: ''Depuis Ovidentia '''<span class="version">8.6.94</span>'''''
 +
: ''Alternative à rows et offset''
 +
: 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.
  
−
Optionnel.
+
; 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
  
−
* Asc : Ordonne les articles par ordre croissant en fonction de la date
+
; orderby ''(optionnel)''
−
* desc : Ordonne les articles par ordre décroissant en fonction de la date (valeur par défaut)
+
: Peut être couplé avec l'attribut order.
−
* rand : Ordonne les articles aléatoirement
+
: 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
  
−
orderby&nbsp;:
+
; 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
  
−
Optionnel, peut être couplé avec l'attribut order.
+
; 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.
  
−
* Creation : Ordonne les articles par ordre de création en fonction de la date
+
; imagewidthmax ''(optionnel)''
−
* publication : Ordonne les articles par ordre de publication en fonction de la date
+
: Valeur en pixels. Permet de préciser la largeur maximum de l'image associée.
−
* modification : Ordonne les articles par ordre de modification en fonction de la date
+
: Si omis, l'image n'est pas redimensionnée et garde sa taille d'origine.
−
* rating : Ordonne les articles en fonction de la note moyenne attribuée dans les commentaires
+
  
−
topicorder&nbsp;:
+
; 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.
  
−
Optionnel.
+
=== Variables ===
−
 
+
−
* Yes : Utilise l'ordre défini par le gestionnaire du thème d'articles
+
−
* no : N'utilise l'ordre défini par le gestionnaire du thème d'articles
+
−
 
+
−
delegationid :
+
−
 
+
−
Optionnel.
+
−
 
+
−
* Si omis ou 0 : 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 :OptionnelValeur numérique. Permet de filtrer les articles ayant une note moyenne dans les commentaires supérieure ou égale à la valeur fournie en paramètre
+
−
 
+
−
Variables :
+
−
 
+
−
 
+
−
 
+
−
{| style="border-spacing:0;"
+
−
| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| OVArticleTitle
+
−
| style="border:0.002cm solid #000000;padding:0.097cm;"| Titre de l'article
+
  
 +
{| class="prettytable"
 +
! Variable
 +
! Valeur
 +
|-
 +
| OVArticleTitle
 +
| Titre de l'article
 
|-
 
|-
 
| OVArticleHead
 
| OVArticleHead
 
| Introduction de l'article
 
| Introduction de l'article
−
 
 
|-
 
|-
 
| OVArticleBody
 
| OVArticleBody
 
| Corps de l'article
 
| Corps de l'article
−
 
 
|-
 
|-
 
| OVArticleReadMore
 
| OVArticleReadMore
 
| 0 si l’article n’a pas de corps sinon 1
 
| 0 si l’article n’a pas de corps sinon 1
−
 
 
|-
 
|-
 
| OVArticleId
 
| OVArticleId
 
| Id de l'article
 
| Id de l'article
−
 
 
|-
 
|-
 
| OVArticleUrl
 
| OVArticleUrl
 
| Url pour atteindre le corps de l'article
 
| Url pour atteindre le corps de l'article
−
 
 
|-
 
|-
 
| OVArticleAuthor
 
| OVArticleAuthor
 
| Auteur de l'article
 
| Auteur de l'article
−
 
 
|-
 
|-
 
| OVArticleModifiedBy
 
| OVArticleModifiedBy
 
| Utilisateur responsable de la dernière modification
 
| Utilisateur responsable de la dernière modification
−
 
 
|-
 
|-
 
| OVArticleDate
 
| OVArticleDate
 
| Date de publication de l'article
 
| Date de publication de l'article
−
 
 
|-
 
|-
 
| OVArticleDateCreation
 
| OVArticleDateCreation
 
| Date de création de l'article
 
| Date de création de l'article
−
 
 
|-
 
|-
 
| OVArticleDatePublication
 
| OVArticleDatePublication
 
| Date de publication de l'article (vaut OVArticleDate)
 
| Date de publication de l'article (vaut OVArticleDate)
−
 
 
|-
 
|-
 
| OVArticleDateModification
 
| OVArticleDateModification
 
| Date de modification de l'article
 
| Date de modification de l'article
−
 
+
|-
 +
| OVArticleCategoryId
 +
| Id de la catégorie du thème contenant l'article
 
|-
 
|-
 
| OVArticleTopicId
 
| OVArticleTopicId
 
| Id du thème contenant l'article
 
| Id du thème contenant l'article
−
 
 
|-
 
|-
 
| OVArticleLanguage
 
| OVArticleLanguage
 
| Langue de l'article
 
| Langue de l'article
−
 
 
|-
 
|-
 
| OVArticlePopupUrl
 
| OVArticlePopupUrl
 
| Url pour afficher l’article dans une fenêtre popup
 
| Url pour afficher l’article dans une fenêtre popup
−
 
 
|-
 
|-
 
| OVArticleFiles
 
| OVArticleFiles
 
| Nombre de fichiers joints
 
| Nombre de fichiers joints
−
 
 
|-
 
|-
 
| OVArticleEditUrl
 
| OVArticleEditUrl
−
| Url pour accéder à la modification de l'article (penser à ouvre ce lien dans une nouvelle fenêtre ou popup)
+
| Url pour accéder à la modification de l'article (penser à ouvrir ce lien dans une nouvelle fenêtre ou popup)
−
 
+
 
|-
 
|-
 
| OVArticleEditName
 
| OVArticleEditName
 
| Nom associé au lien pour accéder à la modification de l'article
 
| Nom associé au lien pour accéder à la modification de l'article
−
 
+
|-
 +
| OVArticleCopyUrl
 +
| Url pour accéder à la duplication de l'article (penser à ouvrir ce lien dans une nouvelle fenêtre ou popup)
 +
|-
 +
| OVArticleCopyName
 +
| Nom associé au lien pour accéder à la duplication de l'article
 
|-
 
|-
 
| OVAssociatedImage
 
| OVAssociatedImage
 
| 0 si aucune image est associée, 1 si une image est associée
 
| 0 si aucune image est associée, 1 si une image est associée
−
 
 
|-
 
|-
 
| OVImageUrl
 
| OVImageUrl
 
| Url d'affichage de l'image (à utiliser dans une balise img), tient compte des paramètres imageheightmax et imagewidthmax
 
| Url d'affichage de l'image (à utiliser dans une balise img), tient compte des paramètres imageheightmax et imagewidthmax
−
 
 
|-
 
|-
 
| OVOriginalImageUrl
 
| 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
 
| 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
 
| OVImageWidth
 
| Largeur d'origine de l'image
 
| Largeur d'origine de l'image
−
 
 
|-
 
|-
 
| OVImageHeight
 
| OVImageHeight
 
| Hauteur d'origine de l'image
 
| Hauteur d'origine de l'image
−
 
 
|-
 
|-
 
| OVResizedImageWidth
 
| OVResizedImageWidth
 
| Largeur de l'image après redimensionnement
 
| Largeur de l'image après redimensionnement
−
 
 
|-
 
|-
 
| OVResizedImageHeight
 
| OVResizedImageHeight
 
| Hauteur de l'image après redimensionnement
 
| Hauteur de l'image après redimensionnement
−
 
 
|-
 
|-
 
| OVArticleAverageRating
 
| OVArticleAverageRating
 
| Note moyenne décimale de l'article entre 1 et 5 ; 0 si aucune note. Les notes proviennent des commentaires sur l'article
 
| Note moyenne décimale de l'article entre 1 et 5 ; 0 si aucune note. Les notes proviennent des commentaires sur l'article
−
 
 
|-
 
|-
 
| OVArticleNbRating
 
| OVArticleNbRating
 
| Nombre de votes sur l'article dans les commentaires
 
| Nombre de votes sur l'article dans les commentaires
−
 
 
|}
 
|}
−
== OCArticleNext ==
+
 
 +
== OCArticleNext ==
 +
 
 
Ce container est valable uniquement dans le container OCArticles. Il permet de récupérer les informations de l’entrée suivante.
 
Ce container est valable uniquement dans le container OCArticles. Il permet de récupérer les informations de l’entrée suivante.
  
 +
=== Syntaxe ===
  
−
<nowiki><OCArticleNext>....</OCArticleNext></nowiki>
+
<pre>
 +
<OCArticleNext>...</OCArticleNext>
 +
</pre>
  
 +
=== Variables ===
  
−
Variables :
+
Identiques à celles du container [[#OCArticles|OCArticles]].
  
−
Idem que ceux du container OCArticles.
+
== OCArticlePrevious ==
  
−
== 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.
 
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 ===
  
−
<nowiki><OCArticlePrevious>....</OCArticlePrevious></nowiki>
+
<pre>
 +
<OCArticlePrevious>...</OCArticlePrevious>
 +
</pre>
  
 +
=== Variables ===
  
−
Variables :
+
Identiques à celles du container [[#OCArticles|OCArticles]].
  
−
Idem que ceux du container OCArticles.
+
== OCArticle ==
  
−
 
−
== OCArticle  ==
 
 
Donne les informations sur un article donné.
 
Donne les informations sur un article donné.
  
 +
=== Syntaxe ===
  
−
<nowiki><OCArticle articleid="">....</OCArticle></nowiki>
+
<pre>
 +
<OCArticle articleid="" [imageheightmax=""] [imagewidthmax=""]>...</OCArticle>
 +
</pre>
  
 +
=== Paramètres ===
  
−
Attributs&nbsp;:
+
; articleid
 +
: Id de l’article ou plusieurs Ids séparés par une virgule
  
−
articleid :
+
; 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.
  
−
* Id de l’article ou plusieurs Ids séparés par une virgule
+
; 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.
  
−
imageheightmax :
+
=== Variables ===
−
 
+
−
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 :
+
−
 
+
−
 
+
−
 
+
−
{| style="border-spacing:0;"
+
−
| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| OVArticleTitle
+
−
| style="border:0.002cm solid #000000;padding:0.097cm;"| Titre de l'article
+
  
 +
{| class="prettytable"
 +
! Variable
 +
! Valeur
 +
|-
 +
| OVArticleTitle
 +
| Titre de l'article
 
|-
 
|-
 
| OVArticleHead
 
| OVArticleHead
 
| Introduction de l'article
 
| Introduction de l'article
−
 
 
|-
 
|-
 
| OVArticleBody
 
| OVArticleBody
 
| Corps de l'article
 
| Corps de l'article
−
 
 
|-
 
|-
 
| OVArticleReadMore
 
| OVArticleReadMore
 
| 0 si l’article n’a pas de corps sinon 1
 
| 0 si l’article n’a pas de corps sinon 1
−
 
 
|-
 
|-
 
| OVArticleId
 
| OVArticleId
 
| Id de l'article
 
| Id de l'article
−
 
 
|-
 
|-
 
| OVArticleUrl
 
| OVArticleUrl
 
| Url pour atteindre le corps de l'article
 
| Url pour atteindre le corps de l'article
−
 
 
|-
 
|-
 
| OVArticleAuthor
 
| OVArticleAuthor
 
| Auteur de l'article
 
| Auteur de l'article
−
 
 
|-
 
|-
 
| OVArticleModifiedBy
 
| OVArticleModifiedBy
 
| Utilisateur responsable de la dernière modification
 
| Utilisateur responsable de la dernière modification
−
 
 
|-
 
|-
 
| OVArticleDate
 
| OVArticleDate
 
| Date de publication de l'article
 
| Date de publication de l'article
−
 
 
|-
 
|-
 
| OVArticleDateCreation
 
| OVArticleDateCreation
 
| Date de création de l'article
 
| Date de création de l'article
−
 
 
|-
 
|-
 
| OVArticleDatePublication
 
| OVArticleDatePublication
 
| Date de publication de l'article (vaut OVArticleDate)
 
| Date de publication de l'article (vaut OVArticleDate)
−
 
 
|-
 
|-
 
| OVArticleDateModification
 
| OVArticleDateModification
 
| Date de modification de l'article
 
| Date de modification de l'article
−
 
 
|-
 
|-
 
| OVArticleTopicId
 
| OVArticleTopicId
 
| Id du thème contenant l'article
 
| Id du thème contenant l'article
−
 
 
|-
 
|-
 
| OVArticleLanguage
 
| OVArticleLanguage
 
| Langue de l'article
 
| Langue de l'article
−
 
 
|-
 
|-
 
| OVArticlePopupUrl
 
| OVArticlePopupUrl
 
| Url pour afficher l’article dans une fenêtre popup
 
| Url pour afficher l’article dans une fenêtre popup
−
 
 
|-
 
|-
 
| OVArticleFiles
 
| OVArticleFiles
 
| Nombre de fichiers joints
 
| Nombre de fichiers joints
−
 
 
|-
 
|-
 
| OVArticleEditUrl
 
| OVArticleEditUrl
−
| Url pour accéder à la modification de l'article (penser à ouvre ce lien dans une nouvelle fenêtre ou popup)
+
| Url pour accéder à la modification de l'article (penser à ouvrir ce lien dans une nouvelle fenêtre ou popup)
−
 
+
 
|-
 
|-
 
| OVArticleEditName
 
| OVArticleEditName
 
| Nom associé au lien pour accéder à la modification de l'article
 
| Nom associé au lien pour accéder à la modification de l'article
−
 
+
|-
 +
| OVArticleCopyUrl
 +
| Url pour accéder à la duplication de l'article (penser à ouvrir ce lien dans une nouvelle fenêtre ou popup)
 +
|-
 +
| OVArticleCopyName
 +
| Nom associé au lien pour accéder à la duplication de l'article
 
|-
 
|-
 
| OVAssociatedImage
 
| OVAssociatedImage
 
| 0 si aucune image est associée, 1 si une image est associée
 
| 0 si aucune image est associée, 1 si une image est associée
−
 
 
|-
 
|-
 
| OVImageUrl
 
| OVImageUrl
 
| Url d'affichage de l'image (à utiliser dans une balise img), tient compte des paramètres imageheightmax et imagewidthmax
 
| Url d'affichage de l'image (à utiliser dans une balise img), tient compte des paramètres imageheightmax et imagewidthmax
−
 
 
|-
 
|-
 
| OVOriginalImageUrl
 
| 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
 
| 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
 
| OVImageWidth
 
| Largeur d'origine de l'image
 
| Largeur d'origine de l'image
−
 
 
|-
 
|-
 
| OVImageHeight
 
| OVImageHeight
 
| Hauteur d'origine de l'image
 
| Hauteur d'origine de l'image
−
 
 
|-
 
|-
 
| OVResizedImageWidth
 
| OVResizedImageWidth
 
| Largeur de l'image après redimensionnement
 
| Largeur de l'image après redimensionnement
−
 
 
|-
 
|-
 
| OVResizedImageHeight
 
| OVResizedImageHeight
 
| Hauteur de l'image après redimensionnement
 
| Hauteur de l'image après redimensionnement
−
 
 
|-
 
|-
 
| OVArticleAverageRating
 
| OVArticleAverageRating
 
| Note moyenne décimale de l'article entre 1 et 5 ; 0 si aucune note. Les notes proviennent des commentaires sur l'article
 
| Note moyenne décimale de l'article entre 1 et 5 ; 0 si aucune note. Les notes proviennent des commentaires sur l'article
−
 
 
|-
 
|-
 
| OVArticleNbRating
 
| OVArticleNbRating
 
| Nombre de votes sur l'article dans les commentaires
 
| Nombre de votes sur l'article dans les commentaires
−
 
 
|}
 
|}
−
== OCArticleFiles  ==
 
−
Donne les informations sur les fichiers joints à un article donné.
 
  
 +
== OCArticleFiles ==
  
−
<nowiki><OCArticleFiles articleid="">....</OCArticleFiles></nowiki>
+
Donne les informations sur les fichiers joints à un article donné.
  
 +
=== Syntaxe ===
  
−
Attributs :
+
<pre>
 +
<OCArticleFiles articleid="">...</OCArticleFiles>
 +
</pre>
  
−
articleid :
+
=== Paramètres ===
  
−
* Id de l’article ou plusieurs Ids séparés par une virgule
+
; articleid
 +
: Id de l’article ou plusieurs Ids séparés par une virgule
  
−
Variables :
+
=== Variables ===
−
 
+
−
 
+
−
 
+
−
{| style="border-spacing:0;"
+
−
| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| OVArticleFileName
+
−
| style="border:0.002cm solid #000000;padding:0.097cm;"| Nom du fichier
+
  
 +
{| class="prettytable"
 +
! Variable
 +
! Valeur
 +
|-
 +
| OVArticleFileName
 +
| Nom du fichier
 
|-
 
|-
 
| OVArticleFileDescription
 
| OVArticleFileDescription
 
| Description du fichier
 
| Description du fichier
−
 
 
|-
 
|-
 
| OVArticleFileUrlGet
 
| OVArticleFileUrlGet
 
| Url pour atteindre le fichier
 
| Url pour atteindre le fichier
−
 
 
|}
 
|}
−
== OCForums  ==
 
−
Liste des forums.
 
  
 +
== OCForums ==
  
−
<nowiki><OCForums forumid=" ">....</OCForums></nowiki>
+
Liste des forums.
  
 +
=== Syntaxe ===
  
−
Attributs :
+
<pre>
 +
<OCForums [forumid=""] [delegationid=""]>...</OCForums>
 +
</pre>
  
−
forumid :
+
=== Paramètres ===
  
−
Optionnel.
+
; forumid ''(optionnel)''
 +
: Id du forum ou plusieurs Ids séparés par une virgule
 +
: Si omis, le container liste tous les forums.
  
−
* Id du forum ou plusieurs Ids séparés par une virgule
+
; delegationid ''(optionnel)''
−
* Si omis, le container liste tous les forums.
+
: 0 ''(par défaut)'' : pas de filtre
 +
: Id de la délégation.
  
−
Delegationid :
+
=== Variables ===
−
 
+
−
Optionnel.
+
−
 
+
−
* Si omis ou 0 : pas de filtre
+
−
* Id de la délégation.
+
−
 
+
−
Variables :
+
−
 
+
−
 
+
−
 
+
−
{| style="border-spacing:0;"
+
−
| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| OVForumName
+
−
| style="border:0.002cm solid #000000;padding:0.097cm;"| Nom du forum
+
  
 +
{| class="prettytable"
 +
! Variable
 +
! Valeur
 +
|-
 +
| OVForumName
 +
| Nom du forum
 
|-
 
|-
 
| OVForumDescription
 
| OVForumDescription
 
| Description du forum
 
| Description du forum
−
 
 
|-
 
|-
 
| OVForumId
 
| OVForumId
 
| Id du forum
 
| Id du forum
−
 
 
|-
 
|-
 
| OVForumUrl
 
| OVForumUrl
 
| Url pour atteindre le forum
 
| Url pour atteindre le forum
−
 
 
|-
 
|-
 
| OVForumDelegationId
 
| 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
 
| 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 ==
+
 
 +
== OCForumNext ==
 +
 
 
Ce container est valable uniquement dans le container OCForums. Il permet de récupérer les informations de l’entrée suivante.
 
Ce container est valable uniquement dans le container OCForums. Il permet de récupérer les informations de l’entrée suivante.
  
 +
=== Syntaxe ===
  
−
<nowiki><OCForumNext>....</OCForumNext></nowiki>
+
<pre>
 +
<OCForumNext>...</OCForumNext>
 +
</pre>
  
 +
=== Variables ===
  
−
Variables :
+
Identiques à celles du container [[#OCForums|OCForums]].
  
−
Idem que ceux du container OCForums.
+
== OCForumPrevious ==
  
−
== 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.
 
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 ===
  
−
<nowiki><OCForumPrevious>....</OCForumPrevious></nowiki>
+
<pre>
 +
<OCForumPrevious>...</OCForumPrevious>
 +
</pre>
  
 +
=== Variables ===
  
−
Variables :
+
Identiques à celles du container [[#OCForums|OCForums]].
  
−
Idem que ceux du container OCForums.
+
== OCForum ==
  
−
 
−
== OCForum  ==
 
 
Donne les informations sur un forum donné.
 
Donne les informations sur un forum donné.
  
 +
=== Syntaxe ===
  
−
<nowiki><OCForum forumid="">....</OCForum></nowiki>
+
<pre>
 +
<OCForum forumid="">...</OCForum>
 +
</pre>
  
 +
=== Paramètres ===
  
−
Attributs :
+
; forumid :
 +
: Id du forum
  
−
forumid :
+
=== Variables ===
−
 
+
−
* Id du forum
+
−
 
+
−
Variables :
+
−
 
+
−
 
+
−
 
+
−
{| style="border-spacing:0;"
+
−
| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| OVForumName
+
−
| style="border:0.002cm solid #000000;padding:0.097cm;"| Nom du forum
+
  
 +
{| class="prettytable"
 +
! Variable
 +
! Valeur
 +
|-
 +
| OVForumName
 +
| Nom du forum
 
|-
 
|-
 
| OVForumDescription
 
| OVForumDescription
 
| Description du forum
 
| Description du forum
−
 
 
|-
 
|-
 
| OVForumId
 
| OVForumId
 
| Id du forum
 
| Id du forum
−
 
 
|-
 
|-
 
| OVForumUrl
 
| OVForumUrl
 
| Url pour atteindre le forum
 
| Url pour atteindre le forum
−
 
 
|-
 
|-
 
| OVForumDelegationId
 
| 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
 
| 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é.
 
  
 +
== OCThread ==
  
−
<nowiki><OCThread threadid="">....</OCThread></nowiki>
+
Donne les informations sur un fil de discussion donné.
  
 +
=== Syntaxe ===
  
−
Attributs :
+
<pre>
 +
<OCThread threadid="" [order=""]>...</OCThread>
 +
</pre>
  
−
threadid :
+
=== Paramètres ===
  
−
* Id du forum
+
; threadid
 +
: Id du forum
  
−
order :
+
; 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
  
−
Optionnel.
+
=== Variables ===
−
 
+
−
* Asc : Ordonne les fils de discussion par ordre croissant en fonction de la date
+
−
* desc : Ordonne les fils de discussion par ordre décroissant en fonction de la date (default)
+
−
* rand : Ordonne les fils de discussion aléatoirement
+
−
 
+
−
Variables :
+
−
 
+
−
 
+
−
 
+
−
{| style="border-spacing:0;"
+
−
| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| OVThreadForumId
+
−
| style="border:0.002cm solid #000000;padding:0.097cm;"| Id du forum contenant le fil de discussion
+
  
 +
{| class="prettytable"
 +
! Variable
 +
! Valeur
 +
|-
 +
| OVThreadForumId
 +
| Id du forum contenant le fil de discussion
 
|-
 
|-
 
| OVThreadId
 
| OVThreadId
 
| Id du sujet du fil de discussion
 
| Id du sujet du fil de discussion
−
 
 
|-
 
|-
 
| OVThreadPostId
 
| OVThreadPostId
 
| Id de la contribution initiale
 
| Id de la contribution initiale
−
 
 
|-
 
|-
 
| OVThreadLastPostId
 
| OVThreadLastPostId
 
| Id de la dernière contribution
 
| Id de la dernière contribution
−
 
 
|-
 
|-
 
| OVThreadDate
 
| OVThreadDate
 
| Date de la création du fil de discussion
 
| Date de la création du fil de discussion
−
 
 
|-
 
|-
 
| OVThreadStarter
 
| OVThreadStarter
 
| Nom du l'initiateur du sujet
 
| Nom du l'initiateur du sujet
−
 
 
|-
 
|-
 
| OVThreadStarterId
 
| OVThreadStarterId
 
| ID de l'utilisateur ayant initié le sujet ( peut être égal à 0 s'il s'agit d'un utilisateur anonyme)  
 
| ID de l'utilisateur ayant initié le sujet ( peut être égal à 0 s'il s'agit d'un utilisateur anonyme)  
−
 
 
|-
 
|-
 
| OVThreadUrl
 
| OVThreadUrl
 
| Url pour atteindre la contribution
 
| Url pour atteindre la contribution
−
 
 
|}
 
|}
−
== OCPost  ==
 
−
Donne les informations sur une contribution donnée ou plusieurs séparées par des virgules.
 
  
 +
== OCPost ==
  
−
<nowiki><OCPost postid="">....</OCPost></nowiki>
+
Donne les informations sur une contribution donnée ou plusieurs séparées par des virgules.
  
 +
=== Syntaxe ===
  
−
Attributs :
+
<pre>
 +
<OCPost postid="" [order=""]>...</OCPost>
 +
</pre>
  
−
postid :
+
=== Paramètres ===
  
−
* Id de la contribution ou plusieurs Ids séparés par des virgules
+
; postid :
 +
: Id de la contribution ou plusieurs Ids séparés par des virgules
  
−
order :
+
; 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
  
−
Optionnel.
+
=== Variables ===
−
 
+
−
* Asc : Ordonne les commentaires par ordre croissant en fonction de la date
+
−
* desc : Ordonne les commentaires par ordre décroissant en fonction de la date (default)
+
−
* rand : Ordonne les commentaires aléatoirement
+
−
 
+
−
Variables :
+
−
 
+
−
 
+
−
 
+
−
{| style="border-spacing:0;"
+
−
| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| OVPostTitle
+
−
| style="border:0.002cm solid #000000;padding:0.097cm;"| Titre de la contribution
+
  
 +
{| class="prettytable"
 +
! Variable
 +
! Valeur
 +
|-
 +
| OVPostTitle
 +
| Titre de la contribution
 
|-
 
|-
 
| OVPostText
 
| OVPostText
 
| Contenu de la contribution
 
| Contenu de la contribution
−
 
 
|-
 
|-
 
| OVPostId
 
| OVPostId
 
| Id de la contribution
 
| Id de la contribution
−
 
 
|-
 
|-
 
| OVPostThreadId
 
| OVPostThreadId
 
| Id du fil de la discussion
 
| Id du fil de la discussion
−
 
 
|-
 
|-
 
| OVPostForumId
 
| OVPostForumId
 
| Id du forum
 
| Id du forum
−
 
 
|-
 
|-
 
| OVPostAuthor
 
| OVPostAuthor
 
| Auteur de la contribution
 
| Auteur de la contribution
−
 
 
|-
 
|-
 
| OVPostAuthorId
 
| OVPostAuthorId
 
| ID de l'auteur (peut être égal à 0 si l'auteur était un utilisateur anoyme)
 
| ID de l'auteur (peut être égal à 0 si l'auteur était un utilisateur anoyme)
−
 
 
|-
 
|-
 
| OVPostDate
 
| OVPostDate
 
| Date de la contribution
 
| Date de la contribution
−
 
 
|-
 
|-
 
| OVPostUrl
 
| OVPostUrl
 
| Url pour atteindre la contribution
 
| Url pour atteindre la contribution
−
 
 
|-
 
|-
 
| OVPostPopupUrl
 
| OVPostPopupUrl
 
| Url pour visualiser la contribution à l'aide d'une fenêtre popup
 
| Url pour visualiser la contribution à l'aide d'une fenêtre popup
−
 
 
|-
 
|-
 
| OVPostReplyUrl
 
| OVPostReplyUrl
 
| Url pour répondre (sinon vide si pas de droit)  
 
| Url pour répondre (sinon vide si pas de droit)  
−
 
 
|-
 
|-
 
| OVPostModifyUrl
 
| OVPostModifyUrl
 
| Url pour modifier (sinon vide si pas de droit)  
 
| Url pour modifier (sinon vide si pas de droit)  
−
 
 
|-
 
|-
 
| OVPostConfirmUrl
 
| OVPostConfirmUrl
 
| Url pour confirmer (sinon vide si pas de droit)  
 
| Url pour confirmer (sinon vide si pas de droit)  
−
 
 
|-
 
|-
 
| OVPostDeleteUrl
 
| OVPostDeleteUrl
 
| Url pour supprimer la contribution (sinon vide si pas de droit)  
 
| Url pour supprimer la contribution (sinon vide si pas de droit)  
−
 
 
|}
 
|}
−
== OCPostFiles  ==
 
−
Donne les informations de fichiers sur une contribution donnée.
 
  
 +
== OCPostFiles ==
  
−
<nowiki><OCPostFiles postid="">....</OCPost></nowiki>
+
Donne les informations de fichiers sur une contribution donnée.
  
 +
=== Syntaxe ===
  
−
Attributs :
+
<pre>
 +
<OCPostFiles postid="">...</OCPost>
 +
</pre>
  
−
postid :
+
=== Paramètres ===
  
−
* Id de la contribution<br/>  
+
; postid
 +
: Id de la contribution<br/>  
  
 +
=== Variables ===
  
−
Variables :
+
{| class="prettytable"
−
 
+
! Variable
−
 
+
! Valeur
−
 
+
|-
−
{| style="border-spacing:0;"
+
| OVPostFileName
−
| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| OVPostFileName
+
| Nom du fichier
−
| style="border:0.002cm solid #000000;padding:0.097cm;"| Nom du fichier
+
−
 
+
 
|-
 
|-
 
| OVPostFileUrlGet
 
| OVPostFileUrlGet
 
| Url pour atteindre le fichier
 
| Url pour atteindre le fichier
−
 
 
|}
 
|}
−
== OCFolders  ==
 
−
Liste les répertoires partageables.
 
  
 +
== OCFolders ==
  
−
<nowiki><OCFolders folderid=" ">....</OCFolders></nowiki>
+
Liste les répertoires partageables.
  
 +
=== Syntaxe ===
  
−
Attributs :
+
<pre>
 +
<OCFolders [folderid=""] [delegationid=""]>...</OCFolders>
 +
</pre>
  
−
folderid :
+
=== Paramètres ===
  
−
Optionnel.
+
; 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.
  
−
* Id du répertoire ou plusieurs Ids séparés par une virgule
+
; delegationid ''(optionnel)''
−
* Si omis, le container liste tous les répertoires partageables.
+
: 0 ''(par défaut)'' : pas de filtre
 +
: Id de la délégation.
  
−
Delegationid :
+
=== Variables ===
−
 
+
−
Optionnel.
+
−
 
+
−
* Si omis ou 0 : pas de filtre
+
−
* Id de la délégation.
+
−
 
+
−
Variables :
+
−
 
+
−
 
+
−
 
+
−
{| style="border-spacing:0;"
+
−
| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| OVFolderName
+
−
| style="border:0.002cm solid #000000;padding:0.097cm;"| Nom du répertoire
+
  
 +
{| class="prettytable"
 +
! Variable
 +
! Valeur
 +
|-
 +
| OVFolderName
 +
| Nom du répertoire
 
|-
 
|-
 
| OVFolderId
 
| OVFolderId
 
| Id du répertoire
 
| Id du répertoire
−
 
 
|-
 
|-
 
| OVFolderDelegationId
 
| 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
 
| 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
 
| OVFolderPath
 
| Chemin du répertoire à partir du répertoire racine (sans le nom du répertoire courant)
 
| Chemin du répertoire à partir du répertoire racine (sans le nom du répertoire courant)
−
 
 
|-
 
|-
 
| OVFolderPathname
 
| OVFolderPathname
 
| Chemin du répertoire à partir du répertoire racine (avec le nom du répertoire courant)
 
| Chemin du répertoire à partir du répertoire racine (avec le nom du répertoire courant)
−
 
 
|-
 
|-
 
| OVFolderBrowseUrl
 
| OVFolderBrowseUrl
 
| Url d'accès au répertoire dans l'interface du gestionnaire de fichiers
 
| Url d'accès au répertoire dans l'interface du gestionnaire de fichiers
−
 
 
|}
 
|}
−
== OCFolderNext ==
+
 
 +
== OCFolderNext ==
 +
 
 
Ce container est valable uniquement dans le container OCFolders. Il permet de récupérer les informations de l’entrée suivante.
 
Ce container est valable uniquement dans le container OCFolders. Il permet de récupérer les informations de l’entrée suivante.
  
 +
=== Syntaxe ===
  
−
<nowiki><OCFolderNext>....</OCFolderNext></nowiki>
+
<pre>
 +
<OCFolderNext>...</OCFolderNext>
 +
</pre>
  
 +
=== Variables ===
  
−
Variables :
+
Identique à celles du container [[#OCFolders|OCFolders]].
  
−
Idem que ceux du container OCFolders.
+
== OCFolderPrevious ==
  
−
== 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.
 
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 ===
  
−
<nowiki><OCFolderPrevious>....</OCFolderPrevious></nowiki>
+
<pre>
 +
<OCFolderPrevious>...</OCFolderPrevious>
 +
</pre>
  
 +
=== Variables ===
  
−
Variables :
+
Identique à celles du container [[#OCFolders|OCFolders]].
  
−
Idem que ceux du container OCFolders.
+
== OCFolder ==
  
−
 
−
== OCFolder  ==
 
 
Donne les information sur un répertoire partageable donné.
 
Donne les information sur un répertoire partageable donné.
  
 +
=== Syntaxe ===
  
−
<nowiki><OCFolder folderid=" ">....</OCFolder></nowiki>
+
<pre>
 +
<OCFolder folderid="">...</OCFolder>
 +
</pre>
  
 +
=== Paramètres ===
  
−
Attributs :
+
; folderid
 +
: Id du répertoire
  
−
folderid :
+
=== Variables ===
−
 
+
−
* Id du répertoire
+
−
 
+
−
Variables :
+
−
 
+
−
 
+
−
 
+
−
{| style="border-spacing:0;"
+
−
| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| OVFolderName
+
−
| style="border:0.002cm solid #000000;padding:0.097cm;"| Nom du répertoire
+
  
 +
{| class="prettytable"
 +
! Variable
 +
! Valeur
 +
|-
 +
| OVFolderName
 +
| Nom du répertoire
 
|-
 
|-
 
| OVFolderId
 
| OVFolderId
 
| Id du répertoire
 
| Id du répertoire
−
 
 
|-
 
|-
 
| OVFolderDelegationId
 
| 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
 
| 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
 
| OVFolderPath
 
| Chemin du répertoire à partir du répertoire racine (sans le nom du répertoire courant)
 
| Chemin du répertoire à partir du répertoire racine (sans le nom du répertoire courant)
−
 
 
|-
 
|-
 
| OVFolderPathname
 
| OVFolderPathname
 
| Chemin du répertoire à partir du répertoire racine (avec le nom du répertoire courant)
 
| Chemin du répertoire à partir du répertoire racine (avec le nom du répertoire courant)
−
 
 
|-
 
|-
 
| OVFolderBrowseUrl
 
| OVFolderBrowseUrl
 
| Url d'accès au répertoire dans l'interface du gestionnaire de fichiers
 
| 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é.
 
  
 +
== OCSubFolders ==
  
−
<nowiki><OCSubFolders folderid="" path="" order="">....</OCSubFolders></nowiki>
+
Liste les sous-répertoires du répertoire path d'un répertoire partageable donné.
  
 +
=== Syntaxe ===
  
−
Attributs :
+
<pre>
 +
<OCSubFolders folderid="" [path=""] [order=""]>...</OCSubFolders>
 +
</pre>
  
−
folderid :
+
=== Paramètres ===
  
−
* Id du répertoire
+
; folderid
 +
: Id du répertoire
  
−
path :
+
; 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
  
−
Optionnel
+
; order ''(optionnel)''
 +
: asc ''(par défaut)'' : ordonne par ordre croissant
 +
: desc : ordonne par ordre décroissant
  
−
* Chemin du répertoire par rapport au répertoire partageable
+
=== Variables ===
−
* Si omis, le container liste les sous-répertoire du répertoire partageable
+
−
 
+
−
order :
+
−
 
+
−
Optionnel
+
−
 
+
−
* asc : ordonne par ordre croissant
+
−
* desc : ordonne par ordre décroissant
+
−
 
+
−
Variables :
+
−
 
+
−
 
+
−
 
+
−
{| style="border-spacing:0;"
+
−
| style="border-top:0.002cm solid #000000;border-bottom:none;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| OVSubFolderName
+
−
| style="border-top:0.002cm solid #000000;border-bottom:none;border-left:0.002cm solid #000000;border-right:0.002cm solid #000000;padding:0.097cm;"| Nom du sous répertoire
+
  
 +
{| class="prettytable"
 +
! Variable
 +
! Valeur
 +
|-
 +
| OVSubFolderName
 +
| Nom du sous répertoire
 
|-
 
|-
 
| OVSubFolderPath
 
| OVSubFolderPath
 
| Chemin du répertoire à partir du répertoire racine (sans le nom du répertoire courant)
 
| Chemin du répertoire à partir du répertoire racine (sans le nom du répertoire courant)
−
 
 
|-
 
|-
 
| OVSubFolderPathname
 
| OVSubFolderPathname
 
| Chemin du répertoire à partir du répertoire racine (avec le nom du répertoire courant)
 
| Chemin du répertoire à partir du répertoire racine (avec le nom du répertoire courant)
−
 
 
|-
 
|-
 
| OVSubFolderBrowseUrl
 
| OVSubFolderBrowseUrl
 
| Url d'accès au répertoire dans l'interface du gestionnaire de fichiers
 
| 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é.
 
  
 +
== OCFiles ==
  
−
<nowiki><OCFiles folderid="" path="" rows="" offset="">....</OCFiles></nowiki>
+
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...) :
  
−
Attributs :
+
'''Exemple :'''
 +
<pre>
 +
<a href="<OVFileUrl&gt;&inl=1"><OVFileName></a>
 +
</pre>
  
−
folderid :
+
=== Syntaxe ===
  
−
* Id du répertoire
+
<pre>
 +
<OCFiles folderid="" rows="" offset="" [path=""] [orderby=""] [order=""]>...</OCFiles>
 +
</pre>
  
−
path :
+
=== Paramètres ===
  
−
Optionnel
+
; folderid
 +
: Id du répertoire
  
−
* Chemin du répertoire par rapport au répertoire partageable
+
; offset
−
* Si omis, le container liste les fichiers du répertoire partageable
+
: "n" indique le nième fichier à partir du début de la liste
  
−
offset :
+
; rows
 +
: "n" combien il faut en prendre
  
−
* "n" indique le nième fichier à partir du début de la liste
+
; path ''(optionnel)''
 +
: Chemin du répertoire par rapport au répertoire partageable
 +
: Si omis, le container liste les fichiers du répertoire partageable
  
−
rows :
+
; order ''(optionnel)''
 +
: ''Depuis Ovidentia '''<span class="version">8.0.91</span>'''''
 +
: En lien avec l'attribut orderby.
 +
:* asc ''(par défaut)'' : Ordonne les fichiers par ordre croissant
 +
:* desc : Ordonne les fichiers par ordre décroissant
  
−
* "n" combien il faut en prendre
+
; orderby ''(optionnel)''
 +
:''Depuis Ovidentia '''<span class="version">8.0.91</span>'''''
 +
: 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 :
+
=== Variables ===
−
 
+
−
 
+
−
 
+
−
{| style="border-spacing:0;"
+
−
| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| OVFileName
+
−
| style="border:0.002cm solid #000000;padding:0.097cm;"| Nom du fichier
+
  
 +
{| class="prettytable"
 +
! Variable
 +
! Valeur
 +
|-
 +
| OVFileName
 +
| Nom du fichier
 
|-
 
|-
 
| OVFileDescription
 
| OVFileDescription
 
| Description du fichier
 
| Description du fichier
−
 
 
|-
 
|-
 
| OVFileKeywords
 
| OVFileKeywords
 
| Les mots clés du fichier  
 
| Les mots clés du fichier  
−
 
 
|-
 
|-
 
| OVFileId
 
| OVFileId
 
| Id du fichier
 
| Id du fichier
−
 
 
|-
 
|-
 
| OVFileFolderId
 
| OVFileFolderId
 
| Id du répertoire
 
| Id du répertoire
−
 
 
|-
 
|-
 
| OVFileUrl
 
| OVFileUrl
 
| Url pour atteindre le fichier dans le gestionnaire de fichiers
 
| Url pour atteindre le fichier dans le gestionnaire de fichiers
−
 
 
|-
 
|-
 
| OVImageUrl
 
| 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.
 
| 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
 
| OVFilePopupUrl
 
| Url pour afficher le détail du fichier
 
| Url pour afficher le détail du fichier
−
 
 
|-
 
|-
 
| OVFileUrlGet
 
| OVFileUrlGet
 
| Url pour télécharger le fichier
 
| Url pour télécharger le fichier
−
 
 
|-
 
|-
 
| OVFileAuthor
 
| OVFileAuthor
 
| Nom de l'auteur
 
| Nom de l'auteur
−
 
 
|}
 
|}
−
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...) :
 
  
−
<nowiki>Exemple : <a href=</nowiki><nowiki>"<OVFileUrl>&inl=1"</nowiki><nowiki>> <OVFileName> </a></nowiki>
+
== OCFileNext ==
  
−
== OCFileNext  ==
 
 
Ce container est valable uniquement dans le container OCFiles. Il permet de récupérer les informations de l’entrée suivante.
 
Ce container est valable uniquement dans le container OCFiles. Il permet de récupérer les informations de l’entrée suivante.
  
 +
=== Syntaxe ===
  
−
<nowiki><OCFileNext>....</OCFileNext></nowiki>
+
<pre>
 +
<OCFileNext>...</OCFileNext>
 +
</pre>
  
 +
=== Variables ===
  
−
Variables :
+
Identiques à celles du container [[#OCFiles|OCFiles]].
  
−
Idem que ceux du container OCFiles.
+
== OCFilePrevious ==
  
−
== 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.
 
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 ===
  
−
<nowiki><OCFilePrevious>....</OCFilePrevious></nowiki>
+
<pre>
 +
<OCFilePrevious>...</OCFilePrevious>
 +
</pre>
  
 +
=== Variables ===
  
−
Variables :
+
Identiques à celles du container [[#OCFolders|OCFolders]].
  
−
Idem que ceux du container OCFolders.
+
== OCFile ==
  
−
 
−
== OCFile  ==
 
 
Donne les informations sur un fichier d'un répertoire partageable donné.
 
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...) :
  
−
<nowiki><OCFile fileid="" path="" rows="" offset="">....</OCFile></nowiki>
+
'''Exemple :'''
 +
<pre>
 +
<a href="<OVFileUrl&gt;&inl=1"><OVFileName></a>
 +
</pre>
  
 +
=== Syntaxe ===
  
−
Attributs :
+
<pre>
 +
<OCFile fileid="">...</OCFile>
 +
</pre>
  
−
fileid :
+
=== Paramètres ===
  
−
* Id du fichier
+
; fileid
 +
: Id du fichier
  
−
Variables :
+
=== Variables ===
−
 
+
−
 
+
−
 
+
−
{| style="border-spacing:0;"
+
−
| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| OVFileName
+
−
| style="border:0.002cm solid #000000;padding:0.097cm;"| Nom du fichier
+
  
 +
{| class="prettytable"
 +
! Variable
 +
! Valeur
 +
|-
 +
| OVFileName
 +
| Nom du fichier
 
|-
 
|-
 
| OVFileDescription
 
| OVFileDescription
 
| Description du fichier
 
| Description du fichier
−
 
 
|-
 
|-
 
| OVFileKeywords
 
| OVFileKeywords
 
| Les mots clés du fichier  
 
| Les mots clés du fichier  
−
 
 
|-
 
|-
 
| OVFileId
 
| OVFileId
 
| Id du fichier
 
| Id du fichier
−
 
 
|-
 
|-
 
| OVFileFolderId
 
| OVFileFolderId
 
| Id du répertoire
 
| Id du répertoire
−
 
 
|-
 
|-
 
| OVFileUrl
 
| OVFileUrl
 
| Url pour atteindre le fichier dans le gestionnaire de fichiers
 
| Url pour atteindre le fichier dans le gestionnaire de fichiers
−
 
 
|-
 
|-
 
| OVFilePopupUrl
 
| OVFilePopupUrl
 
| Url pour afficher le détail du fichier
 
| Url pour afficher le détail du fichier
−
 
 
|-
 
|-
 
| OVFileUrlGet
 
| OVFileUrlGet
 
| Url pour télécharger le fichier
 
| Url pour télécharger le fichier
−
 
 
|-
 
|-
 
| OVFileAuthor
 
| OVFileAuthor
 
| Nom de l'auteur
 
| Nom de l'auteur
−
 
 
|}
 
|}
−
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...) :
 
  
−
<nowiki>Exemple : <a href=</nowiki><nowiki>"<OVFileUrl>&inl=1"</nowiki><nowiki>> <OVFileName> </a></nowiki>
+
== OCFileFields ==
  
−
== OCFileFields  ==
 
 
Donne la liste des champs d'un fichier donné.
 
Donne la liste des champs d'un fichier donné.
  
 +
=== Syntaxe ===
  
−
<nowiki><OCFileFields fileid="">....</OCFileFields></nowiki>
+
<pre>
 +
<OCFileFields fileid="">...</OCFileFields>
 +
</pre>
  
 +
=== Paramètres ===
  
−
Attributs :
+
; fileid
 +
: Id du fichier
  
−
fileid :
+
=== Variables ===
−
 
+
−
* Id du fichier
+
−
 
+
−
Variables :
+
−
 
+
−
 
+
−
 
+
−
{| style="border-spacing:0;"
+
−
| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| OVFileFieldName
+
−
| style="border:0.002cm solid #000000;padding:0.097cm;"| Nom du champ
+
  
 +
{| class="prettytable"
 +
! Variable
 +
! Valeur
 +
|-
 +
| OVFileFieldName
 +
| Nom du champ
 
|-
 
|-
 
| OVFileFieldValue
 
| OVFileFieldValue
 
| Valeur du champ
 
| Valeur du champ
−
 
 
|}
 
|}
−
== OCFaqs  ==
 
−
Donne la liste des Faqs.
 
  
 +
== OCFaqs ==
  
−
<nowiki><OCFaqs faqid="">....</OCFaqs></nowiki>
+
Donne la liste des Faqs.
  
 +
=== Syntaxe ===
  
−
Attributs :
+
<pre>
 +
<OCFaqs [faqid=""] [delegationid=""]>...</OCFaqs>
 +
</pre>
  
−
faqid :
+
=== Paramètres ===
  
−
Optionnel.
+
; faqid ''(optionnel)''
 +
: Id de la faq ou plusieurs Ids séparés par une virgule
 +
: Si omis, le container liste tous Faqs disponibles.
  
−
* Id de la faq ou plusieurs Ids séparés par une virgule
+
; delegationid ''(optionnel)''
−
* Si omis, le container liste tous Faqs disponibles.
+
: 0 ''(par défaut)'' : pas de filtre
 +
: Id de la délégation.
  
−
Delegationid :
+
=== Variables ===
−
 
+
−
Optionnel.
+
−
 
+
−
* Si omis ou 0 : pas de filtre
+
−
* Id de la délégation.
+
−
 
+
−
Variables :
+
−
 
+
−
 
+
−
 
+
−
{| style="border-spacing:0;"
+
−
| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| OVFaqName
+
−
| style="border:0.002cm solid #000000;padding:0.097cm;"| Nom de la Faq
+
  
 +
{| class="prettytable"
 +
! Variable
 +
! Valeur
 +
|-
 +
| OVFaqName
 +
| Nom de la Faq
 
|-
 
|-
 
| OVFaqDescription
 
| OVFaqDescription
 
| Description du la Faq
 
| Description du la Faq
−
 
 
|-
 
|-
 
| OVFaqId
 
| OVFaqId
 
| Id de la Faq  
 
| Id de la Faq  
−
 
 
|-
 
|-
 
| OVFaqUrl
 
| OVFaqUrl
 
| Url pour atteindre la Faq
 
| Url pour atteindre la Faq
−
 
 
|-
 
|-
 
| OVFaqLanguage
 
| OVFaqLanguage
 
| Language de la Faq
 
| Language de la Faq
−
 
 
|-
 
|-
 
| OVFaqDelegationId
 
| 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
 
| 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 ==
+
 
 +
== OCFaqNext ==
 +
 
 
Ce container est valable uniquement dans le container OCFaqs. Il permet de récupérer les informations de l’entrée suivante.
 
Ce container est valable uniquement dans le container OCFaqs. Il permet de récupérer les informations de l’entrée suivante.
  
 +
=== Syntaxe ===
  
−
<nowiki><OCFaqNext>....</OCFaqNext></nowiki>
+
<pre>
 +
<OCFaqNext>...</OCFaqNext>
 +
</pre>
  
 +
=== Variables ===
  
−
Variables&nbsp;:
+
Identiques à celles du container [[#OCFaqs|OCFaqs]].
  
−
Idem que ceux du container OCFaqs.
+
== OCFaqPrevious ==
  
−
== 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.
 
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 ===
  
−
<nowiki><OCFaqPrevious>....</OCFaqPrevious></nowiki>
+
<pre>
 +
<OCFaqPrevious>...</OCFaqPrevious>
 +
</pre>
  
 +
=== Variables ===
  
−
Variables :
+
Identiques à celles du container [[#OCFaqs|OCFaqs]].
  
−
Idem que ceux du container OCFaqs.
+
== OCFaq ==
  
−
 
−
== OCFaq  ==
 
 
Donne les informations sur une Faq donnée.
 
Donne les informations sur une Faq donnée.
  
 +
=== Syntaxe ===
  
−
<nowiki><OCFaq faqid="">....</OCFaq></nowiki>
+
<pre>
 +
<OCFaq faqid="">...</OCFaq>
 +
</pre>
  
 +
=== Paramètres ===
  
−
Attributs :
+
; faqid
 +
: Id de la Faq
  
−
faqid :
+
=== Variables ===
−
 
+
−
* Id de la Faq
+
−
 
+
−
Variables :
+
−
 
+
−
 
+
−
 
+
−
{| style="border-spacing:0;"
+
−
| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| OVFaqName
+
−
| style="border:0.002cm solid #000000;padding:0.097cm;"| Nom de la Faq
+
  
 +
{| class="prettytable"
 +
! Variable
 +
! Valeur
 +
|-
 +
| OVFaqName
 +
| Nom de la Faq
 
|-
 
|-
 
| OVFaqDescription
 
| OVFaqDescription
 
| Description du la Faq
 
| Description du la Faq
−
 
 
|-
 
|-
 
| OVFaqId
 
| OVFaqId
 
| Id de la Faq  
 
| Id de la Faq  
−
 
 
|-
 
|-
 
| OVFaqUrl
 
| OVFaqUrl
 
| Url pour atteindre la Faq
 
| Url pour atteindre la Faq
−
 
 
|-
 
|-
 
| OVFaqLanguage
 
| OVFaqLanguage
 
| Language de la Faq
 
| Language de la Faq
−
 
 
|-
 
|-
 
| OVFaqDelegationId
 
| 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
 
| 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.
 
  
 +
== OCFaqSubCategories ==
  
−
<nowiki><OCFaqSubCategories faqid="">....</OCFaqSubCategories></nowiki>
+
Donne la liste des sous catégories d’une Faq.
  
 +
=== Syntaxe ===
  
−
Attributs :
+
<pre>
 +
<OCFaqSubCategories faqid="" [delegationid=""]>...</OCFaqSubCategories>
 +
</pre>
  
−
faqid :
+
=== Paramètres ===
  
−
* Id de la faq
+
; faqid
 +
: Id de la faq
  
−
delegationid :
+
; delegationid ''(optionnel)''
 +
: 0 ''(par défaut)'' : pas de filtre
 +
: Id de la délégation.
  
−
Optionnel.
+
=== Variables ===
−
 
+
−
* Si omis ou 0 : pas de filtre
+
−
* Id de la délégation.
+
−
 
+
−
Variables :
+
−
 
+
−
 
+
−
 
+
−
{| style="border-spacing:0;"
+
−
| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| OVFaqSubCatName
+
−
| style="border:0.002cm solid #000000;padding:0.097cm;"| Nom de la sous catégorie
+
  
 +
{| class="prettytable"
 +
! Variable
 +
! Valeur
 +
|-
 +
| OVFaqSubCatName
 +
| Nom de la sous catégorie
 
|-
 
|-
 
| OVFaqSubCatId
 
| OVFaqSubCatId
 
| Id de la sous catégorie
 
| Id de la sous catégorie
−
 
 
|-
 
|-
 
| OVFaqId
 
| OVFaqId
 
| Id de la Faq  
 
| Id de la Faq  
−
 
 
|-
 
|-
 
| OVFaqUrl
 
| OVFaqUrl
 
| Url pour atteindre la sous catégorie Faq
 
| Url pour atteindre la sous catégorie Faq
−
 
 
|}
 
|}
−
== OCFaqSubCategory  ==
 
−
Donne les informations des sous-catégories d’une faq.
 
  
 +
== OCFaqSubCategory ==
  
−
<nowiki><OCFaqSubCategory faqsubcatid="">....</OCFaqSubCategory></nowiki>
+
Donne les informations des sous-catégories d’une faq.
  
 +
=== Syntaxe ===
  
−
Attributs :
+
<pre>
 +
<OCFaqSubCategory faqsubcatid="">...</OCFaqSubCategory>
 +
</pre>
  
−
faqsubcatid :
+
=== Paramètres ===
  
−
* Id de la sous catégorie ou plusieurs Ids séparés par une virgule
+
; faqsubcatid
 +
: Id de la sous catégorie ou plusieurs Ids séparés par une virgule
  
−
Variables :
+
=== Variables ===
−
 
+
−
 
+
−
 
+
−
{| style="border-spacing:0;"
+
−
| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| OVFaqSubCatName
+
−
| style="border:0.002cm solid #000000;padding:0.097cm;"| Nom de la sous catégorie
+
  
 +
{| class="prettytable"
 +
! Variable
 +
! Valeur
 +
|-
 +
| OVFaqSubCatName
 +
| Nom de la sous catégorie
 
|-
 
|-
 
| OVFaqSubCatId
 
| OVFaqSubCatId
 
| Id de la sous catégorie
 
| Id de la sous catégorie
−
 
 
|-
 
|-
 
| OVFaqId
 
| OVFaqId
 
| Id de la Faq  
 
| Id de la Faq  
−
 
 
|-
 
|-
 
| OVFaqUrl
 
| OVFaqUrl
 
| Url pour atteindre la sous catégorie Faq
 
| Url pour atteindre la sous catégorie Faq
−
 
 
|}
 
|}
−
== OCFaqQuestions  ==
 
−
Donne la liste des questions/réponses d'une faq.
 
  
 +
== OCFaqQuestions ==
  
−
<nowiki><OCFaqQuestions faqid="">....</OCFaqQuestions></nowiki>
+
Donne la liste des questions/réponses d'une faq.
  
 +
=== Syntaxe ===
  
−
Attributs :
+
<pre>
 +
<OCFaqQuestions [faqid=""] [faqsubcatid=""]>...</OCFaqQuestions>
 +
</pre>
  
−
faqid :
+
=== Paramètres ===
  
−
Optionnel.
+
; 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.
  
−
* Id de la faq ou plusieurs Ids séparés par une virgule
+
; faqsubcatid ''(optionnel)''
−
* Si omis, le container liste les questions/réponses de toutes les Faqs disponibles.
+
: 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.
  
−
Faqsubcatid :
+
=== Variables ===
−
 
+
−
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 :
+
−
 
+
−
 
+
−
 
+
−
{| style="border-spacing:0;"
+
−
| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| OVFaqQuestion
+
−
| style="border:0.002cm solid #000000;padding:0.097cm;"| Intitulé de la question
+
  
 +
{| class="prettytable"
 +
! Variable
 +
! Valeur
 +
|-
 +
| OVFaqQuestion
 +
| Intitulé de la question
 
|-
 
|-
 
| OVFaqResponse
 
| OVFaqResponse
 
| Texte de la réponse
 
| Texte de la réponse
−
 
 
|-
 
|-
 
| OVFaqQuestionId
 
| OVFaqQuestionId
 
| Id de la question
 
| Id de la question
−
 
 
|-
 
|-
 
| OVFaqQuestionUrl
 
| OVFaqQuestionUrl
 
| Url pour atteindre la question
 
| Url pour atteindre la question
−
 
 
|-
 
|-
 
| OVFaqQuestionPopupUrl
 
| OVFaqQuestionPopupUrl
 
| Url pour visualiser la question/réponse dans une fenêtre popup
 
| Url pour visualiser la question/réponse dans une fenêtre popup
 +
|}
 +
 +
== OCFaqQuestionNext ==
  
−
|}
 
−
== OCFaqQuestionNext  ==
 
 
Ce container est valable uniquement dans le container OCFaqQuestions. Il permet de récupérer les informations de l’entrée suivante.
 
Ce container est valable uniquement dans le container OCFaqQuestions. Il permet de récupérer les informations de l’entrée suivante.
  
 +
=== Syntaxe ===
  
−
<nowiki><OCFaqQuestionNext>....</OCFaqQuestionNext></nowiki>
+
<pre>
 +
<OCFaqQuestionNext>...</OCFaqQuestionNext>
 +
</pre>
  
 +
=== Variables ===
  
−
Variables :
+
Identiques à celles du container [[#OCFaqQuestions|OCFaqQuestions]].
  
−
Idem que ceux du container OCFaqQuestions.
+
== OCFaqQuestionPrevious ==
  
−
== 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.
 
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 ===
  
−
<nowiki><OCFaqQuestionPrevious>....</OCFaqQuestionPrevious></nowiki>
+
<pre>
 +
<OCFaqQuestionPrevious>...</OCFaqQuestionPrevious>
 +
</pre>
  
 +
=== Variables ===
  
−
Variables :
+
Identiques à celles du container [[#OCFaqQuestions|OCFaqQuestions]].
  
−
Idem que ceux du container OCFaqQuestions.
+
== OCFaqQuestion ==
  
−
 
−
== OCFaqQuestion  ==
 
 
Donne les informations sur une questions/réponses donnée.
 
Donne les informations sur une questions/réponses donnée.
  
 +
=== Syntaxe ===
  
−
<nowiki><OCFaqQuestion questionid="">....</OCFaqQuestion></nowiki>
+
<pre>
 +
<OCFaqQuestion questionid="">...</OCFaqQuestion>
 +
</pre>
  
 +
=== Paramètres ===
  
−
Attributs :
+
; questionid
 +
: Id de la question/réponse de la Faq
  
−
faqid :
+
=== Variables ===
−
 
+
−
* Id de la question/réponse de la Faq
+
−
 
+
−
Variables:
+
−
 
+
−
 
+
−
{| style="border-spacing:0;"
+
−
| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| OVFaqQuestion
+
−
| style="border:0.002cm solid #000000;padding:0.097cm;"| Intitulé de la question
+
  
 +
{| class="prettytable"
 +
! Variable
 +
! Valeur
 +
|-
 +
| OVFaqQuestion
 +
| Intitulé de la question
 
|-
 
|-
 
| OVFaqResponse
 
| OVFaqResponse
 
| Texte de la réponse
 
| Texte de la réponse
−
 
 
|-
 
|-
 
| OVFaqQuestionId
 
| OVFaqQuestionId
 
| Id de la question
 
| Id de la question
−
 
 
|-
 
|-
 
| OVFaqQuestionUrl
 
| OVFaqQuestionUrl
 
| Url pour atteindre la question
 
| Url pour atteindre la question
−
 
 
|-
 
|-
 
| OVFaqQuestionPopupUrl
 
| OVFaqQuestionPopupUrl
 
| Url pour visualiser la question/réponse dans une fenêtre popup
 
| 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é.
 
  
 +
== OCWaitingArticles ==
  
−
<nowiki><OCWaitingArticles topicid="" userid="">....</OCWaitingArticles></nowiki>
+
Liste les articles d'un thème donné en attente d'approbation pour un utilisateur donné.
  
 +
=== Syntaxe ===
  
−
Attributs :
+
<pre>
 +
<OCWaitingArticles [topicid=""] [userid=""] [delegationid=""] [imageheightmax=""] [imagewidthmax=""]>...</OCWaitingArticles>
 +
</pre>
  
−
topicid :
+
=== Paramètres ===
  
−
Optionnel.
+
; 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.
  
−
* Id du thème ou plusieurs Ids séparés par une virgule
+
; userid ''(optionnel)''
−
* Si omis, le container liste les articles en attente d'approbation tout thème confondu.
+
: Id de l'utilisateur
 +
: Si omis, le container liste les articles en attente d'approbation de l'utilisateur courant.
  
−
Userid :
+
; delegationid ''(optionnel)''
 +
: 0 ''(par défaut)'' : pas de filtre
 +
: Id de la délégation.
  
−
Optionnel
+
; 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.
  
−
* Id de l'utilisateur
+
; imagewidthmax ''(optionnel)''
−
* Si omis, le container liste les articles en attente d'approbation de l'utilisateur courant.
+
: 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.
  
−
Delegationid :
+
=== Variables ===
−
 
+
−
Optionnel.
+
−
 
+
−
* Si omis ou 0 : 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 :
+
−
 
+
−
 
+
−
 
+
−
{| style="border-spacing:0;"
+
−
| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| OVArticleTitle
+
−
| style="border:0.002cm solid #000000;padding:0.097cm;"| Titre de l'article
+
  
 +
{| class="prettytable"
 +
! Variable
 +
! Valeur
 +
|-
 +
| OVArticleTitle
 +
| Titre de l'article
 
|-
 
|-
 
| OVArticleHead
 
| OVArticleHead
 
| Introduction de l'article
 
| Introduction de l'article
−
 
 
|-
 
|-
 
| OVArticleBody
 
| OVArticleBody
 
| Corps de l'article
 
| Corps de l'article
−
 
 
|-
 
|-
 
| OVArticleReadMore
 
| OVArticleReadMore
 
| 0 si l’article n’a pas de corps sinon 1
 
| 0 si l’article n’a pas de corps sinon 1
−
 
 
|-
 
|-
 
| OVArticleId
 
| OVArticleId
 
| Id de l'article
 
| Id de l'article
−
 
 
|-
 
|-
 
| OVArticleUrl
 
| OVArticleUrl
 
| Url pour atteindre le corps de l'article
 
| Url pour atteindre le corps de l'article
−
 
 
|-
 
|-
 
| OVArticleAuthor
 
| OVArticleAuthor
 
| Auteur de l'article
 
| Auteur de l'article
−
 
 
|-
 
|-
 
| OVArticleDate
 
| OVArticleDate
 
| Date de publication de l'article
 
| Date de publication de l'article
−
 
 
|-
 
|-
 
| OVArticleTopicId
 
| OVArticleTopicId
 
| Id du thème contenant l'article
 
| Id du thème contenant l'article
−
 
 
|-
 
|-
 
| OVArticleLanguage
 
| OVArticleLanguage
 
| Langue de l'article
 
| Langue de l'article
−
 
 
|-
 
|-
 
| OVArticlePopupUrl
 
| OVArticlePopupUrl
 
| Url pour afficher l’article dans une fenêtre popup
 
| Url pour afficher l’article dans une fenêtre popup
−
 
 
|-
 
|-
 
| OVArticleEditUrl
 
| OVArticleEditUrl
−
| Url pour accéder à la modification de l'article (penser à ouvre ce lien dans une nouvelle fenêtre ou popup)
+
| Url pour accéder à la modification de l'article (penser à ouvrir ce lien dans une nouvelle fenêtre ou popup)
−
 
+
 
|-
 
|-
 
| OVArticleEditName
 
| OVArticleEditName
 
| Nom associé au lien pour accéder à la modification de l'article
 
| Nom associé au lien pour accéder à la modification de l'article
−
 
+
|-
 +
| OVArticleCopyUrl
 +
| Url pour accéder à la duplication de l'article (penser à ouvrir ce lien dans une nouvelle fenêtre ou popup)
 +
|-
 +
| OVArticleCopyName
 +
| Nom associé au lien pour accéder à la duplication de l'article
 
|-
 
|-
 
| OVAssociatedImage
 
| OVAssociatedImage
 
| 0 si aucune image est associée, 1 si une image est associée
 
| 0 si aucune image est associée, 1 si une image est associée
−
 
 
|-
 
|-
 
| OVImageUrl
 
| OVImageUrl
 
| Url d'affichage de l'image (à utiliser dans une balise img), tient compte des paramètres imageheightmax et imagewidthmax
 
| Url d'affichage de l'image (à utiliser dans une balise img), tient compte des paramètres imageheightmax et imagewidthmax
−
 
 
|-
 
|-
 
| OVOriginalImageUrl
 
| 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
 
| 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
 
| OVImageWidth
 
| Largeur de l'image après redimensionnement
 
| Largeur de l'image après redimensionnement
−
 
 
|-
 
|-
 
| OVImageHeight
 
| OVImageHeight
 
| Hauteur de l'image après redimensionnement
 
| Hauteur de l'image après redimensionnement
−
 
 
|-
 
|-
 
| OVResizedImageWidth
 
| OVResizedImageWidth
 
| Largeur d'origine de l'image
 
| Largeur d'origine de l'image
−
 
 
|-
 
|-
 
| OVResizedImageHeight
 
| OVResizedImageHeight
 
| Hauteur d'origine de l'image
 
| Hauteur d'origine de l'image
−
 
 
|}
 
|}
−
== OCWaitingComments  ==
 
−
Liste les commentaires en attente d'approbation d'un article donné ( articleid ) pour un utilisateur donné.
 
  
 +
== OCWaitingComments ==
  
−
<nowiki><OCWaitingComments articleid="" userid="">....</OCWaitingComments></nowiki>
+
Liste les commentaires en attente d'approbation d'un article donné ( articleid ) pour un utilisateur donné.
  
 +
=== Syntaxe ===
  
−
Attributs :
+
<pre>
 +
<OCWaitingComments [articleid=""] [userid=""] [delegationid=""]>...</OCWaitingComments>
 +
</pre>
  
 +
=== Paramètres ===
  
−
articleid :
+
; 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.
  
−
Optionnel.
+
; userid ''(optionnel)''
 +
: Id de l'utilisateur
 +
: Si omis, le container liste les commentaires en attente d'approbation de l'utilisateur courant.
  
−
* Id de l’article ou plusieurs Ids séparés par une virgule
+
; delegationid ''(optionnel)''
−
* Si omis, le container liste les commentaires en attente de tout article confondu.
+
: 0 ''(par défaut)'' : pas de filtre
 +
: Id de la délégation.
  
−
Userid :
+
=== Variables ===
−
 
+
−
Optionnel
+
−
 
+
−
* Id de l'utilisateur
+
−
* Si omis, le container liste les commentaires en attente d'approbation de l'utilisateur courant.
+
−
 
+
−
Delegationid :
+
−
 
+
−
Optionnel.
+
−
 
+
−
* Si omis ou 0 : pas de filtre
+
−
* Id de la délégation.
+
−
 
+
−
Variables :
+
−
 
+
−
 
+
−
 
+
−
{| style="border-spacing:0;"
+
−
| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| OVCommentTitle
+
−
| style="border:0.002cm solid #000000;padding:0.097cm;"| Titre du commentaire
+
  
 +
{| class="prettytable"
 +
! Variable
 +
! Valeur
 +
|-
 +
| OVCommentTitle
 +
| Titre du commentaire
 
|-
 
|-
 
| OVCommentText
 
| OVCommentText
 
| Contenu du commentaire
 
| Contenu du commentaire
−
 
 
|-
 
|-
 
| OVCommentId
 
| OVCommentId
 
| Id du commentaire
 
| Id du commentaire
−
 
 
|-
 
|-
 
| OVCommentTopicId
 
| OVCommentTopicId
 
| Id du thème contenant l'article contenant le commentaire
 
| Id du thème contenant l'article contenant le commentaire
−
 
 
|-
 
|-
 
| OVCommentArticleId
 
| OVCommentArticleId
 
| Id de l'article contenant le commentaire
 
| Id de l'article contenant le commentaire
−
 
 
|-
 
|-
 
| OVCommentDate
 
| OVCommentDate
 
| Date de publication du commentaire
 
| Date de publication du commentaire
−
 
 
|-
 
|-
 
| OVCommentAuthor
 
| OVCommentAuthor
 
| Auteur du commentaire
 
| Auteur du commentaire
−
 
 
|-
 
|-
 
| OVCommentUrl
 
| OVCommentUrl
 
| Url pour atteindre le commentaire
 
| Url pour atteindre le commentaire
−
 
 
|-
 
|-
 
| OVCommentLanguage
 
| OVCommentLanguage
 
| Langue du commentaire
 
| Langue du commentaire
−
 
 
|-
 
|-
 
| OVCommentPopupUrl
 
| OVCommentPopupUrl
 
| Url pour visualiser le commentaire dans une fenêtre popup
 
| 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é.
 
  
 +
== OCWaitingFiles ==
  
−
<nowiki><OCWaitingFiles folderid="" userid="">....</OCWaitingFiles></nowiki>
+
Liste les fichiers en attente d'approbation d'un répertoire donné ( articleid ) pour un utilisateur donné.
  
 +
=== Syntaxe ===
  
−
Attributs :
+
<pre>
 +
<OCWaitingFiles [folderid=""] [userid=""] [delegationid=""]>...</OCWaitingFiles>
 +
</pre>
  
−
folderid :
+
=== Paramètres ===
  
−
Optionnel.
+
; 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.
  
−
* Id du répertoire ou plusieurs Ids séparés par une virgule
+
; userid ''(optionnel)''
−
* Si omis, le container liste les fichiers en attente de tout répertoire confondu.
+
: Id de l'utilisateur
 +
: Si omis, le container liste les fichiers en attente d'approbation de l'utilisateur courant.
  
−
Userid :
+
; delegationid ''(optionnel)''
 +
: 0 ''(par défaut)'' : pas de filtre
 +
: Id de la délégation.
  
−
Optionnel
+
=== Variables ===
−
 
+
−
* Id de l'utilisateur
+
−
* Si omis, le container liste les fichiers en attente d'approbation de l'utilisateur courant.
+
−
 
+
−
Delegationid :
+
−
 
+
−
Optionnel.
+
−
 
+
−
* Si omis ou 0 : pas de filtre
+
−
* Id de la délégation.
+
−
 
+
−
Variables :
+
−
 
+
−
 
+
−
 
+
−
{| style="border-spacing:0;"
+
−
| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| OVFileId
+
−
| style="border:0.002cm solid #000000;padding:0.097cm;"| Id du fichier
+
  
 +
{| class="prettytable"
 +
! Variable
 +
! Valeur
 +
|-
 +
| OVFileId
 +
| Id du fichier
 
|-
 
|-
 
| OVFileName
 
| OVFileName
 
| Nom du fichier
 
| Nom du fichier
−
 
 
|-
 
|-
 
| OVFilePath
 
| OVFilePath
 
| Chemin du fichier
 
| Chemin du fichier
−
 
 
|-
 
|-
 
| OVFileDescription
 
| OVFileDescription
 
| Description du fichier
 
| Description du fichier
−
 
 
|-
 
|-
 
| OVFileUrl
 
| OVFileUrl
 
| Url pour atteindre la description du fichier
 
| Url pour atteindre la description du fichier
−
 
 
|-
 
|-
 
| OVFilePopupUrl
 
| OVFilePopupUrl
 
| Url pour afficher la description du fichier dans une fenêtre popup
 
| Url pour afficher la description du fichier dans une fenêtre popup
−
 
 
|-
 
|-
 
| OVFileUrlGet
 
| OVFileUrlGet
 
| Url pour télécharger le fichier
 
| Url pour télécharger le fichier
−
 
 
|-
 
|-
 
| OVFileAuthor
 
| OVFileAuthor
 
| Auteur du fichier
 
| Auteur du fichier
−
 
 
|-
 
|-
 
| OVFileDate
 
| OVFileDate
 
| Date de publication du fichier
 
| Date de publication du fichier
−
 
 
|-
 
|-
 
| OVFileFolderId
 
| OVFileFolderId
 
| Id du répertoire contenant le fichier
 
| Id du répertoire contenant le fichier
−
 
 
|}
 
|}
−
== OCWaitingPosts  ==
 
−
Liste les contributions en attente d'approbation d'un forum donné ( forumid ) pour un utilisateur donné.
 
  
 +
== OCWaitingPosts ==
  
−
<nowiki><OCWaitingPosts forumid="" userid="">....</OCWaitingPosts></nowiki>
+
Liste les contributions en attente d'approbation d'un forum donné ( forumid ) pour un utilisateur donné.
  
 +
=== Syntaxe ===
  
−
Attributs :
+
<pre>
 +
<OCWaitingPosts [forumid=""] [userid=""] [delegationid=""]>...</OCWaitingPosts>
 +
</pre>
  
−
forumid :
+
=== Paramètres ===
  
−
Optionnel.
+
; 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.
  
−
* Id du forum ou plusieurs Ids séparés par une virgule
+
; userid ''(optionnel)''
−
* Si omis, le container liste les contributions en attente de tout forum confondu.
+
: Id de l'utilisateur
 +
: Si omis, le container liste les contributions en attente d'approbation de l'utilisateur courant.
  
−
Userid :
+
; delegationid ''(optionnel)''
 +
: 0 ''(par défaut)'' : pas de filtre
 +
: Id de la délégation.
  
−
Optionnel
+
=== Variables ===
−
 
+
−
* Id de l'utilisateur
+
−
* Si omis, le container liste les contributions en attente d'approbation de l'utilisateur courant.
+
−
 
+
−
Delegationid :
+
−
 
+
−
Optionnel.
+
−
 
+
−
* Si omis ou 0 : pas de filtre
+
−
* Id de la délégation.
+
−
 
+
−
Variables :
+
−
 
+
−
 
+
−
 
+
−
{| style="border-spacing:0;"
+
−
| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| OVPostTitle
+
−
| style="border:0.002cm solid #000000;padding:0.097cm;"| Titre de la contribution
+
  
 +
{| class="prettytable"
 +
! Variable
 +
! Valeur
 +
|-
 +
| OVPostTitle
 +
| Titre de la contribution
 
|-
 
|-
 
| OVPostText
 
| OVPostText
 
| Contenu de la contribution
 
| Contenu de la contribution
−
 
 
|-
 
|-
 
| OVPostId
 
| OVPostId
 
| Id de la contribution
 
| Id de la contribution
−
 
 
|-
 
|-
 
| OVPostThreadId
 
| OVPostThreadId
 
| Id du sujet de la contribution
 
| Id du sujet de la contribution
−
 
 
|-
 
|-
 
| OVPostForumId
 
| OVPostForumId
 
| Id du forum de la contribution
 
| Id du forum de la contribution
−
 
 
|-
 
|-
 
| OVPostAuthor
 
| OVPostAuthor
 
| Auteur de la contribution
 
| Auteur de la contribution
−
 
 
|-
 
|-
 
| OVPostDate
 
| OVPostDate
 
| Date de la contribution
 
| Date de la contribution
−
 
 
|-
 
|-
 
| OVPostUrl
 
| OVPostUrl
 
| Url pour visualiser la contribution dans une fenêtre popup
 
| Url pour visualiser la contribution dans une fenêtre popup
−
 
 
|-
 
|-
 
| OVPostPopupUrl
 
| OVPostPopupUrl
 
| Langue du commentaire
 
| Langue du commentaire
−
 
 
|}
 
|}
−
== OCCalendars  ==
 
−
Liste les calendriers
 
  
 +
== OCCalendars ==
  
−
<nowiki><OCCalendars type="" calendarid="">....</OCCalendars></nowiki>
+
Liste les calendriers
  
 +
=== Syntaxe ===
  
−
Attributs :
+
<pre>
 +
<OCCalendars [type=""] [calendarid=""] [delegationid=""]>...</OCCalendars>
 +
</pre>
  
−
type :
+
=== Paramètres ===
  
−
Optionnel.
+
; 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
  
−
* Si omis, le container liste tous les agendas. type peut prendre les valeurs suivantes&nbsp;:
+
; calendarid ''(optionnel)''
−
* user: les agendas personnels
+
: Un ou plusieurs id d'agendas séparés par des virgules
−
* group: les agendas de groupes
+
: Si omis, le container liste tous les agendas.
  
−
* resource: les agendas de ressources
+
; delegationid ''(optionnel)''
 +
: 0 ''(par défaut)'' : pas de filtre
 +
: Id de la délégation.
  
−
calendarid : un ou plusieurs id d'agendas séparés par des virgules&nbsp;; si omis, le container liste tous les agendas.
+
=== Variables ===
−
 
+
−
 
+
−
Delegationid :
+
−
 
+
−
Optionnel.
+
−
 
+
−
* Si omis ou 0 : pas de filtre
+
−
* Id de la délégation.
+
−
 
+
−
Variables :
+
−
 
+
−
 
+
−
 
+
−
{| style="border-spacing:0;"
+
−
| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| OVCalendarId
+
−
| style="border:0.002cm solid #000000;padding:0.097cm;"| Id de l’agenda
+
  
 +
{| class="prettytable"
 +
! Variable
 +
! Valeur
 +
|-
 +
| OVCalendarId
 +
| Id de l’agenda
 
|-
 
|-
 
| OVCalendarName
 
| OVCalendarName
 
| Intitulé de l’agenda
 
| Intitulé de l’agenda
−
 
 
|-
 
|-
 
| OVCalendarDescription
 
| OVCalendarDescription
 
| Description de l'agenda
 
| Description de l'agenda
−
 
 
|-
 
|-
 
| OVCalendarOwnerId
 
| OVCalendarOwnerId
 
| Id du propriétaire de l’agenda
 
| Id du propriétaire de l’agenda
−
 
 
|-
 
|-
 
| OVCalendarType
 
| OVCalendarType
 
| Type de l’agenda ( user, group ou resource )
 
| Type de l’agenda ( user, group ou resource )
−
 
 
|-
 
|-
 
| OVCalendarUrl
 
| OVCalendarUrl
 
| Url pour accéder à la page Agenda
 
| Url pour accéder à la page Agenda
−
 
 
|}
 
|}
−
== OCCalendarCategories  ==
 
−
Liste les catégories d’événements des agendas
 
  
 +
== OCCalendarCategories ==
  
−
<nowiki><OCCalendarCategories>....</OCCalendarCategories></nowiki>
+
Liste les catégories d’événements des agendas
  
 +
=== Syntaxe ===
  
−
Attributs :
+
<pre>
 +
<OCCalendarCategories [filter=""]>...</OCCalendarCategories>
 +
</pre>
  
−
filter :
+
=== Paramètres ===
  
−
Optionnel.
+
; filter ''(optionnel)''
 +
: Si filter=«no», ne filtre pas selon les droits de visibilité
  
−
* Si filter=«no», ne filtre pas selon les droits de visibilité
+
=== Variables ===
−
 
+
−
Variables :
+
−
 
+
−
 
+
−
 
+
−
{| style="border-spacing:0;"
+
−
| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| OVCalendarCategoryId
+
−
| style="border:0.002cm solid #000000;padding:0.097cm;"| Id de la catégorie
+
  
 +
{| class="prettytable"
 +
! Variable
 +
! Valeur
 +
|-
 +
| OVCalendarCategoryId
 +
| Id de la catégorie
 
|-
 
|-
 
| OVCalendarCategoryName
 
| OVCalendarCategoryName
 
| Intitulé de la catégorie
 
| Intitulé de la catégorie
−
 
 
|-
 
|-
 
| OVCalendarCategoryDescription
 
| OVCalendarCategoryDescription
 
| Description de la catégorie
 
| Description de la catégorie
−
 
 
|}
 
|}
−
== OCCalendarUserEvents  ==
 
−
Liste les événements d’un ou plusieurs agendas personnels
 
  
 +
== OCCalendarUserEvents ==
  
−
<nowiki><OCCalendarUserEvents calendarid="" date="" limit="" filter="" </nowiki>categoryid="">....
+
Liste les événements d’un ou plusieurs agendas personnels
  
−
<nowiki></OCCalendarUserEvents></nowiki>
+
=== Syntaxe ===
  
 +
<pre>
 +
<OCCalendarUserEvents [calendarid=""] [date=""] [limit=""] [categoryid=""] [filter=""] [holiday=""]>...</OCCalendarUserEvents>
 +
</pre>
  
−
Attributs :
+
=== Paramètres ===
  
 +
; calendarid ''(optionnel)''
 +
: Si omis, le container liste les événements de l’agenda personnel de l’utilisateur courant.
  
−
calendarid :
+
; date ''(optionnel)''
 +
: Si omis, date courante.
 +
: Sinon le format de la date doit être aaaa-mm-jj
  
−
Optionnel
+
; 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
  
−
* Si omis, le container liste les événements de l’agenda personnel de l’utilisateur courant.
+
; 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
  
−
Userid :
+
; filter ''(optionnel)''
 +
: Si filter=«no», ne filtre pas selon les droits de visibilité.Remarque : si le paramètre est à «&nbsp;no&nbsp;», les événements privés seront aussi remontés
  
−
Optionnel.
+
; holiday ''(optionnel)''
 +
: Si holiday=«no», les jours fériés ne sont pas inclus.
  
−
* Si omis, le container liste les événements de l’agenda personnel de l’utilisateur courant.
+
; userid ''(optionnel, déprécié)''
−
* Cet attribut n'est plus utilisé depuis la version 6.0.4 d'ovidentia, il est recommandé d'utiliser calendarid
+
: 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
  
−
date :
+
=== Variables ===
−
 
+
−
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 à «&nbsp;no&nbsp;», les événements privés seront aussi remontés
+
−
 
+
−
holiday :
+
−
 
+
−
Optionnel.
+
−
 
+
−
* Si holiday=«no», les jours fériés ne sont pas inclus.
+
−
 
+
−
Variables:
+
−
 
+
−
 
+
−
 
+
−
{| style="border-spacing:0;"
+
−
| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| OVEventTitle
+
−
| style="border:0.002cm solid #000000;padding:0.097cm;"| Intitulé de l’événement
+
  
 +
{| class="prettytable"
 +
! Variable
 +
! Valeur
 +
|-
 +
| OVEventTitle
 +
| Intitulé de l’événement
 
|-
 
|-
 
| OVEventDescription
 
| OVEventDescription
 
| Description de l’événement
 
| Description de l’événement
−
 
 
|-
 
|-
 
| OVEventLocation
 
| OVEventLocation
 
| Lieu de l'événement
 
| Lieu de l'événement
−
 
 
|-
 
|-
 
| OVEventBeginDate
 
| OVEventBeginDate
 
| Date de début
 
| Date de début
−
 
 
|-
 
|-
 
| OVEventEndDate
 
| OVEventEndDate
 
| Date de fin
 
| Date de fin
−
 
 
|-
 
|-
 
| OVEventCategoryId
 
| OVEventCategoryId
 
| Id de la catégorie de l’événement
 
| Id de la catégorie de l’événement
−
 
 
|-
 
|-
 
| OVEventCategoryColor
 
| OVEventCategoryColor
 
| Couleur de la catégorie sous forme de FFFFFF
 
| Couleur de la catégorie sous forme de FFFFFF
−
 
 
|-
 
|-
 
| OVEventCategoryName
 
| OVEventCategoryName
 
| Nom de la catégorie
 
| Nom de la catégorie
−
 
 
|-
 
|-
 
| OVEventUrl
 
| OVEventUrl
 
| Url pour accéder à l’événement (vide si filter=no)
 
| Url pour accéder à l’événement (vide si filter=no)
−
 
 
|-
 
|-
 
| OVEventCalendarUrl
 
| OVEventCalendarUrl
 
| Url pour accéder à l’agenda au jour de l’événement (vide si filter=no)
 
| Url pour accéder à l’agenda au jour de l’événement (vide si filter=no)
−
 
 
|-
 
|-
 
| OVEventCategoriesPopupUrl
 
| OVEventCategoriesPopupUrl
 
| Url pour afficher les différentes catégories (vide si filter=no)
 
| Url pour afficher les différentes catégories (vide si filter=no)
−
 
 
|-
 
|-
 
| OVEventOwner
 
| OVEventOwner
 
| Nom du propriétaire de l’agenda
 
| Nom du propriétaire de l’agenda
−
 
 
|}
 
|}
−
== OCCalendarGroupEvents  ==
 
−
Liste les événements d’un ou plusieurs agendas collectifs (anciennement agendas de groupes)
 
  
 +
== OCCalendarGroupEvents ==
  
−
<nowiki><OCCalendarGroupEvents calendarid="" date="" limit="" filter="" categoryid="">....</OCCalendarGroupEvents></nowiki>
+
Liste les événements d’un ou plusieurs agendas collectifs (anciennement agendas de groupes)
  
 +
=== Syntaxe ===
  
−
Attributs :
+
<pre>
 +
<OCCalendarGroupEvents [calendarid=""] [date=""] [limit=""] [categoryid=""] [filter=""] [delegationid=""] [holiday=""]>...</OCCalendarGroupEvents>
 +
</pre>
  
 +
=== Paramètres ===
  
−
calendarid :
+
; 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.
  
−
Optionnel.
+
; date ''(optionnel)''
 +
: Si omis, date courante.
 +
: Sinon le format de la date doit être aaaa-mm-jj
  
−
* 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.
+
; 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
  
−
Groupid :
+
; 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
  
−
Optionnel.
+
; filter ''(optionnel)''
 +
: Si filter=«no», ne filtre pas selon les droits de visibilité
  
−
* 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.
+
; delegationid ''(optionnel)''
 +
: Si omis ou 0 : pas de filtre
 +
: Id de la délégation.
  
−
* Cet attribut n'est plus utilisé depuis la version 6.0.4 d'ovidentia, il est recommandé d'utiliser calendarid
+
; holiday ''(optionnel)''
 +
: Si holiday=«no», les jours fériés ne sont pas inclus.
  
−
Remarque : le paramètre groupid correspond à l'identifiant (grpid) de l'agenda lorsqu'on utilise les agendas collectifs.
+
; 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 ===
  
−
date:
+
{| class="prettytable"
−
 
+
! Variable
−
Optionnel.
+
! Valeur
−
 
+
|-
−
* Si omis, date courante.
+
| OVEventTitle
−
 
+
| Intitulé de l’événement
−
* 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.
+
−
 
+
−
Variables:
+
−
 
+
−
 
+
−
 
+
−
{| style="border-spacing:0;"
+
−
| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| OVEventTitle
+
−
| style="border:0.002cm solid #000000;padding:0.097cm;"| Intitulé de l’événement
+
−
 
+
 
|-
 
|-
 
| OVEventDescription
 
| OVEventDescription
 
| Description de l’événement
 
| Description de l’événement
−
 
 
|-
 
|-
 
| OVEventLocation
 
| OVEventLocation
 
| Lieu de l'événement
 
| Lieu de l'événement
−
 
 
|-
 
|-
 
| OVEventBeginDate
 
| OVEventBeginDate
 
| Date de début
 
| Date de début
−
 
 
|-
 
|-
 
| OVEventEndDate
 
| OVEventEndDate
 
| Date de fin
 
| Date de fin
−
 
 
|-
 
|-
 
| OVEventCategoryId
 
| OVEventCategoryId
 
| Id de la catégorie de l’événement
 
| Id de la catégorie de l’événement
−
 
 
|-
 
|-
 
| OVEventOwner
 
| OVEventOwner
 
| Nom du propriétaire de l’agenda
 
| Nom du propriétaire de l’agenda
−
 
 
|-
 
|-
 
| OVEventCategoryColor
 
| OVEventCategoryColor
 
| Couleur de la catégorie sous forme de FFFFFF
 
| Couleur de la catégorie sous forme de FFFFFF
−
 
 
|-
 
|-
 
| OVEventCategoryName
 
| OVEventCategoryName
 
| Nom de la catégorie
 
| Nom de la catégorie
−
 
 
|-
 
|-
 
| OVEventUrl
 
| OVEventUrl
 
| Url pour accéder à l’événement (vide si filter=no)
 
| Url pour accéder à l’événement (vide si filter=no)
−
 
 
|-
 
|-
 
| OVEventCalendarUrl
 
| OVEventCalendarUrl
 
| Url pour accéder à l’agenda au jour de l’événement (vide si filter=no)
 
| Url pour accéder à l’agenda au jour de l’événement (vide si filter=no)
−
 
 
|-
 
|-
 
| OVEventCategoriesPopupUrl
 
| OVEventCategoriesPopupUrl
 
| Url pour afficher les différentes catégories (vide si filter=no)
 
| Url pour afficher les différentes catégories (vide si filter=no)
−
 
 
|}
 
|}
−
== OCCalendarResourceEvents  ==
 
−
Liste les événements d’un ou plusieurs agendas de ressources
 
  
 +
== OCCalendarResourceEvents ==
  
−
<nowiki><OCCalendarResourceEvents calendarid="" date="" limit="" filter="" categoryid="">....</OCCalendarResourceEvents></nowiki>
+
Liste les événements d’un ou plusieurs agendas de ressources
  
 +
=== Syntaxe ===
  
−
Attributs :
+
<pre>
 +
<OCCalendarResourceEvents [calendarid=""] [date=""] [limit=""] [categoryid=""] [filter=""] [delegationid=""] [holiday=""]>...</OCCalendarResourceEvents>
 +
</pre>
  
−
calendarid :
+
=== Paramètres ===
  
−
Optionnel.
+
; 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.
  
−
* 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
  
−
Resourceid :
+
; 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
  
−
Optionnel.
+
; 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
  
−
* 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.
+
; filter ''(optionnel)''
−
* Cet attribut n'est plus utilisé depuis la version 6.0.4 d'ovidentia, il est recommandé d'utiliser calendarid
+
: Si filter=«no», ne filtre pas selon les droits de visibilité
  
−
date :
+
; delegationid ''(optionnel)''
 +
: Si omis ou 0 : pas de filtre
 +
: Id de la délégation.
  
−
Optionnel.
+
; holiday ''(optionnel)''
 +
: Si holiday=«no», les jours fériés ne sont pas inclus.
  
−
* Si omis, date courante.
+
; resourceid ''(optionnel, déprécié)''
−
* Sinon le format de la date doit être aaaa-mm-jj
+
: 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
  
−
limit :
+
=== Variables ===
−
 
+
−
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.
+
−
 
+
−
Variables :
+
−
 
+
−
 
+
−
 
+
−
{| style="border-spacing:0;"
+
−
| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| OVEventTitle
+
−
| style="border:0.002cm solid #000000;padding:0.097cm;"| Intitulé de l’événement
+
  
 +
{| class="prettytable"
 +
| OVEventTitle
 +
| Intitulé de l’événement
 
|-
 
|-
 
| OVEventDescription
 
| OVEventDescription
 
| Description de l’événement
 
| Description de l’événement
−
 
 
|-
 
|-
 
| OVEventLocation
 
| OVEventLocation
 
| Lieu de l'événement
 
| Lieu de l'événement
−
 
 
|-
 
|-
 
| OVEventBeginDate
 
| OVEventBeginDate
 
| Date de début
 
| Date de début
−
 
 
|-
 
|-
 
| OVEventEndDate
 
| OVEventEndDate
 
| Date de fin
 
| Date de fin
−
 
 
|-
 
|-
 
| OVEventCategoryId
 
| OVEventCategoryId
 
| Id de la catégorie de l’événement
 
| Id de la catégorie de l’événement
−
 
 
|-
 
|-
 
| OVEventOwner
 
| OVEventOwner
 
| Nom du propriétaire de l’agenda
 
| Nom du propriétaire de l’agenda
−
 
 
|-
 
|-
 
| OVEventCategoryColor
 
| OVEventCategoryColor
 
| Couleur de la catégorie sous forme de FFFFFF
 
| Couleur de la catégorie sous forme de FFFFFF
−
 
 
|-
 
|-
 
| OVEventCategoryName
 
| OVEventCategoryName
 
| Nom de la catégorie
 
| Nom de la catégorie
−
 
 
|-
 
|-
 
| OVEventUrl
 
| OVEventUrl
 
| Url pour accéder à l’événement (vide si filter=no)
 
| Url pour accéder à l’événement (vide si filter=no)
−
 
 
|-
 
|-
 
| OVEventCalendarUrl
 
| OVEventCalendarUrl
 
| Url pour accéder à l’agenda au jour de l’événement (vide si filter=no)
 
| Url pour accéder à l’agenda au jour de l’événement (vide si filter=no)
−
 
 
|-
 
|-
 
| OVEventCategoriesPopupUrl
 
| OVEventCategoriesPopupUrl
 
| Url pour afficher les différentes catégories (vide si filter=no)
 
| 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 )
 
  
 +
== OCCalendarEvents ==
  
−
<nowiki><OCCalendarEvents calendarid="" date="" limit="" filter="" categoryid="">....</OCCalendarEvents></nowiki>
+
Liste les événements d’un ou plusieurs agendas ( personnel, groupes ou de ressources )
  
 +
=== Syntaxe ===
  
−
Attributs :
+
<pre>
 +
<OCCalendarEvents [calendarid=""] [date=""] [limit=""] [categoryid=""] [filter=""] [delegationid=""] [holiday=""]>...</OCCalendarEvents>
 +
</pre>
  
−
calendarid :
+
=== Paramètres ===
  
−
Optionnel.
+
; 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.
  
−
* 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
  
−
Date :
+
; 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
  
−
Optionnel.
+
; 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
  
−
* Si omis date courante.
+
; filter ''(optionnel)''
 +
: Si filter=«no», ne filtre pas selon les droits de visibilité
  
−
* Sinon le format de la date doit être aaaa-mm-jj
+
; delegationid ''(optionnel)''
 +
: Si omis ou 0 : pas de filtre
 +
: Id de la délégation.
  
−
limit :
+
; holiday ''(optionnel)''
 +
: Si holiday=«no», les jours fériés ne sont pas inclus.
  
−
Optionnel.
+
=== Variables ===
  
−
* 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 :
 
−
 
−
 
−
 
−
{| style="border-spacing:0;"
 
−
| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| OVEventTitle
 
−
| style="border:0.002cm solid #000000;padding:0.097cm;"| Intitulé de l’événement
 
  
 +
{| class="prettytable"
 +
| OVEventTitle
 +
| Intitulé de l’événement
 
|-
 
|-
 
| OVEventDescription
 
| OVEventDescription
 
| Description de l’événement
 
| Description de l’événement
−
 
 
|-
 
|-
 
| OVEventLocation
 
| OVEventLocation
 
| Lieu de l'événement
 
| Lieu de l'événement
−
 
 
|-
 
|-
 
| OVEventBeginDate
 
| OVEventBeginDate
 
| Date de début
 
| Date de début
−
 
 
|-
 
|-
 
| OVEventEndDate
 
| OVEventEndDate
 
| Date de fin
 
| Date de fin
−
 
 
|-
 
|-
 
| OVEventCategoryId
 
| OVEventCategoryId
 
| Id de la catégorie de l’événement
 
| Id de la catégorie de l’événement
−
 
 
|-
 
|-
 
| OVEventCategoryColor
 
| OVEventCategoryColor
 
| Couleur de la catégorie sous forme de FFFFFF
 
| Couleur de la catégorie sous forme de FFFFFF
−
 
 
|-
 
|-
 
| OVEventCategoryName
 
| OVEventCategoryName
 
| Nom de la catégorie
 
| Nom de la catégorie
−
 
 
|-
 
|-
 
| OVEventUrl
 
| OVEventUrl
 
| Url pour accéder à l’événement (vide si filter=no)
 
| Url pour accéder à l’événement (vide si filter=no)
−
 
 
|-
 
|-
 
| OVEventCalendarUrl
 
| OVEventCalendarUrl
 
| Url pour accéder à l’agenda au jour de l’événement (vide si filter=no)
 
| 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
 
| OVEventCategoriesPopupUrl
 
| Url pour afficher les différentes catégories (vide si filter=no)
 
| Url pour afficher les différentes catégories (vide si filter=no)
−
 
 
|}
 
|}
−
== OCDbDirectories  ==
 
−
Liste les annuaires de base de données
 
  
 +
== OCDbDirectories ==
  
−
<nowiki><OCDbDirectories directoryid="">....</OCDbDirectories></nowiki>
+
Liste les annuaires de base de données
  
 +
=== Syntaxe ===
  
−
Attributs :
+
<pre>
 +
<OCDbDirectories [directoryid=""] [delegationid=""] [type=""]>...</OCDbDirectories>
 +
</pre>
  
−
directoryid :
+
=== Paramètres ===
  
−
Optionnel.
+
; directoryid ''(optionnel)''
 +
: Id de l'annuaire ou plusieurs Ids séparés par une virgule
 +
: Si omis, le container liste tous les annuaires.
  
−
* Id de l'annuaire ou plusieurs Ids séparés par une virgule
+
; delegationid ''(optionnel)''
−
* Si omis, le container liste tous les annuaires.
+
: Si omis ou 0 : pas de filtre
 +
: Id de la délégation.
  
−
Delegationid :
+
; type ''(optionnel)''
 +
: « database » ou « group », si omis, le container liste tous les annuaires.
  
−
Optionnel.
+
=== Variables ===
−
 
+
−
* Si omis ou 0 : pas de filtre
+
−
* Id de la délégation.
+
−
 
+
−
Variables :
+
−
 
+
−
 
+
−
 
+
−
{| style="border-spacing:0;"
+
−
| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| OVDirectoryName
+
−
| style="border:0.002cm solid #000000;padding:0.097cm;"| Intitulé de l’annuaire
+
  
 +
{| class="prettytable"
 +
! Variable
 +
! Valeur
 +
|-
 +
| OVDirectoryName
 +
| Intitulé de l’annuaire
 
|-
 
|-
 
| OVDirectoryDescription
 
| OVDirectoryDescription
 
| Description de l'annuaire
 
| Description de l'annuaire
−
 
 
|-
 
|-
 
| OVDirectoryId
 
| OVDirectoryId
 
| Id de l'annuaire
 
| Id de l'annuaire
−
 
 
|-
 
|-
 
| OVDirectoryUrl
 
| OVDirectoryUrl
 
| Url pour accéder à la liste des membres de l'annuaire
 
| Url pour accéder à la liste des membres de l'annuaire
−
 
 
|-
 
|-
 
| OVDirectoryDelegationId
 
| 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
 
| 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 )
 
  
 +
== OCDbDirectory ==
  
−
<nowiki><OCDbDirectory directoryid="" type="">....</OCDbDirectory></nowiki>
+
Liste les informations concernant un annuaire ( base de données )
  
 +
=== Syntaxe ===
  
−
Attributs :
+
<pre>
 +
<OCDbDirectory directoryid="">...</OCDbDirectory>
 +
</pre>
  
−
directoryid :
+
=== Paramètres ===
  
−
* Id de l'annuaire  
+
; directoryid
 +
: Id de l'annuaire  
  
−
type :
 
  
−
* «&nbsp;database&nbsp;» ou «&nbsp;group&nbsp;», si omis, le container liste tous les annuaires.
+
=== Variables ===
−
 
+
−
Variables :
+
−
 
+
−
 
+
−
 
+
−
{| style="border-spacing:0;"
+
−
| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| OVDirectoryName
+
−
| style="border:0.002cm solid #000000;padding:0.097cm;"| Intitulé de l’annuaire
+
  
 +
{| class="prettytable"
 +
! Variable
 +
! Valeur
 +
|-
 +
| OVDirectoryName
 +
| Intitulé de l’annuaire
 
|-
 
|-
 
| OVDirectoryDescription
 
| OVDirectoryDescription
 
| Description de l'annuaire
 
| Description de l'annuaire
−
 
 
|-
 
|-
 
| OVDirectoryId
 
| OVDirectoryId
 
| Id de l'annuaire
 
| Id de l'annuaire
−
 
 
|-
 
|-
 
| OVDirectoryUrl
 
| OVDirectoryUrl
 
| Url pour accéder à la liste des membres de l'annuaire
 
| Url pour accéder à la liste des membres de l'annuaire
−
 
 
|-
 
|-
 
| OVDirectoryDelegationId
 
| 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
 
| 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 )
 
  
 +
== OCDbDirectoryFields ==
  
−
<nowiki><OCDbDirectoryFields directoryid="" all="">....</OCDbDirectoryFields></nowiki>
+
Liste les différents champs d'un annuaire ( base de données )
  
 +
=== Syntaxe ===
  
−
Attributs :
+
<pre>
 +
<OCDbDirectoryFields directoryid="" [all=""]>...</OCDbDirectoryFields>
 +
</pre>
  
−
directoryid :
+
=== Paramètres ===
  
−
* Id de l'annuaire<br/>
+
; 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.
  
−
all :
+
=== Variables ===
−
 
+
−
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 :
+
−
 
+
−
 
+
−
 
+
−
{| style="border-spacing:0;"
+
−
| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| OVDirectoryFieldName
+
−
| style="border:0.002cm solid #000000;padding:0.097cm;"| Intitulé du champ
+
  
 +
{| class="prettytable"
 +
! Variable
 +
! Valeur
 +
|-
 +
| OVDirectoryFieldName
 +
| Intitulé du champ
 
|-
 
|-
 
| OVDirectoryFieldId
 
| OVDirectoryFieldId
 
| Identifiant du champ
 
| Identifiant du champ
 +
|}
  
−
|}
 
 
Le tableau ci-dessous donne la correspondance entre les champs et leurs identifiants :
 
Le tableau ci-dessous donne la correspondance entre les champs et leurs identifiants :
  
−
 
+
{| class="prettytable"
−
 
+
! Champ
−
{| style="border-spacing:0;"
+
! Identifiant
−
! <center>Champ</center>
+
−
! <center>Identifiant</center>
+
−
 
+
 
|-
 
|-
 
| Surnom
 
| Surnom
 
| cn
 
| cn
−
 
 
|-
 
|-
 
| Nom
 
| Nom
 
| sn
 
| sn
−
 
 
|-
 
|-
 
| Deuxième prénom
 
| Deuxième prénom
 
| mn
 
| mn
−
 
 
|-
 
|-
 
| Prénom
 
| Prénom
 
| givenname
 
| givenname
−
 
 
|-
 
|-
 
| Photo
 
| Photo
 
| jpegphoto
 
| jpegphoto
−
 
 
|-
 
|-
 
| Adresse de messagerie
 
| Adresse de messagerie
 
| email
 
| email
−
 
 
|-
 
|-
 
| Téléphone (bureau)
 
| Téléphone (bureau)
 
| btel
 
| btel
−
 
 
|-
 
|-
 
| Tél. mobile
 
| Tél. mobile
 
| mobile
 
| mobile
−
 
 
|-
 
|-
 
| Téléphone (domicile)
 
| Téléphone (domicile)
 
| htel
 
| htel
−
 
 
|-
 
|-
 
| Télécopie (bureau)
 
| Télécopie (bureau)
 
| bfax
 
| bfax
−
 
 
|-
 
|-
 
| Titre
 
| Titre
 
| title
 
| title
−
 
 
|-
 
|-
 
| Service
 
| Service
 
| departmentnumber
 
| departmentnumber
−
 
 
|-
 
|-
 
| Société
 
| Société
 
| organisationname
 
| organisationname
−
 
 
|-
 
|-
 
| Rue (bureau)
 
| Rue (bureau)
 
| bstreetaddress
 
| bstreetaddress
−
 
 
|-
 
|-
 
| Ville (bureau)
 
| Ville (bureau)
 
| bcity
 
| bcity
−
 
 
|-
 
|-
 
| Code postal (bureau)
 
| Code postal (bureau)
 
| bpostalcode
 
| bpostalcode
−
 
 
|-
 
|-
 
| Dép/Région (bureau)
 
| Dép/Région (bureau)
 
| bstate
 
| bstate
−
 
 
|-
 
|-
 
| Pays (bureau)
 
| Pays (bureau)
 
| bcountry
 
| bcountry
−
 
 
|-
 
|-
 
| Rue (domicile)
 
| Rue (domicile)
 
| hstreetaddress
 
| hstreetaddress
−
 
 
|-
 
|-
 
| Ville (domicile)
 
| Ville (domicile)
 
| hcity
 
| hcity
−
 
 
|-
 
|-
 
| Code postal (domicile)
 
| Code postal (domicile)
 
| hpostalcode
 
| hpostalcode
−
 
 
|-
 
|-
 
| Dép/Région (domicile)
 
| Dép/Région (domicile)
 
| hstate
 
| hstate
−
 
 
|-
 
|-
 
| Pays (domicile)
 
| Pays (domicile)
 
| hcountry
 
| hcountry
−
 
 
|-
 
|-
 
| Utilisateur 1
 
| Utilisateur 1
 
| user1
 
| user1
−
 
 
|-
 
|-
 
| Utilisateur 2
 
| Utilisateur 2
 
| user2
 
| user2
−
 
 
|-
 
|-
 
| Utilisateur 3
 
| Utilisateur 3
 
| user3
 
| 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 ).
 
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 ==
  
−
== OCDbDirectoryMembers  ==
 
 
Liste les membres d'un annuaire ( base de données )
 
Liste les membres d'un annuaire ( base de données )
  
 +
=== Syntaxe ===
  
−
<nowiki><OCDbDirectoryMembers directoryid="" fields="" all="" orderby="" order="" like="">....</OCDbDirectoryMembers></nowiki>
+
<pre>
 +
<OCDbDirectoryMembers directoryid="" [fields=""] [all=""] [orderby=""] [order=""] [like=""]>...</OCDbDirectoryMembers>
 +
</pre>
  
 +
=== Paramètres ===
  
−
Attributs :
+
; directoryid
 +
: Id de l'annuaire
  
−
directoryid :
+
; 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.
  
−
* Id de l'annuaire<br/>
+
; 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
  
−
all :
+
; order ''(optionnel)''
 +
: asc : ordonne par ordre croissant
 +
: desc : ordonne par ordre décroissant
  
−
Optionnel ( ignoré si l'attribut '''fields''' est spécifié )
+
; like ''(optionnel)''
 +
: Restreint la liste des membres ayant le champ spécifié par orderby (exemple orderby="givenname") commençant par ce motif ( exemple like="A" )
  
−
* 1 : Donne tous les champs pour chaque membre
+
=== Variables ===
−
* 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 «&nbsp;sn,givenname,email&nbsp;»&nbsp;
+
−
 
+
−
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=&nbsp;«&nbsp;A&nbsp;» )
+
−
 
+
−
Variables :
+
−
 
+
−
 
+
−
 
+
−
{| style="border-spacing:0;"
+
−
| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| OVDirectoryMemberId
+
−
| style="border:0.002cm solid #000000;padding:0.097cm;"| Identifiant du membre dans l'annuaire
+
  
 +
{| class="prettytable"
 +
! Variable
 +
! Valeur
 +
|-
 +
| OVDirectoryMemberId
 +
| Identifiant du membre dans l'annuaire
 
|-
 
|-
 
| OVDirectoryMemberUserId
 
| OVDirectoryMemberUserId
 
| Identifiant du membre dans Ovidentia si l'annuaire est un annuaire des utilisateurs enregistrés.
 
| 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
 
Cette variable n'est pas fournie dans le cas des autres annuaires
−
 
 
|-
 
|-
 
| OVDirectoryMemberUrl
 
| OVDirectoryMemberUrl
 
| Url pour accéder à la fiche détaillée du membre
 
| Url pour accéder à la fiche détaillée du membre
−
 
 
|-
 
|-
 
| DirectoryMemberEmailUrl
 
| DirectoryMemberEmailUrl
 
| Url pour afficher la popup de composition de message
 
| Url pour afficher la popup de composition de message
−
 
 
|-
 
|-
 
| OVxxxxxxName
 
| OVxxxxxxName
 
| <nowiki>Intitulé du champ ayant pour identifiant xxxxxxx ( ex <OVgivennameName> ) </nowiki>
 
| <nowiki>Intitulé du champ ayant pour identifiant xxxxxxx ( ex <OVgivennameName> ) </nowiki>
−
 
 
|-
 
|-
 
| OVxxxxxxValue
 
| OVxxxxxxValue
 
| <nowiki>Contenu du champ ayant pour identifiant xxxxxxx ( ex <OVgivennameValue> ) </nowiki>
 
| <nowiki>Contenu du champ ayant pour identifiant xxxxxxx ( ex <OVgivennameValue> ) </nowiki>
−
 
 
|}
 
|}
−
== OCDbDirectoryMemberFields ==
+
 
 +
== OCDbDirectoryMemberFields ==
 +
 
 
Ce container n'est valable que dans le contexte du container '''OCDirectoryMembers'''
 
Ce container n'est valable que dans le contexte du container '''OCDirectoryMembers'''
  
 
Liste les différents champs pour le membre courant.
 
Liste les différents champs pour le membre courant.
  
 +
=== Syntaxe ===
  
−
<nowiki><OCDbDirectoryMemberFields>....</OCDbDirectoryMemberFields></nowiki>
+
<pre>
 +
<OCDbDirectoryMemberFields>...</OCDbDirectoryMemberFields>
 +
</pre>
  
 +
=== Variables ===
  
−
Variables :
+
{| class="prettytable"
−
 
+
! Variable
−
 
+
! Valeur
−
 
+
|-
−
{| style="border-spacing:0;"
+
| OVDirectoryFieldName
−
| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| OVDirectoryFieldName
+
| Intitulé du champ
−
| style="border:0.002cm solid #000000;padding:0.097cm;"| Intitulé du champ
+
−
 
+
 
|-
 
|-
 
| OVDirectoryFieldValue
 
| OVDirectoryFieldValue
 
| Valeur du champ
 
| Valeur du champ
 +
|}
  
−
|}
 
 
== OCDbDirectoryEntry ==
 
== OCDbDirectoryEntry ==
 +
 
Liste les informations concernant un membre d'un annuaire ( base de données )
 
Liste les informations concernant un membre d'un annuaire ( base de données )
  
 +
=== Syntaxe ===
  
−
<nowiki><OCDbDirectoryEntry directoryid="" userid="" </nowiki><nowiki>memberid="">....</OCDbDirectoryEntry></nowiki>
+
<pre>
 +
<OCDbDirectoryEntry directoryid="" memberid="" userid="">...</OCDbDirectoryEntry>
 +
</pre>
  
 +
=== Paramètres ===
  
−
Attributs :
+
; directoryid
 +
: Id de l'annuaire
  
−
directoryid :
+
; memberid
 +
: Id du membre dans l'annuaire
  
−
* Id de l'annuaire<br/>
+
; userid
 +
: Id Ovidentia de l'utilisateur s'il est enregistré
 +
: Ignoré si memberid renseigné.
  
 +
=== Variables ===
  
−
memberid :
+
{| class="prettytable"
−
 
+
! Variable
−
* Id du membre dans l'annuaire
+
! Valeur
−
 
+
|-
−
userid :
+
| OVDirectoryEntryMemberId
−
 
+
| Identifiant du membre dans l'annuaire
−
* Id Ovidentia de l'utilisateur s'il est enregistré<br/> Ignoré si memberid renseigné.<br/>
+
−
 
+
−
 
+
−
Variables :
+
−
 
+
−
 
+
−
 
+
−
{| style="border-spacing:0;"
+
−
| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| OVDirectoryEntryMemberId
+
−
| style="border:0.002cm solid #000000;padding:0.097cm;"| Identifiant du membre dans l'annuaire
+
−
 
+
 
|-
 
|-
 
| OVDirectoryEntryUserId
 
| OVDirectoryEntryUserId
 
| Identifiant du membre dans Ovidentia si l'annuaire est un annuaire des utilisateurs enregistrés.
 
| 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
 
Cette variable n'est pas fournie dans le cas des autres annuaires
−
 
 
|-
 
|-
 
| OVxxxxxxName
 
| OVxxxxxxName
 
| <nowiki>Intitulé du champ ayant pour identifiant xxxxxxx ( ex <OVgivennameName> ) </nowiki>
 
| <nowiki>Intitulé du champ ayant pour identifiant xxxxxxx ( ex <OVgivennameName> ) </nowiki>
−
 
 
|-
 
|-
 
| OVxxxxxxValue
 
| OVxxxxxxValue
 
| <nowiki>Contenu du champ ayant pour identifiant xxxxxxx ( ex <OVgivennameValue> ) </nowiki>
 
| <nowiki>Contenu du champ ayant pour identifiant xxxxxxx ( ex <OVgivennameValue> ) </nowiki>
−
 
 
|-
 
|-
 
| OVDirectoryEntryMemberUrl
 
| OVDirectoryEntryMemberUrl
 
| Url vers la fiche annuaire du membre
 
| Url vers la fiche annuaire du membre
−
 
 
|}
 
|}
−
== OCDbDirectoryEntryFields ==
+
 
 +
== OCDbDirectoryEntryFields ==
 +
 
 
Ce container n'est valable que dans le contexte du container '''OCDirectoryEntry'''
 
Ce container n'est valable que dans le contexte du container '''OCDirectoryEntry'''
  
 
Liste les différents champs pour le membre courant.
 
Liste les différents champs pour le membre courant.
  
 +
=== Syntaxe ===
  
−
<nowiki><OCDbDirectoryEntryFields>....</OCDbDirectoryEntryFields></nowiki>
+
<pre>
 +
<OCDbDirectoryEntryFields>...</OCDbDirectoryEntryFields>
 +
</pre>
  
 +
=== Variables ===
  
−
Variables :
+
{| class="prettytable"
−
 
+
! Variable
−
 
+
! Valeur
−
 
+
|-
−
{| style="border-spacing:0;"
+
| OVDirectoryFieldName
−
| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| OVDirectoryFieldName
+
| Intitulé du champ
−
| style="border:0.002cm solid #000000;padding:0.097cm;"| Intitulé du champ
+
−
 
+
 
|-
 
|-
 
| OVDirectoryFieldValue
 
| OVDirectoryFieldValue
 
| Valeur du champ
 
| Valeur du champ
−
 
 
|}
 
|}
−
== OCDbDirectoryAcl  ==
 
−
Liste les utilisateurs ayant des droits sur un annuaire.
 
  
 +
== OCDbDirectoryAcl ==
  
−
<nowiki><OCDbDirectoryAcl directoryid="" type="">....</OCDbDirectoryAcl></nowiki>
+
Liste les utilisateurs ayant des droits sur un annuaire.
  
 +
=== Syntaxe ===
  
−
Attributs :
+
<pre>
 +
<OCDbDirectoryAcl directoryid="" [type=""]>...</OCDbDirectoryAcl>
 +
</pre>
  
−
directoryid :
+
=== Paramètres ===
  
−
* Id de l'annuaire
+
; directoryid
 +
: Id de l'annuaire
  
−
type :
+
; 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
 +
: delete :  pour les utilisateurs ayant le droit de supprimer une fiche
 +
: export :  pour les utilisateurs ayant le droit d'exporter l'annuaire
 +
: import :  pour les utilisateurs ayant le droit d'importer l'annuaire
 +
: empty :  pour les utilisateurs ayant le droit de vider l'annuaire
 +
: bind :  pour les utilisateurs ayant le droit d'attacher une fiche
 +
: unbind :  pour les utilisateurs ayant le droit de détacher une fiche
 +
: view :  pour les utilisateurs ayant le droit de voir les fiches (DEFAULT)
  
−
* modify : pour les utilisateurs ayant le droit de modifier une fiche
+
=== Variables ===
−
 
+
−
* add : pour les utilisateurs ayant le droit d'ajouter une fiche
+
−
 
+
−
* view : pour les utilisateurs ayant le droit de consulter l'annuaire
+
−
 
+
−
Variables :
+
−
 
+
−
 
+
−
 
+
−
{| style="border-spacing:0;"
+
−
| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| OVUserFullName
+
−
| style="border:0.002cm solid #000000;padding:0.097cm;"| Nom complet de l'utilisateur
+
  
 +
{| class="prettytable"
 +
! Variable
 +
! Valeur
 +
|-
 +
| OVUserFullName
 +
| Nom complet de l'utilisateur
 
|-
 
|-
 
| OVUserEmail
 
| OVUserEmail
 
| Adresse email de l'utilisateur
 
| Adresse email de l'utilisateur
−
 
 
|-
 
|-
 
| OVUserId
 
| OVUserId
 
| Id de l'utilisateur dans la base de données
 
| Id de l'utilisateur dans la base de données
−
 
 
|}
 
|}
−
== OCDelegations  ==
 
−
Liste les délégations dont fait partie l'utilisateur courant.
 
  
 +
== OCDelegations ==
  
−
<nowiki><OCDelegations delegationid="" userid=""</nowiki> filter="'''"'''<nowiki>>....</OCDelegations></nowiki>
+
Liste les délégations dont fait partie l'utilisateur courant.
  
 +
=== Syntaxe ===
  
−
Attributs :
+
<pre>
 +
<OCDelegations [delegationid=""] [userid=""] [filter=""] [imageheightmax=""] [imagewidthmax=""]>...</OCDelegations>
 +
</pre>
  
−
delegationid :
+
=== Paramètres ===
  
−
Optionnel.
+
; 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.
  
−
* Id de la délégation ou plusieurs Ids séparés par une virgule
+
; userid ''(optionnel)''
−
* Si omis, le container liste toutes les délégations dont fait partie l'utilisateur.
+
: Id de l'utilisateur
 +
: Si omis, le container liste les délégations dont fait partie l'utilisateur courant.
  
−
Userid :
+
; 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
  
−
Optionnel
+
; 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.
  
−
* Id de l'utilisateur
+
; imagewidthmax ''(optionnel)''
−
* Si omis, le container liste les délégations dont fait partie l'utilisateur courant.
+
: 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.
  
−
Filter :
+
=== Variables ===
−
 
+
−
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 :
+
−
 
+
−
 
+
−
 
+
−
{| style="border-spacing:0;"
+
−
| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| OVDelegationName
+
−
| style="border:0.002cm solid #000000;padding:0.097cm;"| Intitulé de la délégation
+
  
 +
{| class="prettytable"
 +
! Variable
 +
! Valeur
 +
|-
 +
| OVDelegationName
 +
| Intitulé de la délégation
 
|-
 
|-
 
| OVDelegationDescription
 
| OVDelegationDescription
 
| Description de la délégation
 
| Description de la délégation
−
 
 
|-
 
|-
 
| OVDelegationColor
 
| OVDelegationColor
 
| Couleur associée à la délégation.
 
| Couleur associée à la délégation.
−
 
 
|-
 
|-
 
| OVDelegationId
 
| OVDelegationId
 
| Id de la délégation
 
| Id de la délégation
−
 
 
|-
 
|-
 
| OVDelegationGroupId
 
| OVDelegationGroupId
 
| Id du groupe sur lequel porte la délégation
 
| Id du groupe sur lequel porte la délégation
−
 
 
|-
 
|-
 
| OVDelegationGroupName
 
| OVDelegationGroupName
 
| Nom du groupe
 
| Nom du groupe
−
 
 
|-
 
|-
 
| OVDelegationCategoryId
 
| OVDelegationCategoryId
 
| Id de la catégorie
 
| Id de la catégorie
−
 
 
|-
 
|-
 
| OVDelegationCategoryName
 
| OVDelegationCategoryName
 
| Nom de la catégorie
 
| Nom de la catégorie
−
 
 
|-
 
|-
 
| OVDelegationCategoryDescription
 
| OVDelegationCategoryDescription
 
| Description de la catégorie
 
| Description de la catégorie
−
 
 
|-
 
|-
 
| OVDelegationCategoryColor
 
| OVDelegationCategoryColor
 
| Couleur de la catégorie
 
| Couleur de la catégorie
−
 
 
|-
 
|-
 
| OVDelegationImage
 
| OVDelegationImage
 
| 0 si aucune image est associée, 1 si une image est associée
 
| 0 si aucune image est associée, 1 si une image est associée
−
 
 
|-
 
|-
 
| OVDelegationImageUrl
 
| OVDelegationImageUrl
 
| Url d'affichage de l'image (à utiliser dans une balise img), tient compte des paramètres imageheightmax et imagewidthmax
 
| Url d'affichage de l'image (à utiliser dans une balise img), tient compte des paramètres imageheightmax et imagewidthmax
−
 
 
|-
 
|-
 
| OVDelegationImageWidth
 
| OVDelegationImageWidth
 
| Largeur d'origine de l'image
 
| Largeur d'origine de l'image
−
 
 
|-
 
|-
 
| OVDelegationImageHeight
 
| OVDelegationImageHeight
 
| Hauteur d'origine de l'image
 
| Hauteur d'origine de l'image
−
 
 
|-
 
|-
 
| OVDelegationResizedImageWidth
 
| OVDelegationResizedImageWidth
 
| Largeur de l'image après redimensionnement
 
| Largeur de l'image après redimensionnement
−
 
 
|-
 
|-
 
| OVDelegationResizedImageHeight
 
| OVDelegationResizedImageHeight
 
| Hauteur de l'image après redimensionnement
 
| Hauteur de l'image après redimensionnement
−
 
 
|}
 
|}
−
== OCDelegation  ==
 
−
Liste les informations d'une délégation dont fait partie l'utilisateur courant
 
  
 +
== OCDelegation ==
  
−
<nowiki><OCDelegation delegationid="" userid="">....</OCDelegation></nowiki>
+
Liste les informations d'une délégation dont fait partie l'utilisateur courant
  
 +
=== Syntaxe ===
  
−
Attributs :
+
<pre>
 +
<OCDelegation delegationid="" [userid=""] [imageheightmax=""] [imagewidthmax=""]>...</OCDelegation>
 +
</pre>
  
−
delegationid :
+
=== Paramètres ===
  
−
* Id de la délégation  
+
; delegationid
 +
: Id de la délégation  
  
−
userid :
+
; userid ''(optionnel)''
 +
: Id de l'utilisateur
 +
: Si omis, le container utilise l'id de l'utilisateur courant.
  
−
Optionnel
+
; 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.
  
−
* Id de l'utilisateur
+
; imagewidthmax ''(optionnel)''
−
* Si omis, le container utilise l'id de l'utilisateur courant.
+
: 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.
  
−
imageheightmax:
+
=== Variables ===
−
 
+
−
* 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 :
+
−
 
+
−
 
+
−
 
+
−
{| style="border-spacing:0;"
+
−
| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| OVDelegationName
+
−
| style="border:0.002cm solid #000000;padding:0.097cm;"| Intitulé de la délégation
+
  
 +
{| class="prettytable"
 +
! Variable
 +
! Valeur
 +
|-
 +
| OVDelegationName
 +
| Intitulé de la délégation
 
|-
 
|-
 
| OVDelegationDescription
 
| OVDelegationDescription
 
| Description de la délégation
 
| Description de la délégation
−
 
 
|-
 
|-
 
| OVDelegationColor
 
| OVDelegationColor
 
| Couleur associée à la délégation.
 
| Couleur associée à la délégation.
−
 
 
|-
 
|-
 
| OVDelegationId
 
| OVDelegationId
 
| Id de la délégation
 
| Id de la délégation
−
 
 
|-
 
|-
 
| OVDelegationGroupId
 
| OVDelegationGroupId
 
| Id du groupe sur lequel porte la délégation
 
| Id du groupe sur lequel porte la délégation
−
 
 
|-
 
|-
 
| OVDelegationGroupName
 
| OVDelegationGroupName
 
| Nom du groupe
 
| Nom du groupe
−
 
 
|-
 
|-
 
| OVDelegationCategoryId
 
| OVDelegationCategoryId
 
| Id de la catégorie
 
| Id de la catégorie
−
 
 
|-
 
|-
 
| OVDelegationCategoryName
 
| OVDelegationCategoryName
 
| Nom de la catégorie
 
| Nom de la catégorie
−
 
 
|-
 
|-
 
| OVDelegationCategoryDescription
 
| OVDelegationCategoryDescription
 
| Description de la catégorie
 
| Description de la catégorie
−
 
 
|-
 
|-
 
| OVDelegationCategoryColor
 
| OVDelegationCategoryColor
 
| Couleur de la catégorie
 
| Couleur de la catégorie
−
 
 
|-
 
|-
 
| OVDelegationImage
 
| OVDelegationImage
 
| 0 si aucune image est associée, 1 si une image est associée
 
| 0 si aucune image est associée, 1 si une image est associée
−
 
 
|-
 
|-
 
| OVDelegationImageUrl
 
| OVDelegationImageUrl
 
| Url d'affichage de l'image (à utiliser dans une balise img), tient compte des paramètres imageheightmax et imagewidthmax
 
| Url d'affichage de l'image (à utiliser dans une balise img), tient compte des paramètres imageheightmax et imagewidthmax
−
 
 
|-
 
|-
 
| OVDelegationImageWidth
 
| OVDelegationImageWidth
 
| Largeur d'origine de l'image
 
| Largeur d'origine de l'image
−
 
 
|-
 
|-
 
| OVDelegationImageHeight
 
| OVDelegationImageHeight
 
| Hauteur d'origine de l'image
 
| Hauteur d'origine de l'image
−
 
 
|-
 
|-
 
| OVDelegationResizedImageWidth
 
| OVDelegationResizedImageWidth
 
| Largeur de l'image après redimensionnement
 
| Largeur de l'image après redimensionnement
−
 
 
|-
 
|-
 
| OVDelegationResizedImageHeight
 
| OVDelegationResizedImageHeight
 
| Hauteur de l'image après redimensionnement
 
| Hauteur de l'image après redimensionnement
−
 
 
|}
 
|}
−
== OCDelegationsManaged  ==
 
−
Liste les délégations dont l'utilisateur courant est administrateur délégué.
 
  
 +
== OCDelegationsManaged ==
  
−
<nowiki><OCDelegationsManaged delegationid="" userid="">....</OCDelegationsManaged></nowiki>
+
Liste les délégations dont l'utilisateur courant est administrateur délégué.
  
 +
=== Syntaxe ===
  
−
Attributs :
+
<pre>
 +
<OCDelegationsManaged [delegationid=""] [userid=""] [imageheightmax=""] [imagewidthmax=""]>....</OCDelegationsManaged>
 +
</pre>
  
−
delegationid :
+
=== Paramètres ===
  
−
Optionnel.
+
; 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.
  
−
* Id de la délégation ou plusieurs Ids séparés par une virgule
+
; userid ''(optionnel)''
−
* Si omis, le container liste toutes les délégations dont fait partie l'utilisateur.
+
: Id de l'utilisateur
 +
: Si omis, le container liste les délégations dont l'utilisateur courant est administrateur.
  
−
Userid :
+
; 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.
  
−
Optionnel
+
; 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.
  
−
* Id de l'utilisateur
+
=== Variables ===
−
* 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 :
+
−
 
+
−
 
+
−
 
+
−
{| style="border-spacing:0;"
+
−
| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| OVDelegationName
+
−
| style="border:0.002cm solid #000000;padding:0.097cm;"| Intitulé de la délégation
+
  
 +
{| class="prettytable"
 +
! Variable
 +
! Valeur
 +
|-
 +
| OVDelegationName
 +
| Intitulé de la délégation
 
|-
 
|-
 
| OVDelegationDescription
 
| OVDelegationDescription
 
| Description de la délégation
 
| Description de la délégation
−
 
 
|-
 
|-
 
| OVDelegationColor
 
| OVDelegationColor
 
| Couleur associée à la délégation.
 
| Couleur associée à la délégation.
−
 
 
|-
 
|-
 
| OVDelegationId
 
| OVDelegationId
 
| Id de la délégation
 
| Id de la délégation
−
 
 
|-
 
|-
 
| OVDelegationGroupId
 
| OVDelegationGroupId
 
| Id du groupe sur lequel porte la délégation
 
| Id du groupe sur lequel porte la délégation
−
 
 
|-
 
|-
 
| OVDelegationGroupName
 
| OVDelegationGroupName
 
| Nom du groupe
 
| Nom du groupe
−
 
 
|-
 
|-
 
| OVDelegationCategoryId
 
| OVDelegationCategoryId
 
| Id de la catégorie
 
| Id de la catégorie
−
 
 
|-
 
|-
 
| OVDelegationCategoryName
 
| OVDelegationCategoryName
 
| Nom de la catégorie
 
| Nom de la catégorie
−
 
 
|-
 
|-
 
| OVDelegationCategoryDescription
 
| OVDelegationCategoryDescription
 
| Description de la catégorie
 
| Description de la catégorie
−
 
 
|-
 
|-
 
| OVDelegationCategoryColor
 
| OVDelegationCategoryColor
 
| Couleur de la catégorie
 
| Couleur de la catégorie
−
 
 
|-
 
|-
 
| OVDelegationImage
 
| OVDelegationImage
 
| 0 si aucune image est associée, 1 si une image est associée
 
| 0 si aucune image est associée, 1 si une image est associée
−
 
 
|-
 
|-
 
| OVDelegationImageUrl
 
| OVDelegationImageUrl
 
| Url d'affichage de l'image (à utiliser dans une balise img), tient compte des paramètres imageheightmax et imagewidthmax
 
| Url d'affichage de l'image (à utiliser dans une balise img), tient compte des paramètres imageheightmax et imagewidthmax
−
 
 
|-
 
|-
 
| OVDelegationImageWidth
 
| OVDelegationImageWidth
 
| Largeur d'origine de l'image
 
| Largeur d'origine de l'image
−
 
 
|-
 
|-
 
| OVDelegationImageHeight
 
| OVDelegationImageHeight
 
| Hauteur d'origine de l'image
 
| Hauteur d'origine de l'image
−
 
 
|-
 
|-
 
| OVDelegationResizedImageWidth
 
| OVDelegationResizedImageWidth
 
| Largeur de l'image après redimensionnement
 
| Largeur de l'image après redimensionnement
−
 
 
|-
 
|-
 
| OVDelegationResizedImageHeight
 
| OVDelegationResizedImageHeight
 
| Hauteur de l'image après redimensionnement
 
| 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é.
 
  
 +
== OCDelegationManaged ==
  
−
<nowiki><OCDelegationManaged delegationid="" userid="">....</OCDelegationManaged></nowiki>
+
Liste les informations d'une délégation dont l'utilisateur courant est administrateur délégué.
  
 +
=== Syntaxe ===
  
−
Attributs :
+
<pre>
 +
<OCDelegationManaged delegationid="" [userid=""] [imageheightmax=""] [imagewidthmax=""]>...</OCDelegationManaged>
 +
</pre>
  
−
delegationid :
+
=== Paramètres ===
  
−
* Id de la délégation  
+
; delegationid
 +
: Id de la délégation  
  
−
userid :
+
; userid ''(optionnel)''
 +
: Id de l'utilisateur
 +
: Si omis, le container utilise l'id de l'utilisateur courant.
  
−
Optionnel
+
; 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.
  
−
* Id de l'utilisateur
+
; imagewidthmax ''(optionnel)''
−
* Si omis, le container utilise l'id de l'utilisateur courant.
+
: 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.
  
−
imageheightmax:
+
=== Variables ===
−
 
+
−
* 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 :
+
−
 
+
−
 
+
−
 
+
−
{| style="border-spacing:0;"
+
−
| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| OVDelegationName
+
−
| style="border:0.002cm solid #000000;padding:0.097cm;"| Intitulé de la délégation
+
  
 +
{| class="prettytable"
 +
! Variable
 +
! Valeur
 +
|-
 +
| OVDelegationName
 +
| Intitulé de la délégation
 
|-
 
|-
 
| OVDelegationDescription
 
| OVDelegationDescription
 
| Description de la délégation
 
| Description de la délégation
−
 
 
|-
 
|-
 
| OVDelegationColor
 
| OVDelegationColor
 
| Couleur associée à la délégation.
 
| Couleur associée à la délégation.
−
 
 
|-
 
|-
 
| OVDelegationId
 
| OVDelegationId
 
| Id de la délégation
 
| Id de la délégation
−
 
 
|-
 
|-
 
| OVDelegationGroupId
 
| OVDelegationGroupId
 
| Id du groupe sur lequel porte la délégation
 
| Id du groupe sur lequel porte la délégation
−
 
 
|-
 
|-
 
| OVDelegationGroupName
 
| OVDelegationGroupName
 
| Nom du groupe
 
| Nom du groupe
−
 
 
|-
 
|-
 
| OVDelegationCategoryId
 
| OVDelegationCategoryId
 
| Id de la catégorie
 
| Id de la catégorie
−
 
 
|-
 
|-
 
| OVDelegationCategoryName
 
| OVDelegationCategoryName
 
| Nom de la catégorie
 
| Nom de la catégorie
−
 
 
|-
 
|-
 
| OVDelegationCategoryDescription
 
| OVDelegationCategoryDescription
 
| Description de la catégorie
 
| Description de la catégorie
−
 
 
|-
 
|-
 
| OVDelegationCategoryColor
 
| OVDelegationCategoryColor
 
| Couleur de la catégorie
 
| Couleur de la catégorie
−
 
 
|-
 
|-
 
| OVDelegationImage
 
| OVDelegationImage
 
| 0 si aucune image est associée, 1 si une image est associée
 
| 0 si aucune image est associée, 1 si une image est associée
−
 
 
|-
 
|-
 
| OVDelegationImageUrl
 
| OVDelegationImageUrl
 
| Url d'affichage de l'image (à utiliser dans une balise img), tient compte des paramètres imageheightmax et imagewidthmax
 
| Url d'affichage de l'image (à utiliser dans une balise img), tient compte des paramètres imageheightmax et imagewidthmax
−
 
 
|-
 
|-
 
| OVDelegationImageWidth
 
| OVDelegationImageWidth
 
| Largeur d'origine de l'image
 
| Largeur d'origine de l'image
−
 
 
|-
 
|-
 
| OVDelegationImageHeight
 
| OVDelegationImageHeight
 
| Hauteur d'origine de l'image
 
| Hauteur d'origine de l'image
−
 
 
|-
 
|-
 
| OVDelegationResizedImageWidth
 
| OVDelegationResizedImageWidth
 
| Largeur de l'image après redimensionnement
 
| Largeur de l'image après redimensionnement
−
 
 
|-
 
|-
 
| OVDelegationResizedImageHeight
 
| OVDelegationResizedImageHeight
 
| Hauteur de l'image après redimensionnement
 
| 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.
 
  
 +
== OCDelegationItems ==
  
−
<nowiki><OCDelegationItems delegationid="">....</OCDelegationItems></nowiki>
+
Liste les fonctions déléguées aux administrateurs délégués d'une délégation.
  
 +
=== Syntaxe ===
  
−
Attributs :
+
<pre>
 +
<OCDelegationItems delegationid="">...</OCDelegationItems>
 +
</pre>
  
−
delegationid :
+
=== Paramètres ===
  
−
* Id de la délégation  
+
; delegationid
 +
: Id de la délégation  
  
−
Variables :
+
=== Variables ===
−
 
+
−
 
+
−
 
+
−
{| style="border-spacing:0;"
+
−
| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| OVDelegationItemName
+
−
| style="border:0.002cm solid #000000;padding:0.097cm;"| Intitulé de la fonction
+
  
 +
{| class="prettytable"
 +
! Variable
 +
! Valeur
 +
|-
 +
| OVDelegationItemName
 +
| Intitulé de la fonction
 
|-
 
|-
 
| OVDelegationItemValue
 
| OVDelegationItemValue
 
| 1: si la fonction est déléguée, 0 sinon
 
| 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.
 
  
 +
== OCDelegationAdministrators ==
  
−
<nowiki><OCDelegationAdministrators delegationid="">....</OCDelegationAdministrators></nowiki>
+
Retourne la liste des administrateurs délégués d'une délégation.
  
 +
=== Syntaxe ===
  
−
Attributs :
+
<pre>
 +
<OCDelegationAdministrators delegationid="">...</OCDelegationAdministrators>
 +
</pre>
  
−
delegationid :
+
=== Paramètres ===
  
−
* Id de la délégation  
+
; delegationid
 +
: Id de la délégation  
  
−
Variables :
+
=== Variables ===
  
 +
{| class="prettytable"
 +
! Variable
 +
! Valeur
 +
|-
 +
| OVDelegationUserId
 +
| Id de l'administrateur
 +
|}
  
 +
== OCDelegationsCategories ==
  
−
{| style="border-spacing:0;"
 
−
| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| OVDelegationUserId
 
−
| style="border:0.002cm solid #000000;padding:0.097cm;"| Id de l'administrateur
 
−
 
−
|}
 
−
== OCDelegationsCategories  ==
 
 
Liste les catégories de délégations.
 
Liste les catégories de délégations.
  
 +
=== Syntaxe ===
  
−
<nowiki><OCDelegationsCategories categoryid="">....</OCDelegationsCategories></nowiki>
+
<pre>
 +
<OCDelegationsCategories [categoryid=""]>....</OCDelegationsCategories>
 +
</pre>
  
 +
=== Paramètres ===
  
−
Attributs :
+
; categoryid ''(optionnel)''
 +
: Id de la délégation
 +
: Si omis, le container liste toutes les catégories
  
−
categoryid :
+
=== Variables ===
−
 
+
−
Optionnel
+
−
 
+
−
* Id de la délégation
+
−
* Si omis, le container liste toutes les catégories
+
−
 
+
−
Variables :
+
−
 
+
−
 
+
−
 
+
−
{| style="border-spacing:0;"
+
−
| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| OVDelegationCategoryId
+
−
| style="border:0.002cm solid #000000;padding:0.097cm;"| Id de la catégorie
+
  
 +
{| class="prettytable"
 +
! Variable
 +
! Valeur
 +
|-
 +
| OVDelegationCategoryId
 +
| Id de la catégorie
 
|-
 
|-
 
| OVDelegationCategoryName
 
| OVDelegationCategoryName
 
| Nom de la catégorie
 
| Nom de la catégorie
−
 
 
|-
 
|-
 
| OVDelegationCategoryDescription
 
| OVDelegationCategoryDescription
 
| Description de la catégorie
 
| Description de la catégorie
−
 
 
|-
 
|-
 
| OVDelegationCategoryColor
 
| OVDelegationCategoryColor
 
| Couleur de la catégorie
 
| Couleur de la catégorie
−
 
 
|}
 
|}
−
== OCDelegationsCategory  ==
 
−
Liste les informations d'une catégorie de délégations.
 
  
 +
== OCDelegationsCategory ==
  
−
<nowiki><OCDelegationsCategory categoryid="">....</OCDelegationsCategory></nowiki>
+
Liste les informations d'une catégorie de délégations.
  
 +
=== Syntaxe ===
  
−
Attributs :
+
<pre>
 +
<OCDelegationsCategory [categoryid=""]>...</OCDelegationsCategory>
 +
</pre>
  
−
categoryid :
+
=== Paramètres ===
  
−
* Id de la délégation  
+
; categoryid
 +
: Id de la délégation  
  
−
Variables :
+
=== Variables ===
−
 
+
−
 
+
−
 
+
−
{| style="border-spacing:0;"
+
−
| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| OVDelegationCategoryId
+
−
| style="border:0.002cm solid #000000;padding:0.097cm;"| Id de la catégorie
+
  
 +
{| class="prettytable"
 +
! Variable
 +
! Valeur
 +
|-
 +
| OVDelegationCategoryId
 +
| Id de la catégorie
 
|-
 
|-
 
| OVDelegationCategoryName
 
| OVDelegationCategoryName
 
| Nom de la catégorie
 
| Nom de la catégorie
−
 
 
|-
 
|-
 
| OVDelegationCategoryDescription
 
| OVDelegationCategoryDescription
 
| Description de la catégorie
 
| Description de la catégorie
−
 
 
|-
 
|-
 
| OVDelegationCategoryColor
 
| OVDelegationCategoryColor
 
| Couleur de la catégorie
 
| Couleur de la catégorie
−
 
 
|}
 
|}
−
== OCTmSpaces  ==
 
−
Liste les espaces de projets du gestionnaire de tâches.
 
  
 +
== OCTmSpaces ==
  
−
<nowiki><OCTmSpaces>....</OCTmSpaces></nowiki>
+
Liste les espaces de projets du gestionnaire de tâches.
  
 +
=== Syntaxe ===
  
−
Attributs :
+
<pre>
 +
<OCTmSpaces>...</OCTmSpaces>
 +
</pre>
  
−
Aucun attribut
+
=== Variables ===
−
 
+
−
 
+
−
Variables :
+
−
 
+
−
 
+
−
 
+
−
{| style="border-spacing:0;"
+
−
| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| OVSpaceId
+
−
| style="border:0.002cm solid #000000;padding:0.097cm;"| Id de l'espace de projet
+
  
 +
{| class="prettytable"
 +
! Variable
 +
! Valeur
 +
|-
 +
| OVSpaceId
 +
| Id de l'espace de projet
 
|-
 
|-
 
| OVSpaceName
 
| OVSpaceName
 
| Nom de l'espace de projet
 
| Nom de l'espace de projet
−
 
 
|-
 
|-
 
| OVSpaceDescription
 
| OVSpaceDescription
 
| Description de l'espace de projet
 
| Description de l'espace de projet
−
 
 
|}
 
|}
−
== OCTmProjects  ==
 
−
Liste les projets d'un espace de projets du gestionnaire de tâches.
 
  
 +
== OCTmProjects ==
  
−
<nowiki><OCTmProjects spaceid="">....</OCTmProjects></nowiki>
+
Liste les projets d'un espace de projets du gestionnaire de tâches.
  
 +
=== Syntaxe ===
  
−
Attributs :
+
<pre>
 +
<OCTmProjects spaceid="">...</OCTmProjects>
 +
</pre>
  
−
spaceid :
+
=== Paramètres ===
  
−
* Id de l'espace de projets
+
; spaceid
 +
: Id de l'espace de projets
  
−
Variables :
+
=== Variables ===
−
 
+
−
 
+
−
 
+
−
{| style="border-spacing:0;"
+
−
| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| OVProjectId
+
−
| style="border:0.002cm solid #000000;padding:0.097cm;"| Id du projet
+
  
 +
{| class="prettytable"
 +
! Variable
 +
! Valeur
 +
|-
 +
| OVProjectId
 +
| Id du projet
 
|-
 
|-
 
| OVProjectName
 
| OVProjectName
 
| Nom du projet
 
| Nom du projet
−
 
 
|-
 
|-
 
| OVProjectDescription
 
| OVProjectDescription
 
| Description du projet
 
| Description du projet
−
 
 
|}
 
|}
−
== OCTmTasks  ==
 
−
Liste les tâches d'un projet ou des tâches personnelles du gestionnaire de tâches.
 
  
 +
== OCTmTasks ==
  
−
<nowiki><OCTmTasks projectid="">....</OCTmTasks></nowiki>
+
Liste les tâches d'un projet ou des tâches personnelles du gestionnaire de tâches.
  
 +
=== Syntaxe ===
  
−
Attributs :
+
<pre>
 +
<OCTmTasks [projectid=""] [startdate=""] [enddate=""] [order=""] [orderby=""]>....</OCTmTasks>
 +
</pre>
  
−
projectid&nbsp;:
+
=== Paramètres ===
  
−
Optionnel
+
; projectid ''(optionnel)''
 +
: Id du projet.
 +
: Si omis, le conteneur renvoie les tâches personnelles de l'utilisateur courant.
  
−
* Id du projet.
+
; startdate ''(optionnel)''
−
* Si omis, le conteneur renvoie les tâches personnelles de l'utilisateur courant.
+
: 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
  
−
startdate&nbsp;:
+
; 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
  
−
Optionnel.
+
; 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".
  
−
* Filtre les tâches dont la date de début est postérieure à cette date.
+
; orderby ''(optionnel)''
−
* Le format de la date doit être aaaa-mm-jj
+
: 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"
  
−
enddate&nbsp;:
+
=== Variables ===
−
 
+
−
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&nbsp;:
+
−
 
+
−
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&nbsp;:
+
−
 
+
−
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 :
+
−
 
+
−
 
+
−
 
+
−
{| style="border-spacing:0;"
+
−
| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| OVTaskId
+
−
| style="border:0.002cm solid #000000;padding:0.097cm;"| Id de la tâche
+
  
 +
{| class="prettytable"
 +
! Variable
 +
! Valeur
 +
|-
 +
| OVTaskId
 +
| Id de la tâche
 
|-
 
|-
 
| OVTaskProjectId
 
| OVTaskProjectId
 
| Id du projet de la tâche
 
| Id du projet de la tâche
−
 
 
|-
 
|-
 
| OVTaskNumber
 
| OVTaskNumber
 
| Numéro de la tâche
 
| Numéro de la tâche
−
 
 
|-
 
|-
 
| OVTaskShortDescription
 
| OVTaskShortDescription
 
| Description courte de la tâche
 
| Description courte de la tâche
−
 
 
|-
 
|-
 
| OVTaskStartDate
 
| OVTaskStartDate
 
| Date de début de la tâche
 
| Date de début de la tâche
−
 
 
|-
 
|-
 
| OVTaskEndDate
 
| OVTaskEndDate
 
| Date de fin de la tâche
 
| Date de fin de la tâche
−
 
 
|-
 
|-
 
| OVTaskCategoryId
 
| OVTaskCategoryId
 
| Id de la catégorie de la tâche
 
| Id de la catégorie de la tâche
−
 
 
|-
 
|-
 
| OVTaskCategoryName
 
| OVTaskCategoryName
 
| Nom de la catégorie de la tâche
 
| Nom de la catégorie de la tâche
−
 
 
|-
 
|-
 
| OVTaskCompletion
 
| OVTaskCompletion
 
| Niveau d'avancement de la tâche (0-100)
 
| Niveau d'avancement de la tâche (0-100)
−
 
 
|-
 
|-
 
| OVTaskOwnerId
 
| OVTaskOwnerId
 
| Id de l'utilisateur propriétaire de la tâche
 
| Id de l'utilisateur propriétaire de la tâche
−
 
 
|-
 
|-
 
| OVTaskClass
 
| OVTaskClass
 
| Classe de la tâche
 
| Classe de la tâche
−
 
 
|}
 
|}
 +
 
== OCOrgUserEntities ==
 
== OCOrgUserEntities ==
 +
 
Liste les entités d'organigrammes pour lesquelles un utilisateur à un rôle.
 
Liste les entités d'organigrammes pour lesquelles un utilisateur à un rôle.
  
 +
=== Syntaxe ===
  
−
<nowiki><OCOrgUserEntities orgChartId=""</nowiki> userId="" roleType="" ><nowiki>....</OCOrgUserEntities></nowiki>
+
<pre>
 +
<OCOrgUserEntities userId="" [orgChartId=""] [roleType=""]>...</OCOrgUserEntities>
 +
</pre>
  
 +
=== Paramètres ===
  
−
Attributs :
+
; userId
 +
: Identifiant (entier) de l'utilisateur.
  
−
orgChartId&nbsp;:
+
; 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é.
  
−
Optionnel
+
; 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
  
−
* Identifiant (entier) de l'organigramme.
+
=== Variables ===
−
* Si ce paramètre est omis alors c'est l'organigramme par défaut (nommé à l'origine Ovidentia) qui est utilisé.<br/>
+
  
 +
{| class="prettytable"
 +
! Variable
 +
! Valeur
 +
|-
 +
| OVEntityId
 +
| Identifiant (entier) de l'entité
 +
|-
 +
| OVEntityName
 +
| Nom de l'entité
 +
|-
 +
| OVEntityDescription
 +
| Description de l'entité
 +
|}
  
−
userId&nbsp;:
+
== OCOrgPathToEntity ==
  
−
* Identifiant (entier) de l'utilisateur.<br/>
+
Liste toutes les entités parentes d'une entité d'un organigramme.
  
 +
<pre>
 +
<OCOrgPathToEntity entityId="" [order=""] [includeEntity=""]>...</OCOrgPathToEntity>
 +
</pre>
  
−
roleType&nbsp;:
+
=== Paramètres ===
  
−
Optionnel.
+
; entityId
 +
: Identifiant (entier) de l'entité.
  
−
* Si ce paramètre est omis alors tous les rôles seront utilisés.
+
; order ''(optionnel)''
−
* Les rôles sont des valeurs de 0 à 3
+
: Si ce paramètre est omis alors c'est l'ordre ascendant qui est utilisé.
−
* 0 étant les rôles personnalisés
+
: Ordre dans lequel le chemin jusqu'à la racine sera retourné, les valeurs possible sont asc ou desc<br/>
−
* 1 étant le rôle supérieur
+
−
* 2 étant le rôle employé
+
−
* 3 étant le rôle membre
+
  
−
Variables :
+
; includeEntity ''(optionnel)''
 +
: Si ce paramètre est omis, alors l'entité ne sera pas incluse dans les résultats.
 +
: Les valeurs possibles sont&nbsp;:
 +
: 0 pour ne pas inclure l'entité (valeur par défaut)
 +
: 1 pour inclure l'entité<br/>
  
 +
=== Variables ===
  
−
 
+
{| class="prettytable"
−
{| style="border-spacing:0;"
+
! Variable
−
| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| OVEntityId
+
! Valeur
−
| style="border:0.002cm solid #000000;padding:0.097cm;"| Identifiant (entier) de l'entité
+
|-
−
 
+
| OVEntityId
 +
| Identifiant (entier) de l'entité
 
|-
 
|-
 
| OVEntityName
 
| OVEntityName
 
| Nom de l'entité
 
| Nom de l'entité
−
 
 
|-
 
|-
 
| OVEntityDescription
 
| OVEntityDescription
 
| Description de l'entité
 
| Description de l'entité
−
 
 
|}
 
|}
−
== OCOrgPathToEntity ==
 
−
Liste toutes les entités parentes d'une entité d'un organigramme.
 
  
 +
== OCOrgChildEntities ==
  
−
<nowiki><OCOrgPathToEntity entityId="" order="" includeEntity=""> </nowiki>
+
Liste toutes les entités enfant directes d'une entité d'un organigramme.
 +
: ''Depuis Ovidentia '''<span class="version">8.6.100</span>'''''
  
−
...
+
<pre>
 +
<OCOrgChildEntities entityId="" >...</OCOrgChildEntities>
 +
</pre>
  
−
<nowiki></</nowiki>OCOrgPathToEntity>
+
=== Paramètres ===
  
 +
; entityId
 +
: Identifiant (entier) de l'entité.
  
−
Attributs :
+
=== Variables ===
−
 
+
−
entityId&nbsp;:
+
−
 
+
−
* Identifiant (entier) de l'entité.<br/>
+
−
 
+
−
 
+
−
order&nbsp;:
+
−
 
+
−
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<br/>
+
−
 
+
−
 
+
−
includeEntity :
+
−
 
+
−
Optionnel.
+
−
 
+
−
* Si ce paramètre est omis, alors l'entité ne sera pas incluse dans les résultats.
+
−
* Les valeurs possibles sont&nbsp;:
+
−
* 0 pour ne pas inclure l'entité (valeur par défaut)
+
−
* 1 pour inclure l'entité<br/>
+
−
 
+
−
 
+
−
Variables :
+
−
 
+
−
 
+
−
 
+
−
{| style="border-spacing:0;"
+
−
| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| OVEntityId
+
−
| style="border:0.002cm solid #000000;padding:0.097cm;"| Identifiant (entier) de l'entité
+
  
 +
{| class="prettytable"
 +
! Variable
 +
! Valeur
 +
|-
 +
| OVEntityId
 +
| Identifiant (entier) de l'entité
 
|-
 
|-
 
| OVEntityName
 
| OVEntityName
 
| Nom de l'entité
 
| Nom de l'entité
−
 
 
|-
 
|-
 
| OVEntityDescription
 
| OVEntityDescription
 
| Description de l'entité
 
| 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.
 
  
 +
== OCOrgEntityMembers ==
  
−
<nowiki><OCMultipages total="" maxpages="" perpage="" currentpage=""> </nowiki>
+
Liste tous les membres d'une entité.
 +
: ''Depuis Ovidentia '''<span class="version">8.6.100</span>'''''
  
−
...
+
<pre>
 +
<OCOrgEntityMembers entityId="" >...</OCOrgEntityMembers>
 +
</pre>
  
−
<nowiki></</nowiki>OCMultipages>
+
=== Paramètres ===
  
 +
; entityId
 +
: Identifiant (entier) de l'entité.
  
−
Attributs :
+
=== Variables ===
  
−
total :
+
{| class="prettytable"
 +
! Variable
 +
! Valeur
 +
|-
 +
| EntityMemberDirEntryId
 +
| Identifiant (entier) de la fiche annuaire de l'utilisateur
 +
|-
 +
| EntityMemberRoleType
 +
| Id du rôle : 1 = Superior, 2 = Temporary employee, 3 = Members, 0 = Other collaborators
 +
|-
 +
| EntityMemberRoleName
 +
| Nom du rôle
 +
|-
 +
| EntityMemberUserDisabled
 +
| Utilisateur est désactivé (1 ou 0)
 +
|-
 +
| EntityMemberUserConfirmed
 +
| Utilisateur est confirmé (1 ou 0)
 +
|-
 +
| EntityMemberSn
 +
| Nom
 +
|-
 +
| EntityMemberGivenname
 +
| Prénom
 +
|-
 +
| EntityMemberUserId
 +
| Id user correspondant
 +
|}
  
−
* Nombre total de résultats.
+
== OCMultipages ==
  
−
maxpages :
+
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.
  
−
* Nombre maximum de pages à afficher
+
=== Syntaxe ===
  
−
perpage :
+
<pre>
 +
<OCMultipages total="" maxpages="" perpage="" currentpage="">...</OCMultipages>
 +
</pre>
  
−
* Nombre maximum de résultats à afficher par pages
+
=== Paramètres ===
  
−
currentpage :
+
; total
 +
: Nombre total de résultats.
  
−
* Numéro de la page en cours<br/>
+
; maxpages
 +
: Nombre maximum de pages à afficher
  
 +
; perpage
 +
: Nombre maximum de résultats à afficher par pages
  
−
Variables:
+
; currentpage
 +
: Numéro de la page en cours
  
 +
=== Variables ===
  
−
 
+
{| class="prettytable"
−
{| style="border-spacing:0;"
+
! Variable
−
| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| OVCurrentPageNumber  
+
! Valeur
−
| style="border:0.002cm solid #000000;padding:0.097cm;"| Numéro de la page courante
+
|-
−
 
+
| OVCurrentPageNumber  
 +
| Numéro de la page courante
 
|-
 
|-
 
| OVNextPageNumber
 
| OVNextPageNumber
 
| Numéro de la page suivante si elle existe, valeur vide sinon
 
| Numéro de la page suivante si elle existe, valeur vide sinon
−
 
 
|-
 
|-
 
| OVPreviousPageNumber
 
| OVPreviousPageNumber
 
| Numéro de la page précédente si elle existe, valeur vide sinon
 
| Numéro de la page précédente si elle existe, valeur vide sinon
−
 
 
|-
 
|-
 
| OVTotalPages
 
| OVTotalPages
 
| Nombre total de pages
 
| Nombre total de pages
−
 
 
|-
 
|-
 
| OVResultFirst
 
| OVResultFirst
 
| Index du premier résultat de la page courante
 
| Index du premier résultat de la page courante
−
 
 
|-
 
|-
 
| OVResultLast
 
| OVResultLast
 
| Index du dernier résultat de la page courante
 
| Index du dernier résultat de la page courante
−
 
 
|-
 
|-
 
| OVResultsPage
 
| OVResultsPage
 
| Nombre de résultats sur la page courante
 
| Nombre de résultats sur la page courante
−
 
 
|}
 
|}
 +
 
== OCSitemapEntries ==
 
== 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).
 
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).
  
−
===== Exemple =====
+
=== Syntaxe ===
  
−
<OCSitemapEntries node="" sitemap="" limit="">....</OCSitemapEntries>
+
<pre>
 +
<OCSitemapEntries (node="" | langid="") [sitemap=""] [limit=""]>...</OCSitemapEntries>
 +
</pre>
  
−
===== Attributs =====
+
=== Paramètres ===
  
−
<dl>
+
; node
−
<dt>node ''(obligatoire)'' :
+
: Identifiant de l'élément parent (noeud du plan du site). Les éléments enfants seront retournés.
−
<dd>Identifiant de l'élément parent (noeud du plan du site). Les éléments enfants seront retournés.
+
: Exemple : babUserSection, babUserSectionAddons, babArticles, babFaqs, Custom...
−
Exemple : babUserSection, babUserSectionAddons, babArticles, babFaqs, Custom...
+
−
Si node n'est pas spécifié,
+
  
−
<dt>sitemap ''(optionnel)'' :
+
; langid
−
<dd>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é.
+
: 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
  
−
<dt>limit ''(optionnel)'' :
+
; sitemap ''(optionnel)''
−
<dd>Permet de limiter le nombre d'éléments renvoyés par le conteneur :
+
: 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é.
−
* 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.
+
−
</dl>
+
  
−
===== Variables =====
+
; 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 ===
  
 
{| class="prettytable"
 
{| class="prettytable"
 +
! Variable
 +
! Valeur
 +
|-
 
| OVSitemapEntryId
 
| OVSitemapEntryId
 
| Identifiant unique de l'entrée (chaîne de caractères)
 
| Identifiant unique de l'entrée (chaîne de caractères)
−
 
 
|-
 
|-
 
| OVSitemapEntryUrl
 
| OVSitemapEntryUrl
 
| Adresse Web (url) de l'entrée
 
| Adresse Web (url) de l'entrée
−
 
 
|-
 
|-
 
| OVSitemapEntryText
 
| OVSitemapEntryText
 
| Nom de l'entrée
 
| Nom de l'entrée
−
 
 
|-
 
|-
 
| OVSitemapEntryDescription
 
| OVSitemapEntryDescription
 
| Description de l'entrée
 
| Description de l'entrée
−
 
 
|-
 
|-
 
| OVSitemapEntryOnclick
 
| OVSitemapEntryOnclick
 
| Code javascript à exécuter sur l'entrée (événement onclick sur le lien)
 
| Code javascript à exécuter sur l'entrée (événement onclick sur le lien)
−
 
 
|-
 
|-
 
| OVSitemapEntryFolder
 
| OVSitemapEntryFolder
 
| Vaut 1 si l'entrée contient d'autres entrées, 0 sinon
 
| Vaut 1 si l'entrée contient d'autres entrées, 0 sinon
−
 
 
|-
 
|-
 
| OVSitemapEntryPageTitle
 
| OVSitemapEntryPageTitle
 
| Titre de la page (pour le référencement)
 
| Titre de la page (pour le référencement)
−
 
 
|-
 
|-
 
| OVSitemapEntryPageDescription
 
| OVSitemapEntryPageDescription
 
| Description de la page (pour le référencement)
 
| Description de la page (pour le référencement)
−
 
 
|-
 
|-
 
| OVSitemapEntryPageKeywords
 
| OVSitemapEntryPageKeywords
 
| Mots-clés de la page (pour le référencement)
 
| Mots-clés de la page (pour le référencement)
 +
|-
 +
| OVSitemapEntryClassnames
 +
| Classes CSS de l'entrée
 +
|-
 +
| OVSitemapEntryMenuIgnore
 +
| ''Depuis Ovidentia '''<span class="version">7.9.0</span>'''''
 +
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 '''<span class="version">7.9.0</span>'''''
 +
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 '''<span class="version">8.0.91</span>'''''
 +
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 ===
 +
 +
<pre>
 +
<OCSitemapEntry node="" [sitemap=""]>...</OCSitemapEntry>
 +
</pre>
 +
 +
=== 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 ===
 +
 +
{| class="prettytable"
 +
! 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
 
| OVSitemapEntryClassnames
 
| Classes CSS de l'entrée
 
| Classes CSS de l'entrée
 +
|-
 +
| OVSitemapEntryMenuIgnore
 +
| ''Depuis Ovidentia '''<span class="version">7.9.0</span>'''''
 +
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 '''<span class="version">7.9.0</span>'''''
 +
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 '''<span class="version">8.0.91</span>'''''
 +
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 '''<span class="version">8.3.95</span>'''''
 +
 +
Retourne la liste des noeuds ayant pour cible l'id spécifié dans l'attribut <code>target</code>
 +
 +
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 ===
 +
 +
<pre>
 +
<OCSitemapCustomNode [sitemap=""] [basenode=""] target="" [limit=""]>...</OCSitemapCustomNode>
 +
</pre>
 +
 +
=== 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, <code>limit="0,1"</code> pour obtenir seulement le premier noeud. La syntaxe est identique à l'attribut <code>limit</code> de OCSitemapPath
 +
 +
===== Variables =====
 +
 +
{| class="prettytable"
 +
! 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)
 
|}
 
|}
  
Ligne 5 784 : Ligne 6 116 :
 
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).
 
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).
  
−
===== Exemple =====
+
=== Syntaxe ===
  
−
<OCSitemapPath sitemap="" basenode="" node="" limit="">....</OCSitemapPath>
+
<pre>
 +
<OCSitemapPath [node=""] [basenode=""] [sitemap=""] [limit=""] [keeplastknown=""]>...</OCSitemapPath>
 +
</pre>
  
−
===== Attributs =====
+
=== Paramètres ===
  
−
 
+
; node ''(optionnel)''
−
<dl>
+
: Identifiant de l'élément parent (noeud du plan du site). Les éléments enfants seront retournés.
−
<dt>node ''(optionnel)'' :
+
−
<dd>Identifiant de l'élément parent (noeud du plan du site). Les éléments enfants seront retournés.
+
 
Exemple : babUserSection, babUserSectionAddons, babArticles, babFaqs, Custom...
 
Exemple : babUserSection, babUserSectionAddons, babArticles, babFaqs, Custom...
  
−
<dt>basenode ''(optionnel)'' :
+
; basenode ''(optionnel)''
−
<dd>Identifiant du nœud qui servira de point de départ au chemin.
+
: Identifiant du nœud qui servira de point de départ au chemin.
  
−
<dt>sitemap ''(optionnel)'' :
+
;sitemap ''(optionnel)''
−
<dd>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é.
+
: 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é.
  
−
<dt>limit ''(optionnel)'' :
+
; limit ''(optionnel)''
−
<dd>Permet de limiter le nombre d'éléments renvoyés par le conteneur :
+
: 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 une seule valeur spécifiée, celle-ci indique le nombre maximum d'élément renvoyés. Ex. <code>limit="5"</code> 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.
+
:* 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. <code>limit="5,2"</code> 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. <code>limit="-1,1"</code> affiche le dernier élément seulement. L'index négatif est supporté à partir d'ovidentia <span class="version">8.3.95</span>.
  
−
<dt>keeplastknown ''(optionnel)'' :
+
; keeplastknown ''(optionnel)''
−
<dd>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.
+
: 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".
+
: La valeur par défaut est "1".
−
</dl>
+
  
 
===== Variables =====
 
===== Variables =====
  
 
{| class="prettytable"
 
{| class="prettytable"
 +
! Variable
 +
! Valeur
 +
|-
 
| OVSitemapEntryId
 
| OVSitemapEntryId
 
| Identifiant unique de l'entrée (chaîne de caractères)
 
| Identifiant unique de l'entrée (chaîne de caractères)
−
 
 
|-
 
|-
 
| OVSitemapEntryUrl
 
| OVSitemapEntryUrl
 
| Adresse Web (url) de l'entrée
 
| Adresse Web (url) de l'entrée
−
 
 
|-
 
|-
 
| OVSitemapEntryText
 
| OVSitemapEntryText
 
| Nom de l'entrée
 
| Nom de l'entrée
−
 
 
|-
 
|-
 
| OVSitemapEntryDescription
 
| OVSitemapEntryDescription
 
| Description de l'entrée
 
| Description de l'entrée
−
 
 
|-
 
|-
 
| OVSitemapEntryOnclick
 
| OVSitemapEntryOnclick
 
| Code javascript à exécuter sur l'entrée (événement onclick sur le lien)
 
| Code javascript à exécuter sur l'entrée (événement onclick sur le lien)
−
 
 
|-
 
|-
 
| OVSitemapEntryFolder
 
| OVSitemapEntryFolder
 
| Vaut 1 si l'entrée contient d'autres entrées, 0 sinon
 
| Vaut 1 si l'entrée contient d'autres entrées, 0 sinon
−
 
 
|-
 
|-
 
| OVSitemapEntryPageTitle
 
| OVSitemapEntryPageTitle
 
| Titre de la page (pour le référencement)
 
| Titre de la page (pour le référencement)
−
 
 
|-
 
|-
 
| OVSitemapEntryPageDescription
 
| OVSitemapEntryPageDescription
 
| Description de la page (pour le référencement)
 
| Description de la page (pour le référencement)
−
 
 
|-
 
|-
 
| OVSitemapEntryPageKeywords
 
| OVSitemapEntryPageKeywords
 
| Mots-clés de la page (pour le référencement)
 
| Mots-clés de la page (pour le référencement)
−
 
 
|-
 
|-
 
| OVSitemapEntryClassnames
 
| OVSitemapEntryClassnames
 
| Classes CSS de l'entrée
 
| Classes CSS de l'entrée
−
 
+
|-
 +
| OVSitemapEntryMenuIgnore
 +
| ''Depuis Ovidentia '''<span class="version">7.9.0</span>'''''
 +
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 '''<span class="version">7.9.0</span>'''''
 +
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 '''<span class="version">8.0.91</span>'''''
 +
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 =
+
= Différentes méthodes d’utilisation d’un fichier OvML =
 
== Utilisation dans une url ==
 
== Utilisation dans une url ==
 
Un fichier OvML peut être appellé en utilisant l’url suivante :
 
Un fichier OvML peut être appellé en utilisant l’url suivante :
Ligne 5 908 : Ligne 6 244 :
 
Remarque :
 
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 :
+
Il est possible de passer une variable template en tant que paramètre à un fichier OvML via la syntaxe { $OVML(...) } d'un fichier template :
  
  
Ligne 5 917 : Ligne 6 253 :
  
  
−
'''Optimiser le temps d'exécution d'un script OVML (disponible à partir de la version 7.2 d'Ovidentia) :'''
+
'''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.
 
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.
Ligne 5 935 : Ligne 6 271 :
  
  
−
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 !
+
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 ==
 
== Utilisation dans du contenu ==
Ligne 5 964 : Ligne 6 310 :
 
Afin d'utiliser ces fonctionnalités, on utilisera le container suivant :
 
Afin d'utiliser ces fonctionnalités, on utilisera le container suivant :
  
−
<nowiki><OCAddon name="" param1="" param2="" ...>....</OCAddon></nowiki>
+
=== Syntaxe ===
  
 +
<pre>
 +
<OCAddon name="" param1="" param2="" ...>...</OCAddon>
 +
</pre>
  
−
Attribut s:
+
=== Paramètres ===
  
−
name :
+
; name
−
 
+
: Nom du module
−
Nom du module
+
−
 
+
−
 
+
−
param1 :
+
−
 
+
−
Nom d'un attribut du container 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.
 
Pour la signification des paramètres, il faut consulter la documentation fournie avec le module.
Ligne 5 983 : Ligne 6 328 :
 
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.
 
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 :
  
−
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 ===
−
 
+
−
 
+
−
<nowiki><OFAddon name="" function="" param1="" ...></nowiki>
+
−
 
+
−
 
+
−
Attributs :
+
−
 
+
−
name :
+
−
 
+
−
Nom du module
+
−
 
+
−
 
+
−
function :
+
  
−
Nom de la fonction
+
<pre>
 +
<OFAddon name="" function="" param1="" ...>
 +
</pre>
  
 +
=== Paramètres ===
  
−
param1 :
+
; name
 +
: Nom du module
  
−
Nom d'un attribut de la fonction utilisée
+
; function
 +
: Nom de la fonction
  
 +
; param1
 +
: Nom d'un attribut de la fonction utilisée
  
 
== Support d'OvML dans l'éditeur Wysiwyg ==
 
== 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 :
+
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.
+
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 :
 
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.
+
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.

Version actuelle en date du 11 mars 2019 à 14:43

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:

<source lang="ovml"> <OVxxxx param1="value" param2="value" ...> </source>

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 :

<source lang="ovml"> <OFxxxx param1="value" param2="value" ...> </source>

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 :

<source lang="ovml"> <OCxxxx param1="value" param2="value" ...> 

   ...

</OCxxxx> </source>

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 :

<source lang="ovml"> <OCxxxx param1="value" param2="value" monparametre1> 

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

</OCxxxx monparametre1> </source>

  • 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 :

<source lang="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> </pre>

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

<source lang="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> </pre>

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="<OVCategoryId>">
                <OCArticleTopics categoryid="<OVCategoryId>">
                    <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>" 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>" 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>">
    <!-- Affichage de l'article -->
    <OFWebStat name="bab_articles" value="<OVarticleid>">
</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>

OFPortletContainer

Nécessite l'installation du module portlets

Permet l'intégration d'une zone de portlet dans la page.

Syntaxe

<OFPortletContainer id="" [mode="static"] [placeholder=""] [editplaceholder=""] [description=""] [classname=""]>

Paramètres

id
L'identifiant unique du portlet
mode (optionnel)
Le type de portlet
  • static (par défaut) : Le portlet est personnel, chaque utilisateur peut configurer son portlet
  • locked : Le portlet est le même pour tout les utilisateurs
placeholder (optionnel)
Un texte à afficher lorsque la zone de portlet est vide
editplaceholder (optionnel)
Un texte à afficher lorsque l'utilisateur édite la zone de portlet
description (optionnel)
Un texte toujours affiché
classname(optionnel)
Une classe est ajoutée sur la div
categories
initwith


OFGetRegistryValue

Renvoie une valeur de configuration gérée par la bab_Registry.

Depuis Ovidentia 8.6.97

Syntaxe

<OFGetRegistryValue path="/path/to/value">

Paramètres

path
Le chemin de la registry correspondant à la valeur recherchée

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>" 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
OVArticleCategoryId Id de la catégorie du thème contenant 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 à ouvrir ce lien dans une nouvelle fenêtre ou popup)
OVArticleEditName Nom associé au lien pour accéder à la modification de l'article
OVArticleCopyUrl Url pour accéder à la duplication de l'article (penser à ouvrir ce lien dans une nouvelle fenêtre ou popup)
OVArticleCopyName Nom associé au lien pour accéder à la duplication 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
OVArticleCopyUrl Url pour accéder à la duplication de l'article (penser à ouvrir ce lien dans une nouvelle fenêtre ou popup)
OVArticleCopyName Nom associé au lien pour accéder à la duplication 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é.

Depuis la version 8.6.94 d'Ovidentia, les paramètres ajoutés à ce container devrait permettre de replacer OCRecentArticles, OCArticlesHomePage et OCArticle.

Syntaxe

<OCArticles [delegationid=""] [categoryid=""] [topicid=""] [articleid=""] [excludetopicid=""] [homepage="public|private"] [archive=""] [offset=""] [rows=""] [limit="[offset,]rows"] [order="asc | desc"] [orderby=""] [topicorder=""] [imageheightmax=""] [imagewidthmax=""] [minrating=""]>...</OCArticles>

Paramètres

delegationid (optionnel)
0 (par défaut) : pas de filtre
Id de la délégation.
categoryid (optionnel)
Depuis Ovidentia 8.6.94
Id de la catégorie, tous les thèmes enfants seront utilisés
si categoryid est utilisé, topicid devient obsolète
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
articleid (optionnel)
Depuis Ovidentia 8.6.94
Id de l’article ou plusieurs Ids séparés par une virgule
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
homepage (optionnel)
Depuis Ovidentia 8.6.94
private : Liste les articles de la page d’accueil privée
public : Liste les articles de la page d’accueil publique
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
limit (optionnel)
Depuis Ovidentia 8.6.94
Alternative à rows et offset
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.
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
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
OVArticleCategoryId Id de la catégorie du thème contenant 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 à ouvrir ce lien dans une nouvelle fenêtre ou popup)
OVArticleEditName Nom associé au lien pour accéder à la modification de l'article
OVArticleCopyUrl Url pour accéder à la duplication de l'article (penser à ouvrir ce lien dans une nouvelle fenêtre ou popup)
OVArticleCopyName Nom associé au lien pour accéder à la duplication 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 à ouvrir ce lien dans une nouvelle fenêtre ou popup)
OVArticleEditName Nom associé au lien pour accéder à la modification de l'article
OVArticleCopyUrl Url pour accéder à la duplication de l'article (penser à ouvrir ce lien dans une nouvelle fenêtre ou popup)
OVArticleCopyName Nom associé au lien pour accéder à la duplication 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>&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>&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 à ouvrir ce lien dans une nouvelle fenêtre ou popup)
OVArticleEditName Nom associé au lien pour accéder à la modification de l'article
OVArticleCopyUrl Url pour accéder à la duplication de l'article (penser à ouvrir ce lien dans une nouvelle fenêtre ou popup)
OVArticleCopyName Nom associé au lien pour accéder à la duplication 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 spécifié par orderby (exemple orderby="givenname") 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
delete : pour les utilisateurs ayant le droit de supprimer une fiche
export : pour les utilisateurs ayant le droit d'exporter l'annuaire
import : pour les utilisateurs ayant le droit d'importer l'annuaire
empty : pour les utilisateurs ayant le droit de vider l'annuaire
bind : pour les utilisateurs ayant le droit d'attacher une fiche
unbind : pour les utilisateurs ayant le droit de détacher une fiche
view : pour les utilisateurs ayant le droit de voir les fiches (DEFAULT)

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é

OCOrgChildEntities

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

Depuis Ovidentia 8.6.100
<OCOrgChildEntities entityId="" >...</OCOrgChildEntities>

Paramètres

entityId
Identifiant (entier) de l'entité.

Variables

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

OCOrgEntityMembers

Liste tous les membres d'une entité.

Depuis Ovidentia 8.6.100
<OCOrgEntityMembers entityId="" >...</OCOrgEntityMembers>

Paramètres

entityId
Identifiant (entier) de l'entité.

Variables

Variable Valeur
EntityMemberDirEntryId Identifiant (entier) de la fiche annuaire de l'utilisateur
EntityMemberRoleType Id du rôle : 1 = Superior, 2 = Temporary employee, 3 = Members, 0 = Other collaborators
EntityMemberRoleName Nom du rôle
EntityMemberUserDisabled Utilisateur est désactivé (1 ou 0)
EntityMemberUserConfirmed Utilisateur est confirmé (1 ou 0)
EntityMemberSn Nom
EntityMemberGivenname Prénom
EntityMemberUserId Id user correspondant

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.

Récupérée de « https://wiki.ovidentia.fr/index.php?title=Référence_OvML&oldid=5736 »