Scarab commit: svn commit: r10206 - trunk/www/book
[email protected] 14 Jul 2006 17:33:12 -0000
Newsgroups
gmane.comp.java.scarab.cvs
Message-ID
<[email protected] >
Author: jfelfouly
Date: 2006-07-14 10:33:12-0700
New Revision: 10206
Modified:
trunk/www/book/modules-en.xml
trunk/www/book/modules-fr.xml
Log:
A first attempt at User's Guide chapter 7 (Creating and managing modules).
Modified: trunk/www/book/modules-en.xml
Url: http://scarab.tigris.org/source/browse/scarab/trunk/www/book/modules-en.xml?view=diff&rev=10206&p1=trunk/www/book/modules-en.xml&p2=trunk/www/book/modules-en.xml&r1=10205&r2=10206
==============================================================================
--- trunk/www/book/modules-en.xml (original)
+++ trunk/www/book/modules-en.xml 2006-07-14 10:33:12-0700
@@ -1,5 +1,52 @@
<!-- $Id -->
<chapter>
<title>Creating and managing modules</title>
- <simpara>[This chapter is being written.]</simpara>
+ <sect1>
+ <title>Creating a new module</title>
+ <simpara>From the home page, choose any module, if you have not done that already (creation of a new module cannot occur outside a context, but that is irrelevant with the task we want to perform).</simpara>
+ <screenshot>
+ <graphic fileref="images/module-creation0.png"/>
+ </screenshot>
+ <simpara>From a module home page, or from many other pages, you can reach the module administration functions, but you may need to double-click in the left margin to make the menu appear.</simpara>
+ <screenshot>
+ <graphic fileref="images/module-creation1a.png"/>
+ </screenshot>
+ <screenshot>
+ <graphic fileref="images/module-creation1b.png"/>
+ </screenshot>
+ <simpara>From there, choose Modules, Manage modules and push the Create new button.</simpara>
+ <screenshot>
+ <graphic fileref="images/module-creation2.png"/>
+ </screenshot>
+ <simpara>You may now enter the information about the module that you want to create.</simpara>
+ <screenshot>
+ <graphic fileref="images/module-creation3.png"/>
+ </screenshot>
+ <simpara>Two fields are worth a particular attention.</simpara>
+ <simpara>
+ The <emphasis>Parent module</emphasis> determines at this time the module which will be used as a template, a model, for the module you are about to create.
+ Basically this means that the new module will "inherit" all Issue types and attributes from the parent module you choose.</simpara>
+ <caution>
+ <simpara>This "inheritance" occurs once and for all at the time of module creation. Issue types and attributes are copied from the parent to the new modules.</simpara>
+ <simpara>Modifications to the issue types and attributes of the parent module you choose now <emphasis>will not be propagated</emphasis> to the new module afterwards.</simpara>
+ <simpara>To say it yet another way, issue types and attributes are copied from the parent to the new module, not shared between them.</simpara>
+ </caution>
+ <simpara>The module parent will also appear in the modules lists. For instance, the <emphasis>Source</emphasis> module which has <emphasis>Pacman JVM</emphasis> as parent appears as such in the list:</simpara>
+ <screenshot>
+ <graphic fileref="images/module-creation3.png"/>
+ </screenshot>
+ <simpara>You can change the parent later (see next Section) if you want to change the display logic but that should not be the main reason of your parent module choice at creation time.</simpara>
+ </sect1>
+ <sect1>
+ <title>Editing a module</title>
+ <simpara>To edit the definition and properties of a module, choose <emphasis>Manage modules</emphasis> in the <emphasis>Admin</emphasis> menu, then choose the module.</simpara>
+ <simpara>The next screen is pretty self-explanatory.</simpara>
+ <screenshot>
+ <graphic fileref="images/module-edition1.png"/>
+ </screenshot>
+ <simpara>You cannot delete a module but you can mark it as deleted. The module will no longer appear in the modules lists (though it will still appear, as deleted, in the <emphasis>Manage modules</emphasis> list if you ever want to recall it someday later).</simpara>
+ <screenshot>
+ <graphic fileref="images/module-edition2.png"/>
+ </screenshot>
+ </sect1>
</chapter>
Modified: trunk/www/book/modules-fr.xml
Url: http://scarab.tigris.org/source/browse/scarab/trunk/www/book/modules-fr.xml?view=diff&rev=10206&p1=trunk/www/book/modules-fr.xml&p2=trunk/www/book/modules-fr.xml&r1=10205&r2=10206
==============================================================================
--- trunk/www/book/modules-fr.xml (original)
+++ trunk/www/book/modules-fr.xml 2006-07-14 10:33:12-0700
@@ -1,5 +1,52 @@
<!-- $Id -->
<chapter>
<title>Créer et gérer des modules</title>
- <simpara>[Ce chapitre est à écrire.]</simpara>
+ <sect1>
+ <title>Créer un nouveau module</title>
+ <simpara>À partir de la page d'accueil, sélectionnez un module si ce n'est déjà fait (la création d'un module ne peut se faire en dehors de tout contexte, mais c'est sans importance pour la tâche considérée).</simpara>
+ <screenshot>
+ <graphic fileref="images/module-creation0.fr.png"/>
+ </screenshot>
+ <simpara>Depuis la page d'accueil d'un module, ou à partir de la plupart des autres pages d'ailleurs, vous pouvez accéder aux fonctionnalités d'administration des modules mais il vous faudra peut-être double cliquer dans la marge de gauche pour faire apparaître le menu correspondant.</simpara>
+ <screenshot>
+ <graphic fileref="images/module-creation1a.fr.png"/>
+ </screenshot>
+ <screenshot>
+ <graphic fileref="images/module-creation1b.fr.png"/>
+ </screenshot>
+ <simpara>Là , choisissez Modules, Gérer les modules et cliquez le bouton Créer nouveau.</simpara>
+ <screenshot>
+ <graphic fileref="images/module-creation2.fr.png"/>
+ </screenshot>
+ <simpara>Vous pouvez maintenant entrer les informations relatives au module que vous voulez créer.</simpara>
+ <screenshot>
+ <graphic fileref="images/module-creation3.fr.png"/>
+ </screenshot>
+ <simpara>Deux champs méritent une attention particulière à ce stade.</simpara>
+ <simpara>
+ Le champ <emphasis>Module parent</emphasis> détermine le module qui sera utilisé comme gabarit, comme modèle, pour le module que vous vous apprêtez à créer.
+ Cela veut dire que le nouveau module "héritera" de tous les types de fiches et attributs du module parent que vous choisissez.</simpara>
+ <caution>
+ <simpara>Cet "héritage" a donc lieu une fois pour toutes à la création du module. Les types de fiches et les attributs sont copiés du parent au nouveau module.</simpara>
+ <simpara>Les modifications ultérieures des types de fiches et attributs du module parent que vous choisissez maintenant <emphasis>ne seront pas propagées</emphasis> au module que vous créez.</simpara>
+ <simpara>Ou pour le dire encore d'une autre manière, les types de fiches et attributs sont copiés du module parent au nouveau module, ils ne sont pas partagés entre eux.</simpara>
+ </caution>
+ <simpara>Le module parent apparaît aussi dans les listes de modules. Par exemple, le module <emphasis>Source</emphasis> qui a <emphasis>Pacman JVM</emphasis> comme parent apparaît ainsi dans la liste :</simpara>
+ <screenshot>
+ <graphic fileref="images/module-creation3.fr.png"/>
+ </screenshot>
+ <simpara>Vous pouvez changer le parent dans un second temps (voir la section suivante) si vous voulez changer la logique de présentation des modules mais ce critère ne doit pas déterminer votre choix au moment de la création du module.</simpara>
+ </sect1>
+ <sect1>
+ <title>Éditer un module</title>
+ <simpara>Pour modifier la définition et les propriétés d'un module, cliquez <emphasis>Gérer les modules</emphasis> dans le menu <emphasis>Admin</emphasis>, puis cliquez le module.</simpara>
+ <simpara>L'écran suivant ne nécessite pas grande explication.</simpara>
+ <screenshot>
+ <graphic fileref="images/module-edition1.fr.png"/>
+ </screenshot>
+ <simpara>Vous ne pouvez pas supprimer complètement un module mais vous pouvez le marquer comme détruit (et donc le faire disparaître des opérations courantes). Le module n'apparaîtra plus dans les listes de modules (mais il apparaîtra encore, barré, dans la liste de l'écran <emphasis>Gérer les modules</emphasis> au cas où vous voudriez le réactiver un jour).</simpara>
+ <screenshot>
+ <graphic fileref="images/module-edition2.fr.png"/>
+ </screenshot>
+ </sect1>
</chapter>