Changeset 103


Ignore:
Timestamp:
Sep 25, 2009 6:19:24 PM (10 years ago)
Author:
prjemian
Message:

more documentation, refs #19

Location:
1dwg/trunk/doc
Files:
5 edited

Legend:

Unmodified
Added
Removed
  • 1dwg/trunk/doc/Makefile

    r93 r103  
    2323RELEASE = 1.0 
    2424TARGET = cansas-1d-$(RELEASE)-Manual.pdf 
     25TARGET = manual.pdf 
    2526 
    2627CLEANING_LIST += $(TARGET) 
  • 1dwg/trunk/doc/bindings.xml

    r101 r103  
    2020    <xi:include href="cansas1d_binding_Fortran.xml"/> 
    2121    <xi:include href="cansas1d_binding_IgorPro.xml"/> 
     22    <xi:include href="cansas1d_binding_Java.xml"/> 
    2223</chapter> 
  • 1dwg/trunk/doc/cansas1d_binding_IgorPro.xml

    r102 r103  
    3232        (including any renaming of waves as desired).  
    3333    </para></note> 
    34     <para> 
    35         <table> 
    36             <title>Current status of IgorPro support</title> 
    37             <tgroup cols="2"> 
    38                 <tbody> 
    39                     <row> 
    40                         <entry> file </entry> 
    41                         <entry> 
    42                             <link 
    43                                 xlink:href="http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/IgorPro/cansasXML.ipf" 
    44                                     ><citetitle>cansasXML.ipf</citetitle></link> 
    45                         </entry> 
    46                     </row> 
    47                     <row> 
    48                         <entry> author </entry> 
    49                         <entry> Pete R. Jemian &lt;jemian@anl.gov&gt; 
    50                         </entry> 
    51                     </row> 
    52                     <row> 
    53                         <entry> date </entry> 
    54                         <entry>2009-09-02</entry> 
    55                     </row> 
    56                     <row> 
    57                         <entry> version </entry> 
    58                         <entry> 1.11 (<emphasis role="bold">requires</emphasis> latest XMLutils XOP 
    59                             -- see below) </entry> 
    60                     </row> 
    61                     <row> 
    62                         <entry> purpose </entry> 
    63                         <entry> implement an IgorPro file reader to read the canSAS 1-D reduced SAS 
    64                             data in XML files adheres to the cansas1d/1.0 standard: 
    65                             http://www.smallangles.net/wgwiki/index.php/cansas1d_documentation 
    66                         </entry> 
    67                     </row> 
    68                     <row> 
    69                         <entry> URL </entry> 
    70                         <entry> TRAC: 
    71                             http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/IgorPro/cansasXML.ipf 
    72                             SVN: 
    73                             http://svn.smallangles.net/svn/canSAS/1dwg/trunk/IgorPro/cansasXML.ipf 
    74                         </entry> 
    75                     </row> 
    76                     <row> 
    77                         <entry> requires </entry> 
    78                         <entry> IgorPro: http://www.wavemetrics.com XMLutils - XOP: 
    79                             http://www.igorexchange.com/project/XMLutils (IGOR.5.04.x-1.x-dev, 
    80                             2008-Aug-22) </entry> 
    81                     </row> 
    82                 </tbody> 
    83             </tgroup> 
    84         </table></para> 
     34    <glosslist> 
     35        <glossentry> 
     36            <glossterm>file</glossterm> 
     37            <glossdef> 
     38                <para><link 
     39                    xlink:href="http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/IgorPro/cansasXML.ipf" 
     40                    ><citetitle>cansasXML.ipf</citetitle></link></para> 
     41            </glossdef> 
     42        </glossentry> 
     43        <glossentry> 
     44            <glossterm>author</glossterm> 
     45            <glossdef><para>Pete R. Jemian &lt;jemian@anl.gov&gt;</para></glossdef> 
     46        </glossentry> 
     47        <glossentry> 
     48            <glossterm>date</glossterm> 
     49            <glossdef><para>2009-09-02</para></glossdef> 
     50        </glossentry> 
     51        <glossentry> 
     52            <glossterm>version</glossterm> 
     53            <glossdef><para>1.11 (<emphasis role="bold">requires</emphasis>  
     54                latest XMLutils XOP -- see below)</para></glossdef> 
     55        </glossentry> 
     56        <glossentry> 
     57            <glossterm>purpose</glossterm> 
     58            <glossdef><para>implement an IgorPro file reader to read the canSAS 1-D reduced SAS 
     59                data in XML files adheres to the cansas1d/1.0 standard: 
     60                http://www.smallangles.net/wgwiki/index.php/cansas1d_documentation</para></glossdef> 
     61        </glossentry> 
     62        <glossentry> 
     63            <glossterm>URL</glossterm> 
     64            <glossdef> 
     65                <para> 
     66                  TRAC: 
     67                  http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/IgorPro/cansasXML.ipf 
     68                </para> 
     69                <para> 
     70                  SVN: 
     71                  http://svn.smallangles.net/svn/canSAS/1dwg/trunk/IgorPro/cansasXML.ipf 
     72                </para> 
     73            </glossdef> 
     74        </glossentry> 
     75        <glossentry> 
     76            <glossterm>requires</glossterm> 
     77            <glossdef><para> 
     78                IgorPro: http://www.wavemetrics.com XMLutils - XOP: 
     79                http://www.igorexchange.com/project/XMLutils (IGOR.5.04.x-1.x-dev, 
     80                2008-Aug-22) 
     81            </para></glossdef> 
     82        </glossentry> 
     83    </glosslist> 
    8584    <section> 
    8685        <title>Checkout of support code in Subversion</title> 
  • 1dwg/trunk/doc/manual.xml

    r95 r103  
    3131            <email>jemian@anl.gov</email> 
    3232        </author> 
     33        <edition>CanSAS 1-D Data Format Manual, v1.0</edition> 
     34        <pubdate>2009</pubdate> 
     35        <legalnotice> 
     36            <para> 
     37                Not yet licensed.  Intended for unrestricted public domain use. 
     38            </para> 
     39        </legalnotice> 
     40        <revhistory> 
     41            <revision> 
     42                <revnumber>v1.0</revnumber> 
     43                <date>2009-09-25</date> 
     44                <authorinitials>PRJ</authorinitials> 
     45                <revremark>converted from mediawiki to DocBook/5.0</revremark> 
     46            </revision> 
     47        </revhistory> 
    3348    </info> 
    3449    <preface> 
Note: See TracChangeset for help on using the changeset viewer.