Commandes pour documentation
Commande a utiliser pour documenter en ligne ( usage interne )
Etapes de documentation
Permet de documenter les etapes d'un point de documentation
4. Personaliser le mini-site
Un véritable site web a été mis en ligne vous pouver en personaliser le contenu, l'adresse et la charte graphique.
Un nouveau dossier a été créé dans le back-office et un mini site web d'inscription est activé sur Internet.
[#assign listeEtapes = [
{
"titre": "Localiser l'interface de gestion des dossiers",
"description" : "Menu Inter-dossiers > Tous les dossiers
Créer dossier
",
"image" : "/file/~1060/DOC-GIPCO-ADNS/images/documentation/back-office/Dossier/Creation/GIPAD-CREATION002.png"
},
{
"titre": "Interface de création du dossier",
"description" : "Vous devez a minima renseigner le titre et les dates de votre évenement
Vous pourrez revenir a volonté sur ces réglages ulterieurement.
",
"image" : "/file/~1060/DOC-GIPCO-ADNS/images/documentation/back-office/Dossier/Creation/GIPAD-CREATION001.png"
},
{
"titre": "Résultat de la création",
"description" : "Voici le résultat de la création de votre évènement
Un nouveau dossier a été créé dans le back-office et un mini site web d'inscription est activé sur Internet.
",
"image" : "/file/~1060/DOC-GIPCO-ADNS/images/documentation/back-office/Dossier/Creation/gipco-adns-tableau-bord.jpg"
},
{
"titre": "Personaliser le mini-site",
"description" : "Un véritable site web a été mis en ligne vous pouver en personaliser le contenu, l'adresse et la charte graphique.
Un nouveau dossier a été créé dans le back-office et un mini site web d'inscription est activé sur Internet.
",
"image" : "/file/~1060/DOC-GIPCO-ADNS/images/documentation/back-office/Dossier/Creation/Capture_d__cran_2018-11-19___13.12.47.png"
,"lien": { "titre" : "Editer le mini-site", "pageid" : "60408"}
}
] ]
[@afficheListeObjets listeObjets=listeEtapes motifTemplate = 6152 /]
@docDetailCommande
Permet de documenter une macro, avec ses parametres et ses exemples
Paramètre | Requis | Type | Description |
---|---|---|---|
listeCommandes | oui | sequence | liste d'objets à afficher |
permet par exemple l'affichage de cette commande
[#-- Definition de la sequence ici la commande listeMacrosdeMaPage et ses parametres --]
[#assign listeMacrosdeMaPage = [
{
"nom": "@docDetailCommande",
"parametre": [
{"parametre" : "listeCommandes", "requis" : "oui","type" : "sequence","description":"liste d'objets à afficher"}
] ,
"description" : "Permet de mettre une chaine en majuscule premiere lettre",
"exemple": [{ "description" : "permet par exemple l'affichage de cette commande", "code" : "${exempleSourceDetailCommande}"}]
}
] ]
[#-- Appel de la macro pour affichage dans la page Web ( ici une section )--]
[@docDetailCommande listeCommandes=listeMacrosdeMaPage /]
@ueTitre
Permet d'afficher un titre en code unify
Paramètre | Requis | Type | Description |
---|---|---|---|
titre1 | oui | chaine | Le titre a afficher |
titre2 | non | chaine | un sous titre |
style | non | chaine | permet de definir l'alignement du titre par défaut : bandeau.centre |
voir par exemple le titre de cette page
[@ueTitre style="bandeau.centre" titre1="Commandes pour documentation"
titre2="Commande a utiliser pour documenter en ligne ( usage interne )
" /]
videos - afficher une liste de videos vimeo
Permet d'afficher une liste de videos ( voir http://doc.gipco.fr/tutos-videos )
Paramètre | Requis | Type | Description |
---|---|---|---|
url | oui | chaine | id de la video Vimeo |
date | non | chaine | date de la video |
duree | non | chaine | durée de la video |
description | non | chaine | description de l'objet de la video |
voir par exemple le titre de cette page
[#assign listeInstal =
[ {
"titre": "Gipco 5.0 - Monoposte - installation ",
"date": "23/12/2020", "duree": "2 mn",
"description" : " Installation du progiciel de gestion d'évènement Gipco en environnement Apple. "
,
"url": "206385970" } ,
{
"titre": "Gipco 5.0 - Monoposte - mise à jour ",
"date": "20 mars 2017", "duree": "3 mn 26",
"description" : " Voici comment installer manuellement le logiciel Gipco préalablement installé. " ,
"url": "208729103" }
] ]
[#assign titre ]
[@ueTitre titre1="Installation du progiciel Gipco" titre2="Simplement et sans compètences" /]
[/#assign ]
[@afficheListeObjets listeObjets=listeInstal motifTemplate = 6147 contenuAvant=titre /]