Auteur(s) favdb
CC-BY-SA
réalisé avec oStorybook 5.05.08 (dev)
Guide d'utilisation de l'assistant pour oStorybook.
L'assistant qu'est-ce c'est? C'est un module, que vous pouvez adapter à vos propres besoins, permettant de décrire dans le détail des éléments:
Le formulaire proposé suppose que le renseignement des différentes rubriques est facultatif. Par ailleurs l'utilisation de l'Assistant est elle même facultative.
Vous devez définir le fichier de paramétrage à utiliser. Dans Èditer>Préférences onglet "Assistant". La première option est le choix du type de fichier à utiliser. Il peut être:
Le fichier interne est intégré dans le logiciel. L'équipe de développement procède à son intégration, vous ne pouvez donc pas le modifier.
Le fichier installé est similaire au fichier interne. La différence réside dans le fait qu'il est installé dans le dossier du logiciel. Par exemple, sous Linux, vous le trouverez dans le dossier "/usr/share/ostorybook/Assistant/AssistantXXX.xml" où XXX est l'extension "langage" ("_fr" pour le français). Ce fichier pourra être modifié mais sera réinitialisé lors de l'installation d'une nouvelle version de oStorybook.
Le fichier externe en revanche reste votre propriété et ne sera jamais modifié par une installation d'une nouvelle version de oStorybook.
Le formulaire de l'assistant présente 4 types d'information:
Ces informations, lorsqu'elles sont nombreuses, sont regroupées dans des onglets, voir à titre d'exemple l'assistant Personnage ci-après:
(assistant personnage, remarque ici l'assistant est encore en anglais)
L'action sur le bouton "Assistant", lorsqu'il est présent, affiche le formulaire correspondant qu'il convient de renseigner.
Après validation, les informations retenues seront présentées dans l'onglet "Assistant" sous la forme synthétisée suivante:
(exemple de l'assistant personnage dans l'éditeur)
Lorsque la zone Assistant est renseignée il est possible de l'effacer complètement ou d'en transférer le contenu dans la "Description" ou les "Notes".
Jusqu'à la version 557, incluse, la description des formulaires est enregistrée dans un fichier "properties" (similaire aux fichiers "ini" bien connus sous Windows).
À partir de la version 558 la description des formulaires est enregistrée dans un fichier de type XML. Vous pouvez donc définir votre propre fichier Assistant, ou le traduire dans une autre langue, en utilisant n'importe quel éditeur de texte à condition qu'il vous propose le format XML avec une codification des caractères UTF8.
Toutefois ce sera beaucoup plus pratique d'utiliser l'outil dédié qui a été développé à cette fin.
Le logiciel dédié à la personnalisation de l'Assistant se nomme "Assistant.jar", sans aucune originalité. Il se présente comme tout autre logiciel avec une barre de menu et un contenu de départ représentant l'assistant interne, celui évoqué au chapitre 2.
Ce qui distingue ce contenu de ce que vous obtenez dans oStorybook c'est:
Mais commençons par le menu qui comporte 3 éléments:
En premier lieu il est recommandé d'enregistrer le fichier par défaut dans un fichier personnel. Supposons que dans vos dossiers personnels vous ayez déjà un dossier "Écriture". Vous pourrez donc y enregistrer votre fichier via "Fichier>Enregistrer sous". Si vous ne mettez pas l'extension ".xml" elle sera automatiquement ajoutée.
Ensuite vous pourrez procéder à vos ajustements puis les sauvegarder à nouveau dans ce même fichier, que vous pourrez ouvrir lors d'une session ultérieure.
Chaque élément du questionnaire, onglet ou rubrique, est caractérisé par 3 informations de base:
exemple de l'ajout d'un onglet
Pour une rubrique s'ajoute la nature de celle-ci (textfield, textarea, combobox, listbox). Si la rubrique est du type "textfield" vous pourrez indiquer la dimension de la zone de saisie, en nombre de caractères. Si la rubrique est du type "combobox" ou "listbox" vous disposerez d'un tableau pour identifier chacune des options possibles avec un titre et une aide.
exemple de l'ajout d'une rubrique de type "textfield" avec une dimension
exemple de la modification d'une rubrique de type "combobox" avec un tableau
À noter: lorsqu'on modifie une rubrique il n'est pas possible de changer son nom et son type, qui apparaîtront grisés, comme dans l'exemple ci-dessus.
La qualité de l'Assistant dépend fortement du contenu décrit dans le fichier de paramétrage du questionnaire. Le fichier d'origine fourni par l'équipe de développement peut ne pas répondre à vos besoins, n'hésitez pas à l'adapter. Si vous obtenez quelque chose de beaucoup plus complet à vos yeux, votre expérience pourrait intéresser d'autres utilisateurs, partagez là sur le forum, et, qui sait, l'équipe pourrait décider d'intégrer vos suggestions dans la version officielle de oStorybook.