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
- Détails
- actions : toutes les actions
- nom_action : une action
- nom_action.php : le fichier principal non surchargeable
- xxx.js : javascript surchargeable dans custom
- xxx.scss : SCSS surchargeable dans custom
- xxx.css : CSS surchargeable dans custom. Compilé automatiquement à partir du SCSS de même nom
- custom : vos personnalisations (optionnel)
- prefs.ini.dist : fichier modèle fourni par UP
- prefs.ini : vos préférences pour l'action
- dico.ini : vos synonymes pour le nom de l'action et ses options.
Compilé par upactionslist avec l'option make-dico dans up/dico.json - upbtn-options.ini : description des options pour le bouton éditeur
- help.txt : vos aides et conseils affichés dans le bouton éditeur de UP.
utilisé par l'action upbtn-makefile - model ou autre nom : copie du dossier de même nom pour personnalisation
- fichier SCSS
- fichier CSS. Compilé automatiquement à partir du SCSS
- fichier informations (voir la démo de l'action)
- model ou autre nom : sous-dossier pour regrouper des modèles (par exemple)
- fichier SCSS
- fichier CSS. Compilé automatiquement à partir du SCSS
- fichier informations (voir la démo de l'action)
- up : fichiers utilitaires de l'action
- en-GB.ini : traduction anglaise pour la description et les options de l'action.
Il est possible de créer un fichier pour une nouvelle langue. - dico.ini : définition des synonymes pour le nom de l'action et ses options. surchargeable dans custom.
Compilé par upactionslist avec l'option make-dico dans up/dico.json - en-GB.nom_action.html : version anglaise des informations pour le bouton éditeur. Crée par l'action upbtn-makefile
- fr-FR.nom_action.html : version française des informations pour le bouton éditeur. Crée par l'action upbtn-makefile
- upbtn-options.ini : description des options pour le bouton éditeur
- en-GB.ini : traduction anglaise pour la description et les options de l'action.
- nom_action : une action
- assets : les ressources communes
- up.css : feuille de style de UP. Générée par upscsscompiler
- up.scss : fichier pour créer la feuille de style de UP. Non modifiable
- colorname.ini : fichier références pour l'action color généré par upscsscompiler.
- colorname-ref.ini : fichier références pour l'action color généré par upscsscompiler.
- custom : vos préférences
- _variables.scss : partiel SCSS pour définir vos préférences pour les variables SCSS. ne pas supprimer
- _variables.scss.dist : modèle pour créer votre fichier custom/_variables.scss
- _variables.scss.empty : fichier interne. ne pas supprimer
- _variables.v1.0.scss.bak : sauvegarde du fichier _variables.scss avant mise à jour de UP
- scss : partiels utilisés par up.scss
- plusieurs fichiers non modifiables
- js : fichiers javascript utilisés pas plusieurs actions
- plusieurs fichiers non modifiables
- img : images pour up.css et à disposition des actions
- diverses images
- overlay : images à disposition des actions pour créer des overlays
- diverses images
- language : le dossier des langues conforme à la norme Joomla
- en-GB
- en-GB.plg_content_up.ini
- en-GB.plg_content_up.sys.ini
- fr-FR
- fr-FR.plg_content_up.ini
- fr-FR.plg_content_up.sys.ini
- xx-XX : vous pouvez créer des traductions selon les usages Joomla
- en-GB
- upbtn : fichiers pour le plugin éditeur de UP
- en-GB.actions-list.html : version anglaise de la liste des actions. générée par upactionslist
- fr-FR.actions-list.html : version française de la liste des actions. généré par upactionslist
- upbtn.js : script pour le plugin éditeur
- upbtn.css : feuille de style pour le plugin éditeur
- custom
- dico.ini : vos synonymes pour les noms d'actions et leurs options (prioritaire)
- up.xml : manifest du plugin
- up.php : fichier principal du plugin
- upAction.php : helper avec fonctions utilitaires
- dico.ini : la définition des synonymes pour les noms d'actions et leurs options. surchargeable
- dico.json : généré par upactionslist avec l'option make-dico à partir des fichiers dico.ini.
- install.php : script d'installation du plugin
Petit lexique pour bien comprendre mes annotations :
- ne pas supprimer : le fichier doit exister sous peine d'erreur PHP, JS ou SCSS
- généré : inutile de modifier ce fichier, il sera recréé à la prochaine compilation
- surchargeable : il est possible de créer sa version du fichier dans le sous-dossier custom
- non surchargeable : ce fichier ne peut être ni surchargé, ni modifié
- Détails
- dans le code HTML : on met le code hexa en rouge (la partie après Ux) entre
et
;
.
Exemple :Ux26
➠&
si le caractère dispose d'une entité HTML (en vert), on l'utilise directement&
- dans une propriété CSS, on utilise le code hexa préfixé par un antislach
Exemple :.foo{content:"\26";}
Ma méthode de classement :
Elle sera affinée à l'usage. L'idée de base est de regrouper les caractères selon leur utilisations sans tenir compte du classement d'Unicode. Normalement, seuls les caractères lisibles sous Windows, Mac ou Android sont retenus ici. N'hésitez pas à signaler des oublis
Vous pouvez cliquer sur les liens ci-dessous pour aller directement à une sous-famille. Une fois sur la page, un menu à droite permet de naviguer dans cette dernière. Ce texte et menu est présent en haut de toutes les pages. voir le Top 100
Attention, le caractère peut être légèrement différent selon la police utilisée sur le site ou par le navigateur client.
- Détails
?le Top 100
Symboles
- ⭐ Etoiles
- ? Heure
- ☁ Météo
- ❈ Astérisque
- ✄ Ciseaux
- ❎ Croix
- ✑ Crayons
- ☘ décorations typographiques
- ❝ Guillemets
- ❖ Losanges
- ☛ Mains
- ✅ Coche - validation
- ❵ Parenthèses - accolades
- ✚ Plus
- ✟ Religions
- ☯ Divers
Formes
- ⭕ Cercles
- ⭖ Ellipses
- ► Triangles
- ▣ Carrés-rectangles
- ? Losanges
- ➧ Fléches-simples
- ⏩ Fléches-colorées
- ➽ Fléches
- ┋ Filets
- ? Panneaux-bleus
- ? Divers
Humain
- ? Personnes
- ♿ Handicap
- ✋ Parties du corps
- ? Alimentation
- ? Vétements
- ? Bijoux-décorations
- ? Santé-soins
- ? Ecole
- ⚤ Signes
- ♋ Zodiaque
Travail
- ? Achats-argent
- ? Courrier-mail
- ? Téléphone
- ? Calendrier-date
- ? Bureau accessoires
- ? Livres
- ? Documents
- ? Ordinateurs
- ? Outils
- ? Cadenas-clef
- ? Cloches
- ♲ Ecologie
- ? Armes
Loisirs
- ? Fêtes
- ? Sports
- ? Jeux de Cartes
- ? Jeux de Dominos
- ⚅ Jeux de dés
- ♘ Jeux déchec
- ? Jeux de Mahjong
- ? Jouets
- ☔ Météo
- ? Religions
- ? Cinéma-TV
- ? Musique
- Détails
La table ci-dessous est un comparatif des options proposées par les différentes actions Jxxx
A: jcontent-in-content, AL: jcontent-list, AC: jcontent-by-categorie (jnews), AS: jcontent-by-subcat, AT: jcontent-by-tags, CT: jcategories-by-tags, CM: jcontent-metadata
Si vous avez appelé ce tableau à partir de la démo d'une action, la colonne la concernant est sur fond jaune.
Option | A | AL | AC | AS | AT | CT | CM | Description |
---|---|---|---|---|---|---|---|---|
principale | ID(s) catégorie(s) séparé avec virgule, vide pour celui de l'article actuel ou 0 pour tout les IDs | |||||||
maxi | nombre maxi d'articles dans la liste. non précisé (par défaut) = tous | |||||||
exclude | 0 pour exclure l'article en cours | |||||||
current | toutes les catégories seront sélectionnées sauf celles indiquées dans l'option principale | |||||||
no-published | liste aussi les articles non publiés. Vrai par défaut | |||||||
content-plugin | prise en compte des plugins de contenu pour mots-clé content et intro. Peut échouer en cas d'appels récursifs | |||||||
sort-by | ordre de tri: title, ordering,created,modified,publish_up (par défaut),id,hits | |||||||
sort-order | ordre de tri : asc, desc (par défaut) | |||||||
author | filtre sur auteur: aucun (par défaut) OU id1,id2 OU article auteur de l'article en cours OU current utilisateur connecté. | |||||||
template | modèle de mise en page. Si vide le modèle est le contenu | |||||||
main-tag | balise pour le bloc englobant tous les articles. div par défaut, 0 pour aucun | |||||||
main-style | classes et styles inline pour bloc principal (inactif si main-tag=0) | |||||||
main-class | classe(s) pour bloc principal (inactif si main-tag=0) | |||||||
item-tag | balise pour le bloc d'un article. div par défaut, 0 pour aucun. | |||||||
item-style | classes et styles inline pour un article (inactif si art-tag=0) | |||||||
item-class | classe(s) pour un article (obsoléte) (inactif si art-tag=0) | |||||||
date-format | format pour les dates. '%e %B %Y' par défaut. (1) | |||||||
date-locale | localisation pour les dates au format 'fr_FR'. Celui du client par défaut. | |||||||
featured-html | code HTML pour article en vedette. Défaut: ⭐ ⭐ | |||||||
new-days | 30 par défaut. nombre de jours depuis sa création pour considérer un article comme nouveau | |||||||
new-html | Code HTML pour le badge NEW. nouveau par défaut | |||||||
image-src | image utilisée si aucune image n'est trouvée dans l'article. Défaut: '//lorempixel.com/300/300' | |||||||
image-alt | texte alternatif si aucune image n'est trouvé dans l'article | |||||||
tags-list-separator | séparateur entre les mots-cles | |||||||
tags-list-prefix | texte avant les autres clés éventuelles si tag {tag-list} | |||||||
tags-list-style | classe ou style pour les autres mots-clés | |||||||
no-content-html | texte si aucun contenu | |||||||
css-head | code CSS dans le head | |||||||
spécifique jcontent-list (ex article-category) | ||||||||
title | titre HTML si article trouvé. | |||||||
title-tag | niveau du titre | |||||||
title-style | classes et styles inline pour le titre | |||||||
title-class | classe(s) pour le titre | |||||||
list-style | classes et styles inline pour la liste | |||||||
list-class | classe(s) pour la liste | |||||||
class | idem main-class (conservé pour compatibilité descendante) | |||||||
style | idem main-style (conservé pour compatibilité descendante) | |||||||
spécifique jcontent-by-subcat | ||||||||
cat-level | 0 a 99 - niveau maxi des sous-categories explorées | |||||||
cat-tag | Balise pour les lignes catégories. LI pour passer en mode list arborescente | |||||||
cat-class | classes et styles inline pour les catégories | |||||||
cat-style | classes et styles inline pour les catégories | |||||||
cat-template | modèle pour les lignes de categories | |||||||
cat-root-view | affiche l'unique categorie racine. si root=jamais, si plusieurs=toujours | |||||||
cat-separator | pour separer l'arborescence des categories | |||||||
spécifique jcontent-metadata | ||||||||
meta-title-min | alerte coloré si le titre contient moins de lettres | |||||||
meta-title-max | alerte coloré si le titre contient plus de lettres | |||||||
meta-desc-min | alerte coloré si la description contient moins de lettres | |||||||
meta-desc-max | alerte coloré si la description contient plus de lettres |
(1) - Le format d'affichage est défini par l'option date-format. Sa valeur par défaut est : %e %B %Y qui affiche la date sous la forme 1 mai 2019.
Il s'agit de la codification PHP pour la fonction strftime. Les codes usuels sont %y année sur 2 chiffres, %Y année sur 4 chiffres, %m mois sur 2 chiffres, %b nom mois abrégé en 3 lettres, %B nom mois complet, %e jour (1-31), %d jour sur 2 chiffres (01-31), %A nom jour complet, %a nom jour abrégé, %H heure (00-23), %M minutes (00-59)
- Détails
La table ci-dessous est un comparatif des mots-clés utilisés par les différentes actions Jxxx.
A: jcontent-in-content, AL: jcontent-list, AC: jcontent-by-categorie (jnews), AS: jcontent-by-subcat, AT: jcontent-by-tags, CT: jcategories-by-tags, CM: jcontent-metadata
Si vous avez appelé ce tableau à partir de la démo d'une action, la colonne la concernant est sur fond jaune.
Mot-clé | A | AL | AC | AS | AT | CT | CM | Description |
---|---|---|---|---|---|---|---|---|
##id## | ID de l'article | |||||||
##title## | titre de l'article sans lien vers l'article | |||||||
##title-link## | titre de l'article avec lien vers l'article | |||||||
##subtitle## | sous-titre (partie du titre après le tilde) (1) | |||||||
##maintitle## | titre (partie du titre avant le tilde) (1) | |||||||
##link## | à utiliser comme argument de l'attribut href d'une balise a. | |||||||
##intro## | texte d'introduction de l'article au format HTML. (2) | |||||||
##intro-text## | texte d'introduction de l'article au format texte sans aucune balise HTML. (2) | |||||||
##intro-text,100## | variante qui permet de limiter le nombre de caractères affichés (100 dans cet exemple). (2) | |||||||
##content## | Le contenu si existant. (2) | |||||||
##image## | image d'introduction de l'article ou à défaut la première image trouvée dans le texte d'introduction. | |||||||
##image-link## | image avec lien vers l'article | |||||||
##image-src## | variante du mot-clé précédent qui permet un plus grand contrôle sur le résultat. (4) | |||||||
##image-alt## | idem | |||||||
##date-crea## | date de création (4) | |||||||
##date-modif## | date de modification (4) | |||||||
##date-publish## | date de publication de l'article (4) | |||||||
##date-publish-end## | date de fin de publication de l'article (4) | |||||||
##date-featured## | date de mise en vedette de l'article (4) | |||||||
##date-featured-end## | date de fin de mise en vedette de l'article (4) | |||||||
##author## | nom de l'auteur de l'article | |||||||
##note## | note sur l'article | |||||||
##cat## | nom de la catégorie | |||||||
##cat-link## | lien vers la catégorie | |||||||
##new## | badge nouveau si l'article est récent. Voir les options ‘new-jours’ et ‘new-html’ | |||||||
##featured## | si article en vedette | |||||||
##count## | nombre d'article dans la catégorie | |||||||
##hits## | le nombre de vues de l'article | |||||||
##tags-list## | liste des mots-clés | |||||||
##uplist## | liste des actions dans l'article | |||||||
##upnb## | nombre d'actions dans l'article | |||||||
##CF## | CustomField. Remplacer CF par son nom ou son ID. Voir modèle avec %label%, %value% et %rawvalue% | |||||||
##access## | niveau d'accès requis | |||||||
##meta-index## | index ou no-index | |||||||
##meta-follow## | index ou no-index | |||||||
##meta-title## | longueur de la meta title avec alerte colorée | |||||||
##meta-desc## | longueur de la meta description avec alerte colorée | |||||||
##meta-key## | liste des meta keywords | |||||||
spécifique jcontent-by-subcat | ||||||||
##catpath## | chemin des catégories parentes |
(1) - il s'agit d'une astuce que j'utilise pour décomposer le titre d'un article en titre et sous-titre en les séparant par le caractère tilde (~). En dehors de la possibilité de styler différemment les 2 parties, un titre plus long est meilleur pour le référencement.
Concrétement, si le tag {subtitle} est présent dans votre template et que le titre contient un tilde, il sera scindé en {titre] et {subtitle}. Dans le cas contraire, le {subtitle} sera vide et {title}: contiendra la totalité du titre de l'article.
(2) - A la différence de Joomla, si l'introtext n'existe pas, il n'est pas remplacé par le contenu. Et vice-versa. Si le besoin existe, on peut créer un mot-clé "article,X" qui insère les X premiers caractères en supprimant les shortcodes UP.
(3) - Exemple de template: <img src="/{image-src}" alt="{image-alt}" class="img-sepia left" width="100px">
.
⚠ si l'article ne contient pas d'image, le reste du code sera quand même inséré.
(4) - Le format d'affichage est défini par l'option date-format. Sa valeur par défaut est : %e %B %Y qui affiche la date sous la forme 1 mai 2019. Il s'agit de la codification PHP pour la fonction strftime. Les codes usuels sont %y année sur 2 chiffres, %Y année sur 4 chiffres, %m mois sur 2 chiffres, %b nom mois abrégé en 3 lettres, %B nom mois complet, %e jour (1-31), %d jour sur 2 chiffres (01-31), %A nom jour complet, %a nom jour abrégé, %H heure (00-23), %M minutes (00-59)
Si cela est impossible, remplacez l'accolade ouvrante par son code {
, soit pour id : {id}
.
Une autre méthode est de mettre en gras une partie : {<b>id</b>}
.
Si vous l'utilisez avec une action csv2table, pour éviter le conflit avec le séparateur point-virgule, changer le séparateur utilisé ou mettre le contenu de la cellule entre guillemets. "&#123;id}"
ou {<b>id</b>}
- Détails