upactionslist ~ interne - liste et docs des actions

Cette méthode vous permet d'afficher la documentation des actions installées sur votre site

➠ upactionslist : INTERNE - liste des UP actions avec infos et paramétres

Cliquer pour lire la documentation

{up upactionslist} toutes les actions
{up upactionslist=action1, action2} une ou plusieurs actions
{up upactionslist | md} fichier marknote
{up upactionslist | csv} fichier CSV
author Lomart - http://lomart.fr update 2019-10-25 license GNU/GPLv3
  • upactionslist: liste des actions à récupérer. toutes par défaut
  • make-dico = 0: consolide le fichier principal dico.json avec ceux des actions
  • style:
  • class: (obsolète)
  • demo = 1: afficher le lien vers la demo
  • csv = 0: enregistre un tableau CSV des actions et options dans plugins/content/up/doc-actions.csv
  • md = 0: enregistre la documentation au format markdown dans plugins/content/up/doc-actions.md

    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}
    ➠ lorem : Affiche du texte aléatoire (enrichissement possible) DEMO
    .
    Syntaxe : {up lorem=liste des arguments ci-dessous }
    - (integer) - Nombre de paragraphe (P) généré. 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é.
    author Lomart version 1.0 - 07/2017 license GNU/GPLv3
    • lorem: nombre de paragraphe
    • class: classe(s) pour bloc (sans effet, si tag=0)
    • style: style inline pour bloc (sans effet, si tag=0)
    • tag = div: (v1.6) tag du bloc contenant le texte en retour ou tag=0 pour aucun.
    • max-char: nombre maxima de caractères
    • max-word: nombre maxima de mots
      ➠ lorempixel : affiche une image aleatoire DEMO
      Syntaxe : {up lorempixel=type | width=xx | height=xx }
      --> type = abstract, animals, business, cats, city, food, nightlife, fashion, people nature, sports, technics, transport
      .
      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%
      author Lomart version 07/2017 license GNU/GPLv3
      • lorempixel = cats: type d'image: abstract, animals, business, cats, city, food, nightlife, fashion, people nature, sports, technics, transport
      • align: alignement horizontal : left, center, right
      • height (h,hauteur) = 200: hauteur image téléchargée
      • width (l,largeur,w) = 200: largeur image téléchargée
      • class: classe(s) obsolète
      • 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

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

        Aide-mémoire pour convertir la sortie Markdown en PDF

        1. Ouvrir le fichier "plugins/content/up/doc-actions.md" avec Typora
        2. Faire Fichier > Exporter > Word
        3. Ouvrir le fichier .docx dans Word
        4. L'adapter
          • Revoir les marges
          • Revoir le titre et la date
          • Modifier le style "normal" : fontsize:10pt, paragraphe retrait avant/après: 3pt
          • Remplacer les <BR /> par un saut de ligne ^l
            note: UP utilise l'ancienne version du tag pour éviter la confusion avec un <br> dans les textes
          • Mettre la doc d'une action sur une seule page (Maj+Entrée)
        5. Enregister sous format PDF en cochant sous Options : Créer des signets à l'aide des titres