Changeset 90 for trunk

Timestamp:

02/13/09 17:26:36 (15 years ago)

Author:

pinsard

Message:

improve guides

Location:

trunk/adm/guides

Files:

• firststeps.xml (modified) (3 diffs)
• get.xml (modified) (4 diffs)
• whatis.xml (modified) (3 diffs)

trunk/adm/guides/firststeps.xml

@@ -14 +14 @@
 %isonum;
 <!ENTITY project "SUPERBIB">
+<!ENTITY project_min "superbib">
 ]>
 
@@ -23 +24 @@
 xml:id="firststeps">
 
-<!--
-module :
-first steps with SUPERBIB ...
+<!--rst
 
-source :
-./SRC/Documentation/xmldoc/firststeps.xml
+first steps
+
+TODO
+====
+
+demo1installation et check 
+ 
+autre demo à partir d'un fichier bibtex ou autre
+
+comment partir de scratch
+
+pb transformation mailto pour le wiki
+
+EVOLUTIONS
+==========
+
+$Id$
+
+- fplod 2009-02-13T16:07:42Z aedon.locean-ipsl.upmc.fr (Darwin)
+
+  * more realistic than the previous release which was too close from SAXO
+    equivalent
 
 -->
+
   <title> First steps with <application>&project;</application> </title>
 
@@ -43 +63 @@
 </sect1>
 
+<sect1 xml:id="rundemo1">
+<title>Run the first demo</title>
+<sect2 xml:id="rundemo1_what">
+<title>What will happened ?</title>
+<para>
+You are going to produce a set of HTML and PHP files under 
+<filename class="directory">/tmp/superbib/</filename>.
+</para>
+<!-- ++ dessin -->
+</sect2>
+<sect2 xml:id="rundemo1_definition">
+<title>Let's go for definition</title>
+<!-- ++ superbib_profile.sh -->
+<para>
+Go to the working spage :
+<screen>
+ <prompt>$</prompt> <userinput>cd ${SUPERBIB}/</userinput>
+</screen>
+</para>
+<para>
+Prepare output directories :
+<screen>
+ <prompt>$</prompt> <userinput>make before</userinput>
+</screen>
+</para>
+<para>
+Identify bibliography databank 
+<screen>
+ <prompt>$</prompt> <userinput>ln -sf ./data/bibdemo1_dbk5.xml ./biblio.xml</userinput>
+</screen>
+</para>
+<para>
+Identify user databank :
+<screen>
+ <prompt>$</prompt> <userinput>ln -sf ./data/userdemo1.xml ./user.xml</userinput>
+ <prompt>$</prompt> <userinput>ln -sf ./data/usernemo.dtd ./user.dtd</userinput>
+</screen>
+</para>
+<para>
+Define your main page :
+<screen>
+ <prompt>$</prompt> <userinput>ln -sf ./data/maindemo1.xml ./main.xml</userinput>
+</screen>
+</para>
+</sect2>
+<sect2 xml:id="rundemo1_production">
+<title>Build ouptuts</title>
+<para>
+<screen>
+ <prompt>$</prompt> <userinput>make html</userinput>
+</screen>
+</para>
+</sect2>
+<sect2 xml:id="rundemo1_see">
+<title>Look to outputs</title>
+<para>
+Choose your favorite browser supporting PHP files and 
+open <filename>/tmp/superbib/one/en/main.php</filename>.
+</para>
+</sect2>
+<sect2 xml:id="rundemo1_conclusion">
+<title>Ok ?</title>
+<para>
+If something went wrong please send a email to 
+<email>&project_min;-dev@forge.ipsl.jussieu.fr</email>
+whith output errors 
+</para>
+</sect2>
+<!-- ++ installation et check -->
+<!-- ++ autre demo à partir d'un fichier bibtex ou autre -->
+<!-- ++ ++ comment partir de scratch -->
+</sect1>
+
 </article>

trunk/adm/guides/get.xml

@@ -58 +58 @@
          </listitem>
 </itemizedlist>
-If you can access one of these directories, there is no need to re-install <application>&project;</application> again! In that case, you only have to link <filename class='directory'>${HOME}/&project;_DIR</filename> to the appropriate directory:
+If you can access one of this directory, there is no need to re-install <application>&project;</application> again! In that case, you only have to link <filename class='directory'>${HOME}/&project;_DIR</filename> to the appropriate directory:
 <variablelist>
   <varlistentry><term>LOCEAN</term>
@@ -81 +81 @@
 </screen>
       </para>
-      <para>
-The latest revision of the <emphasis role="bold">source files</emphasis> (&szsrcsvn; Mb) can be checked out with the following command:
-<screen>
-  <prompt>$</prompt> <userinput><command>svn</command> <option>checkout</option> <parameter>http://forge.ipsl.jussieu.fr/&project_svn;/svn/trunk/SRC</parameter> <parameter>&project;_DIR/SRC</parameter></userinput>
-</screen>
-      </para>
-      <para>
-The latest revision of the <emphasis role="bold">NetCDF data files</emphasis> (&szdatasvn; Mb) used by the test programs can be checked out with the following command:
-<screen>
-  <prompt>$</prompt> <userinput><command>svn</command> <option>checkout</option> <parameter>http://forge.ipsl.jussieu.fr/&project_svn;/svn/trunk/DATA</parameter> <parameter>&project;_DIR/DATA</parameter></userinput>
-</screen>
-      </para>
       </sect3>
       <sect3 xml:id="svn_contributors">
@@ -106 +94 @@
 
 
+<!-- ++ not yet
     <sect2 xml:id="tar">
       <title> Get <application>&project;</application> from a tar file </title>
@@ -180 +169 @@
       </sect3>
     </sect2>
+-->
   </sect1>
 <sect1 xml:id="afterget">

trunk/adm/guides/whatis.xml

@@ -84 +84 @@
   </para>
   <para>
-If you need the publications/years graph, 
-    <application>&project;</application> needs <command>ploticus</command>.
+If you need the publications/years graph, <application>&project;</application> 
+needs <command>ploticus</command>.
   </para>
   <para>
-If you want PDF outputs,
-    <application>&project;</application> needs <command>dblatex</command>.
+If you want PDF outputs, <application>&project;</application> needs <command>dblatex</command>.
   </para>
   <para>
@@ -99 +98 @@
 </sect1>
 
+<!-- ++ 
 <sect1 xml:id="include">
   <title>Include</title>
@@ -104 +104 @@
 </para>
 </sect1>
+-->
+
 </article>