Changeset 142 for 1dwg


Ignore:
Timestamp:
Oct 10, 2009 1:38:08 AM (11 years ago)
Author:
prjemian
Message:

manual ready for review by 1dwg, equations still not converted properly but intent is readable, fixes #19

Location:
1dwg/trunk/doc
Files:
1 added
10 edited
21 moved

Legend:

Unmodified
Added
Removed

  • 1dwg/trunk/doc/src/binding_Fortran.xml

    r140 r142  
    1515    xmlns:xlink="http://www.w3.org/1999/xlink"> 
    1616    <title>Fortran binding</title> 
    17     <bridgehead> 
    18         $Revision$ 
    19         $Date$ 
    20     </bridgehead> 
    2117    <para> 
    2218        The development of the FORTRAN language,  

  • 1dwg/trunk/doc/src/binding_IgorPro.xml

    r140 r142  
    1818        <secondary>IgorPro</secondary> 
    1919    </indexterm> 
    20     <bridgehead> 
    21         $Revision$ 
    22         $Date$ 
    23     </bridgehead> 
    2420    <para>An import tool (binding) for IgorPro has been created (cansasXML.ipf). You can check out 
    2521        the IgorPro working directory from the SVN server (see instructions below). </para> 
    26     <para>To use the canSASxml.ipf procedure, you must have the XMLutils XOP IGOR plugin installed. 
     22    <para> 
     23        To use the <literal>canSASxml.ipf</literal> procedure,  
     24        you must have the XMLutils XOP IGOR plugin installed. 
    2725        See the Usage Notes below. </para> 
    2826    <note><para>Note that this tool is not a true  
    … …  
    8381            <glossterm>requires</glossterm> 
    8482            <glossdef><para> 
    85                 IgorPro: http://www.wavemetrics.com XMLutils - XOP: 
    86                 http://www.igorexchange.com/project/XMLutils (IGOR.5.04.x-1.x-dev, 
    87                 2008-Aug-22) 
     83                IgorPro: http://www.wavemetrics.com  
     84                <link xlink:href="http://www.igorexchange.com/project/XMLutils" 
     85                    ><literal 
     86                        >XMLutils XOP</literal></link><footnote><para> 
     87                            <link xlink:href="http://www.igorexchange.com/project/XMLutils" 
     88                                ><literal 
     89                                    >http://www.igorexchange.com/project/XMLutils</literal></link> 
     90                        </para></footnote> 
     91                <indexterm significance="preferred"> 
     92                    <primary>IgorPro package</primary> 
     93                    <secondary>XMLutils XOP</secondary> 
     94                </indexterm> 
     95                (minimum requirement: IGOR.5.04.x-1.x-dev, 2008-Aug-22) 
    8896            </para></glossdef> 
    8997        </glossentry> 
    … …  
    101109                <indexterm><primary>XMLutils XOP</primary></indexterm> 
    102110                written by Andrew Nelson (ANSTO),  
    103                 is hosted on the IgorExchange. 
    104                 <footnote> 
     111                is hosted on the IgorExchange.<footnote> 
    105112                    <para> 
    106113                        <literal>http://www.igorexchange.com/</literal> 
    … …  
    109116            </para> 
    110117            <para> One good location to place the checked out XMLutils directory is in the 
    111                 Wavemetrics directory, next to the Igor Pro Folder. 
    112                 <footnote> 
     118                Wavemetrics directory, next to the Igor Pro Folder.<footnote> 
    113119                    <para> 
    114120                        <literal>svn co svn://svn.igorexchange.com/packages/XMLutils/ XMLutils</literal> 
    … …  
    173179            <listitem> 
    174180                <para> Download cansasXML.ipf. Either checkout from subversion (see above) or, with 
    175                     a web browser, copy cansasXML.ipf from the on-line subversion repository. 
    176                     <footnote> 
     181                    a web browser, copy cansasXML.ipf from the on-line subversion  
     182                    repository.<footnote> 
    177183                        <para> 
    178184                    http://svn.smallangles.net/svn/canSAS/1dwg/trunk/IgorPro/cansasXML.ipf 
    … …  
    682688    <section> 
    683689        <title>Example test case</title> 
    684         <para> Here is an example running the test routine <emphasis role="bold" 
    685             >prjTest_cansas1d()</emphasis>. 
    686             <programlisting> 
     690        <para> Here is an example running the test routine <literal>prjTest_cansas1d()</literal>. 
     691            <programlisting linenumbering="numbered"> 
    687692•prjTest_cansas1d() 
    688693XMLopenfile: File(path) to open doesn't exist, or file can't be opened 
    … …  
    783788                <link  
    784789                    xlink:href="http://usaxs.xor.aps.anl.gov/staff/ilavsky/irena.htm" 
    785                     ><emphasis role="bold">Irena</emphasis></link> 
    786                 <footnote> 
    787                     <para>http://usaxs.xor.aps.anl.gov/staff/ilavsky/irena.htm</para> 
     790                    ><emphasis role="bold">Irena</emphasis></link><footnote> 
     791                    <para> 
     792                        <link xlink:href="http://usaxs.xor.aps.anl.gov/staff/ilavsky/irena.htm" 
     793                            ><literal 
     794                                >http://usaxs.xor.aps.anl.gov/staff/ilavsky/irena.htm</literal></link> 
     795                    </para> 
    788796                </footnote> 
    789                 <indexterm> 
    790                     <primary>Irena tool suite</primary> 
     797                <indexterm significance="preferred"> 
     798                    <primary>IgorPro package</primary> 
     799                    <secondary>Irena tool suite</secondary> 
    791800                </indexterm> 
    792801                tool suite for IgorPro has a GUI to 

  • 1dwg/trunk/doc/src/binding_Java.xml

    r140 r142  
    1414    version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink"> 
    1515    <title>Java JAXB binding</title> 
    16     <bridgehead> 
    17         $Revision$ 
    18         $Date$ 
    19     </bridgehead> 
    2016    <para> 
    2117        Documentation for the JAXB binding 
    … …  
    2622        is spotty at this time. 
    2723        You can check it out with subversion: 
    28         <programlisting>svn checkout http://svn.smallangles.net/svn/canSAS/1dwg/trunk cansas-1d-standard</programlisting> 
     24        <example> 
     25            <title>Check out main trunk using subversion.</title> 
     26            <programlisting 
     27                >svn checkout http://svn.smallangles.net/svn/canSAS/1dwg/trunk cansas1d</programlisting> 
     28        </example> 
    2929        (where cansas-1d-standard is a local directory name). 
    3030    </para> 
    … …  
    6868        <para> 
    6969            Here is a Java class that shows how to use the JAXB binding. 
     70            <indexterm> 
     71                <primary>Java file</primary> 
     72                <secondary>JAXB_cansas1d_reader.java</secondary> 
     73            </indexterm> 
    7074            Use this with any of the test data supplied with the cansas-1d-standard directory (above). 
    71             By default, it shows what is in the <emphasis>1998spheres.xml</emphasis> example file: two samples. 
     75            By default, it shows the two samples in the <literal>1998spheres.xml</literal> example  
     76            file.<footnote><para><link  
     77                xlink:href="http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/1998spheres.xml" 
     78                ><literal 
     79                    >http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/1998spheres.xml</literal 
     80                ></link></para></footnote> 
     81            <indexterm> 
     82                <primary>XML file</primary> 
     83                <secondary>1998spheres.xml</secondary> 
     84            </indexterm> 
    7285            (You'll have to get the directory paths right until this documentation improves.) 
    7386        </para> 
    … …  
    7992        <para> 
    8093            Look for the line that has  
    81             <literal>Qsas[i] = sdt.getIdata().get(i).getQ().getValue();</literal>  
    82             to see the operations to unwind the data into usable double[] vectors.  
     94            <informalexample> 
     95                <programlisting>Qsas[i] = sdt.getIdata().get(i).getQ().getValue();</programlisting> 
     96            </informalexample> 
     97            to see the operations that unwind the data into usable double[] vectors.  
    8398            Pretty straightforward. 
    8499        </para> 
    … …  
    92107        <section> 
    93108            <title>GetSASdata.java</title> 
     109            <indexterm> 
     110                <primary>Java file</primary> 
     111                <secondary>GetSASdata.java</secondary> 
     112            </indexterm> 
    94113            <programlisting language="java" linenumbering="numbered"><textobject><textdata 
    95114                fileref="GetSASdata.java"/></textobject></programlisting> 
    … …  
    97116        <section> 
    98117            <title>java-test.xml</title> 
    99             <para> 
    100                 Ok, better to use SVN/TRAC for these files. This example will be improved but it proves the point. 
    101             </para> 
     118            <indexterm> 
     119                <primary>XML file</primary> 
     120                <secondary>java-test.xml</secondary> 
     121            </indexterm> 
     122            <note> 
     123                <para> 
     124                    Ok, better to use SVN/TRAC for these files.  
     125                    This example could be improved but it proves the point. 
     126                    This file is too long for the manual. 
     127                </para> 
     128            </note> 
    102129            <programlisting language="xml" linenumbering="numbered"><textobject><textdata 
    103130                fileref="java-test.xml"/></textobject></programlisting> 

  • 1dwg/trunk/doc/src/binding_Python.xml

    r140 r142  
    1414    version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink"> 
    1515    <title>Python binding</title> 
    16     <bridgehead> 
    17         $Revision$ 
    18         $Date$ 
    19     </bridgehead> 
    2016    <para> 
    2117        Specific <link xlink:href="http://danse.us/trac/sans"><citetitle>support</citetitle></link>  
    … …  
    3228    <para> 
    3329        Here are some terse instructions to get you started: 
    34         <programlisting>svn co http://danse.us/trac/sans/browser/trunk/DataLoader DataLoader 
     30        <example> 
     31            <title></title> 
     32            <programlisting 
     33                >svn co http://danse.us/trac/sans/browser/trunk/DataLoader DataLoader 
    3534cd DataLoader 
    3635python setup.py install</programlisting> 
    37         The <link xlink:href="http://danse.us/trac/sans/browser/trunk/DataLoader/release_notes.txt"><citetitle>release notes</citetitle></link> have a list of the dependencies. 
     36        </example> 
     37        The <link xlink:href="http://danse.us/trac/sans/browser/trunk/DataLoader/release_notes.txt" 
     38            ><citetitle>release notes</citetitle></link> have a list of the dependencies. 
    3839    </para> 
    39     <section><title>Comments</title> 
     40    <section> 
     41        <title>Comments</title> 
    4042        <para> 
    4143            Other constructive suggestions (that predate the NIST/NCNR support) have been gathered on this page. 
    4244        </para>     
    4345    </section> 
    44     <section><title>gnosis.xml.objectify</title> 
     46    <section> 
     47        <title>gnosis.xml.objectify</title> 
    4548        <para> 
    4649            The <link xlink:href="http://freshmeat.net/projects/gnosisxml/">GnosisUtils</link>  
    … …  
    6669                You may also need sysAdmin privileges.  
    6770                You may need ... 
    68                 <programlisting>cd /tmp 
     71                <example> 
     72                    <title>Gnosis installation instructions</title> 
     73                <programlisting linenumbering="numbered" 
     74                    >cd /tmp 
    6975wget http://freshmeat.net/redir/gnosisxml/22028/url_tgz/Gnosis_Utils-1.2.2.tar.gz 
    7076tar xzf Gnosis_Utils-1.2.2.tar.gz  
    7177cd Gnosis_Utils-1.2.2/ 
    7278python setup.py install_all</programlisting> 
     79                </example> 
    7380            </para> 
    7481        </section> 
    … …  
    7683            <para> 
    7784                Here is the Python code (without all that output)  
    78                 (called <emphasis>python-test.py</emphasis>): 
    79                 <programlisting> 
    80 import gnosis.xml.objectify 
     85                (called <literal>python-test.py</literal>): 
     86                <indexterm> 
     87                    <primary>Python file</primary> 
     88                    <secondary>python-test.py</secondary> 
     89                </indexterm> 
     90                <example> 
     91                    <title>python-test.py</title> 
     92                <programlisting linenumbering="numbered" 
     93                    >import gnosis.xml.objectify 
    8194 
    8295sasxml = gnosis.xml.objectify.XML_Objectify('bimodal-test1.xml').make_instance()   
    … …  
    8699print sasxml.SASentry.SASdata.Idata[0].Q.unit,  sasxml.SASentry.SASdata.Idata[0].I.unit 
    87100print sasxml.SASentry.SASdata.Idata[0].Q.PCDATA,  sasxml.SASentry.SASdata.Idata[0].I.PCDATA,  sasxml.SASentry.SASdata.Idata[0].Idev.PCDATA</programlisting> 
    88             </para>             
    89         </section> 
    90         <section> 
    91             <title>execution of that Python code</title> 
    92             <para> 
    93                 <programlisting>[Pete@regitte,2441,cansas1dwg-regitte]$ ./python-test.py  
     101                </example> 
     102            </para> 
     103                <example> 
     104                    <title>output from <literal>python-test.py</literal></title> 
     105                    <programlisting linenumbering="numbered" 
     106                        >[Pete@regitte,2441,cansas1dwg-regitte]$ ./python-test.py  
    94107SAS bimodal test1 
    951081992 
    … …  
    971101/A 1/cm 
    981110.0040157139 3497.473 90.72816 
    99                 </programlisting> 
    100             </para> 
    101         </section> 
    102         <section> 
     112                    </programlisting> 
     113                </example> 
     114        <example> 
    103115            <title>full session output</title> 
    104             <programlisting>[Pete@regitte,2429,/tmp]$ cd /tmp 
     116            <programlisting linenumbering="numbered" 
     117                >[Pete@regitte,2429,/tmp]$ cd /tmp 
    105118/tmp 
    106119[Pete@regitte,2430,/tmp]$ wget http://freshmeat.net/redir/gnosisxml/22028/url_tgz/Gnosis_Utils-1.2.2.tar.gz 
    … …  
    145158>>> print sasxml.SASentry.SASdata.Idata[0].Q.PCDATA,  sasxml.SASentry.SASdata.Idata[0].I.PCDATA,  sasxml.SASentry.SASdata.Idata[0].Idev.PCDATA 
    1461590.0040157139 3497.473 90.72816</programlisting> 
    147         </section> 
    148         <section><title>Conclusion: OK</title> 
    149             <para> 
    150                 This has the promise of being a useful approach to reading this format in Python.Now, how to write back out... ? 
     160        </example> 
     161        </section> 
     162        <section> 
     163            <title>Conclusion: OK</title> 
     164            <para> 
     165                This has the promise of being a useful approach to reading this format in Python. 
     166                Now, how to write back out... ? 
    151167            </para> 
    152168        </section> 
    … …  
    159175            Python data structure) for Python from an XML Schema. 
    160176            However, the cansas1d/1.0 XML schema (cansas1d.xsd) does not seem to  
    161             fit the model.It seems, for now, that <emphasis>generateDS-1.12a</emphasis>  
    162             fails on a certain <emphasis>annotate</emphasis> line. 
    163             <programlisting>[Pete@regitte,2402,cansas1dwg-regitte]$ python ~/generateDS-1.12a/generateDS.py -p CS1D_ -o cansas1d.py -s cansas1dsubs.py cansas1d.xsd 
     177            fit the model.It seems, for now, that <literal>generateDS-1.12a</literal>  
     178            fails on a certain <literal>annotate</literal> line. 
     179            <programlisting linenumbering="numbered" 
     180                >[Pete@regitte,2402,cansas1dwg-regitte]$ python ~/generateDS-1.12a/generateDS.py -p CS1D_ -o cansas1d.py -s cansas1dsubs.py cansas1d.xsd 
    164181Traceback (most recent call last): 
    165182  File "/home/Pete/generateDS-1.12a/generateDS.py", line 3997, in &lt;module> 

  • 1dwg/trunk/doc/src/bindings.xml

    r127 r142  
    1818        have been created and contributed.  These are listed here by the  
    1919        language or software environment.</para> 
    20     <xi:include href="cansas1d_binding_Fortran.xml"/> 
    21     <xi:include href="cansas1d_binding_IgorPro.xml"/> 
    22     <xi:include href="cansas1d_binding_Java.xml"/> 
    23     <xi:include href="cansas1d_binding_Python.xml"/> 
     20    <xi:include href="binding_Fortran.xml"/> 
     21    <xi:include href="binding_IgorPro.xml"/> 
     22    <xi:include href="binding_Java.xml"/> 
     23    <xi:include href="binding_Python.xml"/> 
    2424</chapter> 

  • 1dwg/trunk/doc/src/casestudies.xml

    r138 r142  
    1313    xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"> 
    1414    <title>Case Studies</title> 
    15     <xi:include href="cansas1d_casestudy_collagen.xml"/> 
    16     <xi:include href="cansas1d_casestudy_af1410.xml"/> 
     15    <xi:include href="casestudy_collagen.xml"/> 
     16    <xi:include href="casestudy_af1410.xml"/> 
    1717</section> 

  • 1dwg/trunk/doc/src/casestudy_af1410.xml

    r140 r142  
    1414    version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink"> 
    1515    <title>Case Study: AF1410 steel</title> 
    16     <bridgehead> $Revision$ $Date$ </bridgehead> 
    1716    <section> 
    18         <indexterm significance="preferred"> 
    19             <primary>case study</primary> 
    20             <secondary>SANS of AF1410 steel</secondary> 
    21         </indexterm> 
    2217        <title>Overview</title> 
    2318        <note> 
    … …  
    2924            </para> 
    3025            <para>  
     26                <indexterm significance="preferred"> 
     27                    <primary>case study</primary> 
     28                    <secondary>SANS of AF1410 steel</secondary> 
     29                </indexterm> 
    3130                The data file contains multiple SASentry elements that pertain to different samples 
    3231                treated at different conditions in a time series.  Each SASentry element contains two 

  • 1dwg/trunk/doc/src/casestudy_collagen.xml

    r140 r142  
    1414    version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink"> 
    1515    <title>Case Study: Dry Chick Collagen</title> 
    16     <bridgehead> $Revision$ $Date$ </bridgehead> 
    1716    <section> 
    1817        <title>Overview</title> 
    … …  
    2827            Malcolm Capel, NSLS beam line X12C for the sample.) </para> 
    2928        <para> 
    30             <table> 
    31                 <title>Figures for dry chick collagen case study</title> 
     29            <informaltable> 
     30                <!--<title>Figures for dry chick collagen case study</title>--> 
    3231                <tgroup cols="2"> 
    3332                    <tbody> 
    … …  
    4140                                    </imageobject> 
    4241                                    <caption> 
    43                                         <para>case study: Collagen, SAXS data in Excel table</para> 
     42                                        <para>collagen SAXS in Excel table</para> 
    4443                                    </caption> 
    4544                                </mediaobject> 
    … …  
    5352                                    </imageobject> 
    5453                                    <caption> 
    55                                         <para>case study: Collagen, SAXS data in Excel chart</para> 
     54                                        <para>collagen SAXS in Excel chart (log-log)</para> 
    5655                                    </caption> 
    5756                                </mediaobject> 
    … …  
    6059                    </tbody> 
    6160                </tgroup> 
    62             </table> 
     61            </informaltable> 
    6362        </para> 
    6463        <para> The raw data  

  • 1dwg/trunk/doc/src/element_SAScollimation.xml

    r140 r142  
    1414    version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink"> 
    1515    <title>SAScollimation element</title> 
    16     <bridgehead> 
    17         $Revision$ 
    18         $Date$ 
    19     </bridgehead> 
    2016    <itemizedlist mark="opencircle"> 
    2117        <listitem> 
    … …  
    171167        <title>size</title> 
    172168        <para> 
    173             <table> 
    174                 <title/> 
     169            <informaltable> 
    175170                <tgroup cols='2'> 
    176171                    <tbody> 
    … …  
    207202                    </tbody> 
    208203                </tgroup> 
    209             </table> 
     204            </informaltable> 
    210205            <table orient="port" role="small"> 
    211206                <title/> 

  • 1dwg/trunk/doc/src/element_SASdata.xml

    r141 r142  
    1414    version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink"> 
    1515    <title>SASdata element</title> 
    16     <bridgehead> $Revision$ $Date$ </bridgehead> 
    1716    <itemizedlist mark="opencircle"> 
    1817        <indexterm significance="preferred"> 

  • 1dwg/trunk/doc/src/element_SASdetector.xml

    r140 r142  
    1414    version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink"> 
    1515    <title>SASdetector element</title> 
    16     <bridgehead> 
    17         $Revision$ 
    18         $Date$ 
    19     </bridgehead> 
    2016    <itemizedlist mark="opencircle"> 
    2117        <indexterm significance="preferred"> 
    … …  
    204200        <title>geometry</title> 
    205201        <para> 
    206             <table> 
    207                 <title/> 
     202            <informaltable> 
    208203                <tgroup cols='2'> 
    209204                    <tbody> 
    … …  
    249244                </row> 
    250245                </tbody></tgroup> 
    251             </table> 
     246            </informaltable> 
    252247        </para> 
    253248    </section> 

  • 1dwg/trunk/doc/src/element_SASentry.xml

    r140 r142  
    1414    version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink"> 
    1515    <title>SASentry element</title> 
    16     <bridgehead> 
    17         $Revision$ 
    18         $Date$ 
    19     </bridgehead> 
    2016    <itemizedlist mark="opencircle"> 
    2117        <listitem> 

  • 1dwg/trunk/doc/src/element_SASinstrument.xml

    r140 r142  
    1414    version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink"> 
    1515    <title>SASinstrument element</title> 
    16     <bridgehead> 
    17         $Revision$ 
    18         $Date$ 
    19     </bridgehead> 
    2016    <itemizedlist mark="opencircle"> 
    2117        <listitem> 

  • 1dwg/trunk/doc/src/element_SASnote.xml

    r140 r142  
    1414    version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink"> 
    1515    <title>SASnote element</title> 
    16     <bridgehead> 
    17         $Revision$ 
    18         $Date$ 
    19     </bridgehead> 
    2016    <itemizedlist mark="opencircle"> 
    2117        <listitem> 

  • 1dwg/trunk/doc/src/element_SASprocess.xml

    r141 r142  
    1414    version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink"> 
    1515    <title>SASprocess element</title> 
    16     <bridgehead> 
    17         $Revision$ 
    18         $Date$ 
    19     </bridgehead> 
    2016    <itemizedlist mark="opencircle"> 
    2117        <listitem> 

  • 1dwg/trunk/doc/src/element_SASroot.xml

    r140 r142  
    1414    version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink"> 
    1515    <title>SASroot element</title> 
    16     <bridgehead>  
    17                 $Revision$  
    18                 $Date$  
    19         </bridgehead> 
    2016    <itemizedlist mark="opencircle"> 
    2117        <listitem> 

  • 1dwg/trunk/doc/src/element_SASsample.xml

    r140 r142  
    1414    version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink"> 
    1515    <title>SASsample element</title> 
    16     <bridgehead> 
    17         $Revision$ 
    18         $Date$ 
    19     </bridgehead> 
    2016    <itemizedlist mark="opencircle"> 
    2117        <listitem> 
    … …  
    3632                <imagedata fileref="../../graphics/3-SASsample.png" width="200pt" scalefit="1"/> 
    3733            </imageobject> 
    38             <textobject> 
    39                 <phrase>cansas1d-v1-3-SASsample</phrase> 
    40             </textobject> 
    41             <caption> 
    42                 <para>The SASsample element</para> 
    43             </caption> 
    4434        </mediaobject> 
    4535    </figure> 
    … …  
    177167        <title>geometry</title> 
    178168        <para> 
    179             <table> 
    180                 <title/> 
     169            <informaltable> 
    181170                <tgroup cols="2"> 
    182171                    <tbody> 
    … …  
    215204                    </tbody> 
    216205                </tgroup> 
    217             </table> 
     206            </informaltable> 
    218207        </para> 
    219208    </section> 

  • 1dwg/trunk/doc/src/element_SASsource.xml

    r140 r142  
    1414    version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink"> 
    1515    <title>SASsource element</title> 
    16     <bridgehead> $Revision$ $Date$ </bridgehead> 
    1716    <itemizedlist mark="opencircle"> 
    1817        <listitem> 
    … …  
    3534                <phrase>cansas1d-v1-5-SASsource</phrase> 
    3635            </textobject> 
    37             <caption> 
    38                 <para>The SASsource element</para> 
    39             </caption> 
    4036        </mediaobject> 
    4137    </figure> 
    42     <section> 
    43         <title>SASsource</title> 
    44         <table orient="port" role="small"> 
    45             <title/> 
    46             <tgroup cols="5"> 
    47                 <colspec colname="c1" colwidth="15*"/> 
    48                 <colspec colname="c2" colwidth="15*"/> 
    49                 <colspec colname="c3" colwidth="10*"/> 
    50                 <colspec colname="c4" colwidth="30*"/> 
    51                 <colspec colname="c5" colwidth="30*"/> 
    52                 <tbody> 
    53                     <row> 
    54                         <entry><?dblatex bgcolor="[gray]{0.8}"?>Name</entry> 
    55                         <entry><?dblatex bgcolor="[gray]{0.8}"?>Type</entry> 
    56                         <entry><?dblatex bgcolor="[gray]{0.8}"?>Occurrence</entry> 
    57                         <entry><?dblatex bgcolor="[gray]{0.8}"?>Description</entry> 
    58                         <entry><?dblatex bgcolor="[gray]{0.8}"?>Attributes</entry> 
    59                     </row> 
    60                     <row> 
    61                         <entry> 
    62                             <literal>radiation</literal> 
    63                             <indexterm> 
    64                                 <primary>element</primary> 
    65                                 <secondary>radiation</secondary> 
    66                             </indexterm> 
    67                         </entry> 
    68                         <entry> string </entry> 
    69                         <entry> [1..1] </entry> 
    70                         <entry> 
    71                             <para> 
    72                                 Name of the radiation used. For maximum compatibility with NeXus, 
    73                                 use one of the names defined by either <link 
    74                                     xlink:href="http://www.nexusformat.org/NXsource" 
    75                                     ><citetitle>NeXus</citetitle> 
    76                                         <literal>NXsource/type</literal></link>  
    77                             </para> 
    78                             <itemizedlist> 
    79                                 <listitem><para>Spallation Neutron Source</para></listitem> 
    80                                 <listitem><para>Pulsed Reactor Neutron Source</para></listitem> 
    81                                 <listitem><para>Reactor Neutron Source</para></listitem> 
    82                                 <listitem><para>Synchrotron X-ray Source</para></listitem> 
    83                                 <listitem><para>Pulsed Muon Source</para></listitem> 
    84                                 <listitem><para>Rotating Anode X-ray</para></listitem> 
    85                                 <listitem><para>Fixed Tube X-ray</para></listitem> 
    86                             </itemizedlist> 
    87                             <para>  
    88                                 or <link 
    89                                     xlink:href="http://www.nexusformat.org/NXsource" 
    90                                     ><citetitle>NeXus</citetitle> 
    91                                     <literal>NXsource/probe</literal></link>  
    92                             </para> 
    93                             <itemizedlist> 
    94                                 <listitem><para>neutron</para></listitem> 
    95                                 <listitem><para>x-ray</para></listitem> 
    96                                 <listitem><para>muon</para></listitem> 
    97                                 <listitem><para>electron</para></listitem> 
    98                             </itemizedlist> 
    99                         </entry> 
    100                         <entry/> 
    101                     </row> 
    102                     <row> 
    103                         <entry> 
    104                             <literal>beam_size</literal> 
    105                             <indexterm> 
    106                                 <primary>element</primary> 
    107                                 <secondary>beam_size</secondary> 
    108                             </indexterm> 
    109                         </entry> 
    110                         <entry> container </entry> 
    111                         <entry> [0..1] </entry> 
    112                         <entry> Physical dimension of the beam (incident on the sample). Note: If 
    113                             beam is round, just use X dimension. Note: While Z dimension is allowed 
    114                             by the standard, it does not make sense for small-angle scattering. </entry> 
    115                         <entry><literal>name={name}</literal></entry> 
    116                     </row> 
    117                     <row> 
    118                         <entry> 
    119                             <literal>beam_shape</literal> 
    120                             <indexterm> 
    121                                 <primary>element</primary> 
    122                                 <secondary>beam_shape</secondary> 
    123                             </indexterm> 
    124                         </entry> 
    125                         <entry> string </entry> 
    126                         <entry> [0..1] </entry> 
    127                         <entry> Text description of the shape of the beam (incident on the sample). </entry> 
    128                         <entry/> 
    129                     </row> 
    130                     <row> 
    131                         <entry> 
    132                             <literal>wavelength</literal> 
    133                             <indexterm> 
    134                                 <primary>element</primary> 
    135                                 <secondary>wavelength</secondary> 
    136                             </indexterm> 
    137                         </entry> 
    138                         <entry> floating-point number </entry> 
    139                         <entry> [0..1] </entry> 
    140                         <entry>  
    141                             <para> 
    142                                 wavelength  
    143                                 (<inlineequation> 
    144                                     <mathphrase><alt>$\lambda$</alt></mathphrase> 
    145                                 </inlineequation>) 
    146                                 of radiation incident on the sample. 
    147                             </para> 
    148                         </entry> 
    149                         <entry><literal>unit={unit}</literal></entry> 
    150                     </row> 
    151                     <row> 
    152                         <entry> 
    153                             <literal>wavelength_min</literal> 
    154                             <indexterm> 
    155                                 <primary>element</primary> 
    156                                 <secondary>wavelength_min</secondary> 
    157                             </indexterm> 
    158                         </entry> 
    159                         <entry> floating-point number </entry> 
    160                         <entry> [0..1] </entry> 
    161                         <entry> Some facilities specify wavelength using a range. The minimum of 
    162                             such a range is given by wavelength_min. </entry> 
    163                         <entry><literal>unit={unit}</literal></entry> 
    164                     </row> 
    165                     <row> 
    166                         <entry> 
    167                             <literal>wavelength_max</literal> 
    168                             <indexterm> 
    169                                 <primary>element</primary> 
    170                                 <secondary>wavelength_max</secondary> 
    171                             </indexterm> 
    172                         </entry> 
    173                         <entry> floating-point number </entry> 
    174                         <entry> [0..1] </entry> 
    175                         <entry> Some facilities specify wavelength using a range. The maximum of 
    176                             such a range is given by wavelength_max. </entry> 
    177                         <entry><literal>unit={unit}</literal></entry> 
    178                     </row> 
    179                     <row> 
    180                         <entry> 
    181                             <literal>wavelength_spread</literal> 
    182                             <indexterm> 
    183                                 <primary>element</primary> 
    184                                 <secondary>wavelength_spread</secondary> 
    185                             </indexterm> 
    186                         </entry> 
    187                         <entry> floating-point number </entry> 
    188                         <entry> [0..1] </entry> 
    189                         <entry> Some facilities specify the width of the wavelength spectrum. The 
    190                             width of such a range is given by wavelength_spread. </entry> 
    191                         <entry><literal>unit={unit}</literal></entry> 
    192                     </row> 
    193                 </tbody> 
    194             </tgroup> 
    195         </table> 
    196     </section> 
     38    <table orient="port" role="small"> 
     39        <title/> 
     40        <tgroup cols="5"> 
     41            <colspec colname="c1" colwidth="15*"/> 
     42            <colspec colname="c2" colwidth="15*"/> 
     43            <colspec colname="c3" colwidth="10*"/> 
     44            <colspec colname="c4" colwidth="30*"/> 
     45            <colspec colname="c5" colwidth="30*"/> 
     46            <tbody> 
     47                <row> 
     48                    <entry><?dblatex bgcolor="[gray]{0.8}"?>Name</entry> 
     49                    <entry><?dblatex bgcolor="[gray]{0.8}"?>Type</entry> 
     50                    <entry><?dblatex bgcolor="[gray]{0.8}"?>Occurrence</entry> 
     51                    <entry><?dblatex bgcolor="[gray]{0.8}"?>Description</entry> 
     52                    <entry><?dblatex bgcolor="[gray]{0.8}"?>Attributes</entry> 
     53                </row> 
     54                <row> 
     55                    <entry> 
     56                        <literal>radiation</literal> 
     57                        <indexterm> 
     58                            <primary>element</primary> 
     59                            <secondary>radiation</secondary> 
     60                        </indexterm> 
     61                    </entry> 
     62                    <entry> string </entry> 
     63                    <entry> [1..1] </entry> 
     64                    <entry> 
     65                        <para> 
     66                            Name of the radiation used. For maximum compatibility with NeXus, 
     67                            use one of the names defined by either <link 
     68                                xlink:href="http://www.nexusformat.org/NXsource" 
     69                                ><citetitle>NeXus</citetitle> 
     70                                <literal>NXsource/type</literal></link>  
     71                        </para> 
     72                        <itemizedlist> 
     73                            <listitem><para>Spallation Neutron Source</para></listitem> 
     74                            <listitem><para>Pulsed Reactor Neutron Source</para></listitem> 
     75                            <listitem><para>Reactor Neutron Source</para></listitem> 
     76                            <listitem><para>Synchrotron X-ray Source</para></listitem> 
     77                            <listitem><para>Pulsed Muon Source</para></listitem> 
     78                            <listitem><para>Rotating Anode X-ray</para></listitem> 
     79                            <listitem><para>Fixed Tube X-ray</para></listitem> 
     80                        </itemizedlist> 
     81                        <para>  
     82                            or <link 
     83                                xlink:href="http://www.nexusformat.org/NXsource" 
     84                                ><citetitle>NeXus</citetitle> 
     85                                <literal>NXsource/probe</literal></link>  
     86                        </para> 
     87                        <itemizedlist> 
     88                            <listitem><para>neutron</para></listitem> 
     89                            <listitem><para>x-ray</para></listitem> 
     90                            <listitem><para>muon</para></listitem> 
     91                            <listitem><para>electron</para></listitem> 
     92                        </itemizedlist> 
     93                    </entry> 
     94                    <entry/> 
     95                </row> 
     96                <row> 
     97                    <entry> 
     98                        <literal>beam_size</literal> 
     99                        <indexterm> 
     100                            <primary>element</primary> 
     101                            <secondary>beam_size</secondary> 
     102                        </indexterm> 
     103                    </entry> 
     104                    <entry> container </entry> 
     105                    <entry> [0..1] </entry> 
     106                    <entry> Physical dimension of the beam (incident on the sample). Note: If 
     107                        beam is round, just use X dimension. Note: While Z dimension is allowed 
     108                        by the standard, it does not make sense for small-angle scattering. </entry> 
     109                    <entry><literal>name={name}</literal></entry> 
     110                </row> 
     111                <row> 
     112                    <entry> 
     113                        <literal>beam_shape</literal> 
     114                        <indexterm> 
     115                            <primary>element</primary> 
     116                            <secondary>beam_shape</secondary> 
     117                        </indexterm> 
     118                    </entry> 
     119                    <entry> string </entry> 
     120                    <entry> [0..1] </entry> 
     121                    <entry> Text description of the shape of the beam (incident on the sample). </entry> 
     122                    <entry/> 
     123                </row> 
     124                <row> 
     125                    <entry> 
     126                        <literal>wavelength</literal> 
     127                        <indexterm> 
     128                            <primary>element</primary> 
     129                            <secondary>wavelength</secondary> 
     130                        </indexterm> 
     131                    </entry> 
     132                    <entry> floating-point number </entry> 
     133                    <entry> [0..1] </entry> 
     134                    <entry>  
     135                        <para> 
     136                            wavelength  
     137                            (<inlineequation> 
     138                                <mathphrase><alt>$\lambda$</alt></mathphrase> 
     139                            </inlineequation>) 
     140                            of radiation incident on the sample. 
     141                        </para> 
     142                    </entry> 
     143                    <entry><literal>unit={unit}</literal></entry> 
     144                </row> 
     145                <row> 
     146                    <entry> 
     147                        <literal>wavelength_min</literal> 
     148                        <indexterm> 
     149                            <primary>element</primary> 
     150                            <secondary>wavelength_min</secondary> 
     151                        </indexterm> 
     152                    </entry> 
     153                    <entry> floating-point number </entry> 
     154                    <entry> [0..1] </entry> 
     155                    <entry> Some facilities specify wavelength using a range. The minimum of 
     156                        such a range is given by wavelength_min. </entry> 
     157                    <entry><literal>unit={unit}</literal></entry> 
     158                </row> 
     159                <row> 
     160                    <entry> 
     161                        <literal>wavelength_max</literal> 
     162                        <indexterm> 
     163                            <primary>element</primary> 
     164                            <secondary>wavelength_max</secondary> 
     165                        </indexterm> 
     166                    </entry> 
     167                    <entry> floating-point number </entry> 
     168                    <entry> [0..1] </entry> 
     169                    <entry> Some facilities specify wavelength using a range. The maximum of 
     170                        such a range is given by wavelength_max. </entry> 
     171                    <entry><literal>unit={unit}</literal></entry> 
     172                </row> 
     173                <row> 
     174                    <entry> 
     175                        <literal>wavelength_spread</literal> 
     176                        <indexterm> 
     177                            <primary>element</primary> 
     178                            <secondary>wavelength_spread</secondary> 
     179                        </indexterm> 
     180                    </entry> 
     181                    <entry> floating-point number </entry> 
     182                    <entry> [0..1] </entry> 
     183                    <entry> Some facilities specify the width of the wavelength spectrum. The 
     184                        width of such a range is given by wavelength_spread. </entry> 
     185                    <entry><literal>unit={unit}</literal></entry> 
     186                </row> 
     187            </tbody> 
     188        </tgroup> 
     189    </table> 
    197190    <section> 
    198191        <title>beam_size</title> 
    199192        <para> 
    200             <table> 
    201                 <title/> 
     193            <informaltable> 
    202194                <tgroup cols="2"> 
    203195                    <tbody> 
    … …  
    230222                    </tbody> 
    231223                </tgroup> 
    232             </table> 
     224            </informaltable> 
    233225            <table orient="port" role="small"> 
    234226                <title/> 

  • 1dwg/trunk/doc/src/element_XML_header.xml

    r140 r142  
    1414    version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink"> 
    1515    <title>Required XML Header</title> 
    16     <bridgehead> 
    17         $Revision$ 
    18         $Date$ 
    19     </bridgehead> 
    2016    <example> 
    2117        <title>Required header for cansas1d/1.0 XML files</title> 

  • 1dwg/trunk/doc/src/element_any.xml

    r131 r142  
    1414    version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink"> 
    1515    <title><literal>{any}</literal> element</title> 
    16     <bridgehead> 
    17         $Revision$ 
    18         $Date$ 
    19     </bridgehead> 
    2016    <table orient="port" role="small"> 
    2117        <title/> 
    … …  
    5046                            to differentiate them from the canSAS elements in the XML file.) </para> 
    5147                    </entry> 
    52                     <entry> 
    53                         <para> 
    54                             <emphasis role="bold"> 
    55                                 <emphasis>xmlns:{foreign-prefix}</emphasis> 
    56                             </emphasis> ={foreign-namespace} </para> 
    57                     </entry> 
     48                    <entry><literal>xmlns:{foreign-prefix}={foreign-namespace}</literal></entry> 
    5849                </row> 
    5950            </tbody> 

  • 1dwg/trunk/doc/src/elements.xml

    r140 r142  
    1313    xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"> 
    1414    <title>Elements of the canSAS XML standard</title> 
    15     <para>Starting the description of each element will be the current version control  
    16         <emphasis>Revision</emphasis> and <emphasis>Date</emphasis> of the documentation section.   
     15    <para> 
    1716        There are various elements (tag names) in the cansas1d/1.0 standard.  
    1817        Each of these is described below. 
    … …  
    2120        <glossentry> 
    2221            <glossterm>Name</glossterm> 
    23             <glossdef><para><emphasis role="italic">Name</emphasis> is the XML tag to be used for this element of the standard.</para></glossdef> 
     22            <glossdef><para><emphasis role="italic">Name</emphasis> is the XML tag to be  
     23                used for this element of the standard.</para></glossdef> 
    2424        </glossentry> 
    2525        <glossentry> 
    … …  
    107107    </glosslist> 
    108108 
    109     <xi:include href="cansas1d_element_XML_header.xml"/> 
    110     <xi:include href="cansas1d_element_SASroot.xml"/> 
    111     <xi:include href="cansas1d_element_SASentry.xml"/> 
    112     <xi:include href="cansas1d_element_SASdata.xml"/> 
    113     <xi:include href="cansas1d_element_SASsample.xml"/> 
    114     <xi:include href="cansas1d_element_SASinstrument.xml"/> 
    115     <xi:include href="cansas1d_element_SASsource.xml"/> 
    116     <xi:include href="cansas1d_element_SAScollimation.xml"/> 
    117     <xi:include href="cansas1d_element_SASdetector.xml"/> 
    118     <xi:include href="cansas1d_element_SASprocess.xml"/> 
    119     <xi:include href="cansas1d_element_SASnote.xml"/> 
    120     <xi:include href="cansas1d_element_any.xml"/> 
     109    <xi:include href="element_XML_header.xml"/> 
     110    <xi:include href="element_SASroot.xml"/> 
     111    <xi:include href="element_SASentry.xml"/> 
     112    <xi:include href="element_SASdata.xml"/> 
     113    <xi:include href="element_SASsample.xml"/> 
     114    <xi:include href="element_SASinstrument.xml"/> 
     115    <xi:include href="element_SASsource.xml"/> 
     116    <xi:include href="element_SAScollimation.xml"/> 
     117    <xi:include href="element_SASdetector.xml"/> 
     118    <xi:include href="element_SASprocess.xml"/> 
     119    <xi:include href="element_SASnote.xml"/> 
     120    <xi:include href="element_any.xml"/> 
    121121</section> 

  • 1dwg/trunk/doc/src/examples.xml

    r140 r142  
    1010########### SVN repository information ################### 
    1111--> 
    12 <chapter xml:id="wiki-other" xmlns="http://docbook.org/ns/docbook" version="5.0" 
     12<appendix xml:id="wiki-other" xmlns="http://docbook.org/ns/docbook" version="5.0" 
    1313    xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"> 
    14     <title>Other matters</title> 
     14    <title>Examples</title> 
    1515    <para>Various topics have been considered or presented in considering this standard. Some are 
    1616        described below.</para> 
    17     <xi:include href="cansas1d_definition_of_terms.xml"/> 
    18     <xi:include href="xml-help.xml"/> 
    19     <section xml:id="the_intensity_problem"> 
    20         <title>The Intensity Problem</title> 
    21         <para> The intensity (see  
    22             <link 
    23                 xlink:href="#cansas1d_documentation-element-SASdata" 
    24                 ><literal>SASdata/Idata</literal></link>)  
    25             is permitted in three different forms: </para> 
    26         <itemizedlist> 
    27             <listitem> 
    28                 <para><emphasis role="bold">absolute units:</emphasis> differential cross-section 
    29                     per unit volume per unit solid angle (typical unit: 1/cm)</para> 
    30             </listitem> 
    31             <listitem> 
    32                 <para><emphasis role="bold">absolute units:</emphasis> differential cross-section 
    33                     per unit atom per unit solid angle (typical unit: cm^2)</para> 
    34             </listitem> 
    35             <listitem> 
    36                 <para><emphasis role="bold">arbitrary units:</emphasis> usually a ratio of two 
    37                     detectors but unit is meaningless (typical unit: a.u.)</para> 
    38             </listitem> 
    39         </itemizedlist> 
    40         <para> This presents a few problems  
    41             <indexterm> 
    42                 <primary>intensity</primary> 
    43                 <secondary>problem</secondary> 
    44             </indexterm> 
    45             <indexterm> 
    46                 <primary>intensity</primary> 
    47                 <secondary>absolute</secondary> 
    48             </indexterm> 
    49             for analysis software to sort out when reading the data. 
    50             Fortunately, it is possible to analyze the unit attribute to decide which type of 
    51             intensity is being reported and make choices at the time the file is read. But this is 
    52             an area for consideration and possible improvement. </para> 
    53         <para> One problem arises with software that automatically converts data into some canonical 
    54             units used by that software. The software should not convert units between these three 
    55             types of intensity indiscriminately. </para> 
    56         <para> A second problem is that when arbitrary units are used, then the set of possible 
    57             analytical results is restricted (such as no meaningful volume fraction or number 
    58             density can be determined directly from I(Q)). </para> 
    59     </section> 
     17    <!-- ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> 
     18    <!-- ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> 
    6019    <section xml:id="xml-data-file"> 
    6120        <title>Example XML Data Files</title> 
    … …  
    7332        <section xml:id="data-simple"> 
    7433            <title>data-simple.xml</title> 
    75             <para>The example data file <literal>data-simple.xml</literal> shows  
    76                 just the basic elements of the cansas1d/1.0 standard.  Only a single data  
    77                 point has been shown to more clearly show the other structure. 
     34            <para> 
     35                The example data file <literal>data-simple.xml</literal> 
     36                <indexterm> 
     37                    <primary>XML file</primary> 
     38                    <secondary>data-simple.xml</secondary> 
     39                </indexterm> 
     40                shows just the basic elements of the cansas1d/1.0 standard.  Only a  
     41                single data point has been shown to more clearly show the other structure. 
    7842                The data file is actually an excerpt from the 
    7943                <link 
    … …  
    9054                <secondary>cansas1d/1.0 data file</secondary> 
    9155            </indexterm> 
    92             <programlisting language="xml" linenumbering="numbered"> 
    93                 <textobject> 
    94                     <textdata fileref="data-simple.xml"/> 
    95                 </textobject> 
    96             </programlisting> 
     56            <example> 
     57                <title><citetitle>data-simple.xml</citetitle></title> 
     58                <programlisting language="xml" linenumbering="numbered"> 
     59                    <textobject> 
     60                        <textdata fileref="data-simple.xml"/> 
     61                    </textobject> 
     62                </programlisting> 
     63            </example> 
    9764        </section> 
    9865        <section xml:id="data-cansas1d"> 
    9966            <title>cansas1d.xml</title> 
    10067            <para> 
    101                 The example data file <literal>cansas1d.xml</literal> shows example 
     68                The example data file <literal>cansas1d.xml</literal>  
     69                <indexterm> 
     70                    <primary>XML file</primary> 
     71                    <secondary>cansas1d.xml</secondary> 
     72                </indexterm> 
     73                shows example 
    10274                of most of the elements of the cansas1d/1.0 standard.  Only a single data  
    10375                point has been shown to more clearly show the other structure. 
    … …  
    11082                <secondary>cansas1d/1.0 data file</secondary> 
    11183            </indexterm> 
    112             <programlisting language="xml" linenumbering="numbered"> 
    113                 <textobject> 
    114                     <textdata fileref="../../cansas1d.xml"/> 
    115                 </textobject> 
    116             </programlisting> 
     84            <example> 
     85                <title><citetitle>cansas1d.xml</citetitle></title> 
     86                <programlisting language="xml" linenumbering="numbered"> 
     87                    <textobject> 
     88                        <textdata fileref="../../cansas1d.xml"/> 
     89                    </textobject> 
     90                </programlisting> 
     91            </example> 
    11792        </section> 
    11893    </section> 
    … …  
    198173        </section> 
    199174    </section> 
    200 </chapter> 
     175</appendix> 

  • 1dwg/trunk/doc/src/glossary.xml

    r140 r142  
    1111--> 
    1212<!-- from: http://www.smallangles.net/wgwiki/index.php/cansas1d_cansas1d_definition_of_terms--> 
    13 <section  
     13<appendix  
    1414    xml:id="cansas1d_documentation-element-cansas1d_definition_of_terms"  
    1515    xmlns="http://docbook.org/ns/docbook" 
    … …  
    1717    xmlns:xlink="http://www.w3.org/1999/xlink"> 
    1818    <title>Glossary</title> 
    19     <bridgehead> 
    20         $Revision$ 
    21         $Date$ 
    22     </bridgehead> 
    2319    <note> 
    24         <para> This Glossary  
     20        <para>This Glossary  
    2521            might not be provided in future versions of this manual. </para></note> 
    2622    <para> 
    … …  
    2824        <indexterm><primary>glossary</primary></indexterm> 
    2925        defining the details about each specific field (XPath string,  
    30         XML elements and attributes) in the cansas1d/1.0 standard.<indexterm><primary>cansas1d/1.0 standard</primary></indexterm>  
     26        XML elements and attributes) in the cansas1d/1.0 standard. 
     27        <indexterm><primary>cansas1d/1.0 standard</primary></indexterm>  
    3128    </para> 
    3229    <itemizedlist mark="opencircle"><listitem> 
    … …  
    105102    </itemizedlist> 
    106103    <glossary> 
    107         <title>Glossary</title> 
     104        <title>Listed by full XPath reference</title> 
     105        <subtitle>assumes namespace declaration: <literal>xmlns:cs="cansas1d/1.0"</literal></subtitle> 
    108106        <glosslist> 
    109107            <glossentry> 
    … …  
    10691067        </glosslist> 
    10701068    </glossary> 
    1071 </section> 
     1069</appendix> 

  • 1dwg/trunk/doc/src/manual.xml

    r138 r142  
    3232        </author> 
    3333        <!--<edition>$Id$</edition>--> 
    34         <edition>draft</edition> 
     34        <!--<edition>draft</edition>--> 
    3535        <pubdate>2009</pubdate> 
    3636        <legalnotice> 
    … …  
    5555 
    5656        <xi:include href="preface.xml"/> 
    57     <xi:include href="wiki.xml"/> 
     57    <xi:include href="overview.xml"/> 
    5858    <xi:include href="specification.xml"/> 
    5959    <xi:include href="tutorial.xml"/> 
    6060    <xi:include href="bindings.xml"/> 
    61     <xi:include href="other.xml"/> 
    62         <!--<xi:include href="appendices.xml"/>--> 
     61    <!-- +++++ appendices +++++ --> 
     62    <xi:include href="intensity-problem.xml"/> 
     63    <xi:include href="examples.xml"/> 
     64    <xi:include href="glossary.xml"/> 
     65    <xi:include href="xml-help.xml"/> 
    6366    <index/> 
    6467</book> 

  • 1dwg/trunk/doc/src/overview.xml

    r140 r142  
    2121            forum of users, software developers, and facility staff was to discuss 
    2222            better sharing of SAS data analysis software. The <link 
    23                 xlink:href="http://www.smallangles.net/canSAS">canSAS</link> 
    24             <footnote><para> 
     23                xlink:href="http://www.smallangles.net/canSAS">canSAS</link><footnote><para> 
    2524                <link xlink:href="http://www.smallangles.net/canSAS" 
    2625                    ><literal>http://www.smallangles.net/canSAS</literal></link></para></footnote> 
    … …  
    8180                <link 
    8281                    xlink:href="http://www.smallangles.net/wgwiki/index.php/1D_Data_Formats_Working_Group" 
    83                     >canSAS 1D Data Formats Working Group</link> 
    84                 <footnote> 
     82                    >canSAS 1D Data Formats Working Group</link><footnote> 
    8583                    <para> 
    8684                        <link xlink:href="http://www.smallangles.net/wgwiki/index.php/1D_Data_Formats_Working_Group" 
    … …  
    9189                <link 
    9290                    xlink:href="http://www.smallangles.net/wgwiki/index.php/Talk:1D_Data_Formats_Working_Group" 
    93                     >discussion</link> 
    94                 <footnote> 
     91                    >discussion</link><footnote> 
    9592                    <para> 
    9693                        <link xlink:href="http://www.smallangles.net/wgwiki/index.php/Talk:1D_Data_Formats_Working_Group" 
    … …  
    317314            </listitem> 
    318315            <listitem> 
    319                 <para> units to be given in standard SI abbreviations (eg, m, cm, mm, nm, K) 
     316                <para> 
     317                    units 
     318                    <indexterm significance="preferred"> 
     319                        <primary>unit</primary> 
     320                    </indexterm> 
     321                    <indexterm> 
     322                        <primary>units</primary> 
     323                        <see>unit</see> 
     324                    </indexterm> 
     325                    to be given in standard SI abbreviations (eg, m, cm, mm, nm, K) 
    320326                    with the following exceptions: </para> 
    321327                <orderedlist numeration="loweralpha"> 
    … …  
    382388                                    <secondary>rotation</secondary> 
    383389                                </indexterm> 
    384                                 <table> 
    385                                     <title/> 
     390                                <informaltable> 
     391                                    <!--<title/>--> 
    386392                                    <tgroup cols="2"> 
    387393                                        <tbody> 
    … …  
    414420                                        </tbody> 
    415421                                    </tgroup> 
    416                                 </table> 
     422                                </informaltable> 
    417423                            </para> 
    418424                        </figure> 
    … …  
    437443            <listitem> 
    438444                <para> Unicode characters MUST NOT be used</para> 
     445                <note><para>Perhaps this could be relaxed in v1.1?</para></note> 
    439446            </listitem> 
    440447            <listitem> 
    … …  
    481488        <para>The translation and orientation geometry definitions used here are different than 
    482489            those used by <link xlink:href="http://www.nanotech.wisc.edu/shadow" 
    483                 ><literal>SHADOW</literal></link> 
    484             <footnote><para> 
     490                ><literal>SHADOW</literal></link><footnote><para> 
    485491                <link xlink:href="http://www.nanotech.wisc.edu/shadow" 
    486492                    ><literal>http://www.nanotech.wisc.edu/shadow</literal></link></para></footnote> 
    … …  
    493499        <para>The  
    494500            <link xlink:href="http://www.smallangles.net/canSAS/xmlWriter/" 
    495                 ><emphasis role="italic">canSAS/xmlWriter</emphasis></link> 
    496             <footnote> 
     501                ><emphasis role="italic">canSAS/xmlWriter</emphasis></link><footnote> 
    497502                <para><link xlink:href="http://www.smallangles.net/canSAS/xmlWriter/" 
    498503                    ><literal>http://www.smallangles.net/canSAS/xmlWriter/</literal></link></para> 
    … …  
    506511            ...). </para> 
    507512        <para>Press the <code>Submit</code> button and you will receive a nicely 
    508             formatted WWW page with the SAS data. If you then choose "View page source" (from 
    509             one of your browser menus), you will see the raw XML of the cansas1d/1.0 XML format 
     513            formatted WWW page with the SAS data. If you then choose <emphasis>View page source</emphasis> 
     514            (from one of your browser menus), you will see the raw XML of the cansas1d/1.0 XML format 
    510515            and you can copy/paste this into an XML file. </para> 
    511516        <para>The SAS data that you paste into the form box is likely to be copied directly from 
    … …  
    523528                    ><literal>cansas1d.xsd</literal></link> 
    524529                <link xlink:href="http://www.w3schools.com/xsd" 
    525                     >XML Schema</link> 
    526                 <footnote><para> 
     530                    >XML Schema</link><footnote><para> 
    527531                    <link xlink:href="http://www.w3schools.com/xsd" 
    528532                        ><literal>http://www.w3schools.com/xsd</literal></link></para></footnote> 
    529533                <indexterm><primary>XML Schema</primary></indexterm> 
    530                 defines the rules for the XML file format 
    531                 <footnote> 
     534                defines the rules for the XML file format<footnote> 
    532535                    <para> 
    533536                        TRAC: 
    … …  
    535538                            ><literal>http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/cansas1d.xsd</literal></link> 
    536539                    </para> 
    537                 </footnote> 
    538                 <footnote> 
     540                </footnote><footnote> 
    539541                    <para> 
    540542                        SVN: 
    … …  
    549551            <title>XML Stylesheets</title> 
    550552            <para> 
    551                 XML stylesheets (also known as XSLT) 
    552                 <footnote> 
     553                XML stylesheets (also known as XSLT)<footnote> 
    553554                    <para> 
    554555                        <link xlink:href="http://www.w3schools.com/xsl/" 
    … …  
    559560                </indexterm> 
    560561                can be used to extract metadata or to convert into another file format. The 
    561                 default canSAS stylesheet <literal>cansasxml-html.xsl</literal> 
    562                 <footnote> 
     562                default canSAS stylesheet <literal>cansasxml-html.xsl</literal><footnote> 
    563563                    <para> 
    564564                        <link xlink:href="http://svn.smallangles.net/svn/canSAS/1dwg/trunk/cansasxml-html.xsl" 
    … …  
    569569                (such as Firefox or Internet Explorer) or to import into Microsoft Excel 
    570570                (with the added XML support in Excel). (See the excellent write-up by Steve 
    571                 King, ISIS,  
    572                 <footnote> 
     571                King, ISIS,<footnote> 
    573572                    <para> 
    574573                        <link xlink:href="http://www.isis.rl.ac.uk/archive/LargeScale/LOQ/xml/cansas_xml_format.pdf" 
    … …  
    583582        </section> 
    584583        <section xml:id="cansas1d_documentation-programming_suggestions"> 
    585             <title>Suggestions for support software that writes cansas1d/1.0 XML data files</title> 
     584            <title>Suggestions for support software that write cansas1d/1.0 XML data files</title> 
    586585            <para> 
    587586                Some common best practices have been identified in the list below. 
    … …  
    613612                <listitem> 
    614613                    <para>The most recent XSLT file can be identified by examining the file 
    615                         for the <literal>$ Revision: </literal> string. For example:  
    616                         <code># &#36;Revision: 111 $</code> is version 111. </para> 
     614                        for the <literal>$ Revision: </literal> string such as in the next example.  
     615                        <informalexample> 
     616                            <programlisting># &#36;Revision: 111 $</programlisting> 
     617                        </informalexample> 
     618                    </para> 
    617619                </listitem> 
    618620            </itemizedlist> 
    … …  
    623625                <listitem> 
    624626                    <para> 
    625                         Basic example: 
    626                         <footnote><para> 
     627                        Basic example:<footnote><para> 
    627628                            <link xlink:href="http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/cansas1d.xml" 
    628                                 ><literal>http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/cansas1d.xml</literal></link></para></footnote> 
     629                                ><literal 
     630                                    >http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/cansas1d.xml</literal 
     631                                ></link></para></footnote> 
     632                        <indexterm> 
     633                            <primary>XML file</primary> 
     634                            <secondary>cansas1d.xml</secondary> 
     635                        </indexterm> 
    629636                        Note that, for clarity, only one row of data is 
    630637                        shown. This is probably a very good example to use as a starting point for 
    … …  
    633640                <listitem> 
    634641                    <para> 
    635                         Bimodal test data: 
    636                         <footnote><para> 
     642                        Bimodal test data:<footnote><para> 
    637643                            <link xlink:href="http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/bimodal-test1.xml" 
    638                                 ><literal>http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/bimodal-test1.xml</literal></link></para></footnote> 
    639                         Simulated SAS data (with added noise) calculated from model bimodal size distribution to test size distribution analysis routines.</para> 
    640                 </listitem> 
    641                 <listitem> 
    642                     <para> 
    643                         Glassy Carbon Round Robin: 
    644                         <footnote> 
     644                                ><literal 
     645                                    >http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/bimodal-test1.xml</literal 
     646                                ></link></para></footnote> 
     647                        <indexterm> 
     648                            <primary>XML file</primary> 
     649                            <secondary>bimodal-test1.xml</secondary> 
     650                        </indexterm> 
     651                        <indexterm> 
     652                            <primary>case study</primary> 
     653                            <secondary>bimodal test data</secondary> 
     654                        </indexterm> 
     655                        Simulated SAS data (with added noise) calculated from model bimodal size  
     656                        distribution to test size distribution analysis routines.</para> 
     657                </listitem> 
     658                <listitem> 
     659                    <para> 
     660                        Glassy Carbon Round Robin:<footnote> 
    645661                            <para> 
    646662                            <link xlink:href="http://www.smallangles.net/wgwiki/index.php/Glassy_Carbon_Round_Robin" 
    … …  
    648664                                ></link></para> 
    649665                        </footnote> 
     666                        <indexterm> 
     667                            <primary>case study</primary> 
     668                            <secondary>glassy carbon round robin</secondary> 
     669                        </indexterm> 
    650670                        Samples of a commercial glassy carbon 
    651671                        measured at several facilities worldwide.</para> 
    … …  
    655675                        <link xlink:href="#cansas1d_documentation-case_study-collagen" 
    656676                            >dry chick collagen</link> 
     677                        <indexterm> 
     678                            <primary>case study</primary> 
     679                            <secondary>SAXS of dry chick collagen</secondary> 
     680                        </indexterm> 
    657681                        illustrates the 
    658682                        minimum information necessary to meet the requirements of the standard 
    … …  
    662686                    <para>SANS data from  
    663687                        <link xlink:href="#cansas1d_documentation-case_study-af1410" 
    664                             >AF1410 steel</link>:  
    665                         <footnote><para> 
    666                             <link xlink:href="http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/examples/af1410/" 
    667                                 ><literal>http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/examples/af1410/</literal 
    668                                 ></link></para></footnote> 
     688                            >AF1410 steel</link>:<footnote><para> 
     689                                <link xlink:href="http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/examples/af1410/" 
     690                                    ><literal>http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/examples/af1410/</literal 
     691                                    ></link></para></footnote> 
     692                        <indexterm> 
     693                            <primary>case study</primary> 
     694                            <secondary>SANS of AF1410 steel</secondary> 
     695                        </indexterm> 
    669696                        SANS study using magnetic 
    670697                        contrast variation (with multiple samples and multiple data sets for each 
    … …  
    673700                <listitem> 
    674701                    <para> 
    675                         <literal>cansas1d-template.xml</literal>: 
    676                         <footnote><para> 
     702                        <literal>cansas1d-template.xml</literal>:<footnote><para> 
    677703                            <link xlink:href="http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/cansas1d-template.xml" 
    678                                 ><literal>http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/cansas1d-template.xml</literal></link></para></footnote> 
     704                                ><literal 
     705                                    >http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/cansas1d-template.xml</literal 
     706                                ></link></para></footnote> 
     707                        <indexterm> 
     708                            <primary>XML file</primary> 
     709                            <secondary>cansas1d-template.xml</secondary> 
     710                        </indexterm> 
    679711                        This is used to test all the rules in the XML 
    680712                        Schema. This is probably not a very good example to use as a starting point 
    … …  
    686718                <title>XML layout for multiple experiments</title> 
    687719                <para>Each experiment is described with a single <literal>SASentry</literal> element. The 
    688                     fragment below shows how multiple experiments can be included in a single XML 
     720                    fragment below shows how multiple experiments 
     721                    <indexterm> 
     722                        <primary>multiple experiments</primary> 
     723                    </indexterm> 
     724                    <indexterm> 
     725                        <primary>multiple data sets</primary> 
     726                    </indexterm> 
     727                    can be included in a single XML 
    689728                    file. Full examples of canSAS XML files with multiple experiments 
    690729                    include:</para> 
    691730                <itemizedlist> 
    692731                    <listitem> 
    693                         <para> ISIS LOQ SANS instrument:  
    694                             <footnote><para> 
    695                                 <link xlink:href="http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/W1W2.XML" 
    696                                     ><literal>http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/W1W2.XML</literal></link></para></footnote> 
     732                        <para> ISIS LOQ SANS instrument:<footnote><para> 
     733                            <link xlink:href="http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/W1W2.XML" 
     734                                ><literal 
     735                                    >http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/W1W2.XML</literal 
     736                                ></link></para></footnote> 
     737                            <indexterm> 
     738                                <primary>XML file</primary> 
     739                                <secondary>W1W2.XML</secondary> 
     740                            </indexterm> 
    697741                            multiple data sets. 
    698742                        </para> 
    699743                    </listitem> 
    700744                    <listitem> 
    701                         <para> AF1410 steel SANS contrast variation study from NIST:  
    702                             <footnote><para> 
     745                        <para> AF1410 steel SANS contrast variation study from NIST:<footnote><para> 
    703746                                <link xlink:href="http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/examples/af1410/cs_af1410.xml" 
    704                                     ><literal>http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/examples/af1410/cs_af1410.xml</literal></link></para></footnote> 
     747                                    ><literal 
     748                                        >http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/examples/af1410/cs_af1410.xml</literal 
     749                                    ></link></para></footnote> 
     750                            <indexterm> 
     751                                <primary>XML file</primary> 
     752                                <secondary>cs_af1410.xml</secondary> 
     753                            </indexterm> 
    705754                            SANS study using magnetic 
    706755                            contrast variation (with multiple samples and multiple data sets for each 
    … …  
    711760                <para>Here is a brief sketch of how a file would be arranged with multiple SASentry 
    712761                    elements and multiple SASdata elements. 
     762                    <indexterm> 
     763                        <primary>XML file</primary> 
     764                        <secondary>brief-sketch-multiple.xml</secondary> 
     765                    </indexterm> 
    713766                    <example> 
    714767                        <title>Brief sketch of a file with multiple SASentry and SASdata blocks.</title> 
    … …  
    725778            <title>Foreign Elements</title> 
    726779            <para> To allow for inclusion of elements that are not defined by the  
    727             <literal>cansas1d.xsd</literal> XML 
     780                <literal>cansas1d.xsd</literal> XML 
    728781                Schema, XML <emphasis role="italic">foreign elements</emphasis>  
    729782                <indexterm> 
    … …  
    735788                <link xlink:href="#wiki-XML_Help"><emphasis>XML Help</emphasis></link> 
    736789                 for more help with XML foreign elements. </para> 
    737             <para> There is one example that demonstrates the use of a foreign namespace:  
    738                 <footnote> 
     790            <para>  
     791                There is an example that demonstrates the use of a foreign  
     792                namespace:<footnote> 
    739793                    <para> 
    740794                        <link 
    741795                            xlink:href="http://svn.smallangles.net/trac/canSAS/browser/1dwg/data/Glassy%20Carbon/ISIS/GLASSYC_C4G8G9_withTL.xml" 
    742                             ><literal>http://svn.smallangles.net/trac/canSAS/browser/1dwg/data/Glassy%20Carbon/ISIS/GLASSYC_C4G8G9_withTL.xml</literal></link></para> 
     796                            ><literal 
     797                                >http://svn.smallangles.net/trac/canSAS/browser/1dwg/data/Glassy%20Carbon/ISIS/GLASSYC_C4G8G9_withTL.xml</literal></link></para> 
    743798                </footnote> 
    744799                This example uses a foreign namespace to record the transmission spectra related to 
    745                 the acquisition of the SANS data at a time-of-flight facility. Look for the 
    746                     <code>&lt;transmission_spectrum xmlns="urn:transmission:spectrum"></code> 
    747                 element at line 153. The foreign namespace given 
    748                     (<literal>urn:transmission:spectrum</literal>) becomes the default for just the 
    749                     <literal>transmission_spectrum</literal> element. </para> 
    750             <para> Also refer to <link 
    751                     xlink:href="http://svn.smallangles.net/trac/canSAS/changeset/47">canSAS TRAC 
    752                     ticket #47</link> for an example of arranging the content in  
     800                the acquisition of the SANS data at a time-of-flight facility. Look near line 153 
     801                for the element om the next example.  
     802                <informalexample> 
     803                    <programlisting>&lt;transmission_spectrum xmlns="urn:transmission:spectrum"></programlisting> 
     804                </informalexample> 
     805                The foreign namespace given 
     806                (<literal>urn:transmission:spectrum</literal>) becomes the default namespace for just the 
     807                <literal>transmission_spectrum</literal> element. </para> 
     808            <para>Also refer to <link 
     809                xlink:href="http://svn.smallangles.net/trac/canSAS/changeset/47">canSAS TRAC 
     810                ticket #47</link> for an example of arranging the content in  
    753811                <literal>SASprocessnote</literal> to avoid the use of foreign namespace 
    754812                elements. </para> 
    … …  
    787845                        </indexterm> 
    788846                        <indexterm> 
    789                             <primary>FORTRAN</primary> 
    790                             <see>binding, FORTRAN</see> 
     847                            <primary>IgorPro</primary> 
     848                            <see>binding, IgorPro</see> 
    791849                        </indexterm> 
    792850                    </para> 
    … …  
    827885                            >ISIS LOQ instrument</link> has provided an <link 
    828886                                xlink:href="http://www.isis.rl.ac.uk/archive/LargeScale/LOQ/xml/cansas_xml_format.pdf" 
    829                                 >excellent description</link> 
    830                         <footnote><para><link 
     887                                >excellent description</link><footnote><para><link 
    831888                            xlink:href="http://www.isis.stfc.ac.uk/instruments/loq/loq2470.html" 
    832889                            ><literal>http://www.isis.stfc.ac.uk/instruments/loq/loq2470.html</literal 
    … …  
    837894                            <link 
    838895                            xlink:href="http://www.isis.rl.ac.uk/archive/LargeScale/LOQ/loq.htm">old 
    839                             WWW site</link> 
    840                         <footnote><para><link 
     896                            WWW site</link><footnote><para><link 
    841897                            xlink:href="http://www.isis.rl.ac.uk/LargeScale/LOQ/loq.htm" 
    842898                            ><literal>http://www.isis.rl.ac.uk/LargeScale/LOQ/loq.htm</literal 
    … …  
    851907                            ><emphasis role="italic">canSAS/xmlWriter</emphasis></link> 
    852908                        <indexterm><primary><literal>xmlWriter</literal></primary></indexterm> 
    853                         is implemented in <link xlink:href="http://www.php.net">PHP</link>  
    854                         <footnote><para><link xlink:href="http://www.php.net" 
     909                        is implemented in <link xlink:href="http://www.php.net">PHP</link 
     910                        ><footnote><para><link xlink:href="http://www.php.net" 
    855911                            ><literal>http://www.php.net</literal></link></para></footnote> 
    856912                        <indexterm> 
    … …  
    865921                        (<link 
    866922                            xlink:href="http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/php/xmlWriter/index.php" 
    867                             >PHP source</link>) 
    868                         <footnote> 
     923                            >PHP source</link>)<footnote> 
    869924                            <para> 
    870925                                <link xlink:href="http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/php/xmlWriter/index.php" 
    … …  
    872927                            </para> 
    873928                        </footnote> 
    874                         The code uses <link xlink:href="http://www.php.net/DomDocument">DomDocument</link> 
    875                         <footnote><para><link xlink:href="http://www.php.net/DomDocument" 
     929                        The code uses <link xlink:href="http://www.php.net/DomDocument">DomDocument</link 
     930                        ><footnote><para><link xlink:href="http://www.php.net/DomDocument" 
    876931                            ><literal>http://www.php.net/DomDocument</literal></link></para></footnote> 
    877932                        to build the XML file.  Look for the line beginning with 
    … …  
    931986    <section xml:id="cansas1d_documentation-schema_validation"> 
    932987        <title>Validation of XML against the Schema</title> 
     988        <indexterm> 
     989            <primary>validation</primary> 
     990            <secondary>against XML Schema</secondary> 
     991        </indexterm> 
    933992        <orderedlist> 
    934993            <listitem> 
    … …  
    9461005            <listitem> 
    9471006                <para>paste content of  
    948                     <literal>cansas1d.xsd</literal> 
    949                     <footnote><para><link 
     1007                    <literal>cansas1d.xsd</literal><footnote><para><link 
    9501008                        xlink:href="http://svn.smallangles.net/svn/canSAS/1dwg/trunk/cansas1d.xsd" 
    9511009                        ><literal>http://svn.smallangles.net/svn/canSAS/1dwg/trunk/cansas1d.xsd</literal 

  • 1dwg/trunk/doc/src/preface.xml

    r134 r142  
    2222        canSAS 1-D Data Format, v1.0 
    2323    </para> 
    24     <note><para> 
     24    <!--<note><para> 
    2525        Provide a note here describing canSAS and the initiative to establish 
    2626        a standard file format.  Note that the cansas1d/1.0 XML data files must adhere to the  
    2727        XML rules which includes being well-formed 
    2828        <indexterm><primary>XML</primary><secondary>well-formed</secondary></indexterm> 
    29         (including the use of closing tags).   
    30         <footnote> 
     29        (including the use of closing tags).<footnote> 
    3130            <para> 
    3231                For example, see  
    … …  
    4443            ><literal>cansas1d.xsd</literal> </link> 
    4544        are deemed to be valid cansas1d/1.0 data files. 
    46     </para></note> 
     45    </para></note>--> 
    4746    <para> 
    4847        The name <emphasis role="italic">canSAS</emphasis> 
    … …  
    7170        <link  
    7271            xlink:href="http://www.smallangles.net/wgwiki/index.php/Talk:1D_Data_Formats_Working_Group" 
    73             >discussion</link> 
    74         <footnote><para><link  
     72            >discussion</link><footnote><para><link  
    7573            xlink:href="http://www.smallangles.net/wgwiki/index.php/Talk:1D_Data_Formats_Working_Group" 
    7674            ><literal>http://www.smallangles.net/wgwiki/index.php/Talk:1D_Data_Formats_Working_Group</literal></link></para></footnote>    
    … …  
    8583            <link 
    8684                xlink:href="http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/cansas1d.xsd" 
    87                 >cansas1d/1.0 SAS XML Schema</link> 
    88             <footnote><para><link 
     85                >cansas1d/1.0 SAS XML Schema</link><footnote><para><link 
    8986                xlink:href="http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/cansas1d.xsd" 
    9087                ><literal>http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/cansas1d.xsd</literal></link></para></footnote> 

  • 1dwg/trunk/doc/src/specification.xml

    r140 r142  
    6666        with <literal>analysis</literal> and the element might look like this: 
    6767        <informalexample> 
    68             <programlisting> 
    69                 &lt;analysis> 
    70                 ... analysis content goes here ... 
    71                 &lt;/analysis> 
     68            <programlisting>&lt;analysis> 
     69    ... analysis content goes here ... 
     70&lt;/analysis> 
    7271            </programlisting> 
    7372        </informalexample> 

  • 1dwg/trunk/doc/src/test.xml

    r132 r142  
    5252    </info> 
    5353     
    54     <xi:include href="wiki.xml"/> 
     54    <xi:include href="overview.xml"/> 
    5555 
    5656    <index/> 

  • 1dwg/trunk/doc/src/tutorial.xml

    r138 r142  
    2020        scattering data in XML files. 
    2121    </para> 
    22     <note><para>More needs to be written here.</para></note> 
     22    <para>At present, the tutorial section consists of two case studies, 
     23        which can serve as examples.  The opportunity is ripe for a 
     24        better tutorial.</para> 
    2325 
    2426    <xi:include href="casestudies.xml"/> 

  • 1dwg/trunk/doc/src/xml-help.xml

    r134 r142  
    1010########### SVN repository information ################### 
    1111--> 
    12 <section xml:id="wiki-XML_Help" xmlns="http://docbook.org/ns/docbook" version="5.0" 
     12<appendix xml:id="wiki-XML_Help" xmlns="http://docbook.org/ns/docbook" version="5.0" 
    1313    xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"> 
    1414    <title>XML Help</title> 
    … …  
    114114        </listitem> 
    115115    </itemizedlist> 
    116 </section> 
     116</appendix> 
Note: See TracChangeset for help on using the changeset viewer.