Référence OvML
Sommaire
- 1 Introduction
- 2 Les variables OvML
- 3 Les fonctions OvML
- 4 Les containers OvML
- 4.1 Les opérateurs de comparaison
- 4.2 Les opérateurs de test d'existence sur les variables
- 4.3 OCIfUserMemberOfGroups
- 4.4 OCArticlesHomePages
- 4.5 OCRecentFiles
- 4.6 OCRecentArticles
- 4.7 OCRecentComments
- 4.8 OCRecentThreads
- 4.9 OCRecentPosts
- 4.10 OCRecentFaqQuestions
- 4.11 OCArticleCategories
- 4.12 OCArticleCategoryNext
- 4.13 OCArticleCategoryPrevious
- 4.14 OCParentsArticleCategory
- 4.15 OCArticleCategory
- 4.16 OCArticleTopics
- 4.17 OCArticleTopicNext
- 4.18 OCArticleTopicPrevious
- 4.19 OCArticleTopic
- 4.20 OCArticles
- 4.21 OCArticleNext
- 4.22 OCArticlePrevious
- 4.23 OCArticle
- 4.24 OCArticleFiles
- 4.25 OCForums
- 4.26 OCForumNext
- 4.27 OCForumPrevious
- 4.28 OCForum
- 4.29 OCThread
- 4.30 OCPost
- 4.31 OCPostFiles
- 4.32 OCFolders
- 4.33 OCFolderNext
- 4.34 OCFolderPrevious
- 4.35 OCFolder
- 4.36 OCSubFolders
- 4.37 OCFiles
- 4.38 OCFileNext
- 4.39 OCFilePrevious
- 4.40 OCFile
- 4.41 OCFileFields
- 4.42 OCFaqs
- 4.43 OCFaqNext
- 4.44 OCFaqPrevious
- 4.45 OCFaq
- 4.46 OCFaqSubCategories
- 4.47 OCFaqSubCategory
- 4.48 OCFaqQuestions
- 4.49 OCFaqQuestionNext
- 4.50 OCFaqQuestionPrevious
- 4.51 OCFaqQuestion
- 4.52 OCWaitingArticles
- 4.53 OCWaitingComments
- 4.54 OCWaitingFiles
- 4.55 OCWaitingPosts
- 4.56 OCCalendars
- 4.57 OCCalendarCategories
- 4.58 OCCalendarUserEvents
- 4.59 OCCalendarGroupEvents
- 4.60 OCCalendarResourceEvents
- 4.61 OCCalendarEvents
- 4.62 OCDbDirectories
- 4.63 OCDbDirectory
- 4.64 OCDbDirectoryFields
- 4.65 OCDbDirectoryMembers
- 4.66 OCDbDirectoryMemberFields
- 4.67 OCDbDirectoryEntry
- 4.68 OCDbDirectoryEntryFields
- 4.69 OCDbDirectoryAcl
- 4.70 OCDelegations
- 4.71 OCDelegation
- 4.72 OCDelegationsManaged
- 4.73 OCDelegationManaged
- 4.74 OCDelegationItems
- 4.75 OCDelegationAdministrators
- 4.76 OCDelegationsCategories
- 4.77 OCDelegationsCategory
- 4.78 OCTmSpaces
- 4.79 OCTmProjects
- 4.80 OCTmTasks
- 4.81 OCOrgUserEntities
- 4.82 OCOrgPathToEntity
- 4.83 OCMultipages
- 4.84 OCSitemapEntries
- 4.85 OCSitemapPath
- 5 Différentes méthodes d’utilisation d’un fichier OVML
Introduction
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.
On distingue trois types de tags OvML :
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 :
<OFxxxx param1="value" param2="value" …>
Elles permettent, entre autre, de traduire du texte, de faire des opérations arithmétiques, etc, …
Le résultat de ces fonctions peut être sauvegardé dans une variable OvML en utilisant le paramètre saveas (voir ci-dessus).
Les containers <OCxxxx> … </OCxxxx>
La syntaxe des containers est comme suit :
<OCxxxx param1="value" param2="value" …>...</OCxxxx>
Remarque importante d'utilisation des containers :
- Il est possible d’imbriquer les containers sauf s’ils ont le même nom. Dans le cas précédent, il existe l’astuce de rajouter un paramètre sans valeur différente dans les balises. Ce paramètre va permettre d'identifier l'ouverture et la fermeture des containers par le moteur d'Ovidentia. Le paramètre doit donc se retrouver dans la balise d'ouverture ainsi que dans la balise de fermeture.
Exemple :
<OCxxxx param1="value" param2="value" monparametre1>
<OCxxxx param1="value" param2="value" monparametre2>
...
</OCxxxx monparametre2>
</OCxxxx monparametre1>
- Chaque paramètre d'un container est vu comme une variable par le moteur OVML; il faut donc éviter d'utiliser pour nom d'une variable ovml le nom d'un attribut d'un container pour supprimer des erreurs d'interprétation.
Les variables OvML
Les variables OvML peuvent être définies dans le fichier OvML, produites par un container ou passées comme paramètres dans l’url. Elles sont accessibles en utilisant la syntaxe :
<OVnom-de-la variable>
On peut définir une variable OvML en utilisant la fonction PutVar :
<OFPutVar name="nbArticles" value="10">
Ceci définit une variable nbArticles initialisée à la valeur 10.
Pour récupérer la valeur dans une page OvML, il faut utiliser la syntaxe suivante :
<OVnbArticles>
On peut aussi définir une variable en utilisant une variable globale d’Ovidentia. Pour cela, il suffira d’omettre le deuxième paramètre :
<OFPutVar name="babSlogan">
Maintenant la variable <OVbabSlogan> existe dans OvML et contient le contenu du slogan du site.
On peut ainsi utiliser les variables d’Ovidentia pour récupérer le nom de l’utilisateur connecté ( BAB_SESS_USER ), son ID ( BAB_SESS_USERID ), etc.
Remarque :
- babCurrentDate est une variable globale permettant de récupérer la date courante. Elle ne doit pas être déclarée par la fonction OFPutVar pour l'utiliser.
- Les variables globales booléennes comme BAB_SESS_LOGGED ont la valeur nulle si la valeur est fausse (false) et vaut 1 si la valeur est vraie (true).
Il est parfois utile de tester l’existence d’une variable avant de la définir. On utilisera pour cela la fonction IfNotIsSet :
<OFIfNotIsSet name="page" value="1">
Dans ce cas, si la variable page n’est pas définie, elle sera définie avec la valeur initiale 1.
Toutes les variables produites par un container peuvent être jointes en utilisant la syntaxe d’une variable OvML <OVxxxx>.
On peut aussi passer des variables OvML à un fichier OvML en utilisant l’url :
http://url-du-site/index.php?tg=oml&file=fichier-ovml&total=1000
Dans la page OvML on peut donc utiliser la variable totale.
Toute variable OvML peut être modifiée ou sauvegardée dans une autre variable en utilisant les attributs suivants :
saveas
Permet de sauvegarder une variable dans une autre :
<OVnbArticles saveas="TotalArticles">
Une nouvelle variable TotalArticles est créée et sa valeur est la même que celle de nbArticles.
strlen
Permet de récupérer les n premiers caractères de la variable.
| Value | |
|---|---|
| n | Récupère les n premiers caractères du contenu de la variable |
<OVbabSlogan strlen="100">
Il est possible de spécifier une chaîne qui sera ajoutée à la fin du résultat si la variable a été tronquée. Par exemple "...“ pour indiquer une suite :
<OVbabSlogan strlen="100,...">
striptags
Supprime les tags HTML de la variable :
| Value | |
|---|---|
| 1 | Supprime les tags HTML de la variable |
<OVbabSlogan striptags="1">
htmlentities
| Value | |
|---|---|
| 1 | Convertit les entities HTML ( < devient < ) |
| 2 | Convertit en inverse les entities HTML ( < devient < ) |
<OVbabSlogan htmlentities="1">
stripslashes
Supprime les slashs doublés du contenu de la variable
| Value | |
|---|---|
| 1 | Supprime les slashs doublés du contenu de la variable |
<OVbabSlogan stripslashes="1">
urlencode
| Value | |
|---|---|
| 1 | Encode la variable pour l'utilisation dans une url |
<OVbabSlogan urlencode="1">
jsencode
| Value | |
|---|---|
| 1 | Encode la variable pour l'utilisation dans du javascript |
<OVbabSlogan jsencode="1">
strcase
| Value | |
|---|---|
| upper | Convertit le contenu de la variable en majuscule |
| lower | Convertit le contenu de la variable en minuscule |
<OVbabSlogan strcase="upper">
nlremove
| Value | |
|---|---|
| 1 | Supprime les retours chariots |
<OVbabSlogan nlremove="1">
trim
| Value | |
|---|---|
| left | Supprime les blancs en début de chaîne |
| right | Supprime les blancs en fin de chaîne |
| all | Supprime les blancs en début et en fin de chaîne |
<OVbabSlogan trim="all">
nl2br
| Value | |
|---|---|
| 1
|
Transforme les retours chariots en <BR> |
<OVbabSlogan nl2br="1">
sprintf
| Value | |
|---|---|
| Voir la documentation PHP pour la fonction sprintf | Retourne une chaîne formatée |
<OVMoney sprintf="%01.2f">
date
Permet de formater une date Ovidentia
| Value | |
|---|---|
| S | Format court de la date défini au niveau site ou au niveau utilisateur |
| L | Format long de la date défini au niveau site ou au niveau utilisateur |
| T | Format de l'heure défini au niveau site ou au niveau utilisateur |
| d | Trois premières lettres du jour de la semaine Dim pour Dimanche |
| D | Jour de la semaine Dimanche par exemple |
| j | Jour du mois, sur deux chiffres (éventuellement avec un zéro) : "01" à "31" |
| m | Mois, en trois lettres : par exemple "Avr" (pour Avril) |
| M | Mois en lettres : Avril par exemple |
| n | Mois; i.e. "01" à "12" |
| Y | Année, 4 chiffres; i.e. "2003" |
| y | Année, 2 chiffres; i.e. "03" |
| H | heure, au format 24h, "00" à "23" |
| i | Minutes; "00" à "59" |
<OVArticleDate date="%d %j %m %Y">
Remarque :
<OVbabCurrentDate> est une variable permettant de récupérer la date courante.
Elle ne doit pas être déclarée par la fonction OFPutVar pour l'utiliser.
<OVbabCurrentDate date="%D %j %M" strcase="lower">
author
Permet de formater l’auteur d’un article, un commentaire etc, … quand la variable contient l’id de l’auteur.
| Value | |
|---|---|
| %F | Prénom |
| %M | Deuxième prénom |
| %L | Nom |
<OVArticleAuthor author="%F %L" strcase="lower">
Les fonctions OvML
On reconnaît les fonctions par la syntaxe suivante :
<OFxxxx ... >
Les fonctions OvML disponibles sont :
Translate
Permet de traduire une chaîne
<OFTranslate text="Bonjour tout le monde" lang="nl-be">
Ceci traduit la chaîne en nl-be.
L’attribut lang est optionnel. Dans ce cas, Ovidentia utilisera la langue choisie par l'utilisateur courant.
PutVar
Permet de déclarer une nouvelle variable.
<OFPutVar name="nom-de-la variable" value="valeur-de-la-variable">
L’attribut value est optionnel. Dans ce cas, Ovidentia utilisera la valeur de la variable globale Ovidentia ayant le même nom si elle existe :
<OFPutVar name="babSiteName">
Dans ce cas, <OVbabSiteName> contient le nom du site Ovidentia.
GetVar
Permet d'utiliser une variable tout comme la syntaxe <OVnom-de-la-variable>.
<OFGetVar name="nom-de-la variable">
IfNotIsSet
Permet de sauvegarder une variable si elle n’est pas déjà définie.
<OFIfNotIsSet name="nom-de-la variable" value="valeur-de-la-variable">
L’attribut value est optionnel. Dans ce cas, Ovidentia utilisera la valeur de la variable Ovidentia ayant le même nom :
<OFIfNotIsSet name="length" value="100">
UrlContent
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
<OFUrlContent url="http://www.mysite/page.html">
Recurse
La fonction OFRecurse permet d'exécuter un code tant qu'une condition est réalisée. Voici un exemple avec l'affichage de l'arborescence des catégories et thèmes d'articles. Ici, la fonction OFRecurse est utilisée pour relancer le container <OCArticleCategories> autant de fois que désiré en lui précisant le paramètre parentid (voir container <OCArticleCategories>).
Exemple avec une liste :
<source lang="ovml">
-
<OCArticleCategories>
-
<OVCategoryName>
-
<OFRecurse parentid="<OVCategoryId>">
<OCArticleTopics categoryid="<OVCategoryId>">
- <OVTopicName>
</OCArticleTopics>
</OCArticleCategories>
</source>
Opérateurs arithmétiques
Permettent de faire des opérations arithmétiques sur des variables. Elles sont construites de la manière suivante :
<OFAOxxxxx expr1="X" expr2="Y">
Les opérateurs disponibles sont :
Addition
Permet d’additionner expr1 et expr2 :
<OFAOAddition expr1="10" expr2="50">
Ceci fait l'addition de 10 et de 50. Le résultat doit être sauvegardé dans une variable via le paramètre saveas.
<OFAOAddition expr1="<OVTotal>" expr2="50">
Ceci fait l’addition de 50 avec la valeur de la variable Total. Le résultat doit être sauvegardé dans une variable via le paramètre saveas.
<OFAOAddition expr1="<OVTotal>" expr2="50" saveas="NewTotal">
Ceci définit la variable NewTotal ayant pour valeur la somme de 50 avec le contenu de la variable Total.
Soustraction
Permet de soustraire expr1 et expr2 :
<OFAOSubtraction expr1="100" expr2="50">
Multiplication
Permet de faire le produit de expr1 et expr2 :
<OFAOMultiplication expr1="100" expr2="50">
Division
Permet de diviser expr1 par expr2 :
<OFAODivision expr1="100" expr2="50">
Modulo
Permet de récupérer le reste de expr1 divisé par expr2 :
<OFAOModulus expr1="100" expr2="50">
Header
Permet d'envoyer un header HTTP pour le fichier ovml :
<OFHeader value="content-type:text/xml">
SetCookie
Permet de définir un cookie qui sera envoyé avec le reste des en-têtes :
<OFSetCookie name="" value="" expire="">
name est le nom du cookie, value est la valeur du cookie et est optionnel.
expire est une valeur en secondes et indique le temps après lequel le cookie expire.
GetCookie
Permet de récupérer la valeur d'un cookie :
<OFGetCookie name="moncookie">
name est le nom du cookie. La valeur du cookie peut être récupérée par ovml en utilisant la variable <OVmoncookie>.
SetSessionVar
Permet de choisir le type de sections à afficher dans le portail :
<OFSetSessionVar name="">
name peut prendre 2 valeurs : babSectionsType et babOvmlCurrentDelegation.
- babSectionsType définit le type des sections à afficherValeurs possibles :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ées8 : Sections générées par les modules15 : Toutes les sectionsRemarque : les valeurs peuvent s'additionner. Pour afficher les sections des articles et les sections personnalisées, on utilisera la valeur 6 (2 + 4)
- babOvmlCurrentDelegation filtre sur les sections propres à une délégation
Exemples :
<OFSetSessionVar name="babSectionsType" value="15"> affichera toutes les sections du portail
<OFSetSessionVar name="babSectionsType" value="4"> affichera uniquement les sections personnalisées du portail
<OFSetSessionVar name="babSectionsType" value="10"> affichera les sections générées par les modules et les sections générées par les articles
<OFSetSessionVar name="babOvmlCurrentDelegation" value="5"> affichera uniquement les sections générées par la délégation dont l'identifiant est 5 <OFSetSessionVar name="babOvmlCurrentDelegation" value="0"> cache toutes les sections générées dans les délégations
Request
Permet de connaître la valeur d'un paramètre dans l'url (méthode GET) ou passer par un formulaire (méthode POST).
<OFRequest name="tg" default="" saveas="mavariable">
Le paramètre name indique le nom du paramètre GET ou POST dont on veut connaître la valeur.
Le paramètre default est optionnel, il permet d'attribuer une valeur à la variable lorsque celle-ci n'est pas définie.
Le paramètre saveas est utilisé pour enregistrer la valeur du paramètre dans une nouvelle variable OVML. La variable pourra s'utiliser comme ceci : <Ovmavariable>.
Post
Permet de connaître la valeur d'un paramètre passé par un formulaire (méthode POST).
<source lang="ovml">
<OFPost name="" default="" saveas="">
</source>
Le paramètre name indique le nom du paramètre POST dont on veut connaître la valeur.
Le paramètre default est optionnel, il permet d'attribuer une valeur à la variable lorsque celle-ci n'est pas définie.
Le paramètre saveas est utilisé pour enregistrer la valeur du paramètre dans une nouvelle variable OVML. La variable pourra s'utiliser comme ceci : <Ovmavariable>.
Get
Permet de connaître la valeur d'un paramètre dans l'url (méthode GET).
Exemple
<source lang="ovml">
<OFGet name="" [default=""] saveas="">
</source>
Paramètres
Le paramètre name indique le nom du paramètre GET dont on veut connaître la valeur.
Le paramètre default est optionnel, il permet d'attribuer une valeur à la variable lorsque celle-ci n'est pas définie.
Le paramètre saveas est utilisé pour enregistrer la valeur du paramètre dans une nouvelle variable OVML. La variable pourra s'utiliser comme ceci : <Ovmavariable>.
SitemapPosition
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).
Exemple
<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é.
- La valeur par défaut est "1" (activé).
SitemapMenu
Retourne une liste au format HTML (ul, li) contenant l'arborescence des entrées de navigation d'Ovidentia (Plan du site), ou l'arborescence des entrées de navigation sous le nœud spécifié (si le paramètre selectednode est indiqué).
Exemple
<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é.
- La valeur par défaut est "1" (activé).
- maxdepth (optionnel)
- Permet de limiter le nombre de niveaux (sous-menus imbriqués). Pas de limite par défaut.
NextArticle
Retourne l'identifiant de l'article suivant l'article spécifié. L'article suivant dépend des paramètres passés à la fonction. Ces paramètres sont similaires à ceux passés au container OCArticles
Exemple
<source lang="ovml">
<OFNextArticle articleid="" topicid="" orderby="" order="">
</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
-
- Yes : Donne la liste des articles archivés
- No: Donne la liste des articles non archivés
- Si omis, liste uniquement les articles non archivés.
- order (optionnel)
-
- asc: Ordonne les articles par ordre croissant en fonction de la date
- desc: Ordonne les articles par ordre décroissant en fonction de la date (valeur par défaut)
- rand: Ordonne les articles aléatoirement
- orderby (optionnel)
- Peut-être couplé avec l'attribut order.
- creation: Ordonne les articles par ordre de création en fonction de la date
- publication: Ordonne les articles par ordre de publication en fonction de la date
- modification: Ordonne les articles par ordre de modification en fonction de la date
- topicorder (optionnel)
-
- yes: Utilise l'ordre défini par le gestionnaire du thème d'articles
- no: N'utilise l'ordre défini par le gestionnaire du thème d'articles
- delegationid (optionnel)
-
- Si omis ou 0 : pas de filtre
- Id de la délégation.
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 <OVxxxx>.
La liste des variables dépend du type de container.
Ces variables ne sont plus disponibles en dehors du container
A l’intérieur de tout container de type liste, les variables suivantes sont disponibles :
- 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
<OCxxxx expr1="value" expr2="value"> ….. </OCxxxx>
Ces containers permettent d’effectuer des comparaisons entre les valeurs expr1 et expr2.
Si la condition est vrai, le contenu du container est parcouru.
| OCIfEqual | Vrai si expr1 est égal à expr2 |
| OCIfNotEqual | Vrai si expr1 est différent expr2 |
| OCIfLessThan | Vrai si expr1 plus petit strictement que expr2 |
| OCIfLessThanOrEqual | Vrai si expr1 plus petit ou égal que expr2 |
| OCIfGreaterThan | Vrai si expr1 plus grande strictement que expr2 |
| OCIfGreaterThanOrEqual | Vrai si expr1 plus grande ou égal que expr2 |
Exemple :
<OCIfEqual expr1="<OVCategoryId>" expr2="<OVcat>">
<tr bgcolor="#6B9DCA">
<td width="10"></td>
<td class="BabBodySection" valign="middle"><OVbabsectionbullet></td>
<td width="5"></td>
<td class="BabBodySection">
<OVTopicName>
</td>
</tr>
</OCIfEqual>
Les opérateurs de test d'existence sur les variables
Ces containers permettent de vérifier l'existence ou non d'une variable.
Si la variable est définie ou non, selon le container, le container est parcouru.
<OCIfIsSet name="nom-de-la-variable"> ….. </OCIfIsSet>
Si la variable est définie le contenu du container est parcouru.
<OCIfNotIsSet name="nom-de-la-variable"> ….. </OCIfNotIsSet>
Si la variable n'est pas définie, le contenu du container n'est pas parcouru.
OCIfUserMemberOfGroups
Ce container est exécuté si l'utilisateur courant appartient à un groupe
<OCIfUserMemberOfGroups userid="" groupid="" all="" childs=""> ....</OCIfUserMemberOfGroups>
Attributs :
groupid :
- id du groupe ou plusieurs ids séparés par une virgule
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 :
- yes : L'utilisateur courant doit appartenir à tous les groupes spécifiés dans groupid
- no : L'utilisateur courant doit appartenir à au moins un des groupes spécifiés dans groupid
- si omis, il suffit que l'utilisateur appartienne à au moins un des groupes
childs :
Optionnel
- yes : Pour chaque groupe, inclure ses enfants
- no ou si omis : Les enfants ne sont pas inclus
OCArticlesHomePages
Liste les articles des pages d’accueil privée ou publique.
<OCArticlesHomePages type="" order="" filter="">....</OCArticlesHomePages>
Attributs :
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 : 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
Si omis, le container ordonne par ordre croissant en fonction de la date.
Filter :
Optionnel
- yes : Filtre les articles selon le droit de visibilité
- no : Ne filtre pas
Si omis, le container ne filtre pas les articles.
Imageheightmax :
Optionnel
Valeur en pixels. Permet de préciser la hauteur maximum de l'image associée.
Si omis, l'image n'est pas redimensionnée et garde sa taille d'origine.
Imagewidthmax :
Optionnel
Valeur en pixels. Permet de préciser la largeur maximum de l'image associée.
Si omis, l'image n'est pas redimensionnée et garde sa taille d'origine.
Variables :
| 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.
<OCRecentFiles folderid="xx" from_lastlog="xx" last="xx">....</OCRecentFiles>
Attributs :
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 = depuis sa dernière connexion )
last :
- Nombre de fichiers souhaité
order :
Optionnel.
- Asc : Ordonne les fichiers par ordre croissant en fonction de la date
- desc : Ordonne les fichiers par ordre décroissant en fonction de la date (default)
- rand : Ordonne les fichiers aléatoirement
path :
- Indique dans quel sous-répertoire il faut chercher.
Delegationid :
Optionnel.
- Si omis ou 0 : pas de filtre
- Id de la délégation.
Variables :
| 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.
<OCRecentArticles from_lastlog="" last="" topicid="" order="" minrating="">....</OCRecentArticles>
Attributs :
topicid :
Optionnel.
Permet de préciser les thèmes d'articles concernés
- Id du thème ou plusieurs Ids séparés par une virgule
- Si omis, le container liste les articles tous thèmes confondus
excludetopicid :
Optionnel.
Permet de préciser les thèmes d'articles à exclure à la différence du paramètre topicid
- Id du thème ou plusieurs Ids séparés par une virgule
categoryid :
Optionnel.
- Id de la catégorie, tous les thèmes enfants seront utilisés
- si categoryid est utilisé, topicid devient obsolète
from_lastlog :
Optionnel.
- Indique combien de jours avant la dernière connexion de l'utilisateur
- ( 0 = depuis sa dernière connexion )
last :
- Nombre d‘articles souhaité
order :
Optionnel.
- Asc : Ordonne les articles par ordre croissant en fonction de la date
- desc : Ordonne les articles par ordre décroissant en fonction de la date (valeur par défaut)
- rand : Ordonne les articles aléatoirement
orderby :
Optionnel, peut être couplé avec l'attribut order.
- Creation : Ordonne les articles par ordre de création en fonction de la date
- publication : Ordonne les articles par ordre de publication en fonction de la date
- modification : Ordonne les articles par ordre de modification en fonction de la date
- rating : Ordonne les articles en fonction de la note moyenne attribuée dans les commentaires
topicorder :
Optionnel.
- Yes : Utilise l'ordre défini par le gestionnaire du thème d'articles
- no : N'utilise l'ordre défini par le gestionnaire du thème d'articles
archive :
Optionnel.
- Yes : Donne la liste des articles archivés
- No : Donne la liste des articles non archivés
- Si omis, liste uniquement les articles non archivés
delegationid :
Optionnel.
- Si omis ou 0 : pas de filtre
- Id de la délégation.
Imageheightmax :
Optionnel
Valeur en pixels. Permet de préciser la hauteur maximum de l'image associée.
Si omis, l'image n'est pas redimensionnée et garde sa taille d'origine.
Imagewidthmax :
Optionnel
Valeur en pixels. Permet de préciser la largeur maximum de l'image associée.
Si omis, l'image n'est pas redimensionnée et garde sa taille d'origine.Minrating :OptionnelValeur numérique. Permet de filtrer les articles ayant une note moyenne dans les commentaires supérieure ou égale à la valeur fournie en paramètre
Variables :
| 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.
<OCRecentComments from_lastlog="" last="" articleid="">....</OCRecentComments>
Attributs :
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 = depuis sa dernière connexion )
last :
- Nombre de commentaires souhaité
order :
Optionnel.
- Asc : Ordonne les commentaires par ordre croissant en fonction de la date
- desc : Ordonne les commentaires par ordre décroissant en fonction de la date (défaut)
- rand : Ordonne les commentaires aléatoirement
delegationid :
Optionnel.
- Si omis ou 0 : pas de filtre
- Id de la délégation.
Variables :
| 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.
<OCRecentThreads from_lastlog="" last="" forumid="">....</OCRecentThreads>
Attributs :
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 = depuis sa dernière connexion )
last :
- Nombre de fils de discussion souhaité
order :
Optionnel.
- Asc : Ordonne les fils de discussion par ordre croissant en fonction de la date
- desc : Ordonne les fils de discussion par ordre décroissant en fonction de la date (default)
- rand : Ordonne les fils de discussion aléatoirement
delegationid :
Optionnel.
- Si omis ou 0 : pas de filtre
- Id de la délégation.
Variables :
| 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.
<OCRecentPosts from_lastlog="" last="" forumid="" threadid="">....</OCRecentPosts>
Attributs :
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 = depuis sa dernière connexion )
last :
- Nombre de contributions souhaité
order :
Optionnel.
- Asc : Ordonne les contributions par ordre croissant en fonction de la date
- desc : Ordonne les contributions par ordre décroissant en fonction de la date (default)
- rand : Ordonne les contributions aléatoirement
delegationid :
Optionnel.
- Si omis ou 0 : pas de filtre
- Id de la délégation.
Variables :
| 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.
<OCRecentFaqQuestions from_lastlog="" last="" faqid="" faqsubcatid="" order="" delegationid=""> ... </OCRecentFaqQuestions>
Attributs :
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 = depuis sa dernière connexion )
last :
- Nombre de questions souhaité
faqsubcatid :
Optionnel
- Id de la catégorie de faq
order :
Optionnel.
- Asc : Ordonne les contributions par ordre croissant en fonction de la date
- desc : Ordonne les contributions par ordre décroissant en fonction de la date (default)
- rand : Ordonne les contributions aléatoirement
delegationid :
Optionnel.
- Si omis ou 0 : pas de filtre
- Id de la délégation.
Variables :
| 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.
<OCArticleCategories parentid="">....</OCArticleCategories>
Attributs :
parentid :
Optionnel.
- Id de la catégorie parent ou plusieurs Ids séparés par une virgule
- Si omis ou égale à 0, le container liste les catégories de thèmes à la racine.
Delegationid :
Optionnel.
- Si omis ou 0 : pas de filtre
- Id de la délégation.
Imageheightmax :
Optionnel
Valeur en pixels. Permet de préciser la hauteur maximum de l'image associée.
Si omis, l'image n'est pas redimensionnée et garde sa taille d'origine.
Imagewidthmax :
Optionnel
Valeur en pixels. Permet de préciser la largeur maximum de l'image associée.
Si omis, l'image n'est pas redimensionnée et garde sa taille d'origine.
Variables :
| 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.
<OCArticleCategoryNext>....</OCArticleCategoryNext>
Variables :
Idem que ceux du container OCArticleCategories
OCArticleCategoryPrevious
Ce container est valable uniquement dans le container OCArticleCategories. Il permet de récupérer les informations de l’entrée précédente.
<OCArticleCategoryPrevious>....</OCArticleCategoryPrevious>
Variables :
Idem que ceux du container OCArticleCategories
OCParentsArticleCategory
Liste des catégories de sujets parents.
<OCParentsArticleCategory categoryid="" reverse="">....</OCParentsArticleCategory>
Attributs :
categoryid :
- Id de la catégorie.
Reverse :
- 1 si on souhaite la liste dans l’ordre inverse.
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 :
| 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.
<OCArticleCategory categoryid="">...</OCArticleCategory>
Attributs :
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 :
| 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.
<OCArticleTopics categoryid="">....</OCArticleTopics>
Attributs :
categoryid :
- Id de la catégorie ou plusieurs Ids séparés par une virgule
delegationid :
Optionnel.
- Si omis ou 0 : pas de filtre
- Id de la délégation.
Imageheightmax :
Optionnel
Valeur en pixels. Permet de préciser la hauteur maximum de l'image associée.
Si omis, l'image n'est pas redimensionnée et garde sa taille d'origine.
Imagewidthmax :
Optionnel
Valeur en pixels. Permet de préciser la largeur maximum de l'image associée.
Si omis, l'image n'est pas redimensionnée et garde sa taille d'origine.
Variables:
| 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.
<OCArticleTopicNext>....</OCArticleTopicNext>
Variables :
Idem que ceux du container OCArticleTopics
OCArticleTopicPrevious
Ce container est valable uniquement dans le container OCArticleTopics. Il permet de récupérer les informations de l’entrée précédente.
<OCArticleTopicPrevious>....</OCArticleTopicPrevious>
Variables :
Idem que ceux du container OCArticleTopics
OCArticleTopic
Description d’un thème d'articles donné.
<OCArticleTopic topicid="">....</OCArticleTopic>
Attributs :
topicid :
Optionnel.
- Id du thème d’articles ou plusieurs Ids séparés par une virgule
- Si omis, le container liste tous les thèmes d’articles.
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.
Détails :
<OCArticleTopic topicname="essai">...</OCArticleTopic>Recherche tous les thèmes dont l'utilisateur a le droit et ayant pour nom "essai"<OCArticleTopic topicid="1,2,3" topicname="essai">...</OCArticleTopic>Recherche les thèmes d'id 1,2 3 ayant pour nom essai.<OCArticleTopic topicid="1,2,3" topicname="%essai">...</OCArticleTopic>Recherche les thèmes d'id 1,2 3 et dont le nom se termine par essai<OCArticleTopic topicid="1,2,3" topicname="essai%">...</OCArticleTopic>Recherche les thèmes d'id 1,2 3 et dont le nom commence par essai<OCArticleTopic topicid="1,2,3" topicname="%essai%">...</OCArticleTopic>Recherche les thèmes d'id 1,2 3 et dont le nom contient la chaîne essai
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 :
| 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 |
OCArticles
Liste des articles d'un thème d'articles donné.
<OCArticles topicid="" rows="" offset="n" archive="" minrating="">....</OCArticles>
Attributs :
topicid :
Optionnel.
Permet de préciser les thèmes d'articles concernés
- Id du thème ou plusieurs Ids séparés par une virgule
- Si omis, le container liste les articles 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: Donne la liste des articles non archivés
- Si omis, liste uniquement les articles non archivés.
Offset :
Optionnel
- "n" indique le nième article à partir du début de la liste
rows :
Optionnel
- "n" combien il faut en prendre
order :
Optionnel.
- Asc : Ordonne les articles par ordre croissant en fonction de la date
- desc : Ordonne les articles par ordre décroissant en fonction de la date (valeur par défaut)
- rand : Ordonne les articles aléatoirement
orderby :
Optionnel, peut être couplé avec l'attribut order.
- Creation : Ordonne les articles par ordre de création en fonction de la date
- publication : Ordonne les articles par ordre de publication en fonction de la date
- modification : Ordonne les articles par ordre de modification en fonction de la date
- rating : Ordonne les articles en fonction de la note moyenne attribuée dans les commentaires
topicorder :
Optionnel.
- Yes : Utilise l'ordre défini par le gestionnaire du thème d'articles
- no : N'utilise l'ordre défini par le gestionnaire du thème d'articles
delegationid :
Optionnel.
- Si omis ou 0 : pas de filtre
- Id de la délégation.
Imageheightmax :
Optionnel
Valeur en pixels. Permet de préciser la hauteur maximum de l'image associée.
Si omis, l'image n'est pas redimensionnée et garde sa taille d'origine.
Imagewidthmax :
Optionnel
Valeur en pixels. Permet de préciser la largeur maximum de l'image associée.
Si omis, l'image n'est pas redimensionnée et garde sa taille d'origine.Minrating :OptionnelValeur numérique. Permet de filtrer les articles ayant une note moyenne dans les commentaires supérieure ou égale à la valeur fournie en paramètre
Variables :
| 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.
<OCArticleNext>....</OCArticleNext>
Variables :
Idem que ceux du container OCArticles.
OCArticlePrevious
Ce container est valable uniquement dans le container OCArticles. Il permet de récupérer les informations de l’entrée précédente.
<OCArticlePrevious>....</OCArticlePrevious>
Variables :
Idem que ceux du container OCArticles.
OCArticle
Donne les informations sur un article donné.
<OCArticle articleid="">....</OCArticle>
Attributs :
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 :
| 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é.
<OCArticleFiles articleid="">....</OCArticleFiles>
Attributs :
articleid :
- Id de l’article ou plusieurs Ids séparés par une virgule
Variables :
| OVArticleFileName | Nom du fichier |
| OVArticleFileDescription | Description du fichier |
| OVArticleFileUrlGet | Url pour atteindre le fichier |
OCForums
Liste des forums.
<OCForums forumid=" ">....</OCForums>
Attributs :
forumid :
Optionnel.
- Id du forum ou plusieurs Ids séparés par une virgule
- Si omis, le container liste tous les forums.
Delegationid :
Optionnel.
- Si omis ou 0 : pas de filtre
- Id de la délégation.
Variables :
| 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.
<OCForumNext>....</OCForumNext>
Variables :
Idem que ceux du container OCForums.
OCForumPrevious
Ce container est valable uniquement dans le container OCForums. Il permet de récupérer les informations de l’entrée précédente.
<OCForumPrevious>....</OCForumPrevious>
Variables :
Idem que ceux du container OCForums.
OCForum
Donne les informations sur un forum donné.
<OCForum forumid="">....</OCForum>
Attributs :
forumid :
- Id du forum
Variables :
| 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é.
<OCThread threadid="">....</OCThread>
Attributs :
threadid :
- Id du forum
order :
Optionnel.
- Asc : Ordonne les fils de discussion par ordre croissant en fonction de la date
- desc : Ordonne les fils de discussion par ordre décroissant en fonction de la date (default)
- rand : Ordonne les fils de discussion aléatoirement
Variables :
| 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.
<OCPost postid="">....</OCPost>
Attributs :
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 : Ordonne les commentaires par ordre décroissant en fonction de la date (default)
- rand : Ordonne les commentaires aléatoirement
Variables :
| 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.
<OCPostFiles postid="">....</OCPost>
Attributs :
postid :
- Id de la contribution
Variables :
| OVPostFileName | Nom du fichier |
| OVPostFileUrlGet | Url pour atteindre le fichier |
OCFolders
Liste les répertoires partageables.
<OCFolders folderid=" ">....</OCFolders>
Attributs :
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.
- Si omis ou 0 : pas de filtre
- Id de la délégation.
Variables :
| 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.
<OCFolderNext>....</OCFolderNext>
Variables :
Idem que ceux du container OCFolders.
OCFolderPrevious
Ce container est valable uniquement dans le container OCFolders. Il permet de récupérer les informations de l’entrée précédente.
<OCFolderPrevious>....</OCFolderPrevious>
Variables :
Idem que ceux du container OCFolders.
OCFolder
Donne les information sur un répertoire partageable donné.
<OCFolder folderid=" ">....</OCFolder>
Attributs :
folderid :
- Id du répertoire
Variables :
| 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é.
<OCSubFolders folderid="" path="" order="">....</OCSubFolders>
Attributs :
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 : ordonne par ordre croissant
- desc : ordonne par ordre décroissant
Variables :
| 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é.
<OCFiles folderid="" path="" rows="" offset="">....</OCFiles>
Attributs :
folderid :
- Id du répertoire
path :
Optionnel
- Chemin du répertoire par rapport au répertoire partageable
- Si omis, le container liste les fichiers du répertoire partageable
offset :
- "n" indique le nième fichier à partir du début de la liste
rows :
- "n" combien il faut en prendre
Variables :
| 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 |
Remarque : le paramètre inl=1 peut être ajouté à l'url de téléchargement du fichier afin d'ouvrir le fichier en utilisant les plugins du navigateur (Microsoft Word, Adobe Acrobat...) :
Exemple : <a href="<OVFileUrl>&inl=1"> <OVFileName> </a>
OCFileNext
Ce container est valable uniquement dans le container OCFiles. Il permet de récupérer les informations de l’entrée suivante.
<OCFileNext>....</OCFileNext>
Variables :
Idem que ceux du container OCFiles.
OCFilePrevious
Ce container est valable uniquement dans le container OCFiles. Il permet de récupérer les informations de l’entrée précédente.
<OCFilePrevious>....</OCFilePrevious>
Variables :
Idem que ceux du container OCFolders.
OCFile
Donne les informations sur un fichier d'un répertoire partageable donné.
<OCFile fileid="" path="" rows="" offset="">....</OCFile>
Attributs :
fileid :
- Id du fichier
Variables :
| 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 |
Remarque : le paramètre inl=1 peut être ajouté à l'url de téléchargement du fichier afin d'ouvrir le fichier en utilisant les plugins du navigateur (Microsoft Word, Adobe Acrobat...) :
Exemple : <a href="<OVFileUrl>&inl=1"> <OVFileName> </a>
OCFileFields
Donne la liste des champs d'un fichier donné.
<OCFileFields fileid="">....</OCFileFields>
Attributs :
fileid :
- Id du fichier
Variables :
| OVFileFieldName | Nom du champ |
| OVFileFieldValue | Valeur du champ |
OCFaqs
Donne la liste des Faqs.
<OCFaqs faqid="">....</OCFaqs>
Attributs :
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.
- Si omis ou 0 : pas de filtre
- Id de la délégation.
Variables :
| 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.
<OCFaqNext>....</OCFaqNext>
Variables :
Idem que ceux du container OCFaqs.
OCFaqPrevious
Ce container est valable uniquement dans le container OCFaqs. Il permet de récupérer les informations de l’entrée précédente.
<OCFaqPrevious>....</OCFaqPrevious>
Variables :
Idem que ceux du container OCFaqs.
OCFaq
Donne les informations sur une Faq donnée.
<OCFaq faqid="">....</OCFaq>
Attributs :
faqid :
- Id de la Faq
Variables :
| 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.
<OCFaqSubCategories faqid="">....</OCFaqSubCategories>
Attributs :
faqid :
- Id de la faq
delegationid :
Optionnel.
- Si omis ou 0 : pas de filtre
- Id de la délégation.
Variables :
| 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.
<OCFaqSubCategory faqsubcatid="">....</OCFaqSubCategory>
Attributs :
faqsubcatid :
- Id de la sous catégorie ou plusieurs Ids séparés par une virgule
Variables :
| 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.
<OCFaqQuestions faqid="">....</OCFaqQuestions>
Attributs :
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 :
| 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.
<OCFaqQuestionNext>....</OCFaqQuestionNext>
Variables :
Idem que ceux du container OCFaqQuestions.
OCFaqQuestionPrevious
Ce container est valable uniquement dans le container OCFaqQuestions. Il permet de récupérer les informations de l’entrée précédente.
<OCFaqQuestionPrevious>....</OCFaqQuestionPrevious>
Variables :
Idem que ceux du container OCFaqQuestions.
OCFaqQuestion
Donne les informations sur une questions/réponses donnée.
<OCFaqQuestion questionid="">....</OCFaqQuestion>
Attributs :
faqid :
- Id de la question/réponse de la Faq
Variables:
| 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é.
<OCWaitingArticles topicid="" userid="">....</OCWaitingArticles>
Attributs :
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.
- Si omis ou 0 : pas de filtre
- Id de la délégation.
Imageheightmax :
Optionnel
Valeur en pixels. Permet de préciser la hauteur maximum de l'image associée.
Si omis, l'image n'est pas redimensionnée et garde sa taille d'origine.
Imagewidthmax :
Optionnel
Valeur en pixels. Permet de préciser la largeur maximum de l'image associée.
Si omis, l'image n'est pas redimensionnée et garde sa taille d'origine.
Variables :
| 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é.
<OCWaitingComments articleid="" userid="">....</OCWaitingComments>
Attributs :
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.
- Si omis ou 0 : pas de filtre
- Id de la délégation.
Variables :
| 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é.
<OCWaitingFiles folderid="" userid="">....</OCWaitingFiles>
Attributs :
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.
- Si omis ou 0 : pas de filtre
- Id de la délégation.
Variables :
| 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é.
<OCWaitingPosts forumid="" userid="">....</OCWaitingPosts>
Attributs :
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.
- Si omis ou 0 : pas de filtre
- Id de la délégation.
Variables :
| 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
<OCCalendars type="" calendarid="">....</OCCalendars>
Attributs :
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 : un ou plusieurs id d'agendas séparés par des virgules ; si omis, le container liste tous les agendas.
Delegationid :
Optionnel.
- Si omis ou 0 : pas de filtre
- Id de la délégation.
Variables :
| 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
<OCCalendarCategories>....</OCCalendarCategories>
Attributs :
filter :
Optionnel.
- Si filter=«no», ne filtre pas selon les droits de visibilité
Variables :
| 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
<OCCalendarUserEvents calendarid="" date="" limit="" filter="" categoryid="">....
</OCCalendarUserEvents>
Attributs :
calendarid :
Optionnel
- Si omis, le container liste les événements de l’agenda personnel de l’utilisateur courant.
Userid :
Optionnel.
- Si omis, le container liste les événements de l’agenda personnel de l’utilisateur courant.
- Cet attribut n'est plus utilisé depuis la version 6.0.4 d'ovidentia, il est recommandé d'utiliser calendarid
date :
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.
Variables:
| OVEventTitle | Intitulé de l’événement |
| OVEventDescription | Description de l’événement |
| OVEventLocation | Lieu de l'événement |
| OVEventBeginDate | Date de début |
| OVEventEndDate | Date de fin |
| OVEventCategoryId | Id de la catégorie de l’événement |
| OVEventCategoryColor | Couleur de la catégorie sous forme de FFFFFF |
| OVEventCategoryName | Nom de la catégorie |
| OVEventUrl | Url pour accéder à l’événement (vide si filter=no) |
| OVEventCalendarUrl | Url pour accéder à l’agenda au jour de l’événement (vide si filter=no) |
| 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)
<OCCalendarGroupEvents calendarid="" date="" limit="" filter="" categoryid="">....</OCCalendarGroupEvents>
Attributs :
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.
Groupid :
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.
- 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.
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.
Variables:
| OVEventTitle | Intitulé de l’événement |
| OVEventDescription | Description de l’événement |
| OVEventLocation | Lieu de l'événement |
| OVEventBeginDate | Date de début |
| OVEventEndDate | Date de fin |
| OVEventCategoryId | Id de la catégorie de l’événement |
| OVEventOwner | Nom du propriétaire de l’agenda |
| OVEventCategoryColor | Couleur de la catégorie sous forme de FFFFFF |
| OVEventCategoryName | Nom de la catégorie |
| OVEventUrl | Url pour accéder à l’événement (vide si filter=no) |
| OVEventCalendarUrl | Url pour accéder à l’agenda au jour de l’événement (vide si filter=no) |
| OVEventCategoriesPopupUrl | Url pour afficher les différentes catégories (vide si filter=no) |
OCCalendarResourceEvents
Liste les événements d’un ou plusieurs agendas de ressources
<OCCalendarResourceEvents calendarid="" date="" limit="" filter="" categoryid="">....</OCCalendarResourceEvents>
Attributs :
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.
Resourceid :
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.
- Cet attribut n'est plus utilisé depuis la version 6.0.4 d'ovidentia, il est recommandé d'utiliser calendarid
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.
Variables :
| OVEventTitle | Intitulé de l’événement |
| OVEventDescription | Description de l’événement |
| OVEventLocation | Lieu de l'événement |
| OVEventBeginDate | Date de début |
| OVEventEndDate | Date de fin |
| OVEventCategoryId | Id de la catégorie de l’événement |
| OVEventOwner | Nom du propriétaire de l’agenda |
| OVEventCategoryColor | Couleur de la catégorie sous forme de FFFFFF |
| OVEventCategoryName | Nom de la catégorie |
| OVEventUrl | Url pour accéder à l’événement (vide si filter=no) |
| OVEventCalendarUrl | Url pour accéder à l’agenda au jour de l’événement (vide si filter=no) |
| OVEventCategoriesPopupUrl | Url pour afficher les différentes catégories (vide si filter=no) |
OCCalendarEvents
Liste les événements d’un ou plusieurs agendas ( personnel, groupes ou de ressources )
<OCCalendarEvents calendarid="" date="" limit="" filter="" categoryid="">....</OCCalendarEvents>
Attributs :
calendarid :
Optionnel.
- Si omis, le container liste les événements de tous les agendas pour lesquels l’utilisateur courant a le droit d’accès.
Date :
Optionnel.
- Si omis date courante.
- Sinon le format de la date doit être aaaa-mm-jj
limit :
Optionnel.
- Si omis, le container liste les événements de la date passée dans le paramètre date
- Indique le nombre de jours à traiter avant et après la date
- Format «x,y»: x jours avant la date et y jours après la date
- Remarque : si le paramètre date n'est pas précisé, limit="1,1" ramènera les événements à – 24h et + 24h de la date/heure courante
categoryid :
Optionnel.
- Id d’une catégorie ou plusieurs séparés par des virgules.
- Dans ce cas le container liste que les événements de ce type de catégories
filter :
Optionnel.
- Si filter=«no», ne filtre pas selon les droits de visibilité
delegationid :
Optionnel.
- Si omis ou 0 : pas de filtre
- Id de la délégation.
Holiday :
Optionnel.
- Si holiday=«no», les jours fériés ne sont pas inclus.
Variables :
| OVEventTitle | Intitulé de l’événement |
| OVEventDescription | Description de l’événement |
| OVEventLocation | Lieu de l'événement |
| OVEventBeginDate | Date de début |
| OVEventEndDate | Date de fin |
| OVEventCategoryId | Id de la catégorie de l’événement |
| OVEventCategoryColor | Couleur de la catégorie sous forme de FFFFFF |
| OVEventCategoryName | Nom de la catégorie |
| OVEventUrl | Url pour accéder à l’événement (vide si filter=no) |
| OVEventCalendarUrl | Url pour accéder à l’agenda au jour de l’événement (vide si filter=no) |
| OVEventCategoriesPopupUrl | Url pour afficher les différentes catégories (vide si filter=no) |
OCDbDirectories
Liste les annuaires de base de données
<OCDbDirectories directoryid="">....</OCDbDirectories>
Attributs :
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 :
| 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 )
<OCDbDirectory directoryid="" type="">....</OCDbDirectory>
Attributs :
directoryid :
- Id de l'annuaire
type :
- « database » ou « group », si omis, le container liste tous les annuaires.
Variables :
| 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 )
<OCDbDirectoryFields directoryid="" all="">....</OCDbDirectoryFields>
Attributs :
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 :
| OVDirectoryFieldName | Intitulé du champ |
| OVDirectoryFieldId | Identifiant du champ |
Le tableau ci-dessous donne la correspondance entre les champs et leurs identifiants :
| |
|
|---|---|
| Surnom | cn |
| Nom | sn |
| Deuxième prénom | mn |
| Prénom | givenname |
| Photo | jpegphoto |
| Adresse de messagerie | |
| 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 )
<OCDbDirectoryMembers directoryid="" fields="" all="" orderby="" order="" like="">....</OCDbDirectoryMembers>
Attributs :
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 :
| OVDirectoryMemberId | Identifiant du membre dans l'annuaire |
| OVDirectoryMemberUserId | Identifiant du membre dans Ovidentia si l'annuaire est un annuaire des utilisateurs enregistrés.
Cette variable n'est pas fournie dans le cas des autres annuaires |
| OVDirectoryMemberUrl | Url pour accéder à la fiche détaillée du membre |
| DirectoryMemberEmailUrl | Url pour afficher la popup de composition de message |
| OVxxxxxxName | Intitulé du champ ayant pour identifiant xxxxxxx ( ex <OVgivennameName> ) |
| OVxxxxxxValue | Contenu du champ ayant pour identifiant xxxxxxx ( ex <OVgivennameValue> ) |
OCDbDirectoryMemberFields
Ce container n'est valable que dans le contexte du container OCDirectoryMembers
Liste les différents champs pour le membre courant.
<OCDbDirectoryMemberFields>....</OCDbDirectoryMemberFields>
Variables :
| OVDirectoryFieldName | Intitulé du champ |
| OVDirectoryFieldValue | Valeur du champ |
OCDbDirectoryEntry
Liste les informations concernant un membre d'un annuaire ( base de données )
<OCDbDirectoryEntry directoryid="" userid="" memberid="">....</OCDbDirectoryEntry>
Attributs :
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 :
| OVDirectoryEntryMemberId | Identifiant du membre dans l'annuaire |
| OVDirectoryEntryUserId | Identifiant du membre dans Ovidentia si l'annuaire est un annuaire des utilisateurs enregistrés.
Cette variable n'est pas fournie dans le cas des autres annuaires |
| OVxxxxxxName | Intitulé du champ ayant pour identifiant xxxxxxx ( ex <OVgivennameName> ) |
| OVxxxxxxValue | Contenu du champ ayant pour identifiant xxxxxxx ( ex <OVgivennameValue> ) |
| OVDirectoryEntryMemberUrl | Url vers la fiche annuaire du membre |
OCDbDirectoryEntryFields
Ce container n'est valable que dans le contexte du container OCDirectoryEntry
Liste les différents champs pour le membre courant.
<OCDbDirectoryEntryFields>....</OCDbDirectoryEntryFields>
Variables :
| OVDirectoryFieldName | Intitulé du champ |
| OVDirectoryFieldValue | Valeur du champ |
OCDbDirectoryAcl
Liste les utilisateurs ayant des droits sur un annuaire.
<OCDbDirectoryAcl directoryid="" type="">....</OCDbDirectoryAcl>
Attributs :
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 :
| 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.
<OCDelegations delegationid="" userid="" filter="">....</OCDelegations>
Attributs :
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 :
| 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
<OCDelegation delegationid="" userid="">....</OCDelegation>
Attributs :
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 :
| 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é.
<OCDelegationsManaged delegationid="" userid="">....</OCDelegationsManaged>
Attributs :
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 :
| 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é.
<OCDelegationManaged delegationid="" userid="">....</OCDelegationManaged>
Attributs :
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 :
| 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.
<OCDelegationItems delegationid="">....</OCDelegationItems>
Attributs :
delegationid :
- Id de la délégation
Variables :
| 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.
<OCDelegationAdministrators delegationid="">....</OCDelegationAdministrators>
Attributs :
delegationid :
- Id de la délégation
Variables :
| OVDelegationUserId | Id de l'administrateur |
OCDelegationsCategories
Liste les catégories de délégations.
<OCDelegationsCategories categoryid="">....</OCDelegationsCategories>
Attributs :
categoryid :
Optionnel
- Id de la délégation
- Si omis, le container liste toutes les catégories
Variables :
| 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.
<OCDelegationsCategory categoryid="">....</OCDelegationsCategory>
Attributs :
categoryid :
- Id de la délégation
Variables :
| 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.
<OCTmSpaces>....</OCTmSpaces>
Attributs :
Aucun attribut
Variables :
| 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.
<OCTmProjects spaceid="">....</OCTmProjects>
Attributs :
spaceid :
- Id de l'espace de projets
Variables :
| 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.
<OCTmTasks projectid="">....</OCTmTasks>
Attributs :
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 :
| 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.
<OCOrgUserEntities orgChartId="" userId="" roleType="" >....</OCOrgUserEntities>
Attributs :
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é.
userId :
- Identifiant (entier) de l'utilisateur.
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 :
| OVEntityId | Identifiant (entier) de l'entité |
| OVEntityName | Nom de l'entité |
| OVEntityDescription | Description de l'entité |
OCOrgPathToEntity
Liste toutes les entités parentes d'une entité d'un organigramme.
<OCOrgPathToEntity entityId="" order="" includeEntity="">
...
</OCOrgPathToEntity>
Attributs :
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 :
| 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.
<OCMultipages total="" maxpages="" perpage="" currentpage="">
...
</OCMultipages>
Attributs :
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:
| 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).
Exemple
<OCSitemapEntries node="" sitemap="" limit="">....</OCSitemapEntries>
Attributs
- node (obligatoire) :
- 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
| 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).
Exemple
<OCSitemapPath sitemap="" basenode="" node="" limit="">....</OCSitemapPath>
Attributs
- 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
| 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¶m=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 :
<OCAddon name="" param1="" param2="" ...>....</OCAddon>
Attribut s:
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 :
<OFAddon name="" function="" param1="" ...>
Attributs :
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.