OviWiki - Contributions de l’utilisateur [fr]

Référence OvML

2013-06-25T12:23:04Z

Rodpec : /* OFAddStylesheet */

[[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.

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 :

<source lang="ovml">
<OVnom-de-la-variable>
</source>

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

<source lang="ovml">
<OFPutVar name="nbArticles" value="10">
</source>

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 :

<source lang="ovml">
<OVnbArticles>
</source>

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 :

<source lang="ovml">
<OFPutVar name="babSlogan">
</source>

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.

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

<source lang="ovml">
<OFIfNotIsSet name="page" value="1">
</source>

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 <code><OVxxxx></code>.

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.

<source lang="ovml">
<OVnbArticles saveas="TotalArticles">
</source>

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.

{| class="prettytable"
! Value
!
|-
| n
| Récupère les n premiers caractères du contenu de la variable
|}

<source lang="ovml">
<OVbabSlogan strlen="100">
</source>

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 :

<source lang="ovml">
<OVbabSlogan strlen="100,...">
</source>

== striptags ==

Supprime les tags HTML de la variable :

{| class="prettytable"
! Value
!
|-
| 1
| Supprime les tags HTML de la variable
|}

<source lang="ovml">
<OVbabSlogan striptags="1">
</source>

== htmlentities ==

{| class="prettytable"
! Value
!
|-
| 1
| <nowiki>Convertit les entities HTML ( < devient &lt; )</nowiki>
|-
| 2
| <nowiki>Convertit en inverse les entities HTML ( &lt; devient < )</nowiki>
|}

<source lang="ovml">
<OVbabSlogan htmlentities="1">
</source>

== stripslashes ==

Supprime les slashs doublés du contenu de la variable

{| class="prettytable"
! Value
!
|-
| 1
| Supprime les slashs doublés du contenu de la variable
|}

<source lang="ovml">
<OVbabSlogan stripslashes="1">
</source>

== urlencode ==

{| class="prettytable"
! Value
!
|-
| 1
| Encode la variable pour l'utilisation dans une url
|}

<source lang="ovml">
<OVbabSlogan urlencode="1">
</source>

== jsencode ==

{| class="prettytable"
! Value
!
|-
| 1
| Encode la variable pour l'utilisation dans du javascript
|}

<source lang="ovml">
<OVbabSlogan jsencode="1">
</source>

== strcase ==

{| class="prettytable"
! Value
!
|-
| upper
| Convertit le contenu de la variable en majuscule
|-
| lower
| Convertit le contenu de la variable en minuscule
|}

<source lang="ovml">
<OVbabSlogan strcase="upper">
</source>

== nlremove ==

{| class="prettytable"
! Value
!
|-
| 1
| Supprime les retours chariots
|}

<source lang="ovml">
<OVbabSlogan nlremove="1">
</source>

== trim ==

{| class="prettytable"
! 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
|}

<source lang="ovml">
<OVbabSlogan trim="all">
</source>

== nl2br ==

{| class="prettytable"
! Value
!
|-
| <div align="right">1</div>
| <nowiki>Transforme les retours chariots en </nowiki>
|}

<source lang="ovml">
<OVbabSlogan nl2br="1">
</source>

== sprintf ==

{| class="prettytable"
! Value
!
|-
| Voir la documentation PHP pour la fonction sprintf
| Retourne une chaîne formatée
|}

<source lang="ovml">
<OVMoney sprintf="%01.2f">
</source>

== date ==

Permet de formater une date Ovidentia

{| class="prettytable"
! 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"
|}

<source lang="ovml">
<OVArticleDate date="%d %j %m %Y">
</source>

'''Remarque :'''

<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.

<source lang="ovml">
<OVbabCurrentDate date="%D %j %M" strcase="lower">
</source>

== author ==

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

{| class="prettytable"
! Value
!
|-
| %F
| Prénom
|-
| %M
| Deuxième prénom
|-
| %L
| Nom
|}

<source lang="ovml">
<OVArticleAuthor author="%F %L" strcase="lower">
</source>

= Les fonctions OvML =

On reconnaît les fonctions par la syntaxe suivante :

<source lang="ovml">
<OFxxxx ...>
</source>

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 <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>
</source>

'''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>
</source>

=== Syntaxe ===

<source lang="ovml">
<OFTranslate text="" [lang=""]>
</source>

=== 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

== OFPutVar ==

Permet de déclarer une nouvelle variable.

=== Syntaxe ===

<source lang="ovml">
<OFPutVar name="" [value=""]>
</source>

=== Paramètres ===

; name
: Nom de la variable

; value ''(optionnel)''
: Valeur à affecter à la variable

== OFGetVar ==

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

=== Syntaxe ===

<source lang="ovml">
<OFGetVar name="">
</source>

=== Paramètres ===

; name
: Nom de la variable à afficher

== OFIfNotIsSet ==

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

=== Syntaxe ===

<source lang="ovml">
<OFIfNotIsSet name="" [value=""]>
</source>

=== Paramètres ===

; name
: Nom de la variable

; value ''(optionnel)''
: Valeur à affecter à la variable

== OFInclude ==

Permet d'inclure un autre fichier OVML

=== Syntaxe ===

<source lang="ovml">
<OFInclude file="" [cache=""]>
</source>

=== 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 ===

<source lang="ovml">
<OFUrlContent url="">
</source>

=== 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 ===

<source lang="ovml">
<OFRecurse>
</source>

=== 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>).

<source lang="ovml">
<ul>
<OCArticleCategories>
<li>
<OVCategoryName>
<ul>
<OFRecurse parentid="<OVCategoryId>">
<OCArticleTopics categoryid="<OVCategoryId>">
<li><OVTopicName></li>
</OCArticleTopics>
</ul>
</li>
</OCArticleCategories>
</ul>
</source>

== Opérateurs arithmétiques ==

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

<source lang="ovml">
<OFAOxxxxx expr1="X" expr2="Y">
</source>

<source lang="ovml">
<OFAOxxxxx expr1="10" expr2="50">
</source>

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

<source lang="ovml">
<OFAOxxxxx expr1="<OVTotal>" expr2="50">
</source>

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.

<source lang="ovml">
<OFAOxxxxx expr1="<OVTotal>" expr2="50" saveas="NewTotal">
</source>

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 :

=== OFAOAddition ===

Permet d’additionner expr1 et expr2.

==== Syntaxe ====

<source lang="ovml">
<OFAOAddition expr1="" expr2="">
</source>

==== Paramètres ====

; expr1
: Premier terme de l'addition

; expr2
: Second terme de l'addition

=== OFAOSubtraction ===

Permet de soustraire expr2 à expr1.

==== Syntaxe ====

<source lang="ovml">
<OFAOSubtraction expr1="" expr2="">
</source>

==== Paramètres ====

; expr1
: Premier terme de la soustraction

; expr2
: Second terme de la soustraction

==== Exemple ====

<source lang="ovml">
<OFAOSubtraction expr1="10" expr2="20">
</source>

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 ====

<source lang="ovml">
<OFAOMultiplication expr1="" expr2="">
</source>

==== Paramètres ====

; expr1
: Premier terme de la multiplication

; expr2
: Second terme de la multiplication

=== OFAODivision ===

Permet de diviser expr1 par expr2.

==== Syntaxe ====

<source lang="ovml">
<OFAODivision expr1="" expr2="">
</source>

==== Paramètres ====

; expr1
: Premier terme de la division

; expr2
: Second terme de la division

==== Exemple ====

<source lang="ovml">
<OFAODivision expr1="10" expr2="20">
</source>

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 ====

<source lang="ovml">
<OFAOModulus expr1="" expr2="">
</source>

==== Paramètres ====

; expr1
: Premier terme du modulo

; expr2
: Second terme du modulo

==== Exemple ====

<source lang="ovml">
<OFAOModulus expr1="10" expr2="20">
</source>

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 ===

<source lang="ovml">
<OFHeader value="">
</source>

=== Paramètres ===

; value
: Valeur du header à modifier

=== Exemple ===

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

== OFSetCookie ==

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

=== Syntaxe ===

<source lang="ovml">
<OFSetCookie name="" expire="" [value=""]>
</source>

=== 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 ===

<source lang="ovml">
<OFGetCookie name="">
</source>

=== 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 ===

<source lang="ovml">
<OFSetSessionVar name="" value="">
</source>

=== 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 ===

<source lang="ovml">
<OFSetSessionVar name="babSectionsType" value="15">
</source>

affichera toutes les sections du portail

<source lang="ovml">
<OFSetSessionVar name="babSectionsType" value="4">
</source>

affichera uniquement les sections personnalisées du portail

<source lang="ovml">
<OFSetSessionVar name="babSectionsType" value="10">
</source>

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

<source lang="ovml">
<OFSetSessionVar name="babOvmlCurrentDelegation" value="5">
</source>

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

<source lang="ovml">
<OFSetSessionVar name="babOvmlCurrentDelegation" value="0">
</source>

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 ===

<source lang="ovml">
<OFRequest name="" saveas="" [default=""]>
</source>

=== Paramètres ===

; name
: Nom du paramètre GET dont on souhaite récupérer la valeur

; 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 ===

<source lang="ovml">
<OFPost name="" saveas="" [default=""]>
</source>

=== Paramètres ===

; name
: Nom du paramètre POST dont on souhaite récupérer la valeur

; 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 ===

<source lang="ovml">
<OFGet name="" saveas="" [default=""]>
</source>

=== Paramètres ===

; name
: Nom du paramètre GET dont on souhaite récupérer la valeur

; 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 ===

<source lang="ovml">
<OFSitemapPosition [sitemap=""] [basenode=""] [node=""] [keeplastknown=""]>
</source>

=== Paramètres ===

; 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 ===

<source lang="ovml">
<OFSitemapMenu [sitemap=""] [basenode=""] [selectednode=""] [keeplastknown=""] [maxdepth=""]>
</source>

=== 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é.

; 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).
: 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).

; 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.

== 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 ===

<source lang="ovml">
<OFSitemapCustomNodeId node="" [basenode=""] [saveas=""]>
</source>

=== 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 ===

<source lang="ovml">
<OFSitemapCustomNodeId node="bab_Articles" saveas="CustomNodeId">
<OFSitemapMenu basenode="<OVCustomNodeId>">
</source>

== 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 ===

<source lang="ovml">
<OFPreviousArticle articleid="" [topicid=""] [excludetopicid=""] [archive=""] [orderby=""] [order=""] [topicorder=""] [delegationid=""]>
</source>

=== 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 ===

<source lang="ovml">
<OFNextArticle articleid="" [topicid=""] [excludetopicid=""] [archive=""] [orderby=""] [order=""] [topicorder=""] [delegationid=""]>
</source>

=== 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 ===

<source lang="ovml">
<OFWebStat name="" value="">
</source>

=== 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 ===

<source lang="ovml">
<OCArticle articleid="<OVarticleid>">

<OFWebStat name="bab_articles" value="<OVarticleid>">
</OCArticle>
</source>

== OFAddStyleSheet ==

''Depuis Ovidentia '''7.5.93'''''

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

=== Syntaxe ===

<source lang="ovml">
<OFAddStyleSheet file="">
</source>

=== Paramètres ===

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

= Les containers OvML =

La syntaxe des containers est comme suit :

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

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 ===

<source lang="ovml">
<OCxxxx expr1="" expr2="">...</OCxxxx>
</source>

=== Paramètres ===

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

=== Exemple ===

<source lang="ovml">
<OFPutVar name="BAB_SESS_LOGGED">
<OCIfEqual expr1="<BAB_SESS_LOGGED>" expr2="1">
Vous êtes connecté !
</OCIfEqual>
</source>

== 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 ===

<source lang="ovml">
<OCxxxx name="">...</OCxxxx>
</source>

=== Paramètres ===

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

=== Exemple ===

<source lang="ovml">
<OCIfIsSet name="variable">
Ce texte ne sera pas affiché.
</OCIfIsSet>

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

== OCIfUserMemberOfGroups ==

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

=== Syntaxe ===

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

=== 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 ===

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

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

== OCRecentFiles ==

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

=== Syntaxe ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

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

== OCRecentComments ==

Liste les derniers commentaires d'articles.

=== Syntaxe ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCArticleCategoryNext>...</OCArticleCategoryNext>
</source>

=== Variables ===

Idendiques à celles du container [[#OCArticleCategories|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 ===

<source lang="ovml">
<OCArticleCategoryPrevious>...</OCArticleCategoryPrevious>
</source>

=== Variables ===

Identiques à celles du container [[#OCArticleCategories|OCArticleCategories]].

== OCParentsArticleCategory ==

Liste des catégories de sujets parents.

=== Syntaxe ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 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 ===

<source lang="ovml">
<OCArticleTopicNext>...</OCArticleTopicNext>
</source>

=== Variables ===

Identiques à celles du container [[#OCArticleTopics|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 ===

<source lang="ovml">
<OCArticleTopicPrevious>....</OCArticleTopicPrevious>
</source>

=== Variables ===

Idem que ceux du container [[#OCArticleTopics|OCArticleTopics]].

== OCArticleTopic ==

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

=== Syntaxe ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCArticleTopic topicname="essai">...</OCArticleTopic>
</source>
Recherche tous les thèmes dont l'utilisateur a le droit et ayant pour nom "essai"

<source lang="ovml">
<OCArticleTopic topicid="1,2,3" topicname="essai">...</OCArticleTopic>
</source>
Recherche les thèmes d'id 1,2 3 ayant pour nom essai.

<source lang="ovml">
<OCArticleTopic topicid="1,2,3" topicname="%essai">...</OCArticleTopic>
</source>
Recherche les thèmes d'id 1,2 3 et dont le nom se termine par essai

<source lang="ovml">
<OCArticleTopic topicid="1,2,3" topicname="essai%">...</OCArticleTopic>
</source>
Recherche les thèmes d'id 1,2 3 et dont le nom commence par essai

<source lang="ovml">
<OCArticleTopic topicid="1,2,3" topicname="%essai%">...</OCArticleTopic>
</source>
Recherche les thèmes d'id 1,2 3 et dont le nom contient la chaîne essai

== OCArticles ==

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

=== Syntaxe ===

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

=== Paramètres ===

; topicid ''(optionnel)''
: Permet de préciser les thèmes d'articles concernés
: Id du thème ou plusieurs Ids séparés par une virgule
: Si omis, le container liste les articles tout thème confondu

; excludetopicid ''(optionnel)''
: Permet de préciser les thèmes d'articles à exclure à la différence du paramètre topicid
: Id du thème ou plusieurs Ids séparés par une virgule

; archive ''(optionnel)''
: yes : Donne la liste des articles archivés
: no ''(par défaut)'' : Donne la liste des articles non archivés

; offset ''(optionnel)''
: "n" indique le nombre d'articles à ignorer à partir du début de la liste
: 0 ''(par défaut)'' : aucune article n'est ignoré

; rows ''(optionnel)''
: "n" combien il faut en prendre
: -1 ''(par défaut)'' : toutes les lignes sont prises

; order ''(optionnel)''
: asc : Ordonne les articles par ordre croissant en fonction de la date
: desc ''(par défaut)'' : Ordonne les articles par ordre décroissant en fonction de la date
: rand : Ordonne les articles aléatoirement

; orderby ''(optionnel)''
: Peut être couplé avec l'attribut order.
: creation : Ordonne les articles par ordre de création en fonction de la date
: publication : Ordonne les articles par ordre de publication en fonction de la date
: modification ''(par défaut)'' : Ordonne les articles par ordre de modification en fonction de la date
: rating : Ordonne les articles en fonction de la note moyenne attribuée dans les commentaires

; topicorder ''(optionnel)''
: yes : Utilise l'ordre défini par le gestionnaire du thème d'articles
: no ''(par défaut)'' : N'utilise l'ordre défini par le gestionnaire du thème d'articles

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

; imageheightmax ''(optionnel)''
: Valeur en pixels. Permet de préciser la hauteur maximum de l'image associée.
: Si omis, l'image n'est pas redimensionnée et garde sa taille d'origine.

; imagewidthmax ''(optionnel)''
: Valeur en pixels. Permet de préciser la largeur maximum de l'image associée.
: Si omis, l'image n'est pas redimensionnée et garde sa taille d'origine.

; minrating ''(optionnel)''
: Permet de filtrer les articles ayant une note moyenne dans les commentaires supérieure ou égale à la valeur fournie en paramètre
: Valeur numérique.

=== Variables ===

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

== OCArticleNext ==

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

=== Syntaxe ===

<source lang="ovml">
<OCArticleNext>...</OCArticleNext>
</source>

=== Variables ===

Identiques à celles du container [[#OCArticles|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 ===

<source lang="ovml">
<OCArticlePrevious>...</OCArticlePrevious>
</source>

=== Variables ===

Identiques à celles du container [[#OCArticles|OCArticles]].

== OCArticle ==

Donne les informations sur un article donné.

=== Syntaxe ===

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

=== 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 ===

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

== OCArticleFiles ==

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

=== Syntaxe ===

<source lang="ovml">
<OCArticleFiles articleid="">...</OCArticleFiles>
</source>

=== Paramètres ===

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

=== Variables ===

{| class="prettytable"
! Variable
! Valeur
|-
| OVArticleFileName
| Nom du fichier
|-
| OVArticleFileDescription
| Description du fichier
|-
| OVArticleFileUrlGet
| Url pour atteindre le fichier
|}

== OCForums ==

Liste des forums.

=== Syntaxe ===

<source lang="ovml">
<OCForums [forumid=""] [delegationid=""]>...</OCForums>
</source>

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCForumNext>...</OCForumNext>
</source>

=== Variables ===

Identiques à celles du container [[#OCForums|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 ===

<source lang="ovml">
<OCForumPrevious>...</OCForumPrevious>
</source>

=== Variables ===

Identiques à celles du container [[#OCForums|OCForums]].

== OCForum ==

Donne les informations sur un forum donné.

=== Syntaxe ===

<source lang="ovml">
<OCForum forumid="">...</OCForum>
</source>

=== Paramètres ===

; forumid :
: Id du forum

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCThread threadid="" [order=""]>...</OCThread>
</source>

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCPost postid="" [order=""]>...</OCPost>
</source>

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCPostFiles postid="">...</OCPost>
</source>

=== Paramètres ===

; postid
: Id de la contribution 

=== Variables ===

{| class="prettytable"
! Variable
! Valeur
|-
| OVPostFileName
| Nom du fichier
|-
| OVPostFileUrlGet
| Url pour atteindre le fichier
|}

== OCFolders ==

Liste les répertoires partageables.

=== Syntaxe ===

<source lang="ovml">
<OCFolders [folderid=""] [delegationid=""]>...</OCFolders>
</source>

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFolderNext>...</OCFolderNext>
</source>

=== Variables ===

Identique à celles du container [[#OCFolders|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 ===

<source lang="ovml">
<OCFolderPrevious>...</OCFolderPrevious>
</source>

=== Variables ===

Identique à celles du container [[#OCFolders|OCFolders]].

== OCFolder ==

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

=== Syntaxe ===

<source lang="ovml">
<OCFolder folderid="">...</OCFolder>
</source>

=== Paramètres ===

; folderid
: Id du répertoire

=== Variables ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 :'''
<source lang="ovml">
<a href="<OVFileUrl>&inl=1"><OVFileName></a>
</source>

=== Syntaxe ===

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

=== 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 articles 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFileNext>...</OCFileNext>
</source>

=== Variables ===

Identiques à celles du container [[#OCFiles|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 ===

<source lang="ovml">
<OCFilePrevious>...</OCFilePrevious>
</source>

=== Variables ===

Identiques à celles du container [[#OCFolders|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 :'''
<source lang="ovml">
<a href="<OVFileUrl>&inl=1"><OVFileName></a>
</source>

=== Syntaxe ===

<source lang="ovml">
<OCFile fileid="">...</OCFile>
</source>

=== Paramètres ===

; fileid
: Id du fichier

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFileFields fileid="">...</OCFileFields>
</source>

=== Paramètres ===

; fileid
: Id du fichier

=== Variables ===

{| class="prettytable"
! Variable
! Valeur
|-
| OVFileFieldName
| Nom du champ
|-
| OVFileFieldValue
| Valeur du champ
|}

== OCFaqs ==

Donne la liste des Faqs.

=== Syntaxe ===

<source lang="ovml">
<OCFaqs [faqid=""] [delegationid=""]>...</OCFaqs>
</source>

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFaqNext>...</OCFaqNext>
</source>

=== Variables ===

Identiques à celles du container [[#OCFaqs|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 ===

<source lang="ovml">
<OCFaqPrevious>...</OCFaqPrevious>
</source>

=== Variables ===

Identiques à celles du container [[#OCFaqs|OCFaqs]].

== OCFaq ==

Donne les informations sur une Faq donnée.

=== Syntaxe ===

<source lang="ovml">
<OCFaq faqid="">...</OCFaq>
</source>

=== Paramètres ===

; faqid
: Id de la Faq

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFaqSubCategories faqid="" [delegationid=""]>...</OCFaqSubCategories>
</source>

=== Paramètres ===

; faqid
: Id de la faq

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

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFaqSubCategory faqsubcatid="">...</OCFaqSubCategory>
</source>

=== Paramètres ===

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

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFaqQuestions [faqid=""] [faqsubcatid=""]>...</OCFaqQuestions>
</source>

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFaqQuestionNext>...</OCFaqQuestionNext>
</source>

=== Variables ===

Identiques à celles du container [[#OCFaqQuestions|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 ===

<source lang="ovml">
<OCFaqQuestionPrevious>...</OCFaqQuestionPrevious>
</source>

=== Variables ===

Identiques à celles du container [[#OCFaqQuestions|OCFaqQuestions]].

== OCFaqQuestion ==

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

=== Syntaxe ===

<source lang="ovml">
<OCFaqQuestion questionid="">...</OCFaqQuestion>
</source>

=== Paramètres ===

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

=== Variables ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

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

== OCWaitingComments ==

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

=== Syntaxe ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCCalendarCategories [filter=""]>...</OCCalendarCategories>
</source>

=== Paramètres ===

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

=== Variables ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
| 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 ===

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

=== 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 ===

{| class="prettytable"
| 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)
|}

== OCDbDirectories ==

Liste les annuaires de base de données

=== Syntaxe ===

<source lang="ovml">
<OCDbDirectories [directoryid=""] [delegationid=""]>...</OCDbDirectories>
</source>

=== 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.

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCDbDirectory directoryid="" [type=""]>...</OCDbDirectory>
</source>

=== Paramètres ===

; directoryid
: Id de l'annuaire

; type ''(optionnel)''
: « database » ou « group », si omis, le container liste tous les annuaires.

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCDbDirectoryFields directoryid="" [all=""]>...</OCDbDirectoryFields>
</source>

=== 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 ===

{| class="prettytable"
! Variable
! Valeur
|-
| OVDirectoryFieldName
| Intitulé du champ
|-
| OVDirectoryFieldId
| Identifiant du champ
|}

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

{| class="prettytable"
! 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 ===

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

=== Paramètres ===

; directoryid
: Id de l'annuaire

; all ''(optionnel)''
: Ignoré si l'attribut '''fields''' est spécifié
: 1 : Donne tous les champs pour chaque membre
: 0 : Donne uniquement les champs choisis pour l'affichage lors de la configuration du l'annuaire
: Si omis, liste uniquement les champs choisis.

; fields ''(optionnel)''
: liste des identifiants des champs souhaités séparés par des virgules ( exemple "sn,givenname,email" )

; orderby ''(optionnel)''
: Identifiant du champ à utiliser pour ordonner la liste

; order ''(optionnel)''
: asc : ordonne par ordre croissant
: desc : ordonne par ordre décroissant

; like ''(optionnel)''
: Restreint la liste des membres ayant le champ commençant par ce motif ( exemple like="A" )

=== Variables ===

{| class="prettytable"
! 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
| <nowiki>Intitulé du champ ayant pour identifiant xxxxxxx ( ex <OVgivennameName> ) </nowiki>
|-
| OVxxxxxxValue
| <nowiki>Contenu du champ ayant pour identifiant xxxxxxx ( ex <OVgivennameValue> ) </nowiki>
|}

== OCDbDirectoryMemberFields ==

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

Liste les différents champs pour le membre courant.

=== Syntaxe ===

<source lang="ovml">
<OCDbDirectoryMemberFields>...</OCDbDirectoryMemberFields>
</source>

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCDbDirectoryEntry directoryid="" memberid="" userid="">...</OCDbDirectoryEntry>
</source>

=== 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 ===

{| class="prettytable"
! 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
| <nowiki>Intitulé du champ ayant pour identifiant xxxxxxx ( ex <OVgivennameName> ) </nowiki>
|-
| OVxxxxxxValue
| <nowiki>Contenu du champ ayant pour identifiant xxxxxxx ( ex <OVgivennameValue> ) </nowiki>
|-
| 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 ===

<source lang="ovml">
<OCDbDirectoryEntryFields>...</OCDbDirectoryEntryFields>
</source>

=== Variables ===

{| class="prettytable"
! Variable
! Valeur
|-
| OVDirectoryFieldName
| Intitulé du champ
|-
| OVDirectoryFieldValue
| Valeur du champ
|}

== OCDbDirectoryAcl ==

Liste les utilisateurs ayant des droits sur un annuaire.

=== Syntaxe ===

<source lang="ovml">
<OCDbDirectoryAcl directoryid="" type="">...</OCDbDirectoryAcl>
</source>

=== Paramètres ===

; directoryid
: Id de l'annuaire

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

=== Variables ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCDelegationItems delegationid="">...</OCDelegationItems>
</source>

=== Paramètres ===

; delegationid
: Id de la délégation

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCDelegationAdministrators delegationid="">...</OCDelegationAdministrators>
</source>

=== Paramètres ===

; delegationid
: Id de la délégation

=== Variables ===

{| class="prettytable"
! Variable
! Valeur
|-
| OVDelegationUserId
| Id de l'administrateur
|}

== OCDelegationsCategories ==

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

=== Syntaxe ===

<source lang="ovml">
<OCDelegationsCategories [categoryid=""]>....</OCDelegationsCategories>
</source>

=== Paramètres ===

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

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCDelegationsCategory [categoryid=""]>...</OCDelegationsCategory>
</source>

=== Paramètres ===

; categoryid
: Id de la délégation

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCTmSpaces>...</OCTmSpaces>
</source>

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCTmProjects spaceid="">...</OCTmProjects>
</source>

=== Paramètres ===

; spaceid
: Id de l'espace de projets

=== Variables ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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.

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

=== 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 ===

{| class="prettytable"
! Variable
! Valeur
|-
| OVEntityId
| Identifiant (entier) de l'entité
|-
| OVEntityName
| Nom de l'entité
|-
| OVEntityDescription
| Description de l'entité
|}

== OCMultipages ==

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

=== Syntaxe ===

<source lang="ovml">
<OCMultipages total="" maxpages="" perpage="" currentpage="">...</OCMultipages>
</source>

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCSitemapEntries node="" [sitemap=""] [limit=""]>...</OCSitemapEntries>
</source>

=== 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...
: Si node n'est pas spécifié,

; 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 ===

{| 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
|}

== 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 ===

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

=== 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.

; 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 =====

{| 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
|}

= 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 !

== 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 ===

<source lang="ovml">
<OCAddon name="" param1="" param2="" ...>...</OCAddon>
</source>

=== 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 ===

<source lang="ovml">
<OFAddon name="" function="" param1="" ...>
</source>

=== 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.

Fichier:Icone-theme-articles-droits.png

2013-06-19T15:44:12Z

Rodpec :

Fichier:Icone-theme-articles-tri.png

2013-06-19T15:43:53Z

Rodpec :

Fichier:Icone-theme-articles-suppression.png

2013-06-19T15:43:13Z

Rodpec :

Fichier:Icone-theme-articles-creation.png

2013-06-19T15:42:24Z

Rodpec :

Articles

2013-06-19T15:37:47Z

Rodpec : /* Thèmes d'articles */

La gestion des articles est le plus important système de publication d'informations dans Ovidentia. L'éditeur wysiwyg intégré permet une souplesse dans la mise en forme du contenu ainsi qu'une liaison avec des fonctions du portail comme les annuaires et le gestionnaire de fichiers. Plusieurs points d'entrée existent afin de faciliter l'accès aux informations : sections de catégories, moteur de recherche, ... Le langage OVML pourra aussi être utilisé par le webmaster afin, par exemple, d'illustrer en pages d'accueil les dernières publications.

On retrouve six acteurs dans la gestion des articles :

* l'administrateur : il est en charge de créer l'arborescence de publication et de définir les droits d'accès
* le gestionnaire d'articles : le seul à pouvoir supprimer un article, il gère aussi les processus d'archivages
* le publicateur : l'auteur des articles
* l'approbateur : il modère les articles avant leurs publications
* le gestionnaire des pages d'accueil : il définit les articles qui seront affichés en pages d'accueil
* le lecteur : dernier acteur, il peut ajouter des commentaires aux articles 

= Administration =

L'administrateur est en charge de créer l'arborescence de publication qui deviendra par défaut l'arborescence de navigation sur le site. L'arborescence est constituée de catégories et de thèmes, conteneurs des articles. Pour chaque thème d'articles, l'administrateur choisit ses préférences, active les publications, les points d'entrée sur le site (sections) et définit les acteurs concernés : gestionnaires, publicateurs et lecteurs.

== L'arborescence de publication ==

Lien ''Articles'' en section d'Administration.

L'arborescence de publication est composée de 2 entités : les catégories et les thèmes d'articles.

* Les catégories sont de simples conteneurs, elles précisent la nature de l'information qu'elles contiennent. Une catégorie peut faire partie d'une catégorie parente, on parlera alors de sous-catégorie. Il n'y a pas de limites quant au nombre d'imbrications. Une catégorie peut contenir des thèmes d'articles et des sous-catégories. Sur l'exemple ci-dessous, ''Actualités'' est une catégorie qui contient 3 thèmes d'articles : ''Sport'', ''Politique'' et ''Économie''.
* Les thèmes d'articles sont aussi des conteneurs et précisent aussi la nature de l'information qu'ils contiennent. Un thème d'articles fait obligatoirement partie d'une catégorie et contient des articles. Les droits d'accès et toutes les options de publication s'appliquent uniquement sur les thèmes d'articles (un article n'a pas d'options uniques, il hérite des options de son thème).
* Les articles font partie d'un thème. Ils ne sont pas visibles de l'administrateur du site.

[[Image:|center|Administration : arborescence de publication]]

== Catégories d'articles ==

Dans l'arborescence de publication, on reconnaîtra 5 icônes permettant de gérer les catégories (et sous-catégories) :

* [[Image:]] : Création d'une catégorie
* [[Image:]] : Suppression d'une catégorie
* [[Image:]] : Ordonne les catégories d'un même niveau
* [[Image:]] / [[Image:]] : Affiche ou cache la section de la catégorie
* [[Image:]] : Droits par défaut de la catégorie

Remarque : les sections font partie des points d'entrée possibles aux articles dans la navigation du portail. Il est possible d'activer une section pour chacune des catégories. Une section comporte des liens vers les thèmes et sous-catégories de la catégorie.

[[Image:|center|Gestion des catégories]]

=== Création d’une catégorie ===

Depuis l'arborescence de publication, après avoir cliqué sur l'icône concernée au niveau désiré, le formulaire de création apparaît :

[[Image:|center|Formulaire de création d’une catégorie]]

* Nom : nom de la catégorie
* Description : description de la catégorie (non affichée sur le portail mais peut être utilisée via le langage OVML)
* Section activée : affiche ou cache la section de la catégorie
* Patron de section : optionnel. Indique la mise en forme utilisée pour l'affichage de la section
* Patron d'affichage : optionnel. Indique la mise en forme utilisée pour l'affichage des thèmes d'articles et des sous-catégories
* Catégorie de sujet parent : définit la catégorie parente afin de préciser le niveau d'arborescence
* Sélection d'une image : permet de charger une image au format jpg, gif ou png qui sera associée à la catégorie dans la présentation côté utilisateur

=== Affecter des droits par défaut sur une catégorie ===

Les droits d'accès des articles peuvent s'appliquer sur les catégories afin d'être définis par défaut sur les thèmes d'articles contenus dans ces catégories. Il existe 5 droits :

* Qui peut lire les articles de ce thème ? : lecteurs des articles
* Qui peut soumettre de nouveaux articles ? : auteurs des articles et des brouillons
* Qui peut soumettre des commentaires ? : lecteurs ayant des droits de commentaires sur les articles
* Qui peut modifier les articles ? : auteurs ayant des droits de modification sur les articles, ce statut ne donne pas droit à la création d'articles
* Qui peut gérer ce thème ? : gestionnaires. Ils ordonnent les articles, modifient les dates de publication, choisissent les articles d'archives, suppriment les articles...

[[Image:|center|Affectation des droits par défaut]]

Après avoir cliqué sur le bouton "Enregistrer" (situé tout en bas de l'arbre de droits), l'administrateur doit déterminer sur quels objets vont s'appliquer les droits qu'il vient de définir.

[[Image:]]

En ne sélectionnant aucun objet, on n'affecte aucun thème, sous-catégorie, etc... existant. Les prochains thèmes et sous-catégories créés dans cette catégorie seront en revanche affectés.

=== Ordonner les catégories ===

Le formulaire est constitué d'une liste ordonnée (à gauche) des catégories d'un même niveau et de boutons (à droite) permettant de définir manuellement l'ordre d'affichage des catégories.

Les deux flèches bleues permettent de monter ou de descendre une catégorie sélectionnée dans la liste.

Les deux icônes du bas ordonnent les catégories par ordre croissant ou décroissant sur leurs noms.

Remarque : l'ordre définit par l'administrateur a une incidence sur la navigation (sections, chemin de fer...) et sur la gestion (publication, gestion des articles...).

[[Image:|center|Formulaire pour ordonner les catégories d’articles]]

=== Supprimer une catégorie ===

Il est nécessaire pour supprimer une catégorie d'avoir préalablement supprimé les thèmes d'articles et les sous-catégories qu'elles contient. La suppression n'est effective qu'après confirmation.

[[Image:|center|Suppression d’une catégorie]]

== Thèmes d'articles ==

Dans l'arborescence de publication, on reconnaîtra 3 icônes permettant de gérer les thèmes d'articles :

* [[Image:icone-theme-articles-creation.png|Création d'un thème d'articles]] : Création d'un thème d'articles
* [[Image:icone-theme-articles-suppression.png|Suppression d'un thème d'articles]] : Suppression d'un thème d'articles
* [[Image:icone-theme-articles-tri.png|Ordonne les thèmes d'articles]] : Ordonne les thèmes d'articles d'un même niveau
* [[Image:icone-theme-articles-droits.png|Droits d'accès sur un thème d'articles]] : Droits d'accès sur un thème d'articles (lecteurs, publicateurs, gestionnaires...)

=== Création d’un thème ===

Depuis l'arborescence de publication, après avoir cliqué sur l'icône concernée sous la catégorie désirée, le formulaire de création apparaît :

[[Image:|center|Formulaire de création d’un thème d’articles]]

* Nom : nom du thème d'articles
* Catégorie de thèmes d'articles : définit la catégorie parente afin de préciser le niveau d'arborescence
* Description (via l'éditeur wysiwyg) : description du thème d'articles (visible pendant la navigation dans les articles)
* Langue : initialise la langue par défaut des articles, utile lorsqu'un filtre de langue est appliqué sur le site
* Patron d'affichage : optionnel. Indique la mise en forme utilisée pour l'affichage des articles
* Modèle d'articles : optionnel. Permet d'initialiser le contenu d'un article lors de sa création

Remarque : pour des raisons de mise en forme, l'éditeur wysiwyg ne permet pas le dépôt d'images dans la description d'un thème d'articles.

=== Préférences ===

Tous les articles sont rassemblés dans des thèmes. Les droits d'accès et les options de publication sont appliqués sur les thèmes : chaque article hérite donc des propriétés de son thème.

[[Image:|center|Préférences d’un thème d’articles]]

* Schéma d'approbation pour les articles : schéma utilisé pour modérer les nouveaux articles créés
* Schéma d'approbation pour les commentaires : schéma utilisé pour modérer les commentaires d'articles
* Schéma d'approbation pour la modification : schéma utilisé pour modérer les articles modifiés
* Approuver automatiquement le contributeur s'il fait partie de la première étape du schéma d'approbation : option applicable lors des modérations d'articles
* Les auteurs peuvent notifier les membres du groupe par email : envoie un mail à tous les utilisateurs ayant des droits de lecture sur le thème d'articles
* Les auteurs peuvent restreindre l'accès aux articles : les auteurs peuvent choisir les groupes d'utilisateurs pouvant voir les articles
* Permettre aux auteurs de proposer leur article pour les pages d'accueil : l'auteur propose son article, seul le gestionnaire peut décider d'afficher l'article en pages d'accueil
* Permettre aux auteurs de spécifier des dates de publication : permet de retarder la publication des articles
* Permettre aux auteurs de joindre des fichiers avec leurs articles : oui/non
* Permettre aux auteurs de modifier leurs articles : oui/non
* Permettre aux gestionnaires de modifier les articles : oui/non
* Nombre maximum d'articles sur la page des archives : lorsqu'un article est archivé, il n'est pas pour autant caché. Il se retrouve en nombre restreint avec les autres articles archivés.
* Utiliser les mots-clés du thésaurus : l'activation de cette option rendra obligatoire l'attribution d'au moins un mot-clé par article
* Permettre aux commentateurs de noter les articles: l'activation de cette option permet aux utilisateurs de noter l'article qu'ils commentent.
* Permettre aux auteurs d'associer une image à un article : Cette option autorise l'association d'une image à l'article. Cette image n'est visible qu'en étant récupérée en OvML.
* Sélection d'une image : permet de charger une image au format jpg, gif ou png qui sera associée au thème dans la présentation côté utilisateur. Cette image n'est visible qu'en étant récupérée en OvML.

Remarque : les schémas d'approbation sont créés par l'administrateur du site : lien Approbations en section d'Administration.

=== Droits d'accès ===

Les droits d'accès des articles s'appliquent sur leurs thèmes d'articles. Il existe 5 droits :

* Qui peut lire les articles de ce thème ? : lecteurs des articles
* Qui peut soumettre de nouveaux articles ? : auteurs des articles et des brouillons
* Qui peut soumettre des commentaires ? : lecteurs ayant des droits de commentaires sur les articles
* Qui peut modifier les articles ? : auteurs ayant des droits de modification sur les articles, ce statut ne donne pas droit à la création d'articles
* Qui peut gérer ce thème ? : gestionnaires. Ils ordonnent les articles, modifient les dates de publication, choisissent les articles d'archives, suppriment les articles...

[[Image:|center|ACL : formulaire de droits d’accès]]

=== Ordonner les thèmes ===

Le formulaire est constitué d'une liste ordonnée (à gauche) des thèmes d'articles d'un même niveau et de boutons (à droite) permettant de définir manuellement l'ordre d'affichage des thèmes.

Les deux flèches bleues permettent de monter ou de descendre un thème sélectionné dans la liste.

Les deux icônes du bas ordonnent les thèmes par ordre croissant ou décroissant sur leurs noms.

Remarque : l'ordre défini par l'administrateur a une incidence sur la navigation (sections, chemin de fer...) et sur la gestion (publication, gestion des articles...).

[[Image:|center|Formulaire pour ordonner les thèmes d’articles]]

=== Supprimer un thème ===

La suppression d'un thème d'articles entraînera la suppression de ses articles et de ses commentaires. La suppression n'est effective qu'après confirmation.

[[Image:|center|Suppression d’un thème d’articles]]

= Gestion =

Le gestionnaire d'un thème d'articles a accès à tous les articles du thème afin d'effectuer les opérations suivantes :

* Ordonner les articles
* Modifier les dates de publication et d'archivage
* Modifier le statut des articles : archivés, proposés en pages d'accueil, ...
* Déplacer les articles d'un thème à un autre
* Supprimer les articles

Le point d'entrée à ces options se situe en section Utilisateur : lien Gestion des articles.

Remarque : le gestionnaire n'a pas de droit de modification ou de création sur les articles, mais il peut visualiser les articles.

[[Image:|center|Section Utilisateur]]

[[Image:|center|Liste des thèmes d'articles gérés]]

== Supprimer un article ==

Seul le gestionnaire peut supprimer un article sur le site. Après sélection du thème d'articles dans l'arborescence (lien Gestion des articles en section Utilisateur), le gestionnaire doit sélectionner l'article (ou les articles) à supprimer via les cases à cocher en face des titres d'articles. L'interface permet une sélection multiple des articles. Le formulaire "Mettre à jour les éléments sélectionnés" permet d'effectuer l'opération de suppression sur tous les articles sélectionnés.

La suppression s'effectue après confirmation.

[[Image:|center|Suppression d’un article]]

== Ordonner les articles ==

Seul le gestionnaire peut ordonner les articles d'un thème (visible lors de la navigation dans les articles par les lecteurs). Après sélection du thème d'articles dans l'arborescence (lien Gestion des articles en section Utilisateur), l'onglet Ordre permet d'accéder au formulaire suivant :

[[Image:|center|Formulaire pour ordonner les articles d'un thème]]

Le formulaire est constitué d'une liste ordonnée (à gauche) des articles d'un même thème et de boutons (à droite) permettant de définir manuellement l'ordre d'affichage des articles.

Les deux flèches bleues permettent de monter ou de descendre un article sélectionné dans la liste.

Les deux icônes du bas ordonnent les articles par ordre croissant ou décroissant sur leurs noms.

Remarque :

* l'ordre défini par l'administrateur a une incidence sur la navigation (sections, chemin de fer...) et sur la gestion (publication, gestion des articles...).
* Si le gestionnaire ne modifie pas l'ordre des articles, les articles seront affichés par ordre de publication, l'article le plus récent en tête.

== Déplacer un article ==

Après sélection du thème d'articles dans l'arborescence (lien Gestion des articles en section Utilisateur), le gestionnaire doit afficher les propriétés de l'article pour accéder à son déplacement d'un thème à un autre : icône [[Image:]].

[[Image:|center|Liste des articles]]

Sur le formulaire des propriétés de l'article, l'entrée "thème d'articles" déroule la liste des thèmes sur lesquels le gestionnaire a accès. Le bouton "Mettre à jour" enregistre la modification et déplace l'article.

Remarque : le déplacement ne peut se faire que dans les thèmes d'articles que le gestionnaire gère.

[[Image:|center|Propriétés de l’article]]

== Archiver un article ==

Le gestionnaire peut décider d'archiver ou de désarchiver un article. Un article archivé est encore visible des lecteurs sur le site, cependant son affichage se situe dans une interface à part avec les autres articles archivés d'un même thème. Les articles archivés s'affichent en nombre limité : c'est l'administrateur qui définit le nombre d'articles affichés : les articles archivés les plus anciens ont donc peu de chances d'être vus des lecteurs.

Après sélection du thème d'articles dans l'arborescence (lien Gestion des articles en section Utilisateur), le gestionnaire doit sélectionner l'article (ou les articles) à archiver via les cases à cocher en face des titres d'articles. L'interface permet une sélection multiple des articles. Le formulaire "Mettre à jour les éléments sélectionnés" permet d'effectuer l'opération d'archivage sur tous les articles sélectionnés.

[[Image:|center|Archivage d'un article]]

Pour désarchiver un article et le rendre disponible à la lecture sur le site, le gestionnaire a accés à la liste des articles archivés : après sélection du thème d'articles dans l'arborescence (lien Gestion des articles en section Utilisateur), onglet "Archives".

[[Image:|center|Liste des articles archivés]]

== Autres options ==

Dans les propriétés d'un article (icône [[Image:]] après sélection du thème d'articles dans l'arborescence (lien Gestion des articles en section Utilisateur)), le gestionnaire a accès à plusieurs options selon ce qui a été défini par l'administrateur sur le thème d'articles :

* Date de publication : permet de retarder l'affichage de l'article sur le portail
* Date d'archivage : permet d'automatiser la mise en archive de l'article
* Restriction d'accès : permet de restreindre la lecture de l'article à des groupes d'utilisateurs

[[Image:|center|Propriétés de l’article]]

= Publication =

Les auteurs accèdent à la publication d'articles depuis le lien "Publication" en section Utilisateur. Un auteur peut avoir des droits de création et/ou de modification des articles. Chaque auteur pourra verrouiller un article et gérer un brouillon personnel avant de publier sa modification finale.

== Publier un article ==

Les auteurs accèdent à la publication d'articles depuis le lien "Publication" en section Utilisateur.

La publication passe par plusieurs étapes, les dernières étant optionnelles :

* Sélection du thème d'articles dans lequel l'article sera publié
* Rédaction de l'introduction et du corps de l'article
* Prévisualisation de l'article
* Préférences de publication : date de publication, date d'archivage, fichiers associés...

[[Image:]]

Ces étapes sont désormais (depuis la version 7.4) réunies en un seul écran.

Le lien "Publication" donne accès à la liste des brouillons de l'auteur. Le lien "Créer un nouvel article" lance l'édition.

Remarque : il est aussi possible de publier et de modifier un article en naviguant sur le site. Cette possibilité évite l'étape de sélection du thème.

[[Image:|center|Liste des brouillons d'un auteur]]

* Première étape :

L'auteur sélectionne le thème dans lequel sera créé le nouvel article grâce au menu déroulant. Pour un brouillon, il n'est pas nécessaire de choisir un thème.

[[Image:|center|Sélection du thème d’articles]]

* Deuxième étape :

L'auteur accède à la rédaction de l'article. Un article doit contenir un titre et une introduction. Le corps de l'article est optionnel. Par défaut, le bloc de rédaction est replié. Il faut cliquer sur le titre "Corps" pour que ce bloc s'affiche.

Le partage du contenu dans l'introduction et le corps a une incidence sur la navigation par les lecteurs. Il existe deux écrans principaux pour l'affichage des articles :

* liste des articles d'un thème
* corps de l'article

Lorsqu'un lecteur accède à un thème, il se retrouve avec la liste de tous ses articles et visualise leurs introductions. Si un article contient un corps, un lien "lire la suite" permettra d'accéder au corps de l'article.

L'auteur peut donc choisir de publier tout son article dans l'introduction afin de ne pas séparer le contenu en deux (introduction et corps). Cependant, il peut être intéressant d'utiliser le corps de l'article afin de ne pas surcharger la liste des articles dans le thème.

L'auteur choisira la langue de l'article. Ceci a un effet lors de l'application de filtres de langues sur le site.

[[Image:|center|Rédaction de l’article]]

== L'éditeur wysiwyg ==

L'introduction et le corps d'un article se rédigent grâce à un éditeur dit wysiwyg (What You See Is What You Get). Cet éditeur simplifie la mise en forme du contenu avec des fonctions de mise en gras, italique, alignement au centre, couleur de texte, ... L'objectif est de rédiger un contenu en langage html, le langage reconnu dans les navigateurs Web. L'éditeur simplifie donc la rédaction de l'article en rendant transparent l'édition du code html.

Fonctions :

[[Image:]] : police de caractères : Arial, Times New Roman, Verdana...

: taille de caractères en points (pt)

: style du texte : titre, paragraphe...

: alignement du texte : gauche, centré, droit, justifié

: création de listes à puces

: retrait gauche ou droit de lignes

: couleur du texte et du fond

: création d'un lien interne (renvoie sur la même page) ou externe (adresse Web externe) : le texte du lien doit être sélectionné préalablement : suppression d'un lien : création d'un tableau

: suppression de la mise en forme d'un texte sélectionné

: suppression des balises non désirées sur un texte provenant d'un éditeur externe

: passe en mode code source : édition en langage html

: passe l'édition en plein écran

: "copie" le texte sélectionné (quelques navigateurs n'acceptent pas cette opération)

: "coupe" le texte sélectionné

: "colle" le texte sélectionné

: annule ou répète la dernière action

: met en gras le texte sélectionné

: met en italique le texte sélectionné

: souligne le texte sélectionné

: barre le texte sélectionné

: met en indice le texte sélectionné (abaisse le texte) ; [[Image:]] met en exposant (élève le texte)

'': fonctions d'Ovidentia : voir description ci-dessous''

[[Image:|center|L’éditeur wysiwyg HTMLArea]]

Remarque : il est déconseillé de copier un texte dans l'éditeur wysiwyg provenant d'un éditeur de texte externe (Microsoft Word, OpenOffice, Works...) car certaines mises en formes peuvent être mal interprétées lors de l'affichage de l'article, les syntaxes de rédaction étant différentes. Il est préférable de passer par un texte intermédiaire en supprimant sa mise en forme.

Exemple :

Étape 1 : copie d'un texte mis en forme sur Microsoft Word

Étape 2 : le texte est "collé" dans un éditeur bas niveau tel que le bloc-notes sous Windows afin de supprimer sa mise en forme

Étape 3 : copie du texte placé dans le bloc-note

Étape 4 : le texte est "collé" dans l'éditeur wysiwyg puis mis en forme depuis l'éditeur wysiwyg

Fonctions d'Ovidentia :

[[Image:|center|Fonctions Ovidentia de l'éditeur wysiwyg]]

* Insérer une image : l'auteur peut ajouter une image provenant de son ordinateur

[[Image:]]

Le bouton Parcourir permet de sélectionner un fichier image provenant de son ordinateur.

Si l'option "partagé" est activée, l'image sera présente dans la bibliothèque et sera disponible pour tous les auteurs dans tous les thèmes d'articles. La bibliothèque est affichée en-dessous et peut contenir des répertoires. Avant de partager une image, le répertoire de destination doit être ouvert.

Alignement : définit l'affichage du texte par rapport à l'image. Un alignement à gauche affiche le texte sur le bord droit de l'image.

Alt : texte affiché lorsque l'image est inaccessible. Est aussi un renseignement sur la nature de l'image pour les malvoyants utilisant des lecteurs de pages Web.

Espacement horizontal : espace entre les bords gauche et droit de l'image

Espacement vertical : espace entre les bords haut et bas de l'image

Bordure : taille de la bordure en pixels

* Insérer des fichiers ou des répertoires du gestionnaire de fichiers
* Insérer un lien dynamique vers un article
* Insérer un lien vers une question/réponse d'une FAQ
* Insérer un fichier OVML : les fichiers OVML doivent être présents dans le dossier OVML du skin utilisé par le site. Si un dossier "editor" est présent dans le dossier OVML du skin, ce sont les fichiers présents dans ce dossier "editor" qui seront proposés.
* Insérer un lien vers un contact personnel
* Insérer un lien vers une fiche d'annuaire

== Options de publication ==

Après la rédaction de l'article, l'auteur accède aux options de publication.

* Thème d'articles : déplacement de l'article dans un autre thème
* Date de soumission : permet de retarder l'envoi de l'article à l'approbation, affecte aussi la publication
* Date de publication : permet de retarder l'affichage de l'article sur le site
* Date d'archivage : permet d'automatiser la mise en archive de l'article
* Proposer pour la page d'accueil publique : propose l'article pour la page d'accueil publique (accès anonyme). Seul le gestionnaire peut accepter l'article et l'afficher en pages d'accueil
* Proposer pour la page d'accueil privée : propose l'article pour la page d'accueil privée. Seul le gestionnaire peut accepter l'article et l'afficher en pages d'accueil
* Documents associés : permet d'ajouter des fichiers (pdf, doc, zip...) à l'article
* Notifier les utilisateurs une fois l'article publié : si activé, tous les utilisateurs ayant des droits de lecture recevront un mail de notification
* Restriction d'accès : permet de restreindre l'accès de l'article à des groupes d'utilisateurs

[[Image:|center|Quelques options de publication]]

== Attacher des fichiers à un article ==

Il existe deux méthodes pour associer des fichiers à un article. La première s'appuie sur le gestionnaire de fichiers, une autre fonction de publication d'Ovidentia. L'autre utilise la fonction présente dans les options de publication d'articles.

* Méthode 1 :

On désire lier un fichier à un article, cependant ce fichier sera utilisé dans plusieurs articles. Pour réduire l'espace disque utilisé par les multiples copies de fichiers, le fichier est placé dans le gestionnaire de fichiers.

Depuis l'éditeur wysiwyg, on utilisera l'icône [[Image:ovidentia-icone.png|Icone d'Ovidentia dans l'éditeur WYSIWYG]] pour faire un lien vers ce fichier dans l'article.

Cette méthode a d'autres avantages que le gain d'espace disque. Si le fichier est amené à évoluer, il peut changer de versions depuis le gestionnaire de fichiers : les articles seront directement liés à la dernière version du fichier. De plus, lorsqu'un fichier du gestionnaire de fichiers est lié à un article, son lien dans l'éditeur wysiwyg peut être placé n'importe où dans l'article (sur une image, entre 2 lignes...).

* Méthode 2 :

On souhaite associer un fichier à un article. Ce fichier sera uniquement accessible dans cet article et n'a pas d'intérêt à être visible depuis le gestionnaire de fichiers. On associe donc le fichier depuis les options de publication. Le formulaire de dépôt gère les dépôts multiples et l'ordre d'affichage des fichiers.

Remarque : les fichiers associés apparaîtront sous l'article pour les lecteurs. Contrairement à la méthode 1, les liens vers les fichiers ne peuvent pas être placés à l'intérieur du contenu de l'article.

[[Image:|center|Association des fichiers à un article]]

== Gérer un brouillon ==

Les auteurs peuvent gérer des brouillons lorsque le contenu n'est pas encore terminé. Un brouillon est personnel et n'est donc pas accessible aux autres auteurs. Il existe deux types de brouillons :

* le brouillon sur un nouvel article : dans ce cas, l'article n'est pas soumis à approbation ou n'est pas publié pendant la mise en brouillon.
* le brouillon sur un article modifié : dans ce cas, un article publié est en cours de modification par un auteur. Lorsque la modification est en brouillon, l'article dans son ancienne version reste affiché sur le site. Cependant, l'article est verrouillé par son auteur et ne pourra pas être édité par un autre auteur tant que la modification ne sera pas soumise.

Pour créer un brouillon d'un nouvel article ou d'un article modifié, il suffit de cliquer sur le bouton "Enregistrer un brouillon" lors de la rédaction de l'article.

[[Image:|center|Boutons lors de la rédaction d'un article]]

Le brouillon est accessible dans la liste des brouillons : lien Publication en section Utilisateur.

Pour soumettre un brouillon à la publication, l'auteur peut modifier l'article et suivre les étapes de publication et cliquer sur le bouton "Soumettre". L'auteur peut aussi soumettre l'article directement depuis la liste des brouillons via l'icône [[Image:]].

[[Image:|center|Liste des brouillons]]

= Navigation =

L'arborescence de publication gérée par l'administrateur met en évidence la navigation sur le site dans les articles.

Lors de l'intégration d'une charte graphique, le webmaster a recours à plusieurs méthodes pour afficher le contenu du site à ses lecteurs et peut proposer une navigation totalement différente de celle proposée par défaut dans Ovidentia. Les exemples ci-dessous proviennent de la navigation par défaut d'Ovidentia.

== Les sections ==

Les sections sont les principaux points d'entrée aux informations avec les pages d'accueil. Il existe deux types de sections dans les articles :

* la section de catégories de thèmes d'articles : elle présente la liste des catégories parentes. L'administrateur peut l'activer ou la désactiver depuis le lien "Sections" en section d'Administration.

[[Image:|center|Sections de catégories]]

* les sections de catégories : activées/désactivées par l'administrateur dans l'arborescence de publication, elles listent les thèmes d'articles présents dans une catégorie.

[[Image:|center|Section de catégorie]]

Remarque : l'administrateur peut ordonner l'affichage des sections depuis le lien "Sections" en section d'Administration.

== Navigation ==

Pendant la navigation dans les articles, les lecteurs s'orientent avec le chemin de fer (ou rail). Ce dernier s'appuie sur l'arborescence de publication :

[[Image:|center|Chemin de fer]]

Voici les écrans principaux affichés pendant la navigation dans les articles :

* Catégorie d'articles : liste des sous-catégories et thèmes d'articles d'une catégorie

[[Image:]]

Ici, la catégorie Actualités contient 3 thèmes d'articles : Sport, Politique et Economie.

* Thème d'articles : liste des articles d'un thème. Seules les introductions des articles sont affichées, le corps des articles est accessible via le lien "Lire la suite" sous les articles. L'auteur ainsi que la date de publication sont affichés. Pour les auteurs, il est possible de soumettre ou de modifier un article directement depuis un thème d'articles via les liens "Soumettre" et "Modifier".

[[Image:|center|Liste des articles d’un thème]]

* Articles archivés : les archives sont accessibles via l'onglet "Archives" présent sur chaque thème contenant des archives.

[[Image:]]

== Moteur de recherche ==

Les articles sont totalement intégrés dans le moteur de recherche d'Ovidentia. Pour une recherche avancée, indiquez au moteur la fonction Articles. Cette opération donne accès aux options de recherche :

* Thèmes d'articles : filtre le champ de recherche par thèmes d'articles
* Mots-clés du thésaurus : filtre les articles associés aux mots-clés renseignés. La saisie des mots-clés est simplifiée via une auto-suggestion. L'opérateur OU/ET précise si les articles recherchés doivent contenir tous les mots-clés (ET) ou au moins un mot-clé (OU).
* Auteur : filtre sur l'auteur des articles
* Après la date : filtre les articles publiés après la date renseignée
* Avant la date : filtre les articles publiés avant la date renseignée

[[Image:|center|Moteur de recherche]]

== Ajouter un commentaire ==

Si l'administrateur active les commentaires sur les thèmes d'articles, tous les utilisateurs ayant des droits de commenter verront s'afficher en-dessous de chaque article le lien "Commentaires".

Le lien "Commentaires" permet d'accéder à la liste des commentaires et à la création d'un commentaire.

Remarque : les commentaires peuvent être modérés.

[[Image:|center|Liste des commentaires]]

= Patrons d'affichage et modèles d'articles =

Les patrons d'affichage et les modèles d'articles sont des éléments accessibles au webmaster et permettent de personnaliser l'affichage ou la création des articles.

* Patrons d'affichage : ils permettent de personnaliser l'affichage final des articles ou des catégories
* Modèles d'articles : ils permettent d'initialiser le contenu de l'introduction et du corps des articles lors de leurs rédactions

L'application d'un patron ou d'un modèle s'effectue par l'administrateur dans l'arborescence de publication :

[[Image:]]

[[Image:]]

Création d'une catégorieCréation d'un thème d'articles

== Patrons d'affichage ==

Les patrons d'affichage permettent de personnaliser l'affichage final des articles, des catégories ou des sections.

Il existe trois types de patrons :

* les patrons d'affichage de catégories
* les patrons d'affichage de sections de catégories
* les patrons d'affichage de thèmes d'articles

Voici un exemple simple de personnalisation du patron d'affichage d'un thème d'articles :

Sur la gauche, on aperçoit l'affichage par défaut des articles dans un thème.

Sur la droite, le thème s'appuie sur un patron d'affichage créé par le webmaster : le webmaster a décidé de modifier l'apparence des titres d'articles, d'ajouter des liens internes redirigeant sur les titres d'articles et de supprimer l'affichage des auteurs et dates de publications.

[[Image:]] [[Image:]]

Réaliser un patron d'affichage :

Le webmaster doit avoir accès aux fichiers d'Ovidentia sur le serveur. Il doit commencer par copier le "template" concerné dans le skin du site. Le "template" est un fichier html présent dans la distribution (noyau Ovidentia ) et qui gère l'affichage d'éléments sur le site. Pour ajouter un patron d'affichage, il faut dupliquer le code présent dans ce fichier template.

Les fichiers templates concernés :

topcatsection.html : gère les patrons d'affichage des sections de catégories

topicsdisplay.html : gère le patron d'affichage des thèmes d'articles

topicssection.html : gère les patrons d'affichage des sections de thèmes

topcatdisplay.html : gère les patrons d'affichage des catégories

* Première étape : copier le fichier template présent dans le noyau dans le skin du site. Cette opération est nécessaire afin d'éviter de perdre toutes modifications lors de la mise à jour d'Ovidentia , les fichiers du noyau ne doivent pas être modifiés.

Répertoire des fichiers templates du noyau : racine d'Ovidentia/noyauXXX/skins/ovidentia/templates/

Répertoire des fichiers templates du skin : racine d'Ovidentia/skins/votreskin/templates/

* Deuxième étape : dupliquer le code présent dans le fichier afin de créer un nouveau patron. Chaque fichier contient une portion de code utilisée pour l'affichage d'éléments. La portion est délimitée par les syntaxes suivantes :

<source lang="html4strict">



</source>

Pour ajouter un nouveau patron d'affichage, il faut dupliquer le code compris entre les 2 lignes ci-dessus et nommer le patron de cette manière :

<source lang="html4strict">



</source>

* Troisième étape : personnaliser la portion de code dupliquée : modification de balises html, de styles, suppression d'éléments...

* Quatrième étape : affecter le patron d'affichage à l'élément désiré via l'arborescence de publication

Remarque :

Pour les patrons d'affichage de thèmes d'articles, il est nécessaire de dupliquer 2 portions de codes :

<source lang="html4strict">



</source>

et

<source lang="html4strict">



</source>

La première portion gère l'affichage des articles dans un thème (introductions des articles) et la deuxième gère l'affichage du corps d'un article.

== Modèles d'articles ==

Un modèle d'articles est un procédé qui permet d'initialiser l'introduction et le corps d'un article lors de sa rédaction. Le modèle n'impacte donc pas l'affichage final des articles, seulement sa rédaction.

Le procédé de création est le même que pour les patrons d'affichage (voir ci-dessus les 4 étapes de création), le fichier template concerné est articlestemplates.html.

Voici un exemple simple d'un modèle d'articles :

Lors de la rédaction d'un article, le contenu de l'introduction est pré-renseigné par un tableau.

[[Image:|center|Modèle d'articles]]

= Gestion des pages d'accueil =

Les pages d'accueil sont les points d'entrées principales sur un site, elles ne doivent pas être négligées. Elles contiennent généralement un message d'accueil ainsi que les dernières actualités. Il existe deux pages d'accueil sur Ovidentia :

* la page d'accueil publique : accessible aux utilisateurs anonymes
* la page d'accueil privée : accessible aux utilisateurs authentifiés

== L'OVML ==

Les pages d'accueil publique et privée d'Ovidentia peuvent être gérées par le langage OVML afin d'y afficher un contenu dynamique (derniers articles publiés, prochains événements...). Pour cela, il suffit de créer les fichiers public.html et private.html dans le skin du site sur le serveur. Lorsque ces fichiers sont présents dans le skin du site, ils remplacent l'affichage par défaut des pages d'accueil ; l'affichage par défaut étant la liste des articles proposés en pages d'accueil.

Répertoire des fichiers ovml du skin :

racine d'Ovidentia/skins/votreskin/ovml/

Voici 2 exemples de mise en forme des pages d'accueil par le langage OVML :

[[Image:]] [[Image:]]

Sur ces 2 captures d'écran, l'information remontée appartient à la gestion des articles.

== Proposer un article pour une page d'accueil ==

Les auteurs ont la possibilité de proposer leurs articles pour les pages d'accueil. Ce procédé permet d'afficher des articles tous thèmes confondus en pages d'accueil publique et privée.

Un gestionnaire des pages d'accueil (choisi par l'administrateur) accède à tous les articles proposés et décide de les afficher ou non en pages d'accueil.

* Options de publication :

Les auteurs peuvent proposer leurs articles en pages d'accueil depuis les options de publication (étape qui suit la rédaction et la prévisualisation de l'article), l'administrateur peut activer cette option dans les paramètres des thèmes.

[[Image:|center|Options de publication]]

* Gestionnaire des pages d'accueil :

L'administrateur définit les gestionnaires des pages d'accueil depuis les paramètres du site.

Le gestionnaire des pages d'accueil accède à la liste des articles proposés et peut à tout moment décider de les afficher ou de les retirer des pages d'accueil :

[[Image:|center|Gestion des articles proposés en pages d'accueil]]

Remarque :

L'affichage des articles est automatique dans le fonctionnement par défaut d'Ovidentia, cependant si le skin du site contient les fichiers private.html et public.html, les pages d'accueil sont alors gérées par le langage OVML. Dans ce cas, pour afficher les articles en pages d'accueil, le webmaster utilisera le container OVML nommé OCArticlesHomePages (voir la documentation sur le langage OVML pour plus de détails).

= Gestion de l'approbation =

L'administrateur peut définir un schéma d'approbation au niveau des options de thèmes d'articles. Les articles seront alors modérés au moment de leurs publications et/ou de leurs modifications : un ou plusieurs approbateurs devront accepter l'article avant sa publication.

Remarque :

Un message situé en bas de l'écran prévient l'auteur lorsque l'article est soumis à approbation avant sa publication.

== Schémas d'approbation ==

L'administrateur créé le schéma d'approbation depuis le lien Approbations en section d'Administration. Ce schéma pourra être choisi dans les options de thèmes d'articles et définit les personnes qui devront accepter les articles avant leurs publications sur le site.

[[Image:|center|Liste des schémas d’approbation]]

== Modérer un article ==

A la création ou à la modification d'un article soumis à approbation, l'approbateur est notifié par mail. Pour voir puis accepter ou refuser l'article, l'approbateur passe par le lien Approbations en section Utilisateur.

Remarque : le lien Approbations en section utilisateur n'apparaît qu'à condition que des éléments soient en attente d'approbation.

[[Image:|center|Liste des articles en attente]]

[[Image:|center|Réponse de l'approbateur]]

Articles

2013-06-19T15:36:41Z

Rodpec : /* Thèmes d'articles */

La gestion des articles est le plus important système de publication d'informations dans Ovidentia. L'éditeur wysiwyg intégré permet une souplesse dans la mise en forme du contenu ainsi qu'une liaison avec des fonctions du portail comme les annuaires et le gestionnaire de fichiers. Plusieurs points d'entrée existent afin de faciliter l'accès aux informations : sections de catégories, moteur de recherche, ... Le langage OVML pourra aussi être utilisé par le webmaster afin, par exemple, d'illustrer en pages d'accueil les dernières publications.

On retrouve six acteurs dans la gestion des articles :

* l'administrateur : il est en charge de créer l'arborescence de publication et de définir les droits d'accès
* le gestionnaire d'articles : le seul à pouvoir supprimer un article, il gère aussi les processus d'archivages
* le publicateur : l'auteur des articles
* l'approbateur : il modère les articles avant leurs publications
* le gestionnaire des pages d'accueil : il définit les articles qui seront affichés en pages d'accueil
* le lecteur : dernier acteur, il peut ajouter des commentaires aux articles 

= Administration =

L'administrateur est en charge de créer l'arborescence de publication qui deviendra par défaut l'arborescence de navigation sur le site. L'arborescence est constituée de catégories et de thèmes, conteneurs des articles. Pour chaque thème d'articles, l'administrateur choisit ses préférences, active les publications, les points d'entrée sur le site (sections) et définit les acteurs concernés : gestionnaires, publicateurs et lecteurs.

== L'arborescence de publication ==

Lien ''Articles'' en section d'Administration.

L'arborescence de publication est composée de 2 entités : les catégories et les thèmes d'articles.

* Les catégories sont de simples conteneurs, elles précisent la nature de l'information qu'elles contiennent. Une catégorie peut faire partie d'une catégorie parente, on parlera alors de sous-catégorie. Il n'y a pas de limites quant au nombre d'imbrications. Une catégorie peut contenir des thèmes d'articles et des sous-catégories. Sur l'exemple ci-dessous, ''Actualités'' est une catégorie qui contient 3 thèmes d'articles : ''Sport'', ''Politique'' et ''Économie''.
* Les thèmes d'articles sont aussi des conteneurs et précisent aussi la nature de l'information qu'ils contiennent. Un thème d'articles fait obligatoirement partie d'une catégorie et contient des articles. Les droits d'accès et toutes les options de publication s'appliquent uniquement sur les thèmes d'articles (un article n'a pas d'options uniques, il hérite des options de son thème).
* Les articles font partie d'un thème. Ils ne sont pas visibles de l'administrateur du site.

[[Image:|center|Administration : arborescence de publication]]

== Catégories d'articles ==

Dans l'arborescence de publication, on reconnaîtra 5 icônes permettant de gérer les catégories (et sous-catégories) :

* [[Image:]] : Création d'une catégorie
* [[Image:]] : Suppression d'une catégorie
* [[Image:]] : Ordonne les catégories d'un même niveau
* [[Image:]] / [[Image:]] : Affiche ou cache la section de la catégorie
* [[Image:]] : Droits par défaut de la catégorie

Remarque : les sections font partie des points d'entrée possibles aux articles dans la navigation du portail. Il est possible d'activer une section pour chacune des catégories. Une section comporte des liens vers les thèmes et sous-catégories de la catégorie.

[[Image:|center|Gestion des catégories]]

=== Création d’une catégorie ===

Depuis l'arborescence de publication, après avoir cliqué sur l'icône concernée au niveau désiré, le formulaire de création apparaît :

[[Image:|center|Formulaire de création d’une catégorie]]

* Nom : nom de la catégorie
* Description : description de la catégorie (non affichée sur le portail mais peut être utilisée via le langage OVML)
* Section activée : affiche ou cache la section de la catégorie
* Patron de section : optionnel. Indique la mise en forme utilisée pour l'affichage de la section
* Patron d'affichage : optionnel. Indique la mise en forme utilisée pour l'affichage des thèmes d'articles et des sous-catégories
* Catégorie de sujet parent : définit la catégorie parente afin de préciser le niveau d'arborescence
* Sélection d'une image : permet de charger une image au format jpg, gif ou png qui sera associée à la catégorie dans la présentation côté utilisateur

=== Affecter des droits par défaut sur une catégorie ===

Les droits d'accès des articles peuvent s'appliquer sur les catégories afin d'être définis par défaut sur les thèmes d'articles contenus dans ces catégories. Il existe 5 droits :

* Qui peut lire les articles de ce thème ? : lecteurs des articles
* Qui peut soumettre de nouveaux articles ? : auteurs des articles et des brouillons
* Qui peut soumettre des commentaires ? : lecteurs ayant des droits de commentaires sur les articles
* Qui peut modifier les articles ? : auteurs ayant des droits de modification sur les articles, ce statut ne donne pas droit à la création d'articles
* Qui peut gérer ce thème ? : gestionnaires. Ils ordonnent les articles, modifient les dates de publication, choisissent les articles d'archives, suppriment les articles...

[[Image:|center|Affectation des droits par défaut]]

Après avoir cliqué sur le bouton "Enregistrer" (situé tout en bas de l'arbre de droits), l'administrateur doit déterminer sur quels objets vont s'appliquer les droits qu'il vient de définir.

[[Image:]]

En ne sélectionnant aucun objet, on n'affecte aucun thème, sous-catégorie, etc... existant. Les prochains thèmes et sous-catégories créés dans cette catégorie seront en revanche affectés.

=== Ordonner les catégories ===

Le formulaire est constitué d'une liste ordonnée (à gauche) des catégories d'un même niveau et de boutons (à droite) permettant de définir manuellement l'ordre d'affichage des catégories.

Les deux flèches bleues permettent de monter ou de descendre une catégorie sélectionnée dans la liste.

Les deux icônes du bas ordonnent les catégories par ordre croissant ou décroissant sur leurs noms.

Remarque : l'ordre définit par l'administrateur a une incidence sur la navigation (sections, chemin de fer...) et sur la gestion (publication, gestion des articles...).

[[Image:|center|Formulaire pour ordonner les catégories d’articles]]

=== Supprimer une catégorie ===

Il est nécessaire pour supprimer une catégorie d'avoir préalablement supprimé les thèmes d'articles et les sous-catégories qu'elles contient. La suppression n'est effective qu'après confirmation.

[[Image:|center|Suppression d’une catégorie]]

== Thèmes d'articles ==

Dans l'arborescence de publication, on reconnaîtra 3 icônes permettant de gérer les thèmes d'articles :

* [[Image:theme-articles-creation.png|Création d'un thème d'articles]] : Création d'un thème d'articles
* [[Image:theme-articles-suppression.png|Suppression d'un thème d'articles]] : Suppression d'un thème d'articles
* [[Image:theme-articles-tri.png|Ordonne les thèmes d'articles]] : Ordonne les thèmes d'articles d'un même niveau
* [[Image:theme-articles-droits.png|Droits d'accès sur un thème d'articles]] : Droits d'accès sur un thème d'articles (lecteurs, publicateurs, gestionnaires...)

=== Création d’un thème ===

Depuis l'arborescence de publication, après avoir cliqué sur l'icône concernée sous la catégorie désirée, le formulaire de création apparaît :

[[Image:|center|Formulaire de création d’un thème d’articles]]

* Nom : nom du thème d'articles
* Catégorie de thèmes d'articles : définit la catégorie parente afin de préciser le niveau d'arborescence
* Description (via l'éditeur wysiwyg) : description du thème d'articles (visible pendant la navigation dans les articles)
* Langue : initialise la langue par défaut des articles, utile lorsqu'un filtre de langue est appliqué sur le site
* Patron d'affichage : optionnel. Indique la mise en forme utilisée pour l'affichage des articles
* Modèle d'articles : optionnel. Permet d'initialiser le contenu d'un article lors de sa création

Remarque : pour des raisons de mise en forme, l'éditeur wysiwyg ne permet pas le dépôt d'images dans la description d'un thème d'articles.

=== Préférences ===

Tous les articles sont rassemblés dans des thèmes. Les droits d'accès et les options de publication sont appliqués sur les thèmes : chaque article hérite donc des propriétés de son thème.

[[Image:|center|Préférences d’un thème d’articles]]

* Schéma d'approbation pour les articles : schéma utilisé pour modérer les nouveaux articles créés
* Schéma d'approbation pour les commentaires : schéma utilisé pour modérer les commentaires d'articles
* Schéma d'approbation pour la modification : schéma utilisé pour modérer les articles modifiés
* Approuver automatiquement le contributeur s'il fait partie de la première étape du schéma d'approbation : option applicable lors des modérations d'articles
* Les auteurs peuvent notifier les membres du groupe par email : envoie un mail à tous les utilisateurs ayant des droits de lecture sur le thème d'articles
* Les auteurs peuvent restreindre l'accès aux articles : les auteurs peuvent choisir les groupes d'utilisateurs pouvant voir les articles
* Permettre aux auteurs de proposer leur article pour les pages d'accueil : l'auteur propose son article, seul le gestionnaire peut décider d'afficher l'article en pages d'accueil
* Permettre aux auteurs de spécifier des dates de publication : permet de retarder la publication des articles
* Permettre aux auteurs de joindre des fichiers avec leurs articles : oui/non
* Permettre aux auteurs de modifier leurs articles : oui/non
* Permettre aux gestionnaires de modifier les articles : oui/non
* Nombre maximum d'articles sur la page des archives : lorsqu'un article est archivé, il n'est pas pour autant caché. Il se retrouve en nombre restreint avec les autres articles archivés.
* Utiliser les mots-clés du thésaurus : l'activation de cette option rendra obligatoire l'attribution d'au moins un mot-clé par article
* Permettre aux commentateurs de noter les articles: l'activation de cette option permet aux utilisateurs de noter l'article qu'ils commentent.
* Permettre aux auteurs d'associer une image à un article : Cette option autorise l'association d'une image à l'article. Cette image n'est visible qu'en étant récupérée en OvML.
* Sélection d'une image : permet de charger une image au format jpg, gif ou png qui sera associée au thème dans la présentation côté utilisateur. Cette image n'est visible qu'en étant récupérée en OvML.

Remarque : les schémas d'approbation sont créés par l'administrateur du site : lien Approbations en section d'Administration.

=== Droits d'accès ===

Les droits d'accès des articles s'appliquent sur leurs thèmes d'articles. Il existe 5 droits :

* Qui peut lire les articles de ce thème ? : lecteurs des articles
* Qui peut soumettre de nouveaux articles ? : auteurs des articles et des brouillons
* Qui peut soumettre des commentaires ? : lecteurs ayant des droits de commentaires sur les articles
* Qui peut modifier les articles ? : auteurs ayant des droits de modification sur les articles, ce statut ne donne pas droit à la création d'articles
* Qui peut gérer ce thème ? : gestionnaires. Ils ordonnent les articles, modifient les dates de publication, choisissent les articles d'archives, suppriment les articles...

[[Image:|center|ACL : formulaire de droits d’accès]]

=== Ordonner les thèmes ===

Le formulaire est constitué d'une liste ordonnée (à gauche) des thèmes d'articles d'un même niveau et de boutons (à droite) permettant de définir manuellement l'ordre d'affichage des thèmes.

Les deux flèches bleues permettent de monter ou de descendre un thème sélectionné dans la liste.

Les deux icônes du bas ordonnent les thèmes par ordre croissant ou décroissant sur leurs noms.

Remarque : l'ordre défini par l'administrateur a une incidence sur la navigation (sections, chemin de fer...) et sur la gestion (publication, gestion des articles...).

[[Image:|center|Formulaire pour ordonner les thèmes d’articles]]

=== Supprimer un thème ===

La suppression d'un thème d'articles entraînera la suppression de ses articles et de ses commentaires. La suppression n'est effective qu'après confirmation.

[[Image:|center|Suppression d’un thème d’articles]]

= Gestion =

Le gestionnaire d'un thème d'articles a accès à tous les articles du thème afin d'effectuer les opérations suivantes :

* Ordonner les articles
* Modifier les dates de publication et d'archivage
* Modifier le statut des articles : archivés, proposés en pages d'accueil, ...
* Déplacer les articles d'un thème à un autre
* Supprimer les articles

Le point d'entrée à ces options se situe en section Utilisateur : lien Gestion des articles.

Remarque : le gestionnaire n'a pas de droit de modification ou de création sur les articles, mais il peut visualiser les articles.

[[Image:|center|Section Utilisateur]]

[[Image:|center|Liste des thèmes d'articles gérés]]

== Supprimer un article ==

Seul le gestionnaire peut supprimer un article sur le site. Après sélection du thème d'articles dans l'arborescence (lien Gestion des articles en section Utilisateur), le gestionnaire doit sélectionner l'article (ou les articles) à supprimer via les cases à cocher en face des titres d'articles. L'interface permet une sélection multiple des articles. Le formulaire "Mettre à jour les éléments sélectionnés" permet d'effectuer l'opération de suppression sur tous les articles sélectionnés.

La suppression s'effectue après confirmation.

[[Image:|center|Suppression d’un article]]

== Ordonner les articles ==

Seul le gestionnaire peut ordonner les articles d'un thème (visible lors de la navigation dans les articles par les lecteurs). Après sélection du thème d'articles dans l'arborescence (lien Gestion des articles en section Utilisateur), l'onglet Ordre permet d'accéder au formulaire suivant :

[[Image:|center|Formulaire pour ordonner les articles d'un thème]]

Le formulaire est constitué d'une liste ordonnée (à gauche) des articles d'un même thème et de boutons (à droite) permettant de définir manuellement l'ordre d'affichage des articles.

Les deux flèches bleues permettent de monter ou de descendre un article sélectionné dans la liste.

Les deux icônes du bas ordonnent les articles par ordre croissant ou décroissant sur leurs noms.

Remarque :

* l'ordre défini par l'administrateur a une incidence sur la navigation (sections, chemin de fer...) et sur la gestion (publication, gestion des articles...).
* Si le gestionnaire ne modifie pas l'ordre des articles, les articles seront affichés par ordre de publication, l'article le plus récent en tête.

== Déplacer un article ==

Après sélection du thème d'articles dans l'arborescence (lien Gestion des articles en section Utilisateur), le gestionnaire doit afficher les propriétés de l'article pour accéder à son déplacement d'un thème à un autre : icône [[Image:]].

[[Image:|center|Liste des articles]]

Sur le formulaire des propriétés de l'article, l'entrée "thème d'articles" déroule la liste des thèmes sur lesquels le gestionnaire a accès. Le bouton "Mettre à jour" enregistre la modification et déplace l'article.

Remarque : le déplacement ne peut se faire que dans les thèmes d'articles que le gestionnaire gère.

[[Image:|center|Propriétés de l’article]]

== Archiver un article ==

Le gestionnaire peut décider d'archiver ou de désarchiver un article. Un article archivé est encore visible des lecteurs sur le site, cependant son affichage se situe dans une interface à part avec les autres articles archivés d'un même thème. Les articles archivés s'affichent en nombre limité : c'est l'administrateur qui définit le nombre d'articles affichés : les articles archivés les plus anciens ont donc peu de chances d'être vus des lecteurs.

Après sélection du thème d'articles dans l'arborescence (lien Gestion des articles en section Utilisateur), le gestionnaire doit sélectionner l'article (ou les articles) à archiver via les cases à cocher en face des titres d'articles. L'interface permet une sélection multiple des articles. Le formulaire "Mettre à jour les éléments sélectionnés" permet d'effectuer l'opération d'archivage sur tous les articles sélectionnés.

[[Image:|center|Archivage d'un article]]

Pour désarchiver un article et le rendre disponible à la lecture sur le site, le gestionnaire a accés à la liste des articles archivés : après sélection du thème d'articles dans l'arborescence (lien Gestion des articles en section Utilisateur), onglet "Archives".

[[Image:|center|Liste des articles archivés]]

== Autres options ==

Dans les propriétés d'un article (icône [[Image:]] après sélection du thème d'articles dans l'arborescence (lien Gestion des articles en section Utilisateur)), le gestionnaire a accès à plusieurs options selon ce qui a été défini par l'administrateur sur le thème d'articles :

* Date de publication : permet de retarder l'affichage de l'article sur le portail
* Date d'archivage : permet d'automatiser la mise en archive de l'article
* Restriction d'accès : permet de restreindre la lecture de l'article à des groupes d'utilisateurs

[[Image:|center|Propriétés de l’article]]

= Publication =

Les auteurs accèdent à la publication d'articles depuis le lien "Publication" en section Utilisateur. Un auteur peut avoir des droits de création et/ou de modification des articles. Chaque auteur pourra verrouiller un article et gérer un brouillon personnel avant de publier sa modification finale.

== Publier un article ==

Les auteurs accèdent à la publication d'articles depuis le lien "Publication" en section Utilisateur.

La publication passe par plusieurs étapes, les dernières étant optionnelles :

* Sélection du thème d'articles dans lequel l'article sera publié
* Rédaction de l'introduction et du corps de l'article
* Prévisualisation de l'article
* Préférences de publication : date de publication, date d'archivage, fichiers associés...

[[Image:]]

Ces étapes sont désormais (depuis la version 7.4) réunies en un seul écran.

Le lien "Publication" donne accès à la liste des brouillons de l'auteur. Le lien "Créer un nouvel article" lance l'édition.

Remarque : il est aussi possible de publier et de modifier un article en naviguant sur le site. Cette possibilité évite l'étape de sélection du thème.

[[Image:|center|Liste des brouillons d'un auteur]]

* Première étape :

L'auteur sélectionne le thème dans lequel sera créé le nouvel article grâce au menu déroulant. Pour un brouillon, il n'est pas nécessaire de choisir un thème.

[[Image:|center|Sélection du thème d’articles]]

* Deuxième étape :

L'auteur accède à la rédaction de l'article. Un article doit contenir un titre et une introduction. Le corps de l'article est optionnel. Par défaut, le bloc de rédaction est replié. Il faut cliquer sur le titre "Corps" pour que ce bloc s'affiche.

Le partage du contenu dans l'introduction et le corps a une incidence sur la navigation par les lecteurs. Il existe deux écrans principaux pour l'affichage des articles :

* liste des articles d'un thème
* corps de l'article

Lorsqu'un lecteur accède à un thème, il se retrouve avec la liste de tous ses articles et visualise leurs introductions. Si un article contient un corps, un lien "lire la suite" permettra d'accéder au corps de l'article.

L'auteur peut donc choisir de publier tout son article dans l'introduction afin de ne pas séparer le contenu en deux (introduction et corps). Cependant, il peut être intéressant d'utiliser le corps de l'article afin de ne pas surcharger la liste des articles dans le thème.

L'auteur choisira la langue de l'article. Ceci a un effet lors de l'application de filtres de langues sur le site.

[[Image:|center|Rédaction de l’article]]

== L'éditeur wysiwyg ==

L'introduction et le corps d'un article se rédigent grâce à un éditeur dit wysiwyg (What You See Is What You Get). Cet éditeur simplifie la mise en forme du contenu avec des fonctions de mise en gras, italique, alignement au centre, couleur de texte, ... L'objectif est de rédiger un contenu en langage html, le langage reconnu dans les navigateurs Web. L'éditeur simplifie donc la rédaction de l'article en rendant transparent l'édition du code html.

Fonctions :

[[Image:]] : police de caractères : Arial, Times New Roman, Verdana...

: taille de caractères en points (pt)

: style du texte : titre, paragraphe...

: alignement du texte : gauche, centré, droit, justifié

: création de listes à puces

: retrait gauche ou droit de lignes

: couleur du texte et du fond

: création d'un lien interne (renvoie sur la même page) ou externe (adresse Web externe) : le texte du lien doit être sélectionné préalablement : suppression d'un lien : création d'un tableau

: suppression de la mise en forme d'un texte sélectionné

: suppression des balises non désirées sur un texte provenant d'un éditeur externe

: passe en mode code source : édition en langage html

: passe l'édition en plein écran

: "copie" le texte sélectionné (quelques navigateurs n'acceptent pas cette opération)

: "coupe" le texte sélectionné

: "colle" le texte sélectionné

: annule ou répète la dernière action

: met en gras le texte sélectionné

: met en italique le texte sélectionné

: souligne le texte sélectionné

: barre le texte sélectionné

: met en indice le texte sélectionné (abaisse le texte) ; [[Image:]] met en exposant (élève le texte)

'': fonctions d'Ovidentia : voir description ci-dessous''

[[Image:|center|L’éditeur wysiwyg HTMLArea]]

Remarque : il est déconseillé de copier un texte dans l'éditeur wysiwyg provenant d'un éditeur de texte externe (Microsoft Word, OpenOffice, Works...) car certaines mises en formes peuvent être mal interprétées lors de l'affichage de l'article, les syntaxes de rédaction étant différentes. Il est préférable de passer par un texte intermédiaire en supprimant sa mise en forme.

Exemple :

Étape 1 : copie d'un texte mis en forme sur Microsoft Word

Étape 2 : le texte est "collé" dans un éditeur bas niveau tel que le bloc-notes sous Windows afin de supprimer sa mise en forme

Étape 3 : copie du texte placé dans le bloc-note

Étape 4 : le texte est "collé" dans l'éditeur wysiwyg puis mis en forme depuis l'éditeur wysiwyg

Fonctions d'Ovidentia :

[[Image:|center|Fonctions Ovidentia de l'éditeur wysiwyg]]

* Insérer une image : l'auteur peut ajouter une image provenant de son ordinateur

[[Image:]]

Le bouton Parcourir permet de sélectionner un fichier image provenant de son ordinateur.

Si l'option "partagé" est activée, l'image sera présente dans la bibliothèque et sera disponible pour tous les auteurs dans tous les thèmes d'articles. La bibliothèque est affichée en-dessous et peut contenir des répertoires. Avant de partager une image, le répertoire de destination doit être ouvert.

Alignement : définit l'affichage du texte par rapport à l'image. Un alignement à gauche affiche le texte sur le bord droit de l'image.

Alt : texte affiché lorsque l'image est inaccessible. Est aussi un renseignement sur la nature de l'image pour les malvoyants utilisant des lecteurs de pages Web.

Espacement horizontal : espace entre les bords gauche et droit de l'image

Espacement vertical : espace entre les bords haut et bas de l'image

Bordure : taille de la bordure en pixels

* Insérer des fichiers ou des répertoires du gestionnaire de fichiers
* Insérer un lien dynamique vers un article
* Insérer un lien vers une question/réponse d'une FAQ
* Insérer un fichier OVML : les fichiers OVML doivent être présents dans le dossier OVML du skin utilisé par le site. Si un dossier "editor" est présent dans le dossier OVML du skin, ce sont les fichiers présents dans ce dossier "editor" qui seront proposés.
* Insérer un lien vers un contact personnel
* Insérer un lien vers une fiche d'annuaire

== Options de publication ==

Après la rédaction de l'article, l'auteur accède aux options de publication.

* Thème d'articles : déplacement de l'article dans un autre thème
* Date de soumission : permet de retarder l'envoi de l'article à l'approbation, affecte aussi la publication
* Date de publication : permet de retarder l'affichage de l'article sur le site
* Date d'archivage : permet d'automatiser la mise en archive de l'article
* Proposer pour la page d'accueil publique : propose l'article pour la page d'accueil publique (accès anonyme). Seul le gestionnaire peut accepter l'article et l'afficher en pages d'accueil
* Proposer pour la page d'accueil privée : propose l'article pour la page d'accueil privée. Seul le gestionnaire peut accepter l'article et l'afficher en pages d'accueil
* Documents associés : permet d'ajouter des fichiers (pdf, doc, zip...) à l'article
* Notifier les utilisateurs une fois l'article publié : si activé, tous les utilisateurs ayant des droits de lecture recevront un mail de notification
* Restriction d'accès : permet de restreindre l'accès de l'article à des groupes d'utilisateurs

[[Image:|center|Quelques options de publication]]

== Attacher des fichiers à un article ==

Il existe deux méthodes pour associer des fichiers à un article. La première s'appuie sur le gestionnaire de fichiers, une autre fonction de publication d'Ovidentia. L'autre utilise la fonction présente dans les options de publication d'articles.

* Méthode 1 :

On désire lier un fichier à un article, cependant ce fichier sera utilisé dans plusieurs articles. Pour réduire l'espace disque utilisé par les multiples copies de fichiers, le fichier est placé dans le gestionnaire de fichiers.

Depuis l'éditeur wysiwyg, on utilisera l'icône [[Image:ovidentia-icone.png|Icone d'Ovidentia dans l'éditeur WYSIWYG]] pour faire un lien vers ce fichier dans l'article.

Cette méthode a d'autres avantages que le gain d'espace disque. Si le fichier est amené à évoluer, il peut changer de versions depuis le gestionnaire de fichiers : les articles seront directement liés à la dernière version du fichier. De plus, lorsqu'un fichier du gestionnaire de fichiers est lié à un article, son lien dans l'éditeur wysiwyg peut être placé n'importe où dans l'article (sur une image, entre 2 lignes...).

* Méthode 2 :

On souhaite associer un fichier à un article. Ce fichier sera uniquement accessible dans cet article et n'a pas d'intérêt à être visible depuis le gestionnaire de fichiers. On associe donc le fichier depuis les options de publication. Le formulaire de dépôt gère les dépôts multiples et l'ordre d'affichage des fichiers.

Remarque : les fichiers associés apparaîtront sous l'article pour les lecteurs. Contrairement à la méthode 1, les liens vers les fichiers ne peuvent pas être placés à l'intérieur du contenu de l'article.

[[Image:|center|Association des fichiers à un article]]

== Gérer un brouillon ==

Les auteurs peuvent gérer des brouillons lorsque le contenu n'est pas encore terminé. Un brouillon est personnel et n'est donc pas accessible aux autres auteurs. Il existe deux types de brouillons :

* le brouillon sur un nouvel article : dans ce cas, l'article n'est pas soumis à approbation ou n'est pas publié pendant la mise en brouillon.
* le brouillon sur un article modifié : dans ce cas, un article publié est en cours de modification par un auteur. Lorsque la modification est en brouillon, l'article dans son ancienne version reste affiché sur le site. Cependant, l'article est verrouillé par son auteur et ne pourra pas être édité par un autre auteur tant que la modification ne sera pas soumise.

Pour créer un brouillon d'un nouvel article ou d'un article modifié, il suffit de cliquer sur le bouton "Enregistrer un brouillon" lors de la rédaction de l'article.

[[Image:|center|Boutons lors de la rédaction d'un article]]

Le brouillon est accessible dans la liste des brouillons : lien Publication en section Utilisateur.

Pour soumettre un brouillon à la publication, l'auteur peut modifier l'article et suivre les étapes de publication et cliquer sur le bouton "Soumettre". L'auteur peut aussi soumettre l'article directement depuis la liste des brouillons via l'icône [[Image:]].

[[Image:|center|Liste des brouillons]]

= Navigation =

L'arborescence de publication gérée par l'administrateur met en évidence la navigation sur le site dans les articles.

Lors de l'intégration d'une charte graphique, le webmaster a recours à plusieurs méthodes pour afficher le contenu du site à ses lecteurs et peut proposer une navigation totalement différente de celle proposée par défaut dans Ovidentia. Les exemples ci-dessous proviennent de la navigation par défaut d'Ovidentia.

== Les sections ==

Les sections sont les principaux points d'entrée aux informations avec les pages d'accueil. Il existe deux types de sections dans les articles :

* la section de catégories de thèmes d'articles : elle présente la liste des catégories parentes. L'administrateur peut l'activer ou la désactiver depuis le lien "Sections" en section d'Administration.

[[Image:|center|Sections de catégories]]

* les sections de catégories : activées/désactivées par l'administrateur dans l'arborescence de publication, elles listent les thèmes d'articles présents dans une catégorie.

[[Image:|center|Section de catégorie]]

Remarque : l'administrateur peut ordonner l'affichage des sections depuis le lien "Sections" en section d'Administration.

== Navigation ==

Pendant la navigation dans les articles, les lecteurs s'orientent avec le chemin de fer (ou rail). Ce dernier s'appuie sur l'arborescence de publication :

[[Image:|center|Chemin de fer]]

Voici les écrans principaux affichés pendant la navigation dans les articles :

* Catégorie d'articles : liste des sous-catégories et thèmes d'articles d'une catégorie

[[Image:]]

Ici, la catégorie Actualités contient 3 thèmes d'articles : Sport, Politique et Economie.

* Thème d'articles : liste des articles d'un thème. Seules les introductions des articles sont affichées, le corps des articles est accessible via le lien "Lire la suite" sous les articles. L'auteur ainsi que la date de publication sont affichés. Pour les auteurs, il est possible de soumettre ou de modifier un article directement depuis un thème d'articles via les liens "Soumettre" et "Modifier".

[[Image:|center|Liste des articles d’un thème]]

* Articles archivés : les archives sont accessibles via l'onglet "Archives" présent sur chaque thème contenant des archives.

[[Image:]]

== Moteur de recherche ==

Les articles sont totalement intégrés dans le moteur de recherche d'Ovidentia. Pour une recherche avancée, indiquez au moteur la fonction Articles. Cette opération donne accès aux options de recherche :

* Thèmes d'articles : filtre le champ de recherche par thèmes d'articles
* Mots-clés du thésaurus : filtre les articles associés aux mots-clés renseignés. La saisie des mots-clés est simplifiée via une auto-suggestion. L'opérateur OU/ET précise si les articles recherchés doivent contenir tous les mots-clés (ET) ou au moins un mot-clé (OU).
* Auteur : filtre sur l'auteur des articles
* Après la date : filtre les articles publiés après la date renseignée
* Avant la date : filtre les articles publiés avant la date renseignée

[[Image:|center|Moteur de recherche]]

== Ajouter un commentaire ==

Si l'administrateur active les commentaires sur les thèmes d'articles, tous les utilisateurs ayant des droits de commenter verront s'afficher en-dessous de chaque article le lien "Commentaires".

Le lien "Commentaires" permet d'accéder à la liste des commentaires et à la création d'un commentaire.

Remarque : les commentaires peuvent être modérés.

[[Image:|center|Liste des commentaires]]

= Patrons d'affichage et modèles d'articles =

Les patrons d'affichage et les modèles d'articles sont des éléments accessibles au webmaster et permettent de personnaliser l'affichage ou la création des articles.

* Patrons d'affichage : ils permettent de personnaliser l'affichage final des articles ou des catégories
* Modèles d'articles : ils permettent d'initialiser le contenu de l'introduction et du corps des articles lors de leurs rédactions

L'application d'un patron ou d'un modèle s'effectue par l'administrateur dans l'arborescence de publication :

[[Image:]]

[[Image:]]

Création d'une catégorieCréation d'un thème d'articles

== Patrons d'affichage ==

Les patrons d'affichage permettent de personnaliser l'affichage final des articles, des catégories ou des sections.

Il existe trois types de patrons :

* les patrons d'affichage de catégories
* les patrons d'affichage de sections de catégories
* les patrons d'affichage de thèmes d'articles

Voici un exemple simple de personnalisation du patron d'affichage d'un thème d'articles :

Sur la gauche, on aperçoit l'affichage par défaut des articles dans un thème.

Sur la droite, le thème s'appuie sur un patron d'affichage créé par le webmaster : le webmaster a décidé de modifier l'apparence des titres d'articles, d'ajouter des liens internes redirigeant sur les titres d'articles et de supprimer l'affichage des auteurs et dates de publications.

[[Image:]] [[Image:]]

Réaliser un patron d'affichage :

Le webmaster doit avoir accès aux fichiers d'Ovidentia sur le serveur. Il doit commencer par copier le "template" concerné dans le skin du site. Le "template" est un fichier html présent dans la distribution (noyau Ovidentia ) et qui gère l'affichage d'éléments sur le site. Pour ajouter un patron d'affichage, il faut dupliquer le code présent dans ce fichier template.

Les fichiers templates concernés :

topcatsection.html : gère les patrons d'affichage des sections de catégories

topicsdisplay.html : gère le patron d'affichage des thèmes d'articles

topicssection.html : gère les patrons d'affichage des sections de thèmes

topcatdisplay.html : gère les patrons d'affichage des catégories

* Première étape : copier le fichier template présent dans le noyau dans le skin du site. Cette opération est nécessaire afin d'éviter de perdre toutes modifications lors de la mise à jour d'Ovidentia , les fichiers du noyau ne doivent pas être modifiés.

Répertoire des fichiers templates du noyau : racine d'Ovidentia/noyauXXX/skins/ovidentia/templates/

Répertoire des fichiers templates du skin : racine d'Ovidentia/skins/votreskin/templates/

* Deuxième étape : dupliquer le code présent dans le fichier afin de créer un nouveau patron. Chaque fichier contient une portion de code utilisée pour l'affichage d'éléments. La portion est délimitée par les syntaxes suivantes :

<source lang="html4strict">



</source>

Pour ajouter un nouveau patron d'affichage, il faut dupliquer le code compris entre les 2 lignes ci-dessus et nommer le patron de cette manière :

<source lang="html4strict">



</source>

* Troisième étape : personnaliser la portion de code dupliquée : modification de balises html, de styles, suppression d'éléments...

* Quatrième étape : affecter le patron d'affichage à l'élément désiré via l'arborescence de publication

Remarque :

Pour les patrons d'affichage de thèmes d'articles, il est nécessaire de dupliquer 2 portions de codes :

<source lang="html4strict">



</source>

et

<source lang="html4strict">



</source>

La première portion gère l'affichage des articles dans un thème (introductions des articles) et la deuxième gère l'affichage du corps d'un article.

== Modèles d'articles ==

Un modèle d'articles est un procédé qui permet d'initialiser l'introduction et le corps d'un article lors de sa rédaction. Le modèle n'impacte donc pas l'affichage final des articles, seulement sa rédaction.

Le procédé de création est le même que pour les patrons d'affichage (voir ci-dessus les 4 étapes de création), le fichier template concerné est articlestemplates.html.

Voici un exemple simple d'un modèle d'articles :

Lors de la rédaction d'un article, le contenu de l'introduction est pré-renseigné par un tableau.

[[Image:|center|Modèle d'articles]]

= Gestion des pages d'accueil =

Les pages d'accueil sont les points d'entrées principales sur un site, elles ne doivent pas être négligées. Elles contiennent généralement un message d'accueil ainsi que les dernières actualités. Il existe deux pages d'accueil sur Ovidentia :

* la page d'accueil publique : accessible aux utilisateurs anonymes
* la page d'accueil privée : accessible aux utilisateurs authentifiés

== L'OVML ==

Les pages d'accueil publique et privée d'Ovidentia peuvent être gérées par le langage OVML afin d'y afficher un contenu dynamique (derniers articles publiés, prochains événements...). Pour cela, il suffit de créer les fichiers public.html et private.html dans le skin du site sur le serveur. Lorsque ces fichiers sont présents dans le skin du site, ils remplacent l'affichage par défaut des pages d'accueil ; l'affichage par défaut étant la liste des articles proposés en pages d'accueil.

Répertoire des fichiers ovml du skin :

racine d'Ovidentia/skins/votreskin/ovml/

Voici 2 exemples de mise en forme des pages d'accueil par le langage OVML :

[[Image:]] [[Image:]]

Sur ces 2 captures d'écran, l'information remontée appartient à la gestion des articles.

== Proposer un article pour une page d'accueil ==

Les auteurs ont la possibilité de proposer leurs articles pour les pages d'accueil. Ce procédé permet d'afficher des articles tous thèmes confondus en pages d'accueil publique et privée.

Un gestionnaire des pages d'accueil (choisi par l'administrateur) accède à tous les articles proposés et décide de les afficher ou non en pages d'accueil.

* Options de publication :

Les auteurs peuvent proposer leurs articles en pages d'accueil depuis les options de publication (étape qui suit la rédaction et la prévisualisation de l'article), l'administrateur peut activer cette option dans les paramètres des thèmes.

[[Image:|center|Options de publication]]

* Gestionnaire des pages d'accueil :

L'administrateur définit les gestionnaires des pages d'accueil depuis les paramètres du site.

Le gestionnaire des pages d'accueil accède à la liste des articles proposés et peut à tout moment décider de les afficher ou de les retirer des pages d'accueil :

[[Image:|center|Gestion des articles proposés en pages d'accueil]]

Remarque :

L'affichage des articles est automatique dans le fonctionnement par défaut d'Ovidentia, cependant si le skin du site contient les fichiers private.html et public.html, les pages d'accueil sont alors gérées par le langage OVML. Dans ce cas, pour afficher les articles en pages d'accueil, le webmaster utilisera le container OVML nommé OCArticlesHomePages (voir la documentation sur le langage OVML pour plus de détails).

= Gestion de l'approbation =

L'administrateur peut définir un schéma d'approbation au niveau des options de thèmes d'articles. Les articles seront alors modérés au moment de leurs publications et/ou de leurs modifications : un ou plusieurs approbateurs devront accepter l'article avant sa publication.

Remarque :

Un message situé en bas de l'écran prévient l'auteur lorsque l'article est soumis à approbation avant sa publication.

== Schémas d'approbation ==

L'administrateur créé le schéma d'approbation depuis le lien Approbations en section d'Administration. Ce schéma pourra être choisi dans les options de thèmes d'articles et définit les personnes qui devront accepter les articles avant leurs publications sur le site.

[[Image:|center|Liste des schémas d’approbation]]

== Modérer un article ==

A la création ou à la modification d'un article soumis à approbation, l'approbateur est notifié par mail. Pour voir puis accepter ou refuser l'article, l'approbateur passe par le lien Approbations en section Utilisateur.

Remarque : le lien Approbations en section utilisateur n'apparaît qu'à condition que des éléments soient en attente d'approbation.

[[Image:|center|Liste des articles en attente]]

[[Image:|center|Réponse de l'approbateur]]

Articles

2013-06-19T15:00:57Z

Rodpec : /* Attacher des fichiers à un article */

La gestion des articles est le plus important système de publication d'informations dans Ovidentia. L'éditeur wysiwyg intégré permet une souplesse dans la mise en forme du contenu ainsi qu'une liaison avec des fonctions du portail comme les annuaires et le gestionnaire de fichiers. Plusieurs points d'entrée existent afin de faciliter l'accès aux informations : sections de catégories, moteur de recherche, ... Le langage OVML pourra aussi être utilisé par le webmaster afin, par exemple, d'illustrer en pages d'accueil les dernières publications.

On retrouve six acteurs dans la gestion des articles :

* l'administrateur : il est en charge de créer l'arborescence de publication et de définir les droits d'accès
* le gestionnaire d'articles : le seul à pouvoir supprimer un article, il gère aussi les processus d'archivages
* le publicateur : l'auteur des articles
* l'approbateur : il modère les articles avant leurs publications
* le gestionnaire des pages d'accueil : il définit les articles qui seront affichés en pages d'accueil
* le lecteur : dernier acteur, il peut ajouter des commentaires aux articles 

= Administration =

L'administrateur est en charge de créer l'arborescence de publication qui deviendra par défaut l'arborescence de navigation sur le site. L'arborescence est constituée de catégories et de thèmes, conteneurs des articles. Pour chaque thème d'articles, l'administrateur choisit ses préférences, active les publications, les points d'entrée sur le site (sections) et définit les acteurs concernés : gestionnaires, publicateurs et lecteurs.

== L'arborescence de publication ==

Lien ''Articles'' en section d'Administration.

L'arborescence de publication est composée de 2 entités : les catégories et les thèmes d'articles.

* Les catégories sont de simples conteneurs, elles précisent la nature de l'information qu'elles contiennent. Une catégorie peut faire partie d'une catégorie parente, on parlera alors de sous-catégorie. Il n'y a pas de limites quant au nombre d'imbrications. Une catégorie peut contenir des thèmes d'articles et des sous-catégories. Sur l'exemple ci-dessous, ''Actualités'' est une catégorie qui contient 3 thèmes d'articles : ''Sport'', ''Politique'' et ''Économie''.
* Les thèmes d'articles sont aussi des conteneurs et précisent aussi la nature de l'information qu'ils contiennent. Un thème d'articles fait obligatoirement partie d'une catégorie et contient des articles. Les droits d'accès et toutes les options de publication s'appliquent uniquement sur les thèmes d'articles (un article n'a pas d'options uniques, il hérite des options de son thème).
* Les articles font partie d'un thème. Ils ne sont pas visibles de l'administrateur du site.

[[Image:|center|Administration : arborescence de publication]]

== Catégories d'articles ==

Dans l'arborescence de publication, on reconnaîtra 5 icônes permettant de gérer les catégories (et sous-catégories) :

* [[Image:]] : Création d'une catégorie
* [[Image:]] : Suppression d'une catégorie
* [[Image:]] : Ordonne les catégories d'un même niveau
* [[Image:]] / [[Image:]] : Affiche ou cache la section de la catégorie
* [[Image:]] : Droits par défaut de la catégorie

Remarque : les sections font partie des points d'entrée possibles aux articles dans la navigation du portail. Il est possible d'activer une section pour chacune des catégories. Une section comporte des liens vers les thèmes et sous-catégories de la catégorie.

[[Image:|center|Gestion des catégories]]

=== Création d’une catégorie ===

Depuis l'arborescence de publication, après avoir cliqué sur l'icône concernée au niveau désiré, le formulaire de création apparaît :

[[Image:|center|Formulaire de création d’une catégorie]]

* Nom : nom de la catégorie
* Description : description de la catégorie (non affichée sur le portail mais peut être utilisée via le langage OVML)
* Section activée : affiche ou cache la section de la catégorie
* Patron de section : optionnel. Indique la mise en forme utilisée pour l'affichage de la section
* Patron d'affichage : optionnel. Indique la mise en forme utilisée pour l'affichage des thèmes d'articles et des sous-catégories
* Catégorie de sujet parent : définit la catégorie parente afin de préciser le niveau d'arborescence
* Sélection d'une image : permet de charger une image au format jpg, gif ou png qui sera associée à la catégorie dans la présentation côté utilisateur

=== Affecter des droits par défaut sur une catégorie ===

Les droits d'accès des articles peuvent s'appliquer sur les catégories afin d'être définis par défaut sur les thèmes d'articles contenus dans ces catégories. Il existe 5 droits :

* Qui peut lire les articles de ce thème ? : lecteurs des articles
* Qui peut soumettre de nouveaux articles ? : auteurs des articles et des brouillons
* Qui peut soumettre des commentaires ? : lecteurs ayant des droits de commentaires sur les articles
* Qui peut modifier les articles ? : auteurs ayant des droits de modification sur les articles, ce statut ne donne pas droit à la création d'articles
* Qui peut gérer ce thème ? : gestionnaires. Ils ordonnent les articles, modifient les dates de publication, choisissent les articles d'archives, suppriment les articles...

[[Image:|center|Affectation des droits par défaut]]

Après avoir cliqué sur le bouton "Enregistrer" (situé tout en bas de l'arbre de droits), l'administrateur doit déterminer sur quels objets vont s'appliquer les droits qu'il vient de définir.

[[Image:]]

En ne sélectionnant aucun objet, on n'affecte aucun thème, sous-catégorie, etc... existant. Les prochains thèmes et sous-catégories créés dans cette catégorie seront en revanche affectés.

=== Ordonner les catégories ===

Le formulaire est constitué d'une liste ordonnée (à gauche) des catégories d'un même niveau et de boutons (à droite) permettant de définir manuellement l'ordre d'affichage des catégories.

Les deux flèches bleues permettent de monter ou de descendre une catégorie sélectionnée dans la liste.

Les deux icônes du bas ordonnent les catégories par ordre croissant ou décroissant sur leurs noms.

Remarque : l'ordre définit par l'administrateur a une incidence sur la navigation (sections, chemin de fer...) et sur la gestion (publication, gestion des articles...).

[[Image:|center|Formulaire pour ordonner les catégories d’articles]]

=== Supprimer une catégorie ===

Il est nécessaire pour supprimer une catégorie d'avoir préalablement supprimé les thèmes d'articles et les sous-catégories qu'elles contient. La suppression n'est effective qu'après confirmation.

[[Image:|center|Suppression d’une catégorie]]

== Thèmes d'articles ==

Dans l'arborescence de publication, on reconnaîtra 3 icônes permettant de gérer les thèmes d'articles :

* [[Image:]] : Création d'un thème d'articles
* [[Image:]] : Suppression d'un thème d'articles
* [[Image:]] : Ordonne les thèmes d'articles d'un même niveau
* [[Image:]] : Droits d'accès sur un thème d'articles (lecteurs, publicateurs, gestionnaires...)

=== Création d’un thème ===

Depuis l'arborescence de publication, après avoir cliqué sur l'icône concernée sous la catégorie désirée, le formulaire de création apparaît :

[[Image:|center|Formulaire de création d’un thème d’articles]]

* Nom : nom du thème d'articles
* Catégorie de thèmes d'articles : définit la catégorie parente afin de préciser le niveau d'arborescence
* Description (via l'éditeur wysiwyg) : description du thème d'articles (visible pendant la navigation dans les articles)
* Langue : initialise la langue par défaut des articles, utile lorsqu'un filtre de langue est appliqué sur le site
* Patron d'affichage : optionnel. Indique la mise en forme utilisée pour l'affichage des articles
* Modèle d'articles : optionnel. Permet d'initialiser le contenu d'un article lors de sa création

Remarque : pour des raisons de mise en forme, l'éditeur wysiwyg ne permet pas le dépôt d'images dans la description d'un thème d'articles.

=== Préférences ===

Tous les articles sont rassemblés dans des thèmes. Les droits d'accès et les options de publication sont appliqués sur les thèmes : chaque article hérite donc des propriétés de son thème.

[[Image:|center|Préférences d’un thème d’articles]]

* Schéma d'approbation pour les articles : schéma utilisé pour modérer les nouveaux articles créés
* Schéma d'approbation pour les commentaires : schéma utilisé pour modérer les commentaires d'articles
* Schéma d'approbation pour la modification : schéma utilisé pour modérer les articles modifiés
* Approuver automatiquement le contributeur s'il fait partie de la première étape du schéma d'approbation : option applicable lors des modérations d'articles
* Les auteurs peuvent notifier les membres du groupe par email : envoie un mail à tous les utilisateurs ayant des droits de lecture sur le thème d'articles
* Les auteurs peuvent restreindre l'accès aux articles : les auteurs peuvent choisir les groupes d'utilisateurs pouvant voir les articles
* Permettre aux auteurs de proposer leur article pour les pages d'accueil : l'auteur propose son article, seul le gestionnaire peut décider d'afficher l'article en pages d'accueil
* Permettre aux auteurs de spécifier des dates de publication : permet de retarder la publication des articles
* Permettre aux auteurs de joindre des fichiers avec leurs articles : oui/non
* Permettre aux auteurs de modifier leurs articles : oui/non
* Permettre aux gestionnaires de modifier les articles : oui/non
* Nombre maximum d'articles sur la page des archives : lorsqu'un article est archivé, il n'est pas pour autant caché. Il se retrouve en nombre restreint avec les autres articles archivés.
* Utiliser les mots-clés du thésaurus : l'activation de cette option rendra obligatoire l'attribution d'au moins un mot-clé par article
* Permettre aux commentateurs de noter les articles: l'activation de cette option permet aux utilisateurs de noter l'article qu'ils commentent.
* Permettre aux auteurs d'associer une image à un article : Cette option autorise l'association d'une image à l'article. Cette image n'est visible qu'en étant récupérée en OvML.
* Sélection d'une image : permet de charger une image au format jpg, gif ou png qui sera associée au thème dans la présentation côté utilisateur. Cette image n'est visible qu'en étant récupérée en OvML.

Remarque : les schémas d'approbation sont créés par l'administrateur du site : lien Approbations en section d'Administration.

=== Droits d'accès ===

Les droits d'accès des articles s'appliquent sur leurs thèmes d'articles. Il existe 5 droits :

* Qui peut lire les articles de ce thème ? : lecteurs des articles
* Qui peut soumettre de nouveaux articles ? : auteurs des articles et des brouillons
* Qui peut soumettre des commentaires ? : lecteurs ayant des droits de commentaires sur les articles
* Qui peut modifier les articles ? : auteurs ayant des droits de modification sur les articles, ce statut ne donne pas droit à la création d'articles
* Qui peut gérer ce thème ? : gestionnaires. Ils ordonnent les articles, modifient les dates de publication, choisissent les articles d'archives, suppriment les articles...

[[Image:|center|ACL : formulaire de droits d’accès]]

=== Ordonner les thèmes ===

Le formulaire est constitué d'une liste ordonnée (à gauche) des thèmes d'articles d'un même niveau et de boutons (à droite) permettant de définir manuellement l'ordre d'affichage des thèmes.

Les deux flèches bleues permettent de monter ou de descendre un thème sélectionné dans la liste.

Les deux icônes du bas ordonnent les thèmes par ordre croissant ou décroissant sur leurs noms.

Remarque : l'ordre défini par l'administrateur a une incidence sur la navigation (sections, chemin de fer...) et sur la gestion (publication, gestion des articles...).

[[Image:|center|Formulaire pour ordonner les thèmes d’articles]]

=== Supprimer un thème ===

La suppression d'un thème d'articles entraînera la suppression de ses articles et de ses commentaires. La suppression n'est effective qu'après confirmation.

[[Image:|center|Suppression d’un thème d’articles]]

= Gestion =

Le gestionnaire d'un thème d'articles a accès à tous les articles du thème afin d'effectuer les opérations suivantes :

* Ordonner les articles
* Modifier les dates de publication et d'archivage
* Modifier le statut des articles : archivés, proposés en pages d'accueil, ...
* Déplacer les articles d'un thème à un autre
* Supprimer les articles

Le point d'entrée à ces options se situe en section Utilisateur : lien Gestion des articles.

Remarque : le gestionnaire n'a pas de droit de modification ou de création sur les articles, mais il peut visualiser les articles.

[[Image:|center|Section Utilisateur]]

[[Image:|center|Liste des thèmes d'articles gérés]]

== Supprimer un article ==

Seul le gestionnaire peut supprimer un article sur le site. Après sélection du thème d'articles dans l'arborescence (lien Gestion des articles en section Utilisateur), le gestionnaire doit sélectionner l'article (ou les articles) à supprimer via les cases à cocher en face des titres d'articles. L'interface permet une sélection multiple des articles. Le formulaire "Mettre à jour les éléments sélectionnés" permet d'effectuer l'opération de suppression sur tous les articles sélectionnés.

La suppression s'effectue après confirmation.

[[Image:|center|Suppression d’un article]]

== Ordonner les articles ==

Seul le gestionnaire peut ordonner les articles d'un thème (visible lors de la navigation dans les articles par les lecteurs). Après sélection du thème d'articles dans l'arborescence (lien Gestion des articles en section Utilisateur), l'onglet Ordre permet d'accéder au formulaire suivant :

[[Image:|center|Formulaire pour ordonner les articles d'un thème]]

Le formulaire est constitué d'une liste ordonnée (à gauche) des articles d'un même thème et de boutons (à droite) permettant de définir manuellement l'ordre d'affichage des articles.

Les deux flèches bleues permettent de monter ou de descendre un article sélectionné dans la liste.

Les deux icônes du bas ordonnent les articles par ordre croissant ou décroissant sur leurs noms.

Remarque :

* l'ordre défini par l'administrateur a une incidence sur la navigation (sections, chemin de fer...) et sur la gestion (publication, gestion des articles...).
* Si le gestionnaire ne modifie pas l'ordre des articles, les articles seront affichés par ordre de publication, l'article le plus récent en tête.

== Déplacer un article ==

Après sélection du thème d'articles dans l'arborescence (lien Gestion des articles en section Utilisateur), le gestionnaire doit afficher les propriétés de l'article pour accéder à son déplacement d'un thème à un autre : icône [[Image:]].

[[Image:|center|Liste des articles]]

Sur le formulaire des propriétés de l'article, l'entrée "thème d'articles" déroule la liste des thèmes sur lesquels le gestionnaire a accès. Le bouton "Mettre à jour" enregistre la modification et déplace l'article.

Remarque : le déplacement ne peut se faire que dans les thèmes d'articles que le gestionnaire gère.

[[Image:|center|Propriétés de l’article]]

== Archiver un article ==

Le gestionnaire peut décider d'archiver ou de désarchiver un article. Un article archivé est encore visible des lecteurs sur le site, cependant son affichage se situe dans une interface à part avec les autres articles archivés d'un même thème. Les articles archivés s'affichent en nombre limité : c'est l'administrateur qui définit le nombre d'articles affichés : les articles archivés les plus anciens ont donc peu de chances d'être vus des lecteurs.

Après sélection du thème d'articles dans l'arborescence (lien Gestion des articles en section Utilisateur), le gestionnaire doit sélectionner l'article (ou les articles) à archiver via les cases à cocher en face des titres d'articles. L'interface permet une sélection multiple des articles. Le formulaire "Mettre à jour les éléments sélectionnés" permet d'effectuer l'opération d'archivage sur tous les articles sélectionnés.

[[Image:|center|Archivage d'un article]]

Pour désarchiver un article et le rendre disponible à la lecture sur le site, le gestionnaire a accés à la liste des articles archivés : après sélection du thème d'articles dans l'arborescence (lien Gestion des articles en section Utilisateur), onglet "Archives".

[[Image:|center|Liste des articles archivés]]

== Autres options ==

Dans les propriétés d'un article (icône [[Image:]] après sélection du thème d'articles dans l'arborescence (lien Gestion des articles en section Utilisateur)), le gestionnaire a accès à plusieurs options selon ce qui a été défini par l'administrateur sur le thème d'articles :

* Date de publication : permet de retarder l'affichage de l'article sur le portail
* Date d'archivage : permet d'automatiser la mise en archive de l'article
* Restriction d'accès : permet de restreindre la lecture de l'article à des groupes d'utilisateurs

[[Image:|center|Propriétés de l’article]]

= Publication =

Les auteurs accèdent à la publication d'articles depuis le lien "Publication" en section Utilisateur. Un auteur peut avoir des droits de création et/ou de modification des articles. Chaque auteur pourra verrouiller un article et gérer un brouillon personnel avant de publier sa modification finale.

== Publier un article ==

Les auteurs accèdent à la publication d'articles depuis le lien "Publication" en section Utilisateur.

La publication passe par plusieurs étapes, les dernières étant optionnelles :

* Sélection du thème d'articles dans lequel l'article sera publié
* Rédaction de l'introduction et du corps de l'article
* Prévisualisation de l'article
* Préférences de publication : date de publication, date d'archivage, fichiers associés...

[[Image:]]

Ces étapes sont désormais (depuis la version 7.4) réunies en un seul écran.

Le lien "Publication" donne accès à la liste des brouillons de l'auteur. Le lien "Créer un nouvel article" lance l'édition.

Remarque : il est aussi possible de publier et de modifier un article en naviguant sur le site. Cette possibilité évite l'étape de sélection du thème.

[[Image:|center|Liste des brouillons d'un auteur]]

* Première étape :

L'auteur sélectionne le thème dans lequel sera créé le nouvel article grâce au menu déroulant. Pour un brouillon, il n'est pas nécessaire de choisir un thème.

[[Image:|center|Sélection du thème d’articles]]

* Deuxième étape :

L'auteur accède à la rédaction de l'article. Un article doit contenir un titre et une introduction. Le corps de l'article est optionnel. Par défaut, le bloc de rédaction est replié. Il faut cliquer sur le titre "Corps" pour que ce bloc s'affiche.

Le partage du contenu dans l'introduction et le corps a une incidence sur la navigation par les lecteurs. Il existe deux écrans principaux pour l'affichage des articles :

* liste des articles d'un thème
* corps de l'article

Lorsqu'un lecteur accède à un thème, il se retrouve avec la liste de tous ses articles et visualise leurs introductions. Si un article contient un corps, un lien "lire la suite" permettra d'accéder au corps de l'article.

L'auteur peut donc choisir de publier tout son article dans l'introduction afin de ne pas séparer le contenu en deux (introduction et corps). Cependant, il peut être intéressant d'utiliser le corps de l'article afin de ne pas surcharger la liste des articles dans le thème.

L'auteur choisira la langue de l'article. Ceci a un effet lors de l'application de filtres de langues sur le site.

[[Image:|center|Rédaction de l’article]]

== L'éditeur wysiwyg ==

L'introduction et le corps d'un article se rédigent grâce à un éditeur dit wysiwyg (What You See Is What You Get). Cet éditeur simplifie la mise en forme du contenu avec des fonctions de mise en gras, italique, alignement au centre, couleur de texte, ... L'objectif est de rédiger un contenu en langage html, le langage reconnu dans les navigateurs Web. L'éditeur simplifie donc la rédaction de l'article en rendant transparent l'édition du code html.

Fonctions :

[[Image:]] : police de caractères : Arial, Times New Roman, Verdana...

: taille de caractères en points (pt)

: style du texte : titre, paragraphe...

: alignement du texte : gauche, centré, droit, justifié

: création de listes à puces

: retrait gauche ou droit de lignes

: couleur du texte et du fond

: création d'un lien interne (renvoie sur la même page) ou externe (adresse Web externe) : le texte du lien doit être sélectionné préalablement : suppression d'un lien : création d'un tableau

: suppression de la mise en forme d'un texte sélectionné

: suppression des balises non désirées sur un texte provenant d'un éditeur externe

: passe en mode code source : édition en langage html

: passe l'édition en plein écran

: "copie" le texte sélectionné (quelques navigateurs n'acceptent pas cette opération)

: "coupe" le texte sélectionné

: "colle" le texte sélectionné

: annule ou répète la dernière action

: met en gras le texte sélectionné

: met en italique le texte sélectionné

: souligne le texte sélectionné

: barre le texte sélectionné

: met en indice le texte sélectionné (abaisse le texte) ; [[Image:]] met en exposant (élève le texte)

'': fonctions d'Ovidentia : voir description ci-dessous''

[[Image:|center|L’éditeur wysiwyg HTMLArea]]

Remarque : il est déconseillé de copier un texte dans l'éditeur wysiwyg provenant d'un éditeur de texte externe (Microsoft Word, OpenOffice, Works...) car certaines mises en formes peuvent être mal interprétées lors de l'affichage de l'article, les syntaxes de rédaction étant différentes. Il est préférable de passer par un texte intermédiaire en supprimant sa mise en forme.

Exemple :

Étape 1 : copie d'un texte mis en forme sur Microsoft Word

Étape 2 : le texte est "collé" dans un éditeur bas niveau tel que le bloc-notes sous Windows afin de supprimer sa mise en forme

Étape 3 : copie du texte placé dans le bloc-note

Étape 4 : le texte est "collé" dans l'éditeur wysiwyg puis mis en forme depuis l'éditeur wysiwyg

Fonctions d'Ovidentia :

[[Image:|center|Fonctions Ovidentia de l'éditeur wysiwyg]]

* Insérer une image : l'auteur peut ajouter une image provenant de son ordinateur

[[Image:]]

Le bouton Parcourir permet de sélectionner un fichier image provenant de son ordinateur.

Si l'option "partagé" est activée, l'image sera présente dans la bibliothèque et sera disponible pour tous les auteurs dans tous les thèmes d'articles. La bibliothèque est affichée en-dessous et peut contenir des répertoires. Avant de partager une image, le répertoire de destination doit être ouvert.

Alignement : définit l'affichage du texte par rapport à l'image. Un alignement à gauche affiche le texte sur le bord droit de l'image.

Alt : texte affiché lorsque l'image est inaccessible. Est aussi un renseignement sur la nature de l'image pour les malvoyants utilisant des lecteurs de pages Web.

Espacement horizontal : espace entre les bords gauche et droit de l'image

Espacement vertical : espace entre les bords haut et bas de l'image

Bordure : taille de la bordure en pixels

* Insérer des fichiers ou des répertoires du gestionnaire de fichiers
* Insérer un lien dynamique vers un article
* Insérer un lien vers une question/réponse d'une FAQ
* Insérer un fichier OVML : les fichiers OVML doivent être présents dans le dossier OVML du skin utilisé par le site. Si un dossier "editor" est présent dans le dossier OVML du skin, ce sont les fichiers présents dans ce dossier "editor" qui seront proposés.
* Insérer un lien vers un contact personnel
* Insérer un lien vers une fiche d'annuaire

== Options de publication ==

Après la rédaction de l'article, l'auteur accède aux options de publication.

* Thème d'articles : déplacement de l'article dans un autre thème
* Date de soumission : permet de retarder l'envoi de l'article à l'approbation, affecte aussi la publication
* Date de publication : permet de retarder l'affichage de l'article sur le site
* Date d'archivage : permet d'automatiser la mise en archive de l'article
* Proposer pour la page d'accueil publique : propose l'article pour la page d'accueil publique (accès anonyme). Seul le gestionnaire peut accepter l'article et l'afficher en pages d'accueil
* Proposer pour la page d'accueil privée : propose l'article pour la page d'accueil privée. Seul le gestionnaire peut accepter l'article et l'afficher en pages d'accueil
* Documents associés : permet d'ajouter des fichiers (pdf, doc, zip...) à l'article
* Notifier les utilisateurs une fois l'article publié : si activé, tous les utilisateurs ayant des droits de lecture recevront un mail de notification
* Restriction d'accès : permet de restreindre l'accès de l'article à des groupes d'utilisateurs

[[Image:|center|Quelques options de publication]]

== Attacher des fichiers à un article ==

Il existe deux méthodes pour associer des fichiers à un article. La première s'appuie sur le gestionnaire de fichiers, une autre fonction de publication d'Ovidentia. L'autre utilise la fonction présente dans les options de publication d'articles.

* Méthode 1 :

On désire lier un fichier à un article, cependant ce fichier sera utilisé dans plusieurs articles. Pour réduire l'espace disque utilisé par les multiples copies de fichiers, le fichier est placé dans le gestionnaire de fichiers.

Depuis l'éditeur wysiwyg, on utilisera l'icône [[Image:ovidentia-icone.png|Icone d'Ovidentia dans l'éditeur WYSIWYG]] pour faire un lien vers ce fichier dans l'article.

Cette méthode a d'autres avantages que le gain d'espace disque. Si le fichier est amené à évoluer, il peut changer de versions depuis le gestionnaire de fichiers : les articles seront directement liés à la dernière version du fichier. De plus, lorsqu'un fichier du gestionnaire de fichiers est lié à un article, son lien dans l'éditeur wysiwyg peut être placé n'importe où dans l'article (sur une image, entre 2 lignes...).

* Méthode 2 :

On souhaite associer un fichier à un article. Ce fichier sera uniquement accessible dans cet article et n'a pas d'intérêt à être visible depuis le gestionnaire de fichiers. On associe donc le fichier depuis les options de publication. Le formulaire de dépôt gère les dépôts multiples et l'ordre d'affichage des fichiers.

Remarque : les fichiers associés apparaîtront sous l'article pour les lecteurs. Contrairement à la méthode 1, les liens vers les fichiers ne peuvent pas être placés à l'intérieur du contenu de l'article.

[[Image:|center|Association des fichiers à un article]]

== Gérer un brouillon ==

Les auteurs peuvent gérer des brouillons lorsque le contenu n'est pas encore terminé. Un brouillon est personnel et n'est donc pas accessible aux autres auteurs. Il existe deux types de brouillons :

* le brouillon sur un nouvel article : dans ce cas, l'article n'est pas soumis à approbation ou n'est pas publié pendant la mise en brouillon.
* le brouillon sur un article modifié : dans ce cas, un article publié est en cours de modification par un auteur. Lorsque la modification est en brouillon, l'article dans son ancienne version reste affiché sur le site. Cependant, l'article est verrouillé par son auteur et ne pourra pas être édité par un autre auteur tant que la modification ne sera pas soumise.

Pour créer un brouillon d'un nouvel article ou d'un article modifié, il suffit de cliquer sur le bouton "Enregistrer un brouillon" lors de la rédaction de l'article.

[[Image:|center|Boutons lors de la rédaction d'un article]]

Le brouillon est accessible dans la liste des brouillons : lien Publication en section Utilisateur.

Pour soumettre un brouillon à la publication, l'auteur peut modifier l'article et suivre les étapes de publication et cliquer sur le bouton "Soumettre". L'auteur peut aussi soumettre l'article directement depuis la liste des brouillons via l'icône [[Image:]].

[[Image:|center|Liste des brouillons]]

= Navigation =

L'arborescence de publication gérée par l'administrateur met en évidence la navigation sur le site dans les articles.

Lors de l'intégration d'une charte graphique, le webmaster a recours à plusieurs méthodes pour afficher le contenu du site à ses lecteurs et peut proposer une navigation totalement différente de celle proposée par défaut dans Ovidentia. Les exemples ci-dessous proviennent de la navigation par défaut d'Ovidentia.

== Les sections ==

Les sections sont les principaux points d'entrée aux informations avec les pages d'accueil. Il existe deux types de sections dans les articles :

* la section de catégories de thèmes d'articles : elle présente la liste des catégories parentes. L'administrateur peut l'activer ou la désactiver depuis le lien "Sections" en section d'Administration.

[[Image:|center|Sections de catégories]]

* les sections de catégories : activées/désactivées par l'administrateur dans l'arborescence de publication, elles listent les thèmes d'articles présents dans une catégorie.

[[Image:|center|Section de catégorie]]

Remarque : l'administrateur peut ordonner l'affichage des sections depuis le lien "Sections" en section d'Administration.

== Navigation ==

Pendant la navigation dans les articles, les lecteurs s'orientent avec le chemin de fer (ou rail). Ce dernier s'appuie sur l'arborescence de publication :

[[Image:|center|Chemin de fer]]

Voici les écrans principaux affichés pendant la navigation dans les articles :

* Catégorie d'articles : liste des sous-catégories et thèmes d'articles d'une catégorie

[[Image:]]

Ici, la catégorie Actualités contient 3 thèmes d'articles : Sport, Politique et Economie.

* Thème d'articles : liste des articles d'un thème. Seules les introductions des articles sont affichées, le corps des articles est accessible via le lien "Lire la suite" sous les articles. L'auteur ainsi que la date de publication sont affichés. Pour les auteurs, il est possible de soumettre ou de modifier un article directement depuis un thème d'articles via les liens "Soumettre" et "Modifier".

[[Image:|center|Liste des articles d’un thème]]

* Articles archivés : les archives sont accessibles via l'onglet "Archives" présent sur chaque thème contenant des archives.

[[Image:]]

== Moteur de recherche ==

Les articles sont totalement intégrés dans le moteur de recherche d'Ovidentia. Pour une recherche avancée, indiquez au moteur la fonction Articles. Cette opération donne accès aux options de recherche :

* Thèmes d'articles : filtre le champ de recherche par thèmes d'articles
* Mots-clés du thésaurus : filtre les articles associés aux mots-clés renseignés. La saisie des mots-clés est simplifiée via une auto-suggestion. L'opérateur OU/ET précise si les articles recherchés doivent contenir tous les mots-clés (ET) ou au moins un mot-clé (OU).
* Auteur : filtre sur l'auteur des articles
* Après la date : filtre les articles publiés après la date renseignée
* Avant la date : filtre les articles publiés avant la date renseignée

[[Image:|center|Moteur de recherche]]

== Ajouter un commentaire ==

Si l'administrateur active les commentaires sur les thèmes d'articles, tous les utilisateurs ayant des droits de commenter verront s'afficher en-dessous de chaque article le lien "Commentaires".

Le lien "Commentaires" permet d'accéder à la liste des commentaires et à la création d'un commentaire.

Remarque : les commentaires peuvent être modérés.

[[Image:|center|Liste des commentaires]]

= Patrons d'affichage et modèles d'articles =

Les patrons d'affichage et les modèles d'articles sont des éléments accessibles au webmaster et permettent de personnaliser l'affichage ou la création des articles.

* Patrons d'affichage : ils permettent de personnaliser l'affichage final des articles ou des catégories
* Modèles d'articles : ils permettent d'initialiser le contenu de l'introduction et du corps des articles lors de leurs rédactions

L'application d'un patron ou d'un modèle s'effectue par l'administrateur dans l'arborescence de publication :

[[Image:]]

[[Image:]]

Création d'une catégorieCréation d'un thème d'articles

== Patrons d'affichage ==

Les patrons d'affichage permettent de personnaliser l'affichage final des articles, des catégories ou des sections.

Il existe trois types de patrons :

* les patrons d'affichage de catégories
* les patrons d'affichage de sections de catégories
* les patrons d'affichage de thèmes d'articles

Voici un exemple simple de personnalisation du patron d'affichage d'un thème d'articles :

Sur la gauche, on aperçoit l'affichage par défaut des articles dans un thème.

Sur la droite, le thème s'appuie sur un patron d'affichage créé par le webmaster : le webmaster a décidé de modifier l'apparence des titres d'articles, d'ajouter des liens internes redirigeant sur les titres d'articles et de supprimer l'affichage des auteurs et dates de publications.

[[Image:]] [[Image:]]

Réaliser un patron d'affichage :

Le webmaster doit avoir accès aux fichiers d'Ovidentia sur le serveur. Il doit commencer par copier le "template" concerné dans le skin du site. Le "template" est un fichier html présent dans la distribution (noyau Ovidentia ) et qui gère l'affichage d'éléments sur le site. Pour ajouter un patron d'affichage, il faut dupliquer le code présent dans ce fichier template.

Les fichiers templates concernés :

topcatsection.html : gère les patrons d'affichage des sections de catégories

topicsdisplay.html : gère le patron d'affichage des thèmes d'articles

topicssection.html : gère les patrons d'affichage des sections de thèmes

topcatdisplay.html : gère les patrons d'affichage des catégories

* Première étape : copier le fichier template présent dans le noyau dans le skin du site. Cette opération est nécessaire afin d'éviter de perdre toutes modifications lors de la mise à jour d'Ovidentia , les fichiers du noyau ne doivent pas être modifiés.

Répertoire des fichiers templates du noyau : racine d'Ovidentia/noyauXXX/skins/ovidentia/templates/

Répertoire des fichiers templates du skin : racine d'Ovidentia/skins/votreskin/templates/

* Deuxième étape : dupliquer le code présent dans le fichier afin de créer un nouveau patron. Chaque fichier contient une portion de code utilisée pour l'affichage d'éléments. La portion est délimitée par les syntaxes suivantes :

<source lang="html4strict">



</source>

Pour ajouter un nouveau patron d'affichage, il faut dupliquer le code compris entre les 2 lignes ci-dessus et nommer le patron de cette manière :

<source lang="html4strict">



</source>

* Troisième étape : personnaliser la portion de code dupliquée : modification de balises html, de styles, suppression d'éléments...

* Quatrième étape : affecter le patron d'affichage à l'élément désiré via l'arborescence de publication

Remarque :

Pour les patrons d'affichage de thèmes d'articles, il est nécessaire de dupliquer 2 portions de codes :

<source lang="html4strict">



</source>

et

<source lang="html4strict">



</source>

La première portion gère l'affichage des articles dans un thème (introductions des articles) et la deuxième gère l'affichage du corps d'un article.

== Modèles d'articles ==

Un modèle d'articles est un procédé qui permet d'initialiser l'introduction et le corps d'un article lors de sa rédaction. Le modèle n'impacte donc pas l'affichage final des articles, seulement sa rédaction.

Le procédé de création est le même que pour les patrons d'affichage (voir ci-dessus les 4 étapes de création), le fichier template concerné est articlestemplates.html.

Voici un exemple simple d'un modèle d'articles :

Lors de la rédaction d'un article, le contenu de l'introduction est pré-renseigné par un tableau.

[[Image:|center|Modèle d'articles]]

= Gestion des pages d'accueil =

Les pages d'accueil sont les points d'entrées principales sur un site, elles ne doivent pas être négligées. Elles contiennent généralement un message d'accueil ainsi que les dernières actualités. Il existe deux pages d'accueil sur Ovidentia :

* la page d'accueil publique : accessible aux utilisateurs anonymes
* la page d'accueil privée : accessible aux utilisateurs authentifiés

== L'OVML ==

Les pages d'accueil publique et privée d'Ovidentia peuvent être gérées par le langage OVML afin d'y afficher un contenu dynamique (derniers articles publiés, prochains événements...). Pour cela, il suffit de créer les fichiers public.html et private.html dans le skin du site sur le serveur. Lorsque ces fichiers sont présents dans le skin du site, ils remplacent l'affichage par défaut des pages d'accueil ; l'affichage par défaut étant la liste des articles proposés en pages d'accueil.

Répertoire des fichiers ovml du skin :

racine d'Ovidentia/skins/votreskin/ovml/

Voici 2 exemples de mise en forme des pages d'accueil par le langage OVML :

[[Image:]] [[Image:]]

Sur ces 2 captures d'écran, l'information remontée appartient à la gestion des articles.

== Proposer un article pour une page d'accueil ==

Les auteurs ont la possibilité de proposer leurs articles pour les pages d'accueil. Ce procédé permet d'afficher des articles tous thèmes confondus en pages d'accueil publique et privée.

Un gestionnaire des pages d'accueil (choisi par l'administrateur) accède à tous les articles proposés et décide de les afficher ou non en pages d'accueil.

* Options de publication :

Les auteurs peuvent proposer leurs articles en pages d'accueil depuis les options de publication (étape qui suit la rédaction et la prévisualisation de l'article), l'administrateur peut activer cette option dans les paramètres des thèmes.

[[Image:|center|Options de publication]]

* Gestionnaire des pages d'accueil :

L'administrateur définit les gestionnaires des pages d'accueil depuis les paramètres du site.

Le gestionnaire des pages d'accueil accède à la liste des articles proposés et peut à tout moment décider de les afficher ou de les retirer des pages d'accueil :

[[Image:|center|Gestion des articles proposés en pages d'accueil]]

Remarque :

L'affichage des articles est automatique dans le fonctionnement par défaut d'Ovidentia, cependant si le skin du site contient les fichiers private.html et public.html, les pages d'accueil sont alors gérées par le langage OVML. Dans ce cas, pour afficher les articles en pages d'accueil, le webmaster utilisera le container OVML nommé OCArticlesHomePages (voir la documentation sur le langage OVML pour plus de détails).

= Gestion de l'approbation =

L'administrateur peut définir un schéma d'approbation au niveau des options de thèmes d'articles. Les articles seront alors modérés au moment de leurs publications et/ou de leurs modifications : un ou plusieurs approbateurs devront accepter l'article avant sa publication.

Remarque :

Un message situé en bas de l'écran prévient l'auteur lorsque l'article est soumis à approbation avant sa publication.

== Schémas d'approbation ==

L'administrateur créé le schéma d'approbation depuis le lien Approbations en section d'Administration. Ce schéma pourra être choisi dans les options de thèmes d'articles et définit les personnes qui devront accepter les articles avant leurs publications sur le site.

[[Image:|center|Liste des schémas d’approbation]]

== Modérer un article ==

A la création ou à la modification d'un article soumis à approbation, l'approbateur est notifié par mail. Pour voir puis accepter ou refuser l'article, l'approbateur passe par le lien Approbations en section Utilisateur.

Remarque : le lien Approbations en section utilisateur n'apparaît qu'à condition que des éléments soient en attente d'approbation.

[[Image:|center|Liste des articles en attente]]

[[Image:|center|Réponse de l'approbateur]]

Articles

2013-06-19T15:00:35Z

Rodpec : /* Attacher des fichiers à un article */

La gestion des articles est le plus important système de publication d'informations dans Ovidentia. L'éditeur wysiwyg intégré permet une souplesse dans la mise en forme du contenu ainsi qu'une liaison avec des fonctions du portail comme les annuaires et le gestionnaire de fichiers. Plusieurs points d'entrée existent afin de faciliter l'accès aux informations : sections de catégories, moteur de recherche, ... Le langage OVML pourra aussi être utilisé par le webmaster afin, par exemple, d'illustrer en pages d'accueil les dernières publications.

On retrouve six acteurs dans la gestion des articles :

* l'administrateur : il est en charge de créer l'arborescence de publication et de définir les droits d'accès
* le gestionnaire d'articles : le seul à pouvoir supprimer un article, il gère aussi les processus d'archivages
* le publicateur : l'auteur des articles
* l'approbateur : il modère les articles avant leurs publications
* le gestionnaire des pages d'accueil : il définit les articles qui seront affichés en pages d'accueil
* le lecteur : dernier acteur, il peut ajouter des commentaires aux articles 

= Administration =

L'administrateur est en charge de créer l'arborescence de publication qui deviendra par défaut l'arborescence de navigation sur le site. L'arborescence est constituée de catégories et de thèmes, conteneurs des articles. Pour chaque thème d'articles, l'administrateur choisit ses préférences, active les publications, les points d'entrée sur le site (sections) et définit les acteurs concernés : gestionnaires, publicateurs et lecteurs.

== L'arborescence de publication ==

Lien ''Articles'' en section d'Administration.

L'arborescence de publication est composée de 2 entités : les catégories et les thèmes d'articles.

* Les catégories sont de simples conteneurs, elles précisent la nature de l'information qu'elles contiennent. Une catégorie peut faire partie d'une catégorie parente, on parlera alors de sous-catégorie. Il n'y a pas de limites quant au nombre d'imbrications. Une catégorie peut contenir des thèmes d'articles et des sous-catégories. Sur l'exemple ci-dessous, ''Actualités'' est une catégorie qui contient 3 thèmes d'articles : ''Sport'', ''Politique'' et ''Économie''.
* Les thèmes d'articles sont aussi des conteneurs et précisent aussi la nature de l'information qu'ils contiennent. Un thème d'articles fait obligatoirement partie d'une catégorie et contient des articles. Les droits d'accès et toutes les options de publication s'appliquent uniquement sur les thèmes d'articles (un article n'a pas d'options uniques, il hérite des options de son thème).
* Les articles font partie d'un thème. Ils ne sont pas visibles de l'administrateur du site.

[[Image:|center|Administration : arborescence de publication]]

== Catégories d'articles ==

Dans l'arborescence de publication, on reconnaîtra 5 icônes permettant de gérer les catégories (et sous-catégories) :

* [[Image:]] : Création d'une catégorie
* [[Image:]] : Suppression d'une catégorie
* [[Image:]] : Ordonne les catégories d'un même niveau
* [[Image:]] / [[Image:]] : Affiche ou cache la section de la catégorie
* [[Image:]] : Droits par défaut de la catégorie

Remarque : les sections font partie des points d'entrée possibles aux articles dans la navigation du portail. Il est possible d'activer une section pour chacune des catégories. Une section comporte des liens vers les thèmes et sous-catégories de la catégorie.

[[Image:|center|Gestion des catégories]]

=== Création d’une catégorie ===

Depuis l'arborescence de publication, après avoir cliqué sur l'icône concernée au niveau désiré, le formulaire de création apparaît :

[[Image:|center|Formulaire de création d’une catégorie]]

* Nom : nom de la catégorie
* Description : description de la catégorie (non affichée sur le portail mais peut être utilisée via le langage OVML)
* Section activée : affiche ou cache la section de la catégorie
* Patron de section : optionnel. Indique la mise en forme utilisée pour l'affichage de la section
* Patron d'affichage : optionnel. Indique la mise en forme utilisée pour l'affichage des thèmes d'articles et des sous-catégories
* Catégorie de sujet parent : définit la catégorie parente afin de préciser le niveau d'arborescence
* Sélection d'une image : permet de charger une image au format jpg, gif ou png qui sera associée à la catégorie dans la présentation côté utilisateur

=== Affecter des droits par défaut sur une catégorie ===

Les droits d'accès des articles peuvent s'appliquer sur les catégories afin d'être définis par défaut sur les thèmes d'articles contenus dans ces catégories. Il existe 5 droits :

* Qui peut lire les articles de ce thème ? : lecteurs des articles
* Qui peut soumettre de nouveaux articles ? : auteurs des articles et des brouillons
* Qui peut soumettre des commentaires ? : lecteurs ayant des droits de commentaires sur les articles
* Qui peut modifier les articles ? : auteurs ayant des droits de modification sur les articles, ce statut ne donne pas droit à la création d'articles
* Qui peut gérer ce thème ? : gestionnaires. Ils ordonnent les articles, modifient les dates de publication, choisissent les articles d'archives, suppriment les articles...

[[Image:|center|Affectation des droits par défaut]]

Après avoir cliqué sur le bouton "Enregistrer" (situé tout en bas de l'arbre de droits), l'administrateur doit déterminer sur quels objets vont s'appliquer les droits qu'il vient de définir.

[[Image:]]

En ne sélectionnant aucun objet, on n'affecte aucun thème, sous-catégorie, etc... existant. Les prochains thèmes et sous-catégories créés dans cette catégorie seront en revanche affectés.

=== Ordonner les catégories ===

Le formulaire est constitué d'une liste ordonnée (à gauche) des catégories d'un même niveau et de boutons (à droite) permettant de définir manuellement l'ordre d'affichage des catégories.

Les deux flèches bleues permettent de monter ou de descendre une catégorie sélectionnée dans la liste.

Les deux icônes du bas ordonnent les catégories par ordre croissant ou décroissant sur leurs noms.

Remarque : l'ordre définit par l'administrateur a une incidence sur la navigation (sections, chemin de fer...) et sur la gestion (publication, gestion des articles...).

[[Image:|center|Formulaire pour ordonner les catégories d’articles]]

=== Supprimer une catégorie ===

Il est nécessaire pour supprimer une catégorie d'avoir préalablement supprimé les thèmes d'articles et les sous-catégories qu'elles contient. La suppression n'est effective qu'après confirmation.

[[Image:|center|Suppression d’une catégorie]]

== Thèmes d'articles ==

Dans l'arborescence de publication, on reconnaîtra 3 icônes permettant de gérer les thèmes d'articles :

* [[Image:]] : Création d'un thème d'articles
* [[Image:]] : Suppression d'un thème d'articles
* [[Image:]] : Ordonne les thèmes d'articles d'un même niveau
* [[Image:]] : Droits d'accès sur un thème d'articles (lecteurs, publicateurs, gestionnaires...)

=== Création d’un thème ===

Depuis l'arborescence de publication, après avoir cliqué sur l'icône concernée sous la catégorie désirée, le formulaire de création apparaît :

[[Image:|center|Formulaire de création d’un thème d’articles]]

* Nom : nom du thème d'articles
* Catégorie de thèmes d'articles : définit la catégorie parente afin de préciser le niveau d'arborescence
* Description (via l'éditeur wysiwyg) : description du thème d'articles (visible pendant la navigation dans les articles)
* Langue : initialise la langue par défaut des articles, utile lorsqu'un filtre de langue est appliqué sur le site
* Patron d'affichage : optionnel. Indique la mise en forme utilisée pour l'affichage des articles
* Modèle d'articles : optionnel. Permet d'initialiser le contenu d'un article lors de sa création

Remarque : pour des raisons de mise en forme, l'éditeur wysiwyg ne permet pas le dépôt d'images dans la description d'un thème d'articles.

=== Préférences ===

Tous les articles sont rassemblés dans des thèmes. Les droits d'accès et les options de publication sont appliqués sur les thèmes : chaque article hérite donc des propriétés de son thème.

[[Image:|center|Préférences d’un thème d’articles]]

* Schéma d'approbation pour les articles : schéma utilisé pour modérer les nouveaux articles créés
* Schéma d'approbation pour les commentaires : schéma utilisé pour modérer les commentaires d'articles
* Schéma d'approbation pour la modification : schéma utilisé pour modérer les articles modifiés
* Approuver automatiquement le contributeur s'il fait partie de la première étape du schéma d'approbation : option applicable lors des modérations d'articles
* Les auteurs peuvent notifier les membres du groupe par email : envoie un mail à tous les utilisateurs ayant des droits de lecture sur le thème d'articles
* Les auteurs peuvent restreindre l'accès aux articles : les auteurs peuvent choisir les groupes d'utilisateurs pouvant voir les articles
* Permettre aux auteurs de proposer leur article pour les pages d'accueil : l'auteur propose son article, seul le gestionnaire peut décider d'afficher l'article en pages d'accueil
* Permettre aux auteurs de spécifier des dates de publication : permet de retarder la publication des articles
* Permettre aux auteurs de joindre des fichiers avec leurs articles : oui/non
* Permettre aux auteurs de modifier leurs articles : oui/non
* Permettre aux gestionnaires de modifier les articles : oui/non
* Nombre maximum d'articles sur la page des archives : lorsqu'un article est archivé, il n'est pas pour autant caché. Il se retrouve en nombre restreint avec les autres articles archivés.
* Utiliser les mots-clés du thésaurus : l'activation de cette option rendra obligatoire l'attribution d'au moins un mot-clé par article
* Permettre aux commentateurs de noter les articles: l'activation de cette option permet aux utilisateurs de noter l'article qu'ils commentent.
* Permettre aux auteurs d'associer une image à un article : Cette option autorise l'association d'une image à l'article. Cette image n'est visible qu'en étant récupérée en OvML.
* Sélection d'une image : permet de charger une image au format jpg, gif ou png qui sera associée au thème dans la présentation côté utilisateur. Cette image n'est visible qu'en étant récupérée en OvML.

Remarque : les schémas d'approbation sont créés par l'administrateur du site : lien Approbations en section d'Administration.

=== Droits d'accès ===

Les droits d'accès des articles s'appliquent sur leurs thèmes d'articles. Il existe 5 droits :

* Qui peut lire les articles de ce thème ? : lecteurs des articles
* Qui peut soumettre de nouveaux articles ? : auteurs des articles et des brouillons
* Qui peut soumettre des commentaires ? : lecteurs ayant des droits de commentaires sur les articles
* Qui peut modifier les articles ? : auteurs ayant des droits de modification sur les articles, ce statut ne donne pas droit à la création d'articles
* Qui peut gérer ce thème ? : gestionnaires. Ils ordonnent les articles, modifient les dates de publication, choisissent les articles d'archives, suppriment les articles...

[[Image:|center|ACL : formulaire de droits d’accès]]

=== Ordonner les thèmes ===

Le formulaire est constitué d'une liste ordonnée (à gauche) des thèmes d'articles d'un même niveau et de boutons (à droite) permettant de définir manuellement l'ordre d'affichage des thèmes.

Les deux flèches bleues permettent de monter ou de descendre un thème sélectionné dans la liste.

Les deux icônes du bas ordonnent les thèmes par ordre croissant ou décroissant sur leurs noms.

Remarque : l'ordre défini par l'administrateur a une incidence sur la navigation (sections, chemin de fer...) et sur la gestion (publication, gestion des articles...).

[[Image:|center|Formulaire pour ordonner les thèmes d’articles]]

=== Supprimer un thème ===

La suppression d'un thème d'articles entraînera la suppression de ses articles et de ses commentaires. La suppression n'est effective qu'après confirmation.

[[Image:|center|Suppression d’un thème d’articles]]

= Gestion =

Le gestionnaire d'un thème d'articles a accès à tous les articles du thème afin d'effectuer les opérations suivantes :

* Ordonner les articles
* Modifier les dates de publication et d'archivage
* Modifier le statut des articles : archivés, proposés en pages d'accueil, ...
* Déplacer les articles d'un thème à un autre
* Supprimer les articles

Le point d'entrée à ces options se situe en section Utilisateur : lien Gestion des articles.

Remarque : le gestionnaire n'a pas de droit de modification ou de création sur les articles, mais il peut visualiser les articles.

[[Image:|center|Section Utilisateur]]

[[Image:|center|Liste des thèmes d'articles gérés]]

== Supprimer un article ==

Seul le gestionnaire peut supprimer un article sur le site. Après sélection du thème d'articles dans l'arborescence (lien Gestion des articles en section Utilisateur), le gestionnaire doit sélectionner l'article (ou les articles) à supprimer via les cases à cocher en face des titres d'articles. L'interface permet une sélection multiple des articles. Le formulaire "Mettre à jour les éléments sélectionnés" permet d'effectuer l'opération de suppression sur tous les articles sélectionnés.

La suppression s'effectue après confirmation.

[[Image:|center|Suppression d’un article]]

== Ordonner les articles ==

Seul le gestionnaire peut ordonner les articles d'un thème (visible lors de la navigation dans les articles par les lecteurs). Après sélection du thème d'articles dans l'arborescence (lien Gestion des articles en section Utilisateur), l'onglet Ordre permet d'accéder au formulaire suivant :

[[Image:|center|Formulaire pour ordonner les articles d'un thème]]

Le formulaire est constitué d'une liste ordonnée (à gauche) des articles d'un même thème et de boutons (à droite) permettant de définir manuellement l'ordre d'affichage des articles.

Les deux flèches bleues permettent de monter ou de descendre un article sélectionné dans la liste.

Les deux icônes du bas ordonnent les articles par ordre croissant ou décroissant sur leurs noms.

Remarque :

* l'ordre défini par l'administrateur a une incidence sur la navigation (sections, chemin de fer...) et sur la gestion (publication, gestion des articles...).
* Si le gestionnaire ne modifie pas l'ordre des articles, les articles seront affichés par ordre de publication, l'article le plus récent en tête.

== Déplacer un article ==

Après sélection du thème d'articles dans l'arborescence (lien Gestion des articles en section Utilisateur), le gestionnaire doit afficher les propriétés de l'article pour accéder à son déplacement d'un thème à un autre : icône [[Image:]].

[[Image:|center|Liste des articles]]

Sur le formulaire des propriétés de l'article, l'entrée "thème d'articles" déroule la liste des thèmes sur lesquels le gestionnaire a accès. Le bouton "Mettre à jour" enregistre la modification et déplace l'article.

Remarque : le déplacement ne peut se faire que dans les thèmes d'articles que le gestionnaire gère.

[[Image:|center|Propriétés de l’article]]

== Archiver un article ==

Le gestionnaire peut décider d'archiver ou de désarchiver un article. Un article archivé est encore visible des lecteurs sur le site, cependant son affichage se situe dans une interface à part avec les autres articles archivés d'un même thème. Les articles archivés s'affichent en nombre limité : c'est l'administrateur qui définit le nombre d'articles affichés : les articles archivés les plus anciens ont donc peu de chances d'être vus des lecteurs.

Après sélection du thème d'articles dans l'arborescence (lien Gestion des articles en section Utilisateur), le gestionnaire doit sélectionner l'article (ou les articles) à archiver via les cases à cocher en face des titres d'articles. L'interface permet une sélection multiple des articles. Le formulaire "Mettre à jour les éléments sélectionnés" permet d'effectuer l'opération d'archivage sur tous les articles sélectionnés.

[[Image:|center|Archivage d'un article]]

Pour désarchiver un article et le rendre disponible à la lecture sur le site, le gestionnaire a accés à la liste des articles archivés : après sélection du thème d'articles dans l'arborescence (lien Gestion des articles en section Utilisateur), onglet "Archives".

[[Image:|center|Liste des articles archivés]]

== Autres options ==

Dans les propriétés d'un article (icône [[Image:]] après sélection du thème d'articles dans l'arborescence (lien Gestion des articles en section Utilisateur)), le gestionnaire a accès à plusieurs options selon ce qui a été défini par l'administrateur sur le thème d'articles :

* Date de publication : permet de retarder l'affichage de l'article sur le portail
* Date d'archivage : permet d'automatiser la mise en archive de l'article
* Restriction d'accès : permet de restreindre la lecture de l'article à des groupes d'utilisateurs

[[Image:|center|Propriétés de l’article]]

= Publication =

Les auteurs accèdent à la publication d'articles depuis le lien "Publication" en section Utilisateur. Un auteur peut avoir des droits de création et/ou de modification des articles. Chaque auteur pourra verrouiller un article et gérer un brouillon personnel avant de publier sa modification finale.

== Publier un article ==

Les auteurs accèdent à la publication d'articles depuis le lien "Publication" en section Utilisateur.

La publication passe par plusieurs étapes, les dernières étant optionnelles :

* Sélection du thème d'articles dans lequel l'article sera publié
* Rédaction de l'introduction et du corps de l'article
* Prévisualisation de l'article
* Préférences de publication : date de publication, date d'archivage, fichiers associés...

[[Image:]]

Ces étapes sont désormais (depuis la version 7.4) réunies en un seul écran.

Le lien "Publication" donne accès à la liste des brouillons de l'auteur. Le lien "Créer un nouvel article" lance l'édition.

Remarque : il est aussi possible de publier et de modifier un article en naviguant sur le site. Cette possibilité évite l'étape de sélection du thème.

[[Image:|center|Liste des brouillons d'un auteur]]

* Première étape :

L'auteur sélectionne le thème dans lequel sera créé le nouvel article grâce au menu déroulant. Pour un brouillon, il n'est pas nécessaire de choisir un thème.

[[Image:|center|Sélection du thème d’articles]]

* Deuxième étape :

L'auteur accède à la rédaction de l'article. Un article doit contenir un titre et une introduction. Le corps de l'article est optionnel. Par défaut, le bloc de rédaction est replié. Il faut cliquer sur le titre "Corps" pour que ce bloc s'affiche.

Le partage du contenu dans l'introduction et le corps a une incidence sur la navigation par les lecteurs. Il existe deux écrans principaux pour l'affichage des articles :

* liste des articles d'un thème
* corps de l'article

Lorsqu'un lecteur accède à un thème, il se retrouve avec la liste de tous ses articles et visualise leurs introductions. Si un article contient un corps, un lien "lire la suite" permettra d'accéder au corps de l'article.

L'auteur peut donc choisir de publier tout son article dans l'introduction afin de ne pas séparer le contenu en deux (introduction et corps). Cependant, il peut être intéressant d'utiliser le corps de l'article afin de ne pas surcharger la liste des articles dans le thème.

L'auteur choisira la langue de l'article. Ceci a un effet lors de l'application de filtres de langues sur le site.

[[Image:|center|Rédaction de l’article]]

== L'éditeur wysiwyg ==

L'introduction et le corps d'un article se rédigent grâce à un éditeur dit wysiwyg (What You See Is What You Get). Cet éditeur simplifie la mise en forme du contenu avec des fonctions de mise en gras, italique, alignement au centre, couleur de texte, ... L'objectif est de rédiger un contenu en langage html, le langage reconnu dans les navigateurs Web. L'éditeur simplifie donc la rédaction de l'article en rendant transparent l'édition du code html.

Fonctions :

[[Image:]] : police de caractères : Arial, Times New Roman, Verdana...

: taille de caractères en points (pt)

: style du texte : titre, paragraphe...

: alignement du texte : gauche, centré, droit, justifié

: création de listes à puces

: retrait gauche ou droit de lignes

: couleur du texte et du fond

: création d'un lien interne (renvoie sur la même page) ou externe (adresse Web externe) : le texte du lien doit être sélectionné préalablement : suppression d'un lien : création d'un tableau

: suppression de la mise en forme d'un texte sélectionné

: suppression des balises non désirées sur un texte provenant d'un éditeur externe

: passe en mode code source : édition en langage html

: passe l'édition en plein écran

: "copie" le texte sélectionné (quelques navigateurs n'acceptent pas cette opération)

: "coupe" le texte sélectionné

: "colle" le texte sélectionné

: annule ou répète la dernière action

: met en gras le texte sélectionné

: met en italique le texte sélectionné

: souligne le texte sélectionné

: barre le texte sélectionné

: met en indice le texte sélectionné (abaisse le texte) ; [[Image:]] met en exposant (élève le texte)

'': fonctions d'Ovidentia : voir description ci-dessous''

[[Image:|center|L’éditeur wysiwyg HTMLArea]]

Remarque : il est déconseillé de copier un texte dans l'éditeur wysiwyg provenant d'un éditeur de texte externe (Microsoft Word, OpenOffice, Works...) car certaines mises en formes peuvent être mal interprétées lors de l'affichage de l'article, les syntaxes de rédaction étant différentes. Il est préférable de passer par un texte intermédiaire en supprimant sa mise en forme.

Exemple :

Étape 1 : copie d'un texte mis en forme sur Microsoft Word

Étape 2 : le texte est "collé" dans un éditeur bas niveau tel que le bloc-notes sous Windows afin de supprimer sa mise en forme

Étape 3 : copie du texte placé dans le bloc-note

Étape 4 : le texte est "collé" dans l'éditeur wysiwyg puis mis en forme depuis l'éditeur wysiwyg

Fonctions d'Ovidentia :

[[Image:|center|Fonctions Ovidentia de l'éditeur wysiwyg]]

* Insérer une image : l'auteur peut ajouter une image provenant de son ordinateur

[[Image:]]

Le bouton Parcourir permet de sélectionner un fichier image provenant de son ordinateur.

Si l'option "partagé" est activée, l'image sera présente dans la bibliothèque et sera disponible pour tous les auteurs dans tous les thèmes d'articles. La bibliothèque est affichée en-dessous et peut contenir des répertoires. Avant de partager une image, le répertoire de destination doit être ouvert.

Alignement : définit l'affichage du texte par rapport à l'image. Un alignement à gauche affiche le texte sur le bord droit de l'image.

Alt : texte affiché lorsque l'image est inaccessible. Est aussi un renseignement sur la nature de l'image pour les malvoyants utilisant des lecteurs de pages Web.

Espacement horizontal : espace entre les bords gauche et droit de l'image

Espacement vertical : espace entre les bords haut et bas de l'image

Bordure : taille de la bordure en pixels

* Insérer des fichiers ou des répertoires du gestionnaire de fichiers
* Insérer un lien dynamique vers un article
* Insérer un lien vers une question/réponse d'une FAQ
* Insérer un fichier OVML : les fichiers OVML doivent être présents dans le dossier OVML du skin utilisé par le site. Si un dossier "editor" est présent dans le dossier OVML du skin, ce sont les fichiers présents dans ce dossier "editor" qui seront proposés.
* Insérer un lien vers un contact personnel
* Insérer un lien vers une fiche d'annuaire

== Options de publication ==

Après la rédaction de l'article, l'auteur accède aux options de publication.

* Thème d'articles : déplacement de l'article dans un autre thème
* Date de soumission : permet de retarder l'envoi de l'article à l'approbation, affecte aussi la publication
* Date de publication : permet de retarder l'affichage de l'article sur le site
* Date d'archivage : permet d'automatiser la mise en archive de l'article
* Proposer pour la page d'accueil publique : propose l'article pour la page d'accueil publique (accès anonyme). Seul le gestionnaire peut accepter l'article et l'afficher en pages d'accueil
* Proposer pour la page d'accueil privée : propose l'article pour la page d'accueil privée. Seul le gestionnaire peut accepter l'article et l'afficher en pages d'accueil
* Documents associés : permet d'ajouter des fichiers (pdf, doc, zip...) à l'article
* Notifier les utilisateurs une fois l'article publié : si activé, tous les utilisateurs ayant des droits de lecture recevront un mail de notification
* Restriction d'accès : permet de restreindre l'accès de l'article à des groupes d'utilisateurs

[[Image:|center|Quelques options de publication]]

== Attacher des fichiers à un article ==

Il existe deux méthodes pour associer des fichiers à un article. La première s'appuie sur le gestionnaire de fichiers, une autre fonction de publication d'Ovidentia. L'autre utilise la fonction présente dans les options de publication d'articles.

* Méthode 1 :

On désire lier un fichier à un article, cependant ce fichier sera utilisé dans plusieurs articles. Pour réduire l'espace disque utilisé par les multiples copies de fichiers, le fichier est placé dans le gestionnaire de fichiers.

Depuis l'éditeur wysiwyg, on utilisera l'icône [[Image:ovidentia-icone|Icone d'Ovidentia dans l'éditeur WYSIWYG]] pour faire un lien vers ce fichier dans l'article.

Cette méthode a d'autres avantages que le gain d'espace disque. Si le fichier est amené à évoluer, il peut changer de versions depuis le gestionnaire de fichiers : les articles seront directement liés à la dernière version du fichier. De plus, lorsqu'un fichier du gestionnaire de fichiers est lié à un article, son lien dans l'éditeur wysiwyg peut être placé n'importe où dans l'article (sur une image, entre 2 lignes...).

* Méthode 2 :

On souhaite associer un fichier à un article. Ce fichier sera uniquement accessible dans cet article et n'a pas d'intérêt à être visible depuis le gestionnaire de fichiers. On associe donc le fichier depuis les options de publication. Le formulaire de dépôt gère les dépôts multiples et l'ordre d'affichage des fichiers.

Remarque : les fichiers associés apparaîtront sous l'article pour les lecteurs. Contrairement à la méthode 1, les liens vers les fichiers ne peuvent pas être placés à l'intérieur du contenu de l'article.

[[Image:|center|Association des fichiers à un article]]

== Gérer un brouillon ==

Les auteurs peuvent gérer des brouillons lorsque le contenu n'est pas encore terminé. Un brouillon est personnel et n'est donc pas accessible aux autres auteurs. Il existe deux types de brouillons :

* le brouillon sur un nouvel article : dans ce cas, l'article n'est pas soumis à approbation ou n'est pas publié pendant la mise en brouillon.
* le brouillon sur un article modifié : dans ce cas, un article publié est en cours de modification par un auteur. Lorsque la modification est en brouillon, l'article dans son ancienne version reste affiché sur le site. Cependant, l'article est verrouillé par son auteur et ne pourra pas être édité par un autre auteur tant que la modification ne sera pas soumise.

Pour créer un brouillon d'un nouvel article ou d'un article modifié, il suffit de cliquer sur le bouton "Enregistrer un brouillon" lors de la rédaction de l'article.

[[Image:|center|Boutons lors de la rédaction d'un article]]

Le brouillon est accessible dans la liste des brouillons : lien Publication en section Utilisateur.

Pour soumettre un brouillon à la publication, l'auteur peut modifier l'article et suivre les étapes de publication et cliquer sur le bouton "Soumettre". L'auteur peut aussi soumettre l'article directement depuis la liste des brouillons via l'icône [[Image:]].

[[Image:|center|Liste des brouillons]]

= Navigation =

L'arborescence de publication gérée par l'administrateur met en évidence la navigation sur le site dans les articles.

Lors de l'intégration d'une charte graphique, le webmaster a recours à plusieurs méthodes pour afficher le contenu du site à ses lecteurs et peut proposer une navigation totalement différente de celle proposée par défaut dans Ovidentia. Les exemples ci-dessous proviennent de la navigation par défaut d'Ovidentia.

== Les sections ==

Les sections sont les principaux points d'entrée aux informations avec les pages d'accueil. Il existe deux types de sections dans les articles :

* la section de catégories de thèmes d'articles : elle présente la liste des catégories parentes. L'administrateur peut l'activer ou la désactiver depuis le lien "Sections" en section d'Administration.

[[Image:|center|Sections de catégories]]

* les sections de catégories : activées/désactivées par l'administrateur dans l'arborescence de publication, elles listent les thèmes d'articles présents dans une catégorie.

[[Image:|center|Section de catégorie]]

Remarque : l'administrateur peut ordonner l'affichage des sections depuis le lien "Sections" en section d'Administration.

== Navigation ==

Pendant la navigation dans les articles, les lecteurs s'orientent avec le chemin de fer (ou rail). Ce dernier s'appuie sur l'arborescence de publication :

[[Image:|center|Chemin de fer]]

Voici les écrans principaux affichés pendant la navigation dans les articles :

* Catégorie d'articles : liste des sous-catégories et thèmes d'articles d'une catégorie

[[Image:]]

Ici, la catégorie Actualités contient 3 thèmes d'articles : Sport, Politique et Economie.

* Thème d'articles : liste des articles d'un thème. Seules les introductions des articles sont affichées, le corps des articles est accessible via le lien "Lire la suite" sous les articles. L'auteur ainsi que la date de publication sont affichés. Pour les auteurs, il est possible de soumettre ou de modifier un article directement depuis un thème d'articles via les liens "Soumettre" et "Modifier".

[[Image:|center|Liste des articles d’un thème]]

* Articles archivés : les archives sont accessibles via l'onglet "Archives" présent sur chaque thème contenant des archives.

[[Image:]]

== Moteur de recherche ==

Les articles sont totalement intégrés dans le moteur de recherche d'Ovidentia. Pour une recherche avancée, indiquez au moteur la fonction Articles. Cette opération donne accès aux options de recherche :

* Thèmes d'articles : filtre le champ de recherche par thèmes d'articles
* Mots-clés du thésaurus : filtre les articles associés aux mots-clés renseignés. La saisie des mots-clés est simplifiée via une auto-suggestion. L'opérateur OU/ET précise si les articles recherchés doivent contenir tous les mots-clés (ET) ou au moins un mot-clé (OU).
* Auteur : filtre sur l'auteur des articles
* Après la date : filtre les articles publiés après la date renseignée
* Avant la date : filtre les articles publiés avant la date renseignée

[[Image:|center|Moteur de recherche]]

== Ajouter un commentaire ==

Si l'administrateur active les commentaires sur les thèmes d'articles, tous les utilisateurs ayant des droits de commenter verront s'afficher en-dessous de chaque article le lien "Commentaires".

Le lien "Commentaires" permet d'accéder à la liste des commentaires et à la création d'un commentaire.

Remarque : les commentaires peuvent être modérés.

[[Image:|center|Liste des commentaires]]

= Patrons d'affichage et modèles d'articles =

Les patrons d'affichage et les modèles d'articles sont des éléments accessibles au webmaster et permettent de personnaliser l'affichage ou la création des articles.

* Patrons d'affichage : ils permettent de personnaliser l'affichage final des articles ou des catégories
* Modèles d'articles : ils permettent d'initialiser le contenu de l'introduction et du corps des articles lors de leurs rédactions

L'application d'un patron ou d'un modèle s'effectue par l'administrateur dans l'arborescence de publication :

[[Image:]]

[[Image:]]

Création d'une catégorieCréation d'un thème d'articles

== Patrons d'affichage ==

Les patrons d'affichage permettent de personnaliser l'affichage final des articles, des catégories ou des sections.

Il existe trois types de patrons :

* les patrons d'affichage de catégories
* les patrons d'affichage de sections de catégories
* les patrons d'affichage de thèmes d'articles

Voici un exemple simple de personnalisation du patron d'affichage d'un thème d'articles :

Sur la gauche, on aperçoit l'affichage par défaut des articles dans un thème.

Sur la droite, le thème s'appuie sur un patron d'affichage créé par le webmaster : le webmaster a décidé de modifier l'apparence des titres d'articles, d'ajouter des liens internes redirigeant sur les titres d'articles et de supprimer l'affichage des auteurs et dates de publications.

[[Image:]] [[Image:]]

Réaliser un patron d'affichage :

Le webmaster doit avoir accès aux fichiers d'Ovidentia sur le serveur. Il doit commencer par copier le "template" concerné dans le skin du site. Le "template" est un fichier html présent dans la distribution (noyau Ovidentia ) et qui gère l'affichage d'éléments sur le site. Pour ajouter un patron d'affichage, il faut dupliquer le code présent dans ce fichier template.

Les fichiers templates concernés :

topcatsection.html : gère les patrons d'affichage des sections de catégories

topicsdisplay.html : gère le patron d'affichage des thèmes d'articles

topicssection.html : gère les patrons d'affichage des sections de thèmes

topcatdisplay.html : gère les patrons d'affichage des catégories

* Première étape : copier le fichier template présent dans le noyau dans le skin du site. Cette opération est nécessaire afin d'éviter de perdre toutes modifications lors de la mise à jour d'Ovidentia , les fichiers du noyau ne doivent pas être modifiés.

Répertoire des fichiers templates du noyau : racine d'Ovidentia/noyauXXX/skins/ovidentia/templates/

Répertoire des fichiers templates du skin : racine d'Ovidentia/skins/votreskin/templates/

* Deuxième étape : dupliquer le code présent dans le fichier afin de créer un nouveau patron. Chaque fichier contient une portion de code utilisée pour l'affichage d'éléments. La portion est délimitée par les syntaxes suivantes :

<source lang="html4strict">



</source>

Pour ajouter un nouveau patron d'affichage, il faut dupliquer le code compris entre les 2 lignes ci-dessus et nommer le patron de cette manière :

<source lang="html4strict">



</source>

* Troisième étape : personnaliser la portion de code dupliquée : modification de balises html, de styles, suppression d'éléments...

* Quatrième étape : affecter le patron d'affichage à l'élément désiré via l'arborescence de publication

Remarque :

Pour les patrons d'affichage de thèmes d'articles, il est nécessaire de dupliquer 2 portions de codes :

<source lang="html4strict">



</source>

et

<source lang="html4strict">



</source>

La première portion gère l'affichage des articles dans un thème (introductions des articles) et la deuxième gère l'affichage du corps d'un article.

== Modèles d'articles ==

Un modèle d'articles est un procédé qui permet d'initialiser l'introduction et le corps d'un article lors de sa rédaction. Le modèle n'impacte donc pas l'affichage final des articles, seulement sa rédaction.

Le procédé de création est le même que pour les patrons d'affichage (voir ci-dessus les 4 étapes de création), le fichier template concerné est articlestemplates.html.

Voici un exemple simple d'un modèle d'articles :

Lors de la rédaction d'un article, le contenu de l'introduction est pré-renseigné par un tableau.

[[Image:|center|Modèle d'articles]]

= Gestion des pages d'accueil =

Les pages d'accueil sont les points d'entrées principales sur un site, elles ne doivent pas être négligées. Elles contiennent généralement un message d'accueil ainsi que les dernières actualités. Il existe deux pages d'accueil sur Ovidentia :

* la page d'accueil publique : accessible aux utilisateurs anonymes
* la page d'accueil privée : accessible aux utilisateurs authentifiés

== L'OVML ==

Les pages d'accueil publique et privée d'Ovidentia peuvent être gérées par le langage OVML afin d'y afficher un contenu dynamique (derniers articles publiés, prochains événements...). Pour cela, il suffit de créer les fichiers public.html et private.html dans le skin du site sur le serveur. Lorsque ces fichiers sont présents dans le skin du site, ils remplacent l'affichage par défaut des pages d'accueil ; l'affichage par défaut étant la liste des articles proposés en pages d'accueil.

Répertoire des fichiers ovml du skin :

racine d'Ovidentia/skins/votreskin/ovml/

Voici 2 exemples de mise en forme des pages d'accueil par le langage OVML :

[[Image:]] [[Image:]]

Sur ces 2 captures d'écran, l'information remontée appartient à la gestion des articles.

== Proposer un article pour une page d'accueil ==

Les auteurs ont la possibilité de proposer leurs articles pour les pages d'accueil. Ce procédé permet d'afficher des articles tous thèmes confondus en pages d'accueil publique et privée.

Un gestionnaire des pages d'accueil (choisi par l'administrateur) accède à tous les articles proposés et décide de les afficher ou non en pages d'accueil.

* Options de publication :

Les auteurs peuvent proposer leurs articles en pages d'accueil depuis les options de publication (étape qui suit la rédaction et la prévisualisation de l'article), l'administrateur peut activer cette option dans les paramètres des thèmes.

[[Image:|center|Options de publication]]

* Gestionnaire des pages d'accueil :

L'administrateur définit les gestionnaires des pages d'accueil depuis les paramètres du site.

Le gestionnaire des pages d'accueil accède à la liste des articles proposés et peut à tout moment décider de les afficher ou de les retirer des pages d'accueil :

[[Image:|center|Gestion des articles proposés en pages d'accueil]]

Remarque :

L'affichage des articles est automatique dans le fonctionnement par défaut d'Ovidentia, cependant si le skin du site contient les fichiers private.html et public.html, les pages d'accueil sont alors gérées par le langage OVML. Dans ce cas, pour afficher les articles en pages d'accueil, le webmaster utilisera le container OVML nommé OCArticlesHomePages (voir la documentation sur le langage OVML pour plus de détails).

= Gestion de l'approbation =

L'administrateur peut définir un schéma d'approbation au niveau des options de thèmes d'articles. Les articles seront alors modérés au moment de leurs publications et/ou de leurs modifications : un ou plusieurs approbateurs devront accepter l'article avant sa publication.

Remarque :

Un message situé en bas de l'écran prévient l'auteur lorsque l'article est soumis à approbation avant sa publication.

== Schémas d'approbation ==

L'administrateur créé le schéma d'approbation depuis le lien Approbations en section d'Administration. Ce schéma pourra être choisi dans les options de thèmes d'articles et définit les personnes qui devront accepter les articles avant leurs publications sur le site.

[[Image:|center|Liste des schémas d’approbation]]

== Modérer un article ==

A la création ou à la modification d'un article soumis à approbation, l'approbateur est notifié par mail. Pour voir puis accepter ou refuser l'article, l'approbateur passe par le lien Approbations en section Utilisateur.

Remarque : le lien Approbations en section utilisateur n'apparaît qu'à condition que des éléments soient en attente d'approbation.

[[Image:|center|Liste des articles en attente]]

[[Image:|center|Réponse de l'approbateur]]

Articles

2013-06-19T13:46:04Z

Rodpec :

La gestion des articles est le plus important système de publication d'informations dans Ovidentia. L'éditeur wysiwyg intégré permet une souplesse dans la mise en forme du contenu ainsi qu'une liaison avec des fonctions du portail comme les annuaires et le gestionnaire de fichiers. Plusieurs points d'entrée existent afin de faciliter l'accès aux informations : sections de catégories, moteur de recherche, ... Le langage OVML pourra aussi être utilisé par le webmaster afin, par exemple, d'illustrer en pages d'accueil les dernières publications.

On retrouve six acteurs dans la gestion des articles :

* l'administrateur : il est en charge de créer l'arborescence de publication et de définir les droits d'accès
* le gestionnaire d'articles : le seul à pouvoir supprimer un article, il gère aussi les processus d'archivages
* le publicateur : l'auteur des articles
* l'approbateur : il modère les articles avant leurs publications
* le gestionnaire des pages d'accueil : il définit les articles qui seront affichés en pages d'accueil
* le lecteur : dernier acteur, il peut ajouter des commentaires aux articles 

= Administration =

L'administrateur est en charge de créer l'arborescence de publication qui deviendra par défaut l'arborescence de navigation sur le site. L'arborescence est constituée de catégories et de thèmes, conteneurs des articles. Pour chaque thème d'articles, l'administrateur choisit ses préférences, active les publications, les points d'entrée sur le site (sections) et définit les acteurs concernés : gestionnaires, publicateurs et lecteurs.

== L'arborescence de publication ==

Lien ''Articles'' en section d'Administration.

L'arborescence de publication est composée de 2 entités : les catégories et les thèmes d'articles.

* Les catégories sont de simples conteneurs, elles précisent la nature de l'information qu'elles contiennent. Une catégorie peut faire partie d'une catégorie parente, on parlera alors de sous-catégorie. Il n'y a pas de limites quant au nombre d'imbrications. Une catégorie peut contenir des thèmes d'articles et des sous-catégories. Sur l'exemple ci-dessous, ''Actualités'' est une catégorie qui contient 3 thèmes d'articles : ''Sport'', ''Politique'' et ''Économie''.
* Les thèmes d'articles sont aussi des conteneurs et précisent aussi la nature de l'information qu'ils contiennent. Un thème d'articles fait obligatoirement partie d'une catégorie et contient des articles. Les droits d'accès et toutes les options de publication s'appliquent uniquement sur les thèmes d'articles (un article n'a pas d'options uniques, il hérite des options de son thème).
* Les articles font partie d'un thème. Ils ne sont pas visibles de l'administrateur du site.

[[Image:|center|Administration : arborescence de publication]]

== Catégories d'articles ==

Dans l'arborescence de publication, on reconnaîtra 5 icônes permettant de gérer les catégories (et sous-catégories) :

* [[Image:]] : Création d'une catégorie
* [[Image:]] : Suppression d'une catégorie
* [[Image:]] : Ordonne les catégories d'un même niveau
* [[Image:]] / [[Image:]] : Affiche ou cache la section de la catégorie
* [[Image:]] : Droits par défaut de la catégorie

Remarque : les sections font partie des points d'entrée possibles aux articles dans la navigation du portail. Il est possible d'activer une section pour chacune des catégories. Une section comporte des liens vers les thèmes et sous-catégories de la catégorie.

[[Image:|center|Gestion des catégories]]

=== Création d’une catégorie ===

Depuis l'arborescence de publication, après avoir cliqué sur l'icône concernée au niveau désiré, le formulaire de création apparaît :

[[Image:|center|Formulaire de création d’une catégorie]]

* Nom : nom de la catégorie
* Description : description de la catégorie (non affichée sur le portail mais peut être utilisée via le langage OVML)
* Section activée : affiche ou cache la section de la catégorie
* Patron de section : optionnel. Indique la mise en forme utilisée pour l'affichage de la section
* Patron d'affichage : optionnel. Indique la mise en forme utilisée pour l'affichage des thèmes d'articles et des sous-catégories
* Catégorie de sujet parent : définit la catégorie parente afin de préciser le niveau d'arborescence
* Sélection d'une image : permet de charger une image au format jpg, gif ou png qui sera associée à la catégorie dans la présentation côté utilisateur

=== Affecter des droits par défaut sur une catégorie ===

Les droits d'accès des articles peuvent s'appliquer sur les catégories afin d'être définis par défaut sur les thèmes d'articles contenus dans ces catégories. Il existe 5 droits :

* Qui peut lire les articles de ce thème ? : lecteurs des articles
* Qui peut soumettre de nouveaux articles ? : auteurs des articles et des brouillons
* Qui peut soumettre des commentaires ? : lecteurs ayant des droits de commentaires sur les articles
* Qui peut modifier les articles ? : auteurs ayant des droits de modification sur les articles, ce statut ne donne pas droit à la création d'articles
* Qui peut gérer ce thème ? : gestionnaires. Ils ordonnent les articles, modifient les dates de publication, choisissent les articles d'archives, suppriment les articles...

[[Image:|center|Affectation des droits par défaut]]

Après avoir cliqué sur le bouton "Enregistrer" (situé tout en bas de l'arbre de droits), l'administrateur doit déterminer sur quels objets vont s'appliquer les droits qu'il vient de définir.

[[Image:]]

En ne sélectionnant aucun objet, on n'affecte aucun thème, sous-catégorie, etc... existant. Les prochains thèmes et sous-catégories créés dans cette catégorie seront en revanche affectés.

=== Ordonner les catégories ===

Le formulaire est constitué d'une liste ordonnée (à gauche) des catégories d'un même niveau et de boutons (à droite) permettant de définir manuellement l'ordre d'affichage des catégories.

Les deux flèches bleues permettent de monter ou de descendre une catégorie sélectionnée dans la liste.

Les deux icônes du bas ordonnent les catégories par ordre croissant ou décroissant sur leurs noms.

Remarque : l'ordre définit par l'administrateur a une incidence sur la navigation (sections, chemin de fer...) et sur la gestion (publication, gestion des articles...).

[[Image:|center|Formulaire pour ordonner les catégories d’articles]]

=== Supprimer une catégorie ===

Il est nécessaire pour supprimer une catégorie d'avoir préalablement supprimé les thèmes d'articles et les sous-catégories qu'elles contient. La suppression n'est effective qu'après confirmation.

[[Image:|center|Suppression d’une catégorie]]

== Thèmes d'articles ==

Dans l'arborescence de publication, on reconnaîtra 3 icônes permettant de gérer les thèmes d'articles :

* [[Image:]] : Création d'un thème d'articles
* [[Image:]] : Suppression d'un thème d'articles
* [[Image:]] : Ordonne les thèmes d'articles d'un même niveau
* [[Image:]] : Droits d'accès sur un thème d'articles (lecteurs, publicateurs, gestionnaires...)

=== Création d’un thème ===

Depuis l'arborescence de publication, après avoir cliqué sur l'icône concernée sous la catégorie désirée, le formulaire de création apparaît :

[[Image:|center|Formulaire de création d’un thème d’articles]]

* Nom : nom du thème d'articles
* Catégorie de thèmes d'articles : définit la catégorie parente afin de préciser le niveau d'arborescence
* Description (via l'éditeur wysiwyg) : description du thème d'articles (visible pendant la navigation dans les articles)
* Langue : initialise la langue par défaut des articles, utile lorsqu'un filtre de langue est appliqué sur le site
* Patron d'affichage : optionnel. Indique la mise en forme utilisée pour l'affichage des articles
* Modèle d'articles : optionnel. Permet d'initialiser le contenu d'un article lors de sa création

Remarque : pour des raisons de mise en forme, l'éditeur wysiwyg ne permet pas le dépôt d'images dans la description d'un thème d'articles.

=== Préférences ===

Tous les articles sont rassemblés dans des thèmes. Les droits d'accès et les options de publication sont appliqués sur les thèmes : chaque article hérite donc des propriétés de son thème.

[[Image:|center|Préférences d’un thème d’articles]]

* Schéma d'approbation pour les articles : schéma utilisé pour modérer les nouveaux articles créés
* Schéma d'approbation pour les commentaires : schéma utilisé pour modérer les commentaires d'articles
* Schéma d'approbation pour la modification : schéma utilisé pour modérer les articles modifiés
* Approuver automatiquement le contributeur s'il fait partie de la première étape du schéma d'approbation : option applicable lors des modérations d'articles
* Les auteurs peuvent notifier les membres du groupe par email : envoie un mail à tous les utilisateurs ayant des droits de lecture sur le thème d'articles
* Les auteurs peuvent restreindre l'accès aux articles : les auteurs peuvent choisir les groupes d'utilisateurs pouvant voir les articles
* Permettre aux auteurs de proposer leur article pour les pages d'accueil : l'auteur propose son article, seul le gestionnaire peut décider d'afficher l'article en pages d'accueil
* Permettre aux auteurs de spécifier des dates de publication : permet de retarder la publication des articles
* Permettre aux auteurs de joindre des fichiers avec leurs articles : oui/non
* Permettre aux auteurs de modifier leurs articles : oui/non
* Permettre aux gestionnaires de modifier les articles : oui/non
* Nombre maximum d'articles sur la page des archives : lorsqu'un article est archivé, il n'est pas pour autant caché. Il se retrouve en nombre restreint avec les autres articles archivés.
* Utiliser les mots-clés du thésaurus : l'activation de cette option rendra obligatoire l'attribution d'au moins un mot-clé par article
* Permettre aux commentateurs de noter les articles: l'activation de cette option permet aux utilisateurs de noter l'article qu'ils commentent.
* Permettre aux auteurs d'associer une image à un article : Cette option autorise l'association d'une image à l'article. Cette image n'est visible qu'en étant récupérée en OvML.
* Sélection d'une image : permet de charger une image au format jpg, gif ou png qui sera associée au thème dans la présentation côté utilisateur. Cette image n'est visible qu'en étant récupérée en OvML.

Remarque : les schémas d'approbation sont créés par l'administrateur du site : lien Approbations en section d'Administration.

=== Droits d'accès ===

Les droits d'accès des articles s'appliquent sur leurs thèmes d'articles. Il existe 5 droits :

* Qui peut lire les articles de ce thème ? : lecteurs des articles
* Qui peut soumettre de nouveaux articles ? : auteurs des articles et des brouillons
* Qui peut soumettre des commentaires ? : lecteurs ayant des droits de commentaires sur les articles
* Qui peut modifier les articles ? : auteurs ayant des droits de modification sur les articles, ce statut ne donne pas droit à la création d'articles
* Qui peut gérer ce thème ? : gestionnaires. Ils ordonnent les articles, modifient les dates de publication, choisissent les articles d'archives, suppriment les articles...

[[Image:|center|ACL : formulaire de droits d’accès]]

=== Ordonner les thèmes ===

Le formulaire est constitué d'une liste ordonnée (à gauche) des thèmes d'articles d'un même niveau et de boutons (à droite) permettant de définir manuellement l'ordre d'affichage des thèmes.

Les deux flèches bleues permettent de monter ou de descendre un thème sélectionné dans la liste.

Les deux icônes du bas ordonnent les thèmes par ordre croissant ou décroissant sur leurs noms.

Remarque : l'ordre défini par l'administrateur a une incidence sur la navigation (sections, chemin de fer...) et sur la gestion (publication, gestion des articles...).

[[Image:|center|Formulaire pour ordonner les thèmes d’articles]]

=== Supprimer un thème ===

La suppression d'un thème d'articles entraînera la suppression de ses articles et de ses commentaires. La suppression n'est effective qu'après confirmation.

[[Image:|center|Suppression d’un thème d’articles]]

= Gestion =

Le gestionnaire d'un thème d'articles a accès à tous les articles du thème afin d'effectuer les opérations suivantes :

* Ordonner les articles
* Modifier les dates de publication et d'archivage
* Modifier le statut des articles : archivés, proposés en pages d'accueil, ...
* Déplacer les articles d'un thème à un autre
* Supprimer les articles

Le point d'entrée à ces options se situe en section Utilisateur : lien Gestion des articles.

Remarque : le gestionnaire n'a pas de droit de modification ou de création sur les articles, mais il peut visualiser les articles.

[[Image:|center|Section Utilisateur]]

[[Image:|center|Liste des thèmes d'articles gérés]]

== Supprimer un article ==

Seul le gestionnaire peut supprimer un article sur le site. Après sélection du thème d'articles dans l'arborescence (lien Gestion des articles en section Utilisateur), le gestionnaire doit sélectionner l'article (ou les articles) à supprimer via les cases à cocher en face des titres d'articles. L'interface permet une sélection multiple des articles. Le formulaire "Mettre à jour les éléments sélectionnés" permet d'effectuer l'opération de suppression sur tous les articles sélectionnés.

La suppression s'effectue après confirmation.

[[Image:|center|Suppression d’un article]]

== Ordonner les articles ==

Seul le gestionnaire peut ordonner les articles d'un thème (visible lors de la navigation dans les articles par les lecteurs). Après sélection du thème d'articles dans l'arborescence (lien Gestion des articles en section Utilisateur), l'onglet Ordre permet d'accéder au formulaire suivant :

[[Image:|center|Formulaire pour ordonner les articles d'un thème]]

Le formulaire est constitué d'une liste ordonnée (à gauche) des articles d'un même thème et de boutons (à droite) permettant de définir manuellement l'ordre d'affichage des articles.

Les deux flèches bleues permettent de monter ou de descendre un article sélectionné dans la liste.

Les deux icônes du bas ordonnent les articles par ordre croissant ou décroissant sur leurs noms.

Remarque :

* l'ordre défini par l'administrateur a une incidence sur la navigation (sections, chemin de fer...) et sur la gestion (publication, gestion des articles...).
* Si le gestionnaire ne modifie pas l'ordre des articles, les articles seront affichés par ordre de publication, l'article le plus récent en tête.

== Déplacer un article ==

Après sélection du thème d'articles dans l'arborescence (lien Gestion des articles en section Utilisateur), le gestionnaire doit afficher les propriétés de l'article pour accéder à son déplacement d'un thème à un autre : icône [[Image:]].

[[Image:|center|Liste des articles]]

Sur le formulaire des propriétés de l'article, l'entrée "thème d'articles" déroule la liste des thèmes sur lesquels le gestionnaire a accès. Le bouton "Mettre à jour" enregistre la modification et déplace l'article.

Remarque : le déplacement ne peut se faire que dans les thèmes d'articles que le gestionnaire gère.

[[Image:|center|Propriétés de l’article]]

== Archiver un article ==

Le gestionnaire peut décider d'archiver ou de désarchiver un article. Un article archivé est encore visible des lecteurs sur le site, cependant son affichage se situe dans une interface à part avec les autres articles archivés d'un même thème. Les articles archivés s'affichent en nombre limité : c'est l'administrateur qui définit le nombre d'articles affichés : les articles archivés les plus anciens ont donc peu de chances d'être vus des lecteurs.

Après sélection du thème d'articles dans l'arborescence (lien Gestion des articles en section Utilisateur), le gestionnaire doit sélectionner l'article (ou les articles) à archiver via les cases à cocher en face des titres d'articles. L'interface permet une sélection multiple des articles. Le formulaire "Mettre à jour les éléments sélectionnés" permet d'effectuer l'opération d'archivage sur tous les articles sélectionnés.

[[Image:|center|Archivage d'un article]]

Pour désarchiver un article et le rendre disponible à la lecture sur le site, le gestionnaire a accés à la liste des articles archivés : après sélection du thème d'articles dans l'arborescence (lien Gestion des articles en section Utilisateur), onglet "Archives".

[[Image:|center|Liste des articles archivés]]

== Autres options ==

Dans les propriétés d'un article (icône [[Image:]] après sélection du thème d'articles dans l'arborescence (lien Gestion des articles en section Utilisateur)), le gestionnaire a accès à plusieurs options selon ce qui a été défini par l'administrateur sur le thème d'articles :

* Date de publication : permet de retarder l'affichage de l'article sur le portail
* Date d'archivage : permet d'automatiser la mise en archive de l'article
* Restriction d'accès : permet de restreindre la lecture de l'article à des groupes d'utilisateurs

[[Image:|center|Propriétés de l’article]]

= Publication =

Les auteurs accèdent à la publication d'articles depuis le lien "Publication" en section Utilisateur. Un auteur peut avoir des droits de création et/ou de modification des articles. Chaque auteur pourra verrouiller un article et gérer un brouillon personnel avant de publier sa modification finale.

== Publier un article ==

Les auteurs accèdent à la publication d'articles depuis le lien "Publication" en section Utilisateur.

La publication passe par plusieurs étapes, les dernières étant optionnelles :

* Sélection du thème d'articles dans lequel l'article sera publié
* Rédaction de l'introduction et du corps de l'article
* Prévisualisation de l'article
* Préférences de publication : date de publication, date d'archivage, fichiers associés...

[[Image:]]

Ces étapes sont désormais (depuis la version 7.4) réunies en un seul écran.

Le lien "Publication" donne accès à la liste des brouillons de l'auteur. Le lien "Créer un nouvel article" lance l'édition.

Remarque : il est aussi possible de publier et de modifier un article en naviguant sur le site. Cette possibilité évite l'étape de sélection du thème.

[[Image:|center|Liste des brouillons d'un auteur]]

* Première étape :

L'auteur sélectionne le thème dans lequel sera créé le nouvel article grâce au menu déroulant. Pour un brouillon, il n'est pas nécessaire de choisir un thème.

[[Image:|center|Sélection du thème d’articles]]

* Deuxième étape :

L'auteur accède à la rédaction de l'article. Un article doit contenir un titre et une introduction. Le corps de l'article est optionnel. Par défaut, le bloc de rédaction est replié. Il faut cliquer sur le titre "Corps" pour que ce bloc s'affiche.

Le partage du contenu dans l'introduction et le corps a une incidence sur la navigation par les lecteurs. Il existe deux écrans principaux pour l'affichage des articles :

* liste des articles d'un thème
* corps de l'article

Lorsqu'un lecteur accède à un thème, il se retrouve avec la liste de tous ses articles et visualise leurs introductions. Si un article contient un corps, un lien "lire la suite" permettra d'accéder au corps de l'article.

L'auteur peut donc choisir de publier tout son article dans l'introduction afin de ne pas séparer le contenu en deux (introduction et corps). Cependant, il peut être intéressant d'utiliser le corps de l'article afin de ne pas surcharger la liste des articles dans le thème.

L'auteur choisira la langue de l'article. Ceci a un effet lors de l'application de filtres de langues sur le site.

[[Image:|center|Rédaction de l’article]]

== L'éditeur wysiwyg ==

L'introduction et le corps d'un article se rédigent grâce à un éditeur dit wysiwyg (What You See Is What You Get). Cet éditeur simplifie la mise en forme du contenu avec des fonctions de mise en gras, italique, alignement au centre, couleur de texte, ... L'objectif est de rédiger un contenu en langage html, le langage reconnu dans les navigateurs Web. L'éditeur simplifie donc la rédaction de l'article en rendant transparent l'édition du code html.

Fonctions :

[[Image:]] : police de caractères : Arial, Times New Roman, Verdana...

: taille de caractères en points (pt)

: style du texte : titre, paragraphe...

: alignement du texte : gauche, centré, droit, justifié

: création de listes à puces

: retrait gauche ou droit de lignes

: couleur du texte et du fond

: création d'un lien interne (renvoie sur la même page) ou externe (adresse Web externe) : le texte du lien doit être sélectionné préalablement : suppression d'un lien : création d'un tableau

: suppression de la mise en forme d'un texte sélectionné

: suppression des balises non désirées sur un texte provenant d'un éditeur externe

: passe en mode code source : édition en langage html

: passe l'édition en plein écran

: "copie" le texte sélectionné (quelques navigateurs n'acceptent pas cette opération)

: "coupe" le texte sélectionné

: "colle" le texte sélectionné

: annule ou répète la dernière action

: met en gras le texte sélectionné

: met en italique le texte sélectionné

: souligne le texte sélectionné

: barre le texte sélectionné

: met en indice le texte sélectionné (abaisse le texte) ; [[Image:]] met en exposant (élève le texte)

'': fonctions d'Ovidentia : voir description ci-dessous''

[[Image:|center|L’éditeur wysiwyg HTMLArea]]

Remarque : il est déconseillé de copier un texte dans l'éditeur wysiwyg provenant d'un éditeur de texte externe (Microsoft Word, OpenOffice, Works...) car certaines mises en formes peuvent être mal interprétées lors de l'affichage de l'article, les syntaxes de rédaction étant différentes. Il est préférable de passer par un texte intermédiaire en supprimant sa mise en forme.

Exemple :

Étape 1 : copie d'un texte mis en forme sur Microsoft Word

Étape 2 : le texte est "collé" dans un éditeur bas niveau tel que le bloc-notes sous Windows afin de supprimer sa mise en forme

Étape 3 : copie du texte placé dans le bloc-note

Étape 4 : le texte est "collé" dans l'éditeur wysiwyg puis mis en forme depuis l'éditeur wysiwyg

Fonctions d'Ovidentia :

[[Image:|center|Fonctions Ovidentia de l'éditeur wysiwyg]]

* Insérer une image : l'auteur peut ajouter une image provenant de son ordinateur

[[Image:]]

Le bouton Parcourir permet de sélectionner un fichier image provenant de son ordinateur.

Si l'option "partagé" est activée, l'image sera présente dans la bibliothèque et sera disponible pour tous les auteurs dans tous les thèmes d'articles. La bibliothèque est affichée en-dessous et peut contenir des répertoires. Avant de partager une image, le répertoire de destination doit être ouvert.

Alignement : définit l'affichage du texte par rapport à l'image. Un alignement à gauche affiche le texte sur le bord droit de l'image.

Alt : texte affiché lorsque l'image est inaccessible. Est aussi un renseignement sur la nature de l'image pour les malvoyants utilisant des lecteurs de pages Web.

Espacement horizontal : espace entre les bords gauche et droit de l'image

Espacement vertical : espace entre les bords haut et bas de l'image

Bordure : taille de la bordure en pixels

* Insérer des fichiers ou des répertoires du gestionnaire de fichiers
* Insérer un lien dynamique vers un article
* Insérer un lien vers une question/réponse d'une FAQ
* Insérer un fichier OVML : les fichiers OVML doivent être présents dans le dossier OVML du skin utilisé par le site. Si un dossier "editor" est présent dans le dossier OVML du skin, ce sont les fichiers présents dans ce dossier "editor" qui seront proposés.
* Insérer un lien vers un contact personnel
* Insérer un lien vers une fiche d'annuaire

== Options de publication ==

Après la rédaction de l'article, l'auteur accède aux options de publication.

* Thème d'articles : déplacement de l'article dans un autre thème
* Date de soumission : permet de retarder l'envoi de l'article à l'approbation, affecte aussi la publication
* Date de publication : permet de retarder l'affichage de l'article sur le site
* Date d'archivage : permet d'automatiser la mise en archive de l'article
* Proposer pour la page d'accueil publique : propose l'article pour la page d'accueil publique (accès anonyme). Seul le gestionnaire peut accepter l'article et l'afficher en pages d'accueil
* Proposer pour la page d'accueil privée : propose l'article pour la page d'accueil privée. Seul le gestionnaire peut accepter l'article et l'afficher en pages d'accueil
* Documents associés : permet d'ajouter des fichiers (pdf, doc, zip...) à l'article
* Notifier les utilisateurs une fois l'article publié : si activé, tous les utilisateurs ayant des droits de lecture recevront un mail de notification
* Restriction d'accès : permet de restreindre l'accès de l'article à des groupes d'utilisateurs

[[Image:|center|Quelques options de publication]]

== Attacher des fichiers à un article ==

Il existe deux méthodes pour associer des fichiers à un article. La première s'appuie sur le gestionnaire de fichiers, une autre fonction de publication d'Ovidentia. L'autre utilise la fonction présente dans les options de publication d'articles.

* Méthode 1 :

On désire lier un fichier à un article, cependant ce fichier sera utilisé dans plusieurs articles. Pour réduire l'espace disque utilisé par les multiples copies de fichiers, le fichier est placé dans le gestionnaire de fichiers.

Depuis l'éditeur wysiwyg, on utilisera l'icône [[Image:]] pour faire un lien vers ce fichier dans l'article.

Cette méthode a d'autres avantages que le gain d'espace disque. Si le fichier est amené à évoluer, il peut changer de versions depuis le gestionnaire de fichiers : les articles seront directement liés à la dernière version du fichier. De plus, lorsqu'un fichier du gestionnaire de fichiers est lié à un article, son lien dans l'éditeur wysiwyg peut être placé n'importe où dans l'article (sur une image, entre 2 lignes...).

* Méthode 2 :

On souhaite associer un fichier à un article. Ce fichier sera uniquement accessible dans cet article et n'a pas d'intérêt à être visible depuis le gestionnaire de fichiers. On associe donc le fichier depuis les options de publication. Le formulaire de dépôt gère les dépôts multiples et l'ordre d'affichage des fichiers.

Remarque : les fichiers associés apparaîtront sous l'article pour les lecteurs. Contrairement à la méthode 1, les liens vers les fichiers ne peuvent pas être placés à l'intérieur du contenu de l'article.

[[Image:|center|Association des fichiers à un article]]

== Gérer un brouillon ==

Les auteurs peuvent gérer des brouillons lorsque le contenu n'est pas encore terminé. Un brouillon est personnel et n'est donc pas accessible aux autres auteurs. Il existe deux types de brouillons :

* le brouillon sur un nouvel article : dans ce cas, l'article n'est pas soumis à approbation ou n'est pas publié pendant la mise en brouillon.
* le brouillon sur un article modifié : dans ce cas, un article publié est en cours de modification par un auteur. Lorsque la modification est en brouillon, l'article dans son ancienne version reste affiché sur le site. Cependant, l'article est verrouillé par son auteur et ne pourra pas être édité par un autre auteur tant que la modification ne sera pas soumise.

Pour créer un brouillon d'un nouvel article ou d'un article modifié, il suffit de cliquer sur le bouton "Enregistrer un brouillon" lors de la rédaction de l'article.

[[Image:|center|Boutons lors de la rédaction d'un article]]

Le brouillon est accessible dans la liste des brouillons : lien Publication en section Utilisateur.

Pour soumettre un brouillon à la publication, l'auteur peut modifier l'article et suivre les étapes de publication et cliquer sur le bouton "Soumettre". L'auteur peut aussi soumettre l'article directement depuis la liste des brouillons via l'icône [[Image:]].

[[Image:|center|Liste des brouillons]]

= Navigation =

L'arborescence de publication gérée par l'administrateur met en évidence la navigation sur le site dans les articles.

Lors de l'intégration d'une charte graphique, le webmaster a recours à plusieurs méthodes pour afficher le contenu du site à ses lecteurs et peut proposer une navigation totalement différente de celle proposée par défaut dans Ovidentia. Les exemples ci-dessous proviennent de la navigation par défaut d'Ovidentia.

== Les sections ==

Les sections sont les principaux points d'entrée aux informations avec les pages d'accueil. Il existe deux types de sections dans les articles :

* la section de catégories de thèmes d'articles : elle présente la liste des catégories parentes. L'administrateur peut l'activer ou la désactiver depuis le lien "Sections" en section d'Administration.

[[Image:|center|Sections de catégories]]

* les sections de catégories : activées/désactivées par l'administrateur dans l'arborescence de publication, elles listent les thèmes d'articles présents dans une catégorie.

[[Image:|center|Section de catégorie]]

Remarque : l'administrateur peut ordonner l'affichage des sections depuis le lien "Sections" en section d'Administration.

== Navigation ==

Pendant la navigation dans les articles, les lecteurs s'orientent avec le chemin de fer (ou rail). Ce dernier s'appuie sur l'arborescence de publication :

[[Image:|center|Chemin de fer]]

Voici les écrans principaux affichés pendant la navigation dans les articles :

* Catégorie d'articles : liste des sous-catégories et thèmes d'articles d'une catégorie

[[Image:]]

Ici, la catégorie Actualités contient 3 thèmes d'articles : Sport, Politique et Economie.

* Thème d'articles : liste des articles d'un thème. Seules les introductions des articles sont affichées, le corps des articles est accessible via le lien "Lire la suite" sous les articles. L'auteur ainsi que la date de publication sont affichés. Pour les auteurs, il est possible de soumettre ou de modifier un article directement depuis un thème d'articles via les liens "Soumettre" et "Modifier".

[[Image:|center|Liste des articles d’un thème]]

* Articles archivés : les archives sont accessibles via l'onglet "Archives" présent sur chaque thème contenant des archives.

[[Image:]]

== Moteur de recherche ==

Les articles sont totalement intégrés dans le moteur de recherche d'Ovidentia. Pour une recherche avancée, indiquez au moteur la fonction Articles. Cette opération donne accès aux options de recherche :

* Thèmes d'articles : filtre le champ de recherche par thèmes d'articles
* Mots-clés du thésaurus : filtre les articles associés aux mots-clés renseignés. La saisie des mots-clés est simplifiée via une auto-suggestion. L'opérateur OU/ET précise si les articles recherchés doivent contenir tous les mots-clés (ET) ou au moins un mot-clé (OU).
* Auteur : filtre sur l'auteur des articles
* Après la date : filtre les articles publiés après la date renseignée
* Avant la date : filtre les articles publiés avant la date renseignée

[[Image:|center|Moteur de recherche]]

== Ajouter un commentaire ==

Si l'administrateur active les commentaires sur les thèmes d'articles, tous les utilisateurs ayant des droits de commenter verront s'afficher en-dessous de chaque article le lien "Commentaires".

Le lien "Commentaires" permet d'accéder à la liste des commentaires et à la création d'un commentaire.

Remarque : les commentaires peuvent être modérés.

[[Image:|center|Liste des commentaires]]

= Patrons d'affichage et modèles d'articles =

Les patrons d'affichage et les modèles d'articles sont des éléments accessibles au webmaster et permettent de personnaliser l'affichage ou la création des articles.

* Patrons d'affichage : ils permettent de personnaliser l'affichage final des articles ou des catégories
* Modèles d'articles : ils permettent d'initialiser le contenu de l'introduction et du corps des articles lors de leurs rédactions

L'application d'un patron ou d'un modèle s'effectue par l'administrateur dans l'arborescence de publication :

[[Image:]]

[[Image:]]

Création d'une catégorieCréation d'un thème d'articles

== Patrons d'affichage ==

Les patrons d'affichage permettent de personnaliser l'affichage final des articles, des catégories ou des sections.

Il existe trois types de patrons :

* les patrons d'affichage de catégories
* les patrons d'affichage de sections de catégories
* les patrons d'affichage de thèmes d'articles

Voici un exemple simple de personnalisation du patron d'affichage d'un thème d'articles :

Sur la gauche, on aperçoit l'affichage par défaut des articles dans un thème.

Sur la droite, le thème s'appuie sur un patron d'affichage créé par le webmaster : le webmaster a décidé de modifier l'apparence des titres d'articles, d'ajouter des liens internes redirigeant sur les titres d'articles et de supprimer l'affichage des auteurs et dates de publications.

[[Image:]] [[Image:]]

Réaliser un patron d'affichage :

Le webmaster doit avoir accès aux fichiers d'Ovidentia sur le serveur. Il doit commencer par copier le "template" concerné dans le skin du site. Le "template" est un fichier html présent dans la distribution (noyau Ovidentia ) et qui gère l'affichage d'éléments sur le site. Pour ajouter un patron d'affichage, il faut dupliquer le code présent dans ce fichier template.

Les fichiers templates concernés :

topcatsection.html : gère les patrons d'affichage des sections de catégories

topicsdisplay.html : gère le patron d'affichage des thèmes d'articles

topicssection.html : gère les patrons d'affichage des sections de thèmes

topcatdisplay.html : gère les patrons d'affichage des catégories

* Première étape : copier le fichier template présent dans le noyau dans le skin du site. Cette opération est nécessaire afin d'éviter de perdre toutes modifications lors de la mise à jour d'Ovidentia , les fichiers du noyau ne doivent pas être modifiés.

Répertoire des fichiers templates du noyau : racine d'Ovidentia/noyauXXX/skins/ovidentia/templates/

Répertoire des fichiers templates du skin : racine d'Ovidentia/skins/votreskin/templates/

* Deuxième étape : dupliquer le code présent dans le fichier afin de créer un nouveau patron. Chaque fichier contient une portion de code utilisée pour l'affichage d'éléments. La portion est délimitée par les syntaxes suivantes :

<source lang="html4strict">



</source>

Pour ajouter un nouveau patron d'affichage, il faut dupliquer le code compris entre les 2 lignes ci-dessus et nommer le patron de cette manière :

<source lang="html4strict">



</source>

* Troisième étape : personnaliser la portion de code dupliquée : modification de balises html, de styles, suppression d'éléments...

* Quatrième étape : affecter le patron d'affichage à l'élément désiré via l'arborescence de publication

Remarque :

Pour les patrons d'affichage de thèmes d'articles, il est nécessaire de dupliquer 2 portions de codes :

<source lang="html4strict">



</source>

et

<source lang="html4strict">



</source>

La première portion gère l'affichage des articles dans un thème (introductions des articles) et la deuxième gère l'affichage du corps d'un article.

== Modèles d'articles ==

Un modèle d'articles est un procédé qui permet d'initialiser l'introduction et le corps d'un article lors de sa rédaction. Le modèle n'impacte donc pas l'affichage final des articles, seulement sa rédaction.

Le procédé de création est le même que pour les patrons d'affichage (voir ci-dessus les 4 étapes de création), le fichier template concerné est articlestemplates.html.

Voici un exemple simple d'un modèle d'articles :

Lors de la rédaction d'un article, le contenu de l'introduction est pré-renseigné par un tableau.

[[Image:|center|Modèle d'articles]]

= Gestion des pages d'accueil =

Les pages d'accueil sont les points d'entrées principales sur un site, elles ne doivent pas être négligées. Elles contiennent généralement un message d'accueil ainsi que les dernières actualités. Il existe deux pages d'accueil sur Ovidentia :

* la page d'accueil publique : accessible aux utilisateurs anonymes
* la page d'accueil privée : accessible aux utilisateurs authentifiés

== L'OVML ==

Les pages d'accueil publique et privée d'Ovidentia peuvent être gérées par le langage OVML afin d'y afficher un contenu dynamique (derniers articles publiés, prochains événements...). Pour cela, il suffit de créer les fichiers public.html et private.html dans le skin du site sur le serveur. Lorsque ces fichiers sont présents dans le skin du site, ils remplacent l'affichage par défaut des pages d'accueil ; l'affichage par défaut étant la liste des articles proposés en pages d'accueil.

Répertoire des fichiers ovml du skin :

racine d'Ovidentia/skins/votreskin/ovml/

Voici 2 exemples de mise en forme des pages d'accueil par le langage OVML :

[[Image:]] [[Image:]]

Sur ces 2 captures d'écran, l'information remontée appartient à la gestion des articles.

== Proposer un article pour une page d'accueil ==

Les auteurs ont la possibilité de proposer leurs articles pour les pages d'accueil. Ce procédé permet d'afficher des articles tous thèmes confondus en pages d'accueil publique et privée.

Un gestionnaire des pages d'accueil (choisi par l'administrateur) accède à tous les articles proposés et décide de les afficher ou non en pages d'accueil.

* Options de publication :

Les auteurs peuvent proposer leurs articles en pages d'accueil depuis les options de publication (étape qui suit la rédaction et la prévisualisation de l'article), l'administrateur peut activer cette option dans les paramètres des thèmes.

[[Image:|center|Options de publication]]

* Gestionnaire des pages d'accueil :

L'administrateur définit les gestionnaires des pages d'accueil depuis les paramètres du site.

Le gestionnaire des pages d'accueil accède à la liste des articles proposés et peut à tout moment décider de les afficher ou de les retirer des pages d'accueil :

[[Image:|center|Gestion des articles proposés en pages d'accueil]]

Remarque :

L'affichage des articles est automatique dans le fonctionnement par défaut d'Ovidentia, cependant si le skin du site contient les fichiers private.html et public.html, les pages d'accueil sont alors gérées par le langage OVML. Dans ce cas, pour afficher les articles en pages d'accueil, le webmaster utilisera le container OVML nommé OCArticlesHomePages (voir la documentation sur le langage OVML pour plus de détails).

= Gestion de l'approbation =

L'administrateur peut définir un schéma d'approbation au niveau des options de thèmes d'articles. Les articles seront alors modérés au moment de leurs publications et/ou de leurs modifications : un ou plusieurs approbateurs devront accepter l'article avant sa publication.

Remarque :

Un message situé en bas de l'écran prévient l'auteur lorsque l'article est soumis à approbation avant sa publication.

== Schémas d'approbation ==

L'administrateur créé le schéma d'approbation depuis le lien Approbations en section d'Administration. Ce schéma pourra être choisi dans les options de thèmes d'articles et définit les personnes qui devront accepter les articles avant leurs publications sur le site.

[[Image:|center|Liste des schémas d’approbation]]

== Modérer un article ==

A la création ou à la modification d'un article soumis à approbation, l'approbateur est notifié par mail. Pour voir puis accepter ou refuser l'article, l'approbateur passe par le lien Approbations en section Utilisateur.

Remarque : le lien Approbations en section utilisateur n'apparaît qu'à condition que des éléments soient en attente d'approbation.

[[Image:|center|Liste des articles en attente]]

[[Image:|center|Réponse de l'approbateur]]

Fichier:Navigation-faq.png

2013-06-19T13:18:17Z

Rodpec :

Fichier:Modifier-question-faq.png

2013-06-19T13:17:59Z

Rodpec :

Fichier:Bouton-modifier-question-faq.png

2013-06-19T13:17:25Z

Rodpec :

FAQs

2013-06-19T13:01:04Z

Rodpec : /* Editer une question ou une sous-catégorie. */

Une FAQ (Frequently Asked Questions ou Foire aux questions) est une base de connaissances : les questions fréquemment posées sont rassemblées et actualisées en un point unique, aisément consultable par les utilisateurs.

Attention : une FAQ n'est pas interactive, dans le sens que c'est le même utilisateur qui renseigne questions et réponses. Pour des échanges entre utilisateurs, on utilisera les forums.

= Administration =

L'administrateur crée les FAQs, donne les droits d'accès sur les FAQs, et modifie l'ordre des FAQs dans la section.

== Créer une FAQ ==

Pour créer une FAQ, l'administrateur se rend dans la section Administration, entrée "FAQ".

[[Image:section-administration-faq.png|center|Lien FAQ de la section Administration]]

Il accède alors à la liste des FAQs.

[[Image:liste-faqs.png|center|Liste des FAQs]]

En cliquant sur "Ajouter", il accède au formulaire de création suivant :

[[Image:ajouter-faq.png|center|Ajouter une nouvelle FAQ]]

* Le nom est obligatoire.
* La description, facultative, apparaîtra dans la liste des FAQs.
* La langue ne sert que dans le cas de sites multilingues.

[[Image:liste-faqs-droit.png|center|Lien d'accès à la gestion des droits d'une FAQ]]

Une fois les paramètres définis, l'administrateur clique sur "Ajouter". Une fois sur la liste, il clique sur le lien "Droits" correspondant et définit les droits.

[[Image:gestion-droits-faq.png|center|Gestion des droits d'une FAQ]]

Les différents droits sont :

; Voir
: Les utilisateurs qui ont accès à la FAQ en simple consultation
; Voir et gérer
: Les utilisateurs qui peuvent renseigner de nouvelles questions / réponses

== Editer / Supprimer une FAQ ==

Il suffit pour l'administrateur de cliquer sur le nom de la FAQ dans la liste des FAQs accessibles via la section Administration.

Attention, toute suppression entraîne la suppression de toutes les questions associées sans possibilité de récupération.

= Utilisation =

== Accéder aux FAQ ==

En cliquant sur "FAQ" dans la section Utilisateur, on accède à la liste des FAQs.

[[Image:section-utilisateur-faq.png|center|Lien FAQ de la section Utilisateur]]

[[Image:liste-faqs-utilisateur.png|center|Liste des FAQs pour l'utilisateur]]

En cliquant sur le nom d'une des FAQs, on accède au sommaire de cette FAQ.

[[Image:sommaire-faq.png|center|Sommaire d'une FAQ]]

Bien évidemment par défaut, la FAQ est vide.

Nous allons maintenant voir comment la remplir.

== Créer une sous-catégorie ==

Les utilisateurs qui bénéficient du droit de gestion peuvent créer des sous-catégorie de FAQ, qui constitueront en quelque sorte des rubriques ou des chapitres de la FAQ. Cette fonctionnalité est rapidement utile à mesure que la FAQ prend de l'importance et qu'il faut s'assurer qu'elle reste lisible pour les utilisateurs.

Pour créer une sous-catégorie, il suffit de cliquer sur l'onglet "Ajouter une sous-catégorie", ce qui permet d'accéder au formulaire suivant.

[[Image:categorie-faq.png|center|Ajout d'une sous-catégorie]]

Une sous-catégorie peut elle-même appartenir à une autre sous-catégorie, ce qui vous permet de créer une véritable arborescence de questions / réponses.

Il suffit, une fois le nom de la sous-catégorie renseigné de cliquer sur Ajouter pour qu'elle s'ajoute dans le sommaire.

== Créer une question / réponse ==

Pour créer une question de FAQ et la réponse correspondante, le gestionnaire de la FAQ n'a qu'à cliquer sur l'onglet "Ajouter une question" pour accéder au formulaire suivant.

[[Image:ajouter-question-faq.png|center|Ajouter une question / réponse]]

En cliquant sur Ajouter, la question vient se positionner dans la sous-catégorie souhaitée.

== Editer une question ou une sous-catégorie. ==

L'édition d'une question ou d'une sous-catégorie se fait simplement en cliquant sur le pictogramme [[Image:bouton-modifier-question-faq.png|Bouton de modification d'une question/réponse ou d'une sous-catégorie]] à gauche de chaque objet dans le Sommaire de la FAQ.

[[Image:modifier-question-faq.png|center|Modifier une question / réponse]]

On accède alors au formulaire d'édition correspondant qui permet les même actions que les formulaires de création.

== Navigation ==

Les questions renseignées dans une FAQ sont listées en haut de celle-ci, réparties par sous-catégories.

Un clic sur une question permet d'accéder directement à celle-ci. Un lien "Haut", généré automatiquement par l'outil en dessous de chaque réponse, permet de remonter en haut de la page et de reprendre sa navigation dans les questions.

[[Image:navigation-faq.png|center|Navigation dans une FAQ]]

Fichier:Ajouter-question-faq.png

2013-06-19T12:56:28Z

Rodpec :

Fichier:Categorie-faq.png

2013-06-19T12:56:22Z

Rodpec :

Fichier:Sommaire-faq.png

2013-06-19T12:56:15Z

Rodpec :

Fichier:Liste-faqs-utilisateur.png

2013-06-19T12:56:07Z

Rodpec :

Fichier:Liste-faqs-droit.png

2013-06-19T12:30:05Z

Rodpec :

Référence OvML

2013-06-05T16:08:30Z

Rodpec : /* OFTranslate */

[[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.

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 :

<source lang="ovml">
<OVnom-de-la-variable>
</source>

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

<source lang="ovml">
<OFPutVar name="nbArticles" value="10">
</source>

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 :

<source lang="ovml">
<OVnbArticles>
</source>

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 :

<source lang="ovml">
<OFPutVar name="babSlogan">
</source>

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.

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

<source lang="ovml">
<OFIfNotIsSet name="page" value="1">
</source>

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 <code><OVxxxx></code>.

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.

<source lang="ovml">
<OVnbArticles saveas="TotalArticles">
</source>

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.

{| class="prettytable"
! Value
!
|-
| n
| Récupère les n premiers caractères du contenu de la variable
|}

<source lang="ovml">
<OVbabSlogan strlen="100">
</source>

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 :

<source lang="ovml">
<OVbabSlogan strlen="100,...">
</source>

== striptags ==

Supprime les tags HTML de la variable :

{| class="prettytable"
! Value
!
|-
| 1
| Supprime les tags HTML de la variable
|}

<source lang="ovml">
<OVbabSlogan striptags="1">
</source>

== htmlentities ==

{| class="prettytable"
! Value
!
|-
| 1
| <nowiki>Convertit les entities HTML ( < devient &lt; )</nowiki>
|-
| 2
| <nowiki>Convertit en inverse les entities HTML ( &lt; devient < )</nowiki>
|}

<source lang="ovml">
<OVbabSlogan htmlentities="1">
</source>

== stripslashes ==

Supprime les slashs doublés du contenu de la variable

{| class="prettytable"
! Value
!
|-
| 1
| Supprime les slashs doublés du contenu de la variable
|}

<source lang="ovml">
<OVbabSlogan stripslashes="1">
</source>

== urlencode ==

{| class="prettytable"
! Value
!
|-
| 1
| Encode la variable pour l'utilisation dans une url
|}

<source lang="ovml">
<OVbabSlogan urlencode="1">
</source>

== jsencode ==

{| class="prettytable"
! Value
!
|-
| 1
| Encode la variable pour l'utilisation dans du javascript
|}

<source lang="ovml">
<OVbabSlogan jsencode="1">
</source>

== strcase ==

{| class="prettytable"
! Value
!
|-
| upper
| Convertit le contenu de la variable en majuscule
|-
| lower
| Convertit le contenu de la variable en minuscule
|}

<source lang="ovml">
<OVbabSlogan strcase="upper">
</source>

== nlremove ==

{| class="prettytable"
! Value
!
|-
| 1
| Supprime les retours chariots
|}

<source lang="ovml">
<OVbabSlogan nlremove="1">
</source>

== trim ==

{| class="prettytable"
! 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
|}

<source lang="ovml">
<OVbabSlogan trim="all">
</source>

== nl2br ==

{| class="prettytable"
! Value
!
|-
| <div align="right">1</div>
| <nowiki>Transforme les retours chariots en </nowiki>
|}

<source lang="ovml">
<OVbabSlogan nl2br="1">
</source>

== sprintf ==

{| class="prettytable"
! Value
!
|-
| Voir la documentation PHP pour la fonction sprintf
| Retourne une chaîne formatée
|}

<source lang="ovml">
<OVMoney sprintf="%01.2f">
</source>

== date ==

Permet de formater une date Ovidentia

{| class="prettytable"
! 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"
|}

<source lang="ovml">
<OVArticleDate date="%d %j %m %Y">
</source>

'''Remarque :'''

<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.

<source lang="ovml">
<OVbabCurrentDate date="%D %j %M" strcase="lower">
</source>

== author ==

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

{| class="prettytable"
! Value
!
|-
| %F
| Prénom
|-
| %M
| Deuxième prénom
|-
| %L
| Nom
|}

<source lang="ovml">
<OVArticleAuthor author="%F %L" strcase="lower">
</source>

= Les fonctions OvML =

On reconnaît les fonctions par la syntaxe suivante :

<source lang="ovml">
<OFxxxx ...>
</source>

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 <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>
</source>

'''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>
</source>

=== Syntaxe ===

<source lang="ovml">
<OFTranslate text="" [lang=""]>
</source>

=== 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

== OFPutVar ==

Permet de déclarer une nouvelle variable.

=== Syntaxe ===

<source lang="ovml">
<OFPutVar name="" [value=""]>
</source>

=== Paramètres ===

; name
: Nom de la variable

; value ''(optionnel)''
: Valeur à affecter à la variable

== OFGetVar ==

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

=== Syntaxe ===

<source lang="ovml">
<OFGetVar name="">
</source>

=== Paramètres ===

; name
: Nom de la variable à afficher

== OFIfNotIsSet ==

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

=== Syntaxe ===

<source lang="ovml">
<OFIfNotIsSet name="" [value=""]>
</source>

=== Paramètres ===

; name
: Nom de la variable

; value ''(optionnel)''
: Valeur à affecter à la variable

== OFInclude ==

Permet d'inclure un autre fichier OVML

=== Syntaxe ===

<source lang="ovml">
<OFInclude file="" [cache=""]>
</source>

=== 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 ===

<source lang="ovml">
<OFUrlContent url="">
</source>

=== 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 ===

<source lang="ovml">
<OFRecurse>
</source>

=== 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>).

<source lang="ovml">
<ul>
<OCArticleCategories>
<li>
<OVCategoryName>
<ul>
<OFRecurse parentid="<OVCategoryId>">
<OCArticleTopics categoryid="<OVCategoryId>">
<li><OVTopicName></li>
</OCArticleTopics>
</ul>
</li>
</OCArticleCategories>
</ul>
</source>

== Opérateurs arithmétiques ==

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

<source lang="ovml">
<OFAOxxxxx expr1="X" expr2="Y">
</source>

<source lang="ovml">
<OFAOxxxxx expr1="10" expr2="50">
</source>

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

<source lang="ovml">
<OFAOxxxxx expr1="<OVTotal>" expr2="50">
</source>

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.

<source lang="ovml">
<OFAOxxxxx expr1="<OVTotal>" expr2="50" saveas="NewTotal">
</source>

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 :

=== OFAOAddition ===

Permet d’additionner expr1 et expr2.

==== Syntaxe ====

<source lang="ovml">
<OFAOAddition expr1="" expr2="">
</source>

==== Paramètres ====

; expr1
: Premier terme de l'addition

; expr2
: Second terme de l'addition

=== OFAOSubtraction ===

Permet de soustraire expr2 à expr1.

==== Syntaxe ====

<source lang="ovml">
<OFAOSubtraction expr1="" expr2="">
</source>

==== Paramètres ====

; expr1
: Premier terme de la soustraction

; expr2
: Second terme de la soustraction

==== Exemple ====

<source lang="ovml">
<OFAOSubtraction expr1="10" expr2="20">
</source>

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 ====

<source lang="ovml">
<OFAOMultiplication expr1="" expr2="">
</source>

==== Paramètres ====

; expr1
: Premier terme de la multiplication

; expr2
: Second terme de la multiplication

=== OFAODivision ===

Permet de diviser expr1 par expr2.

==== Syntaxe ====

<source lang="ovml">
<OFAODivision expr1="" expr2="">
</source>

==== Paramètres ====

; expr1
: Premier terme de la division

; expr2
: Second terme de la division

==== Exemple ====

<source lang="ovml">
<OFAODivision expr1="10" expr2="20">
</source>

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 ====

<source lang="ovml">
<OFAOModulus expr1="" expr2="">
</source>

==== Paramètres ====

; expr1
: Premier terme du modulo

; expr2
: Second terme du modulo

==== Exemple ====

<source lang="ovml">
<OFAOModulus expr1="10" expr2="20">
</source>

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 ===

<source lang="ovml">
<OFHeader value="">
</source>

=== Paramètres ===

; value
: Valeur du header à modifier

=== Exemple ===

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

== OFSetCookie ==

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

=== Syntaxe ===

<source lang="ovml">
<OFSetCookie name="" expire="" [value=""]>
</source>

=== 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 ===

<source lang="ovml">
<OFGetCookie name="">
</source>

=== 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 ===

<source lang="ovml">
<OFSetSessionVar name="" value="">
</source>

=== 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 ===

<source lang="ovml">
<OFSetSessionVar name="babSectionsType" value="15">
</source>

affichera toutes les sections du portail

<source lang="ovml">
<OFSetSessionVar name="babSectionsType" value="4">
</source>

affichera uniquement les sections personnalisées du portail

<source lang="ovml">
<OFSetSessionVar name="babSectionsType" value="10">
</source>

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

<source lang="ovml">
<OFSetSessionVar name="babOvmlCurrentDelegation" value="5">
</source>

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

<source lang="ovml">
<OFSetSessionVar name="babOvmlCurrentDelegation" value="0">
</source>

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 ===

<source lang="ovml">
<OFRequest name="" saveas="" [default=""]>
</source>

=== Paramètres ===

; name
: Nom du paramètre GET dont on souhaite récupérer la valeur

; 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 ===

<source lang="ovml">
<OFPost name="" saveas="" [default=""]>
</source>

=== Paramètres ===

; name
: Nom du paramètre POST dont on souhaite récupérer la valeur

; 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 ===

<source lang="ovml">
<OFGet name="" saveas="" [default=""]>
</source>

=== Paramètres ===

; name
: Nom du paramètre GET dont on souhaite récupérer la valeur

; 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 ===

<source lang="ovml">
<OFSitemapPosition [sitemap=""] [basenode=""] [node=""] [keeplastknown=""]>
</source>

=== Paramètres ===

; 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 ===

<source lang="ovml">
<OFSitemapMenu [sitemap=""] [basenode=""] [selectednode=""] [keeplastknown=""] [maxdepth=""]>
</source>

=== 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é.

; 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).
: 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).

; 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.

== 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 ===

<source lang="ovml">
<OFSitemapCustomNodeId node="" [basenode=""] [saveas=""]>
</source>

=== 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 ===

<source lang="ovml">
<OFSitemapCustomNodeId node="bab_Articles" saveas="CustomNodeId">
<OFSitemapMenu basenode="<OVCustomNodeId>">
</source>

== 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 ===

<source lang="ovml">
<OFPreviousArticle articleid="" [topicid=""] [excludetopicid=""] [archive=""] [orderby=""] [order=""] [topicorder=""] [delegationid=""]>
</source>

=== 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 ===

<source lang="ovml">
<OFNextArticle articleid="" [topicid=""] [excludetopicid=""] [archive=""] [orderby=""] [order=""] [topicorder=""] [delegationid=""]>
</source>

=== 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 ===

<source lang="ovml">
<OFWebStat name="" value="">
</source>

=== 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 ===

<source lang="ovml">
<OCArticle articleid="<OVarticleid>">

<OFWebStat name="bab_articles" value="<OVarticleid>">
</OCArticle>
</source>

== OFAddStylesheet ==

''Depuis Ovidentia '''7.5.93'''''

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

=== Syntaxe ===

<source lang="ovml">
<OFAddStylesheet file="">
</source>

=== Paramètres ===

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

= Les containers OvML =

La syntaxe des containers est comme suit :

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

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 ===

<source lang="ovml">
<OCxxxx expr1="" expr2="">...</OCxxxx>
</source>

=== Paramètres ===

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

=== Exemple ===

<source lang="ovml">
<OFPutVar name="BAB_SESS_LOGGED">
<OCIfEqual expr1="<BAB_SESS_LOGGED>" expr2="1">
Vous êtes connecté !
</OCIfEqual>
</source>

== 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 ===

<source lang="ovml">
<OCxxxx name="">...</OCxxxx>
</source>

=== Paramètres ===

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

=== Exemple ===

<source lang="ovml">
<OCIfIsSet name="variable">
Ce texte ne sera pas affiché.
</OCIfIsSet>

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

== OCIfUserMemberOfGroups ==

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

=== Syntaxe ===

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

=== 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 ===

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

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

== OCRecentFiles ==

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

=== Syntaxe ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

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

== OCRecentComments ==

Liste les derniers commentaires d'articles.

=== Syntaxe ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCArticleCategoryNext>...</OCArticleCategoryNext>
</source>

=== Variables ===

Idendiques à celles du container [[#OCArticleCategories|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 ===

<source lang="ovml">
<OCArticleCategoryPrevious>...</OCArticleCategoryPrevious>
</source>

=== Variables ===

Identiques à celles du container [[#OCArticleCategories|OCArticleCategories]].

== OCParentsArticleCategory ==

Liste des catégories de sujets parents.

=== Syntaxe ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 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 ===

<source lang="ovml">
<OCArticleTopicNext>...</OCArticleTopicNext>
</source>

=== Variables ===

Identiques à celles du container [[#OCArticleTopics|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 ===

<source lang="ovml">
<OCArticleTopicPrevious>....</OCArticleTopicPrevious>
</source>

=== Variables ===

Idem que ceux du container [[#OCArticleTopics|OCArticleTopics]].

== OCArticleTopic ==

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

=== Syntaxe ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCArticleTopic topicname="essai">...</OCArticleTopic>
</source>
Recherche tous les thèmes dont l'utilisateur a le droit et ayant pour nom "essai"

<source lang="ovml">
<OCArticleTopic topicid="1,2,3" topicname="essai">...</OCArticleTopic>
</source>
Recherche les thèmes d'id 1,2 3 ayant pour nom essai.

<source lang="ovml">
<OCArticleTopic topicid="1,2,3" topicname="%essai">...</OCArticleTopic>
</source>
Recherche les thèmes d'id 1,2 3 et dont le nom se termine par essai

<source lang="ovml">
<OCArticleTopic topicid="1,2,3" topicname="essai%">...</OCArticleTopic>
</source>
Recherche les thèmes d'id 1,2 3 et dont le nom commence par essai

<source lang="ovml">
<OCArticleTopic topicid="1,2,3" topicname="%essai%">...</OCArticleTopic>
</source>
Recherche les thèmes d'id 1,2 3 et dont le nom contient la chaîne essai

== OCArticles ==

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

=== Syntaxe ===

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

=== Paramètres ===

; topicid ''(optionnel)''
: Permet de préciser les thèmes d'articles concernés
: Id du thème ou plusieurs Ids séparés par une virgule
: Si omis, le container liste les articles tout thème confondu

; excludetopicid ''(optionnel)''
: Permet de préciser les thèmes d'articles à exclure à la différence du paramètre topicid
: Id du thème ou plusieurs Ids séparés par une virgule

; archive ''(optionnel)''
: yes : Donne la liste des articles archivés
: no ''(par défaut)'' : Donne la liste des articles non archivés

; offset ''(optionnel)''
: "n" indique le nombre d'articles à ignorer à partir du début de la liste
: 0 ''(par défaut)'' : aucune article n'est ignoré

; rows ''(optionnel)''
: "n" combien il faut en prendre
: -1 ''(par défaut)'' : toutes les lignes sont prises

; order ''(optionnel)''
: asc : Ordonne les articles par ordre croissant en fonction de la date
: desc ''(par défaut)'' : Ordonne les articles par ordre décroissant en fonction de la date
: rand : Ordonne les articles aléatoirement

; orderby ''(optionnel)''
: Peut être couplé avec l'attribut order.
: creation : Ordonne les articles par ordre de création en fonction de la date
: publication : Ordonne les articles par ordre de publication en fonction de la date
: modification ''(par défaut)'' : Ordonne les articles par ordre de modification en fonction de la date
: rating : Ordonne les articles en fonction de la note moyenne attribuée dans les commentaires

; topicorder ''(optionnel)''
: yes : Utilise l'ordre défini par le gestionnaire du thème d'articles
: no ''(par défaut)'' : N'utilise l'ordre défini par le gestionnaire du thème d'articles

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

; imageheightmax ''(optionnel)''
: Valeur en pixels. Permet de préciser la hauteur maximum de l'image associée.
: Si omis, l'image n'est pas redimensionnée et garde sa taille d'origine.

; imagewidthmax ''(optionnel)''
: Valeur en pixels. Permet de préciser la largeur maximum de l'image associée.
: Si omis, l'image n'est pas redimensionnée et garde sa taille d'origine.

; minrating ''(optionnel)''
: Permet de filtrer les articles ayant une note moyenne dans les commentaires supérieure ou égale à la valeur fournie en paramètre
: Valeur numérique.

=== Variables ===

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

== OCArticleNext ==

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

=== Syntaxe ===

<source lang="ovml">
<OCArticleNext>...</OCArticleNext>
</source>

=== Variables ===

Identiques à celles du container [[#OCArticles|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 ===

<source lang="ovml">
<OCArticlePrevious>...</OCArticlePrevious>
</source>

=== Variables ===

Identiques à celles du container [[#OCArticles|OCArticles]].

== OCArticle ==

Donne les informations sur un article donné.

=== Syntaxe ===

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

=== 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 ===

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

== OCArticleFiles ==

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

=== Syntaxe ===

<source lang="ovml">
<OCArticleFiles articleid="">...</OCArticleFiles>
</source>

=== Paramètres ===

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

=== Variables ===

{| class="prettytable"
! Variable
! Valeur
|-
| OVArticleFileName
| Nom du fichier
|-
| OVArticleFileDescription
| Description du fichier
|-
| OVArticleFileUrlGet
| Url pour atteindre le fichier
|}

== OCForums ==

Liste des forums.

=== Syntaxe ===

<source lang="ovml">
<OCForums [forumid=""] [delegationid=""]>...</OCForums>
</source>

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCForumNext>...</OCForumNext>
</source>

=== Variables ===

Identiques à celles du container [[#OCForums|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 ===

<source lang="ovml">
<OCForumPrevious>...</OCForumPrevious>
</source>

=== Variables ===

Identiques à celles du container [[#OCForums|OCForums]].

== OCForum ==

Donne les informations sur un forum donné.

=== Syntaxe ===

<source lang="ovml">
<OCForum forumid="">...</OCForum>
</source>

=== Paramètres ===

; forumid :
: Id du forum

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCThread threadid="" [order=""]>...</OCThread>
</source>

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCPost postid="" [order=""]>...</OCPost>
</source>

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCPostFiles postid="">...</OCPost>
</source>

=== Paramètres ===

; postid
: Id de la contribution 

=== Variables ===

{| class="prettytable"
! Variable
! Valeur
|-
| OVPostFileName
| Nom du fichier
|-
| OVPostFileUrlGet
| Url pour atteindre le fichier
|}

== OCFolders ==

Liste les répertoires partageables.

=== Syntaxe ===

<source lang="ovml">
<OCFolders [folderid=""] [delegationid=""]>...</OCFolders>
</source>

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFolderNext>...</OCFolderNext>
</source>

=== Variables ===

Identique à celles du container [[#OCFolders|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 ===

<source lang="ovml">
<OCFolderPrevious>...</OCFolderPrevious>
</source>

=== Variables ===

Identique à celles du container [[#OCFolders|OCFolders]].

== OCFolder ==

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

=== Syntaxe ===

<source lang="ovml">
<OCFolder folderid="">...</OCFolder>
</source>

=== Paramètres ===

; folderid
: Id du répertoire

=== Variables ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 :'''
<source lang="ovml">
<a href="<OVFileUrl>&inl=1"><OVFileName></a>
</source>

=== Syntaxe ===

<source lang="ovml">
<OCFiles folderid="" rows="" offset="" [path=""]>...</OCFiles>
</source>

=== 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

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFileNext>...</OCFileNext>
</source>

=== Variables ===

Identiques à celles du container [[#OCFiles|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 ===

<source lang="ovml">
<OCFilePrevious>...</OCFilePrevious>
</source>

=== Variables ===

Identiques à celles du container [[#OCFolders|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 :'''
<source lang="ovml">
<a href="<OVFileUrl>&inl=1"><OVFileName></a>
</source>

=== Syntaxe ===

<source lang="ovml">
<OCFile fileid="">...</OCFile>
</source>

=== Paramètres ===

; fileid
: Id du fichier

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFileFields fileid="">...</OCFileFields>
</source>

=== Paramètres ===

; fileid
: Id du fichier

=== Variables ===

{| class="prettytable"
! Variable
! Valeur
|-
| OVFileFieldName
| Nom du champ
|-
| OVFileFieldValue
| Valeur du champ
|}

== OCFaqs ==

Donne la liste des Faqs.

=== Syntaxe ===

<source lang="ovml">
<OCFaqs [faqid=""] [delegationid=""]>...</OCFaqs>
</source>

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFaqNext>...</OCFaqNext>
</source>

=== Variables ===

Identiques à celles du container [[#OCFaqs|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 ===

<source lang="ovml">
<OCFaqPrevious>...</OCFaqPrevious>
</source>

=== Variables ===

Identiques à celles du container [[#OCFaqs|OCFaqs]].

== OCFaq ==

Donne les informations sur une Faq donnée.

=== Syntaxe ===

<source lang="ovml">
<OCFaq faqid="">...</OCFaq>
</source>

=== Paramètres ===

; faqid
: Id de la Faq

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFaqSubCategories faqid="" [delegationid=""]>...</OCFaqSubCategories>
</source>

=== Paramètres ===

; faqid
: Id de la faq

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

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFaqSubCategory faqsubcatid="">...</OCFaqSubCategory>
</source>

=== Paramètres ===

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

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFaqQuestions [faqid=""] [faqsubcatid=""]>...</OCFaqQuestions>
</source>

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFaqQuestionNext>...</OCFaqQuestionNext>
</source>

=== Variables ===

Identiques à celles du container [[#OCFaqQuestions|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 ===

<source lang="ovml">
<OCFaqQuestionPrevious>...</OCFaqQuestionPrevious>
</source>

=== Variables ===

Identiques à celles du container [[#OCFaqQuestions|OCFaqQuestions]].

== OCFaqQuestion ==

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

=== Syntaxe ===

<source lang="ovml">
<OCFaqQuestion questionid="">...</OCFaqQuestion>
</source>

=== Paramètres ===

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

=== Variables ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

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

== OCWaitingComments ==

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

=== Syntaxe ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCCalendarCategories [filter=""]>...</OCCalendarCategories>
</source>

=== Paramètres ===

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

=== Variables ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
| 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 ===

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

=== 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 ===

{| class="prettytable"
| 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)
|}

== OCDbDirectories ==

Liste les annuaires de base de données

=== Syntaxe ===

<source lang="ovml">
<OCDbDirectories [directoryid=""] [delegationid=""]>...</OCDbDirectories>
</source>

=== 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.

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCDbDirectory directoryid="" [type=""]>...</OCDbDirectory>
</source>

=== Paramètres ===

; directoryid
: Id de l'annuaire

; type ''(optionnel)''
: « database » ou « group », si omis, le container liste tous les annuaires.

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCDbDirectoryFields directoryid="" [all=""]>...</OCDbDirectoryFields>
</source>

=== 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 ===

{| class="prettytable"
! Variable
! Valeur
|-
| OVDirectoryFieldName
| Intitulé du champ
|-
| OVDirectoryFieldId
| Identifiant du champ
|}

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

{| class="prettytable"
! 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 ===

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

=== Paramètres ===

; directoryid
: Id de l'annuaire

; all ''(optionnel)''
: Ignoré si l'attribut '''fields''' est spécifié
: 1 : Donne tous les champs pour chaque membre
: 0 : Donne uniquement les champs choisis pour l'affichage lors de la configuration du l'annuaire
: Si omis, liste uniquement les champs choisis.

; fields ''(optionnel)''
: liste des identifiants des champs souhaités séparés par des virgules ( exemple "sn,givenname,email" )

; orderby ''(optionnel)''
: Identifiant du champ à utiliser pour ordonner la liste

; order ''(optionnel)''
: asc : ordonne par ordre croissant
: desc : ordonne par ordre décroissant

; like ''(optionnel)''
: Restreint la liste des membres ayant le champ commençant par ce motif ( exemple like="A" )

=== Variables ===

{| class="prettytable"
! 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
| <nowiki>Intitulé du champ ayant pour identifiant xxxxxxx ( ex <OVgivennameName> ) </nowiki>
|-
| OVxxxxxxValue
| <nowiki>Contenu du champ ayant pour identifiant xxxxxxx ( ex <OVgivennameValue> ) </nowiki>
|}

== OCDbDirectoryMemberFields ==

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

Liste les différents champs pour le membre courant.

=== Syntaxe ===

<source lang="ovml">
<OCDbDirectoryMemberFields>...</OCDbDirectoryMemberFields>
</source>

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCDbDirectoryEntry directoryid="" memberid="" userid="">...</OCDbDirectoryEntry>
</source>

=== 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 ===

{| class="prettytable"
! 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
| <nowiki>Intitulé du champ ayant pour identifiant xxxxxxx ( ex <OVgivennameName> ) </nowiki>
|-
| OVxxxxxxValue
| <nowiki>Contenu du champ ayant pour identifiant xxxxxxx ( ex <OVgivennameValue> ) </nowiki>
|-
| 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 ===

<source lang="ovml">
<OCDbDirectoryEntryFields>...</OCDbDirectoryEntryFields>
</source>

=== Variables ===

{| class="prettytable"
! Variable
! Valeur
|-
| OVDirectoryFieldName
| Intitulé du champ
|-
| OVDirectoryFieldValue
| Valeur du champ
|}

== OCDbDirectoryAcl ==

Liste les utilisateurs ayant des droits sur un annuaire.

=== Syntaxe ===

<source lang="ovml">
<OCDbDirectoryAcl directoryid="" type="">...</OCDbDirectoryAcl>
</source>

=== Paramètres ===

; directoryid
: Id de l'annuaire

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

=== Variables ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCDelegationItems delegationid="">...</OCDelegationItems>
</source>

=== Paramètres ===

; delegationid
: Id de la délégation

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCDelegationAdministrators delegationid="">...</OCDelegationAdministrators>
</source>

=== Paramètres ===

; delegationid
: Id de la délégation

=== Variables ===

{| class="prettytable"
! Variable
! Valeur
|-
| OVDelegationUserId
| Id de l'administrateur
|}

== OCDelegationsCategories ==

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

=== Syntaxe ===

<source lang="ovml">
<OCDelegationsCategories [categoryid=""]>....</OCDelegationsCategories>
</source>

=== Paramètres ===

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

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCDelegationsCategory [categoryid=""]>...</OCDelegationsCategory>
</source>

=== Paramètres ===

; categoryid
: Id de la délégation

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCTmSpaces>...</OCTmSpaces>
</source>

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCTmProjects spaceid="">...</OCTmProjects>
</source>

=== Paramètres ===

; spaceid
: Id de l'espace de projets

=== Variables ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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.

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

=== 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 ===

{| class="prettytable"
! Variable
! Valeur
|-
| OVEntityId
| Identifiant (entier) de l'entité
|-
| OVEntityName
| Nom de l'entité
|-
| OVEntityDescription
| Description de l'entité
|}

== OCMultipages ==

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

=== Syntaxe ===

<source lang="ovml">
<OCMultipages total="" maxpages="" perpage="" currentpage="">...</OCMultipages>
</source>

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCSitemapEntries node="" [sitemap=""] [limit=""]>...</OCSitemapEntries>
</source>

=== 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...
: Si node n'est pas spécifié,

; 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 ===

{| 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
|}

== 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 ===

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

=== 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.

; 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 =====

{| 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
|}

= 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 !

== 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 ===

<source lang="ovml">
<OCAddon name="" param1="" param2="" ...>...</OCAddon>
</source>

=== 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 ===

<source lang="ovml">
<OFAddon name="" function="" param1="" ...>
</source>

=== 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éférence OvML

2013-06-05T08:27:26Z

Rodpec : /* Les fonctions OvML */

[[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.

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 :

<source lang="ovml">
<OVnom-de-la-variable>
</source>

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

<source lang="ovml">
<OFPutVar name="nbArticles" value="10">
</source>

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 :

<source lang="ovml">
<OVnbArticles>
</source>

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 :

<source lang="ovml">
<OFPutVar name="babSlogan">
</source>

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.

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

<source lang="ovml">
<OFIfNotIsSet name="page" value="1">
</source>

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 <code><OVxxxx></code>.

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.

<source lang="ovml">
<OVnbArticles saveas="TotalArticles">
</source>

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.

{| class="prettytable"
! Value
!
|-
| n
| Récupère les n premiers caractères du contenu de la variable
|}

<source lang="ovml">
<OVbabSlogan strlen="100">
</source>

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 :

<source lang="ovml">
<OVbabSlogan strlen="100,...">
</source>

== striptags ==

Supprime les tags HTML de la variable :

{| class="prettytable"
! Value
!
|-
| 1
| Supprime les tags HTML de la variable
|}

<source lang="ovml">
<OVbabSlogan striptags="1">
</source>

== htmlentities ==

{| class="prettytable"
! Value
!
|-
| 1
| <nowiki>Convertit les entities HTML ( < devient &lt; )</nowiki>
|-
| 2
| <nowiki>Convertit en inverse les entities HTML ( &lt; devient < )</nowiki>
|}

<source lang="ovml">
<OVbabSlogan htmlentities="1">
</source>

== stripslashes ==

Supprime les slashs doublés du contenu de la variable

{| class="prettytable"
! Value
!
|-
| 1
| Supprime les slashs doublés du contenu de la variable
|}

<source lang="ovml">
<OVbabSlogan stripslashes="1">
</source>

== urlencode ==

{| class="prettytable"
! Value
!
|-
| 1
| Encode la variable pour l'utilisation dans une url
|}

<source lang="ovml">
<OVbabSlogan urlencode="1">
</source>

== jsencode ==

{| class="prettytable"
! Value
!
|-
| 1
| Encode la variable pour l'utilisation dans du javascript
|}

<source lang="ovml">
<OVbabSlogan jsencode="1">
</source>

== strcase ==

{| class="prettytable"
! Value
!
|-
| upper
| Convertit le contenu de la variable en majuscule
|-
| lower
| Convertit le contenu de la variable en minuscule
|}

<source lang="ovml">
<OVbabSlogan strcase="upper">
</source>

== nlremove ==

{| class="prettytable"
! Value
!
|-
| 1
| Supprime les retours chariots
|}

<source lang="ovml">
<OVbabSlogan nlremove="1">
</source>

== trim ==

{| class="prettytable"
! 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
|}

<source lang="ovml">
<OVbabSlogan trim="all">
</source>

== nl2br ==

{| class="prettytable"
! Value
!
|-
| <div align="right">1</div>
| <nowiki>Transforme les retours chariots en </nowiki>
|}

<source lang="ovml">
<OVbabSlogan nl2br="1">
</source>

== sprintf ==

{| class="prettytable"
! Value
!
|-
| Voir la documentation PHP pour la fonction sprintf
| Retourne une chaîne formatée
|}

<source lang="ovml">
<OVMoney sprintf="%01.2f">
</source>

== date ==

Permet de formater une date Ovidentia

{| class="prettytable"
! 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"
|}

<source lang="ovml">
<OVArticleDate date="%d %j %m %Y">
</source>

'''Remarque :'''

<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.

<source lang="ovml">
<OVbabCurrentDate date="%D %j %M" strcase="lower">
</source>

== author ==

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

{| class="prettytable"
! Value
!
|-
| %F
| Prénom
|-
| %M
| Deuxième prénom
|-
| %L
| Nom
|}

<source lang="ovml">
<OVArticleAuthor author="%F %L" strcase="lower">
</source>

= Les fonctions OvML =

On reconnaît les fonctions par la syntaxe suivante :

<source lang="ovml">
<OFxxxx ...>
</source>

Les fonctions OvML disponibles sont :

== OFTranslate ==

''Depuis Ovidentia '''7.2.90'''''

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>
</source>

'''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>
</source>

=== Syntaxe ===

<source lang="ovml">
<OFTranslate text="" [lang=""]>
</source>

=== 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

== OFPutVar ==

Permet de déclarer une nouvelle variable.

=== Syntaxe ===

<source lang="ovml">
<OFPutVar name="" [value=""]>
</source>

=== Paramètres ===

; name
: Nom de la variable

; value ''(optionnel)''
: Valeur à affecter à la variable

== OFGetVar ==

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

=== Syntaxe ===

<source lang="ovml">
<OFGetVar name="">
</source>

=== Paramètres ===

; name
: Nom de la variable à afficher

== OFIfNotIsSet ==

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

=== Syntaxe ===

<source lang="ovml">
<OFIfNotIsSet name="" [value=""]>
</source>

=== Paramètres ===

; name
: Nom de la variable

; value ''(optionnel)''
: Valeur à affecter à la variable

== OFInclude ==

Permet d'inclure un autre fichier OVML

=== Syntaxe ===

<source lang="ovml">
<OFInclude file="" [cache=""]>
</source>

=== 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 ===

<source lang="ovml">
<OFUrlContent url="">
</source>

=== 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 ===

<source lang="ovml">
<OFRecurse>
</source>

=== 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>).

<source lang="ovml">
<ul>
<OCArticleCategories>
<li>
<OVCategoryName>
<ul>
<OFRecurse parentid="<OVCategoryId>">
<OCArticleTopics categoryid="<OVCategoryId>">
<li><OVTopicName></li>
</OCArticleTopics>
</ul>
</li>
</OCArticleCategories>
</ul>
</source>

== Opérateurs arithmétiques ==

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

<source lang="ovml">
<OFAOxxxxx expr1="X" expr2="Y">
</source>

<source lang="ovml">
<OFAOxxxxx expr1="10" expr2="50">
</source>

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

<source lang="ovml">
<OFAOxxxxx expr1="<OVTotal>" expr2="50">
</source>

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.

<source lang="ovml">
<OFAOxxxxx expr1="<OVTotal>" expr2="50" saveas="NewTotal">
</source>

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 :

=== OFAOAddition ===

Permet d’additionner expr1 et expr2.

==== Syntaxe ====

<source lang="ovml">
<OFAOAddition expr1="" expr2="">
</source>

==== Paramètres ====

; expr1
: Premier terme de l'addition

; expr2
: Second terme de l'addition

=== OFAOSubtraction ===

Permet de soustraire expr2 à expr1.

==== Syntaxe ====

<source lang="ovml">
<OFAOSubtraction expr1="" expr2="">
</source>

==== Paramètres ====

; expr1
: Premier terme de la soustraction

; expr2
: Second terme de la soustraction

==== Exemple ====

<source lang="ovml">
<OFAOSubtraction expr1="10" expr2="20">
</source>

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 ====

<source lang="ovml">
<OFAOMultiplication expr1="" expr2="">
</source>

==== Paramètres ====

; expr1
: Premier terme de la multiplication

; expr2
: Second terme de la multiplication

=== OFAODivision ===

Permet de diviser expr1 par expr2.

==== Syntaxe ====

<source lang="ovml">
<OFAODivision expr1="" expr2="">
</source>

==== Paramètres ====

; expr1
: Premier terme de la division

; expr2
: Second terme de la division

==== Exemple ====

<source lang="ovml">
<OFAODivision expr1="10" expr2="20">
</source>

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 ====

<source lang="ovml">
<OFAOModulus expr1="" expr2="">
</source>

==== Paramètres ====

; expr1
: Premier terme du modulo

; expr2
: Second terme du modulo

==== Exemple ====

<source lang="ovml">
<OFAOModulus expr1="10" expr2="20">
</source>

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 ===

<source lang="ovml">
<OFHeader value="">
</source>

=== Paramètres ===

; value
: Valeur du header à modifier

=== Exemple ===

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

== OFSetCookie ==

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

=== Syntaxe ===

<source lang="ovml">
<OFSetCookie name="" expire="" [value=""]>
</source>

=== 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 ===

<source lang="ovml">
<OFGetCookie name="">
</source>

=== 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 ===

<source lang="ovml">
<OFSetSessionVar name="" value="">
</source>

=== 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 ===

<source lang="ovml">
<OFSetSessionVar name="babSectionsType" value="15">
</source>

affichera toutes les sections du portail

<source lang="ovml">
<OFSetSessionVar name="babSectionsType" value="4">
</source>

affichera uniquement les sections personnalisées du portail

<source lang="ovml">
<OFSetSessionVar name="babSectionsType" value="10">
</source>

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

<source lang="ovml">
<OFSetSessionVar name="babOvmlCurrentDelegation" value="5">
</source>

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

<source lang="ovml">
<OFSetSessionVar name="babOvmlCurrentDelegation" value="0">
</source>

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 ===

<source lang="ovml">
<OFRequest name="" saveas="" [default=""]>
</source>

=== Paramètres ===

; name
: Nom du paramètre GET dont on souhaite récupérer la valeur

; 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 ===

<source lang="ovml">
<OFPost name="" saveas="" [default=""]>
</source>

=== Paramètres ===

; name
: Nom du paramètre POST dont on souhaite récupérer la valeur

; 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 ===

<source lang="ovml">
<OFGet name="" saveas="" [default=""]>
</source>

=== Paramètres ===

; name
: Nom du paramètre GET dont on souhaite récupérer la valeur

; 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 ===

<source lang="ovml">
<OFSitemapPosition [sitemap=""] [basenode=""] [node=""] [keeplastknown=""]>
</source>

=== Paramètres ===

; 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 ===

<source lang="ovml">
<OFSitemapMenu [sitemap=""] [basenode=""] [selectednode=""] [keeplastknown=""] [maxdepth=""]>
</source>

=== 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é.

; 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).
: 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).

; 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.

== 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 ===

<source lang="ovml">
<OFSitemapCustomNodeId node="" [basenode=""] [saveas=""]>
</source>

=== 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 ===

<source lang="ovml">
<OFSitemapCustomNodeId node="bab_Articles" saveas="CustomNodeId">
<OFSitemapMenu basenode="<OVCustomNodeId>">
</source>

== 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 ===

<source lang="ovml">
<OFPreviousArticle articleid="" [topicid=""] [excludetopicid=""] [archive=""] [orderby=""] [order=""] [topicorder=""] [delegationid=""]>
</source>

=== 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 ===

<source lang="ovml">
<OFNextArticle articleid="" [topicid=""] [excludetopicid=""] [archive=""] [orderby=""] [order=""] [topicorder=""] [delegationid=""]>
</source>

=== 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 ===

<source lang="ovml">
<OFWebStat name="" value="">
</source>

=== 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 ===

<source lang="ovml">
<OCArticle articleid="<OVarticleid>">

<OFWebStat name="bab_articles" value="<OVarticleid>">
</OCArticle>
</source>

== OFAddStylesheet ==

''Depuis Ovidentia '''7.5.93'''''

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

=== Syntaxe ===

<source lang="ovml">
<OFAddStylesheet file="">
</source>

=== Paramètres ===

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

= Les containers OvML =

La syntaxe des containers est comme suit :

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

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 ===

<source lang="ovml">
<OCxxxx expr1="" expr2="">...</OCxxxx>
</source>

=== Paramètres ===

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

=== Exemple ===

<source lang="ovml">
<OFPutVar name="BAB_SESS_LOGGED">
<OCIfEqual expr1="<BAB_SESS_LOGGED>" expr2="1">
Vous êtes connecté !
</OCIfEqual>
</source>

== 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 ===

<source lang="ovml">
<OCxxxx name="">...</OCxxxx>
</source>

=== Paramètres ===

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

=== Exemple ===

<source lang="ovml">
<OCIfIsSet name="variable">
Ce texte ne sera pas affiché.
</OCIfIsSet>

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

== OCIfUserMemberOfGroups ==

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

=== Syntaxe ===

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

=== 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 ===

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

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

== OCRecentFiles ==

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

=== Syntaxe ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

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

== OCRecentComments ==

Liste les derniers commentaires d'articles.

=== Syntaxe ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCArticleCategoryNext>...</OCArticleCategoryNext>
</source>

=== Variables ===

Idendiques à celles du container [[#OCArticleCategories|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 ===

<source lang="ovml">
<OCArticleCategoryPrevious>...</OCArticleCategoryPrevious>
</source>

=== Variables ===

Identiques à celles du container [[#OCArticleCategories|OCArticleCategories]].

== OCParentsArticleCategory ==

Liste des catégories de sujets parents.

=== Syntaxe ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 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 ===

<source lang="ovml">
<OCArticleTopicNext>...</OCArticleTopicNext>
</source>

=== Variables ===

Identiques à celles du container [[#OCArticleTopics|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 ===

<source lang="ovml">
<OCArticleTopicPrevious>....</OCArticleTopicPrevious>
</source>

=== Variables ===

Idem que ceux du container [[#OCArticleTopics|OCArticleTopics]].

== OCArticleTopic ==

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

=== Syntaxe ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCArticleTopic topicname="essai">...</OCArticleTopic>
</source>
Recherche tous les thèmes dont l'utilisateur a le droit et ayant pour nom "essai"

<source lang="ovml">
<OCArticleTopic topicid="1,2,3" topicname="essai">...</OCArticleTopic>
</source>
Recherche les thèmes d'id 1,2 3 ayant pour nom essai.

<source lang="ovml">
<OCArticleTopic topicid="1,2,3" topicname="%essai">...</OCArticleTopic>
</source>
Recherche les thèmes d'id 1,2 3 et dont le nom se termine par essai

<source lang="ovml">
<OCArticleTopic topicid="1,2,3" topicname="essai%">...</OCArticleTopic>
</source>
Recherche les thèmes d'id 1,2 3 et dont le nom commence par essai

<source lang="ovml">
<OCArticleTopic topicid="1,2,3" topicname="%essai%">...</OCArticleTopic>
</source>
Recherche les thèmes d'id 1,2 3 et dont le nom contient la chaîne essai

== OCArticles ==

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

=== Syntaxe ===

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

=== Paramètres ===

; topicid ''(optionnel)''
: Permet de préciser les thèmes d'articles concernés
: Id du thème ou plusieurs Ids séparés par une virgule
: Si omis, le container liste les articles tout thème confondu

; excludetopicid ''(optionnel)''
: Permet de préciser les thèmes d'articles à exclure à la différence du paramètre topicid
: Id du thème ou plusieurs Ids séparés par une virgule

; archive ''(optionnel)''
: yes : Donne la liste des articles archivés
: no ''(par défaut)'' : Donne la liste des articles non archivés

; offset ''(optionnel)''
: "n" indique le nombre d'articles à ignorer à partir du début de la liste
: 0 ''(par défaut)'' : aucune article n'est ignoré

; rows ''(optionnel)''
: "n" combien il faut en prendre
: -1 ''(par défaut)'' : toutes les lignes sont prises

; order ''(optionnel)''
: asc : Ordonne les articles par ordre croissant en fonction de la date
: desc ''(par défaut)'' : Ordonne les articles par ordre décroissant en fonction de la date
: rand : Ordonne les articles aléatoirement

; orderby ''(optionnel)''
: Peut être couplé avec l'attribut order.
: creation : Ordonne les articles par ordre de création en fonction de la date
: publication : Ordonne les articles par ordre de publication en fonction de la date
: modification ''(par défaut)'' : Ordonne les articles par ordre de modification en fonction de la date
: rating : Ordonne les articles en fonction de la note moyenne attribuée dans les commentaires

; topicorder ''(optionnel)''
: yes : Utilise l'ordre défini par le gestionnaire du thème d'articles
: no ''(par défaut)'' : N'utilise l'ordre défini par le gestionnaire du thème d'articles

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

; imageheightmax ''(optionnel)''
: Valeur en pixels. Permet de préciser la hauteur maximum de l'image associée.
: Si omis, l'image n'est pas redimensionnée et garde sa taille d'origine.

; imagewidthmax ''(optionnel)''
: Valeur en pixels. Permet de préciser la largeur maximum de l'image associée.
: Si omis, l'image n'est pas redimensionnée et garde sa taille d'origine.

; minrating ''(optionnel)''
: Permet de filtrer les articles ayant une note moyenne dans les commentaires supérieure ou égale à la valeur fournie en paramètre
: Valeur numérique.

=== Variables ===

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

== OCArticleNext ==

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

=== Syntaxe ===

<source lang="ovml">
<OCArticleNext>...</OCArticleNext>
</source>

=== Variables ===

Identiques à celles du container [[#OCArticles|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 ===

<source lang="ovml">
<OCArticlePrevious>...</OCArticlePrevious>
</source>

=== Variables ===

Identiques à celles du container [[#OCArticles|OCArticles]].

== OCArticle ==

Donne les informations sur un article donné.

=== Syntaxe ===

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

=== 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 ===

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

== OCArticleFiles ==

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

=== Syntaxe ===

<source lang="ovml">
<OCArticleFiles articleid="">...</OCArticleFiles>
</source>

=== Paramètres ===

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

=== Variables ===

{| class="prettytable"
! Variable
! Valeur
|-
| OVArticleFileName
| Nom du fichier
|-
| OVArticleFileDescription
| Description du fichier
|-
| OVArticleFileUrlGet
| Url pour atteindre le fichier
|}

== OCForums ==

Liste des forums.

=== Syntaxe ===

<source lang="ovml">
<OCForums [forumid=""] [delegationid=""]>...</OCForums>
</source>

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCForumNext>...</OCForumNext>
</source>

=== Variables ===

Identiques à celles du container [[#OCForums|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 ===

<source lang="ovml">
<OCForumPrevious>...</OCForumPrevious>
</source>

=== Variables ===

Identiques à celles du container [[#OCForums|OCForums]].

== OCForum ==

Donne les informations sur un forum donné.

=== Syntaxe ===

<source lang="ovml">
<OCForum forumid="">...</OCForum>
</source>

=== Paramètres ===

; forumid :
: Id du forum

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCThread threadid="" [order=""]>...</OCThread>
</source>

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCPost postid="" [order=""]>...</OCPost>
</source>

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCPostFiles postid="">...</OCPost>
</source>

=== Paramètres ===

; postid
: Id de la contribution 

=== Variables ===

{| class="prettytable"
! Variable
! Valeur
|-
| OVPostFileName
| Nom du fichier
|-
| OVPostFileUrlGet
| Url pour atteindre le fichier
|}

== OCFolders ==

Liste les répertoires partageables.

=== Syntaxe ===

<source lang="ovml">
<OCFolders [folderid=""] [delegationid=""]>...</OCFolders>
</source>

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFolderNext>...</OCFolderNext>
</source>

=== Variables ===

Identique à celles du container [[#OCFolders|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 ===

<source lang="ovml">
<OCFolderPrevious>...</OCFolderPrevious>
</source>

=== Variables ===

Identique à celles du container [[#OCFolders|OCFolders]].

== OCFolder ==

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

=== Syntaxe ===

<source lang="ovml">
<OCFolder folderid="">...</OCFolder>
</source>

=== Paramètres ===

; folderid
: Id du répertoire

=== Variables ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 :'''
<source lang="ovml">
<a href="<OVFileUrl>&inl=1"><OVFileName></a>
</source>

=== Syntaxe ===

<source lang="ovml">
<OCFiles folderid="" rows="" offset="" [path=""]>...</OCFiles>
</source>

=== 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

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFileNext>...</OCFileNext>
</source>

=== Variables ===

Identiques à celles du container [[#OCFiles|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 ===

<source lang="ovml">
<OCFilePrevious>...</OCFilePrevious>
</source>

=== Variables ===

Identiques à celles du container [[#OCFolders|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 :'''
<source lang="ovml">
<a href="<OVFileUrl>&inl=1"><OVFileName></a>
</source>

=== Syntaxe ===

<source lang="ovml">
<OCFile fileid="">...</OCFile>
</source>

=== Paramètres ===

; fileid
: Id du fichier

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFileFields fileid="">...</OCFileFields>
</source>

=== Paramètres ===

; fileid
: Id du fichier

=== Variables ===

{| class="prettytable"
! Variable
! Valeur
|-
| OVFileFieldName
| Nom du champ
|-
| OVFileFieldValue
| Valeur du champ
|}

== OCFaqs ==

Donne la liste des Faqs.

=== Syntaxe ===

<source lang="ovml">
<OCFaqs [faqid=""] [delegationid=""]>...</OCFaqs>
</source>

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFaqNext>...</OCFaqNext>
</source>

=== Variables ===

Identiques à celles du container [[#OCFaqs|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 ===

<source lang="ovml">
<OCFaqPrevious>...</OCFaqPrevious>
</source>

=== Variables ===

Identiques à celles du container [[#OCFaqs|OCFaqs]].

== OCFaq ==

Donne les informations sur une Faq donnée.

=== Syntaxe ===

<source lang="ovml">
<OCFaq faqid="">...</OCFaq>
</source>

=== Paramètres ===

; faqid
: Id de la Faq

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFaqSubCategories faqid="" [delegationid=""]>...</OCFaqSubCategories>
</source>

=== Paramètres ===

; faqid
: Id de la faq

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

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFaqSubCategory faqsubcatid="">...</OCFaqSubCategory>
</source>

=== Paramètres ===

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

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFaqQuestions [faqid=""] [faqsubcatid=""]>...</OCFaqQuestions>
</source>

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFaqQuestionNext>...</OCFaqQuestionNext>
</source>

=== Variables ===

Identiques à celles du container [[#OCFaqQuestions|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 ===

<source lang="ovml">
<OCFaqQuestionPrevious>...</OCFaqQuestionPrevious>
</source>

=== Variables ===

Identiques à celles du container [[#OCFaqQuestions|OCFaqQuestions]].

== OCFaqQuestion ==

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

=== Syntaxe ===

<source lang="ovml">
<OCFaqQuestion questionid="">...</OCFaqQuestion>
</source>

=== Paramètres ===

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

=== Variables ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

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

== OCWaitingComments ==

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

=== Syntaxe ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCCalendarCategories [filter=""]>...</OCCalendarCategories>
</source>

=== Paramètres ===

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

=== Variables ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
| 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 ===

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

=== 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 ===

{| class="prettytable"
| 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)
|}

== OCDbDirectories ==

Liste les annuaires de base de données

=== Syntaxe ===

<source lang="ovml">
<OCDbDirectories [directoryid=""] [delegationid=""]>...</OCDbDirectories>
</source>

=== 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.

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCDbDirectory directoryid="" [type=""]>...</OCDbDirectory>
</source>

=== Paramètres ===

; directoryid
: Id de l'annuaire

; type ''(optionnel)''
: « database » ou « group », si omis, le container liste tous les annuaires.

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCDbDirectoryFields directoryid="" [all=""]>...</OCDbDirectoryFields>
</source>

=== 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 ===

{| class="prettytable"
! Variable
! Valeur
|-
| OVDirectoryFieldName
| Intitulé du champ
|-
| OVDirectoryFieldId
| Identifiant du champ
|}

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

{| class="prettytable"
! 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 ===

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

=== Paramètres ===

; directoryid
: Id de l'annuaire

; all ''(optionnel)''
: Ignoré si l'attribut '''fields''' est spécifié
: 1 : Donne tous les champs pour chaque membre
: 0 : Donne uniquement les champs choisis pour l'affichage lors de la configuration du l'annuaire
: Si omis, liste uniquement les champs choisis.

; fields ''(optionnel)''
: liste des identifiants des champs souhaités séparés par des virgules ( exemple "sn,givenname,email" )

; orderby ''(optionnel)''
: Identifiant du champ à utiliser pour ordonner la liste

; order ''(optionnel)''
: asc : ordonne par ordre croissant
: desc : ordonne par ordre décroissant

; like ''(optionnel)''
: Restreint la liste des membres ayant le champ commençant par ce motif ( exemple like="A" )

=== Variables ===

{| class="prettytable"
! 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
| <nowiki>Intitulé du champ ayant pour identifiant xxxxxxx ( ex <OVgivennameName> ) </nowiki>
|-
| OVxxxxxxValue
| <nowiki>Contenu du champ ayant pour identifiant xxxxxxx ( ex <OVgivennameValue> ) </nowiki>
|}

== OCDbDirectoryMemberFields ==

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

Liste les différents champs pour le membre courant.

=== Syntaxe ===

<source lang="ovml">
<OCDbDirectoryMemberFields>...</OCDbDirectoryMemberFields>
</source>

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCDbDirectoryEntry directoryid="" memberid="" userid="">...</OCDbDirectoryEntry>
</source>

=== 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 ===

{| class="prettytable"
! 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
| <nowiki>Intitulé du champ ayant pour identifiant xxxxxxx ( ex <OVgivennameName> ) </nowiki>
|-
| OVxxxxxxValue
| <nowiki>Contenu du champ ayant pour identifiant xxxxxxx ( ex <OVgivennameValue> ) </nowiki>
|-
| 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 ===

<source lang="ovml">
<OCDbDirectoryEntryFields>...</OCDbDirectoryEntryFields>
</source>

=== Variables ===

{| class="prettytable"
! Variable
! Valeur
|-
| OVDirectoryFieldName
| Intitulé du champ
|-
| OVDirectoryFieldValue
| Valeur du champ
|}

== OCDbDirectoryAcl ==

Liste les utilisateurs ayant des droits sur un annuaire.

=== Syntaxe ===

<source lang="ovml">
<OCDbDirectoryAcl directoryid="" type="">...</OCDbDirectoryAcl>
</source>

=== Paramètres ===

; directoryid
: Id de l'annuaire

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

=== Variables ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCDelegationItems delegationid="">...</OCDelegationItems>
</source>

=== Paramètres ===

; delegationid
: Id de la délégation

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCDelegationAdministrators delegationid="">...</OCDelegationAdministrators>
</source>

=== Paramètres ===

; delegationid
: Id de la délégation

=== Variables ===

{| class="prettytable"
! Variable
! Valeur
|-
| OVDelegationUserId
| Id de l'administrateur
|}

== OCDelegationsCategories ==

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

=== Syntaxe ===

<source lang="ovml">
<OCDelegationsCategories [categoryid=""]>....</OCDelegationsCategories>
</source>

=== Paramètres ===

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

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCDelegationsCategory [categoryid=""]>...</OCDelegationsCategory>
</source>

=== Paramètres ===

; categoryid
: Id de la délégation

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCTmSpaces>...</OCTmSpaces>
</source>

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCTmProjects spaceid="">...</OCTmProjects>
</source>

=== Paramètres ===

; spaceid
: Id de l'espace de projets

=== Variables ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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.

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

=== 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 ===

{| class="prettytable"
! Variable
! Valeur
|-
| OVEntityId
| Identifiant (entier) de l'entité
|-
| OVEntityName
| Nom de l'entité
|-
| OVEntityDescription
| Description de l'entité
|}

== OCMultipages ==

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

=== Syntaxe ===

<source lang="ovml">
<OCMultipages total="" maxpages="" perpage="" currentpage="">...</OCMultipages>
</source>

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCSitemapEntries node="" [sitemap=""] [limit=""]>...</OCSitemapEntries>
</source>

=== 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...
: Si node n'est pas spécifié,

; 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 ===

{| 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
|}

== 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 ===

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

=== 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.

; 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 =====

{| 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
|}

= 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 !

== 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 ===

<source lang="ovml">
<OCAddon name="" param1="" param2="" ...>...</OCAddon>
</source>

=== 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 ===

<source lang="ovml">
<OFAddon name="" function="" param1="" ...>
</source>

=== 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éférence OvML

2013-06-05T08:24:32Z

Rodpec : /* OFWebStat */

[[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.

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 :

<source lang="ovml">
<OVnom-de-la-variable>
</source>

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

<source lang="ovml">
<OFPutVar name="nbArticles" value="10">
</source>

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 :

<source lang="ovml">
<OVnbArticles>
</source>

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 :

<source lang="ovml">
<OFPutVar name="babSlogan">
</source>

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.

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

<source lang="ovml">
<OFIfNotIsSet name="page" value="1">
</source>

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 <code><OVxxxx></code>.

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.

<source lang="ovml">
<OVnbArticles saveas="TotalArticles">
</source>

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.

{| class="prettytable"
! Value
!
|-
| n
| Récupère les n premiers caractères du contenu de la variable
|}

<source lang="ovml">
<OVbabSlogan strlen="100">
</source>

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 :

<source lang="ovml">
<OVbabSlogan strlen="100,...">
</source>

== striptags ==

Supprime les tags HTML de la variable :

{| class="prettytable"
! Value
!
|-
| 1
| Supprime les tags HTML de la variable
|}

<source lang="ovml">
<OVbabSlogan striptags="1">
</source>

== htmlentities ==

{| class="prettytable"
! Value
!
|-
| 1
| <nowiki>Convertit les entities HTML ( < devient &lt; )</nowiki>
|-
| 2
| <nowiki>Convertit en inverse les entities HTML ( &lt; devient < )</nowiki>
|}

<source lang="ovml">
<OVbabSlogan htmlentities="1">
</source>

== stripslashes ==

Supprime les slashs doublés du contenu de la variable

{| class="prettytable"
! Value
!
|-
| 1
| Supprime les slashs doublés du contenu de la variable
|}

<source lang="ovml">
<OVbabSlogan stripslashes="1">
</source>

== urlencode ==

{| class="prettytable"
! Value
!
|-
| 1
| Encode la variable pour l'utilisation dans une url
|}

<source lang="ovml">
<OVbabSlogan urlencode="1">
</source>

== jsencode ==

{| class="prettytable"
! Value
!
|-
| 1
| Encode la variable pour l'utilisation dans du javascript
|}

<source lang="ovml">
<OVbabSlogan jsencode="1">
</source>

== strcase ==

{| class="prettytable"
! Value
!
|-
| upper
| Convertit le contenu de la variable en majuscule
|-
| lower
| Convertit le contenu de la variable en minuscule
|}

<source lang="ovml">
<OVbabSlogan strcase="upper">
</source>

== nlremove ==

{| class="prettytable"
! Value
!
|-
| 1
| Supprime les retours chariots
|}

<source lang="ovml">
<OVbabSlogan nlremove="1">
</source>

== trim ==

{| class="prettytable"
! 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
|}

<source lang="ovml">
<OVbabSlogan trim="all">
</source>

== nl2br ==

{| class="prettytable"
! Value
!
|-
| <div align="right">1</div>
| <nowiki>Transforme les retours chariots en </nowiki>
|}

<source lang="ovml">
<OVbabSlogan nl2br="1">
</source>

== sprintf ==

{| class="prettytable"
! Value
!
|-
| Voir la documentation PHP pour la fonction sprintf
| Retourne une chaîne formatée
|}

<source lang="ovml">
<OVMoney sprintf="%01.2f">
</source>

== date ==

Permet de formater une date Ovidentia

{| class="prettytable"
! 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"
|}

<source lang="ovml">
<OVArticleDate date="%d %j %m %Y">
</source>

'''Remarque :'''

<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.

<source lang="ovml">
<OVbabCurrentDate date="%D %j %M" strcase="lower">
</source>

== author ==

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

{| class="prettytable"
! Value
!
|-
| %F
| Prénom
|-
| %M
| Deuxième prénom
|-
| %L
| Nom
|}

<source lang="ovml">
<OVArticleAuthor author="%F %L" strcase="lower">
</source>

= Les fonctions OvML =

On reconnaît les fonctions par la syntaxe suivante :

<source lang="ovml">
<OFxxxx ...>
</source>

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 <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>
</source>

'''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>
</source>

=== Syntaxe ===

<source lang="ovml">
<OFTranslate text="" [lang=""]>
</source>

=== 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

== OFPutVar ==

Permet de déclarer une nouvelle variable.

=== Syntaxe ===

<source lang="ovml">
<OFPutVar name="" [value=""]>
</source>

=== Paramètres ===

; name
: Nom de la variable

; value ''(optionnel)''
: Valeur à affecter à la variable

== OFGetVar ==

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

=== Syntaxe ===

<source lang="ovml">
<OFGetVar name="">
</source>

=== Paramètres ===

; name
: Nom de la variable à afficher

== OFIfNotIsSet ==

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

=== Syntaxe ===

<source lang="ovml">
<OFIfNotIsSet name="" [value=""]>
</source>

=== Paramètres ===

; name
: Nom de la variable

; value ''(optionnel)''
: Valeur à affecter à la variable

== OFInclude ==

Permet d'inclure un autre fichier OVML

=== Syntaxe ===

<source lang="ovml">
<OFInclude file="" [cache=""]>
</source>

=== 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 ===

<source lang="ovml">
<OFUrlContent url="">
</source>

=== 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 ===

<source lang="ovml">
<OFRecurse>
</source>

=== 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>).

<source lang="ovml">
<ul>
<OCArticleCategories>
<li>
<OVCategoryName>
<ul>
<OFRecurse parentid="<OVCategoryId>">
<OCArticleTopics categoryid="<OVCategoryId>">
<li><OVTopicName></li>
</OCArticleTopics>
</ul>
</li>
</OCArticleCategories>
</ul>
</source>

== Opérateurs arithmétiques ==

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

<source lang="ovml">
<OFAOxxxxx expr1="X" expr2="Y">
</source>

<source lang="ovml">
<OFAOxxxxx expr1="10" expr2="50">
</source>

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

<source lang="ovml">
<OFAOxxxxx expr1="<OVTotal>" expr2="50">
</source>

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.

<source lang="ovml">
<OFAOxxxxx expr1="<OVTotal>" expr2="50" saveas="NewTotal">
</source>

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 :

=== OFAOAddition ===

Permet d’additionner expr1 et expr2.

==== Syntaxe ====

<source lang="ovml">
<OFAOAddition expr1="" expr2="">
</source>

==== Paramètres ====

; expr1
: Premier terme de l'addition

; expr2
: Second terme de l'addition

=== OFAOSubtraction ===

Permet de soustraire expr2 à expr1.

==== Syntaxe ====

<source lang="ovml">
<OFAOSubtraction expr1="" expr2="">
</source>

==== Paramètres ====

; expr1
: Premier terme de la soustraction

; expr2
: Second terme de la soustraction

==== Exemple ====

<source lang="ovml">
<OFAOSubtraction expr1="10" expr2="20">
</source>

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 ====

<source lang="ovml">
<OFAOMultiplication expr1="" expr2="">
</source>

==== Paramètres ====

; expr1
: Premier terme de la multiplication

; expr2
: Second terme de la multiplication

=== OFAODivision ===

Permet de diviser expr1 par expr2.

==== Syntaxe ====

<source lang="ovml">
<OFAODivision expr1="" expr2="">
</source>

==== Paramètres ====

; expr1
: Premier terme de la division

; expr2
: Second terme de la division

==== Exemple ====

<source lang="ovml">
<OFAODivision expr1="10" expr2="20">
</source>

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 ====

<source lang="ovml">
<OFAOModulus expr1="" expr2="">
</source>

==== Paramètres ====

; expr1
: Premier terme du modulo

; expr2
: Second terme du modulo

==== Exemple ====

<source lang="ovml">
<OFAOModulus expr1="10" expr2="20">
</source>

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 ===

<source lang="ovml">
<OFHeader value="">
</source>

=== Paramètres ===

; value
: Valeur du header à modifier

=== Exemple ===

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

== OFSetCookie ==

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

=== Syntaxe ===

<source lang="ovml">
<OFSetCookie name="" expire="" [value=""]>
</source>

=== 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 ===

<source lang="ovml">
<OFGetCookie name="">
</source>

=== 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 ===

<source lang="ovml">
<OFSetSessionVar name="" value="">
</source>

=== 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 ===

<source lang="ovml">
<OFSetSessionVar name="babSectionsType" value="15">
</source>

affichera toutes les sections du portail

<source lang="ovml">
<OFSetSessionVar name="babSectionsType" value="4">
</source>

affichera uniquement les sections personnalisées du portail

<source lang="ovml">
<OFSetSessionVar name="babSectionsType" value="10">
</source>

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

<source lang="ovml">
<OFSetSessionVar name="babOvmlCurrentDelegation" value="5">
</source>

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

<source lang="ovml">
<OFSetSessionVar name="babOvmlCurrentDelegation" value="0">
</source>

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 ===

<source lang="ovml">
<OFRequest name="" saveas="" [default=""]>
</source>

=== Paramètres ===

; name
: Nom du paramètre GET dont on souhaite récupérer la valeur

; 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 ===

<source lang="ovml">
<OFPost name="" saveas="" [default=""]>
</source>

=== Paramètres ===

; name
: Nom du paramètre POST dont on souhaite récupérer la valeur

; 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 ===

<source lang="ovml">
<OFGet name="" saveas="" [default=""]>
</source>

=== Paramètres ===

; name
: Nom du paramètre GET dont on souhaite récupérer la valeur

; 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 ===

<source lang="ovml">
<OFSitemapPosition [sitemap=""] [basenode=""] [node=""] [keeplastknown=""]>
</source>

=== Paramètres ===

; 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 ===

<source lang="ovml">
<OFSitemapMenu [sitemap=""] [basenode=""] [selectednode=""] [keeplastknown=""] [maxdepth=""]>
</source>

=== 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é.

; 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).
: 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).

; 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.

== 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 ===

<source lang="ovml">
<OFSitemapCustomNodeId node="" [basenode=""] [saveas=""]>
</source>

=== 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 ===

<source lang="ovml">
<OFSitemapCustomNodeId node="bab_Articles" saveas="CustomNodeId">
<OFSitemapMenu basenode="<OVCustomNodeId>">
</source>

== 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 ===

<source lang="ovml">
<OFPreviousArticle articleid="" [topicid=""] [excludetopicid=""] [archive=""] [orderby=""] [order=""] [topicorder=""] [delegationid=""]>
</source>

=== 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 ===

<source lang="ovml">
<OFNextArticle articleid="" [topicid=""] [excludetopicid=""] [archive=""] [orderby=""] [order=""] [topicorder=""] [delegationid=""]>
</source>

=== 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 ===

<source lang="ovml">
<OFWebStat name="" value="">
</source>

=== 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 ===

<source lang="ovml">
<OCArticle articleid="<OVarticleid>">

<OFWebStat name="bab_articles" value="<OVarticleid>">
</OCArticle>
</source>

== OFAddStylesheet ==

''Depuis Ovidentia '''7.5.93'''''

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

=== Syntaxe ===

<source lang="ovml">
<OFAddStylesheet file="">
</source>

=== Paramètres ===

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

= Les containers OvML =

La syntaxe des containers est comme suit :

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

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 ===

<source lang="ovml">
<OCxxxx expr1="" expr2="">...</OCxxxx>
</source>

=== Paramètres ===

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

=== Exemple ===

<source lang="ovml">
<OFPutVar name="BAB_SESS_LOGGED">
<OCIfEqual expr1="<BAB_SESS_LOGGED>" expr2="1">
Vous êtes connecté !
</OCIfEqual>
</source>

== 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 ===

<source lang="ovml">
<OCxxxx name="">...</OCxxxx>
</source>

=== Paramètres ===

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

=== Exemple ===

<source lang="ovml">
<OCIfIsSet name="variable">
Ce texte ne sera pas affiché.
</OCIfIsSet>

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

== OCIfUserMemberOfGroups ==

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

=== Syntaxe ===

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

=== 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 ===

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

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

== OCRecentFiles ==

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

=== Syntaxe ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

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

== OCRecentComments ==

Liste les derniers commentaires d'articles.

=== Syntaxe ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCArticleCategoryNext>...</OCArticleCategoryNext>
</source>

=== Variables ===

Idendiques à celles du container [[#OCArticleCategories|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 ===

<source lang="ovml">
<OCArticleCategoryPrevious>...</OCArticleCategoryPrevious>
</source>

=== Variables ===

Identiques à celles du container [[#OCArticleCategories|OCArticleCategories]].

== OCParentsArticleCategory ==

Liste des catégories de sujets parents.

=== Syntaxe ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 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 ===

<source lang="ovml">
<OCArticleTopicNext>...</OCArticleTopicNext>
</source>

=== Variables ===

Identiques à celles du container [[#OCArticleTopics|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 ===

<source lang="ovml">
<OCArticleTopicPrevious>....</OCArticleTopicPrevious>
</source>

=== Variables ===

Idem que ceux du container [[#OCArticleTopics|OCArticleTopics]].

== OCArticleTopic ==

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

=== Syntaxe ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCArticleTopic topicname="essai">...</OCArticleTopic>
</source>
Recherche tous les thèmes dont l'utilisateur a le droit et ayant pour nom "essai"

<source lang="ovml">
<OCArticleTopic topicid="1,2,3" topicname="essai">...</OCArticleTopic>
</source>
Recherche les thèmes d'id 1,2 3 ayant pour nom essai.

<source lang="ovml">
<OCArticleTopic topicid="1,2,3" topicname="%essai">...</OCArticleTopic>
</source>
Recherche les thèmes d'id 1,2 3 et dont le nom se termine par essai

<source lang="ovml">
<OCArticleTopic topicid="1,2,3" topicname="essai%">...</OCArticleTopic>
</source>
Recherche les thèmes d'id 1,2 3 et dont le nom commence par essai

<source lang="ovml">
<OCArticleTopic topicid="1,2,3" topicname="%essai%">...</OCArticleTopic>
</source>
Recherche les thèmes d'id 1,2 3 et dont le nom contient la chaîne essai

== OCArticles ==

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

=== Syntaxe ===

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

=== Paramètres ===

; topicid ''(optionnel)''
: Permet de préciser les thèmes d'articles concernés
: Id du thème ou plusieurs Ids séparés par une virgule
: Si omis, le container liste les articles tout thème confondu

; excludetopicid ''(optionnel)''
: Permet de préciser les thèmes d'articles à exclure à la différence du paramètre topicid
: Id du thème ou plusieurs Ids séparés par une virgule

; archive ''(optionnel)''
: yes : Donne la liste des articles archivés
: no ''(par défaut)'' : Donne la liste des articles non archivés

; offset ''(optionnel)''
: "n" indique le nombre d'articles à ignorer à partir du début de la liste
: 0 ''(par défaut)'' : aucune article n'est ignoré

; rows ''(optionnel)''
: "n" combien il faut en prendre
: -1 ''(par défaut)'' : toutes les lignes sont prises

; order ''(optionnel)''
: asc : Ordonne les articles par ordre croissant en fonction de la date
: desc ''(par défaut)'' : Ordonne les articles par ordre décroissant en fonction de la date
: rand : Ordonne les articles aléatoirement

; orderby ''(optionnel)''
: Peut être couplé avec l'attribut order.
: creation : Ordonne les articles par ordre de création en fonction de la date
: publication : Ordonne les articles par ordre de publication en fonction de la date
: modification ''(par défaut)'' : Ordonne les articles par ordre de modification en fonction de la date
: rating : Ordonne les articles en fonction de la note moyenne attribuée dans les commentaires

; topicorder ''(optionnel)''
: yes : Utilise l'ordre défini par le gestionnaire du thème d'articles
: no ''(par défaut)'' : N'utilise l'ordre défini par le gestionnaire du thème d'articles

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

; imageheightmax ''(optionnel)''
: Valeur en pixels. Permet de préciser la hauteur maximum de l'image associée.
: Si omis, l'image n'est pas redimensionnée et garde sa taille d'origine.

; imagewidthmax ''(optionnel)''
: Valeur en pixels. Permet de préciser la largeur maximum de l'image associée.
: Si omis, l'image n'est pas redimensionnée et garde sa taille d'origine.

; minrating ''(optionnel)''
: Permet de filtrer les articles ayant une note moyenne dans les commentaires supérieure ou égale à la valeur fournie en paramètre
: Valeur numérique.

=== Variables ===

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

== OCArticleNext ==

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

=== Syntaxe ===

<source lang="ovml">
<OCArticleNext>...</OCArticleNext>
</source>

=== Variables ===

Identiques à celles du container [[#OCArticles|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 ===

<source lang="ovml">
<OCArticlePrevious>...</OCArticlePrevious>
</source>

=== Variables ===

Identiques à celles du container [[#OCArticles|OCArticles]].

== OCArticle ==

Donne les informations sur un article donné.

=== Syntaxe ===

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

=== 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 ===

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

== OCArticleFiles ==

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

=== Syntaxe ===

<source lang="ovml">
<OCArticleFiles articleid="">...</OCArticleFiles>
</source>

=== Paramètres ===

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

=== Variables ===

{| class="prettytable"
! Variable
! Valeur
|-
| OVArticleFileName
| Nom du fichier
|-
| OVArticleFileDescription
| Description du fichier
|-
| OVArticleFileUrlGet
| Url pour atteindre le fichier
|}

== OCForums ==

Liste des forums.

=== Syntaxe ===

<source lang="ovml">
<OCForums [forumid=""] [delegationid=""]>...</OCForums>
</source>

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCForumNext>...</OCForumNext>
</source>

=== Variables ===

Identiques à celles du container [[#OCForums|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 ===

<source lang="ovml">
<OCForumPrevious>...</OCForumPrevious>
</source>

=== Variables ===

Identiques à celles du container [[#OCForums|OCForums]].

== OCForum ==

Donne les informations sur un forum donné.

=== Syntaxe ===

<source lang="ovml">
<OCForum forumid="">...</OCForum>
</source>

=== Paramètres ===

; forumid :
: Id du forum

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCThread threadid="" [order=""]>...</OCThread>
</source>

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCPost postid="" [order=""]>...</OCPost>
</source>

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCPostFiles postid="">...</OCPost>
</source>

=== Paramètres ===

; postid
: Id de la contribution 

=== Variables ===

{| class="prettytable"
! Variable
! Valeur
|-
| OVPostFileName
| Nom du fichier
|-
| OVPostFileUrlGet
| Url pour atteindre le fichier
|}

== OCFolders ==

Liste les répertoires partageables.

=== Syntaxe ===

<source lang="ovml">
<OCFolders [folderid=""] [delegationid=""]>...</OCFolders>
</source>

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFolderNext>...</OCFolderNext>
</source>

=== Variables ===

Identique à celles du container [[#OCFolders|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 ===

<source lang="ovml">
<OCFolderPrevious>...</OCFolderPrevious>
</source>

=== Variables ===

Identique à celles du container [[#OCFolders|OCFolders]].

== OCFolder ==

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

=== Syntaxe ===

<source lang="ovml">
<OCFolder folderid="">...</OCFolder>
</source>

=== Paramètres ===

; folderid
: Id du répertoire

=== Variables ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 :'''
<source lang="ovml">
<a href="<OVFileUrl>&inl=1"><OVFileName></a>
</source>

=== Syntaxe ===

<source lang="ovml">
<OCFiles folderid="" rows="" offset="" [path=""]>...</OCFiles>
</source>

=== 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

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFileNext>...</OCFileNext>
</source>

=== Variables ===

Identiques à celles du container [[#OCFiles|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 ===

<source lang="ovml">
<OCFilePrevious>...</OCFilePrevious>
</source>

=== Variables ===

Identiques à celles du container [[#OCFolders|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 :'''
<source lang="ovml">
<a href="<OVFileUrl>&inl=1"><OVFileName></a>
</source>

=== Syntaxe ===

<source lang="ovml">
<OCFile fileid="">...</OCFile>
</source>

=== Paramètres ===

; fileid
: Id du fichier

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFileFields fileid="">...</OCFileFields>
</source>

=== Paramètres ===

; fileid
: Id du fichier

=== Variables ===

{| class="prettytable"
! Variable
! Valeur
|-
| OVFileFieldName
| Nom du champ
|-
| OVFileFieldValue
| Valeur du champ
|}

== OCFaqs ==

Donne la liste des Faqs.

=== Syntaxe ===

<source lang="ovml">
<OCFaqs [faqid=""] [delegationid=""]>...</OCFaqs>
</source>

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFaqNext>...</OCFaqNext>
</source>

=== Variables ===

Identiques à celles du container [[#OCFaqs|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 ===

<source lang="ovml">
<OCFaqPrevious>...</OCFaqPrevious>
</source>

=== Variables ===

Identiques à celles du container [[#OCFaqs|OCFaqs]].

== OCFaq ==

Donne les informations sur une Faq donnée.

=== Syntaxe ===

<source lang="ovml">
<OCFaq faqid="">...</OCFaq>
</source>

=== Paramètres ===

; faqid
: Id de la Faq

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFaqSubCategories faqid="" [delegationid=""]>...</OCFaqSubCategories>
</source>

=== Paramètres ===

; faqid
: Id de la faq

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

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFaqSubCategory faqsubcatid="">...</OCFaqSubCategory>
</source>

=== Paramètres ===

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

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFaqQuestions [faqid=""] [faqsubcatid=""]>...</OCFaqQuestions>
</source>

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFaqQuestionNext>...</OCFaqQuestionNext>
</source>

=== Variables ===

Identiques à celles du container [[#OCFaqQuestions|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 ===

<source lang="ovml">
<OCFaqQuestionPrevious>...</OCFaqQuestionPrevious>
</source>

=== Variables ===

Identiques à celles du container [[#OCFaqQuestions|OCFaqQuestions]].

== OCFaqQuestion ==

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

=== Syntaxe ===

<source lang="ovml">
<OCFaqQuestion questionid="">...</OCFaqQuestion>
</source>

=== Paramètres ===

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

=== Variables ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

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

== OCWaitingComments ==

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

=== Syntaxe ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCCalendarCategories [filter=""]>...</OCCalendarCategories>
</source>

=== Paramètres ===

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

=== Variables ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
| 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 ===

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

=== 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 ===

{| class="prettytable"
| 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)
|}

== OCDbDirectories ==

Liste les annuaires de base de données

=== Syntaxe ===

<source lang="ovml">
<OCDbDirectories [directoryid=""] [delegationid=""]>...</OCDbDirectories>
</source>

=== 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.

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCDbDirectory directoryid="" [type=""]>...</OCDbDirectory>
</source>

=== Paramètres ===

; directoryid
: Id de l'annuaire

; type ''(optionnel)''
: « database » ou « group », si omis, le container liste tous les annuaires.

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCDbDirectoryFields directoryid="" [all=""]>...</OCDbDirectoryFields>
</source>

=== 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 ===

{| class="prettytable"
! Variable
! Valeur
|-
| OVDirectoryFieldName
| Intitulé du champ
|-
| OVDirectoryFieldId
| Identifiant du champ
|}

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

{| class="prettytable"
! 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 ===

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

=== Paramètres ===

; directoryid
: Id de l'annuaire

; all ''(optionnel)''
: Ignoré si l'attribut '''fields''' est spécifié
: 1 : Donne tous les champs pour chaque membre
: 0 : Donne uniquement les champs choisis pour l'affichage lors de la configuration du l'annuaire
: Si omis, liste uniquement les champs choisis.

; fields ''(optionnel)''
: liste des identifiants des champs souhaités séparés par des virgules ( exemple "sn,givenname,email" )

; orderby ''(optionnel)''
: Identifiant du champ à utiliser pour ordonner la liste

; order ''(optionnel)''
: asc : ordonne par ordre croissant
: desc : ordonne par ordre décroissant

; like ''(optionnel)''
: Restreint la liste des membres ayant le champ commençant par ce motif ( exemple like="A" )

=== Variables ===

{| class="prettytable"
! 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
| <nowiki>Intitulé du champ ayant pour identifiant xxxxxxx ( ex <OVgivennameName> ) </nowiki>
|-
| OVxxxxxxValue
| <nowiki>Contenu du champ ayant pour identifiant xxxxxxx ( ex <OVgivennameValue> ) </nowiki>
|}

== OCDbDirectoryMemberFields ==

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

Liste les différents champs pour le membre courant.

=== Syntaxe ===

<source lang="ovml">
<OCDbDirectoryMemberFields>...</OCDbDirectoryMemberFields>
</source>

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCDbDirectoryEntry directoryid="" memberid="" userid="">...</OCDbDirectoryEntry>
</source>

=== 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 ===

{| class="prettytable"
! 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
| <nowiki>Intitulé du champ ayant pour identifiant xxxxxxx ( ex <OVgivennameName> ) </nowiki>
|-
| OVxxxxxxValue
| <nowiki>Contenu du champ ayant pour identifiant xxxxxxx ( ex <OVgivennameValue> ) </nowiki>
|-
| 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 ===

<source lang="ovml">
<OCDbDirectoryEntryFields>...</OCDbDirectoryEntryFields>
</source>

=== Variables ===

{| class="prettytable"
! Variable
! Valeur
|-
| OVDirectoryFieldName
| Intitulé du champ
|-
| OVDirectoryFieldValue
| Valeur du champ
|}

== OCDbDirectoryAcl ==

Liste les utilisateurs ayant des droits sur un annuaire.

=== Syntaxe ===

<source lang="ovml">
<OCDbDirectoryAcl directoryid="" type="">...</OCDbDirectoryAcl>
</source>

=== Paramètres ===

; directoryid
: Id de l'annuaire

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

=== Variables ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCDelegationItems delegationid="">...</OCDelegationItems>
</source>

=== Paramètres ===

; delegationid
: Id de la délégation

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCDelegationAdministrators delegationid="">...</OCDelegationAdministrators>
</source>

=== Paramètres ===

; delegationid
: Id de la délégation

=== Variables ===

{| class="prettytable"
! Variable
! Valeur
|-
| OVDelegationUserId
| Id de l'administrateur
|}

== OCDelegationsCategories ==

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

=== Syntaxe ===

<source lang="ovml">
<OCDelegationsCategories [categoryid=""]>....</OCDelegationsCategories>
</source>

=== Paramètres ===

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

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCDelegationsCategory [categoryid=""]>...</OCDelegationsCategory>
</source>

=== Paramètres ===

; categoryid
: Id de la délégation

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCTmSpaces>...</OCTmSpaces>
</source>

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCTmProjects spaceid="">...</OCTmProjects>
</source>

=== Paramètres ===

; spaceid
: Id de l'espace de projets

=== Variables ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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.

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

=== 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 ===

{| class="prettytable"
! Variable
! Valeur
|-
| OVEntityId
| Identifiant (entier) de l'entité
|-
| OVEntityName
| Nom de l'entité
|-
| OVEntityDescription
| Description de l'entité
|}

== OCMultipages ==

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

=== Syntaxe ===

<source lang="ovml">
<OCMultipages total="" maxpages="" perpage="" currentpage="">...</OCMultipages>
</source>

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCSitemapEntries node="" [sitemap=""] [limit=""]>...</OCSitemapEntries>
</source>

=== 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...
: Si node n'est pas spécifié,

; 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 ===

{| 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
|}

== 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 ===

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

=== 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.

; 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 =====

{| 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
|}

= 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 !

== 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 ===

<source lang="ovml">
<OCAddon name="" param1="" param2="" ...>...</OCAddon>
</source>

=== 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 ===

<source lang="ovml">
<OFAddon name="" function="" param1="" ...>
</source>

=== 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éférence OvML

2013-06-05T08:20:31Z

Rodpec : /* OFAddStylesheet */

[[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.

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 :

<source lang="ovml">
<OVnom-de-la-variable>
</source>

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

<source lang="ovml">
<OFPutVar name="nbArticles" value="10">
</source>

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 :

<source lang="ovml">
<OVnbArticles>
</source>

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 :

<source lang="ovml">
<OFPutVar name="babSlogan">
</source>

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.

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

<source lang="ovml">
<OFIfNotIsSet name="page" value="1">
</source>

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 <code><OVxxxx></code>.

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.

<source lang="ovml">
<OVnbArticles saveas="TotalArticles">
</source>

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.

{| class="prettytable"
! Value
!
|-
| n
| Récupère les n premiers caractères du contenu de la variable
|}

<source lang="ovml">
<OVbabSlogan strlen="100">
</source>

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 :

<source lang="ovml">
<OVbabSlogan strlen="100,...">
</source>

== striptags ==

Supprime les tags HTML de la variable :

{| class="prettytable"
! Value
!
|-
| 1
| Supprime les tags HTML de la variable
|}

<source lang="ovml">
<OVbabSlogan striptags="1">
</source>

== htmlentities ==

{| class="prettytable"
! Value
!
|-
| 1
| <nowiki>Convertit les entities HTML ( < devient &lt; )</nowiki>
|-
| 2
| <nowiki>Convertit en inverse les entities HTML ( &lt; devient < )</nowiki>
|}

<source lang="ovml">
<OVbabSlogan htmlentities="1">
</source>

== stripslashes ==

Supprime les slashs doublés du contenu de la variable

{| class="prettytable"
! Value
!
|-
| 1
| Supprime les slashs doublés du contenu de la variable
|}

<source lang="ovml">
<OVbabSlogan stripslashes="1">
</source>

== urlencode ==

{| class="prettytable"
! Value
!
|-
| 1
| Encode la variable pour l'utilisation dans une url
|}

<source lang="ovml">
<OVbabSlogan urlencode="1">
</source>

== jsencode ==

{| class="prettytable"
! Value
!
|-
| 1
| Encode la variable pour l'utilisation dans du javascript
|}

<source lang="ovml">
<OVbabSlogan jsencode="1">
</source>

== strcase ==

{| class="prettytable"
! Value
!
|-
| upper
| Convertit le contenu de la variable en majuscule
|-
| lower
| Convertit le contenu de la variable en minuscule
|}

<source lang="ovml">
<OVbabSlogan strcase="upper">
</source>

== nlremove ==

{| class="prettytable"
! Value
!
|-
| 1
| Supprime les retours chariots
|}

<source lang="ovml">
<OVbabSlogan nlremove="1">
</source>

== trim ==

{| class="prettytable"
! 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
|}

<source lang="ovml">
<OVbabSlogan trim="all">
</source>

== nl2br ==

{| class="prettytable"
! Value
!
|-
| <div align="right">1</div>
| <nowiki>Transforme les retours chariots en </nowiki>
|}

<source lang="ovml">
<OVbabSlogan nl2br="1">
</source>

== sprintf ==

{| class="prettytable"
! Value
!
|-
| Voir la documentation PHP pour la fonction sprintf
| Retourne une chaîne formatée
|}

<source lang="ovml">
<OVMoney sprintf="%01.2f">
</source>

== date ==

Permet de formater une date Ovidentia

{| class="prettytable"
! 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"
|}

<source lang="ovml">
<OVArticleDate date="%d %j %m %Y">
</source>

'''Remarque :'''

<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.

<source lang="ovml">
<OVbabCurrentDate date="%D %j %M" strcase="lower">
</source>

== author ==

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

{| class="prettytable"
! Value
!
|-
| %F
| Prénom
|-
| %M
| Deuxième prénom
|-
| %L
| Nom
|}

<source lang="ovml">
<OVArticleAuthor author="%F %L" strcase="lower">
</source>

= Les fonctions OvML =

On reconnaît les fonctions par la syntaxe suivante :

<source lang="ovml">
<OFxxxx ...>
</source>

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 <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>
</source>

'''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>
</source>

=== Syntaxe ===

<source lang="ovml">
<OFTranslate text="" [lang=""]>
</source>

=== 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

== OFPutVar ==

Permet de déclarer une nouvelle variable.

=== Syntaxe ===

<source lang="ovml">
<OFPutVar name="" [value=""]>
</source>

=== Paramètres ===

; name
: Nom de la variable

; value ''(optionnel)''
: Valeur à affecter à la variable

== OFGetVar ==

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

=== Syntaxe ===

<source lang="ovml">
<OFGetVar name="">
</source>

=== Paramètres ===

; name
: Nom de la variable à afficher

== OFIfNotIsSet ==

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

=== Syntaxe ===

<source lang="ovml">
<OFIfNotIsSet name="" [value=""]>
</source>

=== Paramètres ===

; name
: Nom de la variable

; value ''(optionnel)''
: Valeur à affecter à la variable

== OFInclude ==

Permet d'inclure un autre fichier OVML

=== Syntaxe ===

<source lang="ovml">
<OFInclude file="" [cache=""]>
</source>

=== 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 ===

<source lang="ovml">
<OFUrlContent url="">
</source>

=== 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 ===

<source lang="ovml">
<OFRecurse>
</source>

=== 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>).

<source lang="ovml">
<ul>
<OCArticleCategories>
<li>
<OVCategoryName>
<ul>
<OFRecurse parentid="<OVCategoryId>">
<OCArticleTopics categoryid="<OVCategoryId>">
<li><OVTopicName></li>
</OCArticleTopics>
</ul>
</li>
</OCArticleCategories>
</ul>
</source>

== Opérateurs arithmétiques ==

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

<source lang="ovml">
<OFAOxxxxx expr1="X" expr2="Y">
</source>

<source lang="ovml">
<OFAOxxxxx expr1="10" expr2="50">
</source>

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

<source lang="ovml">
<OFAOxxxxx expr1="<OVTotal>" expr2="50">
</source>

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.

<source lang="ovml">
<OFAOxxxxx expr1="<OVTotal>" expr2="50" saveas="NewTotal">
</source>

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 :

=== OFAOAddition ===

Permet d’additionner expr1 et expr2.

==== Syntaxe ====

<source lang="ovml">
<OFAOAddition expr1="" expr2="">
</source>

==== Paramètres ====

; expr1
: Premier terme de l'addition

; expr2
: Second terme de l'addition

=== OFAOSubtraction ===

Permet de soustraire expr2 à expr1.

==== Syntaxe ====

<source lang="ovml">
<OFAOSubtraction expr1="" expr2="">
</source>

==== Paramètres ====

; expr1
: Premier terme de la soustraction

; expr2
: Second terme de la soustraction

==== Exemple ====

<source lang="ovml">
<OFAOSubtraction expr1="10" expr2="20">
</source>

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 ====

<source lang="ovml">
<OFAOMultiplication expr1="" expr2="">
</source>

==== Paramètres ====

; expr1
: Premier terme de la multiplication

; expr2
: Second terme de la multiplication

=== OFAODivision ===

Permet de diviser expr1 par expr2.

==== Syntaxe ====

<source lang="ovml">
<OFAODivision expr1="" expr2="">
</source>

==== Paramètres ====

; expr1
: Premier terme de la division

; expr2
: Second terme de la division

==== Exemple ====

<source lang="ovml">
<OFAODivision expr1="10" expr2="20">
</source>

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 ====

<source lang="ovml">
<OFAOModulus expr1="" expr2="">
</source>

==== Paramètres ====

; expr1
: Premier terme du modulo

; expr2
: Second terme du modulo

==== Exemple ====

<source lang="ovml">
<OFAOModulus expr1="10" expr2="20">
</source>

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 ===

<source lang="ovml">
<OFHeader value="">
</source>

=== Paramètres ===

; value
: Valeur du header à modifier

=== Exemple ===

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

== OFSetCookie ==

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

=== Syntaxe ===

<source lang="ovml">
<OFSetCookie name="" expire="" [value=""]>
</source>

=== 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 ===

<source lang="ovml">
<OFGetCookie name="">
</source>

=== 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 ===

<source lang="ovml">
<OFSetSessionVar name="" value="">
</source>

=== 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 ===

<source lang="ovml">
<OFSetSessionVar name="babSectionsType" value="15">
</source>

affichera toutes les sections du portail

<source lang="ovml">
<OFSetSessionVar name="babSectionsType" value="4">
</source>

affichera uniquement les sections personnalisées du portail

<source lang="ovml">
<OFSetSessionVar name="babSectionsType" value="10">
</source>

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

<source lang="ovml">
<OFSetSessionVar name="babOvmlCurrentDelegation" value="5">
</source>

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

<source lang="ovml">
<OFSetSessionVar name="babOvmlCurrentDelegation" value="0">
</source>

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 ===

<source lang="ovml">
<OFRequest name="" saveas="" [default=""]>
</source>

=== Paramètres ===

; name
: Nom du paramètre GET dont on souhaite récupérer la valeur

; 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 ===

<source lang="ovml">
<OFPost name="" saveas="" [default=""]>
</source>

=== Paramètres ===

; name
: Nom du paramètre POST dont on souhaite récupérer la valeur

; 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 ===

<source lang="ovml">
<OFGet name="" saveas="" [default=""]>
</source>

=== Paramètres ===

; name
: Nom du paramètre GET dont on souhaite récupérer la valeur

; 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 ===

<source lang="ovml">
<OFSitemapPosition [sitemap=""] [basenode=""] [node=""] [keeplastknown=""]>
</source>

=== Paramètres ===

; 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 ===

<source lang="ovml">
<OFSitemapMenu [sitemap=""] [basenode=""] [selectednode=""] [keeplastknown=""] [maxdepth=""]>
</source>

=== 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é.

; 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).
: 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).

; 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.

== 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 ===

<source lang="ovml">
<OFSitemapCustomNodeId node="" [basenode=""] [saveas=""]>
</source>

=== 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 ===

<source lang="ovml">
<OFSitemapCustomNodeId node="bab_Articles" saveas="CustomNodeId">
<OFSitemapMenu basenode="<OVCustomNodeId>">
</source>

== 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 ===

<source lang="ovml">
<OFPreviousArticle articleid="" [topicid=""] [excludetopicid=""] [archive=""] [orderby=""] [order=""] [topicorder=""] [delegationid=""]>
</source>

=== 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 ===

<source lang="ovml">
<OFNextArticle articleid="" [topicid=""] [excludetopicid=""] [archive=""] [orderby=""] [order=""] [topicorder=""] [delegationid=""]>
</source>

=== 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 ==

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 ===

<source lang="ovml">
<OFWebStat name="" value="">
</source>

=== 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 ===

<source lang="ovml">
<OCArticle articleid="<OVarticleid>">

<OFWebStat name="bab_articles" value="<OVarticleid>">
</OCArticle>
</source>

== OFAddStylesheet ==

''Depuis Ovidentia '''7.5.93'''''

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

=== Syntaxe ===

<source lang="ovml">
<OFAddStylesheet file="">
</source>

=== Paramètres ===

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

= Les containers OvML =

La syntaxe des containers est comme suit :

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

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 ===

<source lang="ovml">
<OCxxxx expr1="" expr2="">...</OCxxxx>
</source>

=== Paramètres ===

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

=== Exemple ===

<source lang="ovml">
<OFPutVar name="BAB_SESS_LOGGED">
<OCIfEqual expr1="<BAB_SESS_LOGGED>" expr2="1">
Vous êtes connecté !
</OCIfEqual>
</source>

== 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 ===

<source lang="ovml">
<OCxxxx name="">...</OCxxxx>
</source>

=== Paramètres ===

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

=== Exemple ===

<source lang="ovml">
<OCIfIsSet name="variable">
Ce texte ne sera pas affiché.
</OCIfIsSet>

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

== OCIfUserMemberOfGroups ==

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

=== Syntaxe ===

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

=== 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 ===

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

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

== OCRecentFiles ==

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

=== Syntaxe ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

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

== OCRecentComments ==

Liste les derniers commentaires d'articles.

=== Syntaxe ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCArticleCategoryNext>...</OCArticleCategoryNext>
</source>

=== Variables ===

Idendiques à celles du container [[#OCArticleCategories|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 ===

<source lang="ovml">
<OCArticleCategoryPrevious>...</OCArticleCategoryPrevious>
</source>

=== Variables ===

Identiques à celles du container [[#OCArticleCategories|OCArticleCategories]].

== OCParentsArticleCategory ==

Liste des catégories de sujets parents.

=== Syntaxe ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 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 ===

<source lang="ovml">
<OCArticleTopicNext>...</OCArticleTopicNext>
</source>

=== Variables ===

Identiques à celles du container [[#OCArticleTopics|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 ===

<source lang="ovml">
<OCArticleTopicPrevious>....</OCArticleTopicPrevious>
</source>

=== Variables ===

Idem que ceux du container [[#OCArticleTopics|OCArticleTopics]].

== OCArticleTopic ==

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

=== Syntaxe ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCArticleTopic topicname="essai">...</OCArticleTopic>
</source>
Recherche tous les thèmes dont l'utilisateur a le droit et ayant pour nom "essai"

<source lang="ovml">
<OCArticleTopic topicid="1,2,3" topicname="essai">...</OCArticleTopic>
</source>
Recherche les thèmes d'id 1,2 3 ayant pour nom essai.

<source lang="ovml">
<OCArticleTopic topicid="1,2,3" topicname="%essai">...</OCArticleTopic>
</source>
Recherche les thèmes d'id 1,2 3 et dont le nom se termine par essai

<source lang="ovml">
<OCArticleTopic topicid="1,2,3" topicname="essai%">...</OCArticleTopic>
</source>
Recherche les thèmes d'id 1,2 3 et dont le nom commence par essai

<source lang="ovml">
<OCArticleTopic topicid="1,2,3" topicname="%essai%">...</OCArticleTopic>
</source>
Recherche les thèmes d'id 1,2 3 et dont le nom contient la chaîne essai

== OCArticles ==

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

=== Syntaxe ===

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

=== Paramètres ===

; topicid ''(optionnel)''
: Permet de préciser les thèmes d'articles concernés
: Id du thème ou plusieurs Ids séparés par une virgule
: Si omis, le container liste les articles tout thème confondu

; excludetopicid ''(optionnel)''
: Permet de préciser les thèmes d'articles à exclure à la différence du paramètre topicid
: Id du thème ou plusieurs Ids séparés par une virgule

; archive ''(optionnel)''
: yes : Donne la liste des articles archivés
: no ''(par défaut)'' : Donne la liste des articles non archivés

; offset ''(optionnel)''
: "n" indique le nombre d'articles à ignorer à partir du début de la liste
: 0 ''(par défaut)'' : aucune article n'est ignoré

; rows ''(optionnel)''
: "n" combien il faut en prendre
: -1 ''(par défaut)'' : toutes les lignes sont prises

; order ''(optionnel)''
: asc : Ordonne les articles par ordre croissant en fonction de la date
: desc ''(par défaut)'' : Ordonne les articles par ordre décroissant en fonction de la date
: rand : Ordonne les articles aléatoirement

; orderby ''(optionnel)''
: Peut être couplé avec l'attribut order.
: creation : Ordonne les articles par ordre de création en fonction de la date
: publication : Ordonne les articles par ordre de publication en fonction de la date
: modification ''(par défaut)'' : Ordonne les articles par ordre de modification en fonction de la date
: rating : Ordonne les articles en fonction de la note moyenne attribuée dans les commentaires

; topicorder ''(optionnel)''
: yes : Utilise l'ordre défini par le gestionnaire du thème d'articles
: no ''(par défaut)'' : N'utilise l'ordre défini par le gestionnaire du thème d'articles

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

; imageheightmax ''(optionnel)''
: Valeur en pixels. Permet de préciser la hauteur maximum de l'image associée.
: Si omis, l'image n'est pas redimensionnée et garde sa taille d'origine.

; imagewidthmax ''(optionnel)''
: Valeur en pixels. Permet de préciser la largeur maximum de l'image associée.
: Si omis, l'image n'est pas redimensionnée et garde sa taille d'origine.

; minrating ''(optionnel)''
: Permet de filtrer les articles ayant une note moyenne dans les commentaires supérieure ou égale à la valeur fournie en paramètre
: Valeur numérique.

=== Variables ===

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

== OCArticleNext ==

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

=== Syntaxe ===

<source lang="ovml">
<OCArticleNext>...</OCArticleNext>
</source>

=== Variables ===

Identiques à celles du container [[#OCArticles|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 ===

<source lang="ovml">
<OCArticlePrevious>...</OCArticlePrevious>
</source>

=== Variables ===

Identiques à celles du container [[#OCArticles|OCArticles]].

== OCArticle ==

Donne les informations sur un article donné.

=== Syntaxe ===

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

=== 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 ===

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

== OCArticleFiles ==

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

=== Syntaxe ===

<source lang="ovml">
<OCArticleFiles articleid="">...</OCArticleFiles>
</source>

=== Paramètres ===

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

=== Variables ===

{| class="prettytable"
! Variable
! Valeur
|-
| OVArticleFileName
| Nom du fichier
|-
| OVArticleFileDescription
| Description du fichier
|-
| OVArticleFileUrlGet
| Url pour atteindre le fichier
|}

== OCForums ==

Liste des forums.

=== Syntaxe ===

<source lang="ovml">
<OCForums [forumid=""] [delegationid=""]>...</OCForums>
</source>

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCForumNext>...</OCForumNext>
</source>

=== Variables ===

Identiques à celles du container [[#OCForums|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 ===

<source lang="ovml">
<OCForumPrevious>...</OCForumPrevious>
</source>

=== Variables ===

Identiques à celles du container [[#OCForums|OCForums]].

== OCForum ==

Donne les informations sur un forum donné.

=== Syntaxe ===

<source lang="ovml">
<OCForum forumid="">...</OCForum>
</source>

=== Paramètres ===

; forumid :
: Id du forum

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCThread threadid="" [order=""]>...</OCThread>
</source>

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCPost postid="" [order=""]>...</OCPost>
</source>

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCPostFiles postid="">...</OCPost>
</source>

=== Paramètres ===

; postid
: Id de la contribution 

=== Variables ===

{| class="prettytable"
! Variable
! Valeur
|-
| OVPostFileName
| Nom du fichier
|-
| OVPostFileUrlGet
| Url pour atteindre le fichier
|}

== OCFolders ==

Liste les répertoires partageables.

=== Syntaxe ===

<source lang="ovml">
<OCFolders [folderid=""] [delegationid=""]>...</OCFolders>
</source>

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFolderNext>...</OCFolderNext>
</source>

=== Variables ===

Identique à celles du container [[#OCFolders|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 ===

<source lang="ovml">
<OCFolderPrevious>...</OCFolderPrevious>
</source>

=== Variables ===

Identique à celles du container [[#OCFolders|OCFolders]].

== OCFolder ==

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

=== Syntaxe ===

<source lang="ovml">
<OCFolder folderid="">...</OCFolder>
</source>

=== Paramètres ===

; folderid
: Id du répertoire

=== Variables ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 :'''
<source lang="ovml">
<a href="<OVFileUrl>&inl=1"><OVFileName></a>
</source>

=== Syntaxe ===

<source lang="ovml">
<OCFiles folderid="" rows="" offset="" [path=""]>...</OCFiles>
</source>

=== 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

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFileNext>...</OCFileNext>
</source>

=== Variables ===

Identiques à celles du container [[#OCFiles|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 ===

<source lang="ovml">
<OCFilePrevious>...</OCFilePrevious>
</source>

=== Variables ===

Identiques à celles du container [[#OCFolders|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 :'''
<source lang="ovml">
<a href="<OVFileUrl>&inl=1"><OVFileName></a>
</source>

=== Syntaxe ===

<source lang="ovml">
<OCFile fileid="">...</OCFile>
</source>

=== Paramètres ===

; fileid
: Id du fichier

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFileFields fileid="">...</OCFileFields>
</source>

=== Paramètres ===

; fileid
: Id du fichier

=== Variables ===

{| class="prettytable"
! Variable
! Valeur
|-
| OVFileFieldName
| Nom du champ
|-
| OVFileFieldValue
| Valeur du champ
|}

== OCFaqs ==

Donne la liste des Faqs.

=== Syntaxe ===

<source lang="ovml">
<OCFaqs [faqid=""] [delegationid=""]>...</OCFaqs>
</source>

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFaqNext>...</OCFaqNext>
</source>

=== Variables ===

Identiques à celles du container [[#OCFaqs|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 ===

<source lang="ovml">
<OCFaqPrevious>...</OCFaqPrevious>
</source>

=== Variables ===

Identiques à celles du container [[#OCFaqs|OCFaqs]].

== OCFaq ==

Donne les informations sur une Faq donnée.

=== Syntaxe ===

<source lang="ovml">
<OCFaq faqid="">...</OCFaq>
</source>

=== Paramètres ===

; faqid
: Id de la Faq

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFaqSubCategories faqid="" [delegationid=""]>...</OCFaqSubCategories>
</source>

=== Paramètres ===

; faqid
: Id de la faq

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

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFaqSubCategory faqsubcatid="">...</OCFaqSubCategory>
</source>

=== Paramètres ===

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

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFaqQuestions [faqid=""] [faqsubcatid=""]>...</OCFaqQuestions>
</source>

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFaqQuestionNext>...</OCFaqQuestionNext>
</source>

=== Variables ===

Identiques à celles du container [[#OCFaqQuestions|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 ===

<source lang="ovml">
<OCFaqQuestionPrevious>...</OCFaqQuestionPrevious>
</source>

=== Variables ===

Identiques à celles du container [[#OCFaqQuestions|OCFaqQuestions]].

== OCFaqQuestion ==

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

=== Syntaxe ===

<source lang="ovml">
<OCFaqQuestion questionid="">...</OCFaqQuestion>
</source>

=== Paramètres ===

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

=== Variables ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

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

== OCWaitingComments ==

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

=== Syntaxe ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCCalendarCategories [filter=""]>...</OCCalendarCategories>
</source>

=== Paramètres ===

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

=== Variables ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
| 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 ===

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

=== 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 ===

{| class="prettytable"
| 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)
|}

== OCDbDirectories ==

Liste les annuaires de base de données

=== Syntaxe ===

<source lang="ovml">
<OCDbDirectories [directoryid=""] [delegationid=""]>...</OCDbDirectories>
</source>

=== 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.

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCDbDirectory directoryid="" [type=""]>...</OCDbDirectory>
</source>

=== Paramètres ===

; directoryid
: Id de l'annuaire

; type ''(optionnel)''
: « database » ou « group », si omis, le container liste tous les annuaires.

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCDbDirectoryFields directoryid="" [all=""]>...</OCDbDirectoryFields>
</source>

=== 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 ===

{| class="prettytable"
! Variable
! Valeur
|-
| OVDirectoryFieldName
| Intitulé du champ
|-
| OVDirectoryFieldId
| Identifiant du champ
|}

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

{| class="prettytable"
! 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 ===

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

=== Paramètres ===

; directoryid
: Id de l'annuaire

; all ''(optionnel)''
: Ignoré si l'attribut '''fields''' est spécifié
: 1 : Donne tous les champs pour chaque membre
: 0 : Donne uniquement les champs choisis pour l'affichage lors de la configuration du l'annuaire
: Si omis, liste uniquement les champs choisis.

; fields ''(optionnel)''
: liste des identifiants des champs souhaités séparés par des virgules ( exemple "sn,givenname,email" )

; orderby ''(optionnel)''
: Identifiant du champ à utiliser pour ordonner la liste

; order ''(optionnel)''
: asc : ordonne par ordre croissant
: desc : ordonne par ordre décroissant

; like ''(optionnel)''
: Restreint la liste des membres ayant le champ commençant par ce motif ( exemple like="A" )

=== Variables ===

{| class="prettytable"
! 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
| <nowiki>Intitulé du champ ayant pour identifiant xxxxxxx ( ex <OVgivennameName> ) </nowiki>
|-
| OVxxxxxxValue
| <nowiki>Contenu du champ ayant pour identifiant xxxxxxx ( ex <OVgivennameValue> ) </nowiki>
|}

== OCDbDirectoryMemberFields ==

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

Liste les différents champs pour le membre courant.

=== Syntaxe ===

<source lang="ovml">
<OCDbDirectoryMemberFields>...</OCDbDirectoryMemberFields>
</source>

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCDbDirectoryEntry directoryid="" memberid="" userid="">...</OCDbDirectoryEntry>
</source>

=== 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 ===

{| class="prettytable"
! 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
| <nowiki>Intitulé du champ ayant pour identifiant xxxxxxx ( ex <OVgivennameName> ) </nowiki>
|-
| OVxxxxxxValue
| <nowiki>Contenu du champ ayant pour identifiant xxxxxxx ( ex <OVgivennameValue> ) </nowiki>
|-
| 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 ===

<source lang="ovml">
<OCDbDirectoryEntryFields>...</OCDbDirectoryEntryFields>
</source>

=== Variables ===

{| class="prettytable"
! Variable
! Valeur
|-
| OVDirectoryFieldName
| Intitulé du champ
|-
| OVDirectoryFieldValue
| Valeur du champ
|}

== OCDbDirectoryAcl ==

Liste les utilisateurs ayant des droits sur un annuaire.

=== Syntaxe ===

<source lang="ovml">
<OCDbDirectoryAcl directoryid="" type="">...</OCDbDirectoryAcl>
</source>

=== Paramètres ===

; directoryid
: Id de l'annuaire

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

=== Variables ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCDelegationItems delegationid="">...</OCDelegationItems>
</source>

=== Paramètres ===

; delegationid
: Id de la délégation

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCDelegationAdministrators delegationid="">...</OCDelegationAdministrators>
</source>

=== Paramètres ===

; delegationid
: Id de la délégation

=== Variables ===

{| class="prettytable"
! Variable
! Valeur
|-
| OVDelegationUserId
| Id de l'administrateur
|}

== OCDelegationsCategories ==

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

=== Syntaxe ===

<source lang="ovml">
<OCDelegationsCategories [categoryid=""]>....</OCDelegationsCategories>
</source>

=== Paramètres ===

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

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCDelegationsCategory [categoryid=""]>...</OCDelegationsCategory>
</source>

=== Paramètres ===

; categoryid
: Id de la délégation

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCTmSpaces>...</OCTmSpaces>
</source>

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCTmProjects spaceid="">...</OCTmProjects>
</source>

=== Paramètres ===

; spaceid
: Id de l'espace de projets

=== Variables ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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.

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

=== 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 ===

{| class="prettytable"
! Variable
! Valeur
|-
| OVEntityId
| Identifiant (entier) de l'entité
|-
| OVEntityName
| Nom de l'entité
|-
| OVEntityDescription
| Description de l'entité
|}

== OCMultipages ==

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

=== Syntaxe ===

<source lang="ovml">
<OCMultipages total="" maxpages="" perpage="" currentpage="">...</OCMultipages>
</source>

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCSitemapEntries node="" [sitemap=""] [limit=""]>...</OCSitemapEntries>
</source>

=== 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...
: Si node n'est pas spécifié,

; 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 ===

{| 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
|}

== 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 ===

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

=== 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.

; 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 =====

{| 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
|}

= 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 !

== 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 ===

<source lang="ovml">
<OCAddon name="" param1="" param2="" ...>...</OCAddon>
</source>

=== 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 ===

<source lang="ovml">
<OFAddon name="" function="" param1="" ...>
</source>

=== 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éférence OvML

2013-06-05T08:20:09Z

Rodpec : /* OFAddStylesheet */

[[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.

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 :

<source lang="ovml">
<OVnom-de-la-variable>
</source>

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

<source lang="ovml">
<OFPutVar name="nbArticles" value="10">
</source>

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 :

<source lang="ovml">
<OVnbArticles>
</source>

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 :

<source lang="ovml">
<OFPutVar name="babSlogan">
</source>

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.

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

<source lang="ovml">
<OFIfNotIsSet name="page" value="1">
</source>

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 <code><OVxxxx></code>.

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.

<source lang="ovml">
<OVnbArticles saveas="TotalArticles">
</source>

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.

{| class="prettytable"
! Value
!
|-
| n
| Récupère les n premiers caractères du contenu de la variable
|}

<source lang="ovml">
<OVbabSlogan strlen="100">
</source>

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 :

<source lang="ovml">
<OVbabSlogan strlen="100,...">
</source>

== striptags ==

Supprime les tags HTML de la variable :

{| class="prettytable"
! Value
!
|-
| 1
| Supprime les tags HTML de la variable
|}

<source lang="ovml">
<OVbabSlogan striptags="1">
</source>

== htmlentities ==

{| class="prettytable"
! Value
!
|-
| 1
| <nowiki>Convertit les entities HTML ( < devient &lt; )</nowiki>
|-
| 2
| <nowiki>Convertit en inverse les entities HTML ( &lt; devient < )</nowiki>
|}

<source lang="ovml">
<OVbabSlogan htmlentities="1">
</source>

== stripslashes ==

Supprime les slashs doublés du contenu de la variable

{| class="prettytable"
! Value
!
|-
| 1
| Supprime les slashs doublés du contenu de la variable
|}

<source lang="ovml">
<OVbabSlogan stripslashes="1">
</source>

== urlencode ==

{| class="prettytable"
! Value
!
|-
| 1
| Encode la variable pour l'utilisation dans une url
|}

<source lang="ovml">
<OVbabSlogan urlencode="1">
</source>

== jsencode ==

{| class="prettytable"
! Value
!
|-
| 1
| Encode la variable pour l'utilisation dans du javascript
|}

<source lang="ovml">
<OVbabSlogan jsencode="1">
</source>

== strcase ==

{| class="prettytable"
! Value
!
|-
| upper
| Convertit le contenu de la variable en majuscule
|-
| lower
| Convertit le contenu de la variable en minuscule
|}

<source lang="ovml">
<OVbabSlogan strcase="upper">
</source>

== nlremove ==

{| class="prettytable"
! Value
!
|-
| 1
| Supprime les retours chariots
|}

<source lang="ovml">
<OVbabSlogan nlremove="1">
</source>

== trim ==

{| class="prettytable"
! 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
|}

<source lang="ovml">
<OVbabSlogan trim="all">
</source>

== nl2br ==

{| class="prettytable"
! Value
!
|-
| <div align="right">1</div>
| <nowiki>Transforme les retours chariots en </nowiki>
|}

<source lang="ovml">
<OVbabSlogan nl2br="1">
</source>

== sprintf ==

{| class="prettytable"
! Value
!
|-
| Voir la documentation PHP pour la fonction sprintf
| Retourne une chaîne formatée
|}

<source lang="ovml">
<OVMoney sprintf="%01.2f">
</source>

== date ==

Permet de formater une date Ovidentia

{| class="prettytable"
! 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"
|}

<source lang="ovml">
<OVArticleDate date="%d %j %m %Y">
</source>

'''Remarque :'''

<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.

<source lang="ovml">
<OVbabCurrentDate date="%D %j %M" strcase="lower">
</source>

== author ==

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

{| class="prettytable"
! Value
!
|-
| %F
| Prénom
|-
| %M
| Deuxième prénom
|-
| %L
| Nom
|}

<source lang="ovml">
<OVArticleAuthor author="%F %L" strcase="lower">
</source>

= Les fonctions OvML =

On reconnaît les fonctions par la syntaxe suivante :

<source lang="ovml">
<OFxxxx ...>
</source>

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 <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>
</source>

'''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>
</source>

=== Syntaxe ===

<source lang="ovml">
<OFTranslate text="" [lang=""]>
</source>

=== 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

== OFPutVar ==

Permet de déclarer une nouvelle variable.

=== Syntaxe ===

<source lang="ovml">
<OFPutVar name="" [value=""]>
</source>

=== Paramètres ===

; name
: Nom de la variable

; value ''(optionnel)''
: Valeur à affecter à la variable

== OFGetVar ==

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

=== Syntaxe ===

<source lang="ovml">
<OFGetVar name="">
</source>

=== Paramètres ===

; name
: Nom de la variable à afficher

== OFIfNotIsSet ==

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

=== Syntaxe ===

<source lang="ovml">
<OFIfNotIsSet name="" [value=""]>
</source>

=== Paramètres ===

; name
: Nom de la variable

; value ''(optionnel)''
: Valeur à affecter à la variable

== OFInclude ==

Permet d'inclure un autre fichier OVML

=== Syntaxe ===

<source lang="ovml">
<OFInclude file="" [cache=""]>
</source>

=== 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 ===

<source lang="ovml">
<OFUrlContent url="">
</source>

=== 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 ===

<source lang="ovml">
<OFRecurse>
</source>

=== 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>).

<source lang="ovml">
<ul>
<OCArticleCategories>
<li>
<OVCategoryName>
<ul>
<OFRecurse parentid="<OVCategoryId>">
<OCArticleTopics categoryid="<OVCategoryId>">
<li><OVTopicName></li>
</OCArticleTopics>
</ul>
</li>
</OCArticleCategories>
</ul>
</source>

== Opérateurs arithmétiques ==

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

<source lang="ovml">
<OFAOxxxxx expr1="X" expr2="Y">
</source>

<source lang="ovml">
<OFAOxxxxx expr1="10" expr2="50">
</source>

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

<source lang="ovml">
<OFAOxxxxx expr1="<OVTotal>" expr2="50">
</source>

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.

<source lang="ovml">
<OFAOxxxxx expr1="<OVTotal>" expr2="50" saveas="NewTotal">
</source>

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 :

=== OFAOAddition ===

Permet d’additionner expr1 et expr2.

==== Syntaxe ====

<source lang="ovml">
<OFAOAddition expr1="" expr2="">
</source>

==== Paramètres ====

; expr1
: Premier terme de l'addition

; expr2
: Second terme de l'addition

=== OFAOSubtraction ===

Permet de soustraire expr2 à expr1.

==== Syntaxe ====

<source lang="ovml">
<OFAOSubtraction expr1="" expr2="">
</source>

==== Paramètres ====

; expr1
: Premier terme de la soustraction

; expr2
: Second terme de la soustraction

==== Exemple ====

<source lang="ovml">
<OFAOSubtraction expr1="10" expr2="20">
</source>

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 ====

<source lang="ovml">
<OFAOMultiplication expr1="" expr2="">
</source>

==== Paramètres ====

; expr1
: Premier terme de la multiplication

; expr2
: Second terme de la multiplication

=== OFAODivision ===

Permet de diviser expr1 par expr2.

==== Syntaxe ====

<source lang="ovml">
<OFAODivision expr1="" expr2="">
</source>

==== Paramètres ====

; expr1
: Premier terme de la division

; expr2
: Second terme de la division

==== Exemple ====

<source lang="ovml">
<OFAODivision expr1="10" expr2="20">
</source>

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 ====

<source lang="ovml">
<OFAOModulus expr1="" expr2="">
</source>

==== Paramètres ====

; expr1
: Premier terme du modulo

; expr2
: Second terme du modulo

==== Exemple ====

<source lang="ovml">
<OFAOModulus expr1="10" expr2="20">
</source>

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 ===

<source lang="ovml">
<OFHeader value="">
</source>

=== Paramètres ===

; value
: Valeur du header à modifier

=== Exemple ===

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

== OFSetCookie ==

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

=== Syntaxe ===

<source lang="ovml">
<OFSetCookie name="" expire="" [value=""]>
</source>

=== 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 ===

<source lang="ovml">
<OFGetCookie name="">
</source>

=== 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 ===

<source lang="ovml">
<OFSetSessionVar name="" value="">
</source>

=== 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 ===

<source lang="ovml">
<OFSetSessionVar name="babSectionsType" value="15">
</source>

affichera toutes les sections du portail

<source lang="ovml">
<OFSetSessionVar name="babSectionsType" value="4">
</source>

affichera uniquement les sections personnalisées du portail

<source lang="ovml">
<OFSetSessionVar name="babSectionsType" value="10">
</source>

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

<source lang="ovml">
<OFSetSessionVar name="babOvmlCurrentDelegation" value="5">
</source>

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

<source lang="ovml">
<OFSetSessionVar name="babOvmlCurrentDelegation" value="0">
</source>

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 ===

<source lang="ovml">
<OFRequest name="" saveas="" [default=""]>
</source>

=== Paramètres ===

; name
: Nom du paramètre GET dont on souhaite récupérer la valeur

; 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 ===

<source lang="ovml">
<OFPost name="" saveas="" [default=""]>
</source>

=== Paramètres ===

; name
: Nom du paramètre POST dont on souhaite récupérer la valeur

; 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 ===

<source lang="ovml">
<OFGet name="" saveas="" [default=""]>
</source>

=== Paramètres ===

; name
: Nom du paramètre GET dont on souhaite récupérer la valeur

; 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 ===

<source lang="ovml">
<OFSitemapPosition [sitemap=""] [basenode=""] [node=""] [keeplastknown=""]>
</source>

=== Paramètres ===

; 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 ===

<source lang="ovml">
<OFSitemapMenu [sitemap=""] [basenode=""] [selectednode=""] [keeplastknown=""] [maxdepth=""]>
</source>

=== 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é.

; 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).
: 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).

; 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.

== 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 ===

<source lang="ovml">
<OFSitemapCustomNodeId node="" [basenode=""] [saveas=""]>
</source>

=== 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 ===

<source lang="ovml">
<OFSitemapCustomNodeId node="bab_Articles" saveas="CustomNodeId">
<OFSitemapMenu basenode="<OVCustomNodeId>">
</source>

== 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 ===

<source lang="ovml">
<OFPreviousArticle articleid="" [topicid=""] [excludetopicid=""] [archive=""] [orderby=""] [order=""] [topicorder=""] [delegationid=""]>
</source>

=== 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 ===

<source lang="ovml">
<OFNextArticle articleid="" [topicid=""] [excludetopicid=""] [archive=""] [orderby=""] [order=""] [topicorder=""] [delegationid=""]>
</source>

=== 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 ==

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 ===

<source lang="ovml">
<OFWebStat name="" value="">
</source>

=== 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 ===

<source lang="ovml">
<OCArticle articleid="<OVarticleid>">

<OFWebStat name="bab_articles" value="<OVarticleid>">
</OCArticle>
</source>

== OFAddStylesheet ==

Depuis Ovidentia 7.5.93

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

=== Syntaxe ===

<source lang="ovml">
<OFAddStylesheet file="">
</source>

=== Paramètres ===

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

= Les containers OvML =

La syntaxe des containers est comme suit :

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

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 ===

<source lang="ovml">
<OCxxxx expr1="" expr2="">...</OCxxxx>
</source>

=== Paramètres ===

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

=== Exemple ===

<source lang="ovml">
<OFPutVar name="BAB_SESS_LOGGED">
<OCIfEqual expr1="<BAB_SESS_LOGGED>" expr2="1">
Vous êtes connecté !
</OCIfEqual>
</source>

== 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 ===

<source lang="ovml">
<OCxxxx name="">...</OCxxxx>
</source>

=== Paramètres ===

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

=== Exemple ===

<source lang="ovml">
<OCIfIsSet name="variable">
Ce texte ne sera pas affiché.
</OCIfIsSet>

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

== OCIfUserMemberOfGroups ==

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

=== Syntaxe ===

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

=== 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 ===

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

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

== OCRecentFiles ==

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

=== Syntaxe ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

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

== OCRecentComments ==

Liste les derniers commentaires d'articles.

=== Syntaxe ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCArticleCategoryNext>...</OCArticleCategoryNext>
</source>

=== Variables ===

Idendiques à celles du container [[#OCArticleCategories|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 ===

<source lang="ovml">
<OCArticleCategoryPrevious>...</OCArticleCategoryPrevious>
</source>

=== Variables ===

Identiques à celles du container [[#OCArticleCategories|OCArticleCategories]].

== OCParentsArticleCategory ==

Liste des catégories de sujets parents.

=== Syntaxe ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 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 ===

<source lang="ovml">
<OCArticleTopicNext>...</OCArticleTopicNext>
</source>

=== Variables ===

Identiques à celles du container [[#OCArticleTopics|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 ===

<source lang="ovml">
<OCArticleTopicPrevious>....</OCArticleTopicPrevious>
</source>

=== Variables ===

Idem que ceux du container [[#OCArticleTopics|OCArticleTopics]].

== OCArticleTopic ==

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

=== Syntaxe ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCArticleTopic topicname="essai">...</OCArticleTopic>
</source>
Recherche tous les thèmes dont l'utilisateur a le droit et ayant pour nom "essai"

<source lang="ovml">
<OCArticleTopic topicid="1,2,3" topicname="essai">...</OCArticleTopic>
</source>
Recherche les thèmes d'id 1,2 3 ayant pour nom essai.

<source lang="ovml">
<OCArticleTopic topicid="1,2,3" topicname="%essai">...</OCArticleTopic>
</source>
Recherche les thèmes d'id 1,2 3 et dont le nom se termine par essai

<source lang="ovml">
<OCArticleTopic topicid="1,2,3" topicname="essai%">...</OCArticleTopic>
</source>
Recherche les thèmes d'id 1,2 3 et dont le nom commence par essai

<source lang="ovml">
<OCArticleTopic topicid="1,2,3" topicname="%essai%">...</OCArticleTopic>
</source>
Recherche les thèmes d'id 1,2 3 et dont le nom contient la chaîne essai

== OCArticles ==

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

=== Syntaxe ===

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

=== Paramètres ===

; topicid ''(optionnel)''
: Permet de préciser les thèmes d'articles concernés
: Id du thème ou plusieurs Ids séparés par une virgule
: Si omis, le container liste les articles tout thème confondu

; excludetopicid ''(optionnel)''
: Permet de préciser les thèmes d'articles à exclure à la différence du paramètre topicid
: Id du thème ou plusieurs Ids séparés par une virgule

; archive ''(optionnel)''
: yes : Donne la liste des articles archivés
: no ''(par défaut)'' : Donne la liste des articles non archivés

; offset ''(optionnel)''
: "n" indique le nombre d'articles à ignorer à partir du début de la liste
: 0 ''(par défaut)'' : aucune article n'est ignoré

; rows ''(optionnel)''
: "n" combien il faut en prendre
: -1 ''(par défaut)'' : toutes les lignes sont prises

; order ''(optionnel)''
: asc : Ordonne les articles par ordre croissant en fonction de la date
: desc ''(par défaut)'' : Ordonne les articles par ordre décroissant en fonction de la date
: rand : Ordonne les articles aléatoirement

; orderby ''(optionnel)''
: Peut être couplé avec l'attribut order.
: creation : Ordonne les articles par ordre de création en fonction de la date
: publication : Ordonne les articles par ordre de publication en fonction de la date
: modification ''(par défaut)'' : Ordonne les articles par ordre de modification en fonction de la date
: rating : Ordonne les articles en fonction de la note moyenne attribuée dans les commentaires

; topicorder ''(optionnel)''
: yes : Utilise l'ordre défini par le gestionnaire du thème d'articles
: no ''(par défaut)'' : N'utilise l'ordre défini par le gestionnaire du thème d'articles

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

; imageheightmax ''(optionnel)''
: Valeur en pixels. Permet de préciser la hauteur maximum de l'image associée.
: Si omis, l'image n'est pas redimensionnée et garde sa taille d'origine.

; imagewidthmax ''(optionnel)''
: Valeur en pixels. Permet de préciser la largeur maximum de l'image associée.
: Si omis, l'image n'est pas redimensionnée et garde sa taille d'origine.

; minrating ''(optionnel)''
: Permet de filtrer les articles ayant une note moyenne dans les commentaires supérieure ou égale à la valeur fournie en paramètre
: Valeur numérique.

=== Variables ===

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

== OCArticleNext ==

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

=== Syntaxe ===

<source lang="ovml">
<OCArticleNext>...</OCArticleNext>
</source>

=== Variables ===

Identiques à celles du container [[#OCArticles|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 ===

<source lang="ovml">
<OCArticlePrevious>...</OCArticlePrevious>
</source>

=== Variables ===

Identiques à celles du container [[#OCArticles|OCArticles]].

== OCArticle ==

Donne les informations sur un article donné.

=== Syntaxe ===

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

=== 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 ===

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

== OCArticleFiles ==

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

=== Syntaxe ===

<source lang="ovml">
<OCArticleFiles articleid="">...</OCArticleFiles>
</source>

=== Paramètres ===

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

=== Variables ===

{| class="prettytable"
! Variable
! Valeur
|-
| OVArticleFileName
| Nom du fichier
|-
| OVArticleFileDescription
| Description du fichier
|-
| OVArticleFileUrlGet
| Url pour atteindre le fichier
|}

== OCForums ==

Liste des forums.

=== Syntaxe ===

<source lang="ovml">
<OCForums [forumid=""] [delegationid=""]>...</OCForums>
</source>

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCForumNext>...</OCForumNext>
</source>

=== Variables ===

Identiques à celles du container [[#OCForums|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 ===

<source lang="ovml">
<OCForumPrevious>...</OCForumPrevious>
</source>

=== Variables ===

Identiques à celles du container [[#OCForums|OCForums]].

== OCForum ==

Donne les informations sur un forum donné.

=== Syntaxe ===

<source lang="ovml">
<OCForum forumid="">...</OCForum>
</source>

=== Paramètres ===

; forumid :
: Id du forum

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCThread threadid="" [order=""]>...</OCThread>
</source>

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCPost postid="" [order=""]>...</OCPost>
</source>

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCPostFiles postid="">...</OCPost>
</source>

=== Paramètres ===

; postid
: Id de la contribution 

=== Variables ===

{| class="prettytable"
! Variable
! Valeur
|-
| OVPostFileName
| Nom du fichier
|-
| OVPostFileUrlGet
| Url pour atteindre le fichier
|}

== OCFolders ==

Liste les répertoires partageables.

=== Syntaxe ===

<source lang="ovml">
<OCFolders [folderid=""] [delegationid=""]>...</OCFolders>
</source>

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFolderNext>...</OCFolderNext>
</source>

=== Variables ===

Identique à celles du container [[#OCFolders|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 ===

<source lang="ovml">
<OCFolderPrevious>...</OCFolderPrevious>
</source>

=== Variables ===

Identique à celles du container [[#OCFolders|OCFolders]].

== OCFolder ==

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

=== Syntaxe ===

<source lang="ovml">
<OCFolder folderid="">...</OCFolder>
</source>

=== Paramètres ===

; folderid
: Id du répertoire

=== Variables ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 :'''
<source lang="ovml">
<a href="<OVFileUrl>&inl=1"><OVFileName></a>
</source>

=== Syntaxe ===

<source lang="ovml">
<OCFiles folderid="" rows="" offset="" [path=""]>...</OCFiles>
</source>

=== 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

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFileNext>...</OCFileNext>
</source>

=== Variables ===

Identiques à celles du container [[#OCFiles|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 ===

<source lang="ovml">
<OCFilePrevious>...</OCFilePrevious>
</source>

=== Variables ===

Identiques à celles du container [[#OCFolders|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 :'''
<source lang="ovml">
<a href="<OVFileUrl>&inl=1"><OVFileName></a>
</source>

=== Syntaxe ===

<source lang="ovml">
<OCFile fileid="">...</OCFile>
</source>

=== Paramètres ===

; fileid
: Id du fichier

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFileFields fileid="">...</OCFileFields>
</source>

=== Paramètres ===

; fileid
: Id du fichier

=== Variables ===

{| class="prettytable"
! Variable
! Valeur
|-
| OVFileFieldName
| Nom du champ
|-
| OVFileFieldValue
| Valeur du champ
|}

== OCFaqs ==

Donne la liste des Faqs.

=== Syntaxe ===

<source lang="ovml">
<OCFaqs [faqid=""] [delegationid=""]>...</OCFaqs>
</source>

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFaqNext>...</OCFaqNext>
</source>

=== Variables ===

Identiques à celles du container [[#OCFaqs|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 ===

<source lang="ovml">
<OCFaqPrevious>...</OCFaqPrevious>
</source>

=== Variables ===

Identiques à celles du container [[#OCFaqs|OCFaqs]].

== OCFaq ==

Donne les informations sur une Faq donnée.

=== Syntaxe ===

<source lang="ovml">
<OCFaq faqid="">...</OCFaq>
</source>

=== Paramètres ===

; faqid
: Id de la Faq

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFaqSubCategories faqid="" [delegationid=""]>...</OCFaqSubCategories>
</source>

=== Paramètres ===

; faqid
: Id de la faq

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

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFaqSubCategory faqsubcatid="">...</OCFaqSubCategory>
</source>

=== Paramètres ===

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

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFaqQuestions [faqid=""] [faqsubcatid=""]>...</OCFaqQuestions>
</source>

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFaqQuestionNext>...</OCFaqQuestionNext>
</source>

=== Variables ===

Identiques à celles du container [[#OCFaqQuestions|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 ===

<source lang="ovml">
<OCFaqQuestionPrevious>...</OCFaqQuestionPrevious>
</source>

=== Variables ===

Identiques à celles du container [[#OCFaqQuestions|OCFaqQuestions]].

== OCFaqQuestion ==

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

=== Syntaxe ===

<source lang="ovml">
<OCFaqQuestion questionid="">...</OCFaqQuestion>
</source>

=== Paramètres ===

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

=== Variables ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

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

== OCWaitingComments ==

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

=== Syntaxe ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCCalendarCategories [filter=""]>...</OCCalendarCategories>
</source>

=== Paramètres ===

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

=== Variables ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
| 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 ===

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

=== 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 ===

{| class="prettytable"
| 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)
|}

== OCDbDirectories ==

Liste les annuaires de base de données

=== Syntaxe ===

<source lang="ovml">
<OCDbDirectories [directoryid=""] [delegationid=""]>...</OCDbDirectories>
</source>

=== 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.

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCDbDirectory directoryid="" [type=""]>...</OCDbDirectory>
</source>

=== Paramètres ===

; directoryid
: Id de l'annuaire

; type ''(optionnel)''
: « database » ou « group », si omis, le container liste tous les annuaires.

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCDbDirectoryFields directoryid="" [all=""]>...</OCDbDirectoryFields>
</source>

=== 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 ===

{| class="prettytable"
! Variable
! Valeur
|-
| OVDirectoryFieldName
| Intitulé du champ
|-
| OVDirectoryFieldId
| Identifiant du champ
|}

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

{| class="prettytable"
! 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 ===

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

=== Paramètres ===

; directoryid
: Id de l'annuaire

; all ''(optionnel)''
: Ignoré si l'attribut '''fields''' est spécifié
: 1 : Donne tous les champs pour chaque membre
: 0 : Donne uniquement les champs choisis pour l'affichage lors de la configuration du l'annuaire
: Si omis, liste uniquement les champs choisis.

; fields ''(optionnel)''
: liste des identifiants des champs souhaités séparés par des virgules ( exemple "sn,givenname,email" )

; orderby ''(optionnel)''
: Identifiant du champ à utiliser pour ordonner la liste

; order ''(optionnel)''
: asc : ordonne par ordre croissant
: desc : ordonne par ordre décroissant

; like ''(optionnel)''
: Restreint la liste des membres ayant le champ commençant par ce motif ( exemple like="A" )

=== Variables ===

{| class="prettytable"
! 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
| <nowiki>Intitulé du champ ayant pour identifiant xxxxxxx ( ex <OVgivennameName> ) </nowiki>
|-
| OVxxxxxxValue
| <nowiki>Contenu du champ ayant pour identifiant xxxxxxx ( ex <OVgivennameValue> ) </nowiki>
|}

== OCDbDirectoryMemberFields ==

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

Liste les différents champs pour le membre courant.

=== Syntaxe ===

<source lang="ovml">
<OCDbDirectoryMemberFields>...</OCDbDirectoryMemberFields>
</source>

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCDbDirectoryEntry directoryid="" memberid="" userid="">...</OCDbDirectoryEntry>
</source>

=== 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 ===

{| class="prettytable"
! 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
| <nowiki>Intitulé du champ ayant pour identifiant xxxxxxx ( ex <OVgivennameName> ) </nowiki>
|-
| OVxxxxxxValue
| <nowiki>Contenu du champ ayant pour identifiant xxxxxxx ( ex <OVgivennameValue> ) </nowiki>
|-
| 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 ===

<source lang="ovml">
<OCDbDirectoryEntryFields>...</OCDbDirectoryEntryFields>
</source>

=== Variables ===

{| class="prettytable"
! Variable
! Valeur
|-
| OVDirectoryFieldName
| Intitulé du champ
|-
| OVDirectoryFieldValue
| Valeur du champ
|}

== OCDbDirectoryAcl ==

Liste les utilisateurs ayant des droits sur un annuaire.

=== Syntaxe ===

<source lang="ovml">
<OCDbDirectoryAcl directoryid="" type="">...</OCDbDirectoryAcl>
</source>

=== Paramètres ===

; directoryid
: Id de l'annuaire

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

=== Variables ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCDelegationItems delegationid="">...</OCDelegationItems>
</source>

=== Paramètres ===

; delegationid
: Id de la délégation

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCDelegationAdministrators delegationid="">...</OCDelegationAdministrators>
</source>

=== Paramètres ===

; delegationid
: Id de la délégation

=== Variables ===

{| class="prettytable"
! Variable
! Valeur
|-
| OVDelegationUserId
| Id de l'administrateur
|}

== OCDelegationsCategories ==

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

=== Syntaxe ===

<source lang="ovml">
<OCDelegationsCategories [categoryid=""]>....</OCDelegationsCategories>
</source>

=== Paramètres ===

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

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCDelegationsCategory [categoryid=""]>...</OCDelegationsCategory>
</source>

=== Paramètres ===

; categoryid
: Id de la délégation

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCTmSpaces>...</OCTmSpaces>
</source>

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCTmProjects spaceid="">...</OCTmProjects>
</source>

=== Paramètres ===

; spaceid
: Id de l'espace de projets

=== Variables ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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.

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

=== 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 ===

{| class="prettytable"
! Variable
! Valeur
|-
| OVEntityId
| Identifiant (entier) de l'entité
|-
| OVEntityName
| Nom de l'entité
|-
| OVEntityDescription
| Description de l'entité
|}

== OCMultipages ==

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

=== Syntaxe ===

<source lang="ovml">
<OCMultipages total="" maxpages="" perpage="" currentpage="">...</OCMultipages>
</source>

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCSitemapEntries node="" [sitemap=""] [limit=""]>...</OCSitemapEntries>
</source>

=== 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...
: Si node n'est pas spécifié,

; 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 ===

{| 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
|}

== 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 ===

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

=== 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.

; 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 =====

{| 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
|}

= 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 !

== 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 ===

<source lang="ovml">
<OCAddon name="" param1="" param2="" ...>...</OCAddon>
</source>

=== 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 ===

<source lang="ovml">
<OFAddon name="" function="" param1="" ...>
</source>

=== 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éférence OvML

2013-06-05T08:01:46Z

Rodpec : /* OFWebStat */

[[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.

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 :

<source lang="ovml">
<OVnom-de-la-variable>
</source>

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

<source lang="ovml">
<OFPutVar name="nbArticles" value="10">
</source>

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 :

<source lang="ovml">
<OVnbArticles>
</source>

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 :

<source lang="ovml">
<OFPutVar name="babSlogan">
</source>

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.

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

<source lang="ovml">
<OFIfNotIsSet name="page" value="1">
</source>

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 <code><OVxxxx></code>.

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.

<source lang="ovml">
<OVnbArticles saveas="TotalArticles">
</source>

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.

{| class="prettytable"
! Value
!
|-
| n
| Récupère les n premiers caractères du contenu de la variable
|}

<source lang="ovml">
<OVbabSlogan strlen="100">
</source>

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 :

<source lang="ovml">
<OVbabSlogan strlen="100,...">
</source>

== striptags ==

Supprime les tags HTML de la variable :

{| class="prettytable"
! Value
!
|-
| 1
| Supprime les tags HTML de la variable
|}

<source lang="ovml">
<OVbabSlogan striptags="1">
</source>

== htmlentities ==

{| class="prettytable"
! Value
!
|-
| 1
| <nowiki>Convertit les entities HTML ( < devient &lt; )</nowiki>
|-
| 2
| <nowiki>Convertit en inverse les entities HTML ( &lt; devient < )</nowiki>
|}

<source lang="ovml">
<OVbabSlogan htmlentities="1">
</source>

== stripslashes ==

Supprime les slashs doublés du contenu de la variable

{| class="prettytable"
! Value
!
|-
| 1
| Supprime les slashs doublés du contenu de la variable
|}

<source lang="ovml">
<OVbabSlogan stripslashes="1">
</source>

== urlencode ==

{| class="prettytable"
! Value
!
|-
| 1
| Encode la variable pour l'utilisation dans une url
|}

<source lang="ovml">
<OVbabSlogan urlencode="1">
</source>

== jsencode ==

{| class="prettytable"
! Value
!
|-
| 1
| Encode la variable pour l'utilisation dans du javascript
|}

<source lang="ovml">
<OVbabSlogan jsencode="1">
</source>

== strcase ==

{| class="prettytable"
! Value
!
|-
| upper
| Convertit le contenu de la variable en majuscule
|-
| lower
| Convertit le contenu de la variable en minuscule
|}

<source lang="ovml">
<OVbabSlogan strcase="upper">
</source>

== nlremove ==

{| class="prettytable"
! Value
!
|-
| 1
| Supprime les retours chariots
|}

<source lang="ovml">
<OVbabSlogan nlremove="1">
</source>

== trim ==

{| class="prettytable"
! 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
|}

<source lang="ovml">
<OVbabSlogan trim="all">
</source>

== nl2br ==

{| class="prettytable"
! Value
!
|-
| <div align="right">1</div>
| <nowiki>Transforme les retours chariots en </nowiki>
|}

<source lang="ovml">
<OVbabSlogan nl2br="1">
</source>

== sprintf ==

{| class="prettytable"
! Value
!
|-
| Voir la documentation PHP pour la fonction sprintf
| Retourne une chaîne formatée
|}

<source lang="ovml">
<OVMoney sprintf="%01.2f">
</source>

== date ==

Permet de formater une date Ovidentia

{| class="prettytable"
! 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"
|}

<source lang="ovml">
<OVArticleDate date="%d %j %m %Y">
</source>

'''Remarque :'''

<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.

<source lang="ovml">
<OVbabCurrentDate date="%D %j %M" strcase="lower">
</source>

== author ==

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

{| class="prettytable"
! Value
!
|-
| %F
| Prénom
|-
| %M
| Deuxième prénom
|-
| %L
| Nom
|}

<source lang="ovml">
<OVArticleAuthor author="%F %L" strcase="lower">
</source>

= Les fonctions OvML =

On reconnaît les fonctions par la syntaxe suivante :

<source lang="ovml">
<OFxxxx ...>
</source>

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 <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>
</source>

'''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>
</source>

=== Syntaxe ===

<source lang="ovml">
<OFTranslate text="" [lang=""]>
</source>

=== 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

== OFPutVar ==

Permet de déclarer une nouvelle variable.

=== Syntaxe ===

<source lang="ovml">
<OFPutVar name="" [value=""]>
</source>

=== Paramètres ===

; name
: Nom de la variable

; value ''(optionnel)''
: Valeur à affecter à la variable

== OFGetVar ==

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

=== Syntaxe ===

<source lang="ovml">
<OFGetVar name="">
</source>

=== Paramètres ===

; name
: Nom de la variable à afficher

== OFIfNotIsSet ==

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

=== Syntaxe ===

<source lang="ovml">
<OFIfNotIsSet name="" [value=""]>
</source>

=== Paramètres ===

; name
: Nom de la variable

; value ''(optionnel)''
: Valeur à affecter à la variable

== OFInclude ==

Permet d'inclure un autre fichier OVML

=== Syntaxe ===

<source lang="ovml">
<OFInclude file="" [cache=""]>
</source>

=== 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 ===

<source lang="ovml">
<OFUrlContent url="">
</source>

=== 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 ===

<source lang="ovml">
<OFRecurse>
</source>

=== 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>).

<source lang="ovml">
<ul>
<OCArticleCategories>
<li>
<OVCategoryName>
<ul>
<OFRecurse parentid="<OVCategoryId>">
<OCArticleTopics categoryid="<OVCategoryId>">
<li><OVTopicName></li>
</OCArticleTopics>
</ul>
</li>
</OCArticleCategories>
</ul>
</source>

== Opérateurs arithmétiques ==

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

<source lang="ovml">
<OFAOxxxxx expr1="X" expr2="Y">
</source>

<source lang="ovml">
<OFAOxxxxx expr1="10" expr2="50">
</source>

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

<source lang="ovml">
<OFAOxxxxx expr1="<OVTotal>" expr2="50">
</source>

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.

<source lang="ovml">
<OFAOxxxxx expr1="<OVTotal>" expr2="50" saveas="NewTotal">
</source>

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 :

=== OFAOAddition ===

Permet d’additionner expr1 et expr2.

==== Syntaxe ====

<source lang="ovml">
<OFAOAddition expr1="" expr2="">
</source>

==== Paramètres ====

; expr1
: Premier terme de l'addition

; expr2
: Second terme de l'addition

=== OFAOSubtraction ===

Permet de soustraire expr2 à expr1.

==== Syntaxe ====

<source lang="ovml">
<OFAOSubtraction expr1="" expr2="">
</source>

==== Paramètres ====

; expr1
: Premier terme de la soustraction

; expr2
: Second terme de la soustraction

==== Exemple ====

<source lang="ovml">
<OFAOSubtraction expr1="10" expr2="20">
</source>

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 ====

<source lang="ovml">
<OFAOMultiplication expr1="" expr2="">
</source>

==== Paramètres ====

; expr1
: Premier terme de la multiplication

; expr2
: Second terme de la multiplication

=== OFAODivision ===

Permet de diviser expr1 par expr2.

==== Syntaxe ====

<source lang="ovml">
<OFAODivision expr1="" expr2="">
</source>

==== Paramètres ====

; expr1
: Premier terme de la division

; expr2
: Second terme de la division

==== Exemple ====

<source lang="ovml">
<OFAODivision expr1="10" expr2="20">
</source>

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 ====

<source lang="ovml">
<OFAOModulus expr1="" expr2="">
</source>

==== Paramètres ====

; expr1
: Premier terme du modulo

; expr2
: Second terme du modulo

==== Exemple ====

<source lang="ovml">
<OFAOModulus expr1="10" expr2="20">
</source>

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 ===

<source lang="ovml">
<OFHeader value="">
</source>

=== Paramètres ===

; value
: Valeur du header à modifier

=== Exemple ===

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

== OFSetCookie ==

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

=== Syntaxe ===

<source lang="ovml">
<OFSetCookie name="" expire="" [value=""]>
</source>

=== 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 ===

<source lang="ovml">
<OFGetCookie name="">
</source>

=== 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 ===

<source lang="ovml">
<OFSetSessionVar name="" value="">
</source>

=== 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 ===

<source lang="ovml">
<OFSetSessionVar name="babSectionsType" value="15">
</source>

affichera toutes les sections du portail

<source lang="ovml">
<OFSetSessionVar name="babSectionsType" value="4">
</source>

affichera uniquement les sections personnalisées du portail

<source lang="ovml">
<OFSetSessionVar name="babSectionsType" value="10">
</source>

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

<source lang="ovml">
<OFSetSessionVar name="babOvmlCurrentDelegation" value="5">
</source>

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

<source lang="ovml">
<OFSetSessionVar name="babOvmlCurrentDelegation" value="0">
</source>

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 ===

<source lang="ovml">
<OFRequest name="" saveas="" [default=""]>
</source>

=== Paramètres ===

; name
: Nom du paramètre GET dont on souhaite récupérer la valeur

; 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 ===

<source lang="ovml">
<OFPost name="" saveas="" [default=""]>
</source>

=== Paramètres ===

; name
: Nom du paramètre POST dont on souhaite récupérer la valeur

; 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 ===

<source lang="ovml">
<OFGet name="" saveas="" [default=""]>
</source>

=== Paramètres ===

; name
: Nom du paramètre GET dont on souhaite récupérer la valeur

; 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 ===

<source lang="ovml">
<OFSitemapPosition [sitemap=""] [basenode=""] [node=""] [keeplastknown=""]>
</source>

=== Paramètres ===

; 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 ===

<source lang="ovml">
<OFSitemapMenu [sitemap=""] [basenode=""] [selectednode=""] [keeplastknown=""] [maxdepth=""]>
</source>

=== 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é.

; 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).
: 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).

; 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.

== 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 ===

<source lang="ovml">
<OFSitemapCustomNodeId node="" [basenode=""] [saveas=""]>
</source>

=== 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 ===

<source lang="ovml">
<OFSitemapCustomNodeId node="bab_Articles" saveas="CustomNodeId">
<OFSitemapMenu basenode="<OVCustomNodeId>">
</source>

== 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 ===

<source lang="ovml">
<OFPreviousArticle articleid="" [topicid=""] [excludetopicid=""] [archive=""] [orderby=""] [order=""] [topicorder=""] [delegationid=""]>
</source>

=== 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 ===

<source lang="ovml">
<OFNextArticle articleid="" [topicid=""] [excludetopicid=""] [archive=""] [orderby=""] [order=""] [topicorder=""] [delegationid=""]>
</source>

=== 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 ==

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 ===

<source lang="ovml">
<OFWebStat name="" value="">
</source>

=== 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 ===

<source lang="ovml">
<OCArticle articleid="<OVarticleid>">

<OFWebStat name="bab_articles" value="<OVarticleid>">
</OCArticle>
</source>

== OFAddStylesheet ==

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

=== Syntaxe ===

<source lang="ovml">
<OFAddStylesheet file="">
</source>

=== Paramètres ===

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

= Les containers OvML =

La syntaxe des containers est comme suit :

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

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 ===

<source lang="ovml">
<OCxxxx expr1="" expr2="">...</OCxxxx>
</source>

=== Paramètres ===

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

=== Exemple ===

<source lang="ovml">
<OFPutVar name="BAB_SESS_LOGGED">
<OCIfEqual expr1="<BAB_SESS_LOGGED>" expr2="1">
Vous êtes connecté !
</OCIfEqual>
</source>

== 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 ===

<source lang="ovml">
<OCxxxx name="">...</OCxxxx>
</source>

=== Paramètres ===

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

=== Exemple ===

<source lang="ovml">
<OCIfIsSet name="variable">
Ce texte ne sera pas affiché.
</OCIfIsSet>

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

== OCIfUserMemberOfGroups ==

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

=== Syntaxe ===

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

=== 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 ===

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

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

== OCRecentFiles ==

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

=== Syntaxe ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

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

== OCRecentComments ==

Liste les derniers commentaires d'articles.

=== Syntaxe ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCArticleCategoryNext>...</OCArticleCategoryNext>
</source>

=== Variables ===

Idendiques à celles du container [[#OCArticleCategories|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 ===

<source lang="ovml">
<OCArticleCategoryPrevious>...</OCArticleCategoryPrevious>
</source>

=== Variables ===

Identiques à celles du container [[#OCArticleCategories|OCArticleCategories]].

== OCParentsArticleCategory ==

Liste des catégories de sujets parents.

=== Syntaxe ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 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 ===

<source lang="ovml">
<OCArticleTopicNext>...</OCArticleTopicNext>
</source>

=== Variables ===

Identiques à celles du container [[#OCArticleTopics|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 ===

<source lang="ovml">
<OCArticleTopicPrevious>....</OCArticleTopicPrevious>
</source>

=== Variables ===

Idem que ceux du container [[#OCArticleTopics|OCArticleTopics]].

== OCArticleTopic ==

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

=== Syntaxe ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCArticleTopic topicname="essai">...</OCArticleTopic>
</source>
Recherche tous les thèmes dont l'utilisateur a le droit et ayant pour nom "essai"

<source lang="ovml">
<OCArticleTopic topicid="1,2,3" topicname="essai">...</OCArticleTopic>
</source>
Recherche les thèmes d'id 1,2 3 ayant pour nom essai.

<source lang="ovml">
<OCArticleTopic topicid="1,2,3" topicname="%essai">...</OCArticleTopic>
</source>
Recherche les thèmes d'id 1,2 3 et dont le nom se termine par essai

<source lang="ovml">
<OCArticleTopic topicid="1,2,3" topicname="essai%">...</OCArticleTopic>
</source>
Recherche les thèmes d'id 1,2 3 et dont le nom commence par essai

<source lang="ovml">
<OCArticleTopic topicid="1,2,3" topicname="%essai%">...</OCArticleTopic>
</source>
Recherche les thèmes d'id 1,2 3 et dont le nom contient la chaîne essai

== OCArticles ==

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

=== Syntaxe ===

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

=== Paramètres ===

; topicid ''(optionnel)''
: Permet de préciser les thèmes d'articles concernés
: Id du thème ou plusieurs Ids séparés par une virgule
: Si omis, le container liste les articles tout thème confondu

; excludetopicid ''(optionnel)''
: Permet de préciser les thèmes d'articles à exclure à la différence du paramètre topicid
: Id du thème ou plusieurs Ids séparés par une virgule

; archive ''(optionnel)''
: yes : Donne la liste des articles archivés
: no ''(par défaut)'' : Donne la liste des articles non archivés

; offset ''(optionnel)''
: "n" indique le nombre d'articles à ignorer à partir du début de la liste
: 0 ''(par défaut)'' : aucune article n'est ignoré

; rows ''(optionnel)''
: "n" combien il faut en prendre
: -1 ''(par défaut)'' : toutes les lignes sont prises

; order ''(optionnel)''
: asc : Ordonne les articles par ordre croissant en fonction de la date
: desc ''(par défaut)'' : Ordonne les articles par ordre décroissant en fonction de la date
: rand : Ordonne les articles aléatoirement

; orderby ''(optionnel)''
: Peut être couplé avec l'attribut order.
: creation : Ordonne les articles par ordre de création en fonction de la date
: publication : Ordonne les articles par ordre de publication en fonction de la date
: modification ''(par défaut)'' : Ordonne les articles par ordre de modification en fonction de la date
: rating : Ordonne les articles en fonction de la note moyenne attribuée dans les commentaires

; topicorder ''(optionnel)''
: yes : Utilise l'ordre défini par le gestionnaire du thème d'articles
: no ''(par défaut)'' : N'utilise l'ordre défini par le gestionnaire du thème d'articles

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

; imageheightmax ''(optionnel)''
: Valeur en pixels. Permet de préciser la hauteur maximum de l'image associée.
: Si omis, l'image n'est pas redimensionnée et garde sa taille d'origine.

; imagewidthmax ''(optionnel)''
: Valeur en pixels. Permet de préciser la largeur maximum de l'image associée.
: Si omis, l'image n'est pas redimensionnée et garde sa taille d'origine.

; minrating ''(optionnel)''
: Permet de filtrer les articles ayant une note moyenne dans les commentaires supérieure ou égale à la valeur fournie en paramètre
: Valeur numérique.

=== Variables ===

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

== OCArticleNext ==

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

=== Syntaxe ===

<source lang="ovml">
<OCArticleNext>...</OCArticleNext>
</source>

=== Variables ===

Identiques à celles du container [[#OCArticles|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 ===

<source lang="ovml">
<OCArticlePrevious>...</OCArticlePrevious>
</source>

=== Variables ===

Identiques à celles du container [[#OCArticles|OCArticles]].

== OCArticle ==

Donne les informations sur un article donné.

=== Syntaxe ===

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

=== 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 ===

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

== OCArticleFiles ==

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

=== Syntaxe ===

<source lang="ovml">
<OCArticleFiles articleid="">...</OCArticleFiles>
</source>

=== Paramètres ===

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

=== Variables ===

{| class="prettytable"
! Variable
! Valeur
|-
| OVArticleFileName
| Nom du fichier
|-
| OVArticleFileDescription
| Description du fichier
|-
| OVArticleFileUrlGet
| Url pour atteindre le fichier
|}

== OCForums ==

Liste des forums.

=== Syntaxe ===

<source lang="ovml">
<OCForums [forumid=""] [delegationid=""]>...</OCForums>
</source>

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCForumNext>...</OCForumNext>
</source>

=== Variables ===

Identiques à celles du container [[#OCForums|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 ===

<source lang="ovml">
<OCForumPrevious>...</OCForumPrevious>
</source>

=== Variables ===

Identiques à celles du container [[#OCForums|OCForums]].

== OCForum ==

Donne les informations sur un forum donné.

=== Syntaxe ===

<source lang="ovml">
<OCForum forumid="">...</OCForum>
</source>

=== Paramètres ===

; forumid :
: Id du forum

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCThread threadid="" [order=""]>...</OCThread>
</source>

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCPost postid="" [order=""]>...</OCPost>
</source>

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCPostFiles postid="">...</OCPost>
</source>

=== Paramètres ===

; postid
: Id de la contribution 

=== Variables ===

{| class="prettytable"
! Variable
! Valeur
|-
| OVPostFileName
| Nom du fichier
|-
| OVPostFileUrlGet
| Url pour atteindre le fichier
|}

== OCFolders ==

Liste les répertoires partageables.

=== Syntaxe ===

<source lang="ovml">
<OCFolders [folderid=""] [delegationid=""]>...</OCFolders>
</source>

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFolderNext>...</OCFolderNext>
</source>

=== Variables ===

Identique à celles du container [[#OCFolders|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 ===

<source lang="ovml">
<OCFolderPrevious>...</OCFolderPrevious>
</source>

=== Variables ===

Identique à celles du container [[#OCFolders|OCFolders]].

== OCFolder ==

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

=== Syntaxe ===

<source lang="ovml">
<OCFolder folderid="">...</OCFolder>
</source>

=== Paramètres ===

; folderid
: Id du répertoire

=== Variables ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 :'''
<source lang="ovml">
<a href="<OVFileUrl>&inl=1"><OVFileName></a>
</source>

=== Syntaxe ===

<source lang="ovml">
<OCFiles folderid="" rows="" offset="" [path=""]>...</OCFiles>
</source>

=== 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

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFileNext>...</OCFileNext>
</source>

=== Variables ===

Identiques à celles du container [[#OCFiles|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 ===

<source lang="ovml">
<OCFilePrevious>...</OCFilePrevious>
</source>

=== Variables ===

Identiques à celles du container [[#OCFolders|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 :'''
<source lang="ovml">
<a href="<OVFileUrl>&inl=1"><OVFileName></a>
</source>

=== Syntaxe ===

<source lang="ovml">
<OCFile fileid="">...</OCFile>
</source>

=== Paramètres ===

; fileid
: Id du fichier

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFileFields fileid="">...</OCFileFields>
</source>

=== Paramètres ===

; fileid
: Id du fichier

=== Variables ===

{| class="prettytable"
! Variable
! Valeur
|-
| OVFileFieldName
| Nom du champ
|-
| OVFileFieldValue
| Valeur du champ
|}

== OCFaqs ==

Donne la liste des Faqs.

=== Syntaxe ===

<source lang="ovml">
<OCFaqs [faqid=""] [delegationid=""]>...</OCFaqs>
</source>

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFaqNext>...</OCFaqNext>
</source>

=== Variables ===

Identiques à celles du container [[#OCFaqs|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 ===

<source lang="ovml">
<OCFaqPrevious>...</OCFaqPrevious>
</source>

=== Variables ===

Identiques à celles du container [[#OCFaqs|OCFaqs]].

== OCFaq ==

Donne les informations sur une Faq donnée.

=== Syntaxe ===

<source lang="ovml">
<OCFaq faqid="">...</OCFaq>
</source>

=== Paramètres ===

; faqid
: Id de la Faq

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFaqSubCategories faqid="" [delegationid=""]>...</OCFaqSubCategories>
</source>

=== Paramètres ===

; faqid
: Id de la faq

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

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFaqSubCategory faqsubcatid="">...</OCFaqSubCategory>
</source>

=== Paramètres ===

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

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFaqQuestions [faqid=""] [faqsubcatid=""]>...</OCFaqQuestions>
</source>

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFaqQuestionNext>...</OCFaqQuestionNext>
</source>

=== Variables ===

Identiques à celles du container [[#OCFaqQuestions|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 ===

<source lang="ovml">
<OCFaqQuestionPrevious>...</OCFaqQuestionPrevious>
</source>

=== Variables ===

Identiques à celles du container [[#OCFaqQuestions|OCFaqQuestions]].

== OCFaqQuestion ==

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

=== Syntaxe ===

<source lang="ovml">
<OCFaqQuestion questionid="">...</OCFaqQuestion>
</source>

=== Paramètres ===

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

=== Variables ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

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

== OCWaitingComments ==

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

=== Syntaxe ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCCalendarCategories [filter=""]>...</OCCalendarCategories>
</source>

=== Paramètres ===

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

=== Variables ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
| 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 ===

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

=== 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 ===

{| class="prettytable"
| 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)
|}

== OCDbDirectories ==

Liste les annuaires de base de données

=== Syntaxe ===

<source lang="ovml">
<OCDbDirectories [directoryid=""] [delegationid=""]>...</OCDbDirectories>
</source>

=== 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.

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCDbDirectory directoryid="" [type=""]>...</OCDbDirectory>
</source>

=== Paramètres ===

; directoryid
: Id de l'annuaire

; type ''(optionnel)''
: « database » ou « group », si omis, le container liste tous les annuaires.

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCDbDirectoryFields directoryid="" [all=""]>...</OCDbDirectoryFields>
</source>

=== 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 ===

{| class="prettytable"
! Variable
! Valeur
|-
| OVDirectoryFieldName
| Intitulé du champ
|-
| OVDirectoryFieldId
| Identifiant du champ
|}

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

{| class="prettytable"
! 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 ===

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

=== Paramètres ===

; directoryid
: Id de l'annuaire

; all ''(optionnel)''
: Ignoré si l'attribut '''fields''' est spécifié
: 1 : Donne tous les champs pour chaque membre
: 0 : Donne uniquement les champs choisis pour l'affichage lors de la configuration du l'annuaire
: Si omis, liste uniquement les champs choisis.

; fields ''(optionnel)''
: liste des identifiants des champs souhaités séparés par des virgules ( exemple "sn,givenname,email" )

; orderby ''(optionnel)''
: Identifiant du champ à utiliser pour ordonner la liste

; order ''(optionnel)''
: asc : ordonne par ordre croissant
: desc : ordonne par ordre décroissant

; like ''(optionnel)''
: Restreint la liste des membres ayant le champ commençant par ce motif ( exemple like="A" )

=== Variables ===

{| class="prettytable"
! 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
| <nowiki>Intitulé du champ ayant pour identifiant xxxxxxx ( ex <OVgivennameName> ) </nowiki>
|-
| OVxxxxxxValue
| <nowiki>Contenu du champ ayant pour identifiant xxxxxxx ( ex <OVgivennameValue> ) </nowiki>
|}

== OCDbDirectoryMemberFields ==

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

Liste les différents champs pour le membre courant.

=== Syntaxe ===

<source lang="ovml">
<OCDbDirectoryMemberFields>...</OCDbDirectoryMemberFields>
</source>

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCDbDirectoryEntry directoryid="" memberid="" userid="">...</OCDbDirectoryEntry>
</source>

=== 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 ===

{| class="prettytable"
! 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
| <nowiki>Intitulé du champ ayant pour identifiant xxxxxxx ( ex <OVgivennameName> ) </nowiki>
|-
| OVxxxxxxValue
| <nowiki>Contenu du champ ayant pour identifiant xxxxxxx ( ex <OVgivennameValue> ) </nowiki>
|-
| 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 ===

<source lang="ovml">
<OCDbDirectoryEntryFields>...</OCDbDirectoryEntryFields>
</source>

=== Variables ===

{| class="prettytable"
! Variable
! Valeur
|-
| OVDirectoryFieldName
| Intitulé du champ
|-
| OVDirectoryFieldValue
| Valeur du champ
|}

== OCDbDirectoryAcl ==

Liste les utilisateurs ayant des droits sur un annuaire.

=== Syntaxe ===

<source lang="ovml">
<OCDbDirectoryAcl directoryid="" type="">...</OCDbDirectoryAcl>
</source>

=== Paramètres ===

; directoryid
: Id de l'annuaire

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

=== Variables ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCDelegationItems delegationid="">...</OCDelegationItems>
</source>

=== Paramètres ===

; delegationid
: Id de la délégation

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCDelegationAdministrators delegationid="">...</OCDelegationAdministrators>
</source>

=== Paramètres ===

; delegationid
: Id de la délégation

=== Variables ===

{| class="prettytable"
! Variable
! Valeur
|-
| OVDelegationUserId
| Id de l'administrateur
|}

== OCDelegationsCategories ==

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

=== Syntaxe ===

<source lang="ovml">
<OCDelegationsCategories [categoryid=""]>....</OCDelegationsCategories>
</source>

=== Paramètres ===

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

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCDelegationsCategory [categoryid=""]>...</OCDelegationsCategory>
</source>

=== Paramètres ===

; categoryid
: Id de la délégation

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCTmSpaces>...</OCTmSpaces>
</source>

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCTmProjects spaceid="">...</OCTmProjects>
</source>

=== Paramètres ===

; spaceid
: Id de l'espace de projets

=== Variables ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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.

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

=== 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 ===

{| class="prettytable"
! Variable
! Valeur
|-
| OVEntityId
| Identifiant (entier) de l'entité
|-
| OVEntityName
| Nom de l'entité
|-
| OVEntityDescription
| Description de l'entité
|}

== OCMultipages ==

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

=== Syntaxe ===

<source lang="ovml">
<OCMultipages total="" maxpages="" perpage="" currentpage="">...</OCMultipages>
</source>

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCSitemapEntries node="" [sitemap=""] [limit=""]>...</OCSitemapEntries>
</source>

=== 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...
: Si node n'est pas spécifié,

; 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 ===

{| 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
|}

== 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 ===

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

=== 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.

; 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 =====

{| 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
|}

= 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 !

== 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 ===

<source lang="ovml">
<OCAddon name="" param1="" param2="" ...>...</OCAddon>
</source>

=== 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 ===

<source lang="ovml">
<OFAddon name="" function="" param1="" ...>
</source>

=== 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éférence OvML

2013-06-05T07:50:01Z

Rodpec : /* OFIfNotIsSet */

[[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.

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 :

<source lang="ovml">
<OVnom-de-la-variable>
</source>

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

<source lang="ovml">
<OFPutVar name="nbArticles" value="10">
</source>

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 :

<source lang="ovml">
<OVnbArticles>
</source>

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 :

<source lang="ovml">
<OFPutVar name="babSlogan">
</source>

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.

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

<source lang="ovml">
<OFIfNotIsSet name="page" value="1">
</source>

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 <code><OVxxxx></code>.

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.

<source lang="ovml">
<OVnbArticles saveas="TotalArticles">
</source>

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.

{| class="prettytable"
! Value
!
|-
| n
| Récupère les n premiers caractères du contenu de la variable
|}

<source lang="ovml">
<OVbabSlogan strlen="100">
</source>

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 :

<source lang="ovml">
<OVbabSlogan strlen="100,...">
</source>

== striptags ==

Supprime les tags HTML de la variable :

{| class="prettytable"
! Value
!
|-
| 1
| Supprime les tags HTML de la variable
|}

<source lang="ovml">
<OVbabSlogan striptags="1">
</source>

== htmlentities ==

{| class="prettytable"
! Value
!
|-
| 1
| <nowiki>Convertit les entities HTML ( < devient &lt; )</nowiki>
|-
| 2
| <nowiki>Convertit en inverse les entities HTML ( &lt; devient < )</nowiki>
|}

<source lang="ovml">
<OVbabSlogan htmlentities="1">
</source>

== stripslashes ==

Supprime les slashs doublés du contenu de la variable

{| class="prettytable"
! Value
!
|-
| 1
| Supprime les slashs doublés du contenu de la variable
|}

<source lang="ovml">
<OVbabSlogan stripslashes="1">
</source>

== urlencode ==

{| class="prettytable"
! Value
!
|-
| 1
| Encode la variable pour l'utilisation dans une url
|}

<source lang="ovml">
<OVbabSlogan urlencode="1">
</source>

== jsencode ==

{| class="prettytable"
! Value
!
|-
| 1
| Encode la variable pour l'utilisation dans du javascript
|}

<source lang="ovml">
<OVbabSlogan jsencode="1">
</source>

== strcase ==

{| class="prettytable"
! Value
!
|-
| upper
| Convertit le contenu de la variable en majuscule
|-
| lower
| Convertit le contenu de la variable en minuscule
|}

<source lang="ovml">
<OVbabSlogan strcase="upper">
</source>

== nlremove ==

{| class="prettytable"
! Value
!
|-
| 1
| Supprime les retours chariots
|}

<source lang="ovml">
<OVbabSlogan nlremove="1">
</source>

== trim ==

{| class="prettytable"
! 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
|}

<source lang="ovml">
<OVbabSlogan trim="all">
</source>

== nl2br ==

{| class="prettytable"
! Value
!
|-
| <div align="right">1</div>
| <nowiki>Transforme les retours chariots en </nowiki>
|}

<source lang="ovml">
<OVbabSlogan nl2br="1">
</source>

== sprintf ==

{| class="prettytable"
! Value
!
|-
| Voir la documentation PHP pour la fonction sprintf
| Retourne une chaîne formatée
|}

<source lang="ovml">
<OVMoney sprintf="%01.2f">
</source>

== date ==

Permet de formater une date Ovidentia

{| class="prettytable"
! 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"
|}

<source lang="ovml">
<OVArticleDate date="%d %j %m %Y">
</source>

'''Remarque :'''

<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.

<source lang="ovml">
<OVbabCurrentDate date="%D %j %M" strcase="lower">
</source>

== author ==

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

{| class="prettytable"
! Value
!
|-
| %F
| Prénom
|-
| %M
| Deuxième prénom
|-
| %L
| Nom
|}

<source lang="ovml">
<OVArticleAuthor author="%F %L" strcase="lower">
</source>

= Les fonctions OvML =

On reconnaît les fonctions par la syntaxe suivante :

<source lang="ovml">
<OFxxxx ...>
</source>

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 <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>
</source>

'''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>
</source>

=== Syntaxe ===

<source lang="ovml">
<OFTranslate text="" [lang=""]>
</source>

=== 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

== OFPutVar ==

Permet de déclarer une nouvelle variable.

=== Syntaxe ===

<source lang="ovml">
<OFPutVar name="" [value=""]>
</source>

=== Paramètres ===

; name
: Nom de la variable

; value ''(optionnel)''
: Valeur à affecter à la variable

== OFGetVar ==

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

=== Syntaxe ===

<source lang="ovml">
<OFGetVar name="">
</source>

=== Paramètres ===

; name
: Nom de la variable à afficher

== OFIfNotIsSet ==

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

=== Syntaxe ===

<source lang="ovml">
<OFIfNotIsSet name="" [value=""]>
</source>

=== Paramètres ===

; name
: Nom de la variable

; value ''(optionnel)''
: Valeur à affecter à la variable

== OFInclude ==

Permet d'inclure un autre fichier OVML

=== Syntaxe ===

<source lang="ovml">
<OFInclude file="" [cache=""]>
</source>

=== 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 ===

<source lang="ovml">
<OFUrlContent url="">
</source>

=== 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 ===

<source lang="ovml">
<OFRecurse>
</source>

=== 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>).

<source lang="ovml">
<ul>
<OCArticleCategories>
<li>
<OVCategoryName>
<ul>
<OFRecurse parentid="<OVCategoryId>">
<OCArticleTopics categoryid="<OVCategoryId>">
<li><OVTopicName></li>
</OCArticleTopics>
</ul>
</li>
</OCArticleCategories>
</ul>
</source>

== Opérateurs arithmétiques ==

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

<source lang="ovml">
<OFAOxxxxx expr1="X" expr2="Y">
</source>

<source lang="ovml">
<OFAOxxxxx expr1="10" expr2="50">
</source>

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

<source lang="ovml">
<OFAOxxxxx expr1="<OVTotal>" expr2="50">
</source>

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.

<source lang="ovml">
<OFAOxxxxx expr1="<OVTotal>" expr2="50" saveas="NewTotal">
</source>

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 :

=== OFAOAddition ===

Permet d’additionner expr1 et expr2.

==== Syntaxe ====

<source lang="ovml">
<OFAOAddition expr1="" expr2="">
</source>

==== Paramètres ====

; expr1
: Premier terme de l'addition

; expr2
: Second terme de l'addition

=== OFAOSubtraction ===

Permet de soustraire expr2 à expr1.

==== Syntaxe ====

<source lang="ovml">
<OFAOSubtraction expr1="" expr2="">
</source>

==== Paramètres ====

; expr1
: Premier terme de la soustraction

; expr2
: Second terme de la soustraction

==== Exemple ====

<source lang="ovml">
<OFAOSubtraction expr1="10" expr2="20">
</source>

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 ====

<source lang="ovml">
<OFAOMultiplication expr1="" expr2="">
</source>

==== Paramètres ====

; expr1
: Premier terme de la multiplication

; expr2
: Second terme de la multiplication

=== OFAODivision ===

Permet de diviser expr1 par expr2.

==== Syntaxe ====

<source lang="ovml">
<OFAODivision expr1="" expr2="">
</source>

==== Paramètres ====

; expr1
: Premier terme de la division

; expr2
: Second terme de la division

==== Exemple ====

<source lang="ovml">
<OFAODivision expr1="10" expr2="20">
</source>

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 ====

<source lang="ovml">
<OFAOModulus expr1="" expr2="">
</source>

==== Paramètres ====

; expr1
: Premier terme du modulo

; expr2
: Second terme du modulo

==== Exemple ====

<source lang="ovml">
<OFAOModulus expr1="10" expr2="20">
</source>

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 ===

<source lang="ovml">
<OFHeader value="">
</source>

=== Paramètres ===

; value
: Valeur du header à modifier

=== Exemple ===

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

== OFSetCookie ==

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

=== Syntaxe ===

<source lang="ovml">
<OFSetCookie name="" expire="" [value=""]>
</source>

=== 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 ===

<source lang="ovml">
<OFGetCookie name="">
</source>

=== 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 ===

<source lang="ovml">
<OFSetSessionVar name="" value="">
</source>

=== 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 ===

<source lang="ovml">
<OFSetSessionVar name="babSectionsType" value="15">
</source>

affichera toutes les sections du portail

<source lang="ovml">
<OFSetSessionVar name="babSectionsType" value="4">
</source>

affichera uniquement les sections personnalisées du portail

<source lang="ovml">
<OFSetSessionVar name="babSectionsType" value="10">
</source>

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

<source lang="ovml">
<OFSetSessionVar name="babOvmlCurrentDelegation" value="5">
</source>

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

<source lang="ovml">
<OFSetSessionVar name="babOvmlCurrentDelegation" value="0">
</source>

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 ===

<source lang="ovml">
<OFRequest name="" saveas="" [default=""]>
</source>

=== Paramètres ===

; name
: Nom du paramètre GET dont on souhaite récupérer la valeur

; 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 ===

<source lang="ovml">
<OFPost name="" saveas="" [default=""]>
</source>

=== Paramètres ===

; name
: Nom du paramètre POST dont on souhaite récupérer la valeur

; 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 ===

<source lang="ovml">
<OFGet name="" saveas="" [default=""]>
</source>

=== Paramètres ===

; name
: Nom du paramètre GET dont on souhaite récupérer la valeur

; 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 ===

<source lang="ovml">
<OFSitemapPosition [sitemap=""] [basenode=""] [node=""] [keeplastknown=""]>
</source>

=== Paramètres ===

; 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 ===

<source lang="ovml">
<OFSitemapMenu [sitemap=""] [basenode=""] [selectednode=""] [keeplastknown=""] [maxdepth=""]>
</source>

=== 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é.

; 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).
: 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).

; 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.

== 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 ===

<source lang="ovml">
<OFSitemapCustomNodeId node="" [basenode=""] [saveas=""]>
</source>

=== 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 ===

<source lang="ovml">
<OFSitemapCustomNodeId node="bab_Articles" saveas="CustomNodeId">
<OFSitemapMenu basenode="<OVCustomNodeId>">
</source>

== 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 ===

<source lang="ovml">
<OFPreviousArticle articleid="" [topicid=""] [excludetopicid=""] [archive=""] [orderby=""] [order=""] [topicorder=""] [delegationid=""]>
</source>

=== 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 ===

<source lang="ovml">
<OFNextArticle articleid="" [topicid=""] [excludetopicid=""] [archive=""] [orderby=""] [order=""] [topicorder=""] [delegationid=""]>
</source>

=== 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 ==

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 ===

<source lang="ovml">
<OFWebStat name="" value="">
</source>

=== 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 ===

<source lang="ovml">
<OCArticle articleid="<OVarticleid>">

<OFWebStat name="bab_articles" value="<OVarticleid>">
</OCArticle>
</source>

= Les containers OvML =

La syntaxe des containers est comme suit :

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

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 ===

<source lang="ovml">
<OCxxxx expr1="" expr2="">...</OCxxxx>
</source>

=== Paramètres ===

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

=== Exemple ===

<source lang="ovml">
<OFPutVar name="BAB_SESS_LOGGED">
<OCIfEqual expr1="<BAB_SESS_LOGGED>" expr2="1">
Vous êtes connecté !
</OCIfEqual>
</source>

== 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 ===

<source lang="ovml">
<OCxxxx name="">...</OCxxxx>
</source>

=== Paramètres ===

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

=== Exemple ===

<source lang="ovml">
<OCIfIsSet name="variable">
Ce texte ne sera pas affiché.
</OCIfIsSet>

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

== OCIfUserMemberOfGroups ==

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

=== Syntaxe ===

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

=== 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 ===

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

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

== OCRecentFiles ==

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

=== Syntaxe ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

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

== OCRecentComments ==

Liste les derniers commentaires d'articles.

=== Syntaxe ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCArticleCategoryNext>...</OCArticleCategoryNext>
</source>

=== Variables ===

Idendiques à celles du container [[#OCArticleCategories|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 ===

<source lang="ovml">
<OCArticleCategoryPrevious>...</OCArticleCategoryPrevious>
</source>

=== Variables ===

Identiques à celles du container [[#OCArticleCategories|OCArticleCategories]].

== OCParentsArticleCategory ==

Liste des catégories de sujets parents.

=== Syntaxe ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 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 ===

<source lang="ovml">
<OCArticleTopicNext>...</OCArticleTopicNext>
</source>

=== Variables ===

Identiques à celles du container [[#OCArticleTopics|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 ===

<source lang="ovml">
<OCArticleTopicPrevious>....</OCArticleTopicPrevious>
</source>

=== Variables ===

Idem que ceux du container [[#OCArticleTopics|OCArticleTopics]].

== OCArticleTopic ==

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

=== Syntaxe ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCArticleTopic topicname="essai">...</OCArticleTopic>
</source>
Recherche tous les thèmes dont l'utilisateur a le droit et ayant pour nom "essai"

<source lang="ovml">
<OCArticleTopic topicid="1,2,3" topicname="essai">...</OCArticleTopic>
</source>
Recherche les thèmes d'id 1,2 3 ayant pour nom essai.

<source lang="ovml">
<OCArticleTopic topicid="1,2,3" topicname="%essai">...</OCArticleTopic>
</source>
Recherche les thèmes d'id 1,2 3 et dont le nom se termine par essai

<source lang="ovml">
<OCArticleTopic topicid="1,2,3" topicname="essai%">...</OCArticleTopic>
</source>
Recherche les thèmes d'id 1,2 3 et dont le nom commence par essai

<source lang="ovml">
<OCArticleTopic topicid="1,2,3" topicname="%essai%">...</OCArticleTopic>
</source>
Recherche les thèmes d'id 1,2 3 et dont le nom contient la chaîne essai

== OCArticles ==

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

=== Syntaxe ===

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

=== Paramètres ===

; topicid ''(optionnel)''
: Permet de préciser les thèmes d'articles concernés
: Id du thème ou plusieurs Ids séparés par une virgule
: Si omis, le container liste les articles tout thème confondu

; excludetopicid ''(optionnel)''
: Permet de préciser les thèmes d'articles à exclure à la différence du paramètre topicid
: Id du thème ou plusieurs Ids séparés par une virgule

; archive ''(optionnel)''
: yes : Donne la liste des articles archivés
: no ''(par défaut)'' : Donne la liste des articles non archivés

; offset ''(optionnel)''
: "n" indique le nombre d'articles à ignorer à partir du début de la liste
: 0 ''(par défaut)'' : aucune article n'est ignoré

; rows ''(optionnel)''
: "n" combien il faut en prendre
: -1 ''(par défaut)'' : toutes les lignes sont prises

; order ''(optionnel)''
: asc : Ordonne les articles par ordre croissant en fonction de la date
: desc ''(par défaut)'' : Ordonne les articles par ordre décroissant en fonction de la date
: rand : Ordonne les articles aléatoirement

; orderby ''(optionnel)''
: Peut être couplé avec l'attribut order.
: creation : Ordonne les articles par ordre de création en fonction de la date
: publication : Ordonne les articles par ordre de publication en fonction de la date
: modification ''(par défaut)'' : Ordonne les articles par ordre de modification en fonction de la date
: rating : Ordonne les articles en fonction de la note moyenne attribuée dans les commentaires

; topicorder ''(optionnel)''
: yes : Utilise l'ordre défini par le gestionnaire du thème d'articles
: no ''(par défaut)'' : N'utilise l'ordre défini par le gestionnaire du thème d'articles

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

; imageheightmax ''(optionnel)''
: Valeur en pixels. Permet de préciser la hauteur maximum de l'image associée.
: Si omis, l'image n'est pas redimensionnée et garde sa taille d'origine.

; imagewidthmax ''(optionnel)''
: Valeur en pixels. Permet de préciser la largeur maximum de l'image associée.
: Si omis, l'image n'est pas redimensionnée et garde sa taille d'origine.

; minrating ''(optionnel)''
: Permet de filtrer les articles ayant une note moyenne dans les commentaires supérieure ou égale à la valeur fournie en paramètre
: Valeur numérique.

=== Variables ===

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

== OCArticleNext ==

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

=== Syntaxe ===

<source lang="ovml">
<OCArticleNext>...</OCArticleNext>
</source>

=== Variables ===

Identiques à celles du container [[#OCArticles|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 ===

<source lang="ovml">
<OCArticlePrevious>...</OCArticlePrevious>
</source>

=== Variables ===

Identiques à celles du container [[#OCArticles|OCArticles]].

== OCArticle ==

Donne les informations sur un article donné.

=== Syntaxe ===

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

=== 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 ===

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

== OCArticleFiles ==

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

=== Syntaxe ===

<source lang="ovml">
<OCArticleFiles articleid="">...</OCArticleFiles>
</source>

=== Paramètres ===

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

=== Variables ===

{| class="prettytable"
! Variable
! Valeur
|-
| OVArticleFileName
| Nom du fichier
|-
| OVArticleFileDescription
| Description du fichier
|-
| OVArticleFileUrlGet
| Url pour atteindre le fichier
|}

== OCForums ==

Liste des forums.

=== Syntaxe ===

<source lang="ovml">
<OCForums [forumid=""] [delegationid=""]>...</OCForums>
</source>

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCForumNext>...</OCForumNext>
</source>

=== Variables ===

Identiques à celles du container [[#OCForums|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 ===

<source lang="ovml">
<OCForumPrevious>...</OCForumPrevious>
</source>

=== Variables ===

Identiques à celles du container [[#OCForums|OCForums]].

== OCForum ==

Donne les informations sur un forum donné.

=== Syntaxe ===

<source lang="ovml">
<OCForum forumid="">...</OCForum>
</source>

=== Paramètres ===

; forumid :
: Id du forum

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCThread threadid="" [order=""]>...</OCThread>
</source>

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCPost postid="" [order=""]>...</OCPost>
</source>

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCPostFiles postid="">...</OCPost>
</source>

=== Paramètres ===

; postid
: Id de la contribution 

=== Variables ===

{| class="prettytable"
! Variable
! Valeur
|-
| OVPostFileName
| Nom du fichier
|-
| OVPostFileUrlGet
| Url pour atteindre le fichier
|}

== OCFolders ==

Liste les répertoires partageables.

=== Syntaxe ===

<source lang="ovml">
<OCFolders [folderid=""] [delegationid=""]>...</OCFolders>
</source>

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFolderNext>...</OCFolderNext>
</source>

=== Variables ===

Identique à celles du container [[#OCFolders|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 ===

<source lang="ovml">
<OCFolderPrevious>...</OCFolderPrevious>
</source>

=== Variables ===

Identique à celles du container [[#OCFolders|OCFolders]].

== OCFolder ==

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

=== Syntaxe ===

<source lang="ovml">
<OCFolder folderid="">...</OCFolder>
</source>

=== Paramètres ===

; folderid
: Id du répertoire

=== Variables ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 :'''
<source lang="ovml">
<a href="<OVFileUrl>&inl=1"><OVFileName></a>
</source>

=== Syntaxe ===

<source lang="ovml">
<OCFiles folderid="" rows="" offset="" [path=""]>...</OCFiles>
</source>

=== 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

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFileNext>...</OCFileNext>
</source>

=== Variables ===

Identiques à celles du container [[#OCFiles|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 ===

<source lang="ovml">
<OCFilePrevious>...</OCFilePrevious>
</source>

=== Variables ===

Identiques à celles du container [[#OCFolders|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 :'''
<source lang="ovml">
<a href="<OVFileUrl>&inl=1"><OVFileName></a>
</source>

=== Syntaxe ===

<source lang="ovml">
<OCFile fileid="">...</OCFile>
</source>

=== Paramètres ===

; fileid
: Id du fichier

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFileFields fileid="">...</OCFileFields>
</source>

=== Paramètres ===

; fileid
: Id du fichier

=== Variables ===

{| class="prettytable"
! Variable
! Valeur
|-
| OVFileFieldName
| Nom du champ
|-
| OVFileFieldValue
| Valeur du champ
|}

== OCFaqs ==

Donne la liste des Faqs.

=== Syntaxe ===

<source lang="ovml">
<OCFaqs [faqid=""] [delegationid=""]>...</OCFaqs>
</source>

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFaqNext>...</OCFaqNext>
</source>

=== Variables ===

Identiques à celles du container [[#OCFaqs|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 ===

<source lang="ovml">
<OCFaqPrevious>...</OCFaqPrevious>
</source>

=== Variables ===

Identiques à celles du container [[#OCFaqs|OCFaqs]].

== OCFaq ==

Donne les informations sur une Faq donnée.

=== Syntaxe ===

<source lang="ovml">
<OCFaq faqid="">...</OCFaq>
</source>

=== Paramètres ===

; faqid
: Id de la Faq

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFaqSubCategories faqid="" [delegationid=""]>...</OCFaqSubCategories>
</source>

=== Paramètres ===

; faqid
: Id de la faq

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

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFaqSubCategory faqsubcatid="">...</OCFaqSubCategory>
</source>

=== Paramètres ===

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

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFaqQuestions [faqid=""] [faqsubcatid=""]>...</OCFaqQuestions>
</source>

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFaqQuestionNext>...</OCFaqQuestionNext>
</source>

=== Variables ===

Identiques à celles du container [[#OCFaqQuestions|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 ===

<source lang="ovml">
<OCFaqQuestionPrevious>...</OCFaqQuestionPrevious>
</source>

=== Variables ===

Identiques à celles du container [[#OCFaqQuestions|OCFaqQuestions]].

== OCFaqQuestion ==

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

=== Syntaxe ===

<source lang="ovml">
<OCFaqQuestion questionid="">...</OCFaqQuestion>
</source>

=== Paramètres ===

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

=== Variables ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

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

== OCWaitingComments ==

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

=== Syntaxe ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCCalendarCategories [filter=""]>...</OCCalendarCategories>
</source>

=== Paramètres ===

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

=== Variables ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
| 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 ===

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

=== 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 ===

{| class="prettytable"
| 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)
|}

== OCDbDirectories ==

Liste les annuaires de base de données

=== Syntaxe ===

<source lang="ovml">
<OCDbDirectories [directoryid=""] [delegationid=""]>...</OCDbDirectories>
</source>

=== 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.

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCDbDirectory directoryid="" [type=""]>...</OCDbDirectory>
</source>

=== Paramètres ===

; directoryid
: Id de l'annuaire

; type ''(optionnel)''
: « database » ou « group », si omis, le container liste tous les annuaires.

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCDbDirectoryFields directoryid="" [all=""]>...</OCDbDirectoryFields>
</source>

=== 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 ===

{| class="prettytable"
! Variable
! Valeur
|-
| OVDirectoryFieldName
| Intitulé du champ
|-
| OVDirectoryFieldId
| Identifiant du champ
|}

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

{| class="prettytable"
! 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 ===

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

=== Paramètres ===

; directoryid
: Id de l'annuaire

; all ''(optionnel)''
: Ignoré si l'attribut '''fields''' est spécifié
: 1 : Donne tous les champs pour chaque membre
: 0 : Donne uniquement les champs choisis pour l'affichage lors de la configuration du l'annuaire
: Si omis, liste uniquement les champs choisis.

; fields ''(optionnel)''
: liste des identifiants des champs souhaités séparés par des virgules ( exemple "sn,givenname,email" )

; orderby ''(optionnel)''
: Identifiant du champ à utiliser pour ordonner la liste

; order ''(optionnel)''
: asc : ordonne par ordre croissant
: desc : ordonne par ordre décroissant

; like ''(optionnel)''
: Restreint la liste des membres ayant le champ commençant par ce motif ( exemple like="A" )

=== Variables ===

{| class="prettytable"
! 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
| <nowiki>Intitulé du champ ayant pour identifiant xxxxxxx ( ex <OVgivennameName> ) </nowiki>
|-
| OVxxxxxxValue
| <nowiki>Contenu du champ ayant pour identifiant xxxxxxx ( ex <OVgivennameValue> ) </nowiki>
|}

== OCDbDirectoryMemberFields ==

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

Liste les différents champs pour le membre courant.

=== Syntaxe ===

<source lang="ovml">
<OCDbDirectoryMemberFields>...</OCDbDirectoryMemberFields>
</source>

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCDbDirectoryEntry directoryid="" memberid="" userid="">...</OCDbDirectoryEntry>
</source>

=== 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 ===

{| class="prettytable"
! 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
| <nowiki>Intitulé du champ ayant pour identifiant xxxxxxx ( ex <OVgivennameName> ) </nowiki>
|-
| OVxxxxxxValue
| <nowiki>Contenu du champ ayant pour identifiant xxxxxxx ( ex <OVgivennameValue> ) </nowiki>
|-
| 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 ===

<source lang="ovml">
<OCDbDirectoryEntryFields>...</OCDbDirectoryEntryFields>
</source>

=== Variables ===

{| class="prettytable"
! Variable
! Valeur
|-
| OVDirectoryFieldName
| Intitulé du champ
|-
| OVDirectoryFieldValue
| Valeur du champ
|}

== OCDbDirectoryAcl ==

Liste les utilisateurs ayant des droits sur un annuaire.

=== Syntaxe ===

<source lang="ovml">
<OCDbDirectoryAcl directoryid="" type="">...</OCDbDirectoryAcl>
</source>

=== Paramètres ===

; directoryid
: Id de l'annuaire

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

=== Variables ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCDelegationItems delegationid="">...</OCDelegationItems>
</source>

=== Paramètres ===

; delegationid
: Id de la délégation

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCDelegationAdministrators delegationid="">...</OCDelegationAdministrators>
</source>

=== Paramètres ===

; delegationid
: Id de la délégation

=== Variables ===

{| class="prettytable"
! Variable
! Valeur
|-
| OVDelegationUserId
| Id de l'administrateur
|}

== OCDelegationsCategories ==

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

=== Syntaxe ===

<source lang="ovml">
<OCDelegationsCategories [categoryid=""]>....</OCDelegationsCategories>
</source>

=== Paramètres ===

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

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCDelegationsCategory [categoryid=""]>...</OCDelegationsCategory>
</source>

=== Paramètres ===

; categoryid
: Id de la délégation

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCTmSpaces>...</OCTmSpaces>
</source>

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCTmProjects spaceid="">...</OCTmProjects>
</source>

=== Paramètres ===

; spaceid
: Id de l'espace de projets

=== Variables ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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.

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

=== 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 ===

{| class="prettytable"
! Variable
! Valeur
|-
| OVEntityId
| Identifiant (entier) de l'entité
|-
| OVEntityName
| Nom de l'entité
|-
| OVEntityDescription
| Description de l'entité
|}

== OCMultipages ==

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

=== Syntaxe ===

<source lang="ovml">
<OCMultipages total="" maxpages="" perpage="" currentpage="">...</OCMultipages>
</source>

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCSitemapEntries node="" [sitemap=""] [limit=""]>...</OCSitemapEntries>
</source>

=== 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...
: Si node n'est pas spécifié,

; 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 ===

{| 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
|}

== 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 ===

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

=== 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.

; 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 =====

{| 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
|}

= 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 !

== 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 ===

<source lang="ovml">
<OCAddon name="" param1="" param2="" ...>...</OCAddon>
</source>

=== 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 ===

<source lang="ovml">
<OFAddon name="" function="" param1="" ...>
</source>

=== 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éférence OvML

2013-06-05T07:49:50Z

Rodpec : /* OFInclude */

[[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.

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 :

<source lang="ovml">
<OVnom-de-la-variable>
</source>

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

<source lang="ovml">
<OFPutVar name="nbArticles" value="10">
</source>

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 :

<source lang="ovml">
<OVnbArticles>
</source>

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 :

<source lang="ovml">
<OFPutVar name="babSlogan">
</source>

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.

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

<source lang="ovml">
<OFIfNotIsSet name="page" value="1">
</source>

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 <code><OVxxxx></code>.

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.

<source lang="ovml">
<OVnbArticles saveas="TotalArticles">
</source>

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.

{| class="prettytable"
! Value
!
|-
| n
| Récupère les n premiers caractères du contenu de la variable
|}

<source lang="ovml">
<OVbabSlogan strlen="100">
</source>

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 :

<source lang="ovml">
<OVbabSlogan strlen="100,...">
</source>

== striptags ==

Supprime les tags HTML de la variable :

{| class="prettytable"
! Value
!
|-
| 1
| Supprime les tags HTML de la variable
|}

<source lang="ovml">
<OVbabSlogan striptags="1">
</source>

== htmlentities ==

{| class="prettytable"
! Value
!
|-
| 1
| <nowiki>Convertit les entities HTML ( < devient &lt; )</nowiki>
|-
| 2
| <nowiki>Convertit en inverse les entities HTML ( &lt; devient < )</nowiki>
|}

<source lang="ovml">
<OVbabSlogan htmlentities="1">
</source>

== stripslashes ==

Supprime les slashs doublés du contenu de la variable

{| class="prettytable"
! Value
!
|-
| 1
| Supprime les slashs doublés du contenu de la variable
|}

<source lang="ovml">
<OVbabSlogan stripslashes="1">
</source>

== urlencode ==

{| class="prettytable"
! Value
!
|-
| 1
| Encode la variable pour l'utilisation dans une url
|}

<source lang="ovml">
<OVbabSlogan urlencode="1">
</source>

== jsencode ==

{| class="prettytable"
! Value
!
|-
| 1
| Encode la variable pour l'utilisation dans du javascript
|}

<source lang="ovml">
<OVbabSlogan jsencode="1">
</source>

== strcase ==

{| class="prettytable"
! Value
!
|-
| upper
| Convertit le contenu de la variable en majuscule
|-
| lower
| Convertit le contenu de la variable en minuscule
|}

<source lang="ovml">
<OVbabSlogan strcase="upper">
</source>

== nlremove ==

{| class="prettytable"
! Value
!
|-
| 1
| Supprime les retours chariots
|}

<source lang="ovml">
<OVbabSlogan nlremove="1">
</source>

== trim ==

{| class="prettytable"
! 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
|}

<source lang="ovml">
<OVbabSlogan trim="all">
</source>

== nl2br ==

{| class="prettytable"
! Value
!
|-
| <div align="right">1</div>
| <nowiki>Transforme les retours chariots en </nowiki>
|}

<source lang="ovml">
<OVbabSlogan nl2br="1">
</source>

== sprintf ==

{| class="prettytable"
! Value
!
|-
| Voir la documentation PHP pour la fonction sprintf
| Retourne une chaîne formatée
|}

<source lang="ovml">
<OVMoney sprintf="%01.2f">
</source>

== date ==

Permet de formater une date Ovidentia

{| class="prettytable"
! 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"
|}

<source lang="ovml">
<OVArticleDate date="%d %j %m %Y">
</source>

'''Remarque :'''

<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.

<source lang="ovml">
<OVbabCurrentDate date="%D %j %M" strcase="lower">
</source>

== author ==

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

{| class="prettytable"
! Value
!
|-
| %F
| Prénom
|-
| %M
| Deuxième prénom
|-
| %L
| Nom
|}

<source lang="ovml">
<OVArticleAuthor author="%F %L" strcase="lower">
</source>

= Les fonctions OvML =

On reconnaît les fonctions par la syntaxe suivante :

<source lang="ovml">
<OFxxxx ...>
</source>

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 <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>
</source>

'''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>
</source>

=== Syntaxe ===

<source lang="ovml">
<OFTranslate text="" [lang=""]>
</source>

=== 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

== OFPutVar ==

Permet de déclarer une nouvelle variable.

=== Syntaxe ===

<source lang="ovml">
<OFPutVar name="" [value=""]>
</source>

=== Paramètres ===

; name
: Nom de la variable

; value ''(optionnel)''
: Valeur à affecter à la variable

== OFGetVar ==

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

=== Syntaxe ===

<source lang="ovml">
<OFGetVar name="">
</source>

=== Paramètres ===

; name
: Nom de la variable à afficher

== OFIfNotIsSet ==

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

=== Syntaxe ===

<source lang="ovml">
<OFIfNotIsSet name="" [value=""]>
</source>

=== Paramètres ===

; name
: Nom de la variable

; value ''(optionnel)''
: Valeur à affecter à la variable

== OFInclude ==

Permet d'inclure un autre fichier OVML

=== Syntaxe ===

<source lang="ovml">
<OFInclude file="" [cache=""]>
</source>

=== 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 ===

<source lang="ovml">
<OFUrlContent url="">
</source>

=== 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 ===

<source lang="ovml">
<OFRecurse>
</source>

=== 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>).

<source lang="ovml">
<ul>
<OCArticleCategories>
<li>
<OVCategoryName>
<ul>
<OFRecurse parentid="<OVCategoryId>">
<OCArticleTopics categoryid="<OVCategoryId>">
<li><OVTopicName></li>
</OCArticleTopics>
</ul>
</li>
</OCArticleCategories>
</ul>
</source>

== Opérateurs arithmétiques ==

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

<source lang="ovml">
<OFAOxxxxx expr1="X" expr2="Y">
</source>

<source lang="ovml">
<OFAOxxxxx expr1="10" expr2="50">
</source>

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

<source lang="ovml">
<OFAOxxxxx expr1="<OVTotal>" expr2="50">
</source>

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.

<source lang="ovml">
<OFAOxxxxx expr1="<OVTotal>" expr2="50" saveas="NewTotal">
</source>

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 :

=== OFAOAddition ===

Permet d’additionner expr1 et expr2.

==== Syntaxe ====

<source lang="ovml">
<OFAOAddition expr1="" expr2="">
</source>

==== Paramètres ====

; expr1
: Premier terme de l'addition

; expr2
: Second terme de l'addition

=== OFAOSubtraction ===

Permet de soustraire expr2 à expr1.

==== Syntaxe ====

<source lang="ovml">
<OFAOSubtraction expr1="" expr2="">
</source>

==== Paramètres ====

; expr1
: Premier terme de la soustraction

; expr2
: Second terme de la soustraction

==== Exemple ====

<source lang="ovml">
<OFAOSubtraction expr1="10" expr2="20">
</source>

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 ====

<source lang="ovml">
<OFAOMultiplication expr1="" expr2="">
</source>

==== Paramètres ====

; expr1
: Premier terme de la multiplication

; expr2
: Second terme de la multiplication

=== OFAODivision ===

Permet de diviser expr1 par expr2.

==== Syntaxe ====

<source lang="ovml">
<OFAODivision expr1="" expr2="">
</source>

==== Paramètres ====

; expr1
: Premier terme de la division

; expr2
: Second terme de la division

==== Exemple ====

<source lang="ovml">
<OFAODivision expr1="10" expr2="20">
</source>

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 ====

<source lang="ovml">
<OFAOModulus expr1="" expr2="">
</source>

==== Paramètres ====

; expr1
: Premier terme du modulo

; expr2
: Second terme du modulo

==== Exemple ====

<source lang="ovml">
<OFAOModulus expr1="10" expr2="20">
</source>

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 ===

<source lang="ovml">
<OFHeader value="">
</source>

=== Paramètres ===

; value
: Valeur du header à modifier

=== Exemple ===

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

== OFSetCookie ==

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

=== Syntaxe ===

<source lang="ovml">
<OFSetCookie name="" expire="" [value=""]>
</source>

=== 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 ===

<source lang="ovml">
<OFGetCookie name="">
</source>

=== 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 ===

<source lang="ovml">
<OFSetSessionVar name="" value="">
</source>

=== 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 ===

<source lang="ovml">
<OFSetSessionVar name="babSectionsType" value="15">
</source>

affichera toutes les sections du portail

<source lang="ovml">
<OFSetSessionVar name="babSectionsType" value="4">
</source>

affichera uniquement les sections personnalisées du portail

<source lang="ovml">
<OFSetSessionVar name="babSectionsType" value="10">
</source>

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

<source lang="ovml">
<OFSetSessionVar name="babOvmlCurrentDelegation" value="5">
</source>

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

<source lang="ovml">
<OFSetSessionVar name="babOvmlCurrentDelegation" value="0">
</source>

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 ===

<source lang="ovml">
<OFRequest name="" saveas="" [default=""]>
</source>

=== Paramètres ===

; name
: Nom du paramètre GET dont on souhaite récupérer la valeur

; 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 ===

<source lang="ovml">
<OFPost name="" saveas="" [default=""]>
</source>

=== Paramètres ===

; name
: Nom du paramètre POST dont on souhaite récupérer la valeur

; 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 ===

<source lang="ovml">
<OFGet name="" saveas="" [default=""]>
</source>

=== Paramètres ===

; name
: Nom du paramètre GET dont on souhaite récupérer la valeur

; 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 ===

<source lang="ovml">
<OFSitemapPosition [sitemap=""] [basenode=""] [node=""] [keeplastknown=""]>
</source>

=== Paramètres ===

; 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 ===

<source lang="ovml">
<OFSitemapMenu [sitemap=""] [basenode=""] [selectednode=""] [keeplastknown=""] [maxdepth=""]>
</source>

=== 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é.

; 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).
: 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).

; 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.

== 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 ===

<source lang="ovml">
<OFSitemapCustomNodeId node="" [basenode=""] [saveas=""]>
</source>

=== 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 ===

<source lang="ovml">
<OFSitemapCustomNodeId node="bab_Articles" saveas="CustomNodeId">
<OFSitemapMenu basenode="<OVCustomNodeId>">
</source>

== 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 ===

<source lang="ovml">
<OFPreviousArticle articleid="" [topicid=""] [excludetopicid=""] [archive=""] [orderby=""] [order=""] [topicorder=""] [delegationid=""]>
</source>

=== 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 ===

<source lang="ovml">
<OFNextArticle articleid="" [topicid=""] [excludetopicid=""] [archive=""] [orderby=""] [order=""] [topicorder=""] [delegationid=""]>
</source>

=== 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 ==

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 ===

<source lang="ovml">
<OFWebStat name="" value="">
</source>

=== 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 ===

<source lang="ovml">
<OCArticle articleid="<OVarticleid>">

<OFWebStat name="bab_articles" value="<OVarticleid>">
</OCArticle>
</source>

= Les containers OvML =

La syntaxe des containers est comme suit :

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

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 ===

<source lang="ovml">
<OCxxxx expr1="" expr2="">...</OCxxxx>
</source>

=== Paramètres ===

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

=== Exemple ===

<source lang="ovml">
<OFPutVar name="BAB_SESS_LOGGED">
<OCIfEqual expr1="<BAB_SESS_LOGGED>" expr2="1">
Vous êtes connecté !
</OCIfEqual>
</source>

== 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 ===

<source lang="ovml">
<OCxxxx name="">...</OCxxxx>
</source>

=== Paramètres ===

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

=== Exemple ===

<source lang="ovml">
<OCIfIsSet name="variable">
Ce texte ne sera pas affiché.
</OCIfIsSet>

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

== OCIfUserMemberOfGroups ==

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

=== Syntaxe ===

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

=== 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 ===

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

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

== OCRecentFiles ==

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

=== Syntaxe ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

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

== OCRecentComments ==

Liste les derniers commentaires d'articles.

=== Syntaxe ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCArticleCategoryNext>...</OCArticleCategoryNext>
</source>

=== Variables ===

Idendiques à celles du container [[#OCArticleCategories|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 ===

<source lang="ovml">
<OCArticleCategoryPrevious>...</OCArticleCategoryPrevious>
</source>

=== Variables ===

Identiques à celles du container [[#OCArticleCategories|OCArticleCategories]].

== OCParentsArticleCategory ==

Liste des catégories de sujets parents.

=== Syntaxe ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 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 ===

<source lang="ovml">
<OCArticleTopicNext>...</OCArticleTopicNext>
</source>

=== Variables ===

Identiques à celles du container [[#OCArticleTopics|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 ===

<source lang="ovml">
<OCArticleTopicPrevious>....</OCArticleTopicPrevious>
</source>

=== Variables ===

Idem que ceux du container [[#OCArticleTopics|OCArticleTopics]].

== OCArticleTopic ==

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

=== Syntaxe ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCArticleTopic topicname="essai">...</OCArticleTopic>
</source>
Recherche tous les thèmes dont l'utilisateur a le droit et ayant pour nom "essai"

<source lang="ovml">
<OCArticleTopic topicid="1,2,3" topicname="essai">...</OCArticleTopic>
</source>
Recherche les thèmes d'id 1,2 3 ayant pour nom essai.

<source lang="ovml">
<OCArticleTopic topicid="1,2,3" topicname="%essai">...</OCArticleTopic>
</source>
Recherche les thèmes d'id 1,2 3 et dont le nom se termine par essai

<source lang="ovml">
<OCArticleTopic topicid="1,2,3" topicname="essai%">...</OCArticleTopic>
</source>
Recherche les thèmes d'id 1,2 3 et dont le nom commence par essai

<source lang="ovml">
<OCArticleTopic topicid="1,2,3" topicname="%essai%">...</OCArticleTopic>
</source>
Recherche les thèmes d'id 1,2 3 et dont le nom contient la chaîne essai

== OCArticles ==

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

=== Syntaxe ===

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

=== Paramètres ===

; topicid ''(optionnel)''
: Permet de préciser les thèmes d'articles concernés
: Id du thème ou plusieurs Ids séparés par une virgule
: Si omis, le container liste les articles tout thème confondu

; excludetopicid ''(optionnel)''
: Permet de préciser les thèmes d'articles à exclure à la différence du paramètre topicid
: Id du thème ou plusieurs Ids séparés par une virgule

; archive ''(optionnel)''
: yes : Donne la liste des articles archivés
: no ''(par défaut)'' : Donne la liste des articles non archivés

; offset ''(optionnel)''
: "n" indique le nombre d'articles à ignorer à partir du début de la liste
: 0 ''(par défaut)'' : aucune article n'est ignoré

; rows ''(optionnel)''
: "n" combien il faut en prendre
: -1 ''(par défaut)'' : toutes les lignes sont prises

; order ''(optionnel)''
: asc : Ordonne les articles par ordre croissant en fonction de la date
: desc ''(par défaut)'' : Ordonne les articles par ordre décroissant en fonction de la date
: rand : Ordonne les articles aléatoirement

; orderby ''(optionnel)''
: Peut être couplé avec l'attribut order.
: creation : Ordonne les articles par ordre de création en fonction de la date
: publication : Ordonne les articles par ordre de publication en fonction de la date
: modification ''(par défaut)'' : Ordonne les articles par ordre de modification en fonction de la date
: rating : Ordonne les articles en fonction de la note moyenne attribuée dans les commentaires

; topicorder ''(optionnel)''
: yes : Utilise l'ordre défini par le gestionnaire du thème d'articles
: no ''(par défaut)'' : N'utilise l'ordre défini par le gestionnaire du thème d'articles

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

; imageheightmax ''(optionnel)''
: Valeur en pixels. Permet de préciser la hauteur maximum de l'image associée.
: Si omis, l'image n'est pas redimensionnée et garde sa taille d'origine.

; imagewidthmax ''(optionnel)''
: Valeur en pixels. Permet de préciser la largeur maximum de l'image associée.
: Si omis, l'image n'est pas redimensionnée et garde sa taille d'origine.

; minrating ''(optionnel)''
: Permet de filtrer les articles ayant une note moyenne dans les commentaires supérieure ou égale à la valeur fournie en paramètre
: Valeur numérique.

=== Variables ===

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

== OCArticleNext ==

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

=== Syntaxe ===

<source lang="ovml">
<OCArticleNext>...</OCArticleNext>
</source>

=== Variables ===

Identiques à celles du container [[#OCArticles|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 ===

<source lang="ovml">
<OCArticlePrevious>...</OCArticlePrevious>
</source>

=== Variables ===

Identiques à celles du container [[#OCArticles|OCArticles]].

== OCArticle ==

Donne les informations sur un article donné.

=== Syntaxe ===

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

=== 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 ===

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

== OCArticleFiles ==

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

=== Syntaxe ===

<source lang="ovml">
<OCArticleFiles articleid="">...</OCArticleFiles>
</source>

=== Paramètres ===

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

=== Variables ===

{| class="prettytable"
! Variable
! Valeur
|-
| OVArticleFileName
| Nom du fichier
|-
| OVArticleFileDescription
| Description du fichier
|-
| OVArticleFileUrlGet
| Url pour atteindre le fichier
|}

== OCForums ==

Liste des forums.

=== Syntaxe ===

<source lang="ovml">
<OCForums [forumid=""] [delegationid=""]>...</OCForums>
</source>

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCForumNext>...</OCForumNext>
</source>

=== Variables ===

Identiques à celles du container [[#OCForums|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 ===

<source lang="ovml">
<OCForumPrevious>...</OCForumPrevious>
</source>

=== Variables ===

Identiques à celles du container [[#OCForums|OCForums]].

== OCForum ==

Donne les informations sur un forum donné.

=== Syntaxe ===

<source lang="ovml">
<OCForum forumid="">...</OCForum>
</source>

=== Paramètres ===

; forumid :
: Id du forum

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCThread threadid="" [order=""]>...</OCThread>
</source>

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCPost postid="" [order=""]>...</OCPost>
</source>

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCPostFiles postid="">...</OCPost>
</source>

=== Paramètres ===

; postid
: Id de la contribution 

=== Variables ===

{| class="prettytable"
! Variable
! Valeur
|-
| OVPostFileName
| Nom du fichier
|-
| OVPostFileUrlGet
| Url pour atteindre le fichier
|}

== OCFolders ==

Liste les répertoires partageables.

=== Syntaxe ===

<source lang="ovml">
<OCFolders [folderid=""] [delegationid=""]>...</OCFolders>
</source>

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFolderNext>...</OCFolderNext>
</source>

=== Variables ===

Identique à celles du container [[#OCFolders|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 ===

<source lang="ovml">
<OCFolderPrevious>...</OCFolderPrevious>
</source>

=== Variables ===

Identique à celles du container [[#OCFolders|OCFolders]].

== OCFolder ==

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

=== Syntaxe ===

<source lang="ovml">
<OCFolder folderid="">...</OCFolder>
</source>

=== Paramètres ===

; folderid
: Id du répertoire

=== Variables ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 :'''
<source lang="ovml">
<a href="<OVFileUrl>&inl=1"><OVFileName></a>
</source>

=== Syntaxe ===

<source lang="ovml">
<OCFiles folderid="" rows="" offset="" [path=""]>...</OCFiles>
</source>

=== 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

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFileNext>...</OCFileNext>
</source>

=== Variables ===

Identiques à celles du container [[#OCFiles|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 ===

<source lang="ovml">
<OCFilePrevious>...</OCFilePrevious>
</source>

=== Variables ===

Identiques à celles du container [[#OCFolders|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 :'''
<source lang="ovml">
<a href="<OVFileUrl>&inl=1"><OVFileName></a>
</source>

=== Syntaxe ===

<source lang="ovml">
<OCFile fileid="">...</OCFile>
</source>

=== Paramètres ===

; fileid
: Id du fichier

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFileFields fileid="">...</OCFileFields>
</source>

=== Paramètres ===

; fileid
: Id du fichier

=== Variables ===

{| class="prettytable"
! Variable
! Valeur
|-
| OVFileFieldName
| Nom du champ
|-
| OVFileFieldValue
| Valeur du champ
|}

== OCFaqs ==

Donne la liste des Faqs.

=== Syntaxe ===

<source lang="ovml">
<OCFaqs [faqid=""] [delegationid=""]>...</OCFaqs>
</source>

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFaqNext>...</OCFaqNext>
</source>

=== Variables ===

Identiques à celles du container [[#OCFaqs|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 ===

<source lang="ovml">
<OCFaqPrevious>...</OCFaqPrevious>
</source>

=== Variables ===

Identiques à celles du container [[#OCFaqs|OCFaqs]].

== OCFaq ==

Donne les informations sur une Faq donnée.

=== Syntaxe ===

<source lang="ovml">
<OCFaq faqid="">...</OCFaq>
</source>

=== Paramètres ===

; faqid
: Id de la Faq

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFaqSubCategories faqid="" [delegationid=""]>...</OCFaqSubCategories>
</source>

=== Paramètres ===

; faqid
: Id de la faq

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

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFaqSubCategory faqsubcatid="">...</OCFaqSubCategory>
</source>

=== Paramètres ===

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

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFaqQuestions [faqid=""] [faqsubcatid=""]>...</OCFaqQuestions>
</source>

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFaqQuestionNext>...</OCFaqQuestionNext>
</source>

=== Variables ===

Identiques à celles du container [[#OCFaqQuestions|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 ===

<source lang="ovml">
<OCFaqQuestionPrevious>...</OCFaqQuestionPrevious>
</source>

=== Variables ===

Identiques à celles du container [[#OCFaqQuestions|OCFaqQuestions]].

== OCFaqQuestion ==

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

=== Syntaxe ===

<source lang="ovml">
<OCFaqQuestion questionid="">...</OCFaqQuestion>
</source>

=== Paramètres ===

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

=== Variables ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

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

== OCWaitingComments ==

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

=== Syntaxe ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCCalendarCategories [filter=""]>...</OCCalendarCategories>
</source>

=== Paramètres ===

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

=== Variables ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
| 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 ===

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

=== 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 ===

{| class="prettytable"
| 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)
|}

== OCDbDirectories ==

Liste les annuaires de base de données

=== Syntaxe ===

<source lang="ovml">
<OCDbDirectories [directoryid=""] [delegationid=""]>...</OCDbDirectories>
</source>

=== 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.

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCDbDirectory directoryid="" [type=""]>...</OCDbDirectory>
</source>

=== Paramètres ===

; directoryid
: Id de l'annuaire

; type ''(optionnel)''
: « database » ou « group », si omis, le container liste tous les annuaires.

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCDbDirectoryFields directoryid="" [all=""]>...</OCDbDirectoryFields>
</source>

=== 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 ===

{| class="prettytable"
! Variable
! Valeur
|-
| OVDirectoryFieldName
| Intitulé du champ
|-
| OVDirectoryFieldId
| Identifiant du champ
|}

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

{| class="prettytable"
! 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 ===

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

=== Paramètres ===

; directoryid
: Id de l'annuaire

; all ''(optionnel)''
: Ignoré si l'attribut '''fields''' est spécifié
: 1 : Donne tous les champs pour chaque membre
: 0 : Donne uniquement les champs choisis pour l'affichage lors de la configuration du l'annuaire
: Si omis, liste uniquement les champs choisis.

; fields ''(optionnel)''
: liste des identifiants des champs souhaités séparés par des virgules ( exemple "sn,givenname,email" )

; orderby ''(optionnel)''
: Identifiant du champ à utiliser pour ordonner la liste

; order ''(optionnel)''
: asc : ordonne par ordre croissant
: desc : ordonne par ordre décroissant

; like ''(optionnel)''
: Restreint la liste des membres ayant le champ commençant par ce motif ( exemple like="A" )

=== Variables ===

{| class="prettytable"
! 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
| <nowiki>Intitulé du champ ayant pour identifiant xxxxxxx ( ex <OVgivennameName> ) </nowiki>
|-
| OVxxxxxxValue
| <nowiki>Contenu du champ ayant pour identifiant xxxxxxx ( ex <OVgivennameValue> ) </nowiki>
|}

== OCDbDirectoryMemberFields ==

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

Liste les différents champs pour le membre courant.

=== Syntaxe ===

<source lang="ovml">
<OCDbDirectoryMemberFields>...</OCDbDirectoryMemberFields>
</source>

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCDbDirectoryEntry directoryid="" memberid="" userid="">...</OCDbDirectoryEntry>
</source>

=== 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 ===

{| class="prettytable"
! 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
| <nowiki>Intitulé du champ ayant pour identifiant xxxxxxx ( ex <OVgivennameName> ) </nowiki>
|-
| OVxxxxxxValue
| <nowiki>Contenu du champ ayant pour identifiant xxxxxxx ( ex <OVgivennameValue> ) </nowiki>
|-
| 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 ===

<source lang="ovml">
<OCDbDirectoryEntryFields>...</OCDbDirectoryEntryFields>
</source>

=== Variables ===

{| class="prettytable"
! Variable
! Valeur
|-
| OVDirectoryFieldName
| Intitulé du champ
|-
| OVDirectoryFieldValue
| Valeur du champ
|}

== OCDbDirectoryAcl ==

Liste les utilisateurs ayant des droits sur un annuaire.

=== Syntaxe ===

<source lang="ovml">
<OCDbDirectoryAcl directoryid="" type="">...</OCDbDirectoryAcl>
</source>

=== Paramètres ===

; directoryid
: Id de l'annuaire

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

=== Variables ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCDelegationItems delegationid="">...</OCDelegationItems>
</source>

=== Paramètres ===

; delegationid
: Id de la délégation

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCDelegationAdministrators delegationid="">...</OCDelegationAdministrators>
</source>

=== Paramètres ===

; delegationid
: Id de la délégation

=== Variables ===

{| class="prettytable"
! Variable
! Valeur
|-
| OVDelegationUserId
| Id de l'administrateur
|}

== OCDelegationsCategories ==

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

=== Syntaxe ===

<source lang="ovml">
<OCDelegationsCategories [categoryid=""]>....</OCDelegationsCategories>
</source>

=== Paramètres ===

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

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCDelegationsCategory [categoryid=""]>...</OCDelegationsCategory>
</source>

=== Paramètres ===

; categoryid
: Id de la délégation

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCTmSpaces>...</OCTmSpaces>
</source>

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCTmProjects spaceid="">...</OCTmProjects>
</source>

=== Paramètres ===

; spaceid
: Id de l'espace de projets

=== Variables ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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.

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

=== 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 ===

{| class="prettytable"
! Variable
! Valeur
|-
| OVEntityId
| Identifiant (entier) de l'entité
|-
| OVEntityName
| Nom de l'entité
|-
| OVEntityDescription
| Description de l'entité
|}

== OCMultipages ==

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

=== Syntaxe ===

<source lang="ovml">
<OCMultipages total="" maxpages="" perpage="" currentpage="">...</OCMultipages>
</source>

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCSitemapEntries node="" [sitemap=""] [limit=""]>...</OCSitemapEntries>
</source>

=== 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...
: Si node n'est pas spécifié,

; 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 ===

{| 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
|}

== 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 ===

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

=== 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.

; 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 =====

{| 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
|}

= 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 !

== 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 ===

<source lang="ovml">
<OCAddon name="" param1="" param2="" ...>...</OCAddon>
</source>

=== 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 ===

<source lang="ovml">
<OFAddon name="" function="" param1="" ...>
</source>

=== 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éférence OvML

2013-06-05T07:49:22Z

Rodpec : /* OFInclude */

[[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.

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 :

<source lang="ovml">
<OVnom-de-la-variable>
</source>

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

<source lang="ovml">
<OFPutVar name="nbArticles" value="10">
</source>

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 :

<source lang="ovml">
<OVnbArticles>
</source>

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 :

<source lang="ovml">
<OFPutVar name="babSlogan">
</source>

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.

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

<source lang="ovml">
<OFIfNotIsSet name="page" value="1">
</source>

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 <code><OVxxxx></code>.

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.

<source lang="ovml">
<OVnbArticles saveas="TotalArticles">
</source>

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.

{| class="prettytable"
! Value
!
|-
| n
| Récupère les n premiers caractères du contenu de la variable
|}

<source lang="ovml">
<OVbabSlogan strlen="100">
</source>

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 :

<source lang="ovml">
<OVbabSlogan strlen="100,...">
</source>

== striptags ==

Supprime les tags HTML de la variable :

{| class="prettytable"
! Value
!
|-
| 1
| Supprime les tags HTML de la variable
|}

<source lang="ovml">
<OVbabSlogan striptags="1">
</source>

== htmlentities ==

{| class="prettytable"
! Value
!
|-
| 1
| <nowiki>Convertit les entities HTML ( < devient &lt; )</nowiki>
|-
| 2
| <nowiki>Convertit en inverse les entities HTML ( &lt; devient < )</nowiki>
|}

<source lang="ovml">
<OVbabSlogan htmlentities="1">
</source>

== stripslashes ==

Supprime les slashs doublés du contenu de la variable

{| class="prettytable"
! Value
!
|-
| 1
| Supprime les slashs doublés du contenu de la variable
|}

<source lang="ovml">
<OVbabSlogan stripslashes="1">
</source>

== urlencode ==

{| class="prettytable"
! Value
!
|-
| 1
| Encode la variable pour l'utilisation dans une url
|}

<source lang="ovml">
<OVbabSlogan urlencode="1">
</source>

== jsencode ==

{| class="prettytable"
! Value
!
|-
| 1
| Encode la variable pour l'utilisation dans du javascript
|}

<source lang="ovml">
<OVbabSlogan jsencode="1">
</source>

== strcase ==

{| class="prettytable"
! Value
!
|-
| upper
| Convertit le contenu de la variable en majuscule
|-
| lower
| Convertit le contenu de la variable en minuscule
|}

<source lang="ovml">
<OVbabSlogan strcase="upper">
</source>

== nlremove ==

{| class="prettytable"
! Value
!
|-
| 1
| Supprime les retours chariots
|}

<source lang="ovml">
<OVbabSlogan nlremove="1">
</source>

== trim ==

{| class="prettytable"
! 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
|}

<source lang="ovml">
<OVbabSlogan trim="all">
</source>

== nl2br ==

{| class="prettytable"
! Value
!
|-
| <div align="right">1</div>
| <nowiki>Transforme les retours chariots en </nowiki>
|}

<source lang="ovml">
<OVbabSlogan nl2br="1">
</source>

== sprintf ==

{| class="prettytable"
! Value
!
|-
| Voir la documentation PHP pour la fonction sprintf
| Retourne une chaîne formatée
|}

<source lang="ovml">
<OVMoney sprintf="%01.2f">
</source>

== date ==

Permet de formater une date Ovidentia

{| class="prettytable"
! 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"
|}

<source lang="ovml">
<OVArticleDate date="%d %j %m %Y">
</source>

'''Remarque :'''

<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.

<source lang="ovml">
<OVbabCurrentDate date="%D %j %M" strcase="lower">
</source>

== author ==

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

{| class="prettytable"
! Value
!
|-
| %F
| Prénom
|-
| %M
| Deuxième prénom
|-
| %L
| Nom
|}

<source lang="ovml">
<OVArticleAuthor author="%F %L" strcase="lower">
</source>

= Les fonctions OvML =

On reconnaît les fonctions par la syntaxe suivante :

<source lang="ovml">
<OFxxxx ...>
</source>

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 <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>
</source>

'''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>
</source>

=== Syntaxe ===

<source lang="ovml">
<OFTranslate text="" [lang=""]>
</source>

=== 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

== OFPutVar ==

Permet de déclarer une nouvelle variable.

=== Syntaxe ===

<source lang="ovml">
<OFPutVar name="" [value=""]>
</source>

=== Paramètres ===

; name
: Nom de la variable

; value ''(optionnel)''
: Valeur à affecter à la variable

== OFGetVar ==

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

=== Syntaxe ===

<source lang="ovml">
<OFGetVar name="">
</source>

=== Paramètres ===

; name
: Nom de la variable à afficher

== OFIfNotIsSet ==

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

=== Syntaxe ===

<source lang="ovml">
<OFIfNotIsSet name="" [value=""]>
</source>

=== Paramètres ===

; name
: Nom de la variable

; value ''(optionnel)''
: Valeur à affecter à la variable

== OFInclude ==

Permet d'inclure un autre fichier OVML

=== Syntaxe ===

<source lang="ovml">
<OFInclude file="" [cache=""]>
</source>

=== 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é.
:* 1 : Le cache est utilisé pour afficher le fichier.

== 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 ===

<source lang="ovml">
<OFUrlContent url="">
</source>

=== 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 ===

<source lang="ovml">
<OFRecurse>
</source>

=== 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>).

<source lang="ovml">
<ul>
<OCArticleCategories>
<li>
<OVCategoryName>
<ul>
<OFRecurse parentid="<OVCategoryId>">
<OCArticleTopics categoryid="<OVCategoryId>">
<li><OVTopicName></li>
</OCArticleTopics>
</ul>
</li>
</OCArticleCategories>
</ul>
</source>

== Opérateurs arithmétiques ==

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

<source lang="ovml">
<OFAOxxxxx expr1="X" expr2="Y">
</source>

<source lang="ovml">
<OFAOxxxxx expr1="10" expr2="50">
</source>

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

<source lang="ovml">
<OFAOxxxxx expr1="<OVTotal>" expr2="50">
</source>

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.

<source lang="ovml">
<OFAOxxxxx expr1="<OVTotal>" expr2="50" saveas="NewTotal">
</source>

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 :

=== OFAOAddition ===

Permet d’additionner expr1 et expr2.

==== Syntaxe ====

<source lang="ovml">
<OFAOAddition expr1="" expr2="">
</source>

==== Paramètres ====

; expr1
: Premier terme de l'addition

; expr2
: Second terme de l'addition

=== OFAOSubtraction ===

Permet de soustraire expr2 à expr1.

==== Syntaxe ====

<source lang="ovml">
<OFAOSubtraction expr1="" expr2="">
</source>

==== Paramètres ====

; expr1
: Premier terme de la soustraction

; expr2
: Second terme de la soustraction

==== Exemple ====

<source lang="ovml">
<OFAOSubtraction expr1="10" expr2="20">
</source>

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 ====

<source lang="ovml">
<OFAOMultiplication expr1="" expr2="">
</source>

==== Paramètres ====

; expr1
: Premier terme de la multiplication

; expr2
: Second terme de la multiplication

=== OFAODivision ===

Permet de diviser expr1 par expr2.

==== Syntaxe ====

<source lang="ovml">
<OFAODivision expr1="" expr2="">
</source>

==== Paramètres ====

; expr1
: Premier terme de la division

; expr2
: Second terme de la division

==== Exemple ====

<source lang="ovml">
<OFAODivision expr1="10" expr2="20">
</source>

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 ====

<source lang="ovml">
<OFAOModulus expr1="" expr2="">
</source>

==== Paramètres ====

; expr1
: Premier terme du modulo

; expr2
: Second terme du modulo

==== Exemple ====

<source lang="ovml">
<OFAOModulus expr1="10" expr2="20">
</source>

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 ===

<source lang="ovml">
<OFHeader value="">
</source>

=== Paramètres ===

; value
: Valeur du header à modifier

=== Exemple ===

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

== OFSetCookie ==

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

=== Syntaxe ===

<source lang="ovml">
<OFSetCookie name="" expire="" [value=""]>
</source>

=== 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 ===

<source lang="ovml">
<OFGetCookie name="">
</source>

=== 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 ===

<source lang="ovml">
<OFSetSessionVar name="" value="">
</source>

=== 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 ===

<source lang="ovml">
<OFSetSessionVar name="babSectionsType" value="15">
</source>

affichera toutes les sections du portail

<source lang="ovml">
<OFSetSessionVar name="babSectionsType" value="4">
</source>

affichera uniquement les sections personnalisées du portail

<source lang="ovml">
<OFSetSessionVar name="babSectionsType" value="10">
</source>

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

<source lang="ovml">
<OFSetSessionVar name="babOvmlCurrentDelegation" value="5">
</source>

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

<source lang="ovml">
<OFSetSessionVar name="babOvmlCurrentDelegation" value="0">
</source>

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 ===

<source lang="ovml">
<OFRequest name="" saveas="" [default=""]>
</source>

=== Paramètres ===

; name
: Nom du paramètre GET dont on souhaite récupérer la valeur

; 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 ===

<source lang="ovml">
<OFPost name="" saveas="" [default=""]>
</source>

=== Paramètres ===

; name
: Nom du paramètre POST dont on souhaite récupérer la valeur

; 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 ===

<source lang="ovml">
<OFGet name="" saveas="" [default=""]>
</source>

=== Paramètres ===

; name
: Nom du paramètre GET dont on souhaite récupérer la valeur

; 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 ===

<source lang="ovml">
<OFSitemapPosition [sitemap=""] [basenode=""] [node=""] [keeplastknown=""]>
</source>

=== Paramètres ===

; 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 ===

<source lang="ovml">
<OFSitemapMenu [sitemap=""] [basenode=""] [selectednode=""] [keeplastknown=""] [maxdepth=""]>
</source>

=== 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é.

; 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).
: 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).

; 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.

== 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 ===

<source lang="ovml">
<OFSitemapCustomNodeId node="" [basenode=""] [saveas=""]>
</source>

=== 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 ===

<source lang="ovml">
<OFSitemapCustomNodeId node="bab_Articles" saveas="CustomNodeId">
<OFSitemapMenu basenode="<OVCustomNodeId>">
</source>

== 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 ===

<source lang="ovml">
<OFPreviousArticle articleid="" [topicid=""] [excludetopicid=""] [archive=""] [orderby=""] [order=""] [topicorder=""] [delegationid=""]>
</source>

=== 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 ===

<source lang="ovml">
<OFNextArticle articleid="" [topicid=""] [excludetopicid=""] [archive=""] [orderby=""] [order=""] [topicorder=""] [delegationid=""]>
</source>

=== 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 ==

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 ===

<source lang="ovml">
<OFWebStat name="" value="">
</source>

=== 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 ===

<source lang="ovml">
<OCArticle articleid="<OVarticleid>">

<OFWebStat name="bab_articles" value="<OVarticleid>">
</OCArticle>
</source>

= Les containers OvML =

La syntaxe des containers est comme suit :

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

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 ===

<source lang="ovml">
<OCxxxx expr1="" expr2="">...</OCxxxx>
</source>

=== Paramètres ===

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

=== Exemple ===

<source lang="ovml">
<OFPutVar name="BAB_SESS_LOGGED">
<OCIfEqual expr1="<BAB_SESS_LOGGED>" expr2="1">
Vous êtes connecté !
</OCIfEqual>
</source>

== 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 ===

<source lang="ovml">
<OCxxxx name="">...</OCxxxx>
</source>

=== Paramètres ===

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

=== Exemple ===

<source lang="ovml">
<OCIfIsSet name="variable">
Ce texte ne sera pas affiché.
</OCIfIsSet>

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

== OCIfUserMemberOfGroups ==

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

=== Syntaxe ===

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

=== 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 ===

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

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

== OCRecentFiles ==

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

=== Syntaxe ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

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

== OCRecentComments ==

Liste les derniers commentaires d'articles.

=== Syntaxe ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCArticleCategoryNext>...</OCArticleCategoryNext>
</source>

=== Variables ===

Idendiques à celles du container [[#OCArticleCategories|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 ===

<source lang="ovml">
<OCArticleCategoryPrevious>...</OCArticleCategoryPrevious>
</source>

=== Variables ===

Identiques à celles du container [[#OCArticleCategories|OCArticleCategories]].

== OCParentsArticleCategory ==

Liste des catégories de sujets parents.

=== Syntaxe ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 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 ===

<source lang="ovml">
<OCArticleTopicNext>...</OCArticleTopicNext>
</source>

=== Variables ===

Identiques à celles du container [[#OCArticleTopics|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 ===

<source lang="ovml">
<OCArticleTopicPrevious>....</OCArticleTopicPrevious>
</source>

=== Variables ===

Idem que ceux du container [[#OCArticleTopics|OCArticleTopics]].

== OCArticleTopic ==

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

=== Syntaxe ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCArticleTopic topicname="essai">...</OCArticleTopic>
</source>
Recherche tous les thèmes dont l'utilisateur a le droit et ayant pour nom "essai"

<source lang="ovml">
<OCArticleTopic topicid="1,2,3" topicname="essai">...</OCArticleTopic>
</source>
Recherche les thèmes d'id 1,2 3 ayant pour nom essai.

<source lang="ovml">
<OCArticleTopic topicid="1,2,3" topicname="%essai">...</OCArticleTopic>
</source>
Recherche les thèmes d'id 1,2 3 et dont le nom se termine par essai

<source lang="ovml">
<OCArticleTopic topicid="1,2,3" topicname="essai%">...</OCArticleTopic>
</source>
Recherche les thèmes d'id 1,2 3 et dont le nom commence par essai

<source lang="ovml">
<OCArticleTopic topicid="1,2,3" topicname="%essai%">...</OCArticleTopic>
</source>
Recherche les thèmes d'id 1,2 3 et dont le nom contient la chaîne essai

== OCArticles ==

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

=== Syntaxe ===

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

=== Paramètres ===

; topicid ''(optionnel)''
: Permet de préciser les thèmes d'articles concernés
: Id du thème ou plusieurs Ids séparés par une virgule
: Si omis, le container liste les articles tout thème confondu

; excludetopicid ''(optionnel)''
: Permet de préciser les thèmes d'articles à exclure à la différence du paramètre topicid
: Id du thème ou plusieurs Ids séparés par une virgule

; archive ''(optionnel)''
: yes : Donne la liste des articles archivés
: no ''(par défaut)'' : Donne la liste des articles non archivés

; offset ''(optionnel)''
: "n" indique le nombre d'articles à ignorer à partir du début de la liste
: 0 ''(par défaut)'' : aucune article n'est ignoré

; rows ''(optionnel)''
: "n" combien il faut en prendre
: -1 ''(par défaut)'' : toutes les lignes sont prises

; order ''(optionnel)''
: asc : Ordonne les articles par ordre croissant en fonction de la date
: desc ''(par défaut)'' : Ordonne les articles par ordre décroissant en fonction de la date
: rand : Ordonne les articles aléatoirement

; orderby ''(optionnel)''
: Peut être couplé avec l'attribut order.
: creation : Ordonne les articles par ordre de création en fonction de la date
: publication : Ordonne les articles par ordre de publication en fonction de la date
: modification ''(par défaut)'' : Ordonne les articles par ordre de modification en fonction de la date
: rating : Ordonne les articles en fonction de la note moyenne attribuée dans les commentaires

; topicorder ''(optionnel)''
: yes : Utilise l'ordre défini par le gestionnaire du thème d'articles
: no ''(par défaut)'' : N'utilise l'ordre défini par le gestionnaire du thème d'articles

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

; imageheightmax ''(optionnel)''
: Valeur en pixels. Permet de préciser la hauteur maximum de l'image associée.
: Si omis, l'image n'est pas redimensionnée et garde sa taille d'origine.

; imagewidthmax ''(optionnel)''
: Valeur en pixels. Permet de préciser la largeur maximum de l'image associée.
: Si omis, l'image n'est pas redimensionnée et garde sa taille d'origine.

; minrating ''(optionnel)''
: Permet de filtrer les articles ayant une note moyenne dans les commentaires supérieure ou égale à la valeur fournie en paramètre
: Valeur numérique.

=== Variables ===

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

== OCArticleNext ==

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

=== Syntaxe ===

<source lang="ovml">
<OCArticleNext>...</OCArticleNext>
</source>

=== Variables ===

Identiques à celles du container [[#OCArticles|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 ===

<source lang="ovml">
<OCArticlePrevious>...</OCArticlePrevious>
</source>

=== Variables ===

Identiques à celles du container [[#OCArticles|OCArticles]].

== OCArticle ==

Donne les informations sur un article donné.

=== Syntaxe ===

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

=== 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 ===

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

== OCArticleFiles ==

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

=== Syntaxe ===

<source lang="ovml">
<OCArticleFiles articleid="">...</OCArticleFiles>
</source>

=== Paramètres ===

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

=== Variables ===

{| class="prettytable"
! Variable
! Valeur
|-
| OVArticleFileName
| Nom du fichier
|-
| OVArticleFileDescription
| Description du fichier
|-
| OVArticleFileUrlGet
| Url pour atteindre le fichier
|}

== OCForums ==

Liste des forums.

=== Syntaxe ===

<source lang="ovml">
<OCForums [forumid=""] [delegationid=""]>...</OCForums>
</source>

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCForumNext>...</OCForumNext>
</source>

=== Variables ===

Identiques à celles du container [[#OCForums|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 ===

<source lang="ovml">
<OCForumPrevious>...</OCForumPrevious>
</source>

=== Variables ===

Identiques à celles du container [[#OCForums|OCForums]].

== OCForum ==

Donne les informations sur un forum donné.

=== Syntaxe ===

<source lang="ovml">
<OCForum forumid="">...</OCForum>
</source>

=== Paramètres ===

; forumid :
: Id du forum

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCThread threadid="" [order=""]>...</OCThread>
</source>

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCPost postid="" [order=""]>...</OCPost>
</source>

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCPostFiles postid="">...</OCPost>
</source>

=== Paramètres ===

; postid
: Id de la contribution 

=== Variables ===

{| class="prettytable"
! Variable
! Valeur
|-
| OVPostFileName
| Nom du fichier
|-
| OVPostFileUrlGet
| Url pour atteindre le fichier
|}

== OCFolders ==

Liste les répertoires partageables.

=== Syntaxe ===

<source lang="ovml">
<OCFolders [folderid=""] [delegationid=""]>...</OCFolders>
</source>

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFolderNext>...</OCFolderNext>
</source>

=== Variables ===

Identique à celles du container [[#OCFolders|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 ===

<source lang="ovml">
<OCFolderPrevious>...</OCFolderPrevious>
</source>

=== Variables ===

Identique à celles du container [[#OCFolders|OCFolders]].

== OCFolder ==

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

=== Syntaxe ===

<source lang="ovml">
<OCFolder folderid="">...</OCFolder>
</source>

=== Paramètres ===

; folderid
: Id du répertoire

=== Variables ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 :'''
<source lang="ovml">
<a href="<OVFileUrl>&inl=1"><OVFileName></a>
</source>

=== Syntaxe ===

<source lang="ovml">
<OCFiles folderid="" rows="" offset="" [path=""]>...</OCFiles>
</source>

=== 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

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFileNext>...</OCFileNext>
</source>

=== Variables ===

Identiques à celles du container [[#OCFiles|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 ===

<source lang="ovml">
<OCFilePrevious>...</OCFilePrevious>
</source>

=== Variables ===

Identiques à celles du container [[#OCFolders|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 :'''
<source lang="ovml">
<a href="<OVFileUrl>&inl=1"><OVFileName></a>
</source>

=== Syntaxe ===

<source lang="ovml">
<OCFile fileid="">...</OCFile>
</source>

=== Paramètres ===

; fileid
: Id du fichier

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFileFields fileid="">...</OCFileFields>
</source>

=== Paramètres ===

; fileid
: Id du fichier

=== Variables ===

{| class="prettytable"
! Variable
! Valeur
|-
| OVFileFieldName
| Nom du champ
|-
| OVFileFieldValue
| Valeur du champ
|}

== OCFaqs ==

Donne la liste des Faqs.

=== Syntaxe ===

<source lang="ovml">
<OCFaqs [faqid=""] [delegationid=""]>...</OCFaqs>
</source>

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFaqNext>...</OCFaqNext>
</source>

=== Variables ===

Identiques à celles du container [[#OCFaqs|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 ===

<source lang="ovml">
<OCFaqPrevious>...</OCFaqPrevious>
</source>

=== Variables ===

Identiques à celles du container [[#OCFaqs|OCFaqs]].

== OCFaq ==

Donne les informations sur une Faq donnée.

=== Syntaxe ===

<source lang="ovml">
<OCFaq faqid="">...</OCFaq>
</source>

=== Paramètres ===

; faqid
: Id de la Faq

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFaqSubCategories faqid="" [delegationid=""]>...</OCFaqSubCategories>
</source>

=== Paramètres ===

; faqid
: Id de la faq

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

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFaqSubCategory faqsubcatid="">...</OCFaqSubCategory>
</source>

=== Paramètres ===

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

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFaqQuestions [faqid=""] [faqsubcatid=""]>...</OCFaqQuestions>
</source>

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCFaqQuestionNext>...</OCFaqQuestionNext>
</source>

=== Variables ===

Identiques à celles du container [[#OCFaqQuestions|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 ===

<source lang="ovml">
<OCFaqQuestionPrevious>...</OCFaqQuestionPrevious>
</source>

=== Variables ===

Identiques à celles du container [[#OCFaqQuestions|OCFaqQuestions]].

== OCFaqQuestion ==

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

=== Syntaxe ===

<source lang="ovml">
<OCFaqQuestion questionid="">...</OCFaqQuestion>
</source>

=== Paramètres ===

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

=== Variables ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

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

== OCWaitingComments ==

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

=== Syntaxe ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCCalendarCategories [filter=""]>...</OCCalendarCategories>
</source>

=== Paramètres ===

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

=== Variables ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
| 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 ===

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

=== 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 ===

{| class="prettytable"
| 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)
|}

== OCDbDirectories ==

Liste les annuaires de base de données

=== Syntaxe ===

<source lang="ovml">
<OCDbDirectories [directoryid=""] [delegationid=""]>...</OCDbDirectories>
</source>

=== 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.

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCDbDirectory directoryid="" [type=""]>...</OCDbDirectory>
</source>

=== Paramètres ===

; directoryid
: Id de l'annuaire

; type ''(optionnel)''
: « database » ou « group », si omis, le container liste tous les annuaires.

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCDbDirectoryFields directoryid="" [all=""]>...</OCDbDirectoryFields>
</source>

=== 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 ===

{| class="prettytable"
! Variable
! Valeur
|-
| OVDirectoryFieldName
| Intitulé du champ
|-
| OVDirectoryFieldId
| Identifiant du champ
|}

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

{| class="prettytable"
! 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 ===

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

=== Paramètres ===

; directoryid
: Id de l'annuaire

; all ''(optionnel)''
: Ignoré si l'attribut '''fields''' est spécifié
: 1 : Donne tous les champs pour chaque membre
: 0 : Donne uniquement les champs choisis pour l'affichage lors de la configuration du l'annuaire
: Si omis, liste uniquement les champs choisis.

; fields ''(optionnel)''
: liste des identifiants des champs souhaités séparés par des virgules ( exemple "sn,givenname,email" )

; orderby ''(optionnel)''
: Identifiant du champ à utiliser pour ordonner la liste

; order ''(optionnel)''
: asc : ordonne par ordre croissant
: desc : ordonne par ordre décroissant

; like ''(optionnel)''
: Restreint la liste des membres ayant le champ commençant par ce motif ( exemple like="A" )

=== Variables ===

{| class="prettytable"
! 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
| <nowiki>Intitulé du champ ayant pour identifiant xxxxxxx ( ex <OVgivennameName> ) </nowiki>
|-
| OVxxxxxxValue
| <nowiki>Contenu du champ ayant pour identifiant xxxxxxx ( ex <OVgivennameValue> ) </nowiki>
|}

== OCDbDirectoryMemberFields ==

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

Liste les différents champs pour le membre courant.

=== Syntaxe ===

<source lang="ovml">
<OCDbDirectoryMemberFields>...</OCDbDirectoryMemberFields>
</source>

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCDbDirectoryEntry directoryid="" memberid="" userid="">...</OCDbDirectoryEntry>
</source>

=== 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 ===

{| class="prettytable"
! 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
| <nowiki>Intitulé du champ ayant pour identifiant xxxxxxx ( ex <OVgivennameName> ) </nowiki>
|-
| OVxxxxxxValue
| <nowiki>Contenu du champ ayant pour identifiant xxxxxxx ( ex <OVgivennameValue> ) </nowiki>
|-
| 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 ===

<source lang="ovml">
<OCDbDirectoryEntryFields>...</OCDbDirectoryEntryFields>
</source>

=== Variables ===

{| class="prettytable"
! Variable
! Valeur
|-
| OVDirectoryFieldName
| Intitulé du champ
|-
| OVDirectoryFieldValue
| Valeur du champ
|}

== OCDbDirectoryAcl ==

Liste les utilisateurs ayant des droits sur un annuaire.

=== Syntaxe ===

<source lang="ovml">
<OCDbDirectoryAcl directoryid="" type="">...</OCDbDirectoryAcl>
</source>

=== Paramètres ===

; directoryid
: Id de l'annuaire

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

=== Variables ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCDelegationItems delegationid="">...</OCDelegationItems>
</source>

=== Paramètres ===

; delegationid
: Id de la délégation

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCDelegationAdministrators delegationid="">...</OCDelegationAdministrators>
</source>

=== Paramètres ===

; delegationid
: Id de la délégation

=== Variables ===

{| class="prettytable"
! Variable
! Valeur
|-
| OVDelegationUserId
| Id de l'administrateur
|}

== OCDelegationsCategories ==

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

=== Syntaxe ===

<source lang="ovml">
<OCDelegationsCategories [categoryid=""]>....</OCDelegationsCategories>
</source>

=== Paramètres ===

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

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCDelegationsCategory [categoryid=""]>...</OCDelegationsCategory>
</source>

=== Paramètres ===

; categoryid
: Id de la délégation

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCTmSpaces>...</OCTmSpaces>
</source>

=== Variables ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCTmProjects spaceid="">...</OCTmProjects>
</source>

=== Paramètres ===

; spaceid
: Id de l'espace de projets

=== Variables ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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 ===

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

=== 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 ===

{| class="prettytable"
! 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.

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

=== 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 ===

{| class="prettytable"
! Variable
! Valeur
|-
| OVEntityId
| Identifiant (entier) de l'entité
|-
| OVEntityName
| Nom de l'entité
|-
| OVEntityDescription
| Description de l'entité
|}

== OCMultipages ==

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

=== Syntaxe ===

<source lang="ovml">
<OCMultipages total="" maxpages="" perpage="" currentpage="">...</OCMultipages>
</source>

=== 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 ===

{| class="prettytable"
! 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 ===

<source lang="ovml">
<OCSitemapEntries node="" [sitemap=""] [limit=""]>...</OCSitemapEntries>
</source>

=== 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...
: Si node n'est pas spécifié,

; 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 ===

{| 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
|}

== 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 ===

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

=== 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.

; 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 =====

{| 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
|}

= 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 !

== 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 ===

<source lang="ovml">
<OCAddon name="" param1="" param2="" ...>...</OCAddon>
</source>

=== 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 ===

<source lang="ovml">
<OFAddon name="" function="" param1="" ...>
</source>

=== 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.