Différences

Ci-dessous, les différences entre deux révisions de la page.

--- local:tabbedquickform:userguide [2016/08/05 19:18] – créée admin
+++ local:tabbedquickform:userguide [2025/12/10 16:16] (Version actuelle) – modification externe 127.0.0.1
@@ Ligne 1: / Ligne 1: @@
-===== Guide d'utilisation =====
+===== User guide =====
-Le composant "Formulaires à onglet" tranforme radicalement l'usage de Moodle en :
+The TabbedQuickform plugin transforms radically moodle by:
-   * Affichant des formulaires plus clairs et plus pratiques
+   * Displaying more compact screens for forms, avoiding scrolls and long forms when deployed.
-   * Permettant d'opérer une simplification massive des fonctionnalités de Moodle en général, par un fitlrage ajouté sur les formulaires.
+   * Allowing cleaning all forms from unused or unexploited options.
-==== Pour l'usager non administrateur ====
+==== For the non admin users ====
-L'utilisation de ce composant est quasiment naturelle pour l'usager non administrateur. Il se résume éventuellement (si la capacité de contrôle ne lui est pas retirée), à pouvoir basculer entre le mode "complet" où il retrouve toutes les fonctions et options originales de Moodle, et le mode simplifié.
+Using this plugin is almost transparent for those users. Users will be proposed the forms in a similar view/controller model as before. Forms are just more compact and have tab switchable panels.
-==== Pour un administrateur ====
+If users are allowed to, users might have an additional "switch" button on top of each form allowing to globally switch between "simplified" or "complete" mode.
-Les administrateurs de site ont une tâche un peu plus complexe qui celle de choisir le filtrage qui sera apporté dans les différents formulaires de Moodle pour proposer un usage plus simple de la plate-forme. Il est fortement conseillé que cet "élagage" :
+==== For an administrator ====
-   * Soit réalisé de manière concertée avec les usagers
+Administrators will have more implication in the process as they will drive the simplification effort of Moodle. Administrators can run across the whole platform and choose to mask and setup some relevant defaults for most of the form items. This cleanup should in any case:
-   * Soit précédé d'une enquête d'usage permettant de répertorié les usages réellement non exploités
-   * Soit éventuellement précédé d'un audit des données permettant de constater le non usage des fonctionnalités par la population utilisatrice.
-=== Basculement en mode "Configuration" ===
+   * Be performed by admins unilaterally before the users come in.
+   * Be performed bilaterally with users representants after users started to use the platform.
+   * Eventually follow a survey that will examine what users really will not use.
+   * Or eventually following a data inquiry to check tracks of disinterest.
-=== Masquage/Démasquage des champs ===
+=== Switching on forms configuration mode ===
-Le masquage démasquage des champs doit être réalisé avec précaution. Certains champs peuvent être liés à d'autres entrées et leur indisponibilité pourrait provoquer des situations non solubles pour l'utilisateur destinataire.
+{{ :local:tabbedquickform:local:tabbedquickform:normal_mode_form_for_admins_fr.jpg |}}
-En général, il est conseillé de bien étudier une fonctionnalité et de repérer l'ensemble des paramètres qui s'y réfèrent afin de les masquer tous. Attention que certains paramètres peuvent également être liés à des fonctions qui transparaissent dans d'autres composants et donc d'autres formulaires.
+   - Form configuration mode switch button
+   - Form mode switch button
-Les hypothèses de simplification doivent donc être étudiées avec soin, faire l'objet d'expérimentation sur les effets produits et d'une validation.
+=== Masking / unmasking fields ===
-=== Utiliser le fichier de configuration pour précaractériser une simplification ===
+Once in form configuration mode, you can mask or unmask fields using the mask icon. This is to be done with precaution. Some fileds may be linked to other features in Moodle and making them unreachable might put the end user in uncomfortable situation.
-Le système de filtrage étant intégré comme un plufin, les décisions de masquage prises par les administrateurs ont été implémentées comme des clefs de configuration du plugin local_tabbedquickform. De ce fait la règle qui permet une configuration forcée par le fichier de configuration config.php à la racine de Moodle s'applique.
+Usually, it will be preferable to carefully study a feature and check all the parameters and variables that may affect it so we may mask them all. Note that sometime, some parameters may affect other features or settings that are in other components and forms.
-Il suffit alors de connaître la matrice qui génère les clefs de configuration lorsqu'un champ est masqué pour pouvoir écrire un ensemble de pré-configurations du type :
+Simplifying Moodle should be thus done carefully, and be experimented with a test population to check for side effects.
-    $CFG->forced_plugin_settings = array('local_tabbedquickform'  => array('<maskid>' => '1',
+{{ :local:tabbedquickform:local:tabbedquickform:config_mode_form_fr.jpg |}}
-                             '<secondmaskid>' => '1'),
-La clef de masque est composée comme suit :
+   - Switch back to normal mode button
+   - Masking switchs
-   * Le préfixe 'mask_'
+=== Do the configuration mode allow setting default values for hidden parameter? ===
-   * L'ID de page Moodle transformé (ex : site_login_index pour le type site-login-index)
-   * Un séparateur '_'
-   * L'identifiant d'élément ou groupe d'élément de formulaire (tel qu'il peut être relevé sur un élément "fitem" dans le HTML d'une page).
-Exemple :
+Yes, for most of them. Most of the simplest widgets such as text, checkboxes, radios and select will store the actual value in the masking preferences. This will override system defaults even if the feature implements explicit defaults in settings. Complex widgets such as multiple fields or complex groups or conditional fields may be not correctly preset by defaults.
+To store a preset default value while in form configuration mode, just change the current value BEFORE hidding the field. The default will be stored at the moment the mask button is switched on.
+=== How do i know a form can be simplified? ===
+When in administrator mode, you will see the "configure" green button at the right upper corner of the form.
+=== Why can't some forms be simplified? ===
+This plugin only can process QuickForm forms, which is the actual common development standard for building Moodle forms. In spite of this common practices, and due to some restrictions in layout or complexity of implementation, some developers have build hard coded HTML forms that cannot be handled by this technique.
+=== What's up if i see two form configuration buttons on the same page? ===
+this can happen if two or more QuickForm instances are displayed on the same screen. In most cases, all forms may be simplified. In some rare cases, form fields might share the same identifier and a key collision might happen. In that case would both fields be masked at the same time.
+=== Using the config.php file to force a complete site setup ===
+The form filtering system is built as a moodle local plugin. All activated masks are stored as configuration keys of the local_tabbedquickform plugin. Thus the general rules allowing forcing plugin settings values in config.php applies.
+All you need to know is how the plugin setting key is build when recording a form mask:
+    $CFG->forced_plugin_settings = array('local_tabbedquickform'  => array('<maskid>' => '<default1>',
+                             '<secondmaskid>' => '<default2>'),
+the settings mask key is:
+   * the 'mask_' prefix
+   * the current page ID with some transform (e.g.: site_login_index for page type site-login-index)
+   * a separator '_'
+   * The quickformform element identifier (the accessible ID of the "fitem" in HTML output).
+Example:
 mask_page_course_edit_id_idnumber
+[[:local:tabbedquickform|Return to plugin summary]]