Changeset 140


Ignore:
Timestamp:
Oct 9, 2009 6:00:42 PM (10 years ago)
Author:
prjemian
Message:

manual is nearly complete for v1.0 release, still a few problems to resolve (table+figure, code examples), refs #19

Location:
1dwg/trunk/doc/src
Files:
2 added
22 edited

Legend:

Unmodified
Added
Removed
  • 1dwg/trunk/doc/src/cansas1d_binding_Fortran.xml

    r130 r140  
    2121    <para> 
    2222        The development of the FORTRAN language,  
    23         <indexterm> 
     23        <indexterm significance="preferred"> 
    2424            <primary>binding</primary> 
    2525            <secondary>FORTRAN</secondary> 
  • 1dwg/trunk/doc/src/cansas1d_binding_IgorPro.xml

    r138 r140  
    1414    version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink"> 
    1515    <title>IgorPro binding</title> 
     16    <indexterm significance="preferred"> 
     17        <primary>binding</primary> 
     18        <secondary>IgorPro</secondary> 
     19    </indexterm> 
    1620    <bridgehead> 
    1721        $Revision$ 
  • 1dwg/trunk/doc/src/cansas1d_binding_Java.xml

    r134 r140  
    2020    <para> 
    2121        Documentation for the JAXB binding 
    22         <indexterm> 
     22        <indexterm significance="preferred"> 
    2323            <primary>binding</primary> 
    2424            <secondary>Java</secondary> 
  • 1dwg/trunk/doc/src/cansas1d_binding_Python.xml

    r130 r140  
    2121        Specific <link xlink:href="http://danse.us/trac/sans"><citetitle>support</citetitle></link>  
    2222        for the cansas1d/1.0 data standard in Python  
    23         <indexterm> 
     23        <indexterm significance="preferred"> 
    2424            <primary>binding</primary> 
    2525            <secondary>Python</secondary> 
  • 1dwg/trunk/doc/src/cansas1d_casestudy_af1410.xml

    r127 r140  
    1616    <bridgehead> $Revision$ $Date$ </bridgehead> 
    1717    <section> 
     18        <indexterm significance="preferred"> 
     19            <primary>case study</primary> 
     20            <secondary>SANS of AF1410 steel</secondary> 
     21        </indexterm> 
    1822        <title>Overview</title> 
    1923        <note> 
  • 1dwg/trunk/doc/src/cansas1d_casestudy_collagen.xml

    r138 r140  
    1717    <section> 
    1818        <title>Overview</title> 
     19        <indexterm significance="preferred"> 
     20            <primary>case study</primary> 
     21            <secondary>SAXS of dry chick collagen</secondary> 
     22        </indexterm> 
    1923        <para> To demonstrate how to get SAS data into the XML standard format, consider this set of 
    2024            SAXS data collected at the National Synchrotron Light Source, Brookhaven National 
     
    3438                                        <imagedata 
    3539                                            fileref="../../graphics/cs-collagen-data-table-Excel.jpg" 
    36                                             width="200pt" scalefit="1"/> 
     40                                            width="150pt" scalefit="1"/> 
    3741                                    </imageobject> 
    3842                                    <caption> 
     
    4650                                        <imagedata 
    4751                                            fileref="../../graphics/cs-collagen-saxs-chart-excel.jpg" 
    48                                             width="200pt" scalefit="1"/> 
     52                                            width="150pt" scalefit="1"/> 
    4953                                    </imageobject> 
    5054                                    <caption> 
     
    5862            </table> 
    5963        </para> 
    60         <para> The raw data was collected on a linear position-sensitive detector and reduced to 
     64        <para> The raw data  
     65            was collected on a linear position-sensitive detector and reduced to 
    6166            columns of <emphasis role="bold">Q</emphasis>, <emphasis role="bold">I</emphasis>, and 
    6267                <emphasis role="bold">Iesd</emphasis> (estimated standard deviation of <emphasis 
    6368                role="bold">I</emphasis>). </para> 
    6469        <para> The only metadata available for this data (without resorting to digging through piles 
    65             of old notebooks) was obtained from two file headers: </para> 
     70            of old notebooks) was obtained from two file headers:  
     71            <link 
     72                xlink:href="http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/examples/collagen/COLLAGEN.ASC" 
     73                ><citetitle>collagen.asc</citetitle> 
     74            </link><footnote><para><link 
     75                xlink:href="http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/examples/collagen/COLLAGEN.ASC" 
     76                ><literal>http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/examples/collagen/COLLAGEN.ASC</literal> 
     77            </link></para></footnote> 
     78            and 
     79            <link 
     80                xlink:href="http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/examples/collagen/collagen.saxs" 
     81                ><citetitle>collagen.saxs</citetitle> 
     82            </link><footnote><para><link 
     83                xlink:href="http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/examples/collagen/collagen.saxs" 
     84                ><literal>http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/examples/collagen/collagen.saxs</literal> 
     85            </link></para></footnote> 
     86            as shown. 
     87        </para> 
    6688        <para> 
    67             <link 
    68                 xlink:href="http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/examples/collagen/COLLAGEN.ASC"> 
    69                 <citetitle>collagen.asc</citetitle> 
    70             </link> 
     89            <example> 
     90                <title>First few lines from file <citetitle>collagen.asc</citetitle></title> 
    7191            <programlisting>Sep 19 1994     01:41:02 am     Elt: 00090 Seconds  
    7292ID: No spectrum identifier defined 
    7393Memory Size: 8192 Chls  Conversion Gain: 1024  Adc Offset: 0000 Chls        </programlisting> 
    74         </para> 
    75         <para> 
    76             <link 
    77                 xlink:href="http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/examples/collagen/collagen.saxs"> 
    78                 <citetitle>collagen.saxs</citetitle> 
    79             </link> 
    80             <programlisting>dry chick collagen, d = 673 A 
     94            </example> 
     95            <example> 
     96                <title>Full listing of file <citetitle>collagen.saxs</citetitle></title> 
     97                <programlisting>dry chick collagen, d = 673 A 
    81986531 eV, X6B</programlisting> 
    82         </para> 
    83         <para> But, the data can fulfill the minimum requirements of the 1D standard file format and 
    84             also make an excellent example of a minimal canSAS reduced 1-D SAS data file in XML. 
     99            </example> 
     100        </para> 
     101        <para> But, there is enough information to fulfill the minimum  
     102            requirements of the 1D standard file format and 
     103            also make an excellent example of a minimal  
     104            canSAS reduced 1-D SAS data file in XML. 
    85105        </para> 
    86106    </section> 
     
    90110            <title>make the basic XML file</title> 
    91111            <para> It is easiest to copy a template rather than start from an empty file. Copy the 
    92                     <link xlink:href="http://svn.smallangles.net/svn/canSAS/1dwg/trunk/cansas1d.xml"> 
    93                     <citetitle>cansas1d.xml</citetitle> 
    94                 </link> file into your working directory and rename it to <emphasis role="bold" 
    95                     >collagen.xml</emphasis>. </para> 
     112                    <link xlink:href="http://svn.smallangles.net/svn/canSAS/1dwg/trunk/cansas1d.xml" 
     113                        ><citetitle>cansas1d.xml</citetitle></link><footnote><para 
     114                            ><link xlink:href="http://svn.smallangles.net/svn/canSAS/1dwg/trunk/cansas1d.xml"> 
     115                                <literal>http://svn.smallangles.net/svn/canSAS/1dwg/trunk/cansas1d.xml</literal> 
     116                            </link></para></footnote>  
     117                file into your working directory and rename it to  
     118                <literal>collagen.xml</literal>. </para> 
    96119        </section> 
    97120        <section> 
    98121            <title>modify collagen.xml</title> 
    99122            <para> It is easier to see the metadata in the XML file before you enter the SAXS data 
    100                 into the file. With the brief metadata available, most lines can be eliminated. This 
    101                 will result in a file that looks like </para> 
    102             <programlisting>&lt;?xml version="1.0"?> 
    103 &lt;?xml-stylesheet type="text/xsl" href="example.xsl" ?> 
    104 &lt;SASroot version="1.0" 
    105     xmlns="cansas1d/1.0" 
    106     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    107     xsi:schemaLocation="cansas1d/1.0 http://svn.smallangles.net/svn/canSAS/1dwg/trunk/cansas1d.xsd" 
    108     > 
    109     &lt;SASentry> 
    110     &lt;Title>dry chick collagen, d = 673 A, 6531 eV, X6B&lt;/Title> 
    111         &lt;Run /> 
    112         &lt;SASdata> 
    113             &lt;!-- Idata lines will go here --> 
    114         &lt;/SASdata> 
    115         &lt;SASsample> 
    116             &lt;ID>dry chick collagen, d = 673 A, 6531 eV, X6B&lt;/ID> 
    117         &lt;/SASsample> 
    118         &lt;SASinstrument> 
    119             &lt;name>X6B, NSLS, BNL&lt;/name> 
    120             &lt;SASsource> 
    121                 &lt;radiation>X-ray synchrotron&lt;/radiation> 
    122                 &lt;wavelength unit="A"> 
    123                     1.898 
    124                     &lt;!-- = 12398/6531 -->  
    125                 &lt;/wavelength> 
    126             &lt;/SASsource> 
    127             &lt;SAScollimation /> 
    128             &lt;SASdetector> 
    129                 &lt;name>X6B PSD&lt;/name> 
    130             &lt;/SASdetector> 
    131         &lt;/SASinstrument> 
    132         &lt;SASnote> 
    133             Sep 19 1994     01:41:02 am     Elt: 00090 Seconds  
    134             ID: No spectrum identifier defined 
    135             Memory Size: 8192 Chls  Conversion Gain: 1024  Adc Offset: 0000 Chls 
    136              
    137             dry chick collagen, d = 673 A 
    138             6531 eV, X6B 
    139         &lt;/SASnote> 
    140     &lt;/SASentry> 
    141 &lt;/SASroot></programlisting> 
     123                into the file. With the brief metadata available, most of the other  
     124                lines in <citetitle>cansas1d.xml</citetitle> can be eliminated. This 
     125                will result in a file that looks like the next example.</para> 
     126            <example> 
     127                <title><literal>collagen.xml</literal> with metadata but before data lines are added.</title> 
     128                <programlisting language="xml" linenumbering="numbered"> 
     129                    <textobject> 
     130                        <textdata fileref="example-collagen-predata.xml"/> 
     131                    </textobject> 
     132                </programlisting> 
     133            </example> 
    142134        </section> 
    143135        <section> 
     
    147139                develop a bit of Excel Macro code to clarify our procedure. </para> 
    148140            <section> 
    149                 <title>Excel macros used</title> 
    150                 <para> Within Excel, with the SAXS data in columns as shown in the Excel table 
     141                <title>Using Excel macros to reformat the SAXS data</title> 
     142                <para> Within Excel,  
     143                    <indexterm> 
     144                        <primary>binding</primary> 
     145                        <secondary>Microsoft Excel</secondary> 
     146                    </indexterm> 
     147                    with the SAXS data in columns as shown in the Excel table 
    151148                    above, let's define the macros for our use. In Excel, type <emphasis role="bold" 
    152149                        >&lt;alt>&lt;F11></emphasis> to open the macro editing window. </para> 
    153                 <programlisting>Function XML_tag(tag, attr, content) As String 
    154   If attr = "" Then 
    155     XML = "&lt;" &amp; tag &amp; ">" 
    156   Else 
    157   XML = "&lt;" &amp; tag &amp; " " &amp; attr &amp; ">" 
    158   End If 
    159   XML = XML &amp; content 
    160   XML = XML &amp; "&lt;/" &amp; tag &amp; ">" 
    161   XML_tag = XML 
    162 End Function 
    163  
    164 Function SAS_Idata_tag(element, unit, content) As String 
    165 XML = XML_tag(element, "unit=""" &amp; unit &amp; """", content) 
    166   SAS_Idata_tag = XML 
    167 End Function 
    168  
    169 Function Idata_tag(Q, Q_unit, I, I_unit, Idev, Idev_unit) As String 
    170   XML = SAS_Idata_tag("Q", Q_unit, Q) 
    171   XML = XML &amp; SAS_Idata_tag("I", I_unit, I) 
    172   XML = XML &amp; SAS_Idata_tag("Idev", Idev_unit, Idev) 
    173   Idata_tag = XML_tag("Idata", "", XML) 
    174 End Function</programlisting> 
    175                 <para> Your window will look similar to this one when you copy/paste the above code: 
    176                      (Yes, my spreadsheet is called MyFirstMacro.xls) </para> 
     150                <example> 
     151                    <title>Microsoft Excel macro to format the <literal>Idata</literal> lines.</title> 
     152                    <programlisting> 
     153                        <textobject> 
     154                            <textdata fileref="example-excel-macro.txt"/> 
     155                        </textobject> 
     156                    </programlisting> 
     157                </example> 
     158                <para> Your window will look similar to this one when you copy/paste the above example code: 
     159                    (Yes, my spreadsheet is called <citetitle>MyFirstMacro.xls</citetitle>) </para> 
    177160                <mediaobject> 
    178161                    <imageobject> 
     
    193176                <title>construct the Idata lines in XML</title> 
    194177                <para> move to spreadsheet cell <literal>E5</literal> and enter this 
    195                     formula <programlisting>=IDATA_tag(A5,$A$4,B5,$B$4,C5,$C$4)</programlisting> 
     178                    formula  
     179                    <informalexample> 
     180                        <programlisting>=IDATA_tag(A5,$A$4,B5,$B$4,C5,$C$4)</programlisting> 
     181                    </informalexample> 
    196182                </para> 
    197183                <para> Copy it down all rows in column <emphasis role="bold">E</emphasis> through 
  • 1dwg/trunk/doc/src/cansas1d_definition_of_terms.xml

    r134 r140  
    2727        This section provides a glossary  
    2828        <indexterm><primary>glossary</primary></indexterm> 
    29         <!--<indexterm><primary>definition of terms</primary><see>glossary</see></indexterm>--> 
    3029        defining the details about each specific field (XPath string,  
    3130        XML elements and attributes) in the cansas1d/1.0 standard.<indexterm><primary>cansas1d/1.0 standard</primary></indexterm>  
     
    114113                    <link xlink:href="#cansas1d_documentation-element-SASroot" 
    115114                        ><literal>SASroot</literal></link> 
    116                     <indexterm><primary>SASroot</primary></indexterm>  
     115                    <indexterm><primary>element</primary><secondary>SASroot</secondary></indexterm>  
    117116                    database. This is similar to the root element of a NeXus file (<literal>NXroot</literal>). 
    118117                </para></glossdef> 
     
    130129                    <link xlink:href="#cansas1d_documentation-element-SASentry" 
    131130                        ><literal>SASentry</literal></link>. 
    132                     <indexterm><primary>SASentry</primary></indexterm>  
     131                    <indexterm><primary>element</primary><secondary>SASentry</secondary></indexterm>  
    133132                    This is similar to <literal>NXentry</literal> used by NeXus. 
    134133                    A <literal>SASentry</literal> can use an optional <literal>name</literal> attribute to provide a string for this SASentry.  
  • 1dwg/trunk/doc/src/cansas1d_element_SAScollimation.xml

    r138 r140  
    2020    <itemizedlist mark="opencircle"> 
    2121        <listitem> 
    22             <indexterm><primary>SAScollimation</primary></indexterm> 
     22            <indexterm significance="preferred"> 
     23                <primary>element</primary> 
     24                <secondary>SAScollimation</secondary> 
     25            </indexterm> 
    2326            <para> 
    2427                parent: 
     
    6265                    <row> 
    6366                        <entry> 
    64                             <para> 
    65                                 <emphasis role="bold"><emphasis>length</emphasis></emphasis> 
    66                             </para> 
     67                            <literal>length</literal> 
     68                            <indexterm> 
     69                                <primary>element</primary> 
     70                                <secondary>length</secondary> 
     71                            </indexterm> 
    6772                        </entry> 
    6873                        <entry> 
     
    7580                            Amount/length of collimation inserted (on a SANS instrument) 
    7681                        </entry> 
    77                         <entry><para><literal> unit={unit} </literal></para></entry> 
     82                        <entry><literal>unit={unit}</literal></entry> 
    7883                    </row> 
    7984                    <row> 
    8085                        <entry> 
    8186                            <literal>aperture</literal> 
     87                            <indexterm> 
     88                                <primary>element</primary> 
     89                                <secondary>aperture</secondary> 
     90                            </indexterm> 
    8291                        </entry> 
    8392                        <entry> 
     
    8998                        <entry> 
    9099                            Description of a slit or aperture.  
    91                             <emphasis role="bold"><emphasis>name</emphasis></emphasis>: Optional name attribute for this aperture.  <emphasis role="bold"><emphasis>type</emphasis></emphasis>: Optional text attribute to describe the type aperture (pinhole, 4-blade slit, Soller slit, ...). 
    92                         </entry> 
    93                         <entry><para><literal> name={type} </literal></para></entry> 
     100                            <literal>name</literal>: Optional name attribute for this aperture.   
     101                            <literal>type</literal>: Optional text attribute to describe the type  
     102                            aperture (pinhole, 4-blade slit, Soller slit, ...). 
     103                        </entry> 
     104                        <entry><literal>name={type}</literal></entry> 
    94105                    </row> 
    95106                </tbody> 
     
    118129                        <entry> 
    119130                            <literal>size</literal> 
     131                            <indexterm> 
     132                                <primary>element</primary> 
     133                                <secondary>size</secondary> 
     134                            </indexterm> 
    120135                        </entry> 
    121136                        <entry> 
     
    128143                            Opening dimensions of this aperture. 
    129144                        </entry> 
    130                         <entry><para><literal> name={name} </literal></para></entry> 
    131                     </row> 
    132                     <row> 
    133                         <entry><para><literal> distance </literal></para></entry> 
     145                        <entry><literal>name={name}</literal></entry> 
     146                    </row> 
     147                    <row> 
     148                        <entry> 
     149                            <literal>distance</literal> 
     150                            <indexterm> 
     151                                <primary>element</primary> 
     152                                <secondary>distance</secondary> 
     153                            </indexterm> 
     154                        </entry> 
    134155                        <entry> 
    135156                            floating-point number 
     
    141162                            Distance from this collimation element to the sample. 
    142163                        </entry> 
    143                         <entry><para><literal> unit={unit} </literal></para></entry> 
     164                        <entry><literal>unit={unit}</literal></entry> 
    144165                    </row> 
    145166                </tbody> 
     
    204225                        </row> 
    205226                        <row> 
    206                             <entry><para><literal> x </literal></para></entry> 
     227                            <entry> 
     228                                <literal>x</literal> 
     229                                <indexterm> 
     230                                    <primary>element</primary> 
     231                                    <secondary>x</secondary> 
     232                                </indexterm> 
     233                            </entry> 
    207234                            <entry> 
    208235                                floating-point number 
     
    212239                            </entry> 
    213240                            <entry> 
    214                                 Dimension of the collimation in X. The <emphasis role="bold">unit</emphasis> attribute is required. See cansas1d_documentation#Rules for acceptable values. 
    215                             </entry> 
    216                             <entry><para><literal> unit={unit} </literal></para></entry> 
    217                         </row> 
    218                         <row> 
    219                             <entry><para><literal> y </literal></para></entry> 
     241                                Dimension of the collimation in X.  
     242                                The <literal>unit</literal> attribute is required. See 
     243                                the section about the 
     244                                <link xlink:href="#cansas1d_documentation-rules">rules</link> 
     245                                for acceptable values. 
     246                            </entry> 
     247                            <entry><literal>unit={unit}</literal></entry> 
     248                        </row> 
     249                        <row> 
     250                            <entry> 
     251                                <literal>y</literal> 
     252                                <indexterm> 
     253                                    <primary>element</primary> 
     254                                    <secondary>y</secondary> 
     255                                </indexterm> 
     256                            </entry> 
    220257                            <entry> 
    221258                                floating-point number 
     
    225262                            </entry> 
    226263                            <entry> 
    227                                 Dimension of the collimation in Y. The <emphasis role="bold">unit</emphasis> attribute is required. See cansas1d_documentation#Rules for acceptable values. 
    228                             </entry> 
    229                             <entry><para><literal> unit={unit} </literal></para></entry> 
    230                         </row> 
    231                         <row> 
    232                             <entry><para><literal> z </literal></para></entry> 
     264                                Dimension of the collimation in Y.  
     265                                The <literal>unit</literal> attribute is required. See 
     266                                the section about the 
     267                                <link xlink:href="#cansas1d_documentation-rules">rules</link> 
     268                                for acceptable values. 
     269                            </entry> 
     270                            <entry><literal>unit={unit}</literal></entry> 
     271                        </row> 
     272                        <row> 
     273                            <entry> 
     274                                <literal>z</literal> 
     275                                <indexterm> 
     276                                    <primary>element</primary> 
     277                                    <secondary>z</secondary> 
     278                                </indexterm> 
     279                            </entry> 
    233280                            <entry> 
    234281                                floating-point number 
     
    238285                            </entry> 
    239286                            <entry> 
    240                                 Dimension of the collimation in Z. The <emphasis role="bold">unit</emphasis> attribute is required. See cansas1d_documentation#Rules for acceptable values. Note: While Z dimension is allowed by the standard (provided by use of a standard element in the XML Schema), it does not make sense for small-angle scattering. 
    241                             </entry> 
    242                             <entry><para><literal> unit={unit} </literal></para></entry> 
     287                                <para> 
     288                                    Dimension of the collimation in Z.  
     289                                    The <literal>unit</literal> 
     290                                    attribute is required. See the section about the <link 
     291                                        xlink:href="#cansas1d_documentation-rules">rules</link> for 
     292                                    acceptable values.  
     293                                    <tip> 
     294                                        <para> 
     295                                            While Z dimension is allowed by the 
     296                                            standard (provided by use of a standard element in the XML Schema), 
     297                                            it does not make sense for small-angle scattering. 
     298                                        </para> 
     299                                    </tip> 
     300                                </para> 
     301                            </entry> 
     302                            <entry><literal>unit={unit}</literal></entry> 
    243303                        </row> 
    244304                    </tbody> 
  • 1dwg/trunk/doc/src/cansas1d_element_SASdata.xml

    r138 r140  
    1616    <bridgehead> $Revision$ $Date$ </bridgehead> 
    1717    <itemizedlist mark="opencircle"> 
     18        <indexterm significance="preferred"> 
     19            <primary>element</primary> 
     20            <secondary>SASdata</secondary> 
     21        </indexterm> 
    1822        <listitem> 
    19             <indexterm significance="preferred"><primary>SASdata</primary></indexterm> 
    2023            <para> parent: <link xlink:href="#cansas1d_documentation-element-SASentry" 
    2124                ><literal>SASentry</literal></link> 
     
    7174                    <row> 
    7275                        <entry> 
    73                             <literal> 
    74                                 Idata 
    75                                 <indexterm><primary>Idata</primary></indexterm> 
    76                             </literal> 
     76                            <literal>Idata</literal> 
     77                            <indexterm> 
     78                                <primary>element</primary> 
     79                                <secondary>Idata</secondary> 
     80                            </indexterm> 
    7781                        </entry> 
    7882                        <entry> container </entry> 
     
    107111                            <para> 
    108112                                <literal>Q</literal> 
     113                                <indexterm> 
     114                                    <primary>element</primary> 
     115                                    <secondary>Q</secondary> 
     116                                </indexterm> 
    109117                            </para> 
    110118                        </entry> 
     
    133141                                typical. </para> 
    134142                        </entry> 
    135                         <entry><para><literal> unit={unit} </literal></para></entry> 
     143                        <entry><literal>unit={unit}</literal></entry> 
    136144                    </row> 
    137145                    <row> 
     
    139147                            <para> 
    140148                                <literal>I</literal> 
     149                                <indexterm> 
     150                                    <primary>element</primary> 
     151                                    <secondary>I</secondary> 
     152                                </indexterm> 
    141153                            </para> 
    142154                        </entry> 
     
    144156                        <entry> [1..1] </entry> 
    145157                        <entry> 
    146                             <para> Intensity of the detected radiation. The <literal>unit</literal>  
    147                                 attribute is required. See 
    148                                 cansas1d_documentation#Rules for acceptable values. One possibility 
     158                            <para> Intensity of the detected radiation.  
     159                                The <literal>unit</literal> attribute is required. See 
     160                                the section about the 
     161                                <link xlink:href="#cansas1d_documentation-rules">rules</link> 
     162                                for acceptable values. 
     163                                One possibility 
    149164                                might be <literal>1/cm</literal> for absolute units when the 
    150165                                intensity describes a <emphasis>differential cross-section per unit 
     
    158173                                data processing, especially in the area of units conversion. </para> 
    159174                        </entry> 
    160                         <entry><para><literal> unit={unit} </literal></para></entry> 
     175                        <entry><literal>unit={unit}</literal></entry> 
    161176                    </row> 
    162177                    <row> 
     
    164179                            <para> 
    165180                                <literal>Idev</literal> 
     181                                <indexterm> 
     182                                    <primary>element</primary> 
     183                                    <secondary>Idev</secondary> 
     184                                </indexterm> 
    166185                            </para> 
    167186                        </entry> 
     
    171190                            The <literal>unit</literal> attribute is required. See 
    172191                                <link xlink:href="#cansas1d_documentation-rules">rules for 
    173                                 units</link> 
    174                             <!--cansas1d_documentation#Rules --> for acceptable values. One 
     192                                units</link> for acceptable values. One 
    175193                            possibility might be <literal>1/cm</literal>. </entry> 
    176                         <entry><para><literal> unit={unit} </literal></para></entry> 
     194                        <entry><literal>unit={unit}</literal></entry> 
    177195                    </row> 
    178196                    <row> 
     
    180198                            <para> 
    181199                                <literal>Qdev</literal> 
     200                                <indexterm> 
     201                                    <primary>element</primary> 
     202                                    <secondary>Qdev</secondary> 
     203                                </indexterm> 
    182204                            </para> 
    183205                        </entry> 
     
    187209                            (optional: see note below on usage) 
    188210                            The <literal>unit</literal>  
    189                                 attribute is required. See <link 
     211                            attribute is required. See <link 
    190212                                xlink:href="#cansas1d_documentation-rules">rules for units</link> 
    191                             <!--cansas1d_documentation#Rules --> for acceptable values. Either 
     213                            for acceptable values. Either 
    192214                            <literal>1/A</literal> or <literal>1/nm</literal> are typical. </entry> 
    193                         <entry><para><literal> unit={unit} </literal></para></entry> 
     215                        <entry><literal>unit={unit}</literal></entry> 
    194216                    </row> 
    195217                    <row> 
     
    197219                            <para> 
    198220                                <literal>dQw</literal> 
     221                                <indexterm> 
     222                                    <primary>element</primary> 
     223                                    <secondary>dQw</secondary> 
     224                                </indexterm> 
    199225                            </para> 
    200226                        </entry> 
     
    210236                            <para> The <literal>unit</literal> attribute is required. 
    211237                                See <link xlink:href="#cansas1d_documentation-rules">rules for 
    212                                     units</link> 
    213                                 <!--cansas1d_documentation#Rules --> for acceptable values. Either 
     238                                    units</link> for acceptable values. Either 
    214239                                <literal>1/A</literal> or <literal>1/nm</literal> are 
    215240                                typical. </para> 
    216241                        </entry> 
    217                         <entry><para><literal> unit={unit} </literal></para></entry> 
     242                        <entry><literal>unit={unit}</literal></entry> 
    218243                    </row> 
    219244                    <row> 
     
    221246                            <para> 
    222247                                <literal>dQl</literal> 
     248                                <indexterm> 
     249                                    <primary>element</primary> 
     250                                    <secondary>dQl</secondary> 
     251                                </indexterm> 
    223252                            </para> 
    224253                        </entry> 
     
    228257                            <para> 
    229258                                <literal>Q</literal> resolution perpendicular to the 
    230                                 axis of scanning (the low-resolution <emphasis>slit 
    231                                     length</emphasis> direction). Useful for defining resolution 
     259                                axis of scanning (the low-resolution <literal>slit 
     260                                    length</literal> direction). Useful for defining resolution 
    232261                                data from slit-smearing instruments such as Bonse-Hart geometry. 
    233262                                (optional: see note below on usage) 
    234263                                The <literal>unit</literal> attribute is required. See <link 
    235264                                    xlink:href="#cansas1d_documentation-rules">rules for 
    236                                     units</link> 
    237                                 <!--cansas1d_documentation#Rules --> for acceptable values. Either 
     265                                    units</link> for acceptable values. Either 
    238266                                <literal>1/A</literal> or <literal>1/nm</literal> are 
    239267                                typical. </para> 
    240268                        </entry> 
    241                         <entry><para><literal> unit={unit} </literal></para></entry> 
     269                        <entry><literal>unit={unit}</literal></entry> 
    242270                    </row> 
    243271                    <row> 
     
    245273                            <para> 
    246274                                <literal>Qmean</literal> 
     275                                <indexterm> 
     276                                    <primary>element</primary> 
     277                                    <secondary>Qmean</secondary> 
     278                                </indexterm> 
    247279                            </para> 
    248280                        </entry> 
     
    254286                            attribute is required. See <link 
    255287                                xlink:href="#cansas1d_documentation-rules">rules for units</link> 
    256                             <!--cansas1d_documentation#Rules --> for acceptable values. Either 
     288                            for acceptable values. Either 
    257289                            <literal>1/A</literal> or <literal>1/nm</literal> are typical. </entry> 
    258                         <entry><para><literal> unit={unit} </literal></para></entry> 
     290                        <entry><literal>unit={unit}</literal></entry> 
    259291                    </row> 
    260292                    <row> 
     
    262294                            <para> 
    263295                                <literal>Shadowfactor</literal> 
     296                                <indexterm> 
     297                                    <primary>element</primary> 
     298                                    <secondary>Shadowfactor</secondary> 
     299                                </indexterm> 
    264300                            </para> 
    265301                        </entry> 
     
    268304                        <entry> 
    269305                            <para> Describes the adjustment due to the beam stop penumbra. </para> 
     306                            <tip> 
     307                                <para>There is no unit attribute.</para> 
     308                            </tip> 
    270309                            <caution> 
    271310                                <para>This definition needs revision. NIST?</para> 
    272311                            </caution> 
    273                             <note> 
    274                                 <para>There is no unit attribute.</para> 
    275                             </note> 
    276312                        </entry> 
    277313                        <entry/> 
     
    279315                    <row> 
    280316                        <entry> 
    281                             <link xlink:href="#cansas1d_documentation-element-any"><literal>{any}</literal></link> 
     317                            <link xlink:href="#cansas1d_documentation-element-any" 
     318                                ><literal>{any}</literal></link> 
    282319                        </entry> 
    283320                        <entry> container </entry> 
     
    285322                        <entry> Any element(s) not defined in the cansas1d/1.0 standard can be 
    286323                            placed at this point.  
    287                             See <link xlink:href="#cansas1d_documentation-element-any"><literal>{any}</literal></link> 
     324                            See <link xlink:href="#cansas1d_documentation-element-any" 
     325                                ><literal>{any}</literal></link> 
    288326                            for more details. </entry> 
    289327                        <entry> 
     
    303341        <orderedlist numeration="arabic"> 
    304342            <listitem> 
    305                 <para> When an optional element (<literal>Idev</literal>, <literal>Qdev</literal>, ...)  
     343                <para> When an optional element  
     344                    (<literal>Idev</literal>, <literal>Qdev</literal>, ...)  
    306345                    is used, it must be given in 
    307                     every <literal>Idata</literal> within the enclosing <literal>SASdata</literal>. </para> 
     346                    every <literal>Idata</literal> within the  
     347                    enclosing <literal>SASdata</literal>. </para> 
    308348            </listitem> 
    309349            <listitem> 
     
    316356        <note> 
    317357            <para> 
    318                 <emphasis role="bold">(The Shadowfactor attribute definition needs revision. 
    319                     NIST?)</emphasis> 
     358                <emphasis role="bold">The Shadowfactor attribute definition needs revision. 
     359                    NIST?</emphasis> 
    320360            </para> 
    321361        </note> 
  • 1dwg/trunk/doc/src/cansas1d_element_SASdetector.xml

    r138 r140  
    1919    </bridgehead> 
    2020    <itemizedlist mark="opencircle"> 
     21        <indexterm significance="preferred"> 
     22            <primary>element</primary> 
     23            <secondary>SASdetector</secondary> 
     24        </indexterm> 
    2125        <listitem> 
    22             <indexterm><primary>SASdetector</primary></indexterm> 
    2326            <para> 
    2427                parent:  
     
    6164                    </row> 
    6265                    <row> 
    63                         <entry><para><literal> name </literal></para></entry> 
     66                        <entry> 
     67                            <literal>name</literal> 
     68                            <indexterm> 
     69                                <primary>element</primary> 
     70                                <secondary>name</secondary> 
     71                            </indexterm> 
     72                        </entry> 
    6473                        <entry> 
    6574                            string 
     
    7483                    </row> 
    7584                    <row> 
    76                         <entry><para><literal> SDD </literal></para></entry> 
     85                        <entry> 
     86                            <literal>SDD</literal> 
     87                            <indexterm> 
     88                                <primary>element</primary> 
     89                                <secondary>SDD</secondary> 
     90                            </indexterm> 
     91                        </entry> 
    7792                        <entry> 
    7893                            floating-point number 
     
    8499                            Distance between sample and detector. 
    85100                        </entry> 
    86                         <entry><para><literal> unit={unit} </literal></para></entry> 
     101                        <entry><literal>unit={unit}</literal></entry> 
    87102                    </row> 
    88103                    <row> 
    89104                        <entry> 
    90105                            <literal>offset</literal> 
     106                            <indexterm> 
     107                                <primary>element</primary> 
     108                                <secondary>offset</secondary> 
     109                            </indexterm> 
    91110                        </entry> 
    92111                        <entry> 
     
    104123                        <entry> 
    105124                            <literal>orientation</literal> 
     125                            <indexterm> 
     126                                <primary>element</primary> 
     127                                <secondary>orientation</secondary> 
     128                            </indexterm> 
    106129                        </entry> 
    107130                        <entry> 
     
    119142                        <entry> 
    120143                            <literal>beam_center</literal> 
     144                            <indexterm> 
     145                                <primary>element</primary> 
     146                                <secondary>beam_center</secondary> 
     147                            </indexterm> 
    121148                        </entry> 
    122149                        <entry> 
     
    134161                        <entry> 
    135162                            <literal>pixel_size</literal> 
     163                            <indexterm> 
     164                                <primary>element</primary> 
     165                                <secondary>pixel_size</secondary> 
     166                            </indexterm> 
    136167                        </entry> 
    137168                        <entry> 
     
    147178                    </row> 
    148179                    <row> 
    149                         <entry><para><literal> slit_length </literal></para></entry> 
     180                        <entry> 
     181                            <literal>slit_length</literal> 
     182                            <indexterm> 
     183                                <primary>element</primary> 
     184                                <secondary>slit_length</secondary> 
     185                            </indexterm> 
     186                        </entry> 
    150187                        <entry> 
    151188                            floating-point number 
     
    158195                            This is expressed in the same units as Q (reciprocal space units). 
    159196                        </entry> 
    160                         <entry><para><literal> unit={unit} </literal></para></entry> 
     197                        <entry><literal>unit={unit}</literal></entry> 
    161198                    </row> 
    162199                </tbody> 
     
    234271                    </row> 
    235272                    <row> 
    236                         <entry><para><literal> x </literal></para></entry> 
     273                        <entry> 
     274                            <literal>x</literal> 
     275                            <indexterm> 
     276                                <primary>element</primary> 
     277                                <secondary>x</secondary> 
     278                            </indexterm> 
     279                        </entry> 
     280                        <entry> 
     281                            floating-point number 
     282                        </entry> 
     283                        <entry> 
     284                            [0..1] 
     285                        </entry> 
     286                        <entry> 
     287                            Offset of the detector position in X.  
     288                            The <literal>unit</literal> attribute is required. See 
     289                            the section about the 
     290                            <link xlink:href="#cansas1d_documentation-rules">rules</link> 
     291                            for acceptable values. 
     292                        </entry> 
     293                        <entry><literal>unit={unit}</literal></entry> 
     294                </row> 
     295                    <row> 
     296                        <entry> 
     297                            <literal>y</literal> 
     298                            <indexterm> 
     299                                <primary>element</primary> 
     300                                <secondary>y</secondary> 
     301                            </indexterm> 
     302                        </entry> 
    237303                    <entry> 
    238304                        floating-point number 
     
    242308                    </entry> 
    243309                    <entry> 
    244                         Offset of the detector position in X. The <emphasis role="bold">unit</emphasis> attribute is required. See cansas1d_documentation#Rules for acceptable values. 
    245                     </entry> 
    246                     <entry><para><literal> unit={unit} </literal></para></entry> 
     310                        Offset of the detector position in Y.  
     311                        The <literal>unit</literal> attribute is required. See 
     312                        the section about the 
     313                        <link xlink:href="#cansas1d_documentation-rules">rules</link> 
     314                        for acceptable values. 
     315                    </entry> 
     316                    <entry><literal>unit={unit}</literal></entry> 
    247317                </row> 
    248318                    <row> 
    249                         <entry><para><literal> y </literal></para></entry> 
     319                        <entry> 
     320                            <literal>z</literal> 
     321                            <indexterm> 
     322                                <primary>element</primary> 
     323                                <secondary>z</secondary> 
     324                            </indexterm> 
     325                        </entry> 
    250326                    <entry> 
    251327                        floating-point number 
     
    255331                    </entry> 
    256332                    <entry> 
    257                         Offset of the detector position in Y. The <emphasis role="bold">unit</emphasis> attribute is required. See cansas1d_documentation#Rules for acceptable values. 
    258                     </entry> 
    259                     <entry><para><literal> unit={unit} </literal></para></entry> 
    260                 </row> 
    261                     <row> 
    262                         <entry><para><literal> z </literal></para></entry> 
    263                     <entry> 
    264                         floating-point number 
    265                     </entry> 
    266                     <entry> 
    267                         [0..1] 
    268                     </entry> 
    269                     <entry> 
    270                         Offset of the detector position in Z. The <emphasis role="bold">unit</emphasis> attribute is required. See cansas1d_documentation#Rules for acceptable values. Note: While Z is allowed by the standard (provided by use of a standard element in the XML Schema), it does not make sense for small-angle scattering. 
    271                     </entry> 
    272                     <entry><para><literal> unit={unit} </literal></para></entry> 
     333                        <para> 
     334                            Offset of the detector position in Z.  
     335                            The <literal>unit</literal> 
     336                            attribute is required. See the section about the <link 
     337                                xlink:href="#cansas1d_documentation-rules">rules</link> for 
     338                            acceptable values.  
     339                            <tip> 
     340                                <para> 
     341                                    While Z dimension is allowed by the 
     342                                    standard (provided by use of a standard element in the XML Schema), 
     343                                    it does not make sense for small-angle scattering. 
     344                                </para> 
     345                            </tip> 
     346                        </para> 
     347                    </entry> 
     348                    <entry><literal>unit={unit}</literal></entry> 
    273349                </row> 
    274350                </tbody> 
     
    295371                    </row> 
    296372                    <row> 
    297                         <entry><para><literal> roll </literal></para></entry> 
    298                         <entry> 
    299                             floating-point number 
    300                         </entry> 
    301                         <entry> 
    302                             [0..1] 
    303                         </entry> 
    304                         <entry> 
    305                             Rotation about the <emphasis>Z</emphasis> axis (roll). The <emphasis role="bold">unit</emphasis> attribute is required. See cansas1d_documentation#Rules for acceptable values. 
    306                         </entry> 
    307                         <entry><para><literal> unit={unit} </literal></para></entry> 
    308                     </row> 
    309                     <row> 
    310                         <entry><para><literal> pitch </literal></para></entry> 
    311                         <entry> 
    312                             floating-point number 
    313                         </entry> 
    314                         <entry> 
    315                             [0..1] 
    316                         </entry> 
    317                         <entry> 
    318                             Rotation about the <emphasis>X</emphasis> axis (pitch). The <emphasis role="bold">unit</emphasis> attribute is required. See cansas1d_documentation#Rules for acceptable values. 
    319                         </entry> 
    320                         <entry><para><literal> unit={unit} </literal></para></entry> 
    321                     </row> 
    322                     <row> 
    323                         <entry><para><literal> yaw </literal></para></entry> 
    324                         <entry> 
    325                             floating-point number 
    326                         </entry> 
    327                         <entry> 
    328                             [0..1] 
    329                         </entry> 
    330                         <entry> 
    331                             Rotation about the <emphasis>Y</emphasis> axis (yaw). The <emphasis role="bold">unit</emphasis> attribute is required. See cansas1d_documentation#Rules for acceptable values. 
    332                         </entry> 
    333                         <entry><para><literal> unit={unit} </literal></para></entry> 
     373                        <entry> 
     374                            <literal>roll</literal> 
     375                            <indexterm> 
     376                                <primary>element</primary> 
     377                                <secondary>roll</secondary> 
     378                            </indexterm> 
     379                        </entry> 
     380                        <entry> 
     381                            floating-point number 
     382                        </entry> 
     383                        <entry> 
     384                            [0..1] 
     385                        </entry> 
     386                        <entry> 
     387                            Rotation about the <literal>Z</literal> axis (roll).  
     388                            The <literal>unit</literal> attribute is required. See 
     389                            the section about the 
     390                            <link xlink:href="#cansas1d_documentation-rules">rules</link> 
     391                            for acceptable values. 
     392                        </entry> 
     393                        <entry><literal>unit={unit}</literal></entry> 
     394                    </row> 
     395                    <row> 
     396                        <entry> 
     397                            <literal>pitch</literal> 
     398                            <indexterm> 
     399                                <primary>element</primary> 
     400                                <secondary>pitch</secondary> 
     401                            </indexterm> 
     402                        </entry> 
     403                        <entry> 
     404                            floating-point number 
     405                        </entry> 
     406                        <entry> 
     407                            [0..1] 
     408                        </entry> 
     409                        <entry> 
     410                            Rotation about the <literal>X</literal> axis (pitch).  
     411                            The <literal>unit</literal> attribute is required. See 
     412                            the section about the 
     413                            <link xlink:href="#cansas1d_documentation-rules">rules</link> 
     414                            for acceptable values. 
     415                        </entry> 
     416                        <entry><literal>unit={unit}</literal></entry> 
     417                    </row> 
     418                    <row> 
     419                        <entry> 
     420                            <literal>yaw</literal> 
     421                            <indexterm> 
     422                                <primary>element</primary> 
     423                                <secondary>yaw</secondary> 
     424                            </indexterm> 
     425                        </entry> 
     426                        <entry> 
     427                            floating-point number 
     428                        </entry> 
     429                        <entry> 
     430                            [0..1] 
     431                        </entry> 
     432                        <entry> 
     433                            Rotation about the <literal>Y</literal> axis (yaw).  
     434                            The <literal>unit</literal> attribute is required. See 
     435                            the section about the 
     436                            <link xlink:href="#cansas1d_documentation-rules">rules</link> 
     437                            for acceptable values. 
     438                        </entry> 
     439                        <entry><literal>unit={unit}</literal></entry> 
    334440                    </row> 
    335441                </tbody> 
     
    356462                    </row> 
    357463                    <row> 
    358                         <entry><para><literal> x </literal></para></entry> 
    359                         <entry> 
    360                             floating-point number 
    361                         </entry> 
    362                         <entry> 
    363                             [0..1] 
    364                         </entry> 
    365                         <entry> 
    366                             Position of the beam center on the detector in X. The <emphasis role="bold">unit</emphasis> attribute is required. See cansas1d_documentation#Rules for acceptable values. 
    367                         </entry> 
    368                         <entry><para><literal> unit={unit} </literal></para></entry> 
    369                     </row> 
    370                     <row> 
    371                         <entry><para><literal> y </literal></para></entry> 
    372                         <entry> 
    373                             floating-point number 
    374                         </entry> 
    375                         <entry> 
    376                             [0..1] 
    377                         </entry> 
    378                         <entry> 
    379                             Position of the beam center on the detector in Y. The <emphasis role="bold">unit</emphasis> attribute is required. See cansas1d_documentation#Rules for acceptable values. 
    380                         </entry> 
    381                         <entry><para><literal> unit={unit} </literal></para></entry> 
    382                     </row> 
    383                     <row> 
    384                         <entry><para><literal> z </literal></para></entry> 
    385                         <entry> 
    386                             floating-point number 
    387                         </entry> 
    388                         <entry> 
    389                             [0..1] 
    390                         </entry> 
    391                         <entry> 
    392                             Position of the beam center on the detector in Z. The <emphasis role="bold">unit</emphasis> attribute is required. See cansas1d_documentation#Rules for acceptable values. Note: While Z dimension is allowed by the standard (provided by use of a standard element in the XML Schema), it does not make sense for small-angle scattering. 
    393                         </entry> 
    394                         <entry><para><literal> unit={unit} </literal></para></entry> 
     464                        <entry> 
     465                            <literal>x</literal> 
     466                            <indexterm> 
     467                                <primary>element</primary> 
     468                                <secondary>x</secondary> 
     469                            </indexterm> 
     470                        </entry> 
     471                        <entry> 
     472                            floating-point number 
     473                        </entry> 
     474                        <entry> 
     475                            [0..1] 
     476                        </entry> 
     477                        <entry> 
     478                            Position of the beam center on the detector in X.  
     479                            The <literal>unit</literal> attribute is required. See 
     480                            the section about the 
     481                            <link xlink:href="#cansas1d_documentation-rules">rules</link> 
     482                            for acceptable values. 
     483                        </entry> 
     484                        <entry><literal>unit={unit}</literal></entry> 
     485                    </row> 
     486                    <row> 
     487                        <entry> 
     488                            <literal>y</literal> 
     489                            <indexterm> 
     490                                <primary>element</primary> 
     491                                <secondary>y</secondary> 
     492                            </indexterm> 
     493                        </entry> 
     494                        <entry> 
     495                            floating-point number 
     496                        </entry> 
     497                        <entry> 
     498                            [0..1] 
     499                        </entry> 
     500                        <entry> 
     501                            Position of the beam center on the detector in Y.  
     502                            The <literal>unit</literal> attribute is required. See 
     503                            the section about the 
     504                            <link xlink:href="#cansas1d_documentation-rules">rules</link> 
     505                            for acceptable values. 
     506                        </entry> 
     507                        <entry><literal>unit={unit}</literal></entry> 
     508                    </row> 
     509                    <row> 
     510                        <entry> 
     511                            <literal>z</literal> 
     512                            <indexterm> 
     513                                <primary>element</primary> 
     514                                <secondary>z</secondary> 
     515                            </indexterm> 
     516                        </entry> 
     517                        <entry> 
     518                            floating-point number 
     519                        </entry> 
     520                        <entry> 
     521                            [0..1] 
     522                        </entry> 
     523                        <entry> 
     524                            <para> 
     525                                Position of the beam center on the detector in Z.  
     526                                The <literal>unit</literal> 
     527                                attribute is required. See the section about the <link 
     528                                    xlink:href="#cansas1d_documentation-rules">rules</link> for 
     529                                acceptable values.  
     530                                <tip> 
     531                                    <para> 
     532                                        While Z dimension is allowed by the 
     533                                        standard (provided by use of a standard element in the XML Schema), 
     534                                        it does not make sense for small-angle scattering. 
     535                                    </para> 
     536                                </tip> 
     537                            </para> 
     538                        </entry> 
     539                        <entry><literal>unit={unit}</literal></entry> 
    395540                    </row> 
    396541                </tbody> 
     
    417562                    </row> 
    418563                    <row> 
    419                         <entry><para><literal> x </literal></para></entry> 
     564                        <entry> 
     565                            <literal>x</literal> 
     566                            <indexterm> 
     567                                <primary>element</primary> 
     568                                <secondary>x</secondary> 
     569                            </indexterm> 
     570                        </entry> 
    420571                    <entry> 
    421572                        floating-point number 
     
    425576                    </entry> 
    426577                    <entry> 
    427                         Size of a detector pixel in X. The <emphasis role="bold">unit</emphasis> attribute is required. See cansas1d_documentation#Rules for acceptable values. 
    428                     </entry> 
    429                     <entry><para><literal> unit={unit} </literal></para></entry> 
     578                        Size of a detector pixel in X.  
     579                        The <literal>unit</literal> attribute is required. See 
     580                        the section about the 
     581                        <link xlink:href="#cansas1d_documentation-rules">rules</link> 
     582                        for acceptable values. 
     583                    </entry> 
     584                        <entry><literal>unit={unit}</literal></entry> 
    430585                </row> 
    431586                    <row> 
    432                         <entry><para><literal> y </literal></para></entry> 
     587                        <entry> 
     588                            <literal>y</literal> 
     589                            <indexterm> 
     590                                <primary>element</primary> 
     591                                <secondary>y</secondary> 
     592                            </indexterm> 
     593                        </entry> 
    433594                    <entry> 
    434595                        floating-point number 
     
    438599                    </entry> 
    439600                    <entry> 
    440                         Size of a detector pixel in Y. The <emphasis role="bold">unit</emphasis> attribute is required. See cansas1d_documentation#Rules for acceptable values. 
    441                     </entry> 
    442                     <entry><para><literal> unit={unit} </literal></para></entry> 
     601                        Size of a detector pixel in Y.  
     602                        The <literal>unit</literal> attribute is required. See 
     603                        the section about the 
     604                        <link xlink:href="#cansas1d_documentation-rules">rules</link> 
     605                        for acceptable values. 
     606                    </entry> 
     607                        <entry><literal>unit={unit}</literal></entry> 
    443608                </row> 
    444609                    <row> 
    445                         <entry><para><literal> z </literal></para></entry> 
     610                        <entry> 
     611                            <literal>z</literal> 
     612                            <indexterm> 
     613                                <primary>element</primary> 
     614                                <secondary>z</secondary> 
     615                            </indexterm> 
     616                        </entry> 
    446617                    <entry> 
    447618                        floating-point number 
     
    451622                    </entry> 
    452623                    <entry> 
    453                         Size of a detector pixel in Z. The <emphasis role="bold">unit</emphasis> attribute is required. See cansas1d_documentation#Rules for acceptable values. Note: While Z dimension is allowed by the standard (provided by use of a standard element in the XML Schema), it does not make sense for small-angle scattering. 
    454                     </entry> 
    455                     <entry><para><literal> unit={unit} </literal></para></entry> 
     624                        <para> 
     625                            Size of a detector pixel in Z.  
     626                            The <literal>unit</literal> 
     627                            attribute is required. See the section about the <link 
     628                                xlink:href="#cansas1d_documentation-rules">rules</link> for 
     629                            acceptable values.  
     630                            <tip> 
     631                                <para> 
     632                                    While Z dimension is allowed by the 
     633                                    standard (provided by use of a standard element in the XML Schema), 
     634                                    it does not make sense for small-angle scattering. 
     635                                </para> 
     636                            </tip> 
     637                        </para> 
     638                    </entry> 
     639                    <entry><literal>unit={unit}</literal></entry> 
    456640                </row> 
    457641            </tbody></tgroup> 
  • 1dwg/trunk/doc/src/cansas1d_element_SASentry.xml

    r138 r140  
    2020    <itemizedlist mark="opencircle"> 
    2121        <listitem> 
    22             <indexterm><primary>SASentry</primary></indexterm> 
     22            <indexterm significance="preferred"> 
     23                <primary>element</primary> 
     24                <secondary>SASentry</secondary> 
     25            </indexterm> 
    2326            <para> 
    2427                                parent: 
    25                                 <link xlink:href="#cansas1d_documentation-element-SASroot">SASroot</link> 
     28                                <link xlink:href="#cansas1d_documentation-element-SASroot"><literal>SASroot</literal></link> 
    2629            </para> 
    2730        </listitem> 
     
    5962                </row> 
    6063                <row> 
    61                     <entry><para><literal> Title </literal></para></entry> 
     64                    <entry> 
     65                        <literal>Title</literal> 
     66                        <indexterm> 
     67                            <primary>element</primary> 
     68                            <secondary>Title</secondary> 
     69                        </indexterm> 
     70                    </entry> 
    6271                    <entry> 
    6372                        string 
     
    6776                    </entry> 
    6877                    <entry> 
    69                         Title of this <emphasis role="bold">SASentry</emphasis>. 
     78                        Title of this <literal>SASentry</literal>. 
    7079                    </entry> 
    7180                    <entry/> 
    7281                </row> 
    7382                <row> 
    74                     <entry><para><literal> Run </literal></para></entry> 
     83                    <entry> 
     84                        <literal>Run</literal> 
     85                        <indexterm> 
     86                            <primary>element</primary> 
     87                            <secondary>Run</secondary> 
     88                        </indexterm> 
     89                    </entry> 
    7590                    <entry> 
    7691                        string 
     
    99114                        </para> 
    100115                    </entry> 
    101                     <entry> 
    102                         <para> 
    103                             <literal>name</literal>={short-Run-identifier} 
    104                         </para> 
    105                     </entry> 
    106                 </row> 
    107                 <row> 
    108                     <entry> 
    109                         <link xlink:href="#cansas1d_documentation-element-any"><literal>{any}</literal></link> 
     116                    <entry><literal>name={short-Run-identifier}</literal></entry> 
     117                </row> 
     118                <row> 
     119                    <entry> 
     120                        <link xlink:href="#cansas1d_documentation-element-any" 
     121                            ><literal>{any}</literal></link> 
    110122                    </entry> 
    111123                    <entry> 
     
    117129                    <entry> 
    118130                        Any element(s) not defined in the cansas1d/1.0 standard can be placed at this point.  
    119                         See <link xlink:href="#cansas1d_documentation-element-any"><literal>{any}</literal></link>  
     131                        See <link xlink:href="#cansas1d_documentation-element-any" 
     132                            ><literal>{any}</literal></link>  
    120133                        for more details. 
    121134                    </entry> 
    122                     <entry> 
    123                         <para> 
    124                             <literal>xmlns:{foreign-prefix}={foreign-namespace}</literal> 
    125                         </para> 
    126                     </entry> 
    127                 </row> 
    128                 <row> 
    129                     <entry> 
    130                         <link xlink:href="#cansas1d_documentation-element-SASdata"><literal>SASdata</literal></link> 
     135                    <entry><literal>xmlns:{foreign-prefix}={foreign-namespace}</literal></entry> 
     136                </row> 
     137                <row> 
     138                    <entry> 
     139                        <link xlink:href="#cansas1d_documentation-element-SASdata" 
     140                            ><literal>SASdata</literal></link> 
     141                        <indexterm> 
     142                            <primary>element</primary> 
     143                            <secondary>SASdata</secondary> 
     144                        </indexterm> 
    131145                    </entry> 
    132146                    <entry> 
     
    142156                        elements with <literal>Run</literal> elements. (Give them the same name.) 
    143157                    </entry> 
    144                     <entry> 
    145                         <para><literal>name={short-Run-identifier}</literal></para> 
    146                     </entry> 
     158                    <entry><literal>name={short-Run-identifier}</literal></entry> 
    147159                </row> 
    148160                <row> 
     
    161173                        for more details. 
    162174                    </entry> 
    163                     <entry> 
    164                         <para><literal>xmlns:{foreign-prefix}={foreign-namespace}</literal></para> 
    165                     </entry> 
    166                 </row> 
    167                 <row> 
    168                     <entry> 
    169                         <link xlink:href="#cansas1d_documentation-element-SASsample"><literal>SASsample</literal></link> 
     175                    <entry><literal>xmlns:{foreign-prefix}={foreign-namespace}</literal></entry> 
     176                </row> 
     177                <row> 
     178                    <entry> 
     179                        <link xlink:href="#cansas1d_documentation-element-SASsample" 
     180                            ><literal>SASsample</literal></link> 
     181                        <indexterm> 
     182                            <primary>element</primary> 
     183                            <secondary>SASsample</secondary> 
     184                        </indexterm> 
    170185                    </entry> 
    171186                    <entry> 
     
    178193                        Description of the sample. 
    179194                    </entry> 
    180                     <entry> 
    181                         <para><literal>name={short-SASsample-identifier}</literal></para> 
    182                     </entry> 
    183                 </row> 
    184                 <row> 
    185                     <entry> 
    186                         <link xlink:href="#cansas1d_documentation-element-SASinstrument"><literal>SASinstrument</literal></link> 
     195                    <entry><literal>name={short-SASsample-identifier}</literal></entry> 
     196                </row> 
     197                <row> 
     198                    <entry> 
     199                        <link xlink:href="#cansas1d_documentation-element-SASinstrument" 
     200                            ><literal>SASinstrument</literal></link> 
     201                        <indexterm> 
     202                            <primary>element</primary> 
     203                            <secondary>SASinstrument</secondary> 
     204                        </indexterm> 
    187205                    </entry> 
    188206                    <entry> 
     
    199217                <row> 
    200218                    <entry> 
    201                         <link xlink:href="#cansas1d_documentation-element-SASprocess"><literal>SASprocess</literal></link> 
     219                        <link xlink:href="#cansas1d_documentation-element-SASprocess" 
     220                            ><literal>SASprocess</literal></link> 
     221                        <indexterm> 
     222                            <primary>element</primary> 
     223                            <secondary>SASprocess</secondary> 
     224                        </indexterm> 
    202225                    </entry> 
    203226                    <entry> 
     
    210233                        Description of a processing or analysis step. 
    211234                    </entry> 
    212                     <entry> 
    213                         <para><literal>name={short-SASprocess-identifier}</literal></para> 
    214                     </entry> 
    215                 </row> 
    216                 <row> 
    217                     <entry> 
    218                         <link xlink:href="#cansas1d_documentation-element-SASnote"><literal>SASnote</literal></link> 
     235                    <entry><literal>name={short-SASprocess-identifier}</literal></entry> 
     236                </row> 
     237                <row> 
     238                    <entry> 
     239                        <link xlink:href="#cansas1d_documentation-element-SASnote" 
     240                            ><literal>SASnote</literal></link> 
     241                        <indexterm> 
     242                            <primary>element</primary> 
     243                            <secondary>SASnote</secondary> 
     244                        </indexterm> 
    219245                    </entry> 
    220246                    <entry> 
     
    227253                        Free form description of anything not covered by other elements. 
    228254                    </entry> 
    229                     <entry> 
    230                         <para><literal>name={short-SASnote-identifier}</literal></para> 
    231                     </entry> 
     255                    <entry><literal>name={short-SASnote-identifier}</literal></entry> 
    232256                </row> 
    233257            </tbody> 
  • 1dwg/trunk/doc/src/cansas1d_element_SASinstrument.xml

    r138 r140  
    2020    <itemizedlist mark="opencircle"> 
    2121        <listitem> 
    22             <indexterm><primary>SASinstrument</primary></indexterm> 
     22            <indexterm significance="preferred"> 
     23                <primary>element</primary> 
     24                <secondary>SASinstrument</secondary> 
     25            </indexterm> 
    2326            <para> 
    2427                parent: 
    25                 <link xlink:href="#cansas1d_documentation-element-SASentry">SASentry</link> 
     28                <link xlink:href="#cansas1d_documentation-element-SASentry"><literal>SASentry</literal></link> 
    2629            </para> 
    2730        </listitem> 
     
    5962                </row> 
    6063            <row> 
    61                 <entry> 
    62                     <para> 
    63                         <emphasis role="bold">name</emphasis> 
    64                     </para> 
    65                 </entry> 
     64                <entry><literal>name</literal></entry> 
    6665                <entry> 
    6766                    string 
     
    7776            <row> 
    7877                <entry> 
    79                     <literal>SASsource</literal> 
     78                    <link xlink:href="#cansas1d_documentation-element-SASsource"><literal>SASsource</literal></link> 
    8079                </entry> 
    8180                <entry> 
     
    9493            <row> 
    9594                <entry> 
    96                     <literal>SAScollimation</literal> 
     95                    <link xlink:href="#cansas1d_documentation-element-SAScollimation"><literal>SAScollimation</literal></link> 
    9796                </entry> 
    9897                <entry> 
     
    111110            <row> 
    112111                <entry> 
    113                     <literal>SASdetector</literal> 
     112                    <link xlink:href="#cansas1d_documentation-element-SASdetector"><literal>SASdetector</literal></link> 
    114113                </entry> 
    115114                <entry> 
     
    127126        </tgroup> 
    128127    </table> 
    129      
    130128</section> 
  • 1dwg/trunk/doc/src/cansas1d_element_SASnote.xml

    r131 r140  
    2020    <itemizedlist mark="opencircle"> 
    2121        <listitem> 
    22             <indexterm><primary>SASnote</primary></indexterm> 
     22            <indexterm significance="preferred"> 
     23                <primary>element</primary> 
     24                <secondary>SASnote</secondary> 
     25            </indexterm> 
    2326            <para> 
    2427                parent: 
     
    7477                    <entry> 
    7578                        <para> 
    76                             <emphasis role="bold"><emphasis>xmlns:{foreign-prefix}</emphasis></emphasis>={foreign-namespace} 
     79                            <literal>xmlns:{foreign-prefix}={foreign-namespace}</literal> 
    7780                        </para> 
    7881                    </entry> 
     
    8184        </tgroup> 
    8285    </table> 
    83      
    8486</section> 
  • 1dwg/trunk/doc/src/cansas1d_element_SASprocess.xml

    r138 r140  
    2020    <itemizedlist mark="opencircle"> 
    2121        <listitem> 
    22             <indexterm><primary>SASprocess</primary></indexterm> 
     22            <indexterm significance="preferred"> 
     23                <primary>element</primary> 
     24                <secondary>SASprocess</secondary> 
     25            </indexterm> 
    2326            <para> 
    2427                parent: 
     
    5861                </row> 
    5962                <row> 
    60                     <entry><para><literal> name </literal></para></entry> 
     63                    <entry> 
     64                        <literal>name</literal> 
     65                        <indexterm> 
     66                            <primary>element</primary> 
     67                            <secondary>name</secondary> 
     68                        </indexterm> 
     69                    </entry> 
    6170                    <entry> 
    6271                        string 
     
    7180                </row> 
    7281                <row> 
    73                     <entry><para><literal> date </literal></para></entry> 
     82                    <entry><literal>date</literal> 
     83                        <indexterm> 
     84                            <primary>element</primary> 
     85                            <secondary>date</secondary> 
     86                        </indexterm> 
     87                    </entry> 
    7488                    <entry> 
    7589                        string 
     
    86100                </row> 
    87101                <row> 
    88                     <entry><para><literal> description </literal></para></entry> 
     102                    <entry> 
     103                        <literal>description</literal> 
     104                        <indexterm> 
     105                            <primary>element</primary> 
     106                            <secondary>description</secondary> 
     107                        </indexterm> 
     108                    </entry> 
    89109                    <entry> 
    90110                        string 
     
    99119                </row> 
    100120                <row> 
    101                     <entry><para><literal> term </literal></para></entry> 
     121                    <entry><literal>term</literal> 
     122                        <indexterm> 
     123                            <primary>element</primary> 
     124                            <secondary>term</secondary> 
     125                        </indexterm> 
     126                    </entry> 
    102127                    <entry> 
    103128                        string 
     
    111136                        <literal>SASprocess</literal> step. 
    112137                    </entry> 
    113                     <entry><para><literal> unit={unit} </literal></para></entry> 
     138                    <entry><literal>unit={unit}</literal></entry> 
    114139                </row> 
    115140                <row> 
     
    117142                        <link xlink:href="#cansas1d_documentation-element-SASprocessnote" 
    118143                            ><literal>SASprocessnote</literal></link> 
     144                        <indexterm> 
     145                            <primary>element</primary> 
     146                            <secondary>SASprocessnote</secondary> 
     147                        </indexterm> 
    119148                    </entry> 
    120149                    <entry> 
     
    131160                <row> 
    132161                    <entry> 
    133                         <link xlink:href="#cansas1d_documentation-element-any"><literal>{any}</literal></link> 
     162                        <link xlink:href="#cansas1d_documentation-element-any" 
     163                            ><literal>{any}</literal></link> 
    134164                    </entry> 
    135165                    <entry> 
     
    141171                    <entry> 
    142172                        Any element(s) not defined in the cansas1d/1.0 standard can be placed at this point.  
    143                         See <link xlink:href="#cansas1d_documentation-element-any"><literal>{any}</literal></link>  
     173                        See <link xlink:href="#cansas1d_documentation-element-any" 
     174                            ><literal>{any}</literal></link>  
    144175                        for more details. 
    145176                    </entry> 
    146                     <entry><para><literal> xmlns:{foreign-prefix}={foreign-namespace} </literal></para></entry> 
     177                    <entry><literal>xmlns:{foreign-prefix}={foreign-namespace}</literal></entry> 
    147178                </row> 
    148179            </tbody> 
     
    169200                    <row> 
    170201                        <entry> 
    171                             <link xlink:href="#cansas1d_documentation-element-any"><literal>{any}</literal></link> 
     202                            <link xlink:href="#cansas1d_documentation-element-any" 
     203                                ><literal>{any}</literal></link> 
    172204                        </entry> 
    173205                        <entry> 
     
    179211                        <entry> 
    180212                            Any element(s) not defined in the cansas1d/1.0 standard can be placed at this point.  
    181                             See <link xlink:href="#cansas1d_documentation-element-any"><literal>{any}</literal></link> for more details. 
    182                         </entry> 
    183                         <entry><para><literal> xmlns:{foreign-prefix}={foreign-namespace} </literal></para></entry> 
     213                            See <link xlink:href="#cansas1d_documentation-element-any" 
     214                                ><literal>{any}</literal></link> for more details. 
     215                        </entry> 
     216                        <entry><literal>xmlns:{foreign-prefix}={foreign-namespace}</literal></entry> 
    184217                    </row> 
    185218                </tbody> 
  • 1dwg/trunk/doc/src/cansas1d_element_SASroot.xml

    r128 r140  
    2020    <itemizedlist mark="opencircle"> 
    2121        <listitem> 
    22             <indexterm><primary>SASroot</primary></indexterm> 
     22            <indexterm significance="preferred"> 
     23                <primary>element</primary> 
     24                <secondary>SASroot</secondary> 
     25            </indexterm> 
    2326            <para>  
    2427                                parent:  
     
    5962                <row> 
    6063                    <entry> 
    61                         <emphasis role="bold"> 
    62                                                         <link xlink:href="#cansas1d_documentation-element-SASentry">SASentry</link> 
    63                                                 </emphasis> 
     64                                                <link xlink:href="#cansas1d_documentation-element-SASentry" 
     65                                                    ><literal>SASentry</literal></link> 
    6466                    </entry> 
    6567                    <entry> container </entry> 
    6668                    <entry> [1..inf] </entry> 
    67                     <entry> A single SAS scan is reported in a <emphasis role="bold" 
    68                             >SASentry</emphasis>. Include as many <emphasis role="bold" 
    69                             >SASentry</emphasis> elements as desired. They may contain related or 
    70                         unrelated data. <emphasis role="bold">name</emphasis> is an optional 
    71                         attribute to provide a string for this <emphasis role="bold" 
    72                             >SASentry</emphasis>. (Use of this string is not defined by this 
     69                    <entry> A single SAS scan is reported in a <literal>SASentry</literal>.  
     70                        Include as many <literal>SASentry</literal> elements as desired.  
     71                        They may contain related or 
     72                        unrelated data. <literal>name</literal> is an optional 
     73                        attribute to provide a string for this <literal>SASentry</literal>.  
     74                        (Use of this string is not defined by this 
    7375                        standard.) </entry> 
    74                     <entry> name=short-name </entry> 
     76                    <entry><literal>name=short-name</literal></entry> 
    7577                </row> 
    7678            </tbody> 
  • 1dwg/trunk/doc/src/cansas1d_element_SASsample.xml

    r138 r140  
    2020    <itemizedlist mark="opencircle"> 
    2121        <listitem> 
    22             <indexterm><primary>SASsample</primary></indexterm> 
     22            <indexterm significance="preferred"> 
     23                <primary>element</primary> 
     24                <secondary>SASsample</secondary> 
     25            </indexterm> 
    2326            <para> 
    2427                parent: 
     
    5861                </row> 
    5962                <row> 
    60                     <entry><para><literal> ID </literal></para></entry> 
     63                    <entry> 
     64                        <literal>ID</literal> 
     65                        <indexterm> 
     66                            <primary>element</primary> 
     67                            <secondary>ID</secondary> 
     68                        </indexterm> 
     69                    </entry> 
    6170                    <entry> string </entry> 
    6271                    <entry> [1..1] </entry> 
     
    6574                </row> 
    6675                <row> 
    67                     <entry><para><literal> thickness </literal></para></entry> 
     76                    <entry> 
     77                        <literal>thickness</literal> 
     78                        <indexterm> 
     79                            <primary>element</primary> 
     80                            <secondary>thickness</secondary> 
     81                        </indexterm> 
     82                    </entry> 
    6883                    <entry> floating-point number </entry> 
    6984                    <entry> [0..1] </entry> 
     
    7489                </row> 
    7590                <row> 
    76                     <entry><para><literal> transmission </literal></para></entry> 
     91                    <entry> 
     92                        <literal>transmission</literal> 
     93                        <indexterm> 
     94                            <primary>element</primary> 
     95                            <secondary>transmission</secondary> 
     96                        </indexterm> 
     97                    </entry> 
    7798                    <entry> floating-point number </entry> 
    7899                    <entry> [0..1] </entry> 
     
    82103                </row> 
    83104                <row> 
    84                     <entry><para><literal> temperature </literal></para></entry> 
     105                    <entry> 
     106                        <literal>temperature</literal> 
     107                        <indexterm> 
     108                            <primary>element</primary> 
     109                            <secondary>temperature</secondary> 
     110                        </indexterm> 
     111                    </entry> 
    85112                    <entry> floating-point number </entry> 
    86113                    <entry> [0..1] </entry> 
    87114                    <entry> Temperature of this sample. Must specify the unit as an attribute. </entry> 
    88                     <entry> 
    89                         <para><literal>unit={unit}</literal></para> 
    90                     </entry> 
    91                 </row> 
    92                 <row> 
    93                     <entry> <literal>position</literal> </entry> 
     115                    <entry><literal>unit={unit}</literal></entry> 
     116                </row> 
     117                <row> 
     118                    <entry> 
     119                        <literal>position</literal> 
     120                        <indexterm> 
     121                            <primary>element</primary> 
     122                            <secondary>position</secondary> 
     123                        </indexterm> 
     124                    </entry> 
    94125                    <entry> container </entry> 
    95126                    <entry> [0..1] </entry> 
     
    98129                </row> 
    99130                <row> 
    100                     <entry> <literal>orientation</literal> </entry> 
     131                    <entry> 
     132                        <literal>orientation</literal>  
     133                        <indexterm> 
     134                            <primary>element</primary> 
     135                            <secondary>orientation</secondary> 
     136                        </indexterm> 
     137                    </entry> 
    101138                    <entry> container </entry> 
    102139                    <entry> [0..1] </entry> 
     
    106143                <row> 
    107144                    <entry> 
    108                         <para><literal>details</literal></para> 
     145                        <para> 
     146                            <literal>details</literal> 
     147                            <indexterm> 
     148                                <primary>element</primary> 
     149                                <secondary>details</secondary> 
     150                            </indexterm> 
     151                        </para> 
    109152                    </entry> 
    110153                    <entry> string </entry> 
     
    194237                    </row> 
    195238                    <row> 
    196                         <entry><para><literal> x </literal></para></entry> 
    197                         <entry> floating-point number </entry> 
    198                         <entry> [0..1] </entry> 
    199                         <entry> Position of the sample in X. The <emphasis role="bold" 
    200                                 >unit</emphasis> attribute is required. See 
    201                             cansas1d_documentation#Rules for acceptable values. </entry> 
    202                         <entry><para><literal>unit={unit}</literal></para></entry> 
    203                     </row> 
    204                     <row> 
    205                         <entry><para><literal> y </literal></para></entry> 
    206                         <entry> floating-point number </entry> 
    207                         <entry> [0..1] </entry> 
    208                         <entry> Position of the sample in Y. The <emphasis role="bold" 
    209                                 >unit</emphasis> attribute is required. See 
    210                             cansas1d_documentation#Rules for acceptable values. </entry> 
    211                         <entry><para><literal>unit={unit}</literal></para></entry> 
    212                     </row> 
    213                     <row> 
    214                         <entry><para><literal> z </literal></para></entry> 
    215                         <entry> floating-point number </entry> 
    216                         <entry> [0..1] </entry> 
    217                         <entry> Position of the sample in Z. The <emphasis role="bold" 
    218                                 >unit</emphasis> attribute is required. See 
    219                             cansas1d_documentation#Rules for acceptable values. Note: While Z 
    220                             dimension is allowed by the standard (provided by use of a standard 
    221                             element in the XML Schema), it does not make sense for small-angle 
    222                             scattering. </entry> 
    223                         <entry><para><literal>unit={unit}</literal></para></entry> 
     239                        <entry> 
     240                            <literal>x</literal> 
     241                            <indexterm> 
     242                                <primary>element</primary> 
     243                                <secondary>x</secondary> 
     244                            </indexterm> 
     245                        </entry> 
     246                        <entry> floating-point number </entry> 
     247                        <entry> [0..1] </entry> 
     248                        <entry> Position of the sample in X.  
     249                            The <literal>unit</literal> attribute is required. See 
     250                            the section about the 
     251                            <link xlink:href="#cansas1d_documentation-rules">rules</link> 
     252                            for acceptable values. </entry> 
     253                        <entry><literal>unit={unit}</literal></entry> 
     254                    </row> 
     255                    <row> 
     256                        <entry> 
     257                            <literal>y</literal> 
     258                            <indexterm> 
     259                                <primary>element</primary> 
     260                                <secondary>y</secondary> 
     261                            </indexterm> 
     262                        </entry> 
     263                        <entry> floating-point number </entry> 
     264                        <entry> [0..1] </entry> 
     265                        <entry> Position of the sample in Y.  
     266                            The <literal>unit</literal> attribute is required. See 
     267                            the section about the 
     268                            <link xlink:href="#cansas1d_documentation-rules">rules</link> 
     269                            for acceptable values. </entry> 
     270                        <entry><literal>unit={unit}</literal></entry> 
     271                    </row> 
     272                    <row> 
     273                        <entry> 
     274                            <literal>z</literal> 
     275                            <indexterm> 
     276                                <primary>element</primary> 
     277                                <secondary>z</secondary> 
     278                            </indexterm> 
     279                        </entry> 
     280                        <entry> floating-point number </entry> 
     281                        <entry> [0..1] </entry> 
     282                        <entry> 
     283                            <para> Position of the sample in Z. The <literal>unit</literal> 
     284                                attribute is required. See the section about the <link 
     285                                    xlink:href="#cansas1d_documentation-rules">rules</link> for 
     286                                acceptable values.  
     287                                <tip> 
     288                                    <para> 
     289                                        While Z dimension is allowed by the 
     290                                        standard (provided by use of a standard element in the XML Schema), 
     291                                        it does not make sense for small-angle scattering. 
     292                                    </para> 
     293                                </tip> 
     294                            </para> 
     295                        </entry> 
     296                        <entry><literal>unit={unit}</literal></entry> 
    224297                    </row> 
    225298                </tbody> 
     
    246319                    </row> 
    247320                    <row> 
    248                         <entry><para><literal> roll </literal></para></entry> 
    249                         <entry> floating-point number </entry> 
    250                         <entry> [0..1] </entry> 
    251                         <entry> Rotation about the <emphasis>Z</emphasis> axis (roll). The <emphasis 
    252                                 role="bold">unit</emphasis> attribute is required. See 
    253                             cansas1d_documentation#Rules for acceptable values. </entry> 
    254                         <entry><para><literal>unit={unit}</literal></para></entry> 
    255                     </row> 
    256                     <row> 
    257                         <entry><para><literal> pitch </literal></para></entry> 
    258                         <entry> floating-point number </entry> 
    259                         <entry> [0..1] </entry> 
    260                         <entry> Rotation about the <emphasis>X</emphasis> axis (pitch). The 
    261                                 <emphasis role="bold">unit</emphasis> attribute is required. See 
    262                             cansas1d_documentation#Rules for acceptable values. </entry> 
    263                         <entry><para><literal>unit={unit}</literal></para></entry> 
    264                     </row> 
    265                     <row> 
    266                         <entry><para><literal> yaw </literal></para></entry> 
    267                         <entry> floating-point number </entry> 
    268                         <entry> [0..1] </entry> 
    269                         <entry> Rotation about the <emphasis>Y</emphasis> axis (yaw). The <emphasis 
    270                                 role="bold">unit</emphasis> attribute is required. See 
    271                             cansas1d_documentation#Rules for acceptable values. </entry> 
    272                         <entry><para><literal>unit={unit}</literal></para></entry> 
     321                        <entry> 
     322                            <literal>roll</literal> 
     323                            <indexterm> 
     324                                <primary>element</primary> 
     325                                <secondary>roll</secondary> 
     326                            </indexterm> 
     327                        </entry> 
     328                        <entry> floating-point number </entry> 
     329                        <entry> [0..1] </entry> 
     330                        <entry> Rotation about the <literal>Z</literal> axis (roll).  
     331                            The <literal>unit</literal> attribute is required. See 
     332                            the section about the 
     333                            <link xlink:href="#cansas1d_documentation-rules">rules</link> 
     334                            for acceptable values. </entry> 
     335                        <entry><literal>unit={unit}</literal></entry> 
     336                    </row> 
     337                    <row> 
     338                        <entry> 
     339                            <literal>pitch</literal> 
     340                            <indexterm> 
     341                                <primary>element</primary> 
     342                                <secondary>pitch</secondary> 
     343                            </indexterm> 
     344                        </entry> 
     345                        <entry> floating-point number </entry> 
     346                        <entry> [0..1] </entry> 
     347                        <entry> Rotation about the <literal>X</literal> axis (pitch).  
     348                            The <literal>unit</literal> attribute is required. See 
     349                            the section about the 
     350                            <link xlink:href="#cansas1d_documentation-rules">rules</link> 
     351                            for acceptable values. </entry> 
     352                        <entry><literal>unit={unit}</literal></entry> 
     353                    </row> 
     354                    <row> 
     355                        <entry> 
     356                            <literal>yaw</literal> 
     357                            <indexterm> 
     358                                <primary>element</primary> 
     359                                <secondary>yaw</secondary> 
     360                            </indexterm> 
     361                        </entry> 
     362                        <entry> floating-point number </entry> 
     363                        <entry> [0..1] </entry> 
     364                        <entry> Rotation about the <literal>Y</literal> axis (yaw).  
     365                            The <literal>unit</literal> attribute is required. See 
     366                            the section about the 
     367                            <link xlink:href="#cansas1d_documentation-rules">rules</link> 
     368                            for acceptable values. </entry> 
     369                        <entry><literal>unit={unit}</literal></entry> 
    273370                    </row> 
    274371                </tbody> 
     
    276373        </table> 
    277374        <note> 
    278             <para> The <emphasis role="bold">orientation</emphasis> element is intended to describe 
     375            <para> The <literal>orientation</literal> element is intended to describe 
    279376                simple rotations about a single axis rather than a full set of rotations as in a 
    280377                crystallographic context. </para> 
  • 1dwg/trunk/doc/src/cansas1d_element_SASsource.xml

    r138 r140  
    22<?oxygen RNGSchema="http://www.oasis-open.org/docbook/xml/5.0/rng/docbook.rng" type="xml"?> 
    33<!--  
    4     ########### SVN repository information ################### 
    5     # $Date$ 
    6     # $Author$ 
    7     # $Revision$ 
    8     # $HeadURL$ 
    9     # $Id$ 
    10     ########### SVN repository information ################### 
     4########### SVN repository information ################### 
     5# $Date$ 
     6# $Author$ 
     7# $Revision$ 
     8# $HeadURL$ 
     9# $Id$ 
     10########### SVN repository information ################### 
    1111--> 
    1212<!-- from: http://www.smallangles.net/wgwiki/index.php/cansas1d_SASsource --> 
     
    1717    <itemizedlist mark="opencircle"> 
    1818        <listitem> 
    19             <indexterm><primary>SASsource</primary></indexterm> 
     19            <indexterm significance="preferred"> 
     20                <primary>element</primary> 
     21                <secondary>SASsource</secondary> 
     22            </indexterm> 
    2023            <para> parent: <link xlink:href="#cansas1d_documentation-element-SASinstrument" 
    2124                    >SASinstrument</link> 
     
    5659                    </row> 
    5760                    <row> 
    58                         <entry><para><literal> radiation </literal></para></entry> 
     61                        <entry> 
     62                            <literal>radiation</literal> 
     63                            <indexterm> 
     64                                <primary>element</primary> 
     65                                <secondary>radiation</secondary> 
     66                            </indexterm> 
     67                        </entry> 
    5968                        <entry> string </entry> 
    6069                        <entry> [1..1] </entry> 
     
    92101                    </row> 
    93102                    <row> 
    94                         <entry><literal> beam_size </literal></entry> 
     103                        <entry> 
     104                            <literal>beam_size</literal> 
     105                            <indexterm> 
     106                                <primary>element</primary> 
     107                                <secondary>beam_size</secondary> 
     108                            </indexterm> 
     109                        </entry> 
    95110                        <entry> container </entry> 
    96111                        <entry> [0..1] </entry> 
     
    98113                            beam is round, just use X dimension. Note: While Z dimension is allowed 
    99114                            by the standard, it does not make sense for small-angle scattering. </entry> 
    100                         <entry><para><literal>name={name}</literal></para></entry> 
    101                     </row> 
    102                     <row> 
    103                         <entry><para><literal> beam_shape </literal></para></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> 
    104125                        <entry> string </entry> 
    105126                        <entry> [0..1] </entry> 
     
    108129                    </row> 
    109130                    <row> 
    110                         <entry><para><literal> wavelength </literal></para></entry> 
     131                        <entry> 
     132                            <literal>wavelength</literal> 
     133                            <indexterm> 
     134                                <primary>element</primary> 
     135                                <secondary>wavelength</secondary> 
     136                            </indexterm> 
     137                        </entry> 
    111138                        <entry> floating-point number </entry> 
    112139                        <entry> [0..1] </entry> 
     
    120147                            </para> 
    121148                        </entry> 
    122                         <entry><para><literal> unit={unit} </literal></para></entry> 
    123                     </row> 
    124                     <row> 
    125                         <entry><para><literal> wavelength_min </literal></para></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> 
    126159                        <entry> floating-point number </entry> 
    127160                        <entry> [0..1] </entry> 
    128161                        <entry> Some facilities specify wavelength using a range. The minimum of 
    129162                            such a range is given by wavelength_min. </entry> 
    130                         <entry><para><literal> unit={unit} </literal></para></entry> 
    131                     </row> 
    132                     <row> 
    133                         <entry><para><literal> wavelength_max </literal></para></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> 
    134173                        <entry> floating-point number </entry> 
    135174                        <entry> [0..1] </entry> 
    136175                        <entry> Some facilities specify wavelength using a range. The maximum of 
    137176                            such a range is given by wavelength_max. </entry> 
    138                         <entry><para><literal> unit={unit} </literal></para></entry> 
    139                     </row> 
    140                     <row> 
    141                         <entry><para><literal> wavelength_spread </literal></para></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> 
    142187                        <entry> floating-point number </entry> 
    143188                        <entry> [0..1] </entry> 
    144189                        <entry> Some facilities specify the width of the wavelength spectrum. The 
    145190                            width of such a range is given by wavelength_spread. </entry> 
    146                         <entry><para><literal> unit={unit} </literal></para></entry> 
     191                        <entry><literal>unit={unit}</literal></entry> 
    147192                    </row> 
    148193                </tbody> 
     
    203248                        </row> 
    204249                        <row> 
    205                             <entry><para><literal> x </literal></para></entry> 
     250                            <entry><literal>x</literal> 
     251                                <indexterm> 
     252                                    <primary>element</primary> 
     253                                    <secondary>x</secondary> 
     254                                </indexterm> 
     255                            </entry> 
    206256                            <entry> floating-point number </entry> 
    207257                            <entry> [0..1] </entry> 
    208                             <entry> Dimension of the beam in X. The <emphasis role="bold" 
    209                                     >unit</emphasis> attribute is required. See 
    210                                 cansas1d_documentation#Rules for acceptable values. </entry> 
    211                             <entry><para><literal> unit={unit} </literal></para></entry> 
    212                         </row> 
    213                         <row> 
    214                             <entry><para><literal> y </literal></para></entry> 
     258                            <entry> Dimension of the beam in X.  
     259                                The <literal>unit</literal> attribute is required. See 
     260                                the section about the 
     261                                <link xlink:href="#cansas1d_documentation-rules">rules</link> 
     262                                for acceptable values. </entry> 
     263                            <entry><literal>unit={unit}</literal></entry> 
     264                        </row> 
     265                        <row> 
     266                            <entry> 
     267                                <literal>y</literal> 
     268                                <indexterm> 
     269                                    <primary>element</primary> 
     270                                    <secondary>y</secondary> 
     271                                </indexterm> 
     272                            </entry> 
    215273                            <entry> floating-point number </entry> 
    216274                            <entry> [0..1] </entry> 
    217                             <entry> Dimension of the beam in Y. The <emphasis role="bold" 
    218                                     >unit</emphasis> attribute is required. See 
    219                                 cansas1d_documentation#Rules for acceptable values. </entry> 
    220                             <entry><para><literal> unit={unit} </literal></para></entry> 
    221                         </row> 
    222                         <row> 
    223                             <entry><para><literal> z </literal></para></entry> 
     275                            <entry> Dimension of the beam in Y.  
     276                                The <literal>unit</literal> attribute is required. See 
     277                                the section about the 
     278                                <link xlink:href="#cansas1d_documentation-rules">rules</link> 
     279                                for acceptable values. </entry> 
     280                            <entry><literal>unit={unit}</literal></entry> 
     281                        </row> 
     282                        <row> 
     283                            <entry> 
     284                                <literal>z</literal> 
     285                                <indexterm> 
     286                                    <primary>element</primary> 
     287                                    <secondary>z</secondary> 
     288                                </indexterm> 
     289                            </entry> 
    224290                            <entry> floating-point number </entry> 
    225291                            <entry> [0..1] </entry> 
    226                             <entry> Dimension of the beam in Z. The <emphasis role="bold" 
    227                                     >unit</emphasis> attribute is required. See 
    228                                 cansas1d_documentation#Rules for acceptable values. Note: While Z 
    229                                 dimension is allowed by the standard (provided by use of a standard 
    230                                 element in the XML Schema), it does not make sense for small-angle 
    231                                 scattering.  
    232                             </entry> 
    233                             <entry><para><literal> unit={unit} </literal></para></entry> 
     292                            <entry>  
     293                                <para> 
     294                                    Dimension of the beam in Z.  
     295                                    The <literal>unit</literal> attribute is required. See 
     296                                    the section about the 
     297                                    <link xlink:href="#cansas1d_documentation-rules">rules</link> 
     298                                    for acceptable values. 
     299                                    <tip> 
     300                                        <para> 
     301                                            While Z 
     302                                            dimension is allowed by the standard (provided by use of a standard 
     303                                            element in the XML Schema), it does not make sense for small-angle 
     304                                            scattering.  
     305                                        </para> 
     306                                    </tip> 
     307                                </para> 
     308                            </entry> 
     309                            <entry><literal>unit={unit}</literal></entry> 
    234310                        </row> 
    235311                    </tbody> 
  • 1dwg/trunk/doc/src/cansas1d_element_XML_header.xml

    r132 r140  
    1818        $Date$ 
    1919    </bridgehead> 
     20    <example> 
     21        <title>Required header for cansas1d/1.0 XML files</title> 
     22        <indexterm significance="preferred"> 
     23            <primary>XML header</primary> 
     24        </indexterm> 
     25        <programlisting>&lt;?xml version="1.0"?> 
     26&lt;SASroot version="1.0" 
     27   xmlns="cansas1d/1.0" 
     28   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
     29   xsi:schemaLocation="cansas1d/1.0  
     30   http://svn.smallangles.net/svn/canSAS/1dwg/trunk/cansas1d.xsd"></programlisting> 
     31    </example> 
    2032    <table orient="port" role="small"> 
    2133        <title/> 
     
    5466                            local directory. Refer to <link 
    5567                                xlink:href="http://www.w3schools.org/xsl">W3 Schools XSLT 
    56                                 Help</link> for assistance in constructing XSLT files. </para> 
     68                                Help</link> for assistance in constructing XSLT  
     69                            files.<footnote><para><link 
     70                                xlink:href="http://www.w3schools.org/xsl"><literal 
     71                                    >http://www.w3schools.org/xsl</literal></link></para></footnote>  
     72                        </para> 
    5773                        <para> XML rules actually allow for multiple stylesheet declarations. 
    5874                            Explore this possibility as your own adventure. </para> 
     
    6581                <row> 
    6682                    <entry> 
    67                                                 <emphasis role="bold"> 
    68                                                         <link xlink:href="#cansas1d_documentation-element-SASroot">SASroot</link> 
    69                                                 </emphasis> 
     83                                            <link xlink:href="#cansas1d_documentation-element-SASroot" 
     84                                                ><literal>SASroot</literal></link> 
    7085                                        </entry> 
    7186                    <entry>container</entry> 
     
    7388                    <entry> 
    7489                        <para>The canSAS reduced 1-D SAS data (cansas1d/1.0) will be in the 
    75                                 <emphasis role="bold">SASroot</emphasis> database.</para> 
     90                                <literal>SASroot</literal> database.</para> 
    7691                        <para> 
    7792                                                        (This is similar to  
    78                                                         NXroot  
    7993                                                        <link 
    80                                 xlink:href="http://www.nexusformat.org/NXroot">NXroot</link> 
    81                                                         used by NeXus.) 
     94                                                            xlink:href="http://www.nexusformat.org/NXroot"><literal>NXroot</literal></link> 
     95                            used by NeXus.<footnote><para><link xlink:href="http://www.nexusformat.org/NXroot" 
     96                                ><literal>http://www.nexusformat.org/NXroot</literal></link></para></footnote>) 
    8297                                                </para> 
     98                    </entry> 
     99                    <entry> 
    83100                        <itemizedlist> 
    84101                            <listitem> 
    85102                                <para> 
    86                                     <emphasis role="bold">version="1.0"</emphasis> is required to 
     103                                    <literal>version="1.0"</literal> is required to 
    87104                                    identify the cansas1d/1.0 standard for SAS data.</para> 
    88105                            </listitem> 
    89106                            <listitem> 
    90107                                <para> 
    91                                     <emphasis role="bold">xmlns</emphasis> sets the default 
    92                                     namespace for all elements (with no prefix) in this file. 
     108                                    <literal>xmlns</literal> sets the default 
     109                                    namespace URI for all elements (with no prefix) in this file. 
    93110                                </para> 
    94111                            </listitem> 
    95112                            <listitem> 
    96113                                <para> 
    97                                     <emphasis role="bold">xmlns:xsi</emphasis> sets <emphasis 
    98                                         role="bold">xsi</emphasis> as the prefix for any elements 
    99                                     from the governing XML Schema.</para> 
     114                                    <literal>xmlns:xsi</literal> sets <literal>xsi</literal>  
     115                                    as the prefix for any elements 
     116                                    from the governing XML Schema and defines the namespace URI to  
     117                                    use with the <literal>xsi:</literal> element prefix.</para> 
    100118                            </listitem> 
    101119                            <listitem> 
    102120                                <para> 
    103                                     <emphasis role="bold">xsi:schemaLocation</emphasis> associates a 
     121                                    <literal>xsi:schemaLocation</literal> associates a 
    104122                                    suggested URL (where the cansas1d/1.0 XML Schema might be found) 
    105123                                    with the default namespace string. </para> 
    106124                            </listitem> 
    107125                        </itemizedlist> 
    108                         <para>See Note 1 below</para> 
    109                     </entry> 
    110                     <entry> 
    111                         <para>See Note 2 below</para> 
    112126                    </entry> 
    113127                </row> 
     
    115129        </tgroup> 
    116130    </table> 
    117     <glossary> 
    118         <glosslist> 
    119             <glossentry> 
    120                 <glossterm>Note 1: Required header for cansas1d/1.0 XML files</glossterm> 
    121                 <glossdef> 
    122                     <programlisting>&lt;SASroot version="1.0" 
    123     xmlns="cansas1d/1.0" 
    124     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    125     xsi:schemaLocation="cansas1d/1.0  
    126         http://svn.smallangles.net/svn/canSAS/1dwg/trunk/cansas1d.xsd"></programlisting> 
    127                 </glossdef> 
    128             </glossentry> 
    129             <glossentry> 
    130                 <glossterm> 
    131                     Note 2: Description of attributes in required header for cansas1d/1.0 XML files 
    132                 </glossterm> 
    133                 <glossdef><programlisting>version="1.0" 
    134      xmlns="{this-namespace-URI}" 
    135      xmlns:xsi="{URL-of-governing-XML-Schema}" 
    136      xsi:schemaLocation="{this-namespace-URI}  {URL-to-find-XML-Schema}"</programlisting></glossdef> 
    137             </glossentry> 
    138         </glosslist> 
    139     </glossary> 
    140131</section> 
  • 1dwg/trunk/doc/src/elements.xml

    r138 r140  
    1818        Each of these is described below. 
    1919    </para> 
    20     <note> 
    21         <para>Explain the <literal>attribute={text}</literal> syntax.</para> 
    22     </note> 
    2320    <glosslist> 
    2421        <glossentry> 
     
    3734                                <para> 
    3835                                    Elements of type <emphasis role="italic">header</emphasis>  
    39                                     describe the required XML header lines.  Use them without question. 
     36                                    describe the required XML header lines.   
     37                                    Without questions, use the header 
     38                                    in the section titled 
     39                                    <link xlink:href="#cansas1d_documentation-XML_Header" 
     40                                        >Required XML Header</link>. 
    4041                                </para> 
    4142                            </glossdef> 
     
    100101                    <programlisting>attributename="value"</programlisting> 
    101102                    where either single or double quotes surround the value.   
    102                     All attributes must have a value. 
     103                    All attributes must have a value.  Attributes may be given in any order. 
    103104                </para> 
    104105            </glossdef> 
  • 1dwg/trunk/doc/src/other.xml

    r138 r140  
    160160                <secondary>ascii3col.xsl</secondary> 
    161161            </indexterm> 
    162             <programlisting language="xml" linenumbering="numbered"> 
    163                 <textobject> 
    164                     <textdata fileref="ascii3col.xsl"/> 
    165                 </textobject> 
    166             </programlisting> 
     162            <example> 
     163                <title><citetitle>ascii3col.xsl</citetitle></title> 
     164                <programlisting language="xml" linenumbering="numbered"> 
     165                    <textobject> 
     166                        <textdata fileref="ascii3col.xsl"/> 
     167                    </textobject> 
     168                </programlisting> 
     169            </example> 
    167170        </section> 
    168171        <section xml:id="xsl-cansas1d"> 
     
    184187                <secondary>cansasxml-html.xsl</secondary> 
    185188            </indexterm> 
    186             <programlisting language="xml" linenumbering="numbered"> 
    187                 <textobject> 
    188                     <textdata fileref="../../cansasxml-html.xsl"/> 
    189                 </textobject> 
    190             </programlisting> 
     189            <!-- Cannot make next code into multi-page example it seems. --> 
     190            <!--<example> 
     191                <title><citetitle>cansasxml-html.xsl</citetitle></title>--> 
     192                <programlisting language="xml" linenumbering="numbered"> 
     193                    <textobject> 
     194                        <textdata fileref="../../cansasxml-html.xsl"/> 
     195                    </textobject> 
     196                </programlisting> 
     197            <!--</example>--> 
    191198        </section> 
    192199    </section> 
  • 1dwg/trunk/doc/src/specification.xml

    r134 r140  
    4444        are deemed to be valid cansas1d/1.0 data files. 
    4545    </para> 
    46     <note><para>More needs to be written here.</para></note> 
     46    <para> 
     47        In this document, curly braces, <literal>{}</literal>, are used to 
     48        indicate text that is supplied by the user.  Such as, an attribute 
     49        may be written 
     50        <informalexample> 
     51            <programlisting>name={text}</programlisting> 
     52        </informalexample> 
     53        and this means that the  
     54        user would replace <literal>{text}</literal> with text that gives, 
     55        in this example, a name such as <literal>final detector</literal>. 
     56        Thus resulting in 
     57        <informalexample> 
     58            <programlisting>name="final detector"</programlisting>  
     59        </informalexample> 
     60        which is a well-formed XML attribute.   
     61    </para> 
     62    <para> 
     63        Another example is an instance of the  
     64        <link xlink:href="#cansas1d_documentation-element-any"><literal>{any}</literal></link> 
     65        element.  Suppose one had analysis data, then <literal>{any}</literal> would be replaced  
     66        with <literal>analysis</literal> and the element might look like this: 
     67        <informalexample> 
     68            <programlisting> 
     69                &lt;analysis> 
     70                ... analysis content goes here ... 
     71                &lt;/analysis> 
     72            </programlisting> 
     73        </informalexample> 
     74    </para> 
    4775 
    4876 
  • 1dwg/trunk/doc/src/wiki.xml

    r136 r140  
    4444            <para>Version 1.0 was tagged from the subversion repository on 2009-05-12 as no changes 
    4545                were committed since January 2009. Use this command to checkout the tagged release. 
    46                 <programlisting>svn checkout http://svn.smallangles.net/svn/canSAS/1dwg/tags/v1.0 cansas1dwg-1.0</programlisting></para> 
     46                <example> 
     47                    <title>Checkout tagged release from subversion repository.</title> 
     48                    <programlisting>svn checkout http://svn.smallangles.net/svn/canSAS/1dwg/tags/v1.0 cansas1dwg-1.0</programlisting> 
     49                </example> 
     50            </para> 
    4751        </section> 
    4852    </section> 
     
    5963                After an XML header, the root element of the file is  
    6064                <link xlink:href="#cansas1d_documentation-element-SASroot" 
    61                     ><code>SASroot</code></link> 
    62                 <indexterm><primary>SASroot</primary></indexterm> 
     65                    ><literal>SASroot</literal></link> 
     66                <indexterm><primary>element</primary><secondary>SASroot</secondary></indexterm> 
    6367                which contains one or more 
    6468                <link xlink:href="#cansas1d_documentation-element-SASentry" 
    65                     ><code>SASentry</code></link> 
    66                 <indexterm><primary>SASentry</primary></indexterm> 
     69                    ><literal>SASentry</literal></link> 
     70                <indexterm><primary>element</primary><secondary>SASentry</secondary></indexterm> 
    6771                elements, each of which 
    6872                describes a single experiment (data set, time-slice, step in a series, new sample, 
     
    124128                </listitem> 
    125129            </itemizedlist> 
    126             <section xml:id="cansas1d_documentation-Basic_elements"> 
    127                 <title>Basic elements of the cansas1d/1.0 standard</title> 
     130            <example> 
     131                <title>Required header for cansas1d/1.0 XML files</title> 
     132                <indexterm significance="preferred"> 
     133                    <primary>XML header</primary> 
     134                </indexterm> 
     135                <programlisting>&lt;?xml version="1.0"?> 
     136&lt;SASroot version="1.0" 
     137   xmlns="cansas1d/1.0" 
     138   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
     139   xsi:schemaLocation="cansas1d/1.0  
     140   http://svn.smallangles.net/svn/canSAS/1dwg/trunk/cansas1d.xsd"></programlisting> 
     141            </example> 
     142            <para> 
     143                <table frame="all"> 
     144                    <title>Basic elements of the canSAS 1-D standard</title> 
     145                    <tgroup cols="2"> 
     146                        <colspec colname="c1" colnum="1" colwidth="2*"/> 
     147                        <colspec colname="c2" colnum="2" colwidth="6*"/> 
     148                        <thead> 
     149                            <row> 
     150                                <entry><?dblatex bgcolor="[gray]{0.8}"?>Element</entry> 
     151                                <entry><?dblatex bgcolor="[gray]{0.8}"?>Description</entry> 
     152                            </row> 
     153                        </thead> 
     154                        <tbody> 
     155                            <row> 
     156                                <entry>XML Header</entry> 
     157                                <entry>descriptive info required at the start of every XML 
     158                                    file</entry> 
     159                            </row> 
     160                            <row> 
     161                                <entry> 
     162                                    <link xlink:href="#cansas1d_documentation-element-SASroot" 
     163                                        ><literal>SASroot</literal></link> 
     164                                </entry> 
     165                                <entry>root element of XML file</entry> 
     166                            </row> 
     167                            <row> 
     168                                <entry> 
     169                                    <link xlink:href="#cansas1d_documentation-element-SASentry" 
     170                                        ><literal>&#160;SASentry</literal></link> 
     171                                </entry> 
     172                                <entry>data set, time-slice, step in a series, new sample, 
     173                                    etc.</entry> 
     174                            </row> 
     175                            <row> 
     176                                <entry> 
     177                                    <literal>&#160;&#160;Title</literal> 
     178                                </entry> 
     179                                <entry>for this particular <literal>SASentry</literal></entry> 
     180                            </row> 
     181                            <row> 
     182                                <entry> 
     183                                    <literal>&#160;&#160;Run</literal> 
     184                                </entry> 
     185                                <entry>run number or ID number of experiment</entry> 
     186                            </row> 
     187                            <row> 
     188                                <entry> 
     189                                    <link xlink:href="#cansas1d_documentation-element-any" 
     190                                        ><literal>&#160;&#160;{any}</literal></link> 
     191                                </entry> 
     192                                <entry>any <literal>cansas1d/1.0</literal> element can be used at this 
     193                                    point</entry> 
     194                            </row> 
     195                            <row> 
     196                                <entry> 
     197                                    <link xlink:href="#cansas1d_documentation-element-SASdata" 
     198                                        ><literal>&#160;&#160;SASdata</literal></link> 
     199                                </entry> 
     200                                <entry>this is where the reduced 1-D SAS data is stored</entry> 
     201                            </row> 
     202                            <row> 
     203                                <entry> 
     204                                    <literal>&#160;&#160;&#160;Idata</literal> 
     205                                </entry> 
     206                                <entry>a single data point in the dataset</entry> 
     207                            </row> 
     208                            <row> 
     209                                <entry> 
     210                                    <link xlink:href="#cansas1d_documentation-element-any" 
     211                                        ><literal>&#160;&#160;{any}</literal></link> 
     212                                </entry> 
     213                                <entry>any cansas1d/1.0 element can be used at this 
     214                                    point</entry> 
     215                            </row> 
     216                            <row> 
     217                                <entry> 
     218                                    <link xlink:href="#cansas1d_documentation-element-SASsample" 
     219                                        ><literal>&#160;&#160;SASsample</literal></link> 
     220                                </entry> 
     221                                <entry>description of the sample</entry> 
     222                            </row> 
     223                            <row> 
     224                                <entry> 
     225                                    <link xlink:href="#cansas1d_documentation-element-SASinstrument" 
     226                                        ><literal>&#160;&#160;SASinstrument</literal></link> 
     227                                </entry> 
     228                                <entry>description of the instrument</entry> 
     229                            </row> 
     230                            <row> 
     231                                <entry> 
     232                                    <link xlink:href="#cansas1d_documentation-element-SASsource" 
     233                                        ><literal>&#160;&#160;&#160;SASsource</literal></link> 
     234                                </entry> 
     235                                <entry>description of the source</entry> 
     236                            </row> 
     237                            <row> 
     238                                <entry> 
     239                                    <link xlink:href="#cansas1d_documentation-element-SAScollimation" 
     240                                        ><literal>&#160;&#160;&#160;SAScollimation</literal></link> 
     241                                </entry> 
     242                                <entry>description of the collimation</entry> 
     243                            </row> 
     244                            <row> 
     245                                <entry> 
     246                                    <link xlink:href="#cansas1d_documentation-element-SASdetector" 
     247                                        ><literal>&#160;&#160;&#160;SASdetector</literal></link> 
     248                                </entry> 
     249                                <entry>description of the detector</entry> 
     250                            </row> 
     251                            <row> 
     252                                <entry> 
     253                                    <link xlink:href="#cansas1d_documentation-element-SASprocess" 
     254                                        ><literal>&#160;&#160;SASprocess</literal></link> 
     255                                </entry> 
     256                                <entry>for each processing or analysis step</entry> 
     257                            </row> 
     258                            <row> 
     259                                <entry> 
     260                                    <link xlink:href="#cansas1d_documentation-element-SASnote" 
     261                                        ><literal>&#160;&#160;SASnote</literal></link> 
     262                                </entry> 
     263                                <entry>anything at all</entry> 
     264                            </row> 
     265                        </tbody> 
     266                    </tgroup> 
     267                </table> 
     268            </para> 
     269            </section> 
     270    </section> 
     271    <section xml:id="cansas1d_documentation-rules"> 
     272        <title>Rules</title> 
     273        <orderedlist> 
     274            <listitem> 
     275                <para> cansas1d/1.0 XML data files will adhere to the standard if they can 
     276                    successfully 
     277                    <link xlink:href="#cansas1d_documentation-schema_validation">validate</link> 
     278                    <indexterm> 
     279                        <primary>validation</primary> 
     280                        <secondary>against XML Schema</secondary> 
     281                    </indexterm> 
     282                    against the established XML Schema 
     283                    (<link  
     284                        xlink:href="http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/cansas1d.xsd" 
     285                        ><literal>canSAS1d.xsd</literal></link>).</para> 
     286            </listitem> 
     287            <listitem> 
    128288                <para> 
    129                     <table frame="all"> 
    130                         <title>Basic elements of the canSAS 1-D standard</title> 
    131                         <tgroup cols="2"> 
    132                             <colspec colname="c1" colnum="1" colwidth="2*"/> 
    133                             <colspec colname="c2" colnum="2" colwidth="6*"/> 
    134                             <thead> 
    135                                 <row> 
    136                                     <entry><?dblatex bgcolor="[gray]{0.8}"?>Element</entry> 
    137                                     <entry><?dblatex bgcolor="[gray]{0.8}"?>Description</entry> 
    138                                 </row> 
    139                             </thead> 
    140                             <tbody> 
    141                                 <row> 
    142                                     <entry>XML Header</entry> 
    143                                     <entry>descriptive info required at the start of every XML 
    144                                         file</entry> 
    145                                 </row> 
    146                                 <row> 
    147                                     <entry> 
    148                                         <emphasis role="bold"> 
    149                                             <link xlink:href="#cansas1d_documentation-element-SASroot" 
    150                                                 ><code>SASroot</code></link> 
    151                                         </emphasis> 
    152                                     </entry> 
    153                                     <entry>root element of XML file</entry> 
    154                                 </row> 
    155                                 <row> 
    156                                     <entry> 
    157                                         <emphasis role="bold"> 
    158                                             <link xlink:href="#cansas1d_documentation-element-SASentry" 
    159                                                 ><code>&#160;SASentry</code></link> 
    160                                         </emphasis> 
    161                                     </entry> 
    162                                     <entry>data set, time-slice, step in a series, new sample, 
    163                                         etc.</entry> 
    164                                 </row> 
    165                                 <row> 
    166                                     <entry> 
    167                                         <emphasis role="bold"> 
    168                                             <code>&#160;&#160;Title</code> 
    169                                         </emphasis> 
    170                                     </entry> 
    171                                     <entry>for this particular <literal>SASentry</literal></entry> 
    172                                 </row> 
    173                                 <row> 
    174                                     <entry> 
    175                                         <emphasis role="bold"> 
    176                                             <code>&#160;&#160;Run</code> 
    177                                         </emphasis> 
    178                                     </entry> 
    179                                     <entry>run number or ID number of experiment</entry> 
    180                                 </row> 
    181                                 <row> 
    182                                     <entry> 
    183                                         <emphasis role="bold"> 
    184                                             <code>&#160;&#160;{any}</code> 
    185                                         </emphasis> 
    186                                     </entry> 
    187                                     <entry>any cansas1d/1.0 element can be used at this 
    188                                         point</entry> 
    189                                 </row> 
    190                                 <row> 
    191                                     <entry> 
    192                                         <emphasis role="bold"> 
    193                                             <code>&#160;&#160;SASdata</code> 
    194                                         </emphasis> 
    195                                     </entry> 
    196                                     <entry>this is where the reduced 1-D SAS data is stored</entry> 
    197                                 </row> 
    198                                 <row> 
    199                                     <entry> 
    200                                         <emphasis role="bold"> 
    201                                             <code>&#160;&#160;&#160;Idata</code> 
    202                                         </emphasis> 
    203                                     </entry> 
    204                                     <entry>a single data point in the dataset</entry> 
    205                                 </row> 
    206                                 <row> 
    207                                     <entry> 
    208                                         <emphasis role="bold"> 
    209                                             <code>&#160;&#160;{any}</code> 
    210                                         </emphasis> 
    211                                     </entry> 
    212                                     <entry>any cansas1d/1.0 element can be used at this 
    213                                         point</entry> 
    214                                 </row> 
    215                                 <row> 
    216                                     <entry> 
    217                                         <emphasis role="bold"> 
    218                                             <code>&#160;&#160;SASsample</code> 
    219                                         </emphasis> 
    220                                     </entry> 
    221                                     <entry>description of the sample</entry> 
    222                                 </row> 
    223                                 <row> 
    224                                     <entry> 
    225                                         <emphasis role="bold"> 
    226                                             <code>&#160;&#160;SASinstrument</code> 
    227                                         </emphasis> 
    228                                     </entry> 
    229                                     <entry>description of the instrument</entry> 
    230                                 </row> 
    231                                 <row> 
    232                                     <entry> 
    233                                         <emphasis role="bold"> 
    234                                             <code>&#160;&#160;&#160;SASsource</code> 
    235                                         </emphasis> 
    236                                     </entry> 
    237                                     <entry>description of the source</entry> 
    238                                 </row> 
    239                                 <row> 
    240                                     <entry> 
    241                                         <emphasis role="bold"> 
    242                                             <code>&#160;&#160;&#160;SAScollimation</code> 
    243                                         </emphasis> 
    244                                     </entry> 
    245                                     <entry>description of the collimation</entry> 
    246                                 </row> 
    247                                 <row> 
    248                                     <entry> 
    249                                         <emphasis role="bold"> 
    250                                             <code>&#160;&#160;&#160;SASdetector</code> 
    251                                         </emphasis> 
    252                                     </entry> 
    253                                     <entry>description of the detector</entry> 
    254                                 </row> 
    255                                 <row> 
    256                                     <entry> 
    257                                         <emphasis role="bold"> 
    258                                             <code>&#160;&#160;SASprocess</code> 
    259                                         </emphasis> 
    260                                     </entry> 
    261                                     <entry>for each processing or analysis step</entry> 
    262                                 </row> 
    263                                 <row> 
    264                                     <entry> 
    265                                         <emphasis role="bold"> 
    266                                             <code>&#160;&#160;SASnote</code> 
    267                                         </emphasis> 
    268                                     </entry> 
    269                                     <entry>anything at all</entry> 
    270                                 </row> 
    271                             </tbody> 
    272                         </tgroup> 
    273                     </table> 
     289                    <inlineequation> 
     290                        <mathphrase> 
     291                            <alt> 
     292                                Q=(4 \pi / \lambda) \sin(\theta) 
     293                            </alt> 
     294                        </mathphrase> 
     295                    </inlineequation> 
    274296                </para> 
    275             </section> 
    276             <section xml:id="cansas1d_documentation-required_header"> 
    277                 <title>Required XML file header</title> 
    278                 <programlisting> 
    279 &lt;?xml version="1.0"?> 
    280 &lt;?xml-stylesheet type="text/xsl" href="cansasxml-html.xsl" ?> 
    281 &lt;SASroot version="1.0" 
    282     xmlns="cansas1d/1.0" 
    283     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    284     xsi:schemaLocation="cansas1d/1.0  
    285     http://svn.smallangles.net/svn/canSAS/1dwg/trunk/cansas1d.xsd"></programlisting> 
    286             </section> 
    287         </section> 
    288         <section xml:id="cansas1d_documentation-rules"> 
    289             <title>Rules</title> 
    290             <orderedlist> 
    291                 <listitem> 
    292                     <para> cansas1d/1.0 XML data files will adhere to the standard if they can 
    293                         successfully 
    294                         <link xlink:href="cansas1d_documentation-schema_validation">validate</link> 
    295                         <indexterm> 
    296                             <primary>validation</primary> 
    297                             <secondary>against XML Schema</secondary> 
    298                         </indexterm> 
    299                         against the established XML Schema 
    300                         (<link xlink:href="http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/cansas1d.xsd" 
    301                             ><literal>canSAS1d.xsd</literal></link>).</para> 
    302                 </listitem> 
    303                 <listitem> 
    304                     <para> 
    305                         <inlineequation> 
    306                             <mathphrase> 
    307                                 <alt> 
    308                                     Q=(4 \pi / \lambda) \sin(\theta) 
    309                                 </alt> 
    310                             </mathphrase> 
    311                         </inlineequation> 
    312                     </para> 
    313                     <para> 
    314                         <indexterm> 
    315                             <primary>geometry</primary> 
    316                             <secondary>Q</secondary> 
    317                         </indexterm> 
    318                         where  
    319                         <inlineequation><mathphrase><alt>\lambda</alt></mathphrase></inlineequation>  
    320                         is the wavelength of the radiation</para> 
    321                     <para>and   
    322                         <inlineequation><mathphrase><alt>2\theta</alt></mathphrase></inlineequation> 
    323                         is the angle through which the detected radiation has been 
    324                         scattered.</para> 
    325                     <figure> 
    326                         <title>definition of Q geometry for small-angle scattering</title> 
    327                         <mediaobject> 
    328                             <imageobject> 
    329                                 <imagedata fileref="../../graphics/Q-geometry.jpg" scalefit="1" 
    330                                     width="200pt"/></imageobject> 
    331                         </mediaobject> 
    332                     </figure> 
    333                 </listitem> 
    334                 <listitem> 
    335                     <para> units to be given in standard SI abbreviations (eg, m, cm, mm, nm, K) 
    336                         with the following exceptions: </para> 
    337                     <orderedlist numeration="loweralpha"> 
    338                         <listitem> 
    339                             <para>um=micrometres</para> 
    340                         </listitem> 
    341                         <listitem> 
    342                             <para>C=celsius</para> 
    343                         </listitem> 
    344                         <listitem> 
    345                             <para>A=Angstroms</para> 
    346                         </listitem> 
    347                         <listitem> 
    348                             <para>percent=%.</para> 
    349                         </listitem> 
    350                         <listitem> 
    351                             <para>fraction</para> 
    352                         </listitem> 
    353                         <listitem> 
    354                             <para>a.u.=arbitrary units</para> 
    355                         </listitem> 
    356                         <listitem> 
    357                             <para>none=no units are relevant (such as dimensionless)</para> 
    358                         </listitem> 
    359                     </orderedlist> 
    360                 </listitem> 
    361                 <listitem> 
    362                     <para> where reciprocal units need to be quoted the format shall be 
    363                         "1/abbreviation"</para> 
    364                 </listitem> 
    365                 <listitem> 
    366                     <para> when raised to a power, use similar to "A^3" or "1/m^4" (and not "A3" or 
    367                         "A**3" or "m-4")</para> 
    368                 </listitem> 
    369                 <listitem> 
    370                     <para>  
    371                         axes: 
    372                         <indexterm> 
    373                             <primary>geometry</primary> 
    374                             <secondary>translation</secondary> 
    375                         </indexterm> 
    376                     </para> 
    377                     <orderedlist numeration="loweralpha"> 
    378                         <listitem> 
    379                             <para>z is along the flight path (positive value in the direction of the 
    380                                 detector)</para> 
    381                         </listitem> 
    382                         <listitem> 
    383                             <para>x is orthogonal to z in the horizontal plane (positive values 
    384                                 increase to the right when viewed towards the incoming 
    385                                 radiation)</para> 
    386                         </listitem> 
    387                         <listitem> 
    388                             <para>y is orthogonal to z and x in the vertical plane (positive values 
    389                                 increase upwards)</para> 
    390                         </listitem> 
    391                         <listitem> 
    392                             <figure> 
    393                                 <title>definition of translation and orientation geometry as viewed 
    394                                     from the detector towards the source</title> 
    395                                 <para> 
    396                                     <indexterm> 
    397                                         <primary>geometry</primary> 
    398                                         <secondary>rotation</secondary> 
    399                                     </indexterm> 
    400                                     <table> 
    401                                         <title/> 
    402                                         <tgroup cols="2"> 
    403                                             <tbody> 
    404                                                 <row> 
    405                                                     <entry> 
    406                                                         <mediaobject> 
    407                                                             <imageobject> 
    408                                                                 <imagedata 
    409                                                                     fileref="../../graphics/translation-orientation-geometry.jpg" 
    410                                                                     width="200pt" scalefit="1"/> 
    411                                                             </imageobject> 
    412                                                             <caption> 
    413                                                                 <para>as viewed from source</para> 
    414                                                             </caption> 
    415                                                         </mediaobject> 
    416                                                     </entry> 
    417                                                     <entry> 
    418                                                         <mediaobject> 
    419                                                             <imageobject> 
    420                                                                 <imagedata 
    421                                                                     fileref="../../graphics/translation-orientation-geometry-2.jpg" 
    422                                                                     width="200pt" scalefit="1"/> 
    423                                                             </imageobject> 
    424                                                             <caption> 
    425                                                                 <para>as viewed from detector</para> 
    426                                                             </caption> 
    427                                                         </mediaobject> 
    428                                                     </entry> 
    429                                                 </row> 
    430                                             </tbody> 
    431                                         </tgroup> 
    432                                     </table> 
    433                                 </para> 
    434                             </figure> 
    435                         </listitem> 
    436                     </orderedlist> 
    437                 </listitem> 
    438                 <listitem> 
    439                     <para>orientation (angles) describes one-axis rotations (rotations about 
    440                         multiple axes require more information): </para> 
    441                     <orderedlist numeration="loweralpha"> 
    442                         <listitem> 
    443                             <para>roll is about z</para> 
    444                         </listitem> 
    445                         <listitem> 
    446                             <para>pitch is about x</para> 
    447                         </listitem> 
    448                         <listitem> 
    449                             <para>yaw is about y</para> 
    450                         </listitem> 
    451                     </orderedlist> 
    452                 </listitem> 
    453                 <listitem> 
    454                     <para> Unicode characters MUST NOT be used</para> 
    455                 </listitem> 
    456                 <listitem> 
    457                     <para> Binary data is not supported</para> 
    458                 </listitem> 
    459             </orderedlist> 
    460             <para> 
    461             </para> 
    462         </section> 
    463         <section xml:id="cansas1d_documentation-geometry_compatibility"> 
    464             <title>Compatibility of Geometry Definitions</title> 
    465             <para> Note: translation and orientation geometry used by canSAS are consistent with: </para> 
    466             <itemizedlist> 
    467                 <listitem> 
    468                     <para>Cartesian: <link xlink:href="http://en.wikipedia.org/wiki/Cartesian_coordinate_system" 
    469                         ><literal>http://en.wikipedia.org/wiki/Cartesian_coordinate_system</literal></link></para> 
    470                 </listitem> 
    471                 <listitem> 
    472                     <para>Right-hand rule: <link xlink:href="http://en.wikipedia.org/wiki/Right-hand_rule" 
    473                         ><literal>http://en.wikipedia.org/wiki/Right-hand_rule</literal></link></para> 
    474                 </listitem> 
    475                 <listitem> 
    476                     <para>NeXus: <link xlink:href="http://www.nexusformat.org/Coordinate_Systems" 
    477                         ><literal>http://www.nexusformat.org/Coordinate_Systems</literal></link></para> 
    478                 </listitem> 
    479                 <listitem> 
    480                     <para><literal>McStas</literal>:  
    481                         <link xlink:href="http://mcstas.risoe.dk/documentation/tutorial/node6.html" 
    482                             ><literal>http://mcstas.risoe.dk/documentation/tutorial/node6.html</literal 
    483                             ></link></para> 
    484                 </listitem> 
     297                <para> 
     298                    <indexterm> 
     299                        <primary>geometry</primary> 
     300                        <secondary>Q</secondary> 
     301                    </indexterm> 
     302                    where  
     303                    <inlineequation><mathphrase><alt>\lambda</alt></mathphrase></inlineequation>  
     304                    is the wavelength of the radiation</para> 
     305                <para>and   
     306                    <inlineequation><mathphrase><alt>2\theta</alt></mathphrase></inlineequation> 
     307                    is the angle through which the detected radiation has been 
     308                    scattered.</para> 
     309                <figure> 
     310                    <title>definition of Q geometry for small-angle scattering</title> 
     311                    <mediaobject> 
     312                        <imageobject> 
     313                            <imagedata fileref="../../graphics/Q-geometry.jpg" scalefit="1" 
     314                                width="200pt"/></imageobject> 
     315                    </mediaobject> 
     316                </figure> 
     317            </listitem> 
     318            <listitem> 
     319                <para> units to be given in standard SI abbreviations (eg, m, cm, mm, nm, K) 
     320                    with the following exceptions: </para> 
     321                <orderedlist numeration="loweralpha"> 
     322                    <listitem> 
     323                        <para>um=micrometres</para> 
     324                    </listitem> 
     325                    <listitem> 
     326                        <para>C=celsius</para> 
     327                    </listitem> 
     328                    <listitem> 
     329                        <para>A=Angstroms</para> 
     330                    </listitem> 
     331                    <listitem> 
     332                        <para>percent=%.</para> 
     333                    </listitem> 
     334                    <listitem> 
     335                        <para>fraction</para> 
     336                    </listitem> 
     337                    <listitem> 
     338                        <para>a.u.=arbitrary units</para> 
     339                    </listitem> 
     340                    <listitem> 
     341                        <para>none=no units are relevant (such as dimensionless)</para> 
     342                    </listitem> 
     343                </orderedlist> 
     344            </listitem> 
     345            <listitem> 
     346                <para> where reciprocal units need to be quoted the format shall be 
     347                    "1/abbreviation"</para> 
     348            </listitem> 
     349            <listitem> 
     350                <para> when raised to a power, use similar to "A^3" or "1/m^4" (and not "A3" or 
     351                    "A**3" or "m-4")</para> 
     352            </listitem> 
     353            <listitem> 
     354                <para>  
     355                    axes: 
     356                    <indexterm> 
     357                        <primary>geometry</primary> 
     358                        <secondary>translation</secondary> 
     359                    </indexterm> 
     360                </para> 
     361                <orderedlist numeration="loweralpha"> 
     362                    <listitem> 
     363                        <para>z is along the flight path (positive value in the direction of the 
     364                            detector)</para> 
     365                    </listitem> 
     366                    <listitem> 
     367                        <para>x is orthogonal to z in the horizontal plane (positive values 
     368                            increase to the right when viewed towards the incoming 
     369                            radiation)</para> 
     370                    </listitem> 
     371                    <listitem> 
     372                        <para>y is orthogonal to z and x in the vertical plane (positive values 
     373                            increase upwards)</para> 
     374                    </listitem> 
     375                    <listitem> 
     376                        <figure> 
     377                            <title>definition of translation and orientation geometry as viewed 
     378                                from the detector towards the source</title> 
     379                            <para> 
     380                                <indexterm> 
     381                                    <primary>geometry</primary> 
     382                                    <secondary>rotation</secondary> 
     383                                </indexterm> 
     384                                <table> 
     385                                    <title/> 
     386                                    <tgroup cols="2"> 
     387                                        <tbody> 
     388                                            <row> 
     389                                                <entry> 
     390                                                    <mediaobject> 
     391                                                        <imageobject> 
     392                                                            <imagedata 
     393                                                                fileref="../../graphics/translation-orientation-geometry.jpg" 
     394                                                                width="200pt" scalefit="1"/> 
     395                                                        </imageobject> 
     396                                                        <caption> 
     397                                                            <para>as viewed from source</para> 
     398                                                        </caption> 
     399                                                    </mediaobject> 
     400                                                </entry> 
     401                                                <entry> 
     402                                                    <mediaobject> 
     403                                                        <imageobject> 
     404                                                            <imagedata 
     405                                                                fileref="../../graphics/translation-orientation-geometry-2.jpg" 
     406                                                                width="200pt" scalefit="1"/> 
     407                                                        </imageobject> 
     408                                                        <caption> 
     409                                                            <para>as viewed from detector</para> 
     410                                                        </caption> 
     411                                                    </mediaobject> 
     412                                                </entry> 
     413                                            </row> 
     414                                        </tbody> 
     415                                    </tgroup> 
     416                                </table> 
     417                            </para> 
     418                        </figure> 
     419                    </listitem> 
     420                </orderedlist> 
     421            </listitem> 
     422            <listitem> 
     423                <para>orientation (angles) describes one-axis rotations (rotations about 
     424                    multiple axes require more information): </para> 
     425                <orderedlist numeration="loweralpha"> 
     426                    <listitem> 
     427                        <para>roll is about z</para> 
     428                    </listitem> 
     429                    <listitem> 
     430                        <para>pitch is about x</para> 
     431                    </listitem> 
     432                    <listitem> 
     433                        <para>yaw is about y</para> 
     434                    </listitem> 
     435                </orderedlist> 
     436            </listitem> 
     437            <listitem> 
     438                <para> Unicode characters MUST NOT be used</para> 
     439            </listitem> 
     440            <listitem> 
     441                <para> Binary data is not supported</para> 
     442            </listitem> 
     443        </orderedlist> 
     444        <para> 
     445        </para> 
     446    </section> 
     447    <section xml:id="cansas1d_documentation-geometry_compatibility"> 
     448        <title>Compatibility of Geometry Definitions</title> 
     449        <para> Note: translation and orientation geometry used by canSAS are consistent with: </para> 
     450        <itemizedlist> 
     451            <listitem> 
     452                <para>Cartesian: <link xlink:href="http://en.wikipedia.org/wiki/Cartesian_coordinate_system" 
     453                    ><literal>http://en.wikipedia.org/wiki/Cartesian_coordinate_system</literal></link></para> 
     454            </listitem> 
     455            <listitem> 
     456                <para>Right-hand rule: <link xlink:href="http://en.wikipedia.org/wiki/Right-hand_rule" 
     457                    ><literal>http://en.wikipedia.org/wiki/Right-hand_rule</literal></link></para> 
     458            </listitem> 
     459            <listitem> 
     460                <para>NeXus: <link xlink:href="http://www.nexusformat.org/Coordinate_Systems" 
     461                    ><literal>http://www.nexusformat.org/Coordinate_Systems</literal></link></para> 
     462            </listitem> 
     463            <listitem> 
     464                <para><literal>McStas</literal>:  
     465                    <link xlink:href="http://mcstas.risoe.dk/documentation/tutorial/node6.html" 
     466                        ><literal>http://mcstas.risoe.dk/documentation/tutorial/node6.html</literal 
     467                        ></link></para> 
     468            </listitem> 
    485469                <!-- PRJ, 2009-10-08: no longer available, this was a robotics book 
    486470                    Now, that work is (from http://www.springer.com/engineering/book/978-0-387-32475-3) 
     
    494478                        ><literal>http://webhost5.nts.jhu.edu/reza/book/kinematics/kinematics.htm</literal></link></para> 
    495479                </listitem>--> 
    496             </itemizedlist> 
    497             <para>The translation and orientation geometry definitions used here are different than 
    498                 those used by <link xlink:href="http://www.nanotech.wisc.edu/shadow"><emphasis 
    499                         role="bold">SHADOW</emphasis></link> 
    500                 <footnote><para> 
    501                     <link xlink:href="http://www.nanotech.wisc.edu/shadow" 
    502                         ><literal>http://www.nanotech.wisc.edu/shadow</literal></link></para></footnote> 
    503                 where the <emphasis role="italic">y</emphasis> and <emphasis role="italic" 
    504                     >z</emphasis> axes are swapped and the direction of <emphasis role="italic" 
     480        </itemizedlist> 
     481        <para>The translation and orientation geometry definitions used here are different than 
     482            those used by <link xlink:href="http://www.nanotech.wisc.edu/shadow" 
     483                ><literal>SHADOW</literal></link> 
     484            <footnote><para> 
     485                <link xlink:href="http://www.nanotech.wisc.edu/shadow" 
     486                    ><literal>http://www.nanotech.wisc.edu/shadow</literal></link></para></footnote> 
     487            where the <emphasis role="italic">y</emphasis> and <emphasis role="italic" 
     488                >z</emphasis> axes are swapped and the direction of <emphasis role="italic" 
    505489                    >x</emphasis> is changed.</para> 
    506         </section> 
    507         <section xml:id="cansas1d_documentation-converting_into_XML"> 
    508             <title>Converting data into the XML format</title> 
    509             <para>The  
    510                 <link xlink:href="http://www.smallangles.net/canSAS/xmlWriter/" 
    511                     ><emphasis role="italic">canSAS/xmlWriter</emphasis></link> 
    512                 <footnote> 
    513                     <para><link xlink:href="http://www.smallangles.net/canSAS/xmlWriter/" 
    514                         ><literal>http://www.smallangles.net/canSAS/xmlWriter/</literal></link></para> 
    515                 </footnote> 
    516                 <indexterm><primary><literal>xmlWriter</literal></primary></indexterm> 
    517                 is a WWW form 
    518                 to translate three-column ASCII text data into the cansas1d/1.0 XML 
    519                 format. This form will help you in creating an XML file with all the required 
    520                 elements in the correct places. The form requests the SAS data of Q, I, and Idev 
    521                 (defined elsewhere on this page) and some basic metadata (title, run, sample info, 
    522                 ...). </para> 
    523             <para>Press the <code>Submit</code> button and you will receive a nicely 
    524                 formatted WWW page with the SAS data. If you then choose "View page source" (from 
    525                 one of your browser menus), you will see the raw XML of the cansas1d/1.0 XML format 
    526                 and you can copy/paste this into an XML file. </para> 
    527             <para>The SAS data that you paste into the form box is likely to be copied directly from 
    528                 a 3-column ASCII file from a text editor. Line breaks are OK, they will be treated 
    529                 as white-space as will tabs and commas. Do not be concerned that the data looks 
    530                 awful in the form entry box, just check the result to see that it comes out 
    531                 OK.</para> 
    532         </section> 
     490    </section> 
     491    <section xml:id="cansas1d_documentation-converting_into_XML"> 
     492        <title>Converting data into the XML format</title> 
     493        <para>The  
     494            <link xlink:href="http://www.smallangles.net/canSAS/xmlWriter/" 
     495                ><emphasis role="italic">canSAS/xmlWriter</emphasis></link> 
     496            <footnote> 
     497                <para><link xlink:href="http://www.smallangles.net/canSAS/xmlWriter/" 
     498                    ><literal>http://www.smallangles.net/canSAS/xmlWriter/</literal></link></para> 
     499            </footnote> 
     500            <indexterm><primary><literal>xmlWriter</literal></primary></indexterm> 
     501            is a WWW form 
     502            to translate three-column ASCII text data into the cansas1d/1.0 XML 
     503            format. This form will help you in creating an XML file with all the required 
     504            elements in the correct places. The form requests the SAS data of Q, I, and Idev 
     505            (defined elsewhere on this page) and some basic metadata (title, run, sample info, 
     506            ...). </para> 
     507        <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 
     510            and you can copy/paste this into an XML file. </para> 
     511        <para>The SAS data that you paste into the form box is likely to be copied directly from 
     512            a 3-column ASCII file from a text editor. Line breaks are OK, they will be treated 
     513            as white-space as will tabs and commas. Do not be concerned that the data looks 
     514            awful in the form entry box, just check the result to see that it comes out 
     515            OK.</para> 
    533516    </section> 
    534517    <section xml:id="cansas1d_documentation-Documentation-Definitions"> 
     
    728711                <para>Here is a brief sketch of how a file would be arranged with multiple SASentry 
    729712                    elements and multiple SASdata elements. 
    730                     <programlisting language="xml" linenumbering="numbered"> 
    731                         <textobject> 
    732                             <textdata fileref="brief-sketch-multiple.xml"/> 
    733                         </textobject> 
    734                     </programlisting> 
     713                    <example> 
     714                        <title>Brief sketch of a file with multiple SASentry and SASdata blocks.</title> 
     715                        <programlisting language="xml" linenumbering="numbered"> 
     716                            <textobject> 
     717                                <textdata fileref="brief-sketch-multiple.xml"/> 
     718                            </textobject> 
     719                        </programlisting> 
     720                    </example> 
    735721                </para> 
    736722            </section> 
Note: See TracChangeset for help on using the changeset viewer.