UP-v5.0.2 : aide-mémoire rédacteur
Les shortcodes
UP permet de donner des instructions en mode code ou wysiwyg dans un article ou un module personnalisé à l'aide de shortcodes.
{up action=paramètre principal | option=valeur de l'option}
- un shortcode "ouvrant" commence toujours par ❴up (altGr+4 suivi du mot up)
- suivi d'un espace et du nom de l'action à réaliser : action
- si l'action attend un paramètre principal, on l'indique à la suite du signe égal
- il est possible d'indiquer plusieurs options en les séparant par le caractère pipe (altGr+6).
- il se termine toujours par une accolade fermante (altGr+=)
Certaines actions permettent de saisir un contenu de façon habituelle à la suite du shortcode. On indique la fin de ce contenu par un shortcode "fermant" où le mot up est précédé d'un antislash suivi du nom de l'action (identique à celui du shortcode ouvrant) :
{/up action commentaire_optionnel}
ils sont utilisés pour isoler les différentes parties du contenu situé entre le shortcode ouvrant et fermant. Cette méthode est plus visuelle et facilite la saisie dans un éditeur comme TinyMCE ou JCE Pour être reconnu, un séparateur doit commencer par une accolade suivie de 3 signes égal et se terminer par une accolade. Utilisés pour fournir des informations optionnelles, ils sont insérés entre les shortcodes ouvrant et fermant. Ils ne commencent pas par up. Voir la documentation des actions concernées. Il est possible de mettre le shortcode d'une action comme contenu ou comme argument pour l'option d'une autre action. Les actions sont évaluées en commençant par la fin de l'article et les plus inclus en premier. Les actions sont autonomes et indépendantes. Elles doivent renvoyer un contenu qui soit compatible avec l'action parente. Cela peut poser des problèmes lorsqu'une action enfant ajoute directement du code dans le head. Dans ce cas, utilisez l'option filter de l'action. Attention Il n'est pas possible de mettre des shortcodes comme argument d'une option dans le fichier prefs.ini L'action lang peut être utilisée sauf dans le fichier prefs.ini Pour saisir du code HTML compris par UP, mais ignoré des éditeurs. option=1 ou option (sans argument) sont considérées comme vraie, option=0 est considérée comme fausse. id : identifiant du bloc principal de l'action. UP le crée automatiquement, mais vous pouvez le forcer si vous avez besoin de le réutiliser pour une autre action (ex: addcsshead) ou pour nommer les cooies d'un module. ? : affiche un résumé des commandes l'action dans la langue de l'utilisateur ainsi que les prefset définis par le webmaster. debug : affiche la liste des options avec les valeurs actuelles. Celles par défaut et celles saisies dans le shortcode. En fin de message, vous trouverez la liste des prefsets définis pour votre site. prefset : permets d'appliquer un ensemble d'options par un nom explicite et facile à retenir. Un jeu d'options (prefset) peut aussi être appelé comme argument de l'option principale. style, class : propriétés CSS ou nom(s) de classe pour le bloc principal de l'action. UP accepte que l'on mélange des noms de classes et des propriétés CSS : class=color:red;bg-yellow est valide. Les accolades sont interdites à l'intérieur du shortcode. Pour indiquer la règle CSS xxx-style, xxx-class : propriétés CSS ou nom(s) de classe pour l'élément indiqué (ex: titre-class). xxx-style-*, xxx-class-* : style et class par défaut pour tous les éléments. exemple : css-head : ajoute des règles CSS dans le head de la page. exemple : filter : n'exécute pas l'action si une des conditions est fausse. exemple : Si vous ajoutez un point d'interrogation ou le mot debug comme option au shortcode, UP affichera de l'aide au début de la page sur le site. Le shortcode est visible sur la page générée. Action non trouvée le shortcode ne semble pas fonctionner message : contenu non trouvé les options ne sont pas prises en compte comportement bizarre UP ne reconnait pas cette option : =1
Le tiret et trait de soulignement ont la même signification.Les shortcodes séparateurs
{up filter | guest} vous êtes invité {===} vous êtes identifié {/up filter}
{up flexauto=2} bloc 1 {=== commentaire} bloc 2 {/up flexauto}
Il est permis d'ajouter un commentaire avant l'accolade fermante ❴====== commentaire❵Shortcodes internes ou secondaires
{up osmap=48.865, 2.30}
{marker=48.8709, 2.33223 | popup-text=... }
{/up osmap}
Shortcodes comme argument
{up table-par-lignes} ❹
{up csv2table | header=id;titre} ❸
{up jnews=8 ❷
| main-tag=0 | item-tag=0
| template=##id##;##title##
| new-html={up icon=etoile} ❶
}
{/up csv2table}
{/up table-par-lignes}
Traduction
option=lang[en=YES;fr=OUI]
permets de proposer des alternatives selon la langue du visiteur. Si sa langue n'est pas spécifiée, on utilise la première option.Format date
BBCode
Il faut remplacer les <>
par des crochets []
. Exemple : [b]gras[/b]
Pour insérer un crochet, il faut l'échapper avec un anti-slash \[
Seules les balises les plus courantes sont prises en charge :a|br|p|h3..6|div|span|b|i|u|img|small|sup|sub|quote|ul|ol|li|code|tt|kbd
Les options courantes
{up hr=param}
et {up hr | prefset=param}
produisent le même résultat.a[title]{color:red}
, on écrit a\[title\][color:red]
col-class-*=t-bleu
toutes les colonnes de la table en bleu. : col-class-6=t-rouge
la 6è colonne en rouge. 12 éléments maximum.css-head=body[background:pink] #id a[text-decoration:underline] \[class^="foo"\][color:red]
les accolades {} sont remplacées par des crochets []. #id, sera remplacé par l'identifiant de l'action. Pour saisir un crochet, échappez le avec un antislash.filter=motclé:condition;!motclé:condition;...
le point d'exclamation inverse le sens de la conditionAide et assistance
Les erreurs fréquentes