Organisation des fichiers de UP

Cet article sert à définir l'organisation des dossiers de UP et spécifier le rôle des fichiers principaux.

Les fichiers en vert sont les fichiers préservés lors des mises à jours.
Les dossiers sont sur fond jaune.

  • up.php : script principal du plugin
  • upAction : classe parente pour les actions
  • up.xml : manifeste pour l'installation
  • up_install.php : script pour préserver les fichiers de configuration lors des mises à jour
  • dico.ini : définition des équivalences des termes utilisés pour construire dico.json. Vous pouvez ajouter vos équivalences à ce fichier, il est préservé lors des mises à jour.
  • dico.json : fichier des équivalences des termes.
    Il est construit par UP lors de l'affichage de la documentation par {up upactionslist | make-dico}.
    Ne jamais modifier directement ce fichier
  •  actions  :
    •  _example_full_options  : dossier d'une action modèle avec toutes les options. Une action dont le nom commence par un underscore n'est pas affichée dans la liste des actions, mais est exécutable (si besoin)
      • _example_full_options.php : script de l'action
      • xxx.js, xxx.css, xxx.scss, ... : les ressources pour le script de l'action.
        Selon vos préférences, elles peuvent être dans des sous-dossiers. La seule contrainte est que les fichiers SCSS et CSS soit dans le même sous-dossier pour être pris en compte lors de la génération des CSS.
      • index.html : protection contre accès direct
      • custom : dossier des personnalisations. Le contenu de ce fichier n'est jamais modifié.
        • prefs.ini.dist : fichier modèle pour créer votre fichier prefs.ini
        • prefs.ini : le fichier contenant vos préférences
        • info.ini.dist, info.txt.dist : fichier modèle pour créer vos fichiers d'informations utilisées par le script
        • info.ini, info.txt : le fichier contenant vos informations
        • xxx.js, xxx.css, xxx.scss, ... : les versions spécifiques au site des fichiers de l'action. Si un fichier appelé par l'action figure aussi dans ce sous-dossier, c'est lui qui sera chargé.
      •  up  : dossier des fichiers pour usage interne de UP
        • dico.ini : équivalences des termes pour l'action. Ils seront ajoutés au fichier principal dico.json
        • en-GB.ini : traductions de la documentation et des messages affichés par l'action. voir Gestion des traductions
        • xx-XX : idem en-GB dans une autre langue
        • index.html : protection contre accès direct
    •  les autres actions  : ...
  •  assets  : ressources pour le script principal de UP
    •  img  : images pour la feuille de style principale
    •  js  : scripts javascript/jquery partagés par plusieurs actions
    •  scss  : partiels SCSS importés par up.scss
    • _variables.scss : utiliser ce fichier pour définir vos préférences couleurs et espacements qui seront utilisées par up.scss
    • up.scss : fichier principal pour la génération de la feuille de style up.css
    • up.css : feuille de style du plugin
    • index.html : protection contre accès direct
  •  language  : fichiers pour la traduction des messages du script principal de UP et lors de l'installation (méthode Joomla!)
    •  fr-FR  : traductions françaises
      • fr-FR.plg_content_up.ini : traduction des messages
      • fr-FR.plg_content_up.sys.ini : message lors de l'installation
      • index.html : protection contre accès direct
    •  xx-XX  : traductions autre langue

 

D'autres infos

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
63 Site de démonstration des actions
comment faire le lien entre votre action et le site de démonstration