Changeset 255 for 1dwg


Ignore:
Timestamp:
Aug 31, 2012 5:09:59 PM (7 years ago)
Author:
prjemian
Message:

refs #24

Location:
1dwg/trunk/doc/source
Files:
10 added
1 deleted
8 edited

Legend:

Unmodified
Added
Removed
  • 1dwg/trunk/doc/source/conf.py

    r250 r255  
    2828extensions = ['sphinx.ext.pngmath',] 
    2929extensions = ['sphinx.ext.mathjax',] 
     30extensions = ['sphinx.ext.todo',] 
     31todo_include_todos = True 
    3032 
    3133# Add any paths that contain templates here, relative to this directory. 
  • 1dwg/trunk/doc/source/element_SAScollimation.rst

    r254 r255  
    66 
    77============================ 
    8 *SAScollimation* element 
     8*SAScollimation* 
    99============================ 
    1010 
     
    1313 
    1414.. figure:: ../../graphics/6-SAScollimation.png 
    15     :alt: cansas1d-v1-1-SAScollimation 
    1615     
    1716    The *SAScollimation* element 
     
    2423Name                           Type        Occurrence   Description                                 Attributes 
    2524============================== =========== ============ =========================================== ==================================== 
    26 *length*                       float       [0..1]       Amount/length of collimation inserted       *unit={unit}* 
     25*length*                       float       [0..1]       Amount/length of collimation inserted       *unit={unit}*   [#units]_ 
    2726                                                        (on a SANS instrument) 
    2827:ref:`SAScollimation.aperture` container   [0..inf]     Description of a slit or aperture.        
     
    4847=========================== =========== ============ =========================================== ==================================== 
    4948:ref:`SAScollimation.size`  container   [0..1]       Opening dimensions of this aperture.        *name={name}* 
    50 *distance*                  float       [0..1]       Distance from this collimation element      *unit={unit}*  
     49*distance*                  float       [0..1]       Distance from this collimation element      *unit={unit}*    [#units]_ 
    5150                                                     to the sample. 
    5251=========================== =========== ============ =========================================== ==================================== 
     
    6564        element; z 
    6665 
    67 .. tip:: While :math:`z` is allowed  
    68         by the standard (provided by use of  
    69         a standard *size* element in the XML Schema),  
    70         it does not make sense for  
    71         small-angle scattering. 
    72  
    7366====================== =========== ============ =========================================== ==================================== 
    7467Name                   Type        Occurrence   Description                                 Attributes 
    7568====================== =========== ============ =========================================== ==================================== 
    76 :math:`x`              float       [0..1]       Dimension of the collimation in X.          *unit={unit}* 
    77                                                 The *unit* attribute is required. See 
    78                                                 :ref:`rules` for acceptable values. 
    79 :math:`y`              float       [0..1]       Dimension of the collimation in Y.          *unit={unit}* 
    80                                                 The *unit* attribute is required. See 
    81                                                 :ref:`rules` for acceptable values. 
    82 :math:`z`              float       [0..1]       Dimension of the collimation in Z.          *unit={unit}* 
    83                                                 The *unit* attribute is required. See 
    84                                                 :ref:`rules` for acceptable values. 
     69:math:`x`              float       [0..1]       Dimension of the collimation in X.          *unit={unit}*   [#units]_ 
     70:math:`y`              float       [0..1]       Dimension of the collimation in Y.          *unit={unit}*   [#units]_ 
     71:math:`z`              float       [0..1]       Dimension of the collimation in Z.          *unit={unit}*   [#units]_  [#Z]_ 
     72====================== =========== ============ =========================================== ==================================== 
    8573 
    86 ====================== =========== ============ =========================================== ==================================== 
     74 
     75--------------- 
     76 
     77.. rubric:: Table Notes 
     78 
     79..  [#units] The *unit* attribute is required.  
     80        See :ref:`rules` for acceptable values. 
     81..  [#Z] While :math:`z` is allowed by the standard (provided by use of  
     82        a standard *size* element in the XML Schema), it does not make sense  
     83        to use it for small-angle scattering.  Use of :math:`z` here may be  
     84        ignored by processing software. 
  • 1dwg/trunk/doc/source/element_SASentry.rst

    r253 r255  
    66 
    77============================ 
    8 *SASentry* element 
     8*SASentry* 
    99============================ 
    1010 
     
    1313 
    1414.. figure:: ../../graphics/1-SASroot.png 
    15     :alt: cansas1d-v1-1-SASentry 
    1615     
    1716    The *SASentry* element 
     
    2221        element; {any} 
    2322        element; SASdata 
     23        element; SASsample 
    2424        element; SASinstrument 
    2525        element; SASprocess 
     
    4747:ref:`{any}`           container   [0..inf]     Any element(s) not defined in the           *xmlns:{foreign-prefix}={foreign-namespace}* 
    4848                                                cansas1d/1.1 standard can be placed at  
    49                                                 this point.  
    50                                                 See :ref:`{any}` for more details. 
     49                                                this point. 
    5150:ref:`SASdata`         container   [1..inf]     Reduced 1-D SAS data for this *SASentry*.   *name={short-Run-identifier}* 
    5251                                                Use multiple *SASdata* elements to  
     
    5857:ref:`{any}`           container   [0..inf]     Any element(s) not defined in the           *xmlns:{foreign-prefix}={foreign-namespace}* 
    5958                                                cansas1d/1.1 standard can be placed at  
    60                                                 this point.  
    61                                                 See :ref:`{any}` for more details. 
     59                                                this point. 
    6260:ref:`SASsample`       container   [1..1]       Description of the sample.                  *name={short-SASsample-identifier}* 
    6361:ref:`SASinstrument`   container   [1..1]       Description of the instrument. 
  • 1dwg/trunk/doc/source/element_SASroot.rst

    r244 r255  
    66 
    77============================ 
    8 *SASroot* element 
     8*SASroot* 
    99============================ 
    1010 
     
    1313 
    1414.. figure:: ../../graphics/1-SASroot.png 
    15     :alt: cansas1d-v1-1-SASroot 
    1615     
    1716    The *SASroot* element 
    1817 
    1918 
    20 =========== =========== ============ ===================================== =========================== 
    21 Name        Type        Occurrence   Description                           Attributes 
    22 =========== =========== ============ ===================================== =========================== 
    23 *SASentry*  container   [1..inf]     A single SAS scan is reported in a    ``name="short-name"`` 
    24                                      *SASentry*. Include as many 
    25                                      *SASentry* elements as desired. 
    26                                      They may contain related or 
    27                                      unrelated data. name is an optional 
    28                                      attribute to provide a string for 
    29                                      this *SASentry*. (Use of this string 
    30                                      is not defined by this standard.) 
    31 =========== =========== ============ ===================================== =========================== 
     19================ =========== ============ ===================================== =========================== 
     20Name             Type        Occurrence   Description                           Attributes 
     21================ =========== ============ ===================================== =========================== 
     22:ref:`SASentry`  container   [1..inf]     A single SAS scan is reported in a    ``name="short-name"`` 
     23                                          *SASentry*. Include as many 
     24                                          *SASentry* elements as desired. 
     25                                          They may contain related or 
     26                                          unrelated data. name is an optional 
     27                                          attribute to provide a string for 
     28                                          this *SASentry*. (Use of this string 
     29                                          is not defined by this standard.) 
     30================ =========== ============ ===================================== =========================== 
  • 1dwg/trunk/doc/source/elements.rst

    r253 r255  
    77=================================================== 
    88 
    9 .. note::  This entire chapter needs to be converted from DocBook! 
    10  
    11 .. _XML Header: 
    12  
    13 XML Header 
    14 =============== 
    15  
    169.. toctree:: 
    1710   :maxdepth: 2 
    1811    
     12   element_XML_header 
    1913   element_SASroot 
    2014   element_SASentry 
     15   element_SASdata 
     16   element_SAStransmission_spectrum 
     17   element_SASsample 
     18   element_SASinstrument 
     19   element_SASsource 
    2120   element_SAScollimation 
    22  
    23 .. _Title: 
    24  
    25 Title 
    26 ============== 
    27  
    28 .. _Run: 
    29  
    30 Run 
    31 ============== 
    32  
    33  
    34 .. _SASdata: 
    35  
    36 SASdata 
    37 ============== 
    38  
    39  
    40 .. _Idata: 
    41  
    42 Idata 
    43 ============== 
    44  
    45  
    46 .. _SAStransmission_spectrum: 
    47  
    48 SAStransmission_spectrum 
    49 ============================ 
    50  
    51  
    52 .. _Tdata: 
    53  
    54 Tdata 
    55 ============== 
    56  
    57  
    58 .. _SASsample: 
    59  
    60 SASsample 
    61 ============== 
    62  
    63  
    64 .. _SASinstrument: 
    65  
    66 SASinstrument 
    67 ============== 
    68  
    69  
    70 .. _SASsource: 
    71  
    72 SASsource 
    73 ============== 
    74  
    75  
    76 .. _SASdetector: 
    77  
    78 SASdetector 
    79 ============== 
    80  
    81  
    82 .. _SASprocess: 
    83  
    84 SASprocess 
    85 ============== 
    86  
    87  
    88 .. _SASnote: 
    89  
    90 SASnote 
    91 ============== 
    92  
    93  
    94 .. _{any}: 
    95  
    96 *{any}* 
    97 ============== 
     21   element_SASdetector 
     22   element_SASprocess 
     23   element_SASnote 
     24   element_any 
  • 1dwg/trunk/doc/source/index.rst

    r246 r255  
    3939   :maxdepth: 2 
    4040    
     41   manual 
    4142   downloads 
    42    manual 
    43    status 
  • 1dwg/trunk/doc/source/overview.rst

    r254 r255  
    9595                > 
    9696 
    97 .. index: element; SASroot 
    98 .. index: element; SASentry 
    99 .. index: element; Title 
    100 .. index: element; Run 
    101 .. index: element; SASdata 
    102 .. index: element; Idata 
    103 .. index: element; SAStransmission_spectrum 
    104 .. index: element; Tdata 
    105 .. index: element; {any} 
    106 .. index: element; SASsample 
    107 .. index: element; SASinstrument 
    108 .. index: element; SASsource 
    109 .. index: element; SAScollimation 
    110 .. index: element; SASdetector  
    111 .. index: element; SASprocess 
    112 .. index: element; SASnote 
     97.. index: 
     98        XML header 
     99        element; SASroot 
     100        element; SASentry 
     101        element; Title 
     102        element; Run 
     103        element; SASdata 
     104        element; Idata 
     105        element; SAStransmission_spectrum 
     106        element; Tdata 
     107        element; {any} 
     108        element; SASsample 
     109        element; SASinstrument 
     110        element; SASsource 
     111        element; SAScollimation 
     112        element; SASdetector  
     113        element; SASprocess 
     114        element; SASnote 
    113115 
    114116.. rubric:: Basic elements of the canSAS 1-D standard 
     
    120122:ref:`SASroot`                    root element of XML file 
    121123:ref:`SASentry`                   data set, time-slice, step in a series, new sample, etc. 
    122 :ref:`Title`                      for this particular :ref:`SASentry` 
    123 :ref:`Run`                        run number or ID number of experiment 
    124 :ref:`{any}`                      any XML element can be used at this point 
     124*Title*                           for this particular :ref:`SASentry` 
     125*Run*                             run number or ID number of experiment 
     126*{any}*                           any XML element can be used at this point 
    125127:ref:`SASdata`                    this is where the reduced 1-D SAS data is stored 
    126128:ref:`Idata`                      a single data point of :math:`I(Q)` (and related items) in the dataset 
    127129:ref:`SAStransmission_spectrum`   any transmission spectra may be stored here 
    128130:ref:`Tdata`                      a single data point in the transmission spectrum 
    129 :ref:`{any}`                      any XML element can be used at this point 
     131*{any}*                           any XML element can be used at this point 
    130132:ref:`SASsample`                  description of the sample 
    131133:ref:`SASinstrument`              description of the instrument 
     
    157159        where :math:`\lambda` is the wavelength of the radiation, 
    158160        and :math:`2\theta` is the angle through which the detected radiation has been scattered. 
     161         
     162        .. _Q geometry: 
    159163         
    160164        .. figure:: ../../graphics/Q-geometry.jpg 
     
    203207#. Binary data is not supported 
    204208 
    205  
    206  
    207209.. _axes definition: 
    208210 
  • 1dwg/trunk/doc/source/specification.rst

    r250 r255  
    5454.. index:: element; {any} 
    5555 
    56 Another example is an instance of the :ref:`{any}` 
     56Another example is an instance of the *{any}* 
    5757element.  Suppose one had analysis data, then *{any}* 
    5858would be replaced  
Note: See TracChangeset for help on using the changeset viewer.