Scarab commit: svn commit: r10455 - trunk/www/book
[email protected] 13 Jul 2007 09:18:29 -0000
Newsgroups
gmane.comp.java.scarab.cvs
Message-ID
<[email protected] >
Author: jfelfouly
Date: 2007-07-13 02:18:29-0700
New Revision: 10455
Modified:
trunk/www/book/queries-en.xml
trunk/www/book/queries-fr.xml
Log:
Add a short, illustrated tutorial on using and defining queries.
Modified: trunk/www/book/queries-en.xml
Url: http://scarab.tigris.org/source/browse/scarab/trunk/www/book/queries-en.xml?view=diff&rev=10455&p1=trunk/www/book/queries-en.xml&p2=trunk/www/book/queries-en.xml&r1=10454&r2=10455
==============================================================================
--- trunk/www/book/queries-en.xml (original)
+++ trunk/www/book/queries-en.xml 2007-07-13 02:18:29-0700
@@ -1,7 +1,7 @@
<!-- $Id -->
<chapter>
<!-- Source: UserQuery section in the online help -->
- <title>Searching for issues : queries</title>
+ <title>Searching for issues: queries</title>
<para>Query functionality includes defining a very specific query, using a customized query, using saved queries and accessing specific issue IDs. You can also use the Issue List to access the last query.</para>
<itemizedlist>
<listitem>
@@ -125,6 +125,60 @@
</itemizedlist>
</sect1>
<sect1>
+ <title>How-to: an illustrated five-minute tutorial on using and defining simple queries</title>
+ <simpara>Let's use and then save simple queries to display all issues and all "new" issues in a given module. This short example use the Sample data that you may have loaded (or not) when you installed Scarab; otherwise it is quite simple to use your own data instead.</simpara>
+ <simpara>In the nav bar, click "Public queries".</simpara>
+ <screenshot>
+ <graphic fileref="images/query01.png"/>
+ </screenshot>
+ <simpara>Right now, you probably haven't any defined query. Click "Create new".</simpara>
+ <screenshot>
+ <graphic fileref="images/query02.png"/>
+ </screenshot>
+ <simpara>Now you have reached the "grid". The grid is a very nice feature in the new Queries UI. Here you have all issue types defined for this module as columns and values of one attribute as rows, plus a total row. Every cell in the table is a count that tells you how many issues have this attribute value in the different issue types. The example displayed here is rather trivial. You have only one issue, its issue type is "Defect" and the functional area is none of "UserInterface", "Setup" or "Help" -- the Functional Area is undefined for this issue.</simpara>
+ <simpara>All cells are navigable: if you click the number "1" in the Grand Total cell ("All" issue types / total) you get the list of all issues in this module (OK, there is only one).</simpara>
+ <simpara>Let's say you want to browse all issues that are "new". In the "view by attribute" drop-down list, choose "Status"</simpara>
+ <screenshot>
+ <graphic fileref="images/query03.png"/>
+ </screenshot>
+ <simpara>Now the grid has changed and you get the issue count by "Status". You may click the "1" designed by the red arrow to display all "New" "Defects".</simpara>
+ <screenshot>
+ <graphic fileref="images/query04.png"/>
+ </screenshot>
+ <simpara>To define a query that will list all issues in the module, check "All" and click "Define query" (to list all "Defects" you could have checked the corresponding issue type instead).</simpara>
+ <screenshot>
+ <graphic fileref="images/query05.png"/>
+ </screenshot>
+ <simpara>Since you want to list all issues, you should not define any selection criterion. Click "Save this query".</simpara>
+ <screenshot>
+ <graphic fileref="images/query06.png"/>
+ </screenshot>
+ <simpara>You are almost done. Just give this query a name (required), an optional description, and if you want others to use this query you should define the availability as "module" (you probably need to be the module owner to do this, otherwise it will require an approbation). Click "Save" and you're done.</simpara>
+ <screenshot>
+ <graphic fileref="images/query07.png"/>
+ </screenshot>
+ <simpara>The application may have brought you back to the list of private queries (the default) at this point, so if you don't see the query you have just defined, just click "Public queries" again.</simpara>
+ <screenshot>
+ <graphic fileref="images/query08.png"/>
+ </screenshot>
+ <simpara>The query you have defined now appears in the query nav bar drop-down list.</simpara>
+ <screenshot>
+ <graphic fileref="images/query09.png"/>
+ </screenshot>
+ <simpara>Now suppose you wanted a list of all "new" issues instead. To define this query, click "Define query" in the grid as we have done before. Now scroll down the page, and find "Status" in the "Common attributes" section ("Common attributes" because the query is defined across different issue types since we checked "All" in the grid). Select "New" in the list (the lists support multiple selection if you want to group different status in the same query).</simpara>
+ <screenshot>
+ <graphic fileref="images/query10.png"/>
+ </screenshot>
+ <simpara>Simply fill the required information to save the query and click "Save".</simpara>
+ <screenshot>
+ <graphic fileref="images/query11.png"/>
+ </screenshot>
+ <simpara>That's all, your new query has been saved!</simpara>
+ <screenshot>
+ <graphic fileref="images/query12.png"/>
+ </screenshot>
+ </sect1>
+ <sect1>
<!-- Source: UserQueryCrossProject section in the online help -->
<title>Cross module queries</title>
<para>Cross module queries allow you to search multiple modules or issue types or both in a single query. Upon accessing Scarab from the navigation bar, you can click on the <emphasis role="bold">Build cross module query</emphasis> tab. On this tab, you can either select a previously saved cross module query, or create a new one.</para>
Modified: trunk/www/book/queries-fr.xml
Url: http://scarab.tigris.org/source/browse/scarab/trunk/www/book/queries-fr.xml?view=diff&rev=10455&p1=trunk/www/book/queries-fr.xml&p2=trunk/www/book/queries-fr.xml&r1=10454&r2=10455
==============================================================================
--- trunk/www/book/queries-fr.xml (original)
+++ trunk/www/book/queries-fr.xml 2007-07-13 02:18:29-0700
@@ -127,6 +127,60 @@
</itemizedlist>
</sect1>
<sect1>
+ <title>How-to: utiliser et définir des requêtes simples (en 5 minutes)</title>
+ <simpara>Montrons en quelques copies d'écran comment utiliser et sauvegarder deux requêtes simples, pour afficher toutes les fiches et toutes les "nouvelles" fiches d'un module. Ce petit tutoriel utilise les données d'exemple qui ont été chargées (ou non) quand vous avez installé Scarab; sinon, ce n'est pas difficile d'utiliser vos propres données à la place.</simpara>
+ <simpara>Dans la barre de navigation, cliquez "Requêtes publiques".</simpara>
+ <screenshot>
+ <graphic fileref="images/query01.fr.png"/>
+ </screenshot>
+ <simpara>Pour l'instant, vous n'avez probablement pas de requête définie. Cliquez "Créer nouveau".</simpara>
+ <screenshot>
+ <graphic fileref="images/query02.fr.png"/>
+ </screenshot>
+ <simpara>Vous devriez maintenant voir la "grille". La grille est une nouveauté assez sympathique dans la nouvelle interface des Requêtes. Vous avez ici en colonnes tous les types de fiches définis pour ce module et les valeurs d'un attribut, plus le total, comme lignes. Chaque cellule du tableau est un nombre qui vous dit combien de fiches ont cette valeur de l'attribut dans les différents types de fiches. L'exemple affiché est assez trivial: il n'y a qu'une fiche, son type est "Defect" et le domaine fonctionnel concerné n'est ni "UserInterface", ni "Setup" ni "Help" -- il n'est pas défini pour cette fiche.</simpara>
+ <simpara>Toutes les cellules du tableau sont navigables: si vous cliquez le nombre "1" dans la cellule total général ("Tous" les types de fiche / total) vous obtiendrez la liste de toutes les fiches de ce module.</simpara>
+ <simpara>Supposons que vous vouliez consulter la liste de toutes les fiches qui sont à l'état "new". Dans la liste déroulante "vue par attribut", sélectionnez "Status"</simpara>
+ <screenshot>
+ <graphic fileref="images/query03.fr.png"/>
+ </screenshot>
+ <simpara>La grille est rafraîchie et vous avez maintenant un nombre de fiches par "Status". Vous pouvez cliquer le "1" pointé par la flèche rouge pour afficher toutes les fiches dont l'état est "New" et le type "Defects".</simpara>
+ <screenshot>
+ <graphic fileref="images/query04.fr.png"/>
+ </screenshot>
+ <simpara>Pour définir (enregistrer) une requête qui liste toutes les fiches du module, cochez "Tous" et cliquez "Définir une requête" (pour lister toutes les fiches de type "Defects" vous pouvez cocher le type correspondant au lieu de "Tous").</simpara>
+ <screenshot>
+ <graphic fileref="images/query05.fr.png"/>
+ </screenshot>
+ <simpara>Puisque vous voulez lister toutes les fiches, il ne faut définir aucun critère de sélection. Cliquez "Enregistrer cette requête".</simpara>
+ <screenshot>
+ <graphic fileref="images/query06.fr.png"/>
+ </screenshot>
+ <simpara>On y est presque. Il suffit de donner un nom à cettre requête (c'est obligatoire), une description (optionnelle), et si vous voulez que d'autres puissent utiliser cette requête vous devez définir sa disponibilité comme "module" (pour que cela soit effectif immédiatement, vous devez probablement être l'administrateur, ou le propriétaire du module, sinon cela requiert une approbation). Cliquez "Enregistrer" et c'est fini.</simpara>
+ <screenshot>
+ <graphic fileref="images/query07.fr.png"/>
+ </screenshot>
+ <simpara>L'application peut vous avoir ramené(e) maintenant à la liste des requêtes privées, qui est la liste par défaut. Si donc vous ne voyez pas la requête que vous venez de définir, cliquez à nouveau "Requêtes publiques".</simpara>
+ <screenshot>
+ <graphic fileref="images/query08.fr.png"/>
+ </screenshot>
+ <simpara>La requête que vous avez définie apparaît maintenant aussi dans la liste déroulante de la barre de requêtes.</simpara>
+ <screenshot>
+ <graphic fileref="images/query09.fr.png"/>
+ </screenshot>
+ <simpara>Supposons qu'au lieu d'une liste générale vous vouliez une liste des fiches dont l'état est "new" (en général, c'est de ces fiches qu'il faut le plus se préoccuper). Pour définir cette requête, procédez comme précédemment et cliquez "Définir une requête" en bas de la grille. Descendez dans la page pour trouver "Status" dans la liste des "Attributs communs" section (pourquoi "Attributs communs" ? parce que la requête est définie sur plusieurs types de fiches, étant donné qu'on a coché la case "Tous" dans la grille). Sélectionnez "New" dans la liste (les listes d'attributs supportent ici la sélection multiple si vous voulez grouper plusieurs valeurs d'un attribut dans la même requête).</simpara>
+ <screenshot>
+ <graphic fileref="images/query10.fr.png"/>
+ </screenshot>
+ <simpara>Il ne reste plus qu'à donner les informations nécessaires pour sauvegarder la requête et à cliquez "Enregistrer".</simpara>
+ <screenshot>
+ <graphic fileref="images/query11.fr.png"/>
+ </screenshot>
+ <simpara>C'est tout, votre nouvelle requête a bien été enregistrée !!</simpara>
+ <screenshot>
+ <graphic fileref="images/query12.fr.png"/>
+ </screenshot>
+ </sect1>
+ <sect1>
<title>Requêtes sur plusieurs modules</title>
<para>Les requêtes sur plusieurs modules vous permettent de rechercher dans plusieurs modules, plusieurs types de fiches ou l'un et l'autre avec une seule requête. En accédant à Scarab depuis la barre de navigation, vous pouvez cliquer l'onglet <emphasis role="bold">Construire une requête sur plusieurs modules</emphasis>. Dans cet onglet, vous pouvez sélectionner une requête enregistrée précédemment ou en créer une nouvelle.</para>
<para>La table <emphasis role="bold">Projets / fiches dans le domaine</emphasis> liste tous les types de fiches de tous les modules pour les ajouter à votre requête. Les projets ne sont disponibles que si vous avez les droits de lancer des requêtes dans ce module. Ajoutez des types de fiches à votre requête en cochant la case de la colonne <emphasis role="bold">Sélection</emphasis> et en cliquant le bouton <emphasis role="bold">Ajouter la sélection</emphasis>. Ceci déplacera les types de fiches sélectionnés vers la section <emphasis role="bold">Construire la liste des types de fiches</emphasis>. Vous pouvez enlever tous les types de votre requête en cliquant le bouton <emphasis role="bold">Enlever tout</emphasis> ou enlever seulement les types sélectionnés en cliquant le bouton <emphasis role="bold">Enlever la sélection</emphasis>.</para>