Changeset 257


Ignore:
Timestamp:
Aug 31, 2012 6:39:29 PM (7 years ago)
Author:
prjemian
Message:

refs #24, make the PDF output look better from Sphinx

Location:
1dwg/trunk
Files:
1 added
1 deleted
15 edited

Legend:

Unmodified
Added
Removed
  • 1dwg/trunk/cansas1d.xml

    r233 r257  
    44        xmlns="cansas1d/1.1" 
    55    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    6     xsi:schemaLocation="cansas1d/1.1 http://svn.smallangles.net/svn/canSAS/1dwg/trunk/cansas1d.xsd" 
     6    xsi:schemaLocation="cansas1d/1.1 
     7        http://svn.smallangles.net/svn/canSAS/1dwg/trunk/cansas1d.xsd" 
    78    > 
    89        <SASentry> 
  • 1dwg/trunk/doc/source/binding-fortran.rst

    r250 r257  
    4545 
    4646Steve King[mailto:s.m.king@rl.ac.uk] (ISIS) has provided a F77 routine  
    47 (http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/fortran/SASXML_G77.F)  
    4847that will read cansas1d/1.0 XML files. 
     48 
     49http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/fortran/SASXML_G77.F  
  • 1dwg/trunk/doc/source/binding-java-jaxb.rst

    r253 r257  
    6161 
    6262An example (*Example_canSAS_Reader.java*) has been constructed 
    63 (http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/java/maven/eclipse/src/main/java/org/scatteringsw/reader/Example_canSAS_Reader.java) 
    6463to show how to read a cansas1d/1.1 XML file using the Java API.  
     64 
     65http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/java/maven/eclipse/src/main/java/org/scatteringsw/reader/Example_canSAS_Reader.java 
    6566 
    6667In short, these are the important two lines: 
  • 1dwg/trunk/doc/source/casestudy_collagen.rst

    r244 r257  
    3636 
    3737        *COLLAGEN.ASC* 
     38                raw data file 
     39                 
    3840                http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/examples/collagen/COLLAGEN.ASC 
    3941 
     
    4951 
    5052        *collagen.saxs* 
     53                raw data file 
     54                 
    5155                http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/examples/collagen/collagen.saxs 
    5256         
  • 1dwg/trunk/doc/source/compatibility.rst

    r244 r257  
    1111The translation and orientation geometry used by this canSAS standard are consistent with: 
    1212 
     13.. index:: cartesian 
     14 
    1315**Cartesian** 
    1416        http://en.wikipedia.org/wiki/Cartesian_coordinate_system 
     17 
     18.. index:: right-hand rule 
    1519 
    1620**Right-hand rule** 
  • 1dwg/trunk/doc/source/element_SASdata.rst

    r255 r257  
    5959                                                as defined in the :ref:`rules` section. 
    6060                                                Either *1/A* or *1/nm* are typical units. 
    61 *I*                    float       [1..1]       Intensity of the detected radiation.        *unit={unit}*   [#units]_ 
     61*I*                    float       [1..1]       Intensity of the detected radiation.        *unit={unit}*   [#units]_ [#SAS_I]_ 
    6262                                                as defined in the :ref:`rules` section. 
    6363                                                See the section titled 
     
    6868                                                describes a **differential cross-section  
    6969                                                per unit volume per unit solid angle**. 
    70                                                  
    71                                                 .. note:: Because there are several 
    72                                                     different ways to describe the SAS  
    73                                                     intensity,  One should be very  
    74                                                     careful to inspect the *unit*  
    75                                                     attribute to determine how to handle  
    76                                                     subsequent data processing,  
    77                                                     especially in the area of units  
    78                                                     conversion. 
    7970*Idev*                 float       [0..1]       Estimated uncertainty (usually standard     *unit={unit}*   [#units]_ 
    8071                                                deviation) of *I*. [#optional]_ 
    8172                                                It is unexpected for *I* and *Idev* 
    8273                                                to have different units. 
    83 *Qdev*                 float       [0..1]       Estimated uncertainty (usually standard     *unit={unit}*   [#units]_ 
     74*Qdev*                 float       [0..1]       Estimated uncertainty (usually standard     *unit={unit}*   [#units]_ [#either]_ 
    8475                                                deviation) of *Q*. [#optional]_ 
    8576                                                It is unexpected for *Q* and *Qdev* 
    8677                                                to have different units. 
    87                                                  
    88                                                 .. note:: If either *dQw* or *dQl*  
    89                                                     are used, then *Qdev* is not  
    90                                                     permitted to be used. 
    91 *dQw*                  float       [0..1]       :math:`Q` resolution along the axis of      *unit={unit}*   [#units]_ 
     78*dQw*                  float       [0..1]       :math:`Q` resolution along the axis of      *unit={unit}*   [#units]_ [#either]_ 
    9279                                                scanning (the high-resolution  
    9380                                                *slit width* direction). Useful for  
     
    9784                                                It is unexpected for *Q* and *dQw* 
    9885                                                to have different units. 
    99                                                  
    100                                                 .. note:: If either *dQw* or *dQl*  
    101                                                     are used, then *Qdev* is not  
    102                                                     permitted to be used. 
    103 *dQl*                  float       [0..1]       :math:`Q` resolution perpendicular to       *unit={unit}*   [#units]_ 
     86*dQl*                  float       [0..1]       :math:`Q` resolution perpendicular to       *unit={unit}*   [#units]_ [#either]_ 
    10487                                                the axis of scanning (the low-resolution  
    10588                                                *slit length* direction). Useful for  
     
    10992                                                It is unexpected for *Q* and *dQl* 
    11093                                                to have different units. 
    111                                                  
    112                                                 .. note:: If either *dQw* or *dQl*  
    113                                                     are used, then *Qdev* is not  
    114                                                     permitted to be used. 
    11594*Qmean*                float       [0..1]       Mean value of :math:`Q` for this data       *unit={unit}*   [#units]_ 
    11695                                                point. [#optional]_ 
     
    122101*Shadowfactor*         float       [0..1]       A numerical factor applied to pixels 
    123102                                                affected by the beam stop penumbra. 
    124                                                 [#optional]_ 
    125                                                  
    126                                                 .. note:: The *Shadowfactor* 
    127                                                     is used in data files from NIST/NCNR  
    128                                                     instruments.  Contact NIST/NCNR  
    129                                                     for more information. 
     103                                                [#optional]_  [#shadow]_  
    130104:ref:`{any}`           container   [0..inf]     Any element(s) not defined in the           *xmlns:{foreign-prefix}={foreign-namespace}* 
    131105                                                cansas1d/1.1 standard can be placed at  
     
    137111.. rubric:: Table Notes 
    138112 
    139 ..  [#units] The *unit* attribute is required.  
     113.. [#units] The *unit* attribute is required.  
    140114        See :ref:`rules` for acceptable values. 
    141 ..  [#optional] When an optional element (such as *Idev*, *Qdev*, ...) is used,  
    142         it must be used in every *Idata* within the enclosing *SASdata*. 
     115.. [#SAS_I] Because there are several different ways to describe the SAS  
     116        intensity,  One should be very careful to inspect the *unit*  
     117        attribute to determine how to handle subsequent data processing,  
     118        especially in the area of units conversion. 
     119.. [#optional] When an optional element (such as *Idev*, *Qdev*, ...) is used,  
     120        it **must** be used in every *Idata* within the enclosing *SASdata*. 
     121.. [#either] If either *dQw* or *dQl* are used,  
     122        then *Qdev* is not permitted to be used. 
     123.. [#shadow] The *Shadowfactor* is used in data files from NIST/NCNR  
     124        instruments.  Contact NIST/NCNR for more information. 
  • 1dwg/trunk/doc/source/element_SASentry.rst

    r255 r257  
    1212        :ref:`SASroot` 
    1313 
    14 .. figure:: ../../graphics/1-SASroot.png 
    15      
    16     The *SASentry* element 
     14Refer to the figure in :ref:`SASroot`. 
    1715 
    1816.. index:: 
  • 1dwg/trunk/doc/source/index.rst

    r255 r257  
    1111is based on XML. 
    1212 
    13 Objective 
    14 ============ 
     13.. rubric:: Objective 
    1514 
    1615One of the first aims of the **canSAS** (Collective Action for  
     
    3938   :maxdepth: 2 
    4039    
    41    manual 
     40   preface 
     41   specification 
     42   tutorial 
     43   case-studies 
     44   examples 
     45   bindings 
     46   intensity-problem 
     47   xml-help 
    4248   downloads 
  • 1dwg/trunk/doc/source/overview.rst

    r255 r257  
    9292                xmlns="cansas1d/1.1" 
    9393                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    94                 xsi:schemaLocation="cansas1d/1.1 http://svn.smallangles.net/svn/canSAS/1dwg/trunk/cansas1d.xsd" 
     94                xsi:schemaLocation="cansas1d/1.1 
     95                    http://svn.smallangles.net/svn/canSAS/1dwg/trunk/cansas1d.xsd" 
    9596                > 
    9697 
     
    154155 
    155156#. A cansas1d/1.1 XML data files will adhere to the standard if it can 
    156         successfully :ref:`validate` against the established XML Schema.  
    157         (http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/cansas1d.xsd) 
     157        successfully :ref:`validate <validate>` against the established XML Schema. 
     158          
     159        http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/cansas1d.xsd 
    158160#. :math:`Q=(4 \pi / \lambda) \sin(\theta)` 
    159161        where :math:`\lambda` is the wavelength of the radiation, 
     
    221223        element; z 
    222224 
    223 +------------------------------------------------------------------+--------------------------------------------------------------------+ 
    224 | view from source                                                 | view from detector                                                 | 
    225 +==================================================================+====================================================================+ 
    226 | .. figure:: ../../graphics/translation-orientation-geometry.jpg  | .. figure:: ../../graphics/translation-orientation-geometry-2.jpg  | 
    227 |     :alt: view from source                                       |     :alt:                                                          | 
    228 |     :width: 350 px                                               |     :width: 350 px                                                 | 
    229 +------------------------------------------------------------------+--------------------------------------------------------------------+ 
    230  
     225.. figure:: ../../graphics/translation-orientation-geometry.jpg 
     226    :alt: view from source                                      
     227    :width: 350 px       
     228     
     229    Coordinate axes as viewed from the source. 
     230 
     231.. figure:: ../../graphics/translation-orientation-geometry-2.jpg 
     232    :alt:                                                  
     233    :width: 350 px 
     234     
     235    Coordinate axes as viewed from the detector. 
     236                                   
    231237 
    232238 
     
    271277validate any XML file for adherence to the format. 
    272278 
    273         TRAC (view source code highlighted by bug tracking system) 
     279        TRAC  
     280                (view source code highlighted by bug tracking system) 
     281                 
    274282                http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/cansas1d.xsd 
    275283 
    276         SVN (view raw source code from version control system) 
     284        SVN  
     285                (view raw source code from version control system) 
     286                 
    277287                http://svn.smallangles.net/svn/canSAS/1dwg/trunk/cansas1d.xsd 
    278288 
     
    290300(with the added XML support in Excel).  
    291301 
    292 .. tip:: See the excellent write-up by Steve King, ISIS,  
    293         (http://www.isis.rl.ac.uk/archive/LargeScale/LOQ/xml/cansas_xml_format.pdf) 
    294         for an example. 
     302.. tip:: See the excellent write-up by Steve King, ISIS, for an example. 
     303 
     304        http://www.isis.rl.ac.uk/archive/LargeScale/LOQ/xml/cansas_xml_format.pdf 
     305         
    295306 
    296307By default, MS Windows binds *.xml* files to start 
     
    412423**multiple data sets** 
    413424        ISIS LOQ SANS instrument:  
     425         
    414426        http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/W1W2.XML 
    415427 
     
    418430**multiple samples, multiple data sets** 
    419431        AF1410 steel SANS contrast variation study from NIST: 
     432         
    420433        http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/examples/af1410/cs_af1410.xml 
    421434         
  • 1dwg/trunk/doc/source/preface.rst

    r244 r257  
    3939 
    4040The home page of the canSAS 1D Data Formats Working Group  
    41 (http://www.smallangles.net/wgwiki/index.php/1D_Data_Formats_Working_Group) 
    4241describes the members, timelines, and current status. 
    43 There is a discussion  
    44 (http://www.smallangles.net/wgwiki/index.php/Talk:1D_Data_Formats_Working_Group) 
    45 page for some matters that preceded this revision. 
     42There is a discussion page for some matters that preceded this revision. 
     43 
     44Home: 
     45        http://www.smallangles.net/wgwiki/index.php/1D_Data_Formats_Working_Group 
     46Discussion: 
     47        http://www.smallangles.net/wgwiki/index.php/Talk:1D_Data_Formats_Working_Group 
    4648 
    4749----------------- 
  • 1dwg/trunk/doc/src/ascii3col.xsl

    r243 r257  
    44xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    55xmlns:cs="cansas1d/1.1" 
    6 xsi:schemaLocation="cansas1d/1.1 http://svn.smallangles.net/svn/canSAS/1dwg/trunk/cansas1d.xsd"> 
     6xsi:schemaLocation="cansas1d/1.1 
     7    http://svn.smallangles.net/svn/canSAS/1dwg/trunk/cansas1d.xsd"> 
    78 
    89<xsl:template match="/"> 
  • 1dwg/trunk/doc/src/brief-sketch-multiple.xml

    r233 r257  
    44      xmlns="cansas1d/1.1" 
    55      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    6       xsi:schemaLocation="cansas1d/1.1 http://svn.smallangles.net/svn/canSAS/1dwg/trunk/cansas1d.xsd" 
     6      xsi:schemaLocation="cansas1d/1.1  
     7          http://svn.smallangles.net/svn/canSAS/1dwg/trunk/cansas1d.xsd" 
    78      > 
    89     <!--  
  • 1dwg/trunk/doc/src/data-simple.xml

    r244 r257  
    44        xmlns="cansas1d/1.1" 
    55        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    6         xsi:schemaLocation="cansas1d/1.1 http://svn.smallangles.net/svn/canSAS/1dwg/trunk/cansas1d.xsd" 
     6        xsi:schemaLocation="cansas1d/1.1 
     7            http://svn.smallangles.net/svn/canSAS/1dwg/trunk/cansas1d.xsd" 
    78        > 
    89        <SASentry> 
  • 1dwg/trunk/doc/src/example-collagen-predata.xml

    r233 r257  
    44    xmlns="cansas1d/1.1" 
    55    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    6     xsi:schemaLocation="cansas1d/1.1 http://svn.smallangles.net/svn/canSAS/1dwg/trunk/cansas1d.xsd" 
     6    xsi:schemaLocation="cansas1d/1.1 
     7        http://svn.smallangles.net/svn/canSAS/1dwg/trunk/cansas1d.xsd" 
    78    > 
    89    <SASentry> 
  • 1dwg/trunk/doc/src/java-test.xml

    r252 r257  
    1313    xmlns="cansas1d/1.1" 
    1414    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    15     xsi:schemaLocation="cansas1d/1.1 http://svn.smallangles.net/svn/canSAS/1dwg/trunk/cansas1d.xsd" 
     15    xsi:schemaLocation="cansas1d/1.1 
     16        http://svn.smallangles.net/svn/canSAS/1dwg/trunk/cansas1d.xsd" 
    1617    > 
    1718    <SASentry> 
Note: See TracChangeset for help on using the changeset viewer.