Cette méthode vous permet d'afficher la documentation des actions installées sur votre site
{up upactionslist}
toutes les actions{up upactionslist=action1, action2}
une ou plusieurs actions{up upactionslist | md}
fichier marknote{up upactionslist | csv}
fichier CSV
*
*Sélection des actions listées
- upactionslist: liste des actions à récupérer. toutes par défaut
- exclude-prefix = _,x_: prefix des actions non listées. Separateur = comma
- without-custom: affiche les infos du dossier custom de l'action. 1 pour les masquer
Affichage du lien vers la démo
- demo = 1: afficher le lien vers la demo
Générer les fichiers JSON synonymes des noms utilisés par UP 'dico'
- make-dico: consolide le fichier principal dico.json avec ceux des actions
Création des fichiers documentation
- csv: fichier doc-actions.csv avec les options des actions
- comment: fichier 'comment-actions.csv' avec les infos des entêtes scripts pour analyse
- md: enregistre la documentation au format markdown dans plugins/content/up/doc-actions.md
Style CSS
- id: identifiant
- style: style ou class
- class: idem style
- filter: condition pour exécuter l'action
- Version 2.5
- Possibilité d'exclure les actions commençant par exclude-prefix
le lien demo non affiché si demopage=0, mais l'aide interne est disponible
possibilité de surcharger dico.ini dans custom (general et actions) - Version 2.8
- ajout option without-custom pour afficher les infos webmaster
- Version 2.9
- ajout traduction GB et upbtn dans doc-actions.csv
prise en charge sous-titre dans l'aide intégrée
upactionlist est une action à usage interne qui permet d'avoir la liste et la documentation des actions de UP
C'est cette action qui affiche la barre d'accordion ci-dessus
Sans paramètre, il affiche toutes les actions présentes dans le sous-dossier actions du plugin. Il est possible d'indiquer une ou plusieurs actions séparées par des virgules.
{up upactionslist=lorem,lorempixel}
Syntaxe :
{up lorem=liste des arguments ci-dessous }
- (integer) - Nombre de paragraphes (P) générés. 4 par défaut
- short, medium, medium, verylong - La longueur moyenne d'un paragraphe.
- decorate - ajoute bold, italic, ...
- link - ajoute des liens.
- ul - ajoute listes.
- ol - ajoute listes ordonnées.
- dl - ajoute listes description.
- bq - ajoute bloc citation
- code - ajoute des exemples de code.
- headers - ajoute des titre hx.
- allcaps - TOUT EN MAJUSCULES.
- prude - version prude.
- plaintext - Retourne text sans balise HTML.
exemple appel : https://loripsum.net/api/2/code/decorate
.
Pour avoir un texte sans aucun tag, utilisez :
{up lorem=2,plaintext | tag=0}
.Même sans balise P, le nombre de paragraphes influe sur la longueur du texte retourné.
- lorem: nombre de paragraphe et mots-clés séparés par des virgules
Divers
- max-char: nombre maxima de caractères
- max-word: nombre maxima de mots
Style CSS
- tag = div: (v1.6) tag du bloc contenant le texte en retour ou tag=0 pour aucun.
- id: pour forcer l'id (sans effet, si tag=0)
- class: classe(s) pour bloc (sans effet, si tag=0)
- style: style inline pour bloc (sans effet, si tag=0)
{up loremflickr=type | width=xx | height=xx}
.
Note : width & height sont les dimensions de l'image retournée par lorempixel. Pour l'afficher en remplissant le bloc parent, il faut ajouter style=width:100%
Le site //lorempixel.com étant fermé, l'action utilise le site //loremflickr.com
on peut appeler l'action par loremflickr ou lorempixel
- lorem_flickr (lorempixel,lorem_placeimg): mot(s) clé(s) séparé par des virgules
- height (h,hauteur) = 200: hauteur image téléchargée
- width (l,largeur,w) = 200: largeur image téléchargée
- color: g (gris), p (pixellisé), red, green, ou blue
Bloc parent
- main-tag (block) = div: balise du bloc parent à l'image si options main-class ou align
- main-class: classe(s)
- align: alignement horizontal : left, center, right
Style CSS
- id: identifiant
- class: classe(s)
- style: classes et styles
Attention au duplicate content
Evitez d'utiliser ce shortcode sur une page référencée par les moteurs de recherche. Elle serait considérée comme une copie de la même page sur ce site.
En dehors de ce risque, il est préférable de réserver la documentation technique sur votre site aux seules personnes autorisées
version 1.6 (oct 2019)
Ajout de 2 nouvelles options pour générer la documentation
- CSV : création d'un fichier CSV avec 3 colonnes : nom action, nom option, traduction du nom option, valeur par défaut, description option
- MD : création d'un fichier markdown reprenant la forme (sans les crédits) de la documentation HTML
Ces 2 fichiers sont enregistrés dans le dossier de l'action sur votre serveur: plugins/content/up/doc-actions.md|csv.
version 2.8 (mai 2022)
Nouvelle option without-custom pour ne pas afficher les préférences et infos du webmaster
Aide-mémoire pour convertir la sortie Markdown en PDF
- Ouvrir le fichier "plugins/content/up/doc-actions.md" avec Typora
- Faire Fichier > Exporter > Word
- Renommer et ouvrir le fichier .docx dans Word pour faire un copier de la totalité
- Renommer et ouvrir la version précédente du Word pour coller le texte (sauf l'entête)
- Ajouter une ligne 'bidon' au début de la première liste d'options.
- Clic droit sur la 2e ligne d'une liste > séparer la ligne.
- Clic-droit sur la 2e > Ajuster les retraits de la liste > Plus. Ajouter taquet tabulation à 0.3 cm et alignement à 0
- Supprimer la ligne 'bidon'
- Convertir les ^l^p en ^p
- Réduire l'espace après Titre 1 et Titre 4
- Mettre la doc d'une action sur une seule page (Maj+Entrée)
- Enregistrer sous format PDF en cochant sous Options : Créer des signets à l'aide des titres
- faire une version flip-builder pour demo action iframe
upactionslist (2) readmore (1) csv2def (1) jcontent-in_content (1) note (1) jcontent-info (1)