Scarab commit: svn commit: r10440 - trunk/www/book: . images

Author: jfelfouly
Date: 2007-05-14 04:15:56-0700
New Revision: 10440

Added:
   trunk/www/book/images/admin.fr.png   (contents, props changed)
   trunk/www/book/images/admin.png   (contents, props changed)
   trunk/www/book/images/admin2.fr.png   (contents, props changed)
   trunk/www/book/images/admin2.png   (contents, props changed)
   trunk/www/book/images/messaging0.fr.png   (contents, props changed)
   trunk/www/book/images/messaging0.png   (contents, props changed)
   trunk/www/book/images/messaging1.fr.png   (contents, props changed)
   trunk/www/book/images/messaging1.png   (contents, props changed)
   trunk/www/book/images/superadmin.fr.png   (contents, props changed)
   trunk/www/book/images/superadmin.png   (contents, props changed)
   trunk/www/book/images/xml-export.fr.png   (contents, props changed)
   trunk/www/book/images/xml-export.png   (contents, props changed)
   trunk/www/book/images/xml-import.fr.png   (contents, props changed)
   trunk/www/book/images/xml-import.png   (contents, props changed)
   trunk/www/book/superadmin-en.xml
   trunk/www/book/superadmin-fr.xml
Modified:
   trunk/www/book/scarab-user-en.xml
   trunk/www/book/scarab-user-fr.xml
   trunk/www/book/xml-import-export-en.xml
   trunk/www/book/xml-import-export-fr.xml

Log:
Wrote the chapter on XML import/export in FR and EN. Added the associated screenshots. Added a chapter on Scarab global administration.

Added: trunk/www/book/images/admin.fr.png
Url: http://scarab.tigris.org/source/browse/scarab/trunk/www/book/images/admin.fr.png?view=auto&rev=10440
==============================================================================
Binary file. No diff available.

Added: trunk/www/book/images/admin.png
Url: http://scarab.tigris.org/source/browse/scarab/trunk/www/book/images/admin.png?view=auto&rev=10440
==============================================================================
Binary file. No diff available.

Added: trunk/www/book/images/admin2.fr.png
Url: http://scarab.tigris.org/source/browse/scarab/trunk/www/book/images/admin2.fr.png?view=auto&rev=10440
==============================================================================
Binary file. No diff available.

Added: trunk/www/book/images/admin2.png
Url: http://scarab.tigris.org/source/browse/scarab/trunk/www/book/images/admin2.png?view=auto&rev=10440
==============================================================================
Binary file. No diff available.

Added: trunk/www/book/images/messaging0.fr.png
Url: http://scarab.tigris.org/source/browse/scarab/trunk/www/book/images/messaging0.fr.png?view=auto&rev=10440
==============================================================================
Binary file. No diff available.

Added: trunk/www/book/images/messaging0.png
Url: http://scarab.tigris.org/source/browse/scarab/trunk/www/book/images/messaging0.png?view=auto&rev=10440
==============================================================================
Binary file. No diff available.

Added: trunk/www/book/images/messaging1.fr.png
Url: http://scarab.tigris.org/source/browse/scarab/trunk/www/book/images/messaging1.fr.png?view=auto&rev=10440
==============================================================================
Binary file. No diff available.

Added: trunk/www/book/images/messaging1.png
Url: http://scarab.tigris.org/source/browse/scarab/trunk/www/book/images/messaging1.png?view=auto&rev=10440
==============================================================================
Binary file. No diff available.

Added: trunk/www/book/images/superadmin.fr.png
Url: http://scarab.tigris.org/source/browse/scarab/trunk/www/book/images/superadmin.fr.png?view=auto&rev=10440
==============================================================================
Binary file. No diff available.

Added: trunk/www/book/images/superadmin.png
Url: http://scarab.tigris.org/source/browse/scarab/trunk/www/book/images/superadmin.png?view=auto&rev=10440
==============================================================================
Binary file. No diff available.

Added: trunk/www/book/images/xml-export.fr.png
Url: http://scarab.tigris.org/source/browse/scarab/trunk/www/book/images/xml-export.fr.png?view=auto&rev=10440
==============================================================================
Binary file. No diff available.

Added: trunk/www/book/images/xml-export.png
Url: http://scarab.tigris.org/source/browse/scarab/trunk/www/book/images/xml-export.png?view=auto&rev=10440
==============================================================================
Binary file. No diff available.

Added: trunk/www/book/images/xml-import.fr.png
Url: http://scarab.tigris.org/source/browse/scarab/trunk/www/book/images/xml-import.fr.png?view=auto&rev=10440
==============================================================================
Binary file. No diff available.

Added: trunk/www/book/images/xml-import.png
Url: http://scarab.tigris.org/source/browse/scarab/trunk/www/book/images/xml-import.png?view=auto&rev=10440
==============================================================================
Binary file. No diff available.

Modified: trunk/www/book/scarab-user-en.xml
Url: http://scarab.tigris.org/source/browse/scarab/trunk/www/book/scarab-user-en.xml?view=diff&rev=10440&p1=trunk/www/book/scarab-user-en.xml&p2=trunk/www/book/scarab-user-en.xml&r1=10439&r2=10440
==============================================================================
--- trunk/www/book/scarab-user-en.xml	(original)
+++ trunk/www/book/scarab-user-en.xml	2007-05-14 04:15:56-0700
@@ -10,6 +10,7 @@
 	<!ENTITY modules SYSTEM "modules-en.xml">

 	<!ENTITY bestpractices SYSTEM "bestpractices-en.xml">

 	<!ENTITY workflow SYSTEM "workflow1-en.xml">

+	<!ENTITY superadmin SYSTEM "superadmin-en.xml">

 	<!ENTITY xml SYSTEM "xml-import-export-en.xml">

 	<!ENTITY integration SYSTEM "integration-en.xml">

 ]>

@@ -41,6 +42,7 @@
 		&modules;

 		&bestpractices;

 	    &workflow;

+	    &superadmin;

 	</part>

 	<part>

 		<title>Advanced topics</title>


Modified: trunk/www/book/scarab-user-fr.xml
Url: http://scarab.tigris.org/source/browse/scarab/trunk/www/book/scarab-user-fr.xml?view=diff&rev=10440&p1=trunk/www/book/scarab-user-fr.xml&p2=trunk/www/book/scarab-user-fr.xml&r1=10439&r2=10440
==============================================================================
--- trunk/www/book/scarab-user-fr.xml	(original)
+++ trunk/www/book/scarab-user-fr.xml	2007-05-14 04:15:56-0700
@@ -10,6 +10,7 @@
 	<!ENTITY modules SYSTEM "modules-fr.xml">
 	<!ENTITY bestpractices SYSTEM "bestpractices-fr.xml">
 	<!ENTITY workflow SYSTEM "workflow1-fr.xml">
+	<!ENTITY superadmin SYSTEM "superadmin-fr.xml">
 	<!ENTITY xml SYSTEM "xml-import-export-fr.xml">
 	<!ENTITY integration SYSTEM "integration-fr.xml">
 ]>
@@ -41,6 +42,7 @@
 		&modules;
 		&bestpractices;
 	    &workflow;
+	    &superadmin;
 	</part>
 	<part>
 		<title>Aller plus loin avec Scarab</title>

Added: trunk/www/book/superadmin-en.xml
Url: http://scarab.tigris.org/source/browse/scarab/trunk/www/book/superadmin-en.xml?view=auto&rev=10440
==============================================================================
--- (empty file)
+++ trunk/www/book/superadmin-en.xml	2007-05-14 04:15:56-0700
@@ -0,0 +1,16 @@
+<!-- $Id -->

+<chapter>

+	<title>Scarab for the super-administrator</title>

+	<simpara>Each Scarab installation has a global administrator. His/her login is &quot;Administrator&quot; by default -- but this may have been changed when building Scarab. The initial password is &quot;1&quot; (without the quotes) -- this <emphasis>should</emphasis> have been changed after building Scarab.</simpara>

+	<simpara>The super-administrator has access to some additional functionalities.</simpara>

+	<screenshot><graphic fileref="images/superadmin.png"/></screenshot>

+	<section>

+	<title>Display an informational message</title>

+	<simpara>This allows the administrator to display an informational message to all users, connected or about to connect. For instance, to plan a maintenance operation.</simpara>

+	<simpara>Access this function using the &quot;Set default informational message&quot; link.</simpara>

+	<screenshot><graphic fileref="images/messaging0.png"/></screenshot>

+	<simpara>The entered message now appears on top of every page (including the home page), to all users.</simpara>

+	<screenshot><graphic fileref="images/messaging1.png"/></screenshot>

+	<note><para>The informational message is not persistent: it is reset if you restart the web application.</para></note>

+	</section>

+</chapter>
\ No newline at end of file

Added: trunk/www/book/superadmin-fr.xml
Url: http://scarab.tigris.org/source/browse/scarab/trunk/www/book/superadmin-fr.xml?view=auto&rev=10440
==============================================================================
--- (empty file)
+++ trunk/www/book/superadmin-fr.xml	2007-05-14 04:15:56-0700
@@ -0,0 +1,24 @@
+<!-- $Id -->

+<chapter>

+	<title>Scarab pour le super-administrateur</title>

+	<simpara>Chaque installation de Scarab possède un administrateur global, dont l'identifiant de connexion est par défaut 'Administrateur' (dans une version française) et le mot de passe initial &quot;1&quot; (sans les guillemets).</simpara>

+	<simpara>Le super-administrateur a accès à certaines fonctionnalités supplémentaires.</simpara>

+	<screenshot>

+		<graphic fileref="images/superadmin.fr.png"/>

+	</screenshot>

+	<section>

+		<title>Afficher un message informatif à tous les utilisateurs</title>

+		<simpara>Cette fonctionnalité permet par exemple de prévenir les utilisateurs connectés (ou qui vont se connecter) d'une opération de maintenance.</simpara>

+		<simpara>On accède à cette fonction par le lien &quot;Message d'information par défaut&quot;.</simpara>

+		<screenshot>

+			<graphic fileref="images/messaging0.fr.png"/>

+		</screenshot>

+		<simpara>Le message saisi apparaît en haut de toutes les pages (y compris la page d'accueil), pour tous les utilisateurs.</simpara>

+		<screenshot>

+			<graphic fileref="images/messaging1.fr.png"/>

+		</screenshot>

+		<note>

+			<para>Le message d'information n'est pas persistent&nbsp;: il est réinitialisé si on redémarre Scarab.</para>

+		</note>

+	</section>

+</chapter>


Modified: trunk/www/book/xml-import-export-en.xml
Url: http://scarab.tigris.org/source/browse/scarab/trunk/www/book/xml-import-export-en.xml?view=diff&rev=10440&p1=trunk/www/book/xml-import-export-en.xml&p2=trunk/www/book/xml-import-export-en.xml&r1=10439&r2=10440
==============================================================================
--- trunk/www/book/xml-import-export-en.xml	(original)
+++ trunk/www/book/xml-import-export-en.xml	2007-05-14 04:15:56-0700
@@ -26,10 +26,15 @@
 			</listitem>

 		</itemizedlist>

 		<simpara>In the current development of Scarab it is not possible (yet) to import the metadata, i.e. issue types and attributes.</simpara>

+		<simpara>Access the XML import/export functions using the Administration menu.</simpara>

+		<screenshot><graphic fileref="images/admin.png"/></screenshot>

+		<screenshot><graphic fileref="images/admin2.png"/></screenshot>

 	</sect1>

 	<sect1>

 		<title>XML export of issues</title>

-		<simpara>[This section to be written.]</simpara>

+		<simpara>Select XML export in the Current module section.</simpara>

+		<screenshot><graphic fileref="images/xml-export.fr.png"/></screenshot>

+		<note><para>In the default Role configuration, you just need the Observer role in a module to have access to this functionality.</para></note>

 	</sect1>

 	<sect1>

 		<title>XML export of metadata (issue types, attributes)</title>

@@ -37,6 +42,8 @@
 	</sect1>

 	<sect1>

 		<title>XML import</title>

-		<simpara>[This section to be written.]</simpara>

+		<simpara>Select XML import in the Current module section.</simpara>

+		<screenshot><graphic fileref="images/xml-import.fr.png"/></screenshot>

+		<note><para>In the default Role configuration, you just need the Observer role in a module to have access to this functionality.</para></note>

 	</sect1>

 </chapter>


Modified: trunk/www/book/xml-import-export-fr.xml
Url: http://scarab.tigris.org/source/browse/scarab/trunk/www/book/xml-import-export-fr.xml?view=diff&rev=10440&p1=trunk/www/book/xml-import-export-fr.xml&p2=trunk/www/book/xml-import-export-fr.xml&r1=10439&r2=10440
==============================================================================
--- trunk/www/book/xml-import-export-fr.xml	(original)
+++ trunk/www/book/xml-import-export-fr.xml	2007-05-14 04:15:56-0700
@@ -26,10 +26,15 @@
 			</listitem>

 		</itemizedlist>

 		<simpara>L'import des types de fiches et des attributs n'est pas possible en l'état courant du développement.</simpara>

+		<simpara>L'accès aux fonctions d'import/export XML se fait par le biais du menu Administration.</simpara>

+		<screenshot><graphic fileref="images/admin.fr.png"/></screenshot>

+		<screenshot><graphic fileref="images/admin2.fr.png"/></screenshot>

 	</sect1>

 	<sect1>

 		<title>Export XML des données d'un module</title>

-		<simpara>[Cette section est à écrire.]</simpara>

+		<simpara>Sélectionnez Import XML dans la section Module courant.</simpara>

+		<screenshot><graphic fileref="images/xml-export.fr.png"/></screenshot>

+		<note><para>Dans le paramétrage par défaut des rôles, il suffit d'avoir le rôle Observateur (Observer) pour pouvoir accéder à cette fonctionnalité.</para></note>

 	</sect1>

 	<sect1>

 		<title>Export XML des métadonnées (types de fiches, attributs)</title>

@@ -37,6 +42,8 @@
 	</sect1>

 	<sect1>

 		<title>Import XML de fiches</title>

-		<simpara>[Cette section est à écrire.]</simpara>

+		<simpara>Sélectionnez Export XML dans la section Module courant.</simpara>

+		<screenshot><graphic fileref="images/xml-import.fr.png"/></screenshot>

+		<note><para>Dans le paramétrage par défaut des rôles, il suffit d'avoir le rôle Observateur (Observer) pour pouvoir accéder à cette fonctionnalité.</para></note>

 	</sect1>

 </chapter>