Changeset 138


Ignore:
Timestamp:
Oct 8, 2009 6:15:40 PM (10 years ago)
Author:
prjemian
Message:

more cross-references, formatting, & indices, refs #19

Location:
1dwg/trunk/doc/src
Files:
16 edited

Legend:

Unmodified
Added
Removed
  • 1dwg/trunk/doc/src/ascii3col.xsl

    r137 r138  
    55xmlns:cs="cansas1d/1.0" 
    66xsi:schemaLocation="cansas1d/1.0 http://svn.smallangles.net/svn/canSAS/1dwg/trunk/cansas1d.xsd"> 
     7 
    78<xsl:template match="/"> 
    8  
    99<html> 
    10 <head> 
    11    <title>ASCII 3-column SAS data</title> 
    12 </head> 
    13  
    14 <body> 
    15 <center> 
    16  
    17 <table border = "1" cellpadding="4" cellspacing="2"> 
    18  
     10<table> 
     11<xsl:for-each select="cs:SASroot/cs:SASentry/cs:SASdata/cs:Idata"> 
    1912<tr> 
    20         <th>Q  <xsl:value-of select="/cs:SASroot/cs:SASentry/cs:SASdata/cs:Idata/cs:Q/@unit"/></th> 
    21         <th>I <xsl:value-of select="/cs:SASroot/cs:SASentry/cs:SASdata/cs:Idata/cs:I/@unit"/></th> 
    22         <th>Idev <xsl:value-of select="/cs:SASroot/cs:SASentry/cs:SASdata/cs:Idata/cs:Idev/@unit"/></th> 
    23  </tr> 
    24  
    25 <xsl:for-each select="cs:SASroot/cs:SASentry/cs:SASdata/cs:Idata"> 
    26  
    27  <tr> 
    28         <td><xsl:value-of select="cs:Q"/> </td> 
    29         <td><xsl:value-of select="cs:I"/></td> 
    30         <td><xsl:value-of select="cs:Idev"/></td> 
    31  </tr> 
     13<td><xsl:value-of select="cs:Q"/></td> 
     14<td><xsl:value-of select="cs:I"/></td> 
     15<td><xsl:value-of select="cs:Idev"/></td> 
     16</tr> 
    3217</xsl:for-each> 
    3318</table> 
    34 <h6 align="left"> 
    35 <hr/> 
    36 <font face="Tahoma"> 
    37 Using Stylesheet:  ascii3col.xsl 
    38 </font></h6> 
    39 </center> 
    40 </body> 
    4119</html> 
    4220</xsl:template> 
  • 1dwg/trunk/doc/src/cansas1d_binding_IgorPro.xml

    r136 r138  
    113113            </para> 
    114114            <para> In the future, to retrieve an updated version of this support, go into the 
    115                 XMLutils directory (created above) and type the command 
     115                XMLutils directory (created above) and type the command: 
    116116                <programlisting>svn update</programlisting> (or just 
    117                 <programlisting>svn up</programlisting>). 
     117                <programlisting>svn up</programlisting> 
    118118                This will check the repository and 
    119                 update files as needed. 
     119                update local files as needed. 
    120120                If the installer program was updated, you'll need to run the 
    121121                new installer program. It is not necessary to uninstall first. </para> 
  • 1dwg/trunk/doc/src/cansas1d_casestudy_collagen.xml

    r128 r138  
    81816531 eV, X6B</programlisting> 
    8282        </para> 
    83         <para> But, the data can fulfill the minimum requirements of the 1D standard file formatand 
    84             also make an excellent example of a minimalcanSAS reduced 1-D SAS data file in XML. 
     83        <para> But, the data can fulfill the minimum requirements of the 1D standard file format and 
     84            also make an excellent example of a minimal canSAS reduced 1-D SAS data file in XML. 
    8585        </para> 
    8686    </section> 
     
    8989        <section> 
    9090            <title>make the basic XML file</title> 
    91             <para> It is easiest to copy a template rather than start from an empty file.Copy the 
     91            <para> It is easiest to copy a template rather than start from an empty file. Copy the 
    9292                    <link xlink:href="http://svn.smallangles.net/svn/canSAS/1dwg/trunk/cansas1d.xml"> 
    9393                    <citetitle>cansas1d.xml</citetitle> 
     
    9898            <title>modify collagen.xml</title> 
    9999            <para> It is easier to see the metadata in the XML file before you enter the SAXS data 
    100                 into the file. With the brief metadata available, most lines can be eliminated.This 
     100                into the file. With the brief metadata available, most lines can be eliminated. This 
    101101                will result in a file that looks like </para> 
    102102            <programlisting>&lt;?xml version="1.0"?> 
     
    143143        <section> 
    144144            <title>prepare the SAXS data</title> 
    145             <para> Microsoft Excel is used here to convert the table of SAXS data into therequired 
     145            <para> Microsoft Excel is used here to convert the table of SAXS data into the required 
    146146                lines of XML for the standard. Some may prefer to use a cell formula but here, we 
    147147                develop a bit of Excel Macro code to clarify our procedure. </para> 
     
    192192            <section> 
    193193                <title>construct the Idata lines in XML</title> 
    194                 <para> move to spreadsheet cell <emphasis role="bold">E5</emphasis> and enter this 
     194                <para> move to spreadsheet cell <literal>E5</literal> and enter this 
    195195                    formula <programlisting>=IDATA_tag(A5,$A$4,B5,$B$4,C5,$C$4)</programlisting> 
    196196                </para> 
    197197                <para> Copy it down all rows in column <emphasis role="bold">E</emphasis> through 
    198                     cell <emphasis role="bold">E335</emphasis> 
     198                    cell <literal>E335</literal> 
    199199                </para> 
    200                 <para> Select cells E5:E335 and copy to clipboard, then paste into <emphasis 
    201                         role="bold">collagen.xml</emphasis> document inside the <emphasis 
    202                         role="bold">SASdata</emphasis> element where you see the XML comment . 
     200                <para> Select cells E5:E335 and copy to clipboard, then paste into  
     201                    <literal>collagen.xml</literal> document inside the  
     202                    <literal>SASdata</literal> element where you see the XML comment. 
    203203                </para> 
    204204            </section> 
  • 1dwg/trunk/doc/src/cansas1d_element_SAScollimation.xml

    r131 r138  
    7575                            Amount/length of collimation inserted (on a SANS instrument) 
    7676                        </entry> 
    77                         <entry> 
    78                             <para> 
    79                                 <emphasis role="bold"><emphasis>unit</emphasis></emphasis>={unit} 
    80                             </para> 
    81                         </entry> 
    82                     </row> 
    83                     <row> 
    84                         <entry> 
    85                             '''''aperture''''' 
     77                        <entry><para><literal> unit={unit} </literal></para></entry> 
     78                    </row> 
     79                    <row> 
     80                        <entry> 
     81                            <literal>aperture</literal> 
    8682                        </entry> 
    8783                        <entry> 
     
    9591                            <emphasis role="bold"><emphasis>name</emphasis></emphasis>: Optional name attribute for this aperture.  <emphasis role="bold"><emphasis>type</emphasis></emphasis>: Optional text attribute to describe the type aperture (pinhole, 4-blade slit, Soller slit, ...). 
    9692                        </entry> 
    97                         <entry> 
    98                             <para> 
    99                                 <emphasis role="bold"><emphasis>name</emphasis></emphasis>={name}  <emphasis role="bold"><emphasis>type</emphasis></emphasis>={type} 
    100                             </para> 
    101                         </entry> 
     93                        <entry><para><literal> name={type} </literal></para></entry> 
    10294                    </row> 
    10395                </tbody> 
     
    125117                    <row> 
    126118                        <entry> 
    127                             '''''size''''' 
     119                            <literal>size</literal> 
    128120                        </entry> 
    129121                        <entry> 
     
    136128                            Opening dimensions of this aperture. 
    137129                        </entry> 
    138                         <entry> 
    139                             <para> 
    140                                 <emphasis role="bold"><emphasis>name</emphasis></emphasis>={name} 
    141                             </para> 
    142                         </entry> 
    143                     </row> 
    144                     <row> 
    145                         <entry> 
    146                             <para> 
    147                                 <emphasis role="bold"><emphasis>distance</emphasis></emphasis> 
    148                             </para> 
    149                         </entry> 
     130                        <entry><para><literal> name={name} </literal></para></entry> 
     131                    </row> 
     132                    <row> 
     133                        <entry><para><literal> distance </literal></para></entry> 
    150134                        <entry> 
    151135                            floating-point number 
     
    157141                            Distance from this collimation element to the sample. 
    158142                        </entry> 
    159                         <entry> 
    160                             <para> 
    161                                 <emphasis role="bold"><emphasis>unit</emphasis></emphasis>={unit} 
    162                             </para> 
    163                         </entry> 
     143                        <entry><para><literal> unit={unit} </literal></para></entry> 
    164144                    </row> 
    165145                </tbody> 
     
    224204                        </row> 
    225205                        <row> 
    226                             <entry> 
    227                                 <emphasis role="bold">x</emphasis> 
    228                             </entry> 
     206                            <entry><para><literal> x </literal></para></entry> 
    229207                            <entry> 
    230208                                floating-point number 
     
    236214                                Dimension of the collimation in X. The <emphasis role="bold">unit</emphasis> attribute is required. See cansas1d_documentation#Rules for acceptable values. 
    237215                            </entry> 
    238                             <entry> 
    239                                 <emphasis role="bold">unit</emphasis>={units} 
    240                             </entry> 
    241                         </row> 
    242                         <row> 
    243                             <entry> 
    244                                 <emphasis role="bold">y</emphasis> 
    245                             </entry> 
     216                            <entry><para><literal> unit={unit} </literal></para></entry> 
     217                        </row> 
     218                        <row> 
     219                            <entry><para><literal> y </literal></para></entry> 
    246220                            <entry> 
    247221                                floating-point number 
     
    253227                                Dimension of the collimation in Y. The <emphasis role="bold">unit</emphasis> attribute is required. See cansas1d_documentation#Rules for acceptable values. 
    254228                            </entry> 
    255                             <entry> 
    256                                 <emphasis role="bold">unit</emphasis>={units} 
    257                             </entry> 
    258                         </row> 
    259                         <row> 
    260                             <entry> 
    261                                 <emphasis role="bold">z</emphasis> 
    262                             </entry> 
     229                            <entry><para><literal> unit={unit} </literal></para></entry> 
     230                        </row> 
     231                        <row> 
     232                            <entry><para><literal> z </literal></para></entry> 
    263233                            <entry> 
    264234                                floating-point number 
     
    270240                                Dimension of the collimation in Z. The <emphasis role="bold">unit</emphasis> attribute is required. See cansas1d_documentation#Rules for acceptable values. Note: While Z dimension is allowed by the standard (provided by use of a standard element in the XML Schema), it does not make sense for small-angle scattering. 
    271241                            </entry> 
    272                             <entry> 
    273                                 <emphasis role="bold">unit</emphasis>={units} 
    274                             </entry> 
     242                            <entry><para><literal> unit={unit} </literal></para></entry> 
    275243                        </row> 
    276244                    </tbody> 
  • 1dwg/trunk/doc/src/cansas1d_element_SASdata.xml

    r131 r138  
    125125                                </inlineequation> 
    126126                                is the angle through which the 
    127                                 detected radiation has been scattered. The <emphasis role="bold" 
    128                                     >unit</emphasis> attribute is required. See <link 
     127                                detected radiation has been scattered.  
     128                                The <literal>unit</literal> attribute is required. See <link 
    129129                                    xlink:href="#cansas1d_documentation-rules">rules for 
    130130                                    units</link> 
    131131                                for acceptable values. Either 
    132                                     <emphasis>1/A</emphasis> or <emphasis>1/nm</emphasis> are 
     132                                <literal>1/A</literal> or <literal>1/nm</literal> are 
    133133                                typical. </para> 
    134134                        </entry> 
    135                         <entry> 
    136                             <para> 
    137                                 <emphasis role="bold">unit</emphasis>={units} </para> 
    138                         </entry> 
     135                        <entry><para><literal> unit={unit} </literal></para></entry> 
    139136                    </row> 
    140137                    <row> 
     
    147144                        <entry> [1..1] </entry> 
    148145                        <entry> 
    149                             <para> Intensity of the detected radiation. The <emphasis role="bold" 
    150                                     >unit</emphasis> attribute is required. See 
     146                            <para> Intensity of the detected radiation. The <literal>unit</literal>  
     147                                attribute is required. See 
    151148                                cansas1d_documentation#Rules for acceptable values. One possibility 
    152                                 might be<emphasis>1/cm</emphasis> for absolute units when the 
     149                                might be <literal>1/cm</literal> for absolute units when the 
    153150                                intensity describes a <emphasis>differential cross-section per unit 
    154151                                    volume per unit solid angle</emphasis>. </para> 
     
    157154                                    <link xlink:href="#the_intensity_problem-rules"><emphasis 
    158155                                        role="italic">The Intensity Problem</emphasis></link>). One 
    159                                 should be very careful to inspect the <emphasis role="bold" 
    160                                     >unit</emphasis> attribute to determine how to handle subsequent 
     156                                should be very careful to inspect the  
     157                                <literal>unit</literal> attribute to determine how to handle subsequent 
    161158                                data processing, especially in the area of units conversion. </para> 
    162159                        </entry> 
    163                         <entry> 
    164                             <para> 
    165                                 <emphasis role="bold">unit</emphasis>={units} </para> 
    166                         </entry> 
     160                        <entry><para><literal> unit={unit} </literal></para></entry> 
    167161                    </row> 
    168162                    <row> 
     
    174168                        <entry> floating-point number </entry> 
    175169                        <entry> [0..1] </entry> 
    176                         <entry> Estimated standard deviation of <emphasis role="bold">I</emphasis>. 
    177                             The <emphasis role="bold">unit</emphasis> attribute is required. See 
     170                        <entry> Estimated standard deviation of <literal>I</literal>. 
     171                            The <literal>unit</literal> attribute is required. See 
    178172                                <link xlink:href="#cansas1d_documentation-rules">rules for 
    179173                                units</link> 
    180174                            <!--cansas1d_documentation#Rules --> for acceptable values. One 
    181                             possibility might be <emphasis>1/cm</emphasis>. </entry> 
    182                         <entry> 
    183                             <para> 
    184                                 <emphasis role="bold">unit</emphasis>={units} </para> 
    185                         </entry> 
     175                            possibility might be <literal>1/cm</literal>. </entry> 
     176                        <entry><para><literal> unit={unit} </literal></para></entry> 
    186177                    </row> 
    187178                    <row> 
     
    193184                        <entry> floating-point number </entry> 
    194185                        <entry> [0..1] </entry> 
    195                         <entry> Estimated standard deviation of <emphasis role="bold">Q</emphasis>. 
    196                             (optional: see note below on usage)The <emphasis role="bold" 
    197                                 >unit</emphasis> attribute is required. See <link 
     186                        <entry> Estimated standard deviation of <literal>Q</literal>. 
     187                            (optional: see note below on usage) 
     188                            The <literal>unit</literal>  
     189                                attribute is required. See <link 
    198190                                xlink:href="#cansas1d_documentation-rules">rules for units</link> 
    199191                            <!--cansas1d_documentation#Rules --> for acceptable values. Either 
    200                                 <emphasis>1/A</emphasis> or <emphasis>1/nm</emphasis> are typical. </entry> 
    201                         <entry> 
    202                             <para> 
    203                                 <emphasis role="bold">unit</emphasis>={units} </para> 
    204                         </entry> 
     192                            <literal>1/A</literal> or <literal>1/nm</literal> are typical. </entry> 
     193                        <entry><para><literal> unit={unit} </literal></para></entry> 
    205194                    </row> 
    206195                    <row> 
     
    214203                        <entry> 
    215204                            <para> 
    216                                 <emphasis role="bold">Q</emphasis> resolution along the axis of 
    217                                 scanning (the high-resolution <emphasis>slit width</emphasis> 
     205                                <literal>Q</literal> resolution along the axis of 
     206                                scanning (the high-resolution <literal>slit width</literal> 
    218207                                direction). Useful for defining resolution data from slit-smearing 
    219208                                instruments such as Bonse-Hart geometry. (optional: see note below 
    220209                                on usage).</para> 
    221                             <para> The <emphasis role="bold">unit</emphasis> attribute is required. 
     210                            <para> The <literal>unit</literal> attribute is required. 
    222211                                See <link xlink:href="#cansas1d_documentation-rules">rules for 
    223212                                    units</link> 
    224213                                <!--cansas1d_documentation#Rules --> for acceptable values. Either 
    225                                     <emphasis>1/A</emphasis> or <emphasis>1/nm</emphasis> are 
     214                                <literal>1/A</literal> or <literal>1/nm</literal> are 
    226215                                typical. </para> 
    227216                        </entry> 
    228                         <entry> 
    229                             <para> 
    230                                 <emphasis role="bold">unit</emphasis>={units} </para> 
    231                         </entry> 
     217                        <entry><para><literal> unit={unit} </literal></para></entry> 
    232218                    </row> 
    233219                    <row> 
     
    241227                        <entry> 
    242228                            <para> 
    243                                 <emphasis role="bold">Q</emphasis> resolution perpendicular to the 
     229                                <literal>Q</literal> resolution perpendicular to the 
    244230                                axis of scanning (the low-resolution <emphasis>slit 
    245231                                    length</emphasis> direction). Useful for defining resolution 
    246232                                data from slit-smearing instruments such as Bonse-Hart geometry. 
    247                                 (optional: see note below on usage)The <emphasis role="bold" 
    248                                     >unit</emphasis> attribute is required. See <link 
     233                                (optional: see note below on usage) 
     234                                The <literal>unit</literal> attribute is required. See <link 
    249235                                    xlink:href="#cansas1d_documentation-rules">rules for 
    250236                                    units</link> 
    251237                                <!--cansas1d_documentation#Rules --> for acceptable values. Either 
    252                                     <emphasis>1/A</emphasis> or <emphasis>1/nm</emphasis> are 
     238                                <literal>1/A</literal> or <literal>1/nm</literal> are 
    253239                                typical. </para> 
    254240                        </entry> 
    255                         <entry> 
    256                             <para> 
    257                                 <emphasis role="bold">unit</emphasis>={units} </para> 
    258                         </entry> 
     241                        <entry><para><literal> unit={unit} </literal></para></entry> 
    259242                    </row> 
    260243                    <row> 
     
    266249                        <entry> floating-point number </entry> 
    267250                        <entry> [0..1] </entry> 
    268                         <entry> Mean value of <emphasis role="bold">Q</emphasis> for this datum. 
     251                        <entry> Mean value of <literal>Q</literal> for this datum. 
    269252                            Useful when describing data that has been binned from higher-resolution 
    270                             or from area detectors.The <emphasis role="bold">unit</emphasis> 
     253                            or from area detectors.The <literal>unit</literal> 
    271254                            attribute is required. See <link 
    272255                                xlink:href="#cansas1d_documentation-rules">rules for units</link> 
    273256                            <!--cansas1d_documentation#Rules --> for acceptable values. Either 
    274                                 <emphasis>1/A</emphasis> or <emphasis>1/nm</emphasis> are typical. </entry> 
    275                         <entry> 
    276                             <para> 
    277                                 <emphasis role="bold">unit</emphasis>={units} </para> 
    278                         </entry> 
     257                            <literal>1/A</literal> or <literal>1/nm</literal> are typical. </entry> 
     258                        <entry><para><literal> unit={unit} </literal></para></entry> 
    279259                    </row> 
    280260                    <row> 
     
    309289                        <entry> 
    310290                            <para> 
    311                                 <emphasis role="bold" 
    312                                     ><emphasis 
    313                                         >xmlns:{foreign-prefix}</emphasis></emphasis> 
    314                                 =<link 
     291                                <link 
    315292                                    xlink:href="#cansas1d_documentation-element-any" 
    316                                     ><literal>{foreign-namespace}</literal></link> 
     293                                    ><literal>xmlns:{foreign-prefix}={foreign-namespace}</literal></link> 
    317294                            </para> 
    318295                        </entry> 
     
    326303        <orderedlist numeration="arabic"> 
    327304            <listitem> 
    328                 <para> When an optional element (<emphasis role="bold" 
    329                         ><emphasis>Idev</emphasis></emphasis>, <emphasis role="bold" 
    330                             ><emphasis>Qdev</emphasis></emphasis>, ...) is used, it must be given in 
    331                     every <emphasis role="bold">Idata</emphasis> within the enclosing <emphasis 
    332                         role="bold">SASdata</emphasis>. </para> 
     305                <para> When an optional element (<literal>Idev</literal>, <literal>Qdev</literal>, ...)  
     306                    is used, it must be given in 
     307                    every <literal>Idata</literal> within the enclosing <literal>SASdata</literal>. </para> 
    333308            </listitem> 
    334309            <listitem> 
    335                 <para> If either <emphasis role="bold"><emphasis>dQw</emphasis></emphasis> or 
    336                         <emphasis role="bold"><emphasis>dQl</emphasis></emphasis> are used, then 
    337                         <emphasis role="bold"><emphasis>Qdev</emphasis></emphasis> is not permitted 
     310                <para> If either <literal>dQw</literal> or 
     311                    <literal>dQl</literal> are used, then 
     312                    <literal>Qdev</literal> is not permitted 
    338313                    to be used. </para> 
    339314            </listitem> 
  • 1dwg/trunk/doc/src/cansas1d_element_SASdetector.xml

    r131 r138  
    6060                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Attributes</entry> 
    6161                    </row> 
    62                 <row> 
    63                     <entry> 
    64                         <para> 
    65                             <emphasis role="bold">name</emphasis> 
    66                         </para> 
    67                     </entry> 
    68                     <entry> 
    69                         string 
    70                     </entry> 
    71                     <entry> 
    72                         [1..1] 
    73                     </entry> 
    74                     <entry> 
    75                         Text string that identifies the name of this detector. 
    76                     </entry> 
    77                     <entry> 
    78                     </entry> 
    79                 </row> 
    80                 <row> 
    81                     <entry> 
    82                         <para> 
    83                             <emphasis role="bold"><emphasis>SDD</emphasis></emphasis> 
    84                         </para> 
    85                     </entry> 
    86                     <entry> 
    87                         floating-point number 
    88                     </entry> 
    89                     <entry> 
    90                         [0..1] 
    91                     </entry> 
    92                     <entry> 
    93                         Distance between sample and detector. 
    94                     </entry> 
    95                     <entry> 
    96                         <para> 
    97                             <emphasis role="bold"><emphasis>unit</emphasis></emphasis>={unit} 
    98                         </para> 
    99                     </entry> 
    100                 </row> 
    101                 <row> 
    102                     <entry> 
    103                         '''''offset''''' 
    104                     </entry> 
    105                     <entry> 
    106                         container 
    107                     </entry> 
    108                     <entry> 
    109                         [0..1] 
    110                     </entry> 
    111                     <entry> 
    112                         Offset of this detector position in X, Y, (and Z if necessary). 
    113                     </entry> 
    114                     <entry> 
    115                     </entry> 
    116                 </row> 
    117                 <row> 
    118                     <entry> 
    119                         '''''orientation''''' 
    120                     </entry> 
    121                     <entry> 
    122                         container 
    123                     </entry> 
    124                     <entry> 
    125                         [0..1] 
    126                     </entry> 
    127                     <entry> 
    128                         Orientation (rotation) of this detector in roll, pitch, and yaw. 
    129                     </entry> 
    130                     <entry> 
    131                     </entry> 
    132                 </row> 
    133                 <row> 
    134                     <entry> 
    135                         '''''beam_center''''' 
    136                     </entry> 
    137                     <entry> 
    138                         container 
    139                     </entry> 
    140                     <entry> 
    141                         [0..1] 
    142                     </entry> 
    143                     <entry> 
    144                         Center of the beam on the detector in X and Y (and Z if necessary). 
    145                     </entry> 
    146                     <entry> 
    147                     </entry> 
    148                 </row> 
    149                 <row> 
    150                     <entry> 
    151                         '''''pixel_size''''' 
    152                     </entry> 
    153                     <entry> 
    154                         container 
    155                     </entry> 
    156                     <entry> 
    157                         [0..1] 
    158                     </entry> 
    159                     <entry> 
    160                         Size of detector pixels in X and Y (and Z if necessary). 
    161                     </entry> 
    162                     <entry> 
    163                     </entry> 
    164                 </row> 
    165                 <row> 
    166                     <entry> 
    167                         <para> 
    168                             <emphasis role="bold"><emphasis>slit_length</emphasis></emphasis> 
    169                         </para> 
    170                     </entry> 
    171                     <entry> 
    172                         floating-point number 
    173                     </entry> 
    174                     <entry> 
    175                         [0..1] 
    176                     </entry> 
    177                     <entry> 
    178                         Slit length of the instrument for this detector. This is expressed in the same units as Q (reciprocal space units). 
    179                     </entry> 
    180                     <entry> 
    181                         <para> 
    182                             <emphasis role="bold"><emphasis>unit</emphasis></emphasis>={unit} 
    183                         </para> 
    184                     </entry> 
    185                 </row> 
     62                    <row> 
     63                        <entry><para><literal> name </literal></para></entry> 
     64                        <entry> 
     65                            string 
     66                        </entry> 
     67                        <entry> 
     68                            [1..1] 
     69                        </entry> 
     70                        <entry> 
     71                            Text string that identifies the name of this detector. 
     72                        </entry> 
     73                        <entry/> 
     74                    </row> 
     75                    <row> 
     76                        <entry><para><literal> SDD </literal></para></entry> 
     77                        <entry> 
     78                            floating-point number 
     79                        </entry> 
     80                        <entry> 
     81                            [0..1] 
     82                        </entry> 
     83                        <entry> 
     84                            Distance between sample and detector. 
     85                        </entry> 
     86                        <entry><para><literal> unit={unit} </literal></para></entry> 
     87                    </row> 
     88                    <row> 
     89                        <entry> 
     90                            <literal>offset</literal> 
     91                        </entry> 
     92                        <entry> 
     93                            container 
     94                        </entry> 
     95                        <entry> 
     96                            [0..1] 
     97                        </entry> 
     98                        <entry> 
     99                            Offset of this detector position in X, Y, (and Z if necessary). 
     100                        </entry> 
     101                        <entry/> 
     102                    </row> 
     103                    <row> 
     104                        <entry> 
     105                            <literal>orientation</literal> 
     106                        </entry> 
     107                        <entry> 
     108                            container 
     109                        </entry> 
     110                        <entry> 
     111                            [0..1] 
     112                        </entry> 
     113                        <entry> 
     114                            Orientation (rotation) of this detector in roll, pitch, and yaw. 
     115                        </entry> 
     116                        <entry/> 
     117                    </row> 
     118                    <row> 
     119                        <entry> 
     120                            <literal>beam_center</literal> 
     121                        </entry> 
     122                        <entry> 
     123                            container 
     124                        </entry> 
     125                        <entry> 
     126                            [0..1] 
     127                        </entry> 
     128                        <entry> 
     129                            Center of the beam on the detector in X and Y (and Z if necessary). 
     130                        </entry> 
     131                        <entry/> 
     132                    </row> 
     133                    <row> 
     134                        <entry> 
     135                            <literal>pixel_size</literal> 
     136                        </entry> 
     137                        <entry> 
     138                            container 
     139                        </entry> 
     140                        <entry> 
     141                            [0..1] 
     142                        </entry> 
     143                        <entry> 
     144                            Size of detector pixels in X and Y (and Z if necessary). 
     145                        </entry> 
     146                        <entry/> 
     147                    </row> 
     148                    <row> 
     149                        <entry><para><literal> slit_length </literal></para></entry> 
     150                        <entry> 
     151                            floating-point number 
     152                        </entry> 
     153                        <entry> 
     154                            [0..1] 
     155                        </entry> 
     156                        <entry> 
     157                            Slit length of the instrument for this detector.  
     158                            This is expressed in the same units as Q (reciprocal space units). 
     159                        </entry> 
     160                        <entry><para><literal> unit={unit} </literal></para></entry> 
     161                    </row> 
    186162                </tbody> 
    187163            </tgroup> 
     
    257233                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Attributes</entry> 
    258234                    </row> 
    259                 <row> 
    260                     <entry> 
    261                         <para> 
    262                             <emphasis role="bold">x</emphasis> 
    263                         </para> 
    264                     </entry> 
     235                    <row> 
     236                        <entry><para><literal> x </literal></para></entry> 
    265237                    <entry> 
    266238                        floating-point number 
     
    272244                        Offset of the detector position in X. The <emphasis role="bold">unit</emphasis> attribute is required. See cansas1d_documentation#Rules for acceptable values. 
    273245                    </entry> 
    274                     <entry> 
    275                         <para> 
    276                             <emphasis role="bold">unit</emphasis>={units} 
    277                         </para> 
    278                     </entry> 
    279                 </row> 
    280                 <row> 
    281                     <entry> 
    282                         <para> 
    283                             <emphasis role="bold">y</emphasis> 
    284                         </para> 
    285                     </entry> 
     246                    <entry><para><literal> unit={unit} </literal></para></entry> 
     247                </row> 
     248                    <row> 
     249                        <entry><para><literal> y </literal></para></entry> 
    286250                    <entry> 
    287251                        floating-point number 
     
    293257                        Offset of the detector position in Y. The <emphasis role="bold">unit</emphasis> attribute is required. See cansas1d_documentation#Rules for acceptable values. 
    294258                    </entry> 
    295                     <entry> 
    296                         <para> 
    297                             <emphasis role="bold">unit</emphasis>={units} 
    298                         </para> 
    299                     </entry> 
    300                 </row> 
    301                 <row> 
    302                     <entry> 
    303                         <para> 
    304                             <emphasis role="bold">z</emphasis> 
    305                         </para> 
    306                     </entry> 
     259                    <entry><para><literal> unit={unit} </literal></para></entry> 
     260                </row> 
     261                    <row> 
     262                        <entry><para><literal> z </literal></para></entry> 
    307263                    <entry> 
    308264                        floating-point number 
     
    314270                        Offset of the detector position in Z. The <emphasis role="bold">unit</emphasis> attribute is required. See cansas1d_documentation#Rules for acceptable values. Note: While Z is allowed by the standard (provided by use of a standard element in the XML Schema), it does not make sense for small-angle scattering. 
    315271                    </entry> 
    316                     <entry> 
    317                         <para> 
    318                             <emphasis role="bold">unit</emphasis>={units} 
    319                         </para> 
    320                     </entry> 
     272                    <entry><para><literal> unit={unit} </literal></para></entry> 
    321273                </row> 
    322274                </tbody> 
     
    342294                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Attributes</entry> 
    343295                    </row> 
    344                 <row> 
    345                     <entry> 
    346                         <para> 
    347                             <emphasis role="bold">roll</emphasis> 
    348                         </para> 
    349                     </entry> 
    350                     <entry> 
    351                         floating-point number 
    352                     </entry> 
    353                     <entry> 
    354                         [0..1] 
    355                     </entry> 
    356                     <entry> 
    357                         Rotation about the <emphasis>Z</emphasis> axis (roll). The <emphasis role="bold">unit</emphasis> attribute is required. See cansas1d_documentation#Rules for acceptable values. 
    358                     </entry> 
    359                     <entry> 
    360                         <para> 
    361                             <emphasis role="bold">unit</emphasis>={units} 
    362                         </para> 
    363                     </entry> 
    364                 </row> 
    365                 <row> 
    366                     <entry> 
    367                         <para> 
    368                             <emphasis role="bold">pitch</emphasis> 
    369                         </para> 
    370                     </entry> 
    371                     <entry> 
    372                         floating-point number 
    373                     </entry> 
    374                     <entry> 
    375                         [0..1] 
    376                     </entry> 
    377                     <entry> 
    378                         Rotation about the <emphasis>X</emphasis> axis (pitch). The <emphasis role="bold">unit</emphasis> attribute is required. See cansas1d_documentation#Rules for acceptable values. 
    379                     </entry> 
    380                     <entry> 
    381                         <para> 
    382                             <emphasis role="bold">unit</emphasis>={units} 
    383                         </para> 
    384                     </entry> 
    385                 </row> 
    386                 <row> 
    387                     <entry> 
    388                         <para> 
    389                             <emphasis role="bold">yaw</emphasis> 
    390                         </para> 
    391                     </entry> 
    392                     <entry> 
    393                         floating-point number 
    394                     </entry> 
    395                     <entry> 
    396                         [0..1] 
    397                     </entry> 
    398                     <entry> 
    399                         Rotation about the <emphasis>Y</emphasis> axis (yaw). The <emphasis role="bold">unit</emphasis> attribute is required. See cansas1d_documentation#Rules for acceptable values. 
    400                     </entry> 
    401                     <entry> 
    402                         <para> 
    403                             <emphasis role="bold">unit</emphasis>={units} 
    404                         </para> 
    405                     </entry> 
    406                 </row> 
     296                    <row> 
     297                        <entry><para><literal> roll </literal></para></entry> 
     298                        <entry> 
     299                            floating-point number 
     300                        </entry> 
     301                        <entry> 
     302                            [0..1] 
     303                        </entry> 
     304                        <entry> 
     305                            Rotation about the <emphasis>Z</emphasis> axis (roll). The <emphasis role="bold">unit</emphasis> attribute is required. See cansas1d_documentation#Rules for acceptable values. 
     306                        </entry> 
     307                        <entry><para><literal> unit={unit} </literal></para></entry> 
     308                    </row> 
     309                    <row> 
     310                        <entry><para><literal> pitch </literal></para></entry> 
     311                        <entry> 
     312                            floating-point number 
     313                        </entry> 
     314                        <entry> 
     315                            [0..1] 
     316                        </entry> 
     317                        <entry> 
     318                            Rotation about the <emphasis>X</emphasis> axis (pitch). The <emphasis role="bold">unit</emphasis> attribute is required. See cansas1d_documentation#Rules for acceptable values. 
     319                        </entry> 
     320                        <entry><para><literal> unit={unit} </literal></para></entry> 
     321                    </row> 
     322                    <row> 
     323                        <entry><para><literal> yaw </literal></para></entry> 
     324                        <entry> 
     325                            floating-point number 
     326                        </entry> 
     327                        <entry> 
     328                            [0..1] 
     329                        </entry> 
     330                        <entry> 
     331                            Rotation about the <emphasis>Y</emphasis> axis (yaw). The <emphasis role="bold">unit</emphasis> attribute is required. See cansas1d_documentation#Rules for acceptable values. 
     332                        </entry> 
     333                        <entry><para><literal> unit={unit} </literal></para></entry> 
     334                    </row> 
    407335                </tbody> 
    408336            </tgroup> 
     
    427355                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Attributes</entry> 
    428356                    </row> 
    429                 <row> 
    430                     <entry> 
    431                         <para> 
    432                             <emphasis role="bold">x</emphasis> 
    433                         </para> 
    434                     </entry> 
    435                     <entry> 
    436                         floating-point number 
    437                     </entry> 
    438                     <entry> 
    439                         [0..1] 
    440                     </entry> 
    441                     <entry> 
    442                         Position of the beam center on the detector in X. The <emphasis role="bold">unit</emphasis> attribute is required. See cansas1d_documentation#Rules for acceptable values. 
    443                     </entry> 
    444                     <entry> 
    445                         <para> 
    446                             <emphasis role="bold">unit</emphasis>={units} 
    447                         </para> 
    448                     </entry> 
    449                 </row> 
    450                 <row> 
    451                     <entry> 
    452                         <para> 
    453                             <emphasis role="bold">y</emphasis> 
    454                         </para> 
    455                     </entry> 
    456                     <entry> 
    457                         floating-point number 
    458                     </entry> 
    459                     <entry> 
    460                         [0..1] 
    461                     </entry> 
    462                     <entry> 
    463                         Position of the beam center on the detector in Y. The <emphasis role="bold">unit</emphasis> attribute is required. See cansas1d_documentation#Rules for acceptable values. 
    464                     </entry> 
    465                     <entry> 
    466                         <para> 
    467                             <emphasis role="bold">unit</emphasis>={units} 
    468                         </para> 
    469                     </entry> 
    470                 </row> 
    471                 <row> 
    472                     <entry> 
    473                         <para> 
    474                             <emphasis role="bold">z</emphasis> 
    475                         </para> 
    476                     </entry> 
    477                     <entry> 
    478                         floating-point number 
    479                     </entry> 
    480                     <entry> 
    481                         [0..1] 
    482                     </entry> 
    483                     <entry> 
    484                         Position of the beam center on the detector in Z. The <emphasis role="bold">unit</emphasis> attribute is required. See cansas1d_documentation#Rules for acceptable values. Note: While Z dimension is allowed by the standard (provided by use of a standard element in the XML Schema), it does not make sense for small-angle scattering. 
    485                     </entry> 
    486                     <entry> 
    487                         <para> 
    488                             <emphasis role="bold">unit</emphasis>={units} 
    489                         </para> 
    490                     </entry> 
    491                 </row> 
    492             </tbody> 
     357                    <row> 
     358                        <entry><para><literal> x </literal></para></entry> 
     359                        <entry> 
     360                            floating-point number 
     361                        </entry> 
     362                        <entry> 
     363                            [0..1] 
     364                        </entry> 
     365                        <entry> 
     366                            Position of the beam center on the detector in X. The <emphasis role="bold">unit</emphasis> attribute is required. See cansas1d_documentation#Rules for acceptable values. 
     367                        </entry> 
     368                        <entry><para><literal> unit={unit} </literal></para></entry> 
     369                    </row> 
     370                    <row> 
     371                        <entry><para><literal> y </literal></para></entry> 
     372                        <entry> 
     373                            floating-point number 
     374                        </entry> 
     375                        <entry> 
     376                            [0..1] 
     377                        </entry> 
     378                        <entry> 
     379                            Position of the beam center on the detector in Y. The <emphasis role="bold">unit</emphasis> attribute is required. See cansas1d_documentation#Rules for acceptable values. 
     380                        </entry> 
     381                        <entry><para><literal> unit={unit} </literal></para></entry> 
     382                    </row> 
     383                    <row> 
     384                        <entry><para><literal> z </literal></para></entry> 
     385                        <entry> 
     386                            floating-point number 
     387                        </entry> 
     388                        <entry> 
     389                            [0..1] 
     390                        </entry> 
     391                        <entry> 
     392                            Position of the beam center on the detector in Z. The <emphasis role="bold">unit</emphasis> attribute is required. See cansas1d_documentation#Rules for acceptable values. Note: While Z dimension is allowed by the standard (provided by use of a standard element in the XML Schema), it does not make sense for small-angle scattering. 
     393                        </entry> 
     394                        <entry><para><literal> unit={unit} </literal></para></entry> 
     395                    </row> 
     396                </tbody> 
    493397            </tgroup> 
    494398        </table> 
     
    512416                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Attributes</entry> 
    513417                    </row> 
    514                 <row> 
    515                     <entry> 
    516                         <para> 
    517                             <emphasis role="bold">x</emphasis> 
    518                         </para> 
    519                     </entry> 
     418                    <row> 
     419                        <entry><para><literal> x </literal></para></entry> 
    520420                    <entry> 
    521421                        floating-point number 
     
    527427                        Size of a detector pixel in X. The <emphasis role="bold">unit</emphasis> attribute is required. See cansas1d_documentation#Rules for acceptable values. 
    528428                    </entry> 
    529                     <entry> 
    530                         <para> 
    531                             <emphasis role="bold">unit</emphasis>={units} 
    532                         </para> 
    533                     </entry> 
    534                 </row> 
    535                 <row> 
    536                     <entry> 
    537                         <para> 
    538                             <emphasis role="bold">y</emphasis> 
    539                         </para> 
    540                     </entry> 
     429                    <entry><para><literal> unit={unit} </literal></para></entry> 
     430                </row> 
     431                    <row> 
     432                        <entry><para><literal> y </literal></para></entry> 
    541433                    <entry> 
    542434                        floating-point number 
     
    548440                        Size of a detector pixel in Y. The <emphasis role="bold">unit</emphasis> attribute is required. See cansas1d_documentation#Rules for acceptable values. 
    549441                    </entry> 
    550                     <entry> 
    551                         <para> 
    552                             <emphasis role="bold">unit</emphasis>={units} 
    553                         </para> 
    554                     </entry> 
    555                 </row> 
    556                 <row> 
    557                     <entry> 
    558                         <para> 
    559                             <emphasis role="bold">z</emphasis> 
    560                         </para> 
    561                     </entry> 
     442                    <entry><para><literal> unit={unit} </literal></para></entry> 
     443                </row> 
     444                    <row> 
     445                        <entry><para><literal> z </literal></para></entry> 
    562446                    <entry> 
    563447                        floating-point number 
     
    569453                        Size of a detector pixel in Z. The <emphasis role="bold">unit</emphasis> attribute is required. See cansas1d_documentation#Rules for acceptable values. Note: While Z dimension is allowed by the standard (provided by use of a standard element in the XML Schema), it does not make sense for small-angle scattering. 
    570454                    </entry> 
    571                     <entry> 
    572                         <para> 
    573                             <emphasis role="bold">unit</emphasis>={units} 
    574                         </para> 
    575                     </entry> 
     455                    <entry><para><literal> unit={unit} </literal></para></entry> 
    576456                </row> 
    577457            </tbody></tgroup> 
  • 1dwg/trunk/doc/src/cansas1d_element_SASentry.xml

    r131 r138  
    5959                </row> 
    6060                <row> 
    61                     <entry> 
    62                         <para> 
    63                             <emphasis role="bold">Title</emphasis> 
    64                         </para> 
    65                     </entry> 
     61                    <entry><para><literal> Title </literal></para></entry> 
    6662                    <entry> 
    6763                        string 
     
    7672                </row> 
    7773                <row> 
    78                     <entry> 
    79                         <para> 
    80                             <emphasis role="bold">Run</emphasis> 
    81                         </para> 
    82                     </entry> 
     74                    <entry><para><literal> Run </literal></para></entry> 
    8375                    <entry> 
    8476                        string 
     
    8981                    <entry> 
    9082                        <para> 
    91                             Run identification for this '''SASentry'''. For many facilities, this is an integer. Use multiple instances of <emphasis role="bold">Run</emphasis> as needed.  
    92                         </para> 
    93                         <para> 
    94                             Note: How to correlate this with '''SASdata''' and '''SASinstrument''' configurations has not yet been defined. 
    95                         </para> 
    96                         <para> 
    97                             <emphasis role="bold">name</emphasis> is an optional string attribute to identify this particular <emphasis role="bold">Run</emphasis>. Could use this to associate (correlate) multiple '''SASdata''' elements with <emphasis role="bold">Run</emphasis> elements. (Give them the same <emphasis>short-Run-identifier</emphasis>.) 
    98                         </para> 
    99                     </entry> 
    100                     <entry> 
    101                         <para> 
    102                             <emphasis role="bold"><emphasis>name</emphasis></emphasis>={short-Run-identifier} 
     83                            Run identification for this <literal>SASentry</literal>.  
     84                            For many facilities, this is an integer.  
     85                            Use multiple instances of <literal>Run</literal> as needed.  
     86                        </para> 
     87                        <para> 
     88                            Note:  
     89                            How to correlate this with <literal>SASdata</literal> and  
     90                            <literal>SASinstrument</literal>  
     91                            configurations has not yet been defined. 
     92                        </para> 
     93                        <para> 
     94                            <literal>name</literal> is an optional string attribute to identify  
     95                            this particular <literal>Run</literal>.  
     96                            Could use this to associate (correlate) multiple <literal>SASdata</literal> 
     97                            elements with <literal>Run</literal> elements.  
     98                            (Give them the same <literal>{short-Run-identifier}</literal>.) 
     99                        </para> 
     100                    </entry> 
     101                    <entry> 
     102                        <para> 
     103                            <literal>name</literal>={short-Run-identifier} 
    103104                        </para> 
    104105                    </entry> 
     
    116117                    <entry> 
    117118                        Any element(s) not defined in the cansas1d/1.0 standard can be placed at this point.  
    118                         See <link xlink:href="#cansas1d_documentation-element-any"><literal>{any}</literal></link> for more details. 
    119                     </entry> 
    120                     <entry> 
    121                         <para> 
    122                             <emphasis role="bold"><emphasis>xmlns:{foreign-prefix}</emphasis></emphasis>={foreign-namespace} 
    123                         </para> 
    124                     </entry> 
    125                 </row> 
    126                 <row> 
    127                     <entry> 
    128                         <link xlink:href="#cansas1d_documentation-element-SASdata">SASdata</link> 
     119                        See <link xlink:href="#cansas1d_documentation-element-any"><literal>{any}</literal></link>  
     120                        for more details. 
     121                    </entry> 
     122                    <entry> 
     123                        <para> 
     124                            <literal>xmlns:{foreign-prefix}={foreign-namespace}</literal> 
     125                        </para> 
     126                    </entry> 
     127                </row> 
     128                <row> 
     129                    <entry> 
     130                        <link xlink:href="#cansas1d_documentation-element-SASdata"><literal>SASdata</literal></link> 
    129131                    </entry> 
    130132                    <entry> 
     
    135137                    </entry> 
    136138                    <entry> 
    137                         Reduced 1-D SAS data for this '''SASentry'''.  
    138                         Use multiple '''SASdata''' elements to represent multiple frames.  
    139                         Use this to associate (correlate) multiple '''SASdata'''  
    140                         elements with  
    141                         <emphasis role="bold">Run</emphasis> elements. (Give them the same name.) 
    142                     </entry> 
    143                     <entry> 
    144                         <para> 
    145                             <emphasis role="bold"><emphasis>name</emphasis></emphasis>={short-Run-identifier} 
    146                         </para> 
     139                        Reduced 1-D SAS data for this <literal>SASentry</literal>.  
     140                        Use multiple <literal>SASdata</literal> elements to represent multiple frames.  
     141                        Use this to associate (correlate) multiple <literal>SASdata</literal> 
     142                        elements with <literal>Run</literal> elements. (Give them the same name.) 
     143                    </entry> 
     144                    <entry> 
     145                        <para><literal>name={short-Run-identifier}</literal></para> 
    147146                    </entry> 
    148147                </row> 
     
    159158                    <entry> 
    160159                        Any element(s) not defined in the cansas1d/1.0 standard can be placed at this point.  
    161                         See <link xlink:href="#cansas1d_documentation-element-any"><literal>{any}</literal></link> for more details. 
    162                     </entry> 
    163                     <entry> 
    164                         <para> 
    165                             <emphasis role="bold"><emphasis>xmlns:{foreign-prefix}</emphasis></emphasis>={foreign-namespace} 
    166                         </para> 
    167                     </entry> 
    168                 </row> 
    169                 <row> 
    170                     <entry> 
    171                         <link xlink:href="#cansas1d_documentation-element-SASsample">SASsample</link> 
     160                        See <link xlink:href="#cansas1d_documentation-element-any"><literal>{any}</literal></link>  
     161                        for more details. 
     162                    </entry> 
     163                    <entry> 
     164                        <para><literal>xmlns:{foreign-prefix}={foreign-namespace}</literal></para> 
     165                    </entry> 
     166                </row> 
     167                <row> 
     168                    <entry> 
     169                        <link xlink:href="#cansas1d_documentation-element-SASsample"><literal>SASsample</literal></link> 
    172170                    </entry> 
    173171                    <entry> 
     
    181179                    </entry> 
    182180                    <entry> 
    183                         <para> 
    184                             <emphasis role="bold"><emphasis>name</emphasis></emphasis>={short-SASsample-identifier} 
    185                         </para> 
    186                     </entry> 
    187                 </row> 
    188                 <row> 
    189                     <entry> 
    190                         <link xlink:href="#cansas1d_documentation-element-SASinstrument">SASinstrument</link> 
     181                        <para><literal>name={short-SASsample-identifier}</literal></para> 
     182                    </entry> 
     183                </row> 
     184                <row> 
     185                    <entry> 
     186                        <link xlink:href="#cansas1d_documentation-element-SASinstrument"><literal>SASinstrument</literal></link> 
    191187                    </entry> 
    192188                    <entry> 
     
    203199                <row> 
    204200                    <entry> 
    205                         <link xlink:href="#cansas1d_documentation-element-SASprocess">SASprocess</link> 
     201                        <link xlink:href="#cansas1d_documentation-element-SASprocess"><literal>SASprocess</literal></link> 
    206202                    </entry> 
    207203                    <entry> 
     
    215211                    </entry> 
    216212                    <entry> 
    217                         <para> 
    218                             <emphasis role="bold"><emphasis>name</emphasis></emphasis>={short-SASprocess-identifier} 
    219                         </para> 
    220                     </entry> 
    221                 </row> 
    222                 <row> 
    223                     <entry> 
    224                         <link xlink:href="#cansas1d_documentation-element-SASnote">SASnote</link> 
     213                        <para><literal>name={short-SASprocess-identifier}</literal></para> 
     214                    </entry> 
     215                </row> 
     216                <row> 
     217                    <entry> 
     218                        <link xlink:href="#cansas1d_documentation-element-SASnote"><literal>SASnote</literal></link> 
    225219                    </entry> 
    226220                    <entry> 
     
    234228                    </entry> 
    235229                    <entry> 
    236                         <para> 
    237                             <emphasis role="bold"><emphasis>name</emphasis></emphasis>={short-SASnote-identifier} 
    238                         </para> 
     230                        <para><literal>name={short-SASnote-identifier}</literal></para> 
    239231                    </entry> 
    240232                </row> 
  • 1dwg/trunk/doc/src/cansas1d_element_SASinstrument.xml

    r128 r138  
    7777            <row> 
    7878                <entry> 
    79                     '''SASsource''' 
     79                    <literal>SASsource</literal> 
    8080                </entry> 
    8181                <entry> 
     
    8989                </entry> 
    9090                <entry> 
    91                     <para> 
    92                         <emphasis role="bold"><emphasis>name</emphasis></emphasis>={name} 
    93                     </para> 
     91                    <para><literal>name={name}</literal></para> 
    9492                </entry> 
    9593            </row> 
    9694            <row> 
    9795                <entry> 
    98                     '''SAScollimation''' 
     96                    <literal>SAScollimation</literal> 
    9997                </entry> 
    10098                <entry> 
     
    108106                </entry> 
    109107                <entry> 
    110                     <para> 
    111                         <emphasis role="bold"><emphasis>name</emphasis></emphasis>={name} 
    112                     </para> 
     108                    <para><literal>name={name}</literal></para> 
    113109                </entry> 
    114110            </row> 
    115111            <row> 
    116112                <entry> 
    117                     '''SASdetector''' 
     113                    <literal>SASdetector</literal> 
    118114                </entry> 
    119115                <entry> 
  • 1dwg/trunk/doc/src/cansas1d_element_SASprocess.xml

    r131 r138  
    2323            <para> 
    2424                parent: 
    25                 <link xlink:href="#cansas1d_documentation-element-SASentry">SASentry</link> 
     25                <link xlink:href="#cansas1d_documentation-element-SASentry"><literal>SASentry</literal></link> 
    2626            </para> 
    2727        </listitem> 
     
    5858                </row> 
    5959                <row> 
    60                     <entry> 
    61                         <para> 
    62                             <emphasis role="bold"><emphasis>name</emphasis></emphasis> 
    63                         </para> 
    64                     </entry> 
     60                    <entry><para><literal> name </literal></para></entry> 
    6561                    <entry> 
    6662                        string 
     
    7268                        Optional name for this data processing or analysis step. 
    7369                    </entry> 
    74                     <entry> 
    75                     </entry> 
     70                    <entry/> 
    7671                </row> 
    7772                <row> 
    78                     <entry> 
    79                         <para> 
    80                             <emphasis role="bold"><emphasis>date</emphasis></emphasis> 
    81                         </para> 
    82                     </entry> 
     73                    <entry><para><literal> date </literal></para></entry> 
    8374                    <entry> 
    8475                        string 
     
    8879                    </entry> 
    8980                    <entry> 
    90                         Optional date for this data processing or analysis step. Use a format which is easily machine-readable such as yyyy-mm-dd hh:mm:ss  
     81                        Optional date for this data processing or analysis step.  
     82                        Use a format which is easily machine-readable such as yyyy-mm-dd hh:mm:ss  
    9183                        The format for the date string may be specified at a later date. 
    9284                    </entry> 
     
    9486                </row> 
    9587                <row> 
    96                     <entry> 
    97                         <para> 
    98                             <emphasis role="bold"><emphasis>description</emphasis></emphasis> 
    99                         </para> 
    100                     </entry> 
     88                    <entry><para><literal> description </literal></para></entry> 
    10189                    <entry> 
    10290                        string 
     
    11199                </row> 
    112100                <row> 
    113                     <entry> 
    114                         <para> 
    115                             <emphasis role="bold"><emphasis>term</emphasis></emphasis> 
    116                         </para> 
    117                     </entry> 
     101                    <entry><para><literal> term </literal></para></entry> 
    118102                    <entry> 
    119103                        string 
     
    123107                    </entry> 
    124108                    <entry> 
    125                         This is used to specify the value of a single variable, parameter, or term (while defined here as a string, it could be a number) related to the SASprocess step. 
     109                        This is used to specify the value of a single variable, parameter, or term  
     110                        (while defined here as a string, it could be a number) related to the  
     111                        <literal>SASprocess</literal> step. 
    126112                    </entry> 
    127                     <entry> 
    128                         <para> 
    129                             <emphasis role="bold">unit</emphasis>={unit} 
    130                         </para> 
    131                     </entry> 
     113                    <entry><para><literal> unit={unit} </literal></para></entry> 
    132114                </row> 
    133115                <row> 
    134116                    <entry> 
    135                         <link xlink:href="#cansas1d_documentation-element-SASprocessnote"><literal>SASprocessnote</literal></link> 
     117                        <link xlink:href="#cansas1d_documentation-element-SASprocessnote" 
     118                            ><literal>SASprocessnote</literal></link> 
    136119                    </entry> 
    137120                    <entry> 
     
    158141                    <entry> 
    159142                        Any element(s) not defined in the cansas1d/1.0 standard can be placed at this point.  
    160                         See <link xlink:href="#cansas1d_documentation-element-any"><literal>{any}</literal></link> for more details. 
     143                        See <link xlink:href="#cansas1d_documentation-element-any"><literal>{any}</literal></link>  
     144                        for more details. 
    161145                    </entry> 
    162                     <entry> 
    163                         <para> 
    164                             <emphasis role="bold"><emphasis>xmlns:{foreign-prefix}</emphasis></emphasis>={foreign-namespace} 
    165                         </para> 
    166                     </entry> 
     146                    <entry><para><literal> xmlns:{foreign-prefix}={foreign-namespace} </literal></para></entry> 
    167147                </row> 
    168148            </tbody> 
     
    201181                            See <link xlink:href="#cansas1d_documentation-element-any"><literal>{any}</literal></link> for more details. 
    202182                        </entry> 
    203                         <entry> 
    204                             <para> 
    205                                 <emphasis role="bold"><emphasis>xmlns:{foreign-prefix}</emphasis></emphasis>={foreign-namespace} 
    206                             </para> 
    207                         </entry> 
     183                        <entry><para><literal> xmlns:{foreign-prefix}={foreign-namespace} </literal></para></entry> 
    208184                    </row> 
    209185                </tbody> 
  • 1dwg/trunk/doc/src/cansas1d_element_SASsample.xml

    r131 r138  
    5858                </row> 
    5959                <row> 
    60                     <entry> 
    61                         <para> 
    62                             <emphasis role="bold">ID</emphasis> 
    63                         </para> 
    64                     </entry> 
     60                    <entry><para><literal> ID </literal></para></entry> 
    6561                    <entry> string </entry> 
    6662                    <entry> [1..1] </entry> 
    6763                    <entry> Text string that identifies this sample. </entry> 
    68                     <entry> 
    69                     </entry> 
    70                 </row> 
    71                 <row> 
    72                     <entry> 
    73                         <para> 
    74                             <emphasis role="bold"><emphasis>thickness</emphasis></emphasis> 
    75                         </para> 
    76                     </entry> 
     64                    <entry/> 
     65                </row> 
     66                <row> 
     67                    <entry><para><literal> thickness </literal></para></entry> 
    7768                    <entry> floating-point number </entry> 
    7869                    <entry> [0..1] </entry> 
    7970                    <entry> Thickness of this sample. Must specify the unit as an attribute. </entry> 
    8071                    <entry> 
    81                         <para> 
    82                             <emphasis role="bold">unit</emphasis>={unit} </para> 
    83                     </entry> 
    84                 </row> 
    85                 <row> 
    86                     <entry> 
    87                         <para> 
    88                             <emphasis role="bold"><emphasis>transmission</emphasis></emphasis> 
    89                         </para> 
    90                     </entry> 
     72                        <para><literal>unit={unit}</literal></para> 
     73                    </entry> 
     74                </row> 
     75                <row> 
     76                    <entry><para><literal> transmission </literal></para></entry> 
    9177                    <entry> floating-point number </entry> 
    9278                    <entry> [0..1] </entry> 
    9379                    <entry> Transmission (1-attenuation) of this sample. Express this as a fraction, 
    9480                        not as a percentage. NOTE: there is no unit attribute. </entry> 
    95                     <entry> 
    96                     </entry> 
    97                 </row> 
    98                 <row> 
    99                     <entry> 
    100                         <para> 
    101                             <emphasis role="bold"><emphasis>temperature</emphasis></emphasis> 
    102                         </para> 
    103                     </entry> 
     81                    <entry/> 
     82                </row> 
     83                <row> 
     84                    <entry><para><literal> temperature </literal></para></entry> 
    10485                    <entry> floating-point number </entry> 
    10586                    <entry> [0..1] </entry> 
    10687                    <entry> Temperature of this sample. Must specify the unit as an attribute. </entry> 
    10788                    <entry> 
    108                         <para> 
    109                             <emphasis role="bold">unit</emphasis>={unit} </para> 
    110                     </entry> 
    111                 </row> 
    112                 <row> 
    113                     <entry> '''''position''''' </entry> 
     89                        <para><literal>unit={unit}</literal></para> 
     90                    </entry> 
     91                </row> 
     92                <row> 
     93                    <entry> <literal>position</literal> </entry> 
    11494                    <entry> container </entry> 
    11595                    <entry> [0..1] </entry> 
    11696                    <entry> Location in X, Y, and Z of the sample. </entry> 
    117                     <entry> 
    118                     </entry> 
    119                 </row> 
    120                 <row> 
    121                     <entry> '''''orientation''''' </entry> 
     97                    <entry/> 
     98                </row> 
     99                <row> 
     100                    <entry> <literal>orientation</literal> </entry> 
    122101                    <entry> container </entry> 
    123102                    <entry> [0..1] </entry> 
    124103                    <entry> Orientation (rotation) of the sample. </entry> 
    125                     <entry> 
    126                     </entry> 
    127                 </row> 
    128                 <row> 
    129                     <entry> 
    130                         <para> 
    131                             <emphasis role="bold"><emphasis>details</emphasis></emphasis> 
    132                         </para> 
     104                    <entry/> 
     105                </row> 
     106                <row> 
     107                    <entry> 
     108                        <para><literal>details</literal></para> 
    133109                    </entry> 
    134110                    <entry> string </entry> 
    135111                    <entry> [0..inf] </entry> 
    136112                    <entry> Any additional sample details. </entry> 
    137                     <entry> 
    138                     </entry> 
     113                    <entry/> 
     114                     
    139115                </row> 
    140116                <row> 
     
    149125                        for more details. </entry> 
    150126                    <entry> 
    151                         <para> 
    152                             <emphasis role="bold" 
    153                                 ><emphasis>xmlns:{foreign-prefix}</emphasis></emphasis>={foreign-namespace} 
    154                         </para> 
     127                        <para><literal>xmlns:{foreign-prefix}={foreign-namespace}</literal></para> 
    155128                    </entry> 
    156129                </row> 
     
    221194                    </row> 
    222195                    <row> 
    223                         <entry> 
    224                             <para> 
    225                                 <emphasis role="bold">x</emphasis> 
    226                             </para> 
    227                         </entry> 
     196                        <entry><para><literal> x </literal></para></entry> 
    228197                        <entry> floating-point number </entry> 
    229198                        <entry> [0..1] </entry> 
     
    231200                                >unit</emphasis> attribute is required. See 
    232201                            cansas1d_documentation#Rules for acceptable values. </entry> 
    233                         <entry> 
    234                             <para> 
    235                                 <emphasis role="bold">unit</emphasis>={units} </para> 
    236                         </entry> 
    237                     </row> 
    238                     <row> 
    239                         <entry> 
    240                             <para> 
    241                                 <emphasis role="bold">y</emphasis> 
    242                             </para> 
    243                         </entry> 
     202                        <entry><para><literal>unit={unit}</literal></para></entry> 
     203                    </row> 
     204                    <row> 
     205                        <entry><para><literal> y </literal></para></entry> 
    244206                        <entry> floating-point number </entry> 
    245207                        <entry> [0..1] </entry> 
     
    247209                                >unit</emphasis> attribute is required. See 
    248210                            cansas1d_documentation#Rules for acceptable values. </entry> 
    249                         <entry> 
    250                             <para> 
    251                                 <emphasis role="bold">unit</emphasis>={units} </para> 
    252                         </entry> 
    253                     </row> 
    254                     <row> 
    255                         <entry> 
    256                             <para> 
    257                                 <emphasis role="bold">z</emphasis> 
    258                             </para> 
    259                         </entry> 
     211                        <entry><para><literal>unit={unit}</literal></para></entry> 
     212                    </row> 
     213                    <row> 
     214                        <entry><para><literal> z </literal></para></entry> 
    260215                        <entry> floating-point number </entry> 
    261216                        <entry> [0..1] </entry> 
     
    266221                            element in the XML Schema), it does not make sense for small-angle 
    267222                            scattering. </entry> 
    268                         <entry> 
    269                             <para> 
    270                                 <emphasis role="bold">unit</emphasis>={units} </para> 
    271                         </entry> 
     223                        <entry><para><literal>unit={unit}</literal></para></entry> 
    272224                    </row> 
    273225                </tbody> 
     
    294246                    </row> 
    295247                    <row> 
    296                         <entry> 
    297                             <para> 
    298                                 <emphasis role="bold">roll</emphasis> 
    299                             </para> 
    300                         </entry> 
     248                        <entry><para><literal> roll </literal></para></entry> 
    301249                        <entry> floating-point number </entry> 
    302250                        <entry> [0..1] </entry> 
     
    304252                                role="bold">unit</emphasis> attribute is required. See 
    305253                            cansas1d_documentation#Rules for acceptable values. </entry> 
    306                         <entry> 
    307                             <para> 
    308                                 <emphasis role="bold">unit</emphasis>={units} </para> 
    309                         </entry> 
    310                     </row> 
    311                     <row> 
    312                         <entry> 
    313                             <para> 
    314                                 <emphasis role="bold">pitch</emphasis> 
    315                             </para> 
    316                         </entry> 
     254                        <entry><para><literal>unit={unit}</literal></para></entry> 
     255                    </row> 
     256                    <row> 
     257                        <entry><para><literal> pitch </literal></para></entry> 
    317258                        <entry> floating-point number </entry> 
    318259                        <entry> [0..1] </entry> 
     
    320261                                <emphasis role="bold">unit</emphasis> attribute is required. See 
    321262                            cansas1d_documentation#Rules for acceptable values. </entry> 
    322                         <entry> 
    323                             <para> 
    324                                 <emphasis role="bold">unit</emphasis>={units} </para> 
    325                         </entry> 
    326                     </row> 
    327                     <row> 
    328                         <entry> 
    329                             <para> 
    330                                 <emphasis role="bold">yaw</emphasis> 
    331                             </para> 
    332                         </entry> 
     263                        <entry><para><literal>unit={unit}</literal></para></entry> 
     264                    </row> 
     265                    <row> 
     266                        <entry><para><literal> yaw </literal></para></entry> 
    333267                        <entry> floating-point number </entry> 
    334268                        <entry> [0..1] </entry> 
     
    336270                                role="bold">unit</emphasis> attribute is required. See 
    337271                            cansas1d_documentation#Rules for acceptable values. </entry> 
    338                         <entry> 
    339                             <para> 
    340                                 <emphasis role="bold">unit</emphasis>={units} </para> 
    341                         </entry> 
     272                        <entry><para><literal>unit={unit}</literal></para></entry> 
    342273                    </row> 
    343274                </tbody> 
  • 1dwg/trunk/doc/src/cansas1d_element_SASsource.xml

    r128 r138  
    5656                    </row> 
    5757                    <row> 
    58                         <entry> 
    59                             <para> 
    60                                 <emphasis role="bold">radiation</emphasis> 
    61                             </para> 
    62                         </entry> 
     58                        <entry><para><literal> radiation </literal></para></entry> 
    6359                        <entry> string </entry> 
    6460                        <entry> [1..1] </entry> 
     
    9490                        </entry> 
    9591                        <entry/> 
    96                          
    97                     </row> 
    98                     <row> 
    99                         <entry> '''''beam_size''''' </entry> 
     92                    </row> 
     93                    <row> 
     94                        <entry><literal> beam_size </literal></entry> 
    10095                        <entry> container </entry> 
    10196                        <entry> [0..1] </entry> 
     
    10398                            beam is round, just use X dimension. Note: While Z dimension is allowed 
    10499                            by the standard, it does not make sense for small-angle scattering. </entry> 
    105                         <entry> 
    106                             <para> 
    107                                 <emphasis role="bold"><emphasis>name</emphasis></emphasis>={name} 
    108                             </para> 
    109                         </entry> 
    110                     </row> 
    111                     <row> 
    112                         <entry> 
    113                             <para> 
    114                                 <emphasis role="bold"><emphasis>beam_shape</emphasis></emphasis> 
    115                             </para> 
    116                         </entry> 
     100                        <entry><para><literal>name={name}</literal></para></entry> 
     101                    </row> 
     102                    <row> 
     103                        <entry><para><literal> beam_shape </literal></para></entry> 
    117104                        <entry> string </entry> 
    118105                        <entry> [0..1] </entry> 
    119106                        <entry> Text description of the shape of the beam (incident on the sample). </entry> 
    120                         <entry> 
    121                         </entry> 
    122                     </row> 
    123                     <row> 
    124                         <entry> 
    125                             <para> 
    126                                 <emphasis role="bold"><emphasis>wavelength</emphasis></emphasis> 
    127                             </para> 
    128                         </entry> 
     107                        <entry/> 
     108                    </row> 
     109                    <row> 
     110                        <entry><para><literal> wavelength </literal></para></entry> 
    129111                        <entry> floating-point number </entry> 
    130112                        <entry> [0..1] </entry> 
     
    138120                            </para> 
    139121                        </entry> 
    140                         <entry> 
    141                             <para> 
    142                                 <emphasis role="bold">unit</emphasis>={unit} </para> 
    143                         </entry> 
    144                     </row> 
    145                     <row> 
    146                         <entry> 
    147                             <para> 
    148                                 <emphasis role="bold"><emphasis>wavelength_min</emphasis></emphasis> 
    149                             </para> 
    150                         </entry> 
     122                        <entry><para><literal> unit={unit} </literal></para></entry> 
     123                    </row> 
     124                    <row> 
     125                        <entry><para><literal> wavelength_min </literal></para></entry> 
    151126                        <entry> floating-point number </entry> 
    152127                        <entry> [0..1] </entry> 
    153128                        <entry> Some facilities specify wavelength using a range. The minimum of 
    154129                            such a range is given by wavelength_min. </entry> 
    155                         <entry> 
    156                             <para> 
    157                                 <emphasis role="bold">unit</emphasis>={unit} </para> 
    158                         </entry> 
    159                     </row> 
    160                     <row> 
    161                         <entry> 
    162                             <para> 
    163                                 <emphasis role="bold"><emphasis>wavelength_max</emphasis></emphasis> 
    164                             </para> 
    165                         </entry> 
     130                        <entry><para><literal> unit={unit} </literal></para></entry> 
     131                    </row> 
     132                    <row> 
     133                        <entry><para><literal> wavelength_max </literal></para></entry> 
    166134                        <entry> floating-point number </entry> 
    167135                        <entry> [0..1] </entry> 
    168136                        <entry> Some facilities specify wavelength using a range. The maximum of 
    169137                            such a range is given by wavelength_max. </entry> 
    170                         <entry> 
    171                             <para> 
    172                                 <emphasis role="bold">unit</emphasis>={unit} </para> 
    173                         </entry> 
    174                     </row> 
    175                     <row> 
    176                         <entry> 
    177                             <para> 
    178                                 <emphasis role="bold" 
    179                                     ><emphasis>wavelength_spread</emphasis></emphasis> 
    180                             </para> 
    181                         </entry> 
     138                        <entry><para><literal> unit={unit} </literal></para></entry> 
     139                    </row> 
     140                    <row> 
     141                        <entry><para><literal> wavelength_spread </literal></para></entry> 
    182142                        <entry> floating-point number </entry> 
    183143                        <entry> [0..1] </entry> 
    184144                        <entry> Some facilities specify the width of the wavelength spectrum. The 
    185145                            width of such a range is given by wavelength_spread. </entry> 
    186                         <entry> 
    187                             <para> 
    188                                 <emphasis role="bold">unit</emphasis>={unit} </para> 
    189                         </entry> 
     146                        <entry><para><literal> unit={unit} </literal></para></entry> 
    190147                    </row> 
    191148                </tbody> 
     
    246203                        </row> 
    247204                        <row> 
    248                             <entry> 
    249                                 <emphasis role="bold">x</emphasis> 
    250                             </entry> 
     205                            <entry><para><literal> x </literal></para></entry> 
    251206                            <entry> floating-point number </entry> 
    252207                            <entry> [0..1] </entry> 
     
    254209                                    >unit</emphasis> attribute is required. See 
    255210                                cansas1d_documentation#Rules for acceptable values. </entry> 
    256                             <entry> 
    257                                 <emphasis role="bold">unit</emphasis>={units} </entry> 
    258                         </row> 
    259                         <row> 
    260                             <entry> 
    261                                 <emphasis role="bold">y</emphasis> 
    262                             </entry> 
     211                            <entry><para><literal> unit={unit} </literal></para></entry> 
     212                        </row> 
     213                        <row> 
     214                            <entry><para><literal> y </literal></para></entry> 
    263215                            <entry> floating-point number </entry> 
    264216                            <entry> [0..1] </entry> 
     
    266218                                    >unit</emphasis> attribute is required. See 
    267219                                cansas1d_documentation#Rules for acceptable values. </entry> 
    268                             <entry> 
    269                                 <emphasis role="bold">unit</emphasis>={units} </entry> 
    270                         </row> 
    271                         <row> 
    272                             <entry> 
    273                                 <emphasis role="bold">z</emphasis> 
    274                             </entry> 
     220                            <entry><para><literal> unit={unit} </literal></para></entry> 
     221                        </row> 
     222                        <row> 
     223                            <entry><para><literal> z </literal></para></entry> 
    275224                            <entry> floating-point number </entry> 
    276225                            <entry> [0..1] </entry> 
     
    280229                                dimension is allowed by the standard (provided by use of a standard 
    281230                                element in the XML Schema), it does not make sense for small-angle 
    282                                 scattering. </entry> 
    283                             <entry> 
    284                                 <emphasis role="bold">unit</emphasis>={units} </entry> 
     231                                scattering.  
     232                            </entry> 
     233                            <entry><para><literal> unit={unit} </literal></para></entry> 
    285234                        </row> 
    286235                    </tbody> 
  • 1dwg/trunk/doc/src/casestudies.xml

    r127 r138  
    1010    ########### SVN repository information ################### 
    1111--> 
    12 <chapter xml:id="wiki-case_studies" xmlns="http://docbook.org/ns/docbook" version="5.0" 
     12<section xml:id="wiki-case_studies" xmlns="http://docbook.org/ns/docbook" version="5.0" 
    1313    xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"> 
    1414    <title>Case Studies</title> 
    1515    <xi:include href="cansas1d_casestudy_collagen.xml"/> 
    1616    <xi:include href="cansas1d_casestudy_af1410.xml"/> 
    17 </chapter> 
     17</section> 
  • 1dwg/trunk/doc/src/elements.xml

    r134 r138  
    1818        Each of these is described below. 
    1919    </para> 
     20    <note> 
     21        <para>Explain the <literal>attribute={text}</literal> syntax.</para> 
     22    </note> 
    2023    <glosslist> 
    2124        <glossentry> 
  • 1dwg/trunk/doc/src/manual.xml

    r136 r138  
    5959    <xi:include href="tutorial.xml"/> 
    6060    <xi:include href="bindings.xml"/> 
    61     <xi:include href="casestudies.xml"/> 
    6261    <xi:include href="other.xml"/> 
    6362        <!--<xi:include href="appendices.xml"/>--> 
  • 1dwg/trunk/doc/src/other.xml

    r137 r138  
    148148                stylesheet displays  
    149149                all the <literal>Idata</literal> blocks in a cansas1d/1.0 file 
    150                 in 3-column ASCII form, with column headers. 
     150                in 3-column ASCII form.  Be careful using this stylesheet 
     151                on files with multiple <literal>SASdata</literal> or 
     152                <literal>SASentry</literal> blocks since this stylesheet 
     153                assumes there is only one of each of these.  While it 
     154                is the most common case to have only one of each, some of 
     155                the examples have multiple data sets.  This stylesheet will 
     156                concatenate all of the <literal>Idata</literal>. 
    151157            </para> 
    152158            <indexterm> 
  • 1dwg/trunk/doc/src/tutorial.xml

    r132 r138  
    2121    </para> 
    2222    <note><para>More needs to be written here.</para></note> 
     23 
     24    <xi:include href="casestudies.xml"/> 
    2325</chapter> 
Note: See TracChangeset for help on using the changeset viewer.