Changeset 140


Ignore:
Timestamp:
02/27/12 12:14:36 (12 years ago)
Author:
pinsard
Message:

progress on user doc

Location:
trunk/docs
Files:
4 added
1 deleted
5 edited
1 copied
1 moved

Legend:

Unmodified
Added
Removed

  • trunk/docs/docs_dev/source/conf.py

    r137 r140  
    162162# Additional templates that should be rendered to pages, maps page names to 
    163163# template names. 
    164 #html_additional_pages = {} 
     164html_additional_pages = {'index': 'index.html'} 
    165165 
    166166# If false, no module index is generated. 

  • trunk/docs/docs_users/source/_templates/index.html

    r138 r140  
    2323{% block body %} 
    2424 
    25 <h2>Developer documentation</h2> 
     25<h2>User documentation</h2> 
    2626 
    2727<table class="contentstable" align="center" style="margin-left: 30px"> 
    2828 <tr><td> 
    2929    <p class="biglink"><a class="biglink" href="{{ pathto("guides/index") }}">Guides</a> 
    30        <span class="linkdescr">PULSATION guides </span></p> 
     30       <span class="linkdescr">SUPERBIB guides </span></p> 
    3131  </td> 
    3232 <td> 
    3333    <p class="biglink"><a class="biglink" href="{{ pathto("manuals/index") }}">Manuals</a> 
    34        <span class="linkdescr">PULSATION manuals</span></p> 
     34       <span class="linkdescr">SUPERBIB manuals</span></p> 
    3535  </td></tr> 
    3636</table> 

  • trunk/docs/docs_users/source/conf.py

    r138 r140  
    3535 
    3636# The encoding of source files. 
    37 #source_encoding = 'utf-8-sig' 
     37#source_encoding = 'iso-8859-15' 
    3838 
    3939# The master toctree document. 
    40 master_doc = 'index' 
     40master_doc = 'contents' 
    4141 
    4242# General information about the project. 
    … …  
    6565# List of patterns, relative to source directory, that match files and 
    6666# directories to ignore when looking for source files. 
    67 exclude_patterns = [] 
    68  
     67exclude_patterns = ['build', 'prolog.rst'] 
     68 
     69# Included at the beginning of every source file that is read. 
     70with open('prolog.rst', 'r') as pr: 
     71     rst_prolog = pr.read() 
     72 
     73rst_prolog 
    6974# The reST default role (used for this markup: `text`) to use for all documents. 
    7075#default_role = None 
    … …  
    136141# Additional templates that should be rendered to pages, maps page names to 
    137142# template names. 
    138 #html_additional_pages = {} 
     143html_additional_pages = {'index': 'index.html'} 
    139144 
    140145# If false, no module index is generated. 

  • trunk/docs/docs_users/source/contents.rst

    r138 r140  
    44.. TODO 
    55.. ==== 
    6 .. 
    7 .. meilleur plan : logging est un des thèmes, il y en a d'autres (ex  
    8 .. installation avec *_install.sh) 
    96.. 
    107.. better meta directive usage (propagation to every HTML files) 
    … …  
    1714.. $URL: svn+ssh://pinsard@forge.ipsl.jussieu.fr/ipsl/forge/projets/pulsation/svn/trunk/docs/docs_dev/source/contents.rst $ 
    1815.. 
    19 .. - fplod 20120103T112734Z cratos (Linux) 
    20 .. 
    21 ..   * add logging 
    22 .. 
    23 .. - fplod 20111230T141556Z cratos (Linux) 
     16.. - fplod 20120227 
    2417.. 
    2518..   * creation 
    … …  
    3124.. _contents: 
    3225 
    33 ================================== 
     26============================= 
    3427SUPERBIB Users Documentations 
    35 ================================== 
     28============================= 
    3629 
    3730.. only:: html 
    … …  
    4033 
    4134.. toctree:: 
    42    :maxdepth: 2 
     35   :maxdepth: 1 
    4336 
    4437   overview 
    45    guides/index.rst 
     38   guides 
    4639   manuals/index.rst 

  • trunk/docs/docs_users/source/guides/firststeps.rst

    r137 r140  
    1 <?xml version="1.0" encoding="iso-8859-1"?> 
    2 <!DOCTYPE chapter [ 
    3 <!ENTITY % isolat1 SYSTEM "http://www.w3.org/2003/entities/iso8879/isolat1.ent"> 
    4 %isolat1; 
    5 <!ENTITY % isolat2 SYSTEM "http://www.w3.org/2003/entities/iso8879/isolat2.ent"> 
    6 %isolat2; 
    7 <!ENTITY % isogrk3 SYSTEM "http://www.w3.org/2003/entities/iso8879/isogrk3.ent"> 
    8 %isogrk3; 
    9 <!ENTITY % isopub SYSTEM "http://www.w3.org/2003/entities/iso8879/isopub.ent"> 
    10 %isopub; 
    11 <!ENTITY % isotech SYSTEM "http://www.w3.org/2003/entities/iso8879/isotech.ent"> 
    12 %isotech; 
    13 <!ENTITY % isonum SYSTEM "http://www.w3.org/2003/entities/iso8879/isonum.ent"> 
    14 %isonum; 
    15 <!ENTITY project "SUPERBIB"> 
    16 <!ENTITY project_min "superbib"> 
    17 ]> 
     1.. + 
     2.. DESCRIPTION 
     3.. =========== 
     4.. 
     5.. first steps 
     6..  
     7.. TODO 
     8.. ==== 
     9..  
     10.. demo1 installation et check et menage  
     11..   
     12.. autre demo à partir d'un fichier bibtex ou autre 
     13..  
     14.. comment partir de scratch 
     15..  
     16.. pb transformation mailto pour le wiki 
     17..  
     18.. EVOLUTIONS 
     19.. ========== 
     20..  
     21.. $Id$ 
     22..  
     23.. $URL$ 
     24.. 
     25.. - fplod 20120227 
     26.. 
     27..   * migration to ReST 
     28..   * move in user documentation 
     29.. 
     30.. - fplod 2009-02-13T16:07:42Z aedon.locean-ipsl.upmc.fr (Darwin) 
     31..  
     32..   * more realistic than the previous release which was too close from SAXO 
     33..     equivalent 
     34..  
     35.. - 
    1836 
    19 <chapter version="5.0" 
    20 xmlns="http://docbook.org/ns/docbook" 
    21 xmlns:xl="http://www.w3.org/1999/xlink" 
    22 xmlns:xi="http://www.w3.org/2001/XInclude" 
    23 xml:lang="en" 
    24 xml:id="firststeps"> 
     37.. _firststeps: 
    2538 
    26 <!--rst 
     39========================== 
     40First steps with |project| 
     41========================== 
    2742 
    28 first steps 
     43.. _beforefirststeps: 
    2944 
    30 TODO 
    31 ==== 
     45Before this 
     46+++++++++++ 
    3247 
    33 demo1 installation et check et menage  
     48In this document, we supposed that you followed :ref:`get` recommendations. 
     49 
     50.. _rundemo1: 
     51 
     52Run the first demo 
     53++++++++++++++++++ 
     54 
     55.. _rundemo1_what: 
     56 
     57What will happened ? 
     58~~~~~~~~~~~~~~~~~~~~ 
     59 
     60You are going to produce a set of HTML and PHP files under  
     61:file:`/tmp/superbib/`. 
     62 
     63.. _rundemo1_definition: 
     64 
     65Let's go for definition 
     66~~~~~~~~~~~~~~~~~~~~~~~ 
     67 
     68.. ++ superbib_profile.sh 
     69 
     70Go to the working page:: 
     71 
     72 $ cd ${SUPERBIB}/ 
     73 
     74Prepare output directories:: 
     75 
     76 $ make before 
     77 
     78Identify bibliography databank:: 
     79 
     80 $ ln -sf ./data/bibdemo1_dbk5.xml ./biblio.xml 
     81 
     82Identify user databank:: 
     83 
     84 $ ln -sf ./data/userdemo1.xml ./user.xml 
     85 $ ln -sf ./data/usernemo.dtd ./user.dtd 
     86 
     87Define your main page:: 
     88 
     89 $ ln -sf ./data/maindemo1.xml ./main.xml 
     90 
     91.. _rundemo1_production: 
     92 
     93Build ouptuts 
     94~~~~~~~~~~~~~ 
     95:: 
    3496  
    35 autre demo à partir d'un fichier bibtex ou autre 
     97 $ make html 
    3698 
    37 comment partir de scratch 
     99.. _rundemo1_see: 
    38100 
    39 pb transformation mailto pour le wiki 
     101Look to outputs 
     102~~~~~~~~~~~~~~~ 
    40103 
    41 EVOLUTIONS 
    42 ========== 
     104Choose your favorite browser supporting PHP files and  
     105open :file:`/tmp/superbib/one/en/main.php`. 
    43106 
    44 $Id$ 
     107.. _rundemo1_conclusion: 
    45108 
    46 - fplod 2009-02-13T16:07:42Z aedon.locean-ipsl.upmc.fr (Darwin) 
     109Ok ? 
     110~~~~ 
    47111 
    48   * more realistic than the previous release which was too close from SAXO 
    49     equivalent 
     112If something went wrong please send an email to  
     113|contact| 
     114with output errors  
    50115 
    51 --> 
    52  
    53   <title> First steps with <application>&project;</application> </title> 
    54  
    55   <info> 
    56      <pubdate>$Id$</pubdate> 
    57   </info> 
    58 <sect1 xml:id="beforefirststeps"> 
    59 <title>Before this</title> 
    60 <para> 
    61 In this document, we supposed that you followed <link xl:href="./get.html">Get &project;</link> recommendations. 
    62 </para> 
    63 </sect1> 
    64  
    65 <sect1 xml:id="rundemo1"> 
    66 <title>Run the first demo</title> 
    67 <sect2 xml:id="rundemo1_what"> 
    68 <title>What will happened ?</title> 
    69 <para> 
    70 You are going to produce a set of HTML and PHP files under  
    71 <filename class="directory">/tmp/superbib/</filename>. 
    72 </para> 
    73 <!-- ++ dessin --> 
    74 </sect2> 
    75 <sect2 xml:id="rundemo1_definition"> 
    76 <title>Let's go for definition</title> 
    77 <!-- ++ superbib_profile.sh --> 
    78 <para> 
    79 Go to the working page : 
    80 <screen> 
    81  <prompt>$</prompt> <userinput>cd ${SUPERBIB}/</userinput> 
    82 </screen> 
    83 </para> 
    84 <para> 
    85 Prepare output directories : 
    86 <screen> 
    87  <prompt>$</prompt> <userinput>make before</userinput> 
    88 </screen> 
    89 </para> 
    90 <para> 
    91 Identify bibliography databank : 
    92 <screen> 
    93  <prompt>$</prompt> <userinput>ln -sf ./data/bibdemo1_dbk5.xml ./biblio.xml</userinput> 
    94 </screen> 
    95 </para> 
    96 <para> 
    97 Identify user databank : 
    98 <screen> 
    99  <prompt>$</prompt> <userinput>ln -sf ./data/userdemo1.xml ./user.xml</userinput> 
    100  <prompt>$</prompt> <userinput>ln -sf ./data/usernemo.dtd ./user.dtd</userinput> 
    101 </screen> 
    102 </para> 
    103 <para> 
    104 Define your main page : 
    105 <screen> 
    106  <prompt>$</prompt> <userinput>ln -sf ./data/maindemo1.xml ./main.xml</userinput> 
    107 </screen> 
    108 </para> 
    109 </sect2> 
    110 <sect2 xml:id="rundemo1_production"> 
    111 <title>Build ouptuts</title> 
    112 <para> 
    113 <screen> 
    114  <prompt>$</prompt> <userinput>make html</userinput> 
    115 </screen> 
    116 </para> 
    117 </sect2> 
    118 <sect2 xml:id="rundemo1_see"> 
    119 <title>Look to outputs</title> 
    120 <para> 
    121 Choose your favorite browser supporting PHP files and  
    122 open <filename>/tmp/superbib/one/en/main.php</filename>. 
    123 </para> 
    124 </sect2> 
    125 <sect2 xml:id="rundemo1_conclusion"> 
    126 <title>Ok ?</title> 
    127 <para> 
    128 If something went wrong please send an email to  
    129 <email>&project_min;-dev@forge.ipsl.jussieu.fr</email> 
    130 with output errors  
    131 </para> 
    132 </sect2> 
    133116<!-- ++ installation et check --> 
    134117<!-- ++ autre demo à partir d'un fichier bibtex ou autre --> 
    135118<!-- ++ ++ comment partir de scratch --> 
    136 </sect1> 
    137  
    138 </chapter> 

  • trunk/docs/docs_users/source/guides/get.rst

    r137 r140  
    1 <?xml version="1.0" encoding="ISO-8859-1"?> 
    2 <!DOCTYPE chapter [ 
    3 <!ENTITY % isolat1 SYSTEM "http://www.w3.org/2003/entities/iso8879/isolat1.ent"> 
    4 %isolat1; 
    5 <!ENTITY % isolat2 SYSTEM "http://www.w3.org/2003/entities/iso8879/isolat2.ent"> 
    6 %isolat2; 
    7 <!ENTITY % isogrk3 SYSTEM "http://www.w3.org/2003/entities/iso8879/isogrk3.ent"> 
    8 %isogrk3; 
    9 <!ENTITY % isopub SYSTEM "http://www.w3.org/2003/entities/iso8879/isopub.ent"> 
    10 %isopub; 
    11 <!ENTITY % isotech SYSTEM "http://www.w3.org/2003/entities/iso8879/isotech.ent"> 
    12 %isotech; 
    13 <!ENTITY % isonum SYSTEM "http://www.w3.org/2003/entities/iso8879/isonum.ent"> 
    14 %isonum; 
    15 <!ENTITY project "SUPERBIB"> 
    16 <!ENTITY project_svn "superbib"> 
    17 <!ENTITY szallsvn "+todo+ see get_pre.sh"> 
    18 ]> 
    19 <chapter version="5.0" 
    20 xmlns="http://docbook.org/ns/docbook" 
    21 xmlns:xl="http://www.w3.org/1999/xlink" 
    22 xmlns:xi="http://www.w3.org/2001/XInclude" 
    23 xml:lang="en" 
    24 xml:id="get"> 
     1.. DESCRIPTION 
     2.. =========== 
     3..  
     4..  
     5.. SEE ALSO 
     6.. ======== 
     7..  
     8.. EVOLUTIONS 
     9.. ========== 
     10..  
     11.. $Id$ 
     12..  
     13.. $URL$ 
     14.. 
     15.. - fplod 20120227 
     16.. 
     17..   * migration to ReST 
     18..   * move in user documentation 
     19.. 
     20.. - fplod 20100428T103121Z aedon.locean-ipsl.upmc.fr (Darwin) 
     21..  
     22..   * form article to chapter 
    2523 
    26 <!-- 
     24.. _get: 
    2725 
    28 ======= 
    29 get.xml 
    30 ======= 
     26============= 
     27Get |project| 
     28============= 
    3129 
    32 How to get SUPERBIB ? 
     30.. _create_env: 
    3331 
    34 SEE ALSO 
    35 ======== 
     32Create |project| environment 
     33============================ 
    3634 
    37 get_pre.sh_ 
     35To simplify the explanation, we suppose that we install |project| in your  
     36:file:`${HOME}/SUPERBIB/` : 
    3837 
    39 .. _get_pre.sh: get_pre.sh.html 
     38.. code-block:: sh 
    4039 
    41 EVOLUTIONS 
     40   $ cd ${HOME} 
     41   $ mkdir SUPERBIB/ 
     42 
     43.. _get_files 
     44 
     45Get |project| files 
     46=================== 
     47 
     48.. _local: 
     49 
     50If you work on LOCEAN systems 
     51+++++++++++++++++++++++++++++ 
     52 
     53The latest operational release |project| is already installed at 
     54 
     55 - LOCEAN: :file:`/usr/home/fplod/SUPERBIB/` 
     56 
     57If you can access to this directory, there is no need to re-install |project|  
     58again!  
     59 
     60In that case, you only have to link :file:`${HOME}/SUPERBIB/` to the  
     61appropriate directory: 
     62  LOCEAN 
     63 
     64  .. code-block:: sh 
     65 
     66     $ ln -s /usr/home/fplod/SUPERBIB ${HOME}/SUPERBIB 
     67 
     68.. _svn: 
     69 
     70If Subversion (:samp:`svn`) client is installed on your machine 
     71+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 
     72 
     73.. _svn_users: 
     74 
     75Regular users 
     76~~~~~~~~~~~~~ 
     77 
     78The **complete** latest revision 
     79can be checked out with the following command executed in your  
     80:envvar:`${HOME}` : 
     81 
     82.. code-block:: sh 
     83 
     84   $ svn checkout http://forge.ipsl.jussieu.fr/superbib/svn/trunk/ SUPERBIB 
     85 
     86.. _svn_contributors: 
     87 
     88Contributors 
     89~~~~~~~~~~~~ 
     90 
     91**Contributors** should better use the following command (and replace login by their own login) : 
     92 
     93.. code-block:: sh 
     94 
     95   $ svn checkout svn+ssh://login@forge.ipsl.jussieu.fr/ipsl/forge/projets/superbib/svn/trunk/ SUPERBIB 
     96 
     97.. _afterget: 
     98 
     99After this 
    42100========== 
    43101 
    44 $Id$ 
    45  
    46  
    47 - fplod 20100428T103121Z aedon.locean-ipsl.upmc.fr (Darwin) 
    48  
    49   * form article to chapter 
    50 --> 
    51  
    52   <title>Get <application>&project;</application></title> 
    53  
    54   <info> 
    55    <pubdate>$Id$</pubdate> 
    56   </info> 
    57  
    58  
    59   <sect1 xml:id="create_env"> 
    60     <title> Create <application>&project;</application> environment </title> 
    61     <para> 
    62       To simplify the explanation, we suppose that we install <application>&project;</application> in your <filename class='directory'>${HOME}/&project;_ws/</filename> (<quote>ws</quote> for <quote>working space</quote>). 
    63     </para> 
    64     <para> 
    65       <screen> 
    66   <prompt>$</prompt> <userinput><command>cd</command> <parameter>${HOME}</parameter></userinput> 
    67   <prompt>$</prompt> <userinput><command>mkdir</command> <parameter>&project;_ws/</parameter></userinput> 
    68       </screen> 
    69     </para> 
    70   </sect1> 
    71  
    72  
    73  <sect1 xml:id="get_files"> 
    74     <title> Get <application>&project;</application> files </title> 
    75  
    76  
    77     <sect2 xml:id="local"> 
    78       <title> If you work on LOCEAN systems</title> 
    79       <para> 
    80 The latest operational release <application>&project;</application> is already installed at 
    81 <itemizedlist> 
    82   <listitem> 
    83            <simpara>LOCEAN: <filename class='directory'>/usr/home/fplod/&project;_DIR/</filename> 
    84            </simpara> 
    85          </listitem> 
    86 </itemizedlist> 
    87 If you can access to this directory, there is no need to re-install <application>&project;</application> again!  
    88 In that case, you only have to link <filename class='directory'>${HOME}/&project;_DIR/</filename> to the appropriate directory: 
    89 <variablelist> 
    90   <varlistentry><term>LOCEAN</term> 
    91   <listitem><screen> 
    92   <prompt>$</prompt> <userinput><command>ln</command> <option>-s</option> <parameter>/usr/home/fplod/&project;_DIR</parameter> <parameter>${HOME}/&project;_DIR</parameter></userinput> 
    93   </screen> 
    94            </listitem> 
    95   </varlistentry> 
    96 </variablelist> 
    97       </para> 
    98     </sect2> 
    99  
    100  
    101     <sect2 xml:id="svn"> 
    102       <title> If <link xl:href="http://subversion.tigris.org/"><application> Subversion (svn)</application></link> client is installed on your machine </title> 
    103       <sect3 xml:id="svn_users"> 
    104 <title> Regular users </title> 
    105       <para> 
    106 The <emphasis role="bold">complete</emphasis> latest revision (source + tests data files: &szallsvn; Mb) can be checked out with the following command executed in your <envar>${HOME}</envar>: 
    107 <screen> 
    108   <prompt>$</prompt> <userinput><command>svn</command> <option>checkout</option> <parameter>http://forge.ipsl.jussieu.fr/&project_svn;/svn/trunk/</parameter> <parameter>&project;_DIR</parameter></userinput> 
    109 </screen> 
    110       </para> 
    111       </sect3> 
    112       <sect3 xml:id="svn_contributors"> 
    113 <title> Contributors </title> 
    114       <para> 
    115 <emphasis role="bold">Contributors</emphasis> should better use the following command (and replace login by their own login): 
    116 <screen > 
    117   <prompt>$</prompt> <userinput><command>svn</command> <option>checkout</option> <parameter>svn+ssh://<replaceable>login</replaceable>@forge.ipsl.jussieu.fr/ipsl/forge/projets/&project_svn;/svn/trunk/</parameter> <parameter>&project;_DIR</parameter></userinput> 
    118 </screen> 
    119       </para> 
    120       </sect3> 
    121     </sect2> 
    122  
    123  
    124 <!-- ++ not yet 
    125     <sect2 xml:id="tar"> 
    126       <title> Get <application>&project;</application> from a tar file </title> 
    127       <sect3 xml:id="src_tar"> 
    128 <title> Get <application>&project;</application> source files (&szsrc; Mb) </title> 
    129 <para> 
    130   Create your <filename class='directory'>${HOME}/&project;_DIR</filename> directory &hellip; 
    131   <screen> 
    132   <prompt>$</prompt> <userinput><command>cd</command> <parameter>${HOME}</parameter></userinput> 
    133   <prompt>$</prompt> <userinput><command>mkdir</command> <parameter>&project;_DIR</parameter></userinput> 
    134   <prompt>$</prompt> <userinput><command>cd</command> <parameter>&project;_DIR</parameter></userinput> 
    135   </screen> 
    136          </para> 
    137          <para> 
    138   &hellip; and download it the latest version of the sources tar file: <link xl:href="http://forge.ipsl.jussieu.fr/&project_svn;/download/&project;_SRC_&date;.tar.gz">&project;_SRC_&date;.tar.gz</link> (&szsrc; Mb). 
    139 </para> 
    140 <para> 
    141 This tar.gz file could also be downloaded with <command>wget</command> or <command>curl</command> 
    142 <variablelist> 
    143   <varlistentry><term><command>wget</command></term> 
    144   <listitem><screen> 
    145   <prompt>$</prompt> <userinput><command>wget</command> <parameter>http://forge.ipsl.jussieu.fr/&project_svn;/download/&project;_SRC_&date;.tar.gz</parameter></userinput> 
    146   </screen> 
    147            </listitem> 
    148   </varlistentry> 
    149   <varlistentry><term><command>curl</command></term> 
    150   <listitem><screen> 
    151   <prompt>$</prompt> <userinput><command>curl</command> <option>-O</option> <parameter>http://forge.ipsl.jussieu.fr/&project_svn;/download/&project;_SRC_&date;.tar.gz</parameter></userinput> 
    152   </screen> 
    153            </listitem> 
    154   </varlistentry> 
    155 </variablelist> 
    156 Untar the file 
    157 <screen> 
    158   <prompt>$</prompt> <userinput><command>cd</command> <parameter>${HOME}/&project;_DIR</parameter></userinput> 
    159   <prompt>$</prompt> <userinput><command>tar</command> <option>xvfz</option> <parameter>&project;_SRC_&date;.tar.gz</parameter></userinput> 
    160   <prompt>$</prompt> <userinput><command>rm</command> <parameter>&project;_SRC_&date;.tar.gz</parameter></userinput> 
    161 </screen> 
    162 </para> 
    163  
    164       </sect3> 
    165       <sect3 xml:id="data_tar"> 
    166 <title> Get <application>&project;</application> tests data files (&szdata; Mb) </title> 
    167 <para> 
    168 If you want to use the tests programs, you need to download the data tests files (<filename>&project;_DATA_&date2;.tar.gz</filename>), you may download theses files in 
    169 <itemizedlist> 
    170   <listitem> 
    171            <simpara><filename class='directory'>${HOME}/My_IDL</filename>. This is the easiest solution but it could be inconvenient if your <envar>${HOME}</envar> disk space is limited. 
    172            </simpara> 
    173           </listitem> 
    174 </itemizedlist> 
    175 <screen> 
    176   <prompt>$</prompt> <userinput><command>cd</command> <parameter>${HOME}</parameter></userinput> 
    177   <prompt>$</prompt> <userinput><command>mkdir</command> <parameter><replaceable>CHOSEN_DIR</replaceable></parameter></userinput> 
    178   <prompt>$</prompt> <userinput><command>cd</command> <parameter><replaceable>CHOSEN_DIR</replaceable></parameter></userinput> 
    179 </screen> 
    180 Download <link xl:href="http://forge.ipsl.jussieu.fr/&project_svn;/download/&project;_DATA_&date2;.tar.gz">&project;_DATA_&date2;.tar.gz</link> (&szdata; Mb) 
    181 or with <command>wget</command> or <command>curl</command> &hellip; 
    182 <variablelist> 
    183   <varlistentry><term><command>wget</command></term> 
    184   <listitem><screen> 
    185   <prompt>$</prompt> <userinput><command>wget</command> <parameter>http://forge.ipsl.jussieu.fr/&project_svn;/download/&project;_DATA_&date2;.tar.gz</parameter></userinput> 
    186    </screen> 
    187            </listitem> 
    188   </varlistentry> 
    189   <varlistentry><term><command>curl</command></term> 
    190   <listitem><screen> 
    191   <prompt>$</prompt> <userinput><command>curl</command> <option>-O</option> <parameter>http://forge.ipsl.jussieu.fr/&project_svn;/download/&project;_DATA_&date2;.tar.gz</parameter></userinput> 
    192   </screen> 
    193             </listitem> 
    194   </varlistentry> 
    195 </variablelist> 
    196 </para> 
    197       </sect3> 
    198     </sect2> 
    199 --> 
    200   </sect1> 
    201 <sect1 xml:id="afterget"> 
    202 <title>After this</title> 
    203 <para> 
    204 You are now ready to do your 
    205 <link xl:href="./firststeps.html">First steps with &project;</link>. 
    206 </para> 
    207 </sect1> 
    208 </chapter> 
     102You are now ready to do your :ref:`firststeps`. 

  • trunk/docs/docs_users/source/overview.rst

    r138 r140  
    2424.. - 
    2525 
     26.. _overview: 
     27 
     28=================== 
    2629What is |project| ? 
     30=================== 
    2731 
    28 |project| is dedicated to bibliography and users of a project &hellip;  
     32|project| is dedicated to bibliography and users of a project. 
    2933 
    3034Imagine you want to know how many publications have been written using your tools or your results : |project| is for you ! 
    … …  
    3236Using a XML/DocBook bibliography file, you will be able to produce 
    3337HTML and PHP files to see : 
     38 
    3439 * All publications, 
    3540 * publications sorted by years with a graph, 
    … …  
    3944 * forms to help authors to update the bibliography. 
    4045 
    41 As <link xl:href="http://www.docbook.org/tdg5/en/html/">XML/DocBook</link> 
    42 bibliography is not very popular, |project| allows you to convert flat bibliography information (using copy/paste on an existing website for example) or <literal>bibtex</literal> into this format. 
     46As unfortunately |xmldbk| 
     47bibliography is not very popular, |project| allows you to convert flat bibliography information (using copy/paste on an existing website for example) or :samp:`bibtex` into this format. 
    4348 
    4449No database is involved in the process. HTML and PHP files just have to be  
Note: See TracChangeset for help on using the changeset viewer.