This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
local:tabbedquickform:userguide [2017/01/03 12:15] admin [Pour un administrateur] |
local:tabbedquickform:userguide [2023/01/31 16:46] (current) |
||
---|---|---|---|
Line 28: | Line 28: | ||
- Form mode switch button | - Form mode switch button | ||
- | === Masquage/Démasquage des champs === | + | === Masking / unmasking fields === |
- | 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. | + | 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. |
- | 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. | + | 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. |
- | 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. | + | Simplifying Moodle should be thus done carefully, and be experimented with a test population to check for side effects. |
{{ :local:tabbedquickform:local:tabbedquickform:config_mode_form_fr.jpg |}} | {{ :local:tabbedquickform:local:tabbedquickform:config_mode_form_fr.jpg |}} | ||
- | - Bouton de retour au mode normal | + | - Switch back to normal mode button |
- | - Commutateurs de masques | + | - Masking switchs |
- | === Peut on utiliser le mode configuration pour changer les valeurs par défaut des paramètres masqués ? === | + | === Do the configuration mode allow setting default values for hidden parameter? === |
- | Actuellement non. Les valeurs que vous modifiez dans un formulaire que vous configurez ont la même valeur que celles que vous rentreriez dans le mode d'usage normal. Elles valent pour l'action que vous êtes en train de faire (créer un cours, créer une activité, une cohorte etc.) | + | 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. |
- | === Comment je reconnais un formulaire qui peut être traité ? === | + | 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. |
- | En mode administrateur de site, par la présence du bouton "Configurer le formulaire" en haut à droite du formulaire. | + | === How do i know a form can be simplified? === |
- | === Pourquoi certains écrans avec des entrées de formulaires ne peuvent-ils pas être configurés ? === | + | When in administrator mode, you will see the "configure" green button at the right upper corner of the form. |
- | Parce que le développeur n'a pas utilisé la technologie QuickForm préconisée par Moodle pour les formulaires. Seuls les formulaires QuickForm peuvent être optimisés. | + | === Why can't some forms be simplified? === |
- | === Si je vois deux boutons de configuration sur une page ? === | + | 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. |
- | C'est qu'il y a deux formulaires indépendants posés sur la page. Les deux peuvent être dans la plupart des cas optimisés. Dans certains cas rares, des champs pourraient avoir le même nom dans la même page et une collision de clef pourrait se produire. Les deux champs se verraient alors maqués en même temps. | + | === What's up if i see two form configuration buttons on the same page? === |
- | === Si les boutons d'action du formulaire n'apparaissent que sur le dernier onglet ? === | + | 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. |
- | Il s'agit d'une construction particulière du formulaire par son développeur que nous n'avons pas encore examinée. Reportez nous si possible le signalement [[https://github.com/vfremaux/moodle-local_tabbedquickform/issues|sur Github]]. | + | === Using the config.php file to force a complete site setup === |
- | === Utiliser le fichier de configuration pour précaractériser une simplification === | + | 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. |
- | 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. | + | All you need to know is how the plugin setting key is build when recording a form mask: |
- | 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 : | + | $CFG->forced_plugin_settings = array('local_tabbedquickform' => array('<maskid>' => '<default1>', |
+ | '<secondmaskid>' => '<default2>'), | ||
- | $CFG->forced_plugin_settings = array('local_tabbedquickform' => array('<maskid>' => '1', | + | the settings mask key is: |
- | '<secondmaskid>' => '1'), | + | |
- | La clef de masque est composée comme suit : | + | * 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). | ||
- | * Le préfixe 'mask_' | + | Example: |
- | * 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 : | + | |
mask_page_course_edit_id_idnumber | mask_page_course_edit_id_idnumber | ||
- | [[:local:tabbedquickform|Revenir au sommaire du composant]] | + | [[:local:tabbedquickform|Return to plugin summary]] |