frendeitpt

Plugin bouton éditeur

Pour faciliter l'écriture des shortcodes, un plugin éditeur (editors-xtd) est disponible depuis la version 2.1 de UP.

Il doit être téléchargé et installé comme tous les plugins.

Il ajoute un bouton dans tous les éditeurs de Joomla!

UP bouton avec TinyMCE
Up bouton avec TinyMCE
UP bouton avec JCE et les autres éditeurs
Up bouton avec JCE et les autres éditeurs

Ce plugin bouton sert uniquement pour la création d'un shortcode. Les modifications sont à faire directement dans le shortcode.

Sélectionner une action

Upbtn list actions

Un clic sur le bouton, ouvre cette fenêtre popup.

La présentation standard (ci-contre) affiche la liste des options avec les options fréquemment utilisées au début.

Selon les choix du webmaster du site, les actions "top10" et le regroupement peuvent varier.

A l'ouverture, la zone active est la liste.
Cela permet de saisir les premières lettres d'une action pour la sélectionner

Action : infos et saisie des options

 

Upbtn tooltip num
  1. La sélection d'une action affiche ses informations au-dessous.
  2. Un lien permet d'ouvrir un nouvel onglet avec sa page de démo
  3. Une documentation succincte sur l'utilisation et les précautions
  4. Le webmaster du site peut également fournir des informations et conseils spécifiques à votre site
  5. La liste des options proposées par l'action.
    Sa présentation dépend de son type.
    Le survol de son libellé affiche une bulle avec des informations sur l'option.
    Le survol de la valeur affiche la valeur par défaut. Quand cela est possible, cette valeur est affichée en grisé dans le champ.
  6. Si du texte est sélectionné lors du clic sur le bouton, il est considéré comme le contenu de cette action. Il est possible de forcer la fermeture du shortcode en cochant cette case.
  7. Certaines actions utilisent des séparateurs pour les différentes parties du contenu. Indiquez ici leur nombre.
  8. Vous pouvez ajouter une option "debug" pour avoir un message avec les valeurs de l'action en frontend
  9. l'option "?" affiche une aide en frontend.
  10. Et enfin, le bouton pour insérer le shortcode dans votre article ou module personnalisé.

Les types d'options

Dans l'exemple ci-dessus, nous avons les différents types d'options

  • tooltip : l'option principale de l'action permet de saisir du texte, mais également de choisir un jeu d'options si votre webmaster en propose.
    Une liste avec saisie (combo) se reconnait grâce au petit triangle à droite.
    Cette option est sur fond jaune pour montrer son importance et la nécessité de fournir un argument.
  • position : une liste déroulante sans possibilité de saisie
  • width : saisie d'une valeur numérique entière. Il est possible d'indiquer une valeur minimale et maximale.
    notez la présence de l'unité entre parenthèses devant la zone. Il s'agit de l'unité par défaut de l'action. Elle n'est pas reprise dans le shortcode.
  • color : saisie d'une couleur au format #rrggbb. Pour utiliser un autre format, il faudra le modifier dans le shortcode
  • icon : il s'agit d'une liste contenant les fichiers d'un dossier. Utilisé pour choisir un style parmi plusieurs fichiers .css
  • open : un classique oui/non sous la forme d'une liste
  • id : sur fond gris pour indiquer la non-nécessité de saisie.
    Comme head-css, il est précédé d'une ligne pour créer des groupes visuels.

Note : un champ sur fond rouge pâle attire votre attention sur une particularité.

upbtn_makefile : action compagnon

Pour créer et mettre à jour les fichiers utilisés par le plugin upbtn, on utilise l'action upbtn_makefile

Son usage est indispensable si :

  • vous créer des jeux d'options
  • vous ajouter des modèles CSS
  • vous transmettez des conseils avec les fichiers custom/help.txt
  • vous modifiez la présentation de la liste d'action dans le plugin editor
  • vous créer des actions

Voir sa documentation

 

Doc rédacteur

logo UP

Ce plugin demande un tout petit peu de connaissance pour l'utiliser. Il n'y a pas une suite d'écran pour définir ses besoins.

Vous les exprimez dans un petit bout de code que l'on / je nomme shortcode. Vous verrez, c'est très rapide et surtout très souple.

164 Premiers pas
62 Composition des shortcodes
les règles générales pour donner des instructions à UP
128 Les options courantes
connaitre les options, présentes dans beaucoup d'actions, qui ont les mêmes noms et effets
55 Les erreurs fréquentes
c'est souvent des fautes de frappe ou d'inattention

L'essentiel

{up action=paramètre principal | option=valeur de l'option}
  • un shortcode 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 :

{/up action}

Si ce n'est pas déjà fait, demandez à votre webmaster qu'il prépare un mémento avec les actions principales (et leurs options) envisagées pour le site.
Outre le fait de faciliter la saisie, cela permet d'uniformiser le style de rendu entre les articles et rédacteurs.

Doc webmaster

logo UP

Vous êtes en charge d'installer le site et de lui donner son style.

UP est pensé pour vous simplifier le travail. Vous allez pouvoir définir les options par défaut, créer des jeux d'options, simplifiez la saisie de vos rédacteurs.

Je vous conseille de faire un petit mémento avec les actions et réglages courants pour votre site. 

 

185 Créer le dossier technique du site
Tous les sites ont besoin d'un dossier technique pour transmettre les informations et bonnes pratiques aux personnes impliquées. Même et surtout si l'on est seul !
59 Installation et mise à jour
La procédure pour installer UP sur votre site
153 Le fichier custom/prefs.ini
Toutes les infos sur la composition du fichier de préférence webmaster.
86 Personnaliser une action
tous les moyens pour adapter UP au style de votre site et faciliter le travail des rédacteurs
50 Gestion des traductions
maitriser les langues avec UP

Doc développeur

logo UP

Ce plugin permet d'ajouter rapidement une fonctionnalité à Joomla!

La majeure partie de création d'un plugin est déjà prise en charge par UP.
Vous avez juste à vous concentrer sur la fonctionnalité.

Il est toutefois nécessaire de savoir qui fait quoi et comment.

J'espère que cette documentation vous aidera à vous lancer.

188 Utiliser la feuille de style UP
informations sur l'utilisation de la feuille de style UP dans les actions
186 Les fonctions d'aide (upAction.php)
UP met à disposition des méthodes pour faciliter la programmation des actions
173 Prefset : les jeux d'options
Comment programmer les jeux d'options
37 Les règles
Les règles à respecter pour programmer une action
46 Créer une action
Les grands principes et les règles à respecter
67 Organisation des fichiers de UP
Comment s'y retrouver dans les 1000 fichiers et 350 dossiers de UP
63 Site de démonstration des actions
comment faire le lien entre votre action et le site de démonstration

Documentation

En dehors de la démonstration des actions, la documentation générale est classée par type d'intervenant.

  • le rédacteur est la personne en charge d'ajouter du contenu.
  • le webmaster conçoit le site et veille à son intégrité et bon fonctionnement. Il personnalise UP pour l'adapter au style qu'il a définit.
  • le programmeur, ajoute des actions à UP.

Pour tous, les sections CSS et références servent d'aide-mémoire pour utiliser UP, mais pas que !

Les intervenants

Rédacteur

164 Premiers pas
62 Composition des shortcodes
les règles générales pour donner des instructions à UP
128 Les options courantes
connaitre les options, présentes dans beaucoup d'actions, qui ont les mêmes noms et effets
55 Les erreurs fréquentes
c'est souvent des fautes de frappe ou d'inattention

Webmaster

185 Créer le dossier technique du site
Tous les sites ont besoin d'un dossier technique pour transmettre les informations et bonnes pratiques aux personnes impliquées. Même et surtout si l'on est seul !
59 Installation et mise à jour
La procédure pour installer UP sur votre site
153 Le fichier custom/prefs.ini
Toutes les infos sur la composition du fichier de préférence webmaster.
86 Personnaliser une action
tous les moyens pour adapter UP au style de votre site et faciliter le travail des rédacteurs
50 Gestion des traductions
maitriser les langues avec UP

Programmeur

188 Utiliser la feuille de style UP
informations sur l'utilisation de la feuille de style UP dans les actions
186 Les fonctions d'aide (upAction.php)
UP met à disposition des méthodes pour faciliter la programmation des actions
173 Prefset : les jeux d'options
Comment programmer les jeux d'options
37 Les règles
Les règles à respecter pour programmer une action
46 Créer une action
Les grands principes et les règles à respecter
67 Organisation des fichiers de UP
Comment s'y retrouver dans les 1000 fichiers et 350 dossiers de UP
63 Site de démonstration des actions
comment faire le lien entre votre action et le site de démonstration

Aide-mémoire

CSS de UP

187 CSS - Table
mise en forme d'un tableau
8 CSS - la feuille de style interne
une synthèse de toutes les classes de UP sur une seule page !
13 CSS - width, height, margin, padding
gérer les largeurs, hauteurs, marges et paddings
9 CSS - Color & border
mettre en couleur le texte, les fonds, les bordures et ajouter des ombrages
14 CSS - Position
gestion du positionnement des blocs autrement que par flexbox et table-cell
10 CSS - Flexbox
pour maitriser la puissance de flexbox
12 CSS - Cell
alignement de plusieurs cellules de même hauteur avec le mode table-cell
18 CSS - Modal
ouvrir une fenêtre modale dans un article
16 CSS - typo
les classes qui agissent sur le texte
11 CSS - Images
des classes pour gérer et enrichir les images
17 CSS - Box
des pavés pour mettre en évidence du contenu

Polices d'icône

93 Icônes Font-Awesome
92 Icônes Icomoon

Caractères Unicode

🎯le Top 100

Mémentos

Cette section regroupe des informations générales bien pratique pour l'utilisation de UP.

Polices d'icône

93 Icônes Font-Awesome
92 Icônes Icomoon

Caractères Unicode

🎯le Top 100