Changeset 117


Ignore:
Timestamp:
Sep 27, 2009 11:57:31 AM (10 years ago)
Author:
prjemian
Message:

add the case studies, reformat other things, refs #19

Location:
1dwg/trunk/doc
Files:
3 added
19 edited

Legend:

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

    r95 r117  
    1515    xmlns:xlink="http://www.w3.org/1999/xlink"> 
    1616    <title>Fortran binding</title> 
     17    <bridgehead> 
     18        $Revision$ 
     19        $Date$ 
     20    </bridgehead> 
    1721    <para> 
    1822        The development of the FORTRAN language, so beloved of scientists, pre-dates the development of XML. And it shows. FORTRAN is not a language that manipulates strings with ease, and this makes parsing XML decidedly awkward. So unless you <emphasis>really</emphasis> have to use FORTRAN, you are probably better off with C/C++ (or something else more 'modern'), see for example Daniel Veillard's LIBXML2 library at http://xmlsoft.org/ or Frank van den Berghen's parser at http://www.applied-mathematics.net/tools/xmlParser.html. 
  • 1dwg/trunk/doc/cansas1d_binding_IgorPro.xml

    r103 r117  
    1414    version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink"> 
    1515    <title>IgorPro binding</title> 
     16    <bridgehead> 
     17        $Revision$ 
     18        $Date$ 
     19    </bridgehead> 
    1620    <para>An import tool (binding) for IgorPro has been created (cansasXML.ipf). You can check out 
    1721        the IgorPro working directory from the SVN server (see instructions below). </para> 
  • 1dwg/trunk/doc/cansas1d_binding_Java.xml

    r102 r117  
    1414    version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink"> 
    1515    <title>Java JAXB binding</title> 
     16    <bridgehead> 
     17        $Revision$ 
     18        $Date$ 
     19    </bridgehead> 
    1620    <para> 
    1721        Documentation for the JAXB binding is spotty at this time. 
  • 1dwg/trunk/doc/cansas1d_binding_Python.xml

    r107 r117  
    1414    version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink"> 
    1515    <title>Python binding</title> 
     16    <bridgehead> 
     17        $Revision$ 
     18        $Date$ 
     19    </bridgehead> 
    1620    <para> 
    1721        Specific <link xlink:href="http://danse.us/trac/sans"><citetitle>support</citetitle></link>  
  • 1dwg/trunk/doc/cansas1d_definition_of_terms.xml

    r115 r117  
    1111--> 
    1212<!-- from: http://www.smallangles.net/wgwiki/index.php/cansas1d_cansas1d_definition_of_terms--> 
    13 <section xml:id="cansas1d_documentation-element-cansas1d_definition_of_terms" xmlns="http://docbook.org/ns/docbook" 
    14     version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink"> 
     13<section  
     14    xml:id="cansas1d_documentation-element-cansas1d_definition_of_terms"  
     15    xmlns="http://docbook.org/ns/docbook" 
     16    version="5.0"  
     17    xmlns:xlink="http://www.w3.org/1999/xlink"> 
    1518    <title>Definition of Terms</title> 
    16     <note><para>This Definition of Terms may not be provided in future versions of this manual.</para></note> 
     19    <bridgehead> 
     20        $Revision$ 
     21        $Date$ 
     22    </bridgehead> 
     23    <note><para> 
     24        This Definition of Terms may not be provided in future versions of this manual. 
     25    </para></note> 
    1726    <para> 
    1827        Note: 
     
    2231            Each term (element or attribute) is listed by its  
    2332            <link xlink:href="http://cs:www.w3schools.com/cs:xpath/"><citetitle>XPath</citetitle></link>  
    24             in the XML file. The <literal>cs:</literal> prefix refers to the  
    25             <literal>xmlns</literal> namespace attribute listed in the XML header. 
     33            in the XML file. The <literal>cs:</literal> prefix is defined by a  
     34            <literal>xmlns:cs="cansas1d/1.0"</literal> namespace  
     35            attribute listed in the XML header. 
    2636        </para> 
    2737    </listitem> 
     
    109119                <glossterm><code>/cs:SASroot/cs:SASentry</code></glossterm> 
    110120                <glossdef><para> 
    111                     [1..] A single SAS scan is reported in a SASentry. A SASentry can use the optional "name" attribute to provide a string for this SASentry. Use of this string is not defined by this standard. 
     121                    [1..inf] A single SAS scan is reported in a SASentry. A SASentry can use the optional "name" attribute to provide a string for this SASentry. Use of this string is not defined by this standard. 
    112122                </para></glossdef> 
    113123            </glossentry> 
     
    715725                <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASnote</code></glossterm> 
    716726                <glossdef><para> 
    717                     [1..] Free form description of anything not covered by other elements. 
     727                    [1..inf] Free form description of anything not covered by other elements. 
    718728                </para></glossdef> 
    719729            </glossentry> 
     
    727737                <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASprocess/@name</code></glossterm> 
    728738                <glossdef><para> 
    729                     [0..1] Optional attribute to provide a name for this SASprocess. It is redundant with /cs:SASroot/cs:SASentry/cs:SASprocess/cs:name but it is not the same. It should probably be removed. 
     739                    [0..1] Optional attribute to provide a name for this SASprocess.  
     740                    <note><para> 
     741                        It is redundant with  
     742                        /cs:SASroot/cs:SASentry/cs:SASprocess/cs:name  
     743                        but it is not the same. It should probably be removed. 
     744                    </para></note> 
    730745                </para></glossdef> 
    731746            </glossentry> 
     
    733748                <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASprocess/cs:date</code></glossterm> 
    734749                <glossdef><para> 
    735                     [0..1] Optional date for this data processing or analysis step. *** SHOULD WE SPECIFY THE FORMAT FOR THE DATE? *** 
     750                    [0..1] Optional date for this data processing or analysis step.  
     751                    <note><para> 
     752                        SHOULD WE SPECIFY THE FORMAT FOR THE DATE? 
     753                    </para></note> 
    736754                </para></glossdef> 
    737755            </glossentry> 
     
    757775                <glossterm><code>/cs:SASroot/cs:SASentry/cs:SASprocess/cs:SASprocessnote/&lt;any></code></glossterm> 
    758776                <glossdef><para> 
    759                     [0..inf] Provision at this point for any element to be entered that is not part of the canSAS standard. Use a xmlns="some-simple-identification-string" to identify that this is a foreign element. 
     777                    [0..inf] Provision at this point for any element to be entered that is not part of the canSAS standard.  
     778                    Declare a default namespace declaration such as 
     779                    <code>xmlns="urn:example-namespace:example-context"</code>  
     780                    to identify that this is a foreign element  
     781                    (where you replace "<code>example-namespace</code>"  
     782                    and "<code>example-context</code>" with your own terms). 
    760783                </para></glossdef> 
    761784            </glossentry> 
  • 1dwg/trunk/doc/cansas1d_element_SAScollimation.xml

    r114 r117  
    1414    version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink"> 
    1515    <title>SAScollimation element</title> 
     16    <bridgehead> 
     17        $Revision$ 
     18        $Date$ 
     19    </bridgehead> 
    1620    <figure> 
    1721        <title>The SAScollimation element</title> 
     
    8387                        </entry> 
    8488                        <entry> 
    85                             [0..] 
     89                            [0..inf] 
    8690                        </entry> 
    8791                        <entry> 
  • 1dwg/trunk/doc/cansas1d_element_SASdata.xml

    r114 r117  
    1414    version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink"> 
    1515    <title>SASdata element</title> 
     16    <bridgehead> 
     17        $Revision$ 
     18        $Date$ 
     19    </bridgehead> 
    1620    <figure> 
    1721        <title>The SASdata element</title> 
     
    7781                        </entry> 
    7882                        <entry> 
    79                             [1..] 
     83                            [1..inf] 
    8084                        </entry> 
    8185                        <entry> 
     
    299303                            container 
    300304                        </entry> 
    301                         <entry> [0..] </entry> 
     305                        <entry> [0..inf] </entry> 
    302306                        <entry> 
    303307                            Any element(s) not defined in the cansas1d/1.0 standard can be placed at this point. See ''{any}'' for more details. 
  • 1dwg/trunk/doc/cansas1d_element_SASdetector.xml

    r114 r117  
    1414    version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink"> 
    1515    <title>SASdetector element</title> 
     16    <bridgehead> 
     17        $Revision$ 
     18        $Date$ 
     19    </bridgehead> 
    1620    <figure> 
    1721        <title>The SASdetector element</title> 
  • 1dwg/trunk/doc/cansas1d_element_SASentry.xml

    r114 r117  
    1414    version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink"> 
    1515    <title>SASentry element</title> 
     16    <bridgehead> 
     17        $Revision$ 
     18        $Date$ 
     19    </bridgehead> 
    1620    <figure> 
    1721        <title>The SASentry element</title> 
     
    7983                    </entry> 
    8084                    <entry> 
    81                         [1..] 
     85                        [1..inf] 
    8286                    </entry> 
    8387                    <entry> 
     
    106110                    </entry> 
    107111                    <entry> 
    108                         [0..] 
     112                        [0..inf] 
    109113                    </entry> 
    110114                    <entry> 
     
    125129                    </entry> 
    126130                    <entry> 
    127                         [1..] 
     131                        [1..inf] 
    128132                    </entry> 
    129133                    <entry> 
     
    148152                    </entry> 
    149153                    <entry> 
    150                         [0..] 
     154                        [0..inf] 
    151155                    </entry> 
    152156                    <entry> 
     
    202206                    </entry> 
    203207                    <entry> 
    204                         [0..] 
     208                        [0..inf] 
    205209                    </entry> 
    206210                    <entry> 
     
    221225                    </entry> 
    222226                    <entry> 
    223                         [1..] 
     227                        [1..inf] 
    224228                    </entry> 
    225229                    <entry> 
  • 1dwg/trunk/doc/cansas1d_element_SASinstrument.xml

    r114 r117  
    1414    version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink"> 
    1515    <title>SASinstrument element</title> 
     16    <bridgehead> 
     17        $Revision$ 
     18        $Date$ 
     19    </bridgehead> 
    1620    <figure> 
    1721        <title>The SASinstrument element</title> 
     
    9498                </entry> 
    9599                <entry> 
    96                     [1..] 
     100                    [1..inf] 
    97101                </entry> 
    98102                <entry> 
     
    113117                </entry> 
    114118                <entry> 
    115                     [1..] 
     119                    [1..inf] 
    116120                </entry> 
    117121                <entry> 
  • 1dwg/trunk/doc/cansas1d_element_SASnote.xml

    r114 r117  
    1414    version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink"> 
    1515    <title>SASnote element</title> 
     16    <bridgehead> 
     17        $Revision$ 
     18        $Date$ 
     19    </bridgehead> 
    1620    <figure> 
    1721        <title>The SASroot element</title> 
     
    6064                    </entry> 
    6165                    <entry> 
    62                         [0..] 
     66                        [0..inf] 
    6367                    </entry> 
    6468                    <entry> 
  • 1dwg/trunk/doc/cansas1d_element_SASprocess.xml

    r114 r117  
    1414    version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink"> 
    1515    <title>SASprocess element</title> 
     16    <bridgehead> 
     17        $Revision$ 
     18        $Date$ 
     19    </bridgehead> 
    1620    <figure> 
    1721        <title>The SASprocess element</title> 
     
    114118                    </entry> 
    115119                    <entry> 
    116                         [0..] 
     120                        [0..inf] 
    117121                    </entry> 
    118122                    <entry> 
     
    133137                    </entry> 
    134138                    <entry> 
    135                         [1..] 
     139                        [1..inf] 
    136140                    </entry> 
    137141                    <entry> 
     
    148152                    </entry> 
    149153                    <entry> 
    150                         [0..] 
     154                        [0..inf] 
    151155                    </entry> 
    152156                    <entry> 
     
    188192                        </entry> 
    189193                        <entry> 
    190                             [0..] 
     194                            [0..inf] 
    191195                        </entry> 
    192196                        <entry> 
  • 1dwg/trunk/doc/cansas1d_element_SASroot.xml

    r114 r117  
    1414    version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink"> 
    1515    <title>SASroot element</title> 
     16    <bridgehead> $Revision$ $Date$ </bridgehead> 
    1617    <figure> 
    1718        <title>The SASroot element</title> 
    1819        <mediaobject> 
    1920            <imageobject> 
    20                 <imagedata fileref="../graphics/1-SASroot.png" width="200pt" 
    21                     scalefit="1"/> 
     21                <imagedata fileref="../graphics/1-SASroot.png" width="200pt" scalefit="1"/> 
    2222            </imageobject> 
    2323            <textobject> 
     
    5151                </row> 
    5252                <row> 
    53                     <entry> <emphasis role="bold">SASentry</emphasis> </entry> 
     53                    <entry> 
     54                        <emphasis role="bold">SASentry</emphasis> 
     55                    </entry> 
    5456                    <entry> container </entry> 
    55                     <entry> [1..] </entry> 
    56                     <entry> A single SAS scan is reported in a <emphasis role="bold">SASentry</emphasis>. Include as many 
    57                         <emphasis role="bold">SASentry</emphasis> elements as desired. They may contain related or unrelated 
    58                         data. <emphasis role="bold">name</emphasis> is an optional attribute to 
    59                         provide a string for this <emphasis role="bold">SASentry</emphasis>. (Use of this string is not defined 
    60                         by this standard.) </entry> 
     57                    <entry> [1..inf] </entry> 
     58                    <entry> A single SAS scan is reported in a <emphasis role="bold" 
     59                            >SASentry</emphasis>. Include as many <emphasis role="bold" 
     60                            >SASentry</emphasis> elements as desired. They may contain related or 
     61                        unrelated data. <emphasis role="bold">name</emphasis> is an optional 
     62                        attribute to provide a string for this <emphasis role="bold" 
     63                            >SASentry</emphasis>. (Use of this string is not defined by this 
     64                        standard.) </entry> 
    6165                    <entry> name=short-name </entry> 
    6266                </row> 
  • 1dwg/trunk/doc/cansas1d_element_SASsample.xml

    r114 r117  
    1414    version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink"> 
    1515    <title>SASsample element</title> 
     16    <bridgehead> 
     17        $Revision$ 
     18        $Date$ 
     19    </bridgehead> 
    1620    <figure> 
    1721        <title>The SASsample element</title> 
     
    125129                    </entry> 
    126130                    <entry> string </entry> 
    127                     <entry> [0..] </entry> 
     131                    <entry> [0..inf] </entry> 
    128132                    <entry> Any additional sample details. </entry> 
    129133                    <entry> 
     
    133137                    <entry> '''''{any}''''' </entry> 
    134138                    <entry> container </entry> 
    135                     <entry> [0..] </entry> 
     139                    <entry> [0..inf] </entry> 
    136140                    <entry> Any element(s) not defined in the cansas1d/1.0 standard can be placed at 
    137141                        this point. See ''{any}'' for more details. </entry> 
  • 1dwg/trunk/doc/cansas1d_element_SASsource.xml

    r114 r117  
    1414    version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink"> 
    1515    <title>SASsource element</title> 
     16    <bridgehead> 
     17        $Revision$ 
     18        $Date$ 
     19    </bridgehead> 
    1620    <figure> 
    1721        <title>The SASsource element</title> 
  • 1dwg/trunk/doc/cansas1d_element_XML_header.xml

    r114 r117  
    1414    version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink"> 
    1515    <title>Required XML Header</title> 
     16    <bridgehead> 
     17        $Revision$ 
     18        $Date$ 
     19    </bridgehead> 
    1620    <figure> 
    1721        <title>The SASroot element</title> 
     
    115119        </tgroup> 
    116120    </table> 
    117     <figure> 
    118         <title>Note 1: Required header for canSAS1d/1.0 XML files</title> 
    119         <programlisting>&lt;SASroot version="1.0" 
    120             xmlns="cansas1d/1.0" 
    121             xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    122             xsi:schemaLocation="cansas1d/1.0 http://svn.smallangles.net/svn/canSAS/1dwg/trunk/cansas1d.xsd" 
    123             ></programlisting> 
    124     </figure> 
    125     <figure> 
    126         <title>Note 2: Description of attributes in required header for canSAS1d/1.0 XML files</title> 
    127         <programlisting>version="1.0" 
    128 xmlns="{this-namespace-URI}" 
    129 xmlns:xsi="{URL-of-governing-XML-Schema}" 
    130 xsi:schemaLocation="{this-namespace-URI}  {URL-to-find-XML-Schema}"</programlisting> 
    131     </figure> 
     121    <glossary> 
     122        <glosslist> 
     123            <glossentry> 
     124                <glossterm>Note 1: Required header for canSAS1d/1.0 XML files</glossterm> 
     125                <glossdef> 
     126                    <programlisting>&lt;SASroot version="1.0" 
     127    xmlns="cansas1d/1.0" 
     128    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
     129    xsi:schemaLocation="cansas1d/1.0  
     130        http://svn.smallangles.net/svn/canSAS/1dwg/trunk/cansas1d.xsd"></programlisting> 
     131                </glossdef> 
     132            </glossentry> 
     133            <glossentry> 
     134                <glossterm> 
     135                    Note 2: Description of attributes in required header for canSAS1d/1.0 XML files 
     136                </glossterm> 
     137                <glossdef><programlisting>version="1.0" 
     138     xmlns="{this-namespace-URI}" 
     139     xmlns:xsi="{URL-of-governing-XML-Schema}" 
     140     xsi:schemaLocation="{this-namespace-URI}  {URL-to-find-XML-Schema}"</programlisting></glossdef> 
     141            </glossentry> 
     142        </glosslist> 
     143    </glossary> 
    132144</section> 
  • 1dwg/trunk/doc/cansas1d_element_any.xml

    r114 r117  
    1414    version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink"> 
    1515    <title>''{any}'' element</title> 
     16    <bridgehead> 
     17        $Revision$ 
     18        $Date$ 
     19    </bridgehead> 
    1620    <table orient="port"> 
    1721        <title/> 
     
    3337                    <entry><emphasis role="bold">{any}</emphasis></entry> 
    3438                    <entry> container </entry> 
    35                     <entry> [0..] </entry> 
     39                    <entry> [0..inf] </entry> 
    3640                    <entry> 
    3741                        <para> Any element(s) not defined in the cansas1d/1.0 standard can be placed 
  • 1dwg/trunk/doc/elements.xml

    r113 r117  
    2222            role="italic">occurence</emphasis> column. A value of <emphasis role="italic" 
    2323            >[0..1]</emphasis> indicates the element is optional but may appear one time. A value of 
    24             <emphasis role="italic">[0..]</emphasis> indicates the element is optional but may 
    25         appear as many times as desired (also known as unbounded). </para> 
     24            <emphasis role="italic">[0..inf]</emphasis> indicates the element is optional  
     25            but may appear an infinite number of times (also known as unbounded). </para> 
    2626    <xi:include href="cansas1d_element_XML_Header.xml"/> 
    2727    <xi:include href="cansas1d_element_SASroot.xml"/> 
  • 1dwg/trunk/doc/manual.xml

    r113 r117  
    9393        1D_Data_Formats_Working_Group 
    9494        Talk:1D_Data_Formats_Working_Group 
    95         cansas1d_definition_of_terms 
     95           cansas1d_definition_of_terms 
    9696           cansas1d_XML_header 
    9797           cansas1d_any 
     
    108108    <xi:include href="elements.xml"/> 
    109109    <xi:include href="bindings.xml"/> 
     110    <xi:include href="casestudies.xml"/> 
    110111    <xi:include href="other.xml"/> 
    111112    <!-- 
Note: See TracChangeset for help on using the changeset viewer.