Changeset 147


Ignore:
Timestamp:
Nov 27, 2009 8:42:10 PM (10 years ago)
Author:
prjemian
Message:

added more index items, adjusted language for Qdev and Idev descriptions (estimated uncertainty), fixed some formatting problems

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

Legend:

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

    r142 r147  
    3030        This tool reads the vectors of 1-D SAS data (Q, I, ...)  
    3131        into IgorPro waves (Qsas, Isas, ...). The tool also reads  
    32         most of the metadata into an IgorPro textWave for use by other  
     32        most of the metadata 
     33        <indexterm><primary>metadata</primary></indexterm> 
     34        into an IgorPro textWave for use by other  
    3335        support in IgorPro.</para></note> 
    3436    <note><para>Note that the code described here is <emphasis>not a complete user interface</emphasis>. 
     
    231233            standard IgorPro routines). For <literal>SASentry</literal> elements that 
    232234            contain more than one SASdata element, a <literal>SASdata</literal> folder 
    233             is created for each and the corresponding <literal>I(Q)</literal> is placed in that 
     235            is created for each and the corresponding  
     236            <literal>I(Q)</literal><indexterm><primary>I(Q)</primary></indexterm> 
     237            is placed in that 
    234238            subfolder. When only one <literal>SASdata</literal> is found, the 
    235239                <literal>I(Q)</literal>data is placed in the main <literal>Title</literal> 
     
    244248        <section> 
    245249            <title>metadata</title> 
    246             <para> Additional metadata is collected into a single text wave 
    247                 (<emphasis>metadata</emphasis>) where the first columnis  
     250            <para> Additional metadata 
     251                <indexterm><primary>metadata</primary></indexterm> 
     252                is collected into a single text wave 
     253                (<emphasis>metadata</emphasis>) where the first column is  
    248254                an identifier (or 
    249255                <emphasis>key</emphasis>) and the second identifier is the 
     
    258264                routine to <emphasis>clean these up</emphasis> if the need arises. 
    259265            </para></caution> 
    260                 <para> The code checks for most metadata elements and will check for repeated 
     266            <para> The code checks for most metadata 
     267                <indexterm><primary>metadata</primary></indexterm> 
     268                elements and will check for repeated 
    261269                elements where the standard permits. </para> 
    262             <para> Here is an example of the metadata for the  
     270            <para> Here is an example of the metadata 
     271                <indexterm><primary>metadata</primary></indexterm> 
     272                for the  
    263273                <literal>cs_collagen_full.xml</literal> case study:  
    264274                <table> 
     
    369379            <para> The <link xlink:href="http://www.igorexchange.com/project/XMLutils" 
    370380                ><citetitle><literal>XMLutils</literal></citetitle></link>  
    371                 package does not provide a 
    372                 method to insert the prescribed XML  
    373                 stylesheet processing-instruction into the XML 
    374                 data file. 
     381                package does not provide a method to insert the prescribed XML  
     382                stylesheet  
     383                <indexterm><primary>XML Stylesheet</primary></indexterm> 
     384                processing-instruction into the XML data file. 
    375385                <programlisting>&lt;?xml-stylesheet type=text/xsl href=example.xsl ?&gt;</programlisting> 
    376386                If this processing-instruction is desired,  
     
    458468                    <emphasis role="bold">This is what guides the 
    459469                        work</emphasis>, given a file ID returned from <emphasis role="bold" 
    460                         >XMLOpenFile()</emphasis>, parses that file for SAS data and metadata (1i in 
    461                     the function name signifies this is a function that supports INPUT from version 
    462                     1.0 XML files) </para> 
     470                            >XMLOpenFile()</emphasis>, parses that file for SAS data and metadata 
     471                    <indexterm><primary>metadata</primary></indexterm> 
     472                    (1i in the function name signifies this is a function that supports  
     473                    INPUT from version 1.0 XML files) </para> 
    463474            </listitem> 
    464475            <listitem> 
     
    469480                        <tertiary><literal>CS_1i_getOneSASdata()</literal></tertiary> 
    470481                    </indexterm> 
    471                     harvest the data and 
    472                     metadata in the specific SASdata element </para> 
     482                    harvest the data and metadata 
     483                    <indexterm><primary>metadata</primary></indexterm> 
     484                    in the specific SASdata element </para> 
    473485            </listitem> 
    474486            <listitem> 
     
    511523                    queries XML file for <emphasis 
    512524                        role="bold">xpath</emphasis>. If <emphasis role="bold">value</emphasis> is 
    513                     not empty, appends it to <emphasis role="bold">metadata</emphasis> where 
    514                         <emphasis>last</emphasis> is the new last row: metadata[last][0]=key; 
     525                    not empty, appends it to <emphasis role="bold">metadata</emphasis> 
     526                    <indexterm><primary>metadata</primary></indexterm> 
     527                    where <emphasis>last</emphasis> is the new last row: metadata[last][0]=key; 
    515528                    metadata[last][1]=value </para> 
    516529            </listitem> 
  • 1dwg/trunk/doc/src/binding_Java.xml

    r142 r147  
    5757            </listitem> 
    5858            <listitem> 
    59                 <para> Question : How do I pull out the <emphasis>I(Q)</emphasis> data? </para> 
     59                <para>  
     60                    Question : How do I pull out the  
     61                    <emphasis>I(Q)</emphasis><indexterm><primary>I(Q)</primary></indexterm>  
     62                    data?  
     63                </para> 
    6064            </listitem> 
    6165            <listitem> 
     
    9094    <section> 
    9195        <title>example: how to retrieve I(Q)</title> 
     96        <indexterm><primary>I(Q)</primary></indexterm>  
    9297        <para> 
    9398            Look for the line that has  
  • 1dwg/trunk/doc/src/casestudy_collagen.xml

    r142 r147  
    6464            was collected on a linear position-sensitive detector and reduced to 
    6565            columns of <emphasis role="bold">Q</emphasis>, <emphasis role="bold">I</emphasis>, and 
    66                 <emphasis role="bold">Iesd</emphasis> (estimated standard deviation of <emphasis 
     66                <emphasis role="bold">Idev</emphasis> (estimated standard deviation of <emphasis 
    6767                role="bold">I</emphasis>). </para> 
    68         <para> The only metadata available for this data (without resorting to digging through piles 
     68        <para> The only metadata 
     69            <indexterm><primary>metadata</primary></indexterm> 
     70            available for this data (without resorting to digging through piles 
    6971            of old notebooks) was obtained from two file headers:  
    7072            <link 
     
    120122            <title>modify collagen.xml</title> 
    121123            <para> It is easier to see the metadata in the XML file before you enter the SAXS data 
    122                 into the file. With the brief metadata available, most of the other  
     124                into the file. With the brief metadata 
     125                <indexterm><primary>metadata</primary></indexterm> 
     126                available, most of the other  
    123127                lines in <citetitle>cansas1d.xml</citetitle> can be eliminated. This 
    124128                will result in a file that looks like the next example.</para> 
  • 1dwg/trunk/doc/src/element_SAScollimation.xml

    r142 r147  
    1919                <primary>element</primary> 
    2020                <secondary>SAScollimation</secondary> 
    21             </indexterm> 
     21            </indexterm>  
    2222            <para> 
    2323                parent: 
  • 1dwg/trunk/doc/src/element_SASdata.xml

    r143 r147  
    1515    <title>SASdata element</title> 
    1616    <itemizedlist mark="opencircle"> 
    17         <indexterm significance="preferred"> 
    18             <primary>element</primary> 
    19             <secondary>SASdata</secondary> 
    20         </indexterm> 
    2117        <listitem> 
     18            <indexterm significance="preferred"> 
     19                <primary>element</primary> 
     20                <secondary>SASdata</secondary> 
     21            </indexterm> 
    2222            <para> parent: <link xlink:href="#cansas1d_documentation-element-SASentry" 
    2323                ><literal>SASentry</literal></link> 
     
    186186                        <entry> floating-point number </entry> 
    187187                        <entry> [0..1] </entry> 
    188                         <entry> Estimated standard deviation of <literal>I</literal>. 
     188                        <entry> Estimated uncertainty (usually standard deviation) of <literal>I</literal>. 
    189189                            The <literal>unit</literal> attribute is required. See 
    190190                                <link xlink:href="#cansas1d_documentation-rules">rules for 
     
    205205                        <entry> floating-point number </entry> 
    206206                        <entry> [0..1] </entry> 
    207                         <entry> Estimated standard deviation of <literal>Q</literal>. 
     207                        <entry> Estimated uncertainty (usually standard deviation) of <literal>Q</literal>. 
    208208                            (optional: see note below on usage) 
    209209                            The <literal>unit</literal>  
     
    317317                            <link xlink:href="#cansas1d_documentation-element-any" 
    318318                                ><literal>{any}</literal></link> 
     319                            <indexterm> 
     320                                <primary>element</primary> 
     321                                <secondary>&lt;any&gt;</secondary> 
     322                            </indexterm> 
    319323                        </entry> 
    320324                        <entry> container </entry> 
     
    351355        <note> 
    352356            <para> 
    353                 <emphasis role="bold">The Shadowfactor attribute definition needs revision. 
     357                <emphasis role="bold">The <literal>Shadowfactor</literal> element definition needs revision. 
    354358                    NIST?</emphasis> 
    355359            </para> 
  • 1dwg/trunk/doc/src/element_SASdetector.xml

    r142 r147  
    1515    <title>SASdetector element</title> 
    1616    <itemizedlist mark="opencircle"> 
     17        <listitem> 
    1718        <indexterm significance="preferred"> 
    1819            <primary>element</primary> 
    1920            <secondary>SASdetector</secondary> 
    2021        </indexterm> 
    21         <listitem> 
    2222            <para> 
    2323                parent:  
  • 1dwg/trunk/doc/src/element_SASentry.xml

    r142 r147  
    116116                        <link xlink:href="#cansas1d_documentation-element-any" 
    117117                            ><literal>{any}</literal></link> 
     118                        <indexterm> 
     119                            <primary>element</primary> 
     120                            <secondary>&lt;any&gt;</secondary> 
     121                        </indexterm> 
    118122                    </entry> 
    119123                    <entry> 
     
    127131                        See <link xlink:href="#cansas1d_documentation-element-any" 
    128132                            ><literal>{any}</literal></link>  
     133                        <indexterm> 
     134                            <primary>element</primary> 
     135                            <secondary>&lt;any&gt;</secondary> 
     136                        </indexterm> 
    129137                        for more details. 
    130138                    </entry> 
     
    157165                    <entry> 
    158166                        <link xlink:href="#cansas1d_documentation-element-any"><literal>{any}</literal></link> 
     167                        <indexterm> 
     168                            <primary>element</primary> 
     169                            <secondary>&lt;any&gt;</secondary> 
     170                        </indexterm> 
    159171                    </entry> 
    160172                    <entry> 
  • 1dwg/trunk/doc/src/element_SASnote.xml

    r142 r147  
    6060                    <entry> 
    6161                        <link xlink:href="#cansas1d_documentation-element-any"><literal>{any}</literal></link> 
     62                        <indexterm> 
     63                            <primary>element</primary> 
     64                            <secondary>&lt;any&gt;</secondary> 
     65                        </indexterm> 
    6266                    </entry> 
    6367                    <entry> 
     
    6973                    <entry> 
    7074                        Any element(s) not defined in the cansas1d/1.0 standard can be placed at this point.  
    71                         See <link xlink:href="#cansas1d_documentation-element-any"><literal>{any}</literal></link> for more details. 
     75                        See <link xlink:href="#cansas1d_documentation-element-any"><literal>{any}</literal></link> 
     76                        for more details. 
    7277                    </entry> 
    7378                    <entry> 
  • 1dwg/trunk/doc/src/element_SASprocess.xml

    r142 r147  
    158158                        <link xlink:href="#cansas1d_documentation-element-any" 
    159159                            ><literal>{any}</literal></link> 
     160                        <indexterm> 
     161                            <primary>element</primary> 
     162                            <secondary>&lt;any&gt;</secondary> 
     163                        </indexterm> 
    160164                    </entry> 
    161165                    <entry> 
     
    202206                            <link xlink:href="#cansas1d_documentation-element-any" 
    203207                                ><literal>{any}</literal></link> 
     208                            <indexterm> 
     209                                <primary>element</primary> 
     210                                <secondary>&lt;any&gt;</secondary> 
     211                            </indexterm> 
    204212                        </entry> 
    205213                        <entry> 
  • 1dwg/trunk/doc/src/element_SASsample.xml

    r142 r147  
    150150                    <entry> 
    151151                        <link xlink:href="#cansas1d_documentation-element-any"><literal>{any}</literal></link> 
     152                        <indexterm> 
     153                            <primary>element</primary> 
     154                            <secondary>&lt;any&gt;</secondary> 
     155                        </indexterm> 
    152156                    </entry> 
    153157                    <entry> container </entry> 
  • 1dwg/trunk/doc/src/element_SASsource.xml

    r142 r147  
    6565                        <para> 
    6666                            Name of the radiation used. For maximum compatibility with NeXus, 
     67                            <indexterm><primary>NeXus</primary></indexterm> 
    6768                            use one of the names defined by either <link 
    6869                                xlink:href="http://www.nexusformat.org/NXsource" 
     
    8384                                xlink:href="http://www.nexusformat.org/NXsource" 
    8485                                ><citetitle>NeXus</citetitle> 
     86                                <indexterm><primary>NeXus</primary></indexterm> 
    8587                                <literal>NXsource/probe</literal></link>  
    8688                        </para> 
  • 1dwg/trunk/doc/src/element_XML_header.xml

    r142 r147  
    5555                    <entry> 
    5656                        <para><code>&lt;?xml-stylesheet type="text/xsl" href="example.xsl" 
    57                             ?></code></para> 
    58                         <para> Declares that <emphasis role="italic">example.xsl</emphasis> (needs 
    59                             to be in the local directory) will be the default stylesheet to an XML 
    60                             visualization tool. Change <emphasis role="italic" 
     57                            ?&gt;</code></para> 
     58                        <para>Declares <emphasis role="italic">example.xsl</emphasis> (needs 
     59                            to be in the local directory) is the default stylesheet 
     60                            <indexterm><primary>XML Stylesheet</primary></indexterm> 
     61                            of an XML visualization tool. Change <emphasis role="italic" 
    6162                                >example.xsl</emphasis> to indicate a different stylesheet in the 
    62                             local directory. Refer to <link 
    63                                 xlink:href="http://www.w3schools.org/xsl">W3 Schools XSLT 
     63                            local directory.<footnote><para>Refer to <link 
     64                                xlink:href="http://www.w3schools.org/xsl"><literal 
     65                                    >http://www.w3schools.org/xsl</literal> 
     66                                W3 Schools XSLT 
    6467                                Help</link> for assistance in constructing XSLT  
    65                             files.<footnote><para><link 
    66                                 xlink:href="http://www.w3schools.org/xsl"><literal 
    67                                     >http://www.w3schools.org/xsl</literal></link></para></footnote>  
     68                                files.</para></footnote>  
     69                            <footnote> 
     70                                <para> XML rules actually allow for multiple stylesheet 
     71                                   <indexterm><primary>XML Stylesheet</primary></indexterm> 
     72                                   declarations.  Explore this possibility as your own adventure.  
     73                                </para> 
     74                            </footnote> 
    6875                        </para> 
    69                         <para> XML rules actually allow for multiple stylesheet declarations. 
    70                             Explore this possibility as your own adventure. </para> 
    7176                    </entry> 
    7277                    <entry> 
     
    8994                                                        <link 
    9095                                                            xlink:href="http://www.nexusformat.org/NXroot"><literal>NXroot</literal></link> 
    91                             used by NeXus.<footnote><para><link xlink:href="http://www.nexusformat.org/NXroot" 
     96                            used by  
     97                            <indexterm><primary>NeXus</primary></indexterm> 
     98                            NeXus.<footnote><para><link xlink:href="http://www.nexusformat.org/NXroot" 
    9299                                ><literal>http://www.nexusformat.org/NXroot</literal></link></para></footnote>) 
    93100                                                </para> 
  • 1dwg/trunk/doc/src/element_any.xml

    r142 r147  
    1414    version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink"> 
    1515    <title><literal>{any}</literal> element</title> 
     16    <indexterm significance="preferred"> 
     17        <primary>element</primary> 
     18        <secondary>&lt;any&gt;</secondary> 
     19    </indexterm>  
    1620    <table orient="port" role="small"> 
    1721        <title/> 
  • 1dwg/trunk/doc/src/elements.xml

    r142 r147  
    9898                    <indexterm><primary>XML</primary><secondary>attributes</secondary></indexterm> 
    9999                    list the required or optional attributes of this element.  Note that attributes must 
    100                     adhere to the well-formed XML guidelines 
     100                    adhere to the well-formed<footnote><para><link  
     101                        xlink:href="http://www.w3schools.com/xmL/xml_syntax.asp" 
     102                        ><literal>http://www.w3schools.com/xmL/xml_syntax.asp</literal></link></para></footnote> 
     103                    <indexterm><primary>XML</primary><secondary>well-formed</secondary></indexterm> 
     104                    XML guidelines 
    101105                    <programlisting>attributename="value"</programlisting> 
    102106                    where either single or double quotes surround the value.   
  • 1dwg/trunk/doc/src/examples.xml

    r142 r147  
    4444                    xlink:href="http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/bimodal-test1.xml" 
    4545                    ><literal>bimodal-test1.xml</literal></link> example file in the main distribution. 
    46                 The stylesheet in <literal>data-simple.xml</literal> is very basic 
     46                The stylesheet 
     47                <indexterm><primary>XML Stylesheet</primary></indexterm> 
     48                in <literal>data-simple.xml</literal> is very basic 
    4749                <footnote><para><link 
    4850                    xlink:href="http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/bimodal-test1.xml" 
     
    7173                    <secondary>cansas1d.xml</secondary> 
    7274                </indexterm> 
    73                 shows example 
     75                shows examples 
    7476                of most of the elements of the cansas1d/1.0 standard.  Only a single data  
    7577                point has been shown to more clearly show the other structure. 
     
    8284                <secondary>cansas1d/1.0 data file</secondary> 
    8385            </indexterm> 
    84             <example> 
    85                 <title><citetitle>cansas1d.xml</citetitle></title> 
     86            <!-- too long for a DocBook "example" --> 
     87            <informalexample> 
     88                <!--<title><citetitle>cansas1d.xml</citetitle></title>--> 
    8689                <programlisting language="xml" linenumbering="numbered"> 
    8790                    <textobject> 
     
    8992                    </textobject> 
    9093                </programlisting> 
    91             </example> 
     94            </informalexample> 
    9295        </section> 
    9396    </section> 
     
    9699        <para> 
    97100            This section presents examples of XML Stylesheets  
    98             <indexterm> 
     101            <indexterm significance="preferred"> 
    99102                <primary>XML Stylesheet</primary> 
    100103            </indexterm> 
     
    107110            are used to transform XML documents into  
    108111            other documents such as XML documents, xhtml documents, or even ASCII text. 
    109             XML stylesheets also can be used to extract metadata from XML files. 
     112            XML stylesheets also can be used to extract metadata 
     113            <indexterm><primary>metadata</primary></indexterm> 
     114            from XML files. 
    110115            <indexterm> 
    111116                <primary>XML Stylesheet</primary> 
     
    155160                is the standard XSL stylesheet for cansas1d/1.0 files. 
    156161                It shows all available <literal>SASdata</literal> 
    157                 and metadata, separated by the different  
     162                and metadata, 
     163                <indexterm><primary>metadata</primary></indexterm> 
     164                separated by the different  
    158165                <literal>SASentry</literal> blocks. 
    159166            </para> 
     
    162169                <secondary>cansasxml-html.xsl</secondary> 
    163170            </indexterm> 
    164             <!-- Cannot make next code into multi-page example it seems. --> 
    165             <!--<example> 
    166                 <title><citetitle>cansasxml-html.xsl</citetitle></title>--> 
     171            <!-- too long for a DocBook "example" --> 
     172            <informalexample> 
     173                <!--<title><citetitle>cansasxml-html.xsl</citetitle></title>--> 
    167174                <programlisting language="xml" linenumbering="numbered"> 
    168175                    <textobject> 
     
    170177                    </textobject> 
    171178                </programlisting> 
    172             <!--</example>--> 
     179            </informalexample> 
    173180        </section> 
    174181    </section> 
  • 1dwg/trunk/doc/src/glossary.xml

    r142 r147  
    6363                    <itemizedlist mark="opencircle"><listitem> 
    6464                        <para> 
    65                             [0..1] : element is optional but can only appear once within enclosing element 
     65                            [0..1] : element is optional but can only appear once 
     66                            within enclosing element 
    6667                        </para> 
    6768                    </listitem> 
    6869                        <listitem> 
    6970                            <para> 
    70                                 [1..1] : element is required and can only appear once within enclosing element 
     71                                [1..1] : element is required and can only appear 
     72                                once within enclosing element 
    7173                            </para> 
    7274                        </listitem> 
    7375                        <listitem> 
    7476                            <para> 
    75                                 [1..inf] : element is required but can appear as many times as needed within enclosing element 
     77                                [1..inf] : element is required but can appear as many 
     78                                times as needed within enclosing element 
    7679                            </para> 
    7780                        </listitem> 
    7881                        <listitem> 
    7982                            <para> 
    80                                 [0..inf] : element is optional and can appear as many times as needed within enclosing element 
     83                                [0..inf] : element is optional and can appear as many  
     84                                times as needed within enclosing element 
    8185                            </para> 
    8286                        </listitem> 
    8387                        <listitem> 
    8488                            <para> 
    85                                 [] : element is optional, number of appearances within enclosing element is not specified 
     89                                [] : element is optional, number of appearances within  
     90                                enclosing element is not specified 
    8691                            </para> 
    8792                        </listitem> 
     
    112117                        ><literal>SASroot</literal></link> 
    113118                    <indexterm><primary>element</primary><secondary>SASroot</secondary></indexterm>  
    114                     database. This is similar to the root element of a NeXus file (<literal>NXroot</literal>). 
     119                    database. This is similar to the root element of a NeXus 
     120                    <indexterm><primary>NeXus</primary></indexterm> 
     121                    file (<literal>NXroot</literal>). 
    115122                </para></glossdef> 
    116123            </glossentry> 
     
    118125                <glossterm><code>/cs:SASroot/@version</code></glossterm> 
    119126                <glossdef><para> 
    120                     [1..1] version="1.0" Required attribute to indicate the version of the standard to which this XML document is encoded. 
     127                    [1..1] version="1.0" Required attribute to indicate the version  
     128                    of the standard to which this XML document is encoded. 
    121129                </para></glossdef> 
    122130            </glossentry> 
     
    129137                    <indexterm><primary>element</primary><secondary>SASentry</secondary></indexterm>  
    130138                    This is similar to <literal>NXentry</literal> used by NeXus. 
    131                     A <literal>SASentry</literal> can use an optional <literal>name</literal> attribute to provide a string for this SASentry.  
     139                    <indexterm><primary>NeXus</primary></indexterm> 
     140                    A <literal>SASentry</literal> can use an optional  
     141                    <literal>name</literal> attribute to provide a string for this SASentry.  
    132142                </para></glossdef> 
    133143            </glossentry> 
     
    135145                <glossterm><code>/cs:SASroot/cs:SASentry/@name</code></glossterm> 
    136146                <glossdef><para> 
    137                     [0..1] Optional string attribute to identify this particular <literal>SASentry</literal>.  Use of the string associated with the <literal>name</literal> attribute is not defined by this standard. 
     147                    [0..1] Optional string attribute to identify this  
     148                    particular <literal>SASentry</literal>.  Use of the  
     149                    string associated with the <literal>name</literal> attribute  
     150                    is not defined by this standard. 
    138151                </para></glossdef> 
    139152            </glossentry> 
     
    141154                <glossterm><code>/cs:SASroot/cs:SASentry/&lt;any></code></glossterm> 
    142155                <glossdef><para> 
    143                     [0..inf] Provision at this point for any element to be entered that is not part of the canSAS standard.  
     156                    [0..inf] Provision at this point for any 
     157                    <indexterm><primary>element</primary><secondary>&lt;any&gt;</secondary></indexterm>  
     158                    element to be entered  
     159                    that is not part of the canSAS standard.  
    144160                    Declare a default namespace declaration such as 
    145161                    <code>xmlns="urn:example-namespace:example-context"</code>  
     
    156172                <glossterm><code>/cs:SASroot/cs:SASentry/cs:Run</code></glossterm> 
    157173                <glossdef><para> 
    158                     [1..inf] Run identification for this SASentry. For many facilities, this is an integer. Use multiple instances of Run as needed. Note: How to correlate this with SASinstrument configurations has not yet been defined. 
     174                    [1..inf] Run 
     175                    <indexterm><primary>element</primary><secondary>Run</secondary></indexterm>  
     176                    identification for this SASentry. For many facilities, this is an integer.  
     177                    Use multiple instances of Run as needed.  
     178                    Note: How to correlate this with SASinstrument  
     179                    configurations has not yet been defined. 
    159180                </para></glossdef> 
    160181            </glossentry> 
     
    162183                <glossterm><code>/cs:SASroot/cs:SASentry/cs:Run/@name</code></glossterm> 
    163184                <glossdef><para> 
    164                     [0..1] Optional string attribute to identify this particular SASrun. Use this to associate (correlate) multiple SASdata elements with Run elements. (Give them the same name.) 
     185                    [0..1] Optional string attribute to identify this particular SASrun.  
     186                    Use this to associate (correlate) multiple SASdata elements with Run  
     187                    elements. (Give them the same name.) 
    165188                </para></glossdef> 
    166189            </glossentry> 
     
    168191                <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASdata</code></glossterm> 
    169192                <glossdef><para> 
    170                     [1..inf] Reduced 1-D SAS data for this SASentry. Use multiple SASdata elements to represent multiple frames. Use this to associate (correlate) multiple SASdata elements with Run elements. (Give them the same name.) 
     193                    [1..inf] Reduced 1-D SAS data for this SASentry. Use multiple SASdata 
     194                    <indexterm><primary>element</primary><secondary>SASdata</secondary></indexterm>  
     195                    elements to represent multiple frames. Use this to associate (correlate)  
     196                    multiple SASdata elements with Run elements. (Give them the same name.) 
    171197                </para></glossdef> 
    172198            </glossentry> 
     
    180206                <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASdata/cs:Idata</code></glossterm> 
    181207                <glossdef><para> 
    182                     [1..inf] Idata describes a single SAS data point. 
     208                    [1..inf] Idata 
     209                    <indexterm><primary>element</primary><secondary>Idata</secondary></indexterm>  
     210                    describes a single SAS data point. 
    183211                </para></glossdef> 
    184212            </glossentry> 
     
    186214                <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASdata/cs:Idata/cs:dQl</code></glossterm> 
    187215                <glossdef><para> 
    188                     [0..1] Q resolution perpendicular to the axis of scanning (the low-resolution slit length direction). 
     216                    [0..1] Q resolution 
     217                    <indexterm><primary>element</primary><secondary>dQl</secondary></indexterm>  
     218                    perpendicular to the axis of  
     219                    scanning (the low-resolution slit length direction). 
    189220                </para></glossdef> 
    190221            </glossentry> 
     
    198229                <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASdata/cs:Idata/cs:dQw</code></glossterm> 
    199230                <glossdef><para> 
    200                     [0..1] Q resolution along the axis of scanning (the high-resolution slit width direction). 
     231                    [0..1] Q resolution  
     232                    <indexterm><primary>element</primary><secondary>dQw</secondary></indexterm>  
     233                    along the axis of scanning (the high-resolution slit width direction). 
    201234                </para></glossdef> 
    202235            </glossentry> 
     
    210243                <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASdata/cs:Idata/cs:I</code></glossterm> 
    211244                <glossdef><para> 
    212                     [1..1] Intensity of the detected radiation. 
     245                    [1..1] Intensity 
     246                    <indexterm><primary>element</primary><secondary>I</secondary></indexterm>   
     247                    of the detected radiation. 
    213248                </para></glossdef> 
    214249            </glossentry> 
     
    222257                <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASdata/cs:Idata/cs:Idev</code></glossterm> 
    223258                <glossdef><para> 
    224                     [0..1] Estimated standard deviation of I. Must specify the unit as an attribute. 
     259                    [0..1] Estimated uncertainty (usually standard deviation) of I. 
     260                    <indexterm><primary>element</primary><secondary>Idev</secondary></indexterm>  
     261                    Must specify the unit as an attribute. 
    225262                </para></glossdef> 
    226263            </glossentry> 
     
    234271                <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASdata/cs:Idata/cs:Q</code></glossterm> 
    235272                <glossdef><para> 
    236                     [1..1] Q = (4 pi / lambda) sin(theta) where lambda is the wavelength of the radiation and 2theta is the angle through which the detected radiation has been scattered. 
     273                    [1..1] Q = (4 pi / lambda) sin(theta) 
     274                    <indexterm><primary>element</primary><secondary>Q</secondary></indexterm>  
     275                    where lambda is the wavelength of the radiation and 2theta is the angle  
     276                    through which the detected radiation has been scattered. 
    237277                </para></glossdef> 
    238278            </glossentry> 
     
    246286                <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASdata/cs:Idata/cs:Qdev</code></glossterm> 
    247287                <glossdef><para> 
    248                     [0..1] Estimated standard deviation of Q. Must specify the unit as an attribute. 
     288                    [0..1] Estimated uncertainty (usually standard deviation) of Q.  
     289                    <indexterm><primary>element</primary><secondary>Qdev</secondary></indexterm>  
     290                    Must specify the unit as an attribute. 
    249291                </para></glossdef> 
    250292            </glossentry> 
     
    258300                <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASdata/cs:Idata/cs:Qmean</code></glossterm> 
    259301                <glossdef><para> 
    260                     [0..1] Mean value of Q for this datum. Must specify the unit as an attribute. 
     302                    [0..1] Mean value of Q for this datum. 
     303                    <indexterm><primary>element</primary><secondary>Qmean</secondary></indexterm>  
     304                    Must specify the unit as an attribute. 
    261305                </para></glossdef> 
    262306            </glossentry> 
     
    270314                <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASdata/cs:Idata/cs:Shadowfactor</code></glossterm> 
    271315                <glossdef><para> 
    272                     [0..1] Describes the adjustment due to the beam stop penumbra. (This definition needs revision. NIST?) NOTE: There is no "unit" attribute. 
     316                    [0..1] Describes the adjustment due to the beam stop penumbra.  
     317                    <indexterm><primary>element</primary><secondary>Shadowfactor</secondary></indexterm>  
     318                    <note><para>The use of Shadowfactor is limited and not generally expected in files 
     319                        except those from the NIST NCNR.</para></note> 
    273320                </para></glossdef> 
    274321            </glossentry> 
     
    276323                <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASdata/cs:Idata/&lt;any></code></glossterm> 
    277324                <glossdef><para> 
    278                     [0..inf] Provision at this point for any element to be entered that is not part of the canSAS standard.  
     325                    [0..inf] Provision at this point for any 
     326                    <indexterm><primary>element</primary><secondary>&lt;any&gt;</secondary></indexterm>  
     327                    element to be entered that is not part of the canSAS standard.  
    279328                    Declare a default namespace declaration such as 
    280329                    <code>xmlns="urn:example-namespace:example-context"</code>  
     
    292341                <glossdef><para> 
    293342                    [1..1] Description of the instrument. 
     343                    <indexterm><primary>element</primary><secondary>SASinstrument</secondary></indexterm>  
    294344                </para></glossdef> 
    295345            </glossentry> 
     
    298348                <glossdef><para> 
    299349                    [1..1] Name of the instrument. 
     350                    <indexterm><primary>element</primary><secondary>name</secondary></indexterm>  
    300351                </para></glossdef> 
    301352            </glossentry> 
     
    304355                <glossdef><para> 
    305356                    [1..inf] Description of the instrument collimation. 
     357                    <indexterm><primary>element</primary><secondary>SAScollimation</secondary></indexterm>  
    306358                </para></glossdef> 
    307359            </glossentry> 
     
    316368                <glossdef><para> 
    317369                    [0..inf] Slit or aperture. 
     370                    <indexterm><primary>element</primary><secondary>aperture</secondary></indexterm>  
    318371                </para></glossdef> 
    319372            </glossentry> 
     
    333386                <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASinstrument/cs:SAScollimation/cs:aperture/cs:distance</code></glossterm> 
    334387                <glossdef><para> 
    335                     [0..1] Distance from this collimation element to the sample. 
     388                    [0..1] Distance 
     389                    <indexterm><primary>element</primary><secondary>distance</secondary></indexterm>  
     390                    from this collimation element to the sample. 
    336391                </para></glossdef> 
    337392            </glossentry> 
     
    346401                <glossdef><para> 
    347402                    [0..1] Opening dimensions of this aperture. 
     403                    <indexterm><primary>element</primary><secondary>size</secondary></indexterm>  
    348404                </para></glossdef> 
    349405            </glossentry> 
     
    358414                <glossdef><para> 
    359415                    [0..1] Dimension of the aperture in X. 
     416                    <indexterm><primary>element</primary><secondary>x</secondary></indexterm>  
    360417                </para></glossdef> 
    361418            </glossentry> 
     
    370427                <glossdef><para> 
    371428                    [0..1] Dimension of the aperture in Y. 
     429                    <indexterm><primary>element</primary><secondary>y</secondary></indexterm>  
    372430                </para></glossdef> 
    373431            </glossentry> 
     
    381439                <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASinstrument/cs:SAScollimation/cs:aperture/cs:size/cs:z</code></glossterm> 
    382440                <glossdef><para> 
    383                     [0..1] Dimension of the aperture in Z. While this is allowed by the standard, it does not make much sense for small-angle scattering. 
     441                    [0..1] Dimension of the aperture in Z.  
     442                    <indexterm><primary>element</primary><secondary>z</secondary></indexterm>  
     443                    While this is allowed by the standard, it does not make much sense for small-angle scattering. 
    384444                </para></glossdef> 
    385445            </glossentry> 
     
    394454                <glossdef><para> 
    395455                    [0..1] Amount/length of collimation inserted (on a SANS instrument). 
     456                    <indexterm><primary>element</primary><secondary>length</secondary></indexterm>  
    396457                </para></glossdef> 
    397458            </glossentry> 
     
    406467                <glossdef><para> 
    407468                    [1..inf] Description of a single or composite detector. 
     469                    <indexterm><primary>element</primary><secondary>SASdetector</secondary></indexterm>  
    408470                </para></glossdef> 
    409471            </glossentry> 
     
    412474                <glossdef><para> 
    413475                    [0..1] Center of the beam on the detector in X and Y. 
     476                    <indexterm><primary>element</primary><secondary>beam_center</secondary></indexterm>  
    414477                </para></glossdef> 
    415478            </glossentry> 
     
    424487                <glossdef><para> 
    425488                    [0..1] Center of the beam on the detector in X. 
     489                    <indexterm><primary>element</primary><secondary>x</secondary></indexterm>  
    426490                </para></glossdef> 
    427491            </glossentry> 
     
    436500                <glossdef><para> 
    437501                    [0..1] Center of the beam on the detector in Y. 
     502                    <indexterm><primary>element</primary><secondary>y</secondary></indexterm>  
    438503                </para></glossdef> 
    439504            </glossentry> 
     
    447512                <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASinstrument/cs:SASdetector/cs:beam_center/cs:z</code></glossterm> 
    448513                <glossdef><para> 
    449                     [0..1] Center of the beam on the detector in Z. While this is allowed by the standard, it does not make much sense for small-angle scattering. 
     514                    [0..1] Center of the beam on the detector in Z. 
     515                    <indexterm><primary>element</primary><secondary>z</secondary></indexterm>  
     516                    While this is allowed by the standard, it does not make much sense for small-angle scattering. 
    450517                </para></glossdef> 
    451518            </glossentry> 
     
    460527                <glossdef><para> 
    461528                    [1..1] Name of the detector. 
     529                    <indexterm><primary>element</primary><secondary>name</secondary></indexterm>  
    462530                </para></glossdef> 
    463531            </glossentry> 
     
    465533                <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASinstrument/cs:SASdetector/cs:offset</code></glossterm> 
    466534                <glossdef><para> 
    467                     [0..1] Offset of the detector position in X, Y, and Z. 
     535                    [0..1] Offset 
     536                    <indexterm><primary>element</primary><secondary>offset</secondary></indexterm>  
     537                    of the detector position in X, Y, and Z. 
    468538                </para></glossdef> 
    469539            </glossentry> 
     
    478548                <glossdef><para> 
    479549                    [0..1] Offset of the detector position in X. 
     550                    <indexterm><primary>element</primary><secondary>x</secondary></indexterm>  
    480551                </para></glossdef> 
    481552            </glossentry> 
     
    490561                <glossdef><para> 
    491562                    [0..1] Offset of the detector position in Y. 
     563                    <indexterm><primary>element</primary><secondary>y</secondary></indexterm>  
    492564                </para></glossdef> 
    493565            </glossentry> 
     
    507579                <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASinstrument/cs:SASdetector/cs:offset/cs:z/@unit</code></glossterm> 
    508580                <glossdef><para> 
     581                    [1..1] Required unit for the dimension of z.  
     582                    <indexterm><primary>element</primary><secondary>z</secondary></indexterm>  
     583                    (See @unit for details.) 
     584                </para></glossdef> 
     585            </glossentry> 
     586            <glossentry> 
     587                <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASinstrument/cs:SASdetector/cs:orientation</code></glossterm> 
     588                <glossdef><para> 
     589                    [0..1] Orientation (rotation) 
     590                    <indexterm><primary>element</primary><secondary>orientation</secondary></indexterm>  
     591                    of the detector in roll, pitch, and yaw. Must specify the unit as an attribute. 
     592                </para></glossdef> 
     593            </glossentry> 
     594            <glossentry> 
     595                <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASinstrument/cs:SASdetector/cs:orientation/@name</code></glossterm> 
     596                <glossdef><para> 
     597                    Optional attribute to name this orientation. 
     598                </para></glossdef> 
     599            </glossentry> 
     600            <glossentry> 
     601                <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASinstrument/cs:SASdetector/cs:orientation/cs:pitch</code></glossterm> 
     602                <glossdef><para> 
     603                    [0..1] Optional rotation of the detector about the X axis (pitch). 
     604                    <indexterm><primary>element</primary><secondary>pitch</secondary></indexterm>  
     605                </para></glossdef> 
     606            </glossentry> 
     607            <glossentry> 
     608                <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASinstrument/cs:SASdetector/cs:orientation/cs:pitch/@unit</code></glossterm> 
     609                <glossdef><para> 
     610                    [1..1] Required unit for the dimension of pitch. (See @unit for details.) 
     611                </para></glossdef> 
     612            </glossentry> 
     613            <glossentry> 
     614                <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASinstrument/cs:SASdetector/cs:orientation/cs:roll</code></glossterm> 
     615                <glossdef><para> 
     616                    [0..1] Optional rotation of the detector about the Z axis (roll). 
     617                    <indexterm><primary>element</primary><secondary>roll</secondary></indexterm>  
     618                </para></glossdef> 
     619            </glossentry> 
     620            <glossentry> 
     621                <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASinstrument/cs:SASdetector/cs:orientation/cs:roll/@unit</code></glossterm> 
     622                <glossdef><para> 
     623                    [1..1] Required unit for the dimension of roll. (See @unit for details.) 
     624                </para></glossdef> 
     625            </glossentry> 
     626            <glossentry> 
     627                <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASinstrument/cs:SASdetector/cs:orientation/cs:yaw</code></glossterm> 
     628                <glossdef><para> 
     629                    [0..1] Optional rotation of the detector about the Y axis (yaw). 
     630                    <indexterm><primary>element</primary><secondary>yaw</secondary></indexterm>  
     631                </para></glossdef> 
     632            </glossentry> 
     633            <glossentry> 
     634                <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASinstrument/cs:SASdetector/cs:orientation/cs:yaw/@unit</code></glossterm> 
     635                <glossdef><para> 
     636                    [1..1] Required unit for the dimension of yaw. (See @unit for details.) 
     637                </para></glossdef> 
     638            </glossentry> 
     639            <glossentry> 
     640                <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASinstrument/cs:SASdetector/cs:pixel_size</code></glossterm> 
     641                <glossdef><para> 
     642                    [0..1] Size of detector pixels in X and Y. 
     643                    <indexterm><primary>element</primary><secondary>pixel_size</secondary></indexterm>  
     644                </para></glossdef> 
     645            </glossentry> 
     646            <glossentry> 
     647                <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASinstrument/cs:SASdetector/cs:pixel_size/@name</code></glossterm> 
     648                <glossdef><para> 
     649                    Optional attribute to clarify the name of this detector pixel size. 
     650                </para></glossdef> 
     651            </glossentry> 
     652            <glossentry> 
     653                <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASinstrument/cs:SASdetector/cs:pixel_size/cs:x</code></glossterm> 
     654                <glossdef><para> 
     655                    [0..1] Size of detector pixels in X. 
     656                    <indexterm><primary>element</primary><secondary>x</secondary></indexterm>  
     657                </para></glossdef> 
     658            </glossentry> 
     659            <glossentry> 
     660                <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASinstrument/cs:SASdetector/cs:pixel_size/cs:x/@unit</code></glossterm> 
     661                <glossdef><para> 
     662                    [1..1] Required unit for the dimension of x. (See @unit for details.) 
     663                </para></glossdef> 
     664            </glossentry> 
     665            <glossentry> 
     666                <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASinstrument/cs:SASdetector/cs:pixel_size/cs:y</code></glossterm> 
     667                <glossdef><para> 
     668                    [0..1] Size of detector pixels in Y. 
     669                    <indexterm><primary>element</primary><secondary>y</secondary></indexterm>  
     670                </para></glossdef> 
     671            </glossentry> 
     672            <glossentry> 
     673                <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASinstrument/cs:SASdetector/cs:pixel_size/cs:y/@unit</code></glossterm> 
     674                <glossdef><para> 
     675                    [1..1] Required unit for the dimension of y. (See @unit for details.) 
     676                </para></glossdef> 
     677            </glossentry> 
     678            <glossentry> 
     679                <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASinstrument/cs:SASdetector/cs:pixel_size/cs:z</code></glossterm> 
     680                <glossdef><para> 
     681                    [0..1] Size of detector pixels in Z.  
     682                    <indexterm><primary>element</primary><secondary>z</secondary></indexterm>  
     683                    While this is allowed by the standard, it does not make much sense for small-angle scattering. 
     684                </para></glossdef> 
     685            </glossentry> 
     686            <glossentry> 
     687                <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASinstrument/cs:SASdetector/cs:pixel_size/cs:z/@unit</code></glossterm> 
     688                <glossdef><para> 
    509689                    [1..1] Required unit for the dimension of z. (See @unit for details.) 
    510690                </para></glossdef> 
    511691            </glossentry> 
    512692            <glossentry> 
    513                 <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASinstrument/cs:SASdetector/cs:orientation</code></glossterm> 
    514                 <glossdef><para> 
    515                     [0..1] Orientation (rotation) of the detector in roll, pitch, and yaw. Must specify the unit as an attribute. 
    516                 </para></glossdef> 
    517             </glossentry> 
    518             <glossentry> 
    519                 <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASinstrument/cs:SASdetector/cs:orientation/@name</code></glossterm> 
    520                 <glossdef><para> 
    521                     Optional attribute to name this orientation. 
    522                 </para></glossdef> 
    523             </glossentry> 
    524             <glossentry> 
    525                 <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASinstrument/cs:SASdetector/cs:orientation/cs:pitch</code></glossterm> 
    526                 <glossdef><para> 
    527                     [0..1] Optional rotation of the detector about the X axis (pitch). 
    528                 </para></glossdef> 
    529             </glossentry> 
    530             <glossentry> 
    531                 <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASinstrument/cs:SASdetector/cs:orientation/cs:pitch/@unit</code></glossterm> 
    532                 <glossdef><para> 
    533                     [1..1] Required unit for the dimension of pitch. (See @unit for details.) 
    534                 </para></glossdef> 
    535             </glossentry> 
    536             <glossentry> 
    537                 <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASinstrument/cs:SASdetector/cs:orientation/cs:roll</code></glossterm> 
    538                 <glossdef><para> 
    539                     [0..1] Optional rotation of the detector about the Z axis (roll). 
    540                 </para></glossdef> 
    541             </glossentry> 
    542             <glossentry> 
    543                 <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASinstrument/cs:SASdetector/cs:orientation/cs:roll/@unit</code></glossterm> 
    544                 <glossdef><para> 
    545                     [1..1] Required unit for the dimension of roll. (See @unit for details.) 
    546                 </para></glossdef> 
    547             </glossentry> 
    548             <glossentry> 
    549                 <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASinstrument/cs:SASdetector/cs:orientation/cs:yaw</code></glossterm> 
    550                 <glossdef><para> 
    551                     [0..1] Optional rotation of the detector about the Y axis (yaw). 
    552                 </para></glossdef> 
    553             </glossentry> 
    554             <glossentry> 
    555                 <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASinstrument/cs:SASdetector/cs:orientation/cs:yaw/@unit</code></glossterm> 
    556                 <glossdef><para> 
    557                     [1..1] Required unit for the dimension of yaw. (See @unit for details.) 
    558                 </para></glossdef> 
    559             </glossentry> 
    560             <glossentry> 
    561                 <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASinstrument/cs:SASdetector/cs:pixel_size</code></glossterm> 
    562                 <glossdef><para> 
    563                     [0..1] Size of detector pixels in X and Y. 
    564                 </para></glossdef> 
    565             </glossentry> 
    566             <glossentry> 
    567                 <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASinstrument/cs:SASdetector/cs:pixel_size/@name</code></glossterm> 
    568                 <glossdef><para> 
    569                     Optional attribute to clarify the name of this detector pixel size. 
    570                 </para></glossdef> 
    571             </glossentry> 
    572             <glossentry> 
    573                 <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASinstrument/cs:SASdetector/cs:pixel_size/cs:x</code></glossterm> 
    574                 <glossdef><para> 
    575                     [0..1] Size of detector pixels in X. 
    576                 </para></glossdef> 
    577             </glossentry> 
    578             <glossentry> 
    579                 <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASinstrument/cs:SASdetector/cs:pixel_size/cs:x/@unit</code></glossterm> 
     693                <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASinstrument/cs:SASdetector/cs:SDD</code></glossterm> 
     694                <glossdef><para> 
     695                    [0..1] Distance between sample and detector. 
     696                    <indexterm><primary>element</primary><secondary>SDD</secondary></indexterm>  
     697                    Must specify the unit as an attribute. 
     698                </para></glossdef> 
     699            </glossentry> 
     700            <glossentry> 
     701                <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASinstrument/cs:SASdetector/cs:SDD/@unit</code></glossterm> 
     702                <glossdef><para> 
     703                    [1..1] Required unit for SDD. (See @unit for details.) 
     704                </para></glossdef> 
     705            </glossentry> 
     706            <glossentry> 
     707                <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASinstrument/cs:SASdetector/cs:slit_length</code></glossterm> 
     708                <glossdef><para> 
     709                    [0..1] Slit length of the instrument for this detector. 
     710                    <indexterm><primary>element</primary><secondary>slit_length</secondary></indexterm>  
     711                    This is expressed in the same units as Q (reciprocal space units).  
     712                    Must specify the unit as an attribute. 
     713                </para></glossdef> 
     714            </glossentry> 
     715            <glossentry> 
     716                <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASinstrument/cs:SASdetector/cs:slit_length/@unit</code></glossterm> 
     717                <glossdef><para> 
     718                    [1..1] Required unit for the slit length. (See @unit for details.) 
     719                </para></glossdef> 
     720            </glossentry> 
     721            <glossentry> 
     722                <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASinstrument/cs:SASsource</code></glossterm> 
     723                <glossdef><para> 
     724                    [1..1] Description of the source of the radiation. 
     725                    <indexterm><primary>element</primary><secondary>SASsource</secondary></indexterm>  
     726                </para></glossdef> 
     727            </glossentry> 
     728            <glossentry> 
     729                <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASinstrument/cs:SASsource/@name</code></glossterm> 
     730                <glossdef><para> 
     731                    [0..1] Optional text description of the source of the radiation (incident on the sample). This can be different from /cs:SASroot/cs:SASentry/cs:SASinstrument/cs:SASsource/cs:radiation. 
     732                </para></glossdef> 
     733            </glossentry> 
     734            <glossentry> 
     735                <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASinstrument/cs:SASsource/cs:beam_shape</code></glossterm> 
     736                <glossdef><para> 
     737                    [0..1] Text description of the shape of the beam (incident on the sample). 
     738                    <indexterm><primary>element</primary><secondary>beam_shape</secondary></indexterm>  
     739                </para></glossdef> 
     740            </glossentry> 
     741            <glossentry> 
     742                <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASinstrument/cs:SASsource/cs:beam_size</code></glossterm> 
     743                <glossdef><para> 
     744                    [0..1] Physical dimension of the beam (incident on the sample).  
     745                    <indexterm><primary>element</primary><secondary>beam_size</secondary></indexterm>  
     746                    Note: If beam is round, just use X dimension. Note: While Z dimension is allowed by the standard, it does not make sense for small-angle scattering. 
     747                </para></glossdef> 
     748            </glossentry> 
     749            <glossentry> 
     750                <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASinstrument/cs:SASsource/cs:beam_size/@name</code></glossterm> 
     751                <glossdef><para> 
     752                    Optional attribute to clarify the name of this beam size. 
     753                </para></glossdef> 
     754            </glossentry> 
     755            <glossentry> 
     756                <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASinstrument/cs:SASsource/cs:beam_size/cs:x</code></glossterm> 
     757                <glossdef><para> 
     758                    [0..1] Dimension of the beam size in X. 
     759                    <indexterm><primary>element</primary><secondary>x</secondary></indexterm>  
     760                </para></glossdef> 
     761            </glossentry> 
     762            <glossentry> 
     763                <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASinstrument/cs:SASsource/cs:beam_size/cs:x/@unit</code></glossterm> 
    580764                <glossdef><para> 
    581765                    [1..1] Required unit for the dimension of x. (See @unit for details.) 
     
    583767            </glossentry> 
    584768            <glossentry> 
    585                 <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASinstrument/cs:SASdetector/cs:pixel_size/cs:y</code></glossterm> 
    586                 <glossdef><para> 
    587                     [0..1] Size of detector pixels in Y. 
    588                 </para></glossdef> 
    589             </glossentry> 
    590             <glossentry> 
    591                 <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASinstrument/cs:SASdetector/cs:pixel_size/cs:y/@unit</code></glossterm> 
     769                <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASinstrument/cs:SASsource/cs:beam_size/cs:y</code></glossterm> 
     770                <glossdef><para> 
     771                    [0..1] Dimension of the beam size in Y. 
     772                    <indexterm><primary>element</primary><secondary>y</secondary></indexterm>  
     773                </para></glossdef> 
     774            </glossentry> 
     775            <glossentry> 
     776                <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASinstrument/cs:SASsource/cs:beam_size/cs:y/@unit</code></glossterm> 
    592777                <glossdef><para> 
    593778                    [1..1] Required unit for the dimension of y. (See @unit for details.) 
     
    595780            </glossentry> 
    596781            <glossentry> 
    597                 <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASinstrument/cs:SASdetector/cs:pixel_size/cs:z</code></glossterm> 
    598                 <glossdef><para> 
    599                     [0..1] Size of detector pixels in Z. While this is allowed by the standard, it does not make much sense for small-angle scattering. 
    600                 </para></glossdef> 
    601             </glossentry> 
    602             <glossentry> 
    603                 <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASinstrument/cs:SASdetector/cs:pixel_size/cs:z/@unit</code></glossterm> 
     782                <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASinstrument/cs:SASsource/cs:beam_size/cs:z</code></glossterm> 
     783                <glossdef><para> 
     784                    [0..1] Dimension of the beam size in Z.  
     785                    <indexterm><primary>element</primary><secondary>z</secondary></indexterm>  
     786                    While this is allowed by the standard, it does not make much sense for small-angle scattering. 
     787                </para></glossdef> 
     788            </glossentry> 
     789            <glossentry> 
     790                <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASinstrument/cs:SASsource/cs:beam_size/cs:z/@unit</code></glossterm> 
    604791                <glossdef><para> 
    605792                    [1..1] Required unit for the dimension of z. (See @unit for details.) 
     
    607794            </glossentry> 
    608795            <glossentry> 
    609                 <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASinstrument/cs:SASdetector/cs:SDD</code></glossterm> 
    610                 <glossdef><para> 
    611                     [0..1] Distance between sample and detector. Must specify the unit as an attribute. 
    612                 </para></glossdef> 
    613             </glossentry> 
    614             <glossentry> 
    615                 <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASinstrument/cs:SASdetector/cs:SDD/@unit</code></glossterm> 
    616                 <glossdef><para> 
    617                     [1..1] Required unit for SDD. (See @unit for details.) 
    618                 </para></glossdef> 
    619             </glossentry> 
    620             <glossentry> 
    621                 <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASinstrument/cs:SASdetector/cs:slit_length</code></glossterm> 
    622                 <glossdef><para> 
    623                     [0..1] Slit length of the instrument for this detector. This is expressed in the same units as Q (reciprocal space units). Must specify the unit as an attribute. 
    624                 </para></glossdef> 
    625             </glossentry> 
    626             <glossentry> 
    627                 <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASinstrument/cs:SASdetector/cs:slit_length/@unit</code></glossterm> 
    628                 <glossdef><para> 
    629                     [1..1] Required unit for the slit length. (See @unit for details.) 
    630                 </para></glossdef> 
    631             </glossentry> 
    632             <glossentry> 
    633                 <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASinstrument/cs:SASsource</code></glossterm> 
    634                 <glossdef><para> 
    635                     [1..1] Description of the source of the radiation. 
    636                 </para></glossdef> 
    637             </glossentry> 
    638             <glossentry> 
    639                 <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASinstrument/cs:SASsource/@name</code></glossterm> 
    640                 <glossdef><para> 
    641                     [0..1] Optional text description of the source of the radiation (incident on the sample). This can be different from /cs:SASroot/cs:SASentry/cs:SASinstrument/cs:SASsource/cs:radiation. 
    642                 </para></glossdef> 
    643             </glossentry> 
    644             <glossentry> 
    645                 <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASinstrument/cs:SASsource/cs:beam_shape</code></glossterm> 
    646                 <glossdef><para> 
    647                     [0..1] Text description of the shape of the beam (incident on the sample). 
    648                 </para></glossdef> 
    649             </glossentry> 
    650             <glossentry> 
    651                 <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASinstrument/cs:SASsource/cs:beam_size</code></glossterm> 
    652                 <glossdef><para> 
    653                     [0..1] Physical dimension of the beam (incident on the sample). Note: If beam is round, just use X dimension. Note: While Z dimension is allowed by the standard, it does not make sense for small-angle scattering. 
    654                 </para></glossdef> 
    655             </glossentry> 
    656             <glossentry> 
    657                 <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASinstrument/cs:SASsource/cs:beam_size/@name</code></glossterm> 
    658                 <glossdef><para> 
    659                     Optional attribute to clarify the name of this beam size. 
    660                 </para></glossdef> 
    661             </glossentry> 
    662             <glossentry> 
    663                 <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASinstrument/cs:SASsource/cs:beam_size/cs:x</code></glossterm> 
    664                 <glossdef><para> 
    665                     [0..1] Dimension of the beam size in X. 
    666                 </para></glossdef> 
    667             </glossentry> 
    668             <glossentry> 
    669                 <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASinstrument/cs:SASsource/cs:beam_size/cs:x/@unit</code></glossterm> 
    670                 <glossdef><para> 
    671                     [1..1] Required unit for the dimension of x. (See @unit for details.) 
    672                 </para></glossdef> 
    673             </glossentry> 
    674             <glossentry> 
    675                 <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASinstrument/cs:SASsource/cs:beam_size/cs:y</code></glossterm> 
    676                 <glossdef><para> 
    677                     [0..1] Dimension of the beam size in Y. 
    678                 </para></glossdef> 
    679             </glossentry> 
    680             <glossentry> 
    681                 <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASinstrument/cs:SASsource/cs:beam_size/cs:y/@unit</code></glossterm> 
    682                 <glossdef><para> 
    683                     [1..1] Required unit for the dimension of y. (See @unit for details.) 
    684                 </para></glossdef> 
    685             </glossentry> 
    686             <glossentry> 
    687                 <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASinstrument/cs:SASsource/cs:beam_size/cs:z</code></glossterm> 
    688                 <glossdef><para> 
    689                     [0..1] Dimension of the beam size in Z. While this is allowed by the standard, it does not make much sense for small-angle scattering. 
    690                 </para></glossdef> 
    691             </glossentry> 
    692             <glossentry> 
    693                 <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASinstrument/cs:SASsource/cs:beam_size/cs:z/@unit</code></glossterm> 
    694                 <glossdef><para> 
    695                     [1..1] Required unit for the dimension of z. (See @unit for details.) 
    696                 </para></glossdef> 
    697             </glossentry> 
    698             <glossentry> 
    699796                <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASinstrument/cs:SASsource/cs:radiation</code></glossterm> 
    700797                <glossdef><para> 
    701                     [1..1] Name of the radiation used (neutron, X-ray, synchrotron X-ray, Cu Ka X-ray tube, ..." 
     798                    [1..1] Name of the radiation 
     799                    <indexterm><primary>element</primary><secondary>radiation</secondary></indexterm>  
     800                    used (neutron, X-ray, synchrotron X-ray, Cu Ka X-ray tube, ..." 
    702801                </para></glossdef> 
    703802            </glossentry> 
     
    705804                <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASinstrument/cs:SASsource/cs:wavelength</code></glossterm> 
    706805                <glossdef><para> 
    707                     [0..1] wavelength of radiation incident on the sample. 
     806                    [0..1] wavelength 
     807                    <indexterm><primary>element</primary><secondary>wavelength</secondary></indexterm>  
     808                    of radiation incident on the sample. 
    708809                </para></glossdef> 
    709810            </glossentry> 
     
    717818                <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASinstrument/cs:SASsource/cs:wavelength_max</code></glossterm> 
    718819                <glossdef><para> 
    719                     [0..1] Some facilities specify wavelength using a range. The maximum of such a range is given by wavelength_max. 
     820                    [0..1] Some facilities specify wavelength using a range. The maximum 
     821                    <indexterm><primary>element</primary><secondary>wavelength_max</secondary></indexterm>  
     822                    of such a range is given by wavelength_max. 
    720823                </para></glossdef> 
    721824            </glossentry> 
     
    729832                <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASinstrument/cs:SASsource/cs:wavelength_min</code></glossterm> 
    730833                <glossdef><para> 
    731                     [0..1] Some facilities specify wavelength using a range. The minimum of such a range is given by wavelength_min. 
     834                    [0..1] Some facilities specify wavelength using a range. The minimum  
     835                    <indexterm><primary>element</primary><secondary>wavelength_min</secondary></indexterm>  
     836                    of such a range is given by wavelength_min. 
    732837                </para></glossdef> 
    733838            </glossentry> 
     
    741846                <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASinstrument/cs:SASsource/cs:wavelength_spread</code></glossterm> 
    742847                <glossdef><para> 
    743                     [0..1] Some facilities specify the width of the wavelength spectrum. The minimum of such a range is given by wavelength_spread. 
     848                    [0..1] Some facilities specify the width 
     849                    <indexterm><primary>element</primary><secondary>wavelength_spread</secondary></indexterm> 
     850                    of the wavelength spectrum. The extent (or width) of such a range is given by wavelength_spread. 
    744851                </para></glossdef> 
    745852            </glossentry> 
     
    754861                <glossdef><para> 
    755862                    [1..inf] Free form description of anything not covered by other elements. 
     863                    <indexterm><primary>element</primary><secondary>SASnote</secondary></indexterm> 
    756864                </para></glossdef> 
    757865            </glossentry> 
     
    760868                <glossdef><para> 
    761869                    [0..inf] Description of a processing or analysis step. 
     870                    <indexterm><primary>element</primary><secondary>SASprocess</secondary></indexterm> 
    762871                </para></glossdef> 
    763872            </glossentry> 
     
    776885                <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASprocess/cs:date</code></glossterm> 
    777886                <glossdef><para> 
    778                     [0..1] Optional date for this data processing or analysis step.  
     887                    [0..1] Optional date 
     888                    <indexterm><primary>element</primary><secondary>date</secondary></indexterm> 
     889                    for this data processing or analysis step.  
    779890                    <note><para> 
    780891                        SHOULD WE SPECIFY THE FORMAT FOR THE DATE? 
     
    785896                <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASprocess/cs:description</code></glossterm> 
    786897                <glossdef><para> 
    787                     [0..1] Optional description for this data processing or analysis step. 
     898                    [0..1] Optional description 
     899                    <indexterm><primary>element</primary><secondary>description</secondary></indexterm> 
     900                    for this data processing or analysis step. 
    788901                </para></glossdef> 
    789902            </glossentry> 
     
    791904                <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASprocess/cs:name</code></glossterm> 
    792905                <glossdef><para> 
    793                     [0..1] Optional name for this data processing or analysis step. 
     906                    [0..1] Optional name 
     907                    <indexterm><primary>element</primary><secondary>name</secondary></indexterm> 
     908                    for this data processing or analysis step. 
    794909                </para></glossdef> 
    795910            </glossentry> 
     
    797912                <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASprocess/cs:SASprocessnote</code></glossterm> 
    798913                <glossdef><para> 
    799                     [1..inf] This element is used to describe anything about SASprocess that is not already described. 
     914                    [1..inf] This element is used to describe anything 
     915                    <indexterm><primary>element</primary><secondary>SASprocessnote</secondary></indexterm> 
     916                    about SASprocess that is not already described. 
    800917                </para></glossdef> 
    801918            </glossentry> 
     
    803920                <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASprocess/cs:SASprocessnote/&lt;any></code></glossterm> 
    804921                <glossdef><para> 
    805                     [0..inf] Provision at this point for any element to be entered that is not part of the canSAS standard.  
     922                    [0..inf] Provision at this point for any 
     923                    <indexterm><primary>element</primary><secondary>&lt;any&gt;</secondary></indexterm>  
     924                    element to be entered that is not part of the canSAS standard.  
    806925                    Declare a default namespace declaration such as 
    807926                    <code>xmlns="urn:example-namespace:example-context"</code>  
     
    818937                <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASprocess/cs:term</code></glossterm> 
    819938                <glossdef><para> 
    820                     [0..1] This is used to specify the value of a single variable, parameter, or term related to the SASprocess step. 
     939                    [0..1] This is used to specify the value 
     940                    <indexterm><primary>element</primary><secondary>term</secondary></indexterm> 
     941                    of a single variable, parameter, or term related to the SASprocess step. 
    821942                </para></glossdef> 
    822943            </glossentry> 
     
    825946                <glossdef><para> 
    826947                    [] Description of the sample. 
     948                    <indexterm><primary>element</primary><secondary>SASsample</secondary></indexterm> 
    827949                </para></glossdef> 
    828950            </glossentry> 
     
    837959                <glossdef><para> 
    838960                    [0..inf]  
    839                     Provision at this point for any element to be entered that is not part of the canSAS standard.  
     961                    Provision at this point for any 
     962                    <indexterm><primary>element</primary><secondary>&lt;any&gt;</secondary></indexterm>  
     963                    element to be entered that is not part of the canSAS standard.  
    840964                    Declare a default namespace declaration such as 
    841965                    <code>xmlns="urn:example-namespace:example-context"</code>  
     
    853977                <glossdef><para> 
    854978                    [0..inf] Text string to supply additional sample details. 
     979                    <indexterm><primary>element</primary><secondary>details</secondary></indexterm> 
    855980                </para></glossdef> 
    856981            </glossentry> 
     
    859984                <glossdef><para> 
    860985                    [1..1] Text string that identifies this sample. 
     986                    <indexterm><primary>element</primary><secondary>ID</secondary></indexterm> 
    861987                </para></glossdef> 
    862988            </glossentry> 
     
    865991                <glossdef><para> 
    866992                    [0..1] Orientation (rotation) of the sample. 
     993                    <indexterm><primary>element</primary><secondary>orientation</secondary></indexterm> 
    867994                </para></glossdef> 
    868995            </glossentry> 
     
    8771004                <glossdef><para> 
    8781005                    [0..1] Optional rotation of the sample about the X axis (pitch). 
     1006                    <indexterm><primary>element</primary><secondary>pitch</secondary></indexterm> 
    8791007                </para></glossdef> 
    8801008            </glossentry> 
     
    8891017                <glossdef><para> 
    8901018                    [0..1] Optional rotation of the sample about the Z axis (roll). 
     1019                    <indexterm><primary>element</primary><secondary>roll</secondary></indexterm> 
    8911020                </para></glossdef> 
    8921021            </glossentry> 
     
    9011030                <glossdef><para> 
    9021031                    [0..1] Optional rotation of the sample about the Y axis (yaw). 
     1032                    <indexterm><primary>element</primary><secondary>yaw</secondary></indexterm> 
    9031033                </para></glossdef> 
    9041034            </glossentry> 
     
    9121042                <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASsample/cs:position</code></glossterm> 
    9131043                <glossdef><para> 
    914                     [0..1] Location in X, Y, and Z of the sample. Must specify the unit as an attribute to each position. 
     1044                    [0..1] Location in X, Y, and Z of the sample. 
     1045                    <indexterm><primary>element</primary><secondary>position</secondary></indexterm> 
     1046                    Must specify the unit as an attribute to each position. 
    9151047                </para></glossdef> 
    9161048            </glossentry> 
     
    9251057                <glossdef><para> 
    9261058                    [0..1] Location of the sample in X. 
     1059                    <indexterm><primary>element</primary><secondary>x</secondary></indexterm> 
    9271060                </para></glossdef> 
    9281061            </glossentry> 
     
    9371070                <glossdef><para> 
    9381071                    [0..1] Location of the sample in Y. 
     1072                    <indexterm><primary>element</primary><secondary>y</secondary></indexterm> 
    9391073                </para></glossdef> 
    9401074            </glossentry> 
     
    9481082                <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASsample/cs:position/cs:z</code></glossterm> 
    9491083                <glossdef><para> 
    950                     [0..1] Location of the sample in Z. While this is allowed by the standard, it does not make much sense for small-angle scattering. 
     1084                    [0..1] Location of the sample in Z. 
     1085                    <indexterm><primary>element</primary><secondary>z</secondary></indexterm> 
     1086                    While this is allowed by the standard, it does not make much sense for small-angle scattering. 
    9511087                </para></glossdef> 
    9521088            </glossentry> 
     
    9601096                <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASsample/cs:temperature</code></glossterm> 
    9611097                <glossdef><para> 
    962                     [0..1] Temperature of this sample. Must specify the unit as an attribute. 
     1098                    [0..1] Temperature 
     1099                    <indexterm><primary>element</primary><secondary>temperature</secondary></indexterm> 
     1100                    of this sample. Must specify the unit as an attribute. 
    9631101                </para></glossdef> 
    9641102            </glossentry> 
     
    9721110                <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASsample/cs:thickness</code></glossterm> 
    9731111                <glossdef><para> 
    974                     [0..1] Thickness of this sample. Must specify the unit as an attribute. 
     1112                    [0..1] Thickness 
     1113                    <indexterm><primary>element</primary><secondary>thickness</secondary></indexterm> 
     1114                    of this sample. Must specify the unit as an attribute. 
    9751115                </para></glossdef> 
    9761116            </glossentry> 
     
    9841124                <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASsample/cs:transmission</code></glossterm> 
    9851125                <glossdef><para> 
    986                     [0..1] Transmission (1-attenuation) of this sample. Express this as a fraction, not as a percentage. NOTE: there is not "unit" attribute. 
     1126                    [0..1] Transmission (1-attenuation) 
     1127                    <indexterm><primary>element</primary><secondary>transmission</secondary></indexterm> 
     1128                    of this sample. Express this as a fraction, not as a percentage.  
     1129                    NOTE: there is not "unit" attribute. 
    9871130                </para></glossdef> 
    9881131            </glossentry> 
     
    9911134                <glossdef><para> 
    9921135                    [1..1] Title of this SASentry. 
     1136                    <indexterm><primary>element</primary><secondary>Title</secondary></indexterm> 
    9931137                </para></glossdef> 
    9941138            </glossentry> 
     
    10021146                <glossterm><code>cs:term</code></glossterm> 
    10031147                <glossdef><para> 
    1004                     [0..1] This is used to specify the value of a single variable, parameter, or term related to the SASprocess step. This could also be used in a SASnote element to indicate terms not associated with a SASprocess step. 
     1148                    [0..1] This is used 
     1149                    <indexterm><primary>element</primary><secondary>term</secondary></indexterm> 
     1150                    to specify the value of a single variable, parameter, or term related to the SASprocess step. This could also be used in a SASnote element to indicate terms not associated with a SASprocess step. 
    10051151                </para></glossdef> 
    10061152            </glossentry> 
     
    10211167                <glossdef><para> 
    10221168                    [0..1] Rotation about about the X axis. Unit must be specified. 
     1169                    <indexterm><primary>element</primary><secondary>pitch</secondary></indexterm> 
    10231170                </para></glossdef> 
    10241171            </glossentry> 
     
    10271174                <glossdef><para> 
    10281175                    [0..1] Rotation about about the Z axis. Unit must be specified. 
     1176                    <indexterm><primary>element</primary><secondary>roll</secondary></indexterm> 
    10291177                </para></glossdef> 
    10301178            </glossentry> 
     
    10331181                <glossdef><para> 
    10341182                    [0..1] Rotation about about the Y axis. Unit must be specified. 
     1183                    <indexterm><primary>element</primary><secondary>yaw</secondary></indexterm> 
    10351184                </para></glossdef> 
    10361185            </glossentry> 
     
    10381187                <glossterm><code>position/cs:x</code></glossterm> 
    10391188                <glossdef><para> 
    1040                     [0..1] Translation in the horizontal direction, orthogonal to Y and Z. Positive X direction increases as defined by Y and Z. Unit must be specified. 
     1189                    [0..1] Translation in the horizontal direction, 
     1190                    <indexterm><primary>element</primary><secondary>x</secondary></indexterm> 
     1191                    orthogonal to Y and Z. Positive X direction increases as defined by 
     1192                    Y and Z. Unit must be specified. 
    10411193                </para></glossdef> 
    10421194            </glossentry> 
     
    10441196                <glossterm><code>position/cs:y</code></glossterm> 
    10451197                <glossdef><para> 
    1046                     [0..1] Translation along the vertical gravitational direction. Positive direction increases upward. Unit must be specified. 
     1198                    [0..1] Translation along the vertical gravitational direction. 
     1199                    <indexterm><primary>element</primary><secondary>y</secondary></indexterm>  
     1200                    Positive direction increases upward. Unit must be specified. 
    10471201                </para></glossdef> 
    10481202            </glossentry> 
     
    10501204                <glossterm><code>position/cs:z</code></glossterm> 
    10511205                <glossdef><para> 
    1052                     [0..1] Translation along the beam direction. Positive direction increases from source towards detector. Unit must be specified. 
     1206                    [0..1] Translation along the beam direction.  
     1207                    <indexterm><primary>element</primary><secondary>z</secondary></indexterm> 
     1208                    Positive direction increases from source towards detector. Unit must be specified. 
    10531209                </para></glossdef> 
    10541210            </glossentry> 
     
    10561212                <glossterm><code>roll, pitch, yaw</code></glossterm> 
    10571213                <glossdef><para> 
    1058                     Coordinates for (roll, pitch, yaw) values representing an orientation or rotation. Unit must be specified for each. 
     1214                    Coordinates for (roll, pitch, yaw) values representing an orientation or rotation.  
     1215                    Unit must be specified for each. 
    10591216                </para></glossdef> 
    10601217            </glossentry> 
  • 1dwg/trunk/doc/src/intensity-problem.xml

    r142 r147  
    5454    <para> A second problem is that when arbitrary units are used, then the set of possible 
    5555        analytical results is restricted (such as no meaningful volume fraction or number 
    56         density can be determined directly from I(Q)). </para> 
     56        density can be determined directly from I(Q)).<indexterm><primary>I(Q)</primary></indexterm>  
     57    </para> 
    5758</appendix> 
  • 1dwg/trunk/doc/src/manual.xml

    r142 r147  
    4949    </info> 
    5050 
    51         <!-- 
    52         Here is an example of how to construct a cross-reference from NeXus 
    53         <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="#NXgeometrySection">NXgeometry</link> 
    54         --> 
    55  
    5651        <xi:include href="preface.xml"/> 
    5752    <xi:include href="overview.xml"/> 
  • 1dwg/trunk/doc/src/overview.xml

    r144 r147  
    1616    <section xml:id="cansas1d_documentation-Objective"> 
    1717        <title>Objective</title> 
    18         <para>One of the first aims of the <emphasis role="bold">canSAS</emphasis> 
     18        <para>One of the first aims 
     19            <indexterm><primary>canSAS</primary><secondary>objective</secondary></indexterm> 
     20            <indexterm><primary>canSAS</primary><secondary>aims</secondary></indexterm> 
     21            of the <emphasis role="bold">canSAS</emphasis> 
    1922            <indexterm><primary>canSAS</primary></indexterm> 
    2023            (Collective Action for Nomadic Small-Angle Scatterers)  
     
    2629            identified that a significant need within the SAS 
    2730            community can be satisfied by a robust, self-describing, text-based, standard format to 
    28             communicate reduced one-dimensional small-angle scattering data, <literal>I(Q)</literal>, between users 
     31            communicate reduced one-dimensional small-angle scattering data,  
     32            <literal>I(Q)</literal>,<indexterm><primary>I(Q)</primary></indexterm>  
     33            between users 
    2934            of our facilities. Our goal has been to define such a format that leaves the data file 
    3035            instantly human-readable, editable in the simplest of editors, and importable by simple 
    3136            text import filters in programs that need not recognise advanced structure in the file 
    3237            nor require advanced programming interfaces. The file should contain both the primary 
    33             data of <literal>I(Q)</literal> and also any other descriptive information (metadata) about the sample, 
    34             measurement, instrument, processing, or analysis steps. </para> 
     38            data of <literal>I(Q)</literal><indexterm><primary>I(Q)</primary></indexterm>  
     39            and also any other descriptive information (metadata)  
     40            <indexterm significance="preferred"><primary>metadata</primary></indexterm> 
     41            about the sample, measurement, instrument, processing, or analysis steps. </para> 
    3542        <para>The cansas1d/1.0 
    3643            <indexterm><primary>cansas1d/1.0 standard</primary></indexterm>  
     44            <indexterm><primary>canSAS</primary><secondary>objective</secondary></indexterm> 
    3745            standard meets the objectives for a 1D standard, incorporating 
    38             metadata about the measurement, parameters and results of processing or analysis steps. 
     46            metadata 
     47            <indexterm><primary>metadata</primary></indexterm> 
     48            about the measurement, parameters and results of processing or analysis steps. 
    3949            Even multiple measurements (related or unrelated) may be included within a single XML 
    4050            file. </para> 
     
    5464        <para>The canSAS 1-D standard for reduced 1-D SAS data is implemented using XML files. A 
    5565            single file can contain SAS data from a single experiment or multiple experiments. All 
    56             types of relevant data (<literal>I(Q)</literal>, metadata)  
    57             are described for each experiment. More 
    58             details are provided below.</para> 
     66            types of relevant data (<literal>I(Q)</literal><indexterm><primary>I(Q)</primary></indexterm>, 
     67            metadata)  
     68            <indexterm><primary>metadata</primary></indexterm> 
     69            are described for each experiment. More details are provided below.</para> 
    5970        <section xml:id="cansas1d_documentation-XMLLayout-Overview"> 
    6071            <title>Overview</title> 
     
    159170                                    <link xlink:href="#cansas1d_documentation-element-SASroot" 
    160171                                        ><literal>SASroot</literal></link> 
     172                                    <indexterm><primary>element</primary><secondary>SASroot</secondary></indexterm>  
    161173                                </entry> 
    162174                                <entry>root element of XML file</entry> 
     
    166178                                    <link xlink:href="#cansas1d_documentation-element-SASentry" 
    167179                                        ><literal>&#160;SASentry</literal></link> 
     180                                    <indexterm><primary>element</primary><secondary>SASentry</secondary></indexterm>  
    168181                                </entry> 
    169182                                <entry>data set, time-slice, step in a series, new sample, 
     
    173186                                <entry> 
    174187                                    <literal>&#160;&#160;Title</literal> 
     188                                <indexterm><primary>element</primary><secondary>Title</secondary></indexterm> 
    175189                                </entry> 
    176190                                <entry>for this particular <literal>SASentry</literal></entry> 
     
    179193                                <entry> 
    180194                                    <literal>&#160;&#160;Run</literal> 
     195                                    <indexterm><primary>element</primary><secondary>Run</secondary></indexterm> 
    181196                                </entry> 
    182197                                <entry>run number or ID number of experiment</entry> 
     
    186201                                    <link xlink:href="#cansas1d_documentation-element-any" 
    187202                                        ><literal>&#160;&#160;{any}</literal></link> 
     203                                    <indexterm><primary>element</primary><secondary>&lt;any&gt;</secondary></indexterm> 
    188204                                </entry> 
    189205                                <entry>any <literal>cansas1d/1.0</literal> element can be used at this 
     
    194210                                    <link xlink:href="#cansas1d_documentation-element-SASdata" 
    195211                                        ><literal>&#160;&#160;SASdata</literal></link> 
     212                                    <indexterm><primary>element</primary><secondary>SASdata</secondary></indexterm> 
    196213                                </entry> 
    197214                                <entry>this is where the reduced 1-D SAS data is stored</entry> 
     
    200217                                <entry> 
    201218                                    <literal>&#160;&#160;&#160;Idata</literal> 
     219                                    <indexterm><primary>element</primary><secondary>Idata</secondary></indexterm> 
    202220                                </entry> 
    203221                                <entry>a single data point in the dataset</entry> 
     
    207225                                    <link xlink:href="#cansas1d_documentation-element-any" 
    208226                                        ><literal>&#160;&#160;{any}</literal></link> 
     227                                    <indexterm><primary>element</primary><secondary>&lt;any&gt;</secondary></indexterm> 
    209228                                </entry> 
    210229                                <entry>any cansas1d/1.0 element can be used at this 
     
    215234                                    <link xlink:href="#cansas1d_documentation-element-SASsample" 
    216235                                        ><literal>&#160;&#160;SASsample</literal></link> 
     236                                    <indexterm><primary>element</primary><secondary>SASsample</secondary></indexterm> 
    217237                                </entry> 
    218238                                <entry>description of the sample</entry> 
     
    222242                                    <link xlink:href="#cansas1d_documentation-element-SASinstrument" 
    223243                                        ><literal>&#160;&#160;SASinstrument</literal></link> 
     244                                    <indexterm><primary>element</primary><secondary>SASinstrument</secondary></indexterm> 
    224245                                </entry> 
    225246                                <entry>description of the instrument</entry> 
     
    229250                                    <link xlink:href="#cansas1d_documentation-element-SASsource" 
    230251                                        ><literal>&#160;&#160;&#160;SASsource</literal></link> 
     252                                    <indexterm><primary>element</primary><secondary>SASsource</secondary></indexterm> 
    231253                                </entry> 
    232254                                <entry>description of the source</entry> 
     
    236258                                    <link xlink:href="#cansas1d_documentation-element-SAScollimation" 
    237259                                        ><literal>&#160;&#160;&#160;SAScollimation</literal></link> 
     260                                    <indexterm><primary>element</primary><secondary>SAScollimation</secondary></indexterm> 
    238261                                </entry> 
    239262                                <entry>description of the collimation</entry> 
     
    243266                                    <link xlink:href="#cansas1d_documentation-element-SASdetector" 
    244267                                        ><literal>&#160;&#160;&#160;SASdetector</literal></link> 
     268                                    <indexterm><primary>element</primary><secondary>SASdetector</secondary></indexterm> 
    245269                                </entry> 
    246270                                <entry>description of the detector</entry> 
     
    250274                                    <link xlink:href="#cansas1d_documentation-element-SASprocess" 
    251275                                        ><literal>&#160;&#160;SASprocess</literal></link> 
     276                                    <indexterm><primary>element</primary><secondary>SASprocess</secondary></indexterm> 
    252277                                </entry> 
    253278                                <entry>for each processing or analysis step</entry> 
     
    257282                                    <link xlink:href="#cansas1d_documentation-element-SASnote" 
    258283                                        ><literal>&#160;&#160;SASnote</literal></link> 
     284                                    <indexterm><primary>element</primary><secondary>SASnote</secondary></indexterm> 
    259285                                </entry> 
    260286                                <entry>anything at all</entry> 
     
    291317                        </mathphrase> 
    292318                    </inlineequation> 
     319                    <indexterm> 
     320                        <primary>Q</primary> 
     321                    </indexterm> 
    293322                </para> 
    294323                <para> 
     
    428457            <listitem> 
    429458                <para>orientation (angles) describes one-axis rotations (rotations about 
    430                     multiple axes require more information): </para> 
     459                    multiple axes require more information):  
     460                    <indexterm> 
     461                        <primary>geometry</primary> 
     462                        <secondary>orientation (rotation)</secondary> 
     463                    </indexterm> 
     464                </para> 
    431465                <orderedlist numeration="loweralpha"> 
    432466                    <listitem> 
     
    442476            </listitem> 
    443477            <listitem> 
    444                 <para> Unicode characters MUST NOT be used</para> 
    445                 <!--<note><para>Perhaps this could be relaxed in v1.1?</para></note>--> 
     478                <para>  
     479                    Unicode characters MUST NOT be used 
     480                    <note> 
     481                        <para>Can UNICODE characters be permitted in v1.1 standard?</para> 
     482                    </note> 
     483                </para> 
    446484            </listitem> 
    447485            <listitem> 
     
    454492    <section xml:id="cansas1d_documentation-geometry_compatibility"> 
    455493        <title>Compatibility of Geometry Definitions</title> 
    456         <para> Note: translation and orientation geometry used by canSAS are consistent with: </para> 
     494        <para> 
     495            Note: translation and orientation geometry used by canSAS are consistent with:  
     496            <indexterm> 
     497                <primary>geometry</primary> 
     498                <secondary>compatibility with other standards</secondary> 
     499            </indexterm> 
     500        </para> 
    457501        <itemizedlist> 
    458502            <listitem> 
     
    465509            </listitem> 
    466510            <listitem> 
    467                 <para>NeXus: <link xlink:href="http://www.nexusformat.org/Coordinate_Systems" 
     511                <para>NeXus: 
     512                    <indexterm><primary>NeXus</primary></indexterm> 
     513                    <link xlink:href="http://www.nexusformat.org/Coordinate_Systems" 
    468514                    ><literal>http://www.nexusformat.org/Coordinate_Systems</literal></link></para> 
    469515            </listitem> 
     
    508554            format. This form will help you in creating an XML file with all the required 
    509555            elements in the correct places. The form requests the SAS data of Q, I, and Idev 
    510             (defined elsewhere on this page) and some basic metadata (title, run, sample info, 
    511             ...). </para> 
     556            (defined elsewhere on this page) and some basic metadata  
     557            <indexterm><primary>metadata</primary></indexterm> 
     558            (title, run, sample info, ...). </para> 
    512559        <para>Press the <code>Submit</code> button and you will receive a nicely 
    513560            formatted WWW page with the SAS data. If you then choose <emphasis>View page source</emphasis> 
     
    559606                    <primary>XML Stylesheet</primary> 
    560607                </indexterm> 
    561                 can be used to extract metadata or to convert into another file format. The 
     608                can be used to extract metadata  
     609                <indexterm><primary>metadata</primary></indexterm> 
     610                or to convert into another file format. The 
    562611                default canSAS stylesheet <literal>cansasxml-html.xsl</literal><footnote> 
    563612                    <para> 
     
    579628                <literal>cansasxml-html.xsl</literal> (see above) 
    580629                stylesheet in the same directory will produce a 
    581                 WWW page with the SAS data and selected metadata.</para> 
     630                WWW page with the SAS data and selected metadata. 
     631                <indexterm><primary>metadata</primary></indexterm> 
     632            </para> 
    582633        </section> 
    583634        <section xml:id="cansas1d_documentation-programming_suggestions"> 
     
    797848                                >http://svn.smallangles.net/trac/canSAS/browser/1dwg/data/Glassy%20Carbon/ISIS/GLASSYC_C4G8G9_withTL.xml</literal></link></para> 
    798849                </footnote> 
    799                 This example uses a foreign namespace to record the transmission spectra related to 
     850                This example uses a foreign namespace to record the transmission spectrum related to 
    800851                the acquisition of the SANS data at a time-of-flight facility. Look near line 153 
    801                 for the element om the next example.  
     852                for this element:  
    802853                <informalexample> 
    803854                    <programlisting>&lt;transmission_spectrum xmlns="urn:transmission:spectrum"></programlisting> 
  • 1dwg/trunk/doc/src/preface.xml

    r144 r147  
    3535    </para> 
    3636    <para> 
    37         The aims of the canSAS meetings are to promote and simplify sharing SAS data  
    38         analysis methods. Non-specialists will benefit from easily applicable methods  
     37        The aims 
     38        <indexterm significance="preferred"><primary>canSAS</primary><secondary>aims</secondary></indexterm> 
     39        of the canSAS meetings are to promote and simplify sharing SAS data  
     40        analysis methods. Non-specialists will benefit 
     41        <indexterm><primary>canSAS</primary><secondary>benefit</secondary></indexterm> 
     42        from easily applicable methods  
    3943        for exchanging and merging of data from different synchrotron, laboratory  
    4044        and neutron facilities. 
  • 1dwg/trunk/doc/src/specification.xml

    r142 r147  
    2525        Note that the cansas1d/1.0 XML data files must adhere to the  
    2626        XML rules which includes being well-formed 
    27         <indexterm><primary>XML</primary><secondary>well-formed</secondary></indexterm> 
     27        <indexterm significance="preferred"><primary>XML</primary><secondary>well-formed</secondary></indexterm> 
    2828        (including the use of closing tags).   
    2929        <footnote> 
     
    6363        Another example is an instance of the  
    6464        <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  
     65        element.  Suppose one had analysis data, then <literal>{any}</literal> 
     66        <indexterm> 
     67            <primary>element</primary> 
     68            <secondary>&lt;any&gt;</secondary> 
     69        </indexterm> 
     70        would be replaced  
    6671        with <literal>analysis</literal> and the element might look like this: 
    6772        <informalexample> 
     
    7378    </para> 
    7479 
    75  
    7680    <xi:include href="elements.xml"/> 
    7781</chapter> 
  • 1dwg/trunk/doc/src/xml-help.xml

    r142 r147  
    1414    <title>XML Help</title> 
    1515    <para>Listed below are various references useful in learning XML and related topics.</para> 
     16    <indexterm> 
     17        <primary>XML</primary> 
     18    </indexterm> 
    1619    <itemizedlist mark="opencircle"> 
    1720        <listitem> 
     
    5457        <listitem> 
    5558            <para><emphasis role="bold">XPath</emphasis>: XPath is a language for finding information 
    56                 in an XML document. <itemizedlist> 
     59                in an XML document.  
     60                <indexterm> 
     61                    <primary>XPath</primary> 
     62                </indexterm> 
     63                <itemizedlist> 
    5764                    <listitem> 
    5865                        <para>http://www.w3schools.com/xpath/</para> 
     
    6875        <listitem> 
    6976            <para><emphasis role="bold">Schema</emphasis>: An XML Schema describes the structure of 
    70                 an XML document. <itemizedlist> 
     77                an XML document. 
     78                <indexterm> 
     79                    <primary>XML Schema</primary> 
     80                </indexterm> 
     81                <itemizedlist> 
    7182                    <listitem> 
    7283                        <para>http://www.w3schools.com/schema/</para> 
     
    8293        <listitem> 
    8394            <para><emphasis role="bold">XML Namespaces</emphasis>: XML namespaces are used for 
    84                 providing uniquely named elements and attributes in an XML instance. <itemizedlist> 
     95                providing uniquely named elements and attributes in an XML instance. 
     96                <indexterm> 
     97                    <primary>XML Namespace</primary> 
     98                </indexterm> 
     99                <indexterm> 
     100                    <primary>namespace</primary> 
     101                    <see>XML Namespace</see> 
     102                </indexterm> 
     103                <itemizedlist> 
    85104                    <listitem> 
    86105                        <para>http://www.zvon.org/xxl/NamespaceTutorial/Output</para> 
Note: See TracChangeset for help on using the changeset viewer.