This shows you the differences between two versions of the page.
Next revision | Previous revision | ||
local:tabbedquickform:installguide [2016/08/05 20:31] admin |
local:tabbedquickform:installguide [2023/01/31 16:46] (current) |
||
---|---|---|---|
Line 1: | Line 1: | ||
- | ===== Guide d'installation ===== | + | ===== Install Guide ===== |
- | ===== Formulaires tabulés et filtrés ===== | + | ===== Tabbed and filtered QuickForms ===== |
- | === Installer le composant ==== | + | === Install the plugin ==== |
- | Ce composant s'installe en deux temps : | + | Two steps install: |
- | * Le premier est une installation standard d'un composant local : | + | * First install the plugin as usual as a local plugin: |
- | * Dézippez l'archive dans le répertoire /local de votre installation | + | * Unzip archive into the /local directory of your moodle |
- | * Naviguez vers les Notifications du menu Administration de Site pour terminer l'installation | + | * Browse to the Site Administration / Notifications to finish the install. |
- | * Dans un deuxième temps, vous devez modifier le fichier lib/formslib.php pour y remplacer le moteur de rendu des formulaires : | + | * Then you need add the essential unique patch into the file lib/formslib.php. This will replace the standard form renderer. |
- | A la fin de ce script est initialisé le moteur de rendu standard : | + | You'll find patch and core reference into respectively the __patch and __reference metadirs of the plugin. Reference file is given to facilitate automatic patch detection and integration into automated assembling procedures. Check the patch marked by "// PATCH+" and "// PATCH-" and report into the corresponding location. |
- | /** | + | This change will affect ALL QuickForms in the whole Moodle. See next chapter to see how to exclude some local forms from the change. |
- | * @global object $GLOBALS['_HTML_QuickForm_default_renderer'] | + | |
- | * @name $_HTML_QuickForm_default_renderer | + | |
- | */ | + | |
- | $GLOBALS['_HTML_QuickForm_default_renderer'] = new MoodleQuickForm_Renderer(); | + | |
- | Cette définition doit être complétée comme ceci : | + | ==== Configure ==== |
- | /** | + | Four settings need attention for configuring the TabbedQuickform plugin. Browse to: |
- | * @global object $GLOBALS['_HTML_QuickForm_default_renderer'] | + | |
- | * @name $_HTML_QuickForm_default_renderer | + | |
- | */ | + | |
- | $GLOBALS['_HTML_QuickForm_default_renderer'] = new MoodleQuickForm_Renderer(); | + | |
- | // PATCH : Overloads quickform renderer | + | |
- | $config = get_config('local_tabbedquickform'); | + | |
- | if (!empty($config->enable) && is_dir($CFG->dirroot.'/local/tabbedquickform')) { | + | |
- | $GLOBALS['_HTML_QuickForm_default_renderer'] = new MoodleQuickForm_Tabbed_Renderer(); | + | |
- | } | + | |
- | // /PATCH | + | |
- | Cette modification affectera TOUS les formulaires de Moodle à partir du moment où elle est activée dans la configuration générale. | + | Site Administration > Plugins > Local plugins > Tabbed quickforms |
- | ==== Configurer la fonctionnalité ==== | + | {{ :local:tabbedquickform:settings_en.jpg |}} |
- | La configuration générale de ce composant ne propose que deux options. Vous l'atteindrez par le menu : | + | === Enabling tabs renderer === |
- | Administration de site > Plugins > Plugins Locaux > formulaires à onglets | + | By enabling the renderer, you will replace the standard collapsible sections with the new tabs renderer. This renderer also provides the global form filtering feature. |
- | {{ :local:tabbedquickform:local:tabbedquickform:settings_fr.jpg |}} | + | === Enabling masking mandatory fields === |
- | === Activation du moteur de rendu tabulaire === | + | This is NOT enabled by default, as this might have severe consequences on behaviour if admins mask fields inadequately, or recording inappropriate default values. |
- | En activant le moteur, vous remplacerez l'ancien moteur de rendu de formulaire en sections rabattables par le moteur à onglets disposant en plus de la capacité de filtrage fonctionnel. | + | === Default mode forms === |
- | === Mode par défaut des formulaires === | + | As a default (apart any explicit choice in user's preferences), the initial presentation mode for forms can be: |
- | Par défaut (sans enregistrement de quoi que ce soit dans les préférences utilisateur), le mode des formulaires peut être : | + | * **Filtered (simplified):** Any masked field will not appear in the form. |
+ | * **Complete:** All usual moodle form fields are visible. | ||
- | * **Filtré :** Les champs qui ont été masqués par l'administrateur n'apparaitront plus. | + | Users may be allowed to choose the form mode by themselves in their own profile. |
- | * **Complet :** Tous les champs d'origine des formulaires apparaissent | + | |
- | [[:local:tabbedquickform|Revenir à l'index du composant]] | + | [[:local:tabbedquickform|Return to the plugin index]] |