frendeitpt

UP - liste des fichiers

  • 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
  • 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
  • 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é