Scarab commit: svn commit: r10224 - trunk/www/book
[email protected] 24 Jul 2006 17:12:12 -0000
Newsgroups
gmane.comp.java.scarab.cvs
Message-ID
<[email protected] >
Author: jfelfouly
Date: 2006-07-24 10:12:12-0700
New Revision: 10224
Added:
trunk/www/book/integration-en.xml
trunk/www/book/integration-fr.xml
Log:
Restructured the IDE integration chapter in the User's Guide to make it more general and add the doc on TWiki integration supplied by Steve James.
Added: trunk/www/book/integration-en.xml
Url: http://scarab.tigris.org/source/browse/scarab/trunk/www/book/integration-en.xml?view=auto&rev=10224
==============================================================================
--- (empty file)
+++ trunk/www/book/integration-en.xml 2006-07-24 10:12:12-0700
@@ -0,0 +1,102 @@
+<!-- $Id$ -->
+<chapter>
+ <title>Integrating Scarab and other tools</title>
+ <sect1>
+ <title>Integrating Scarab in Eclipse</title>
+ <simpara>An interesting way to bring Scarab information into Eclipse is probably to use an RSS reader, for example <ulink url="http://morphine.sourceforge.net/presence/projects/rss/index.html">Eclipse RSS Reader</ulink>. Let us use this plugin as an example.</simpara>
+ <simpara>You can keep an eye on a given issue or on the result of any public query (except for multi-module queries). Say you want to keep an eye on the history of the PACS1 issue in Scarab. In the bottom right corner of the issue page in Scarab, you have RSS and ATOM links.</simpara>
+ <screenshot>
+ <graphic fileref="images/pacs1-rss1.fr.png"/>
+ </screenshot>
+ <simpara>Copy the URL in the RSS link.</simpara>
+ <screenshot>
+ <graphic fileref="images/pacs1-rss2.fr.png"/>
+ </screenshot>
+ <simpara>Now, in Eclipse, create a new RSS channel.</simpara>
+ <screenshot>
+ <graphic fileref="images/pacs1-rss3.png"/>
+ </screenshot>
+ <simpara>Paste the issue RSS feed URL and click "Load".</simpara>
+ <screenshot>
+ <graphic fileref="images/pacs1-rss4.png"/>
+ </screenshot>
+ <simpara>There is only one translator available for this feed format, so you may proceed.</simpara>
+ <screenshot>
+ <graphic fileref="images/pacs1-rss5.png"/>
+ </screenshot>
+ <simpara>Now you must choose a project and a file name for your RSS feed.</simpara>
+ <screenshot>
+ <graphic fileref="images/pacs1-rss6.png"/>
+ </screenshot>
+ <simpara>The RSS appears now among your project resources in the Package Explorer.</simpara>
+ <screenshot>
+ <graphic fileref="images/pacs1-rss7.png"/>
+ </screenshot>
+ <simpara>When you click the feed, you get a new window with the history. The "Browse" link brings you back to Scarab in the issue page.</simpara>
+ <screenshot>
+ <graphic fileref="images/pacs1-rss8.png"/>
+ </screenshot>
+ </sect1>
+ <sect1>
+ <title>Integrating Scarab in Netbeans</title>
+ <abstract>
+ <para>A NetBeans plugin allows to include Scarab issues in the to-do list.</para>
+ <para>This plug-in (.nbm) is currently available from the NetBeans tracker at this URL: <ulink url="http://tasklist.netbeans.org/issues/show_bug.cgi?id=69572">http://tasklist.netbeans.org/issues/show_bug.cgi?id=69572</ulink></para>
+ </abstract>
+ </sect1>
+ <sect1>
+ <title>Integrating Scarab in TWiki</title>
+ <abstract><simpara>Use an RSS feed with TWiki for Status and Progress Reporting</simpara></abstract>
+ <simpara>
+ TWiki is an enterprise collaboration platform and has a plugin for showing the
+ content of RSS and Atom feeds (HeadlinesPlugin). The results can be formatted
+ as a table. This can be used to show the results of a public Scarab query.
+ Use this, for example, to create a TWiki topic that shows all the Defects
+ that are currently at Status of Assigned. You could even create a table to
+ list which issues were changed to a Status of Resolved in the current month.
+ </simpara>
+ <orderedlist>
+ <listitem>
+ <para>
+ Create a public query that finds the issues you want to report. For
+ example, search for all issues with Status equal to Assigned or Reopened.
+ Use a public query so that TWiki will be able to get a feed from it without
+ needing to provide credentials. Alternatively you must include private
+ credentials as part of the feed URL.
+ </para>
+ </listitem>
+ <listitem>
+ <para>Run the query from the Advanced query pull-down list. Verify that the query reports what you expect.</para>
+ </listitem>
+ <listitem>
+ <para>
+ Use your browser to copy the address of the RSS or Atom feed for this
+ query. You would normally do this by right-clicking on the feed name at the
+ top (and bottom) of the query results table.
+ </para>
+ </listitem>
+ <listitem>
+ <para>On a TWiki topic, use the %HEADLINES% variable to pull the feed into the topic.</para>
+ <para>
+ <computeroutput>
+ %HEADLINES{ href="http://www.saxess.de/testscarab/issues/curmodule/1/tqk/0/template/RSSDataExport.vm/feedType/QueryFeed/queryId/10000/userId/1/type/rss_2.0"
+ refresh="1" header="| *$title* | *$description* |" format="$t| [[$link]
+ [$title]] | $description |" }%
+ </computeroutput>
+ </para>
+ </listitem>
+ </orderedlist>
+ <simpara>You will see a formatted table of the query results, just as Scarab showed them.</simpara>
+ <simpara>
+ The first column shows the issue name and the second column shows the Status,
+ Summary and AssignedTo attribute values. The entries in the first column also
+ link to the original issue in Scarab.
+ </simpara>
+ <simpara>
+ Beware that the headlines plugin will cache its results to avoid excessive
+ loading on the feed source. The default refresh timeout is 60 minutes. In the
+ example above, the refresh parameter is used to set the refresh time to only
+ one minute.
+ </simpara>
+ </sect1>
+</chapter>
Added: trunk/www/book/integration-fr.xml
Url: http://scarab.tigris.org/source/browse/scarab/trunk/www/book/integration-fr.xml?view=auto&rev=10224
==============================================================================
--- (empty file)
+++ trunk/www/book/integration-fr.xml 2006-07-24 10:12:12-0700
@@ -0,0 +1,104 @@
+<!-- $Id -->
+<chapter>
+ <title>Intégrer Scarab et d'autres outils</title>
+ <sect1>
+ <title>Intégrer Scarab dans Eclipse</title>
+ <simpara>Un moyen intéressant d'amener des informations de Scarab dans Eclipse est d'utiliser un plugin de lecture de flux RSS, par exemple <ulink url="http://morphine.sourceforge.net/presence/projects/rss/index.html">Eclipse RSS Reader</ulink>. Utilisons ce plugin pour les besoins de la démonstration.</simpara>
+ <simpara>Vous pouvez suivre dans Eclipse l'historique d'une fiche ou le résultat d'une requête publique (hors requêtes multi-modules). Supposons par exemple que vous vouliez suivre dans Eclipse l'évolution de la fiche Scarab PACS1. Dans Scarab, dans le coin inférieur droit de cette fiche, il y a des liens RSS et ATOM.</simpara>
+ <screenshot>
+ <graphic fileref="images/pacs1-rss1.fr.png"/>
+ </screenshot>
+ <simpara>Copiez par exemple le lien RSS.</simpara>
+ <screenshot>
+ <graphic fileref="images/pacs1-rss2.fr.png"/>
+ </screenshot>
+ <simpara>Dans Eclipse, maintenant, créez un nouveau canal RSS.</simpara>
+ <screenshot>
+ <graphic fileref="images/pacs1-rss3.png"/>
+ </screenshot>
+ <simpara>Collez l'URL du lien RSS et cliquez "Load".</simpara>
+ <screenshot>
+ <graphic fileref="images/pacs1-rss4.png"/>
+ </screenshot>
+ <simpara>Il n'y a qu'un traducteur disponible pour ce format, vous pouvez donc continuer.</simpara>
+ <screenshot>
+ <graphic fileref="images/pacs1-rss5.png"/>
+ </screenshot>
+ <simpara>Choisissez maintenant le projet auquel vous voulez associer le RSS, puis un nom de fichier.</simpara>
+ <screenshot>
+ <graphic fileref="images/pacs1-rss6.png"/>
+ </screenshot>
+ <simpara>Le flux RSS apparaît maintenant comme une ressource projet dans le navigateur d'Eclipse..</simpara>
+ <screenshot>
+ <graphic fileref="images/pacs1-rss7.png"/>
+ </screenshot>
+ <simpara>Si vous cliquez sur le fichier du flux RSS, une fenêtre s'ouvre avec l'historique de la fiche (elle est rafraîchie automatiquement, par défaut toutes les 30 minutes). Le lien "Browse" vous ramène directement vers Scarab, à la fiche concernée.</simpara>
+ <screenshot>
+ <graphic fileref="images/pacs1-rss8.png"/>
+ </screenshot>
+ </sect1>
+ <sect1>
+ <title>Intégrer Scarab dans Netbeans</title>
+ <abstract>
+ <para>Un plug-in NetBeans permet d'inclure des fiches Scarab dans sa liste de tâches.</para>
+ <para>Ce plug-in (.nbm) est pour l'instant disponible dans le <emphasis>tracker</emphasis> de NetBeans à l'URL suivante : <ulink url="http://tasklist.netbeans.org/issues/show_bug.cgi?id=69572">http://tasklist.netbeans.org/issues/show_bug.cgi?id=69572</ulink>
+ </para>
+ </abstract>
+ </sect1>
+ <sect1>
+ <title>Integrating Scarab dans TWiki</title>
+ <abstract><simpara>On utilise un flux RSS dans TWiki pour obtenir une vue de l'état d'avancement d'un projet.</simpara></abstract>
+ <simpara>
+ TWiki est une plate-forme de collaboration en entreprise qui a un plugin pour
+ afficher le contenu de flux RSS et Arom (le plugin HeadLines). Les résultats
+ peuvent être présentés sous forme tabulaire. On peut utiliser cette fonctionnalité
+ pour afficher les résultats d'une requête publique dans Scarab.
+ Par exemple, on peut créer un sujet TWiki pour montrer tous les défauts ayant
+ à un instant donné le statut "Assigné".
+ Il est même possible de créer un tableau qui liste les fiches dont le statut est passé Ã
+ "Résolu" dans le mois courant.
+ </simpara>
+ <orderedlist>
+ <listitem>
+ <para>
+ Créez une requête publique qui ramène les fiches que vous voulez inclure
+ dans votre rapport. Par exemple, recherchez touts les fiches dont le statut est
+ "Assigné" ou "Réouvert".
+ Utilisez une requête publique de sorte que TWiki puisse obtenir le flux correspondant
+ sans devoir s'authentifier. Sinon, il est aussi possible d'inclure l'identifiant et le mot
+ de passe dans l'URL du flux.
+ </para>
+ </listitem>
+ <listitem>
+ <para>Exécutez la requête depuis la liste déroulante "Requête avancée". Vérifiez que la requête ramène les résultats attendus.</para>
+ </listitem>
+ <listitem>
+ <para>
+ Utilisez votre navigateur pour copier l'adresse du flux RSS ou Atom correspondant au résultat de cette requête.
+ Pour cela, faites un clic droit sur "RSS" ou "Atom" en haut ou en bas du tableau
+ présentant les résultats de la requête dans Scarab.
+ </para>
+ </listitem>
+ <listitem>
+ <para>Dans un sujet (topic) TWiki, utilisez la variable <computeroutput>%HEADLINES%</computeroutput> pour présenter le flux dans la page :.</para>
+ <para>
+ <computeroutput>
+ %HEADLINES{ href="http://www.saxess.de/testscarab/issues/curmodule/1/tqk/0/template/RSSDataExport.vm/feedType/QueryFeed/queryId/10000/userId/1/type/rss_2.0"
+ refresh="1" header="| *$title* | *$description* |" format="$t| [[$link]
+ [$title]] | $description |" }%
+ </computeroutput>
+ </para>
+ </listitem>
+ </orderedlist>
+ <simpara>Vous verrez une table formatée présentant les résultats de la requête, comme vous l'aviez vue dans Scarab.</simpara>
+ <simpara>
+ La première colonne donne l'identifiant de la fiche, la seconde l'état, le résumé et les personnes à qui cette fiche est assignée.
+ Les identifiants de la première colonne sont aussi des liens vers la fiche correspondante dans Scarab.
+ </simpara>
+ <simpara>
+ Prenez garde au fait que le plugin Headlines de TWiki met les résultats en cache pour évider de trop charger la source des flux.
+ Le temps de rafraîchissement est par défaut de 60 minutes; dans l'exemple ci-dessus, le paramètre
+ <computeroutput>refresh</computeroutput> est positionné pour ramener ce délai à une minute.
+ </simpara>
+ </sect1>
+</chapter>