Changeset 134


Ignore:
Timestamp:
Oct 8, 2009 3:53:21 PM (10 years ago)
Author:
prjemian
Message:

move the "elements" section, rename "definitions of terms" to "glossary," more cross-references, formatting, & indices, refs #19

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

Legend:

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

    r132 r134  
    6060        <glossentry> 
    6161            <glossterm>purpose</glossterm> 
    62             <glossdef><para>implement an IgorPro file reader to read the canSAS 1-D reduced SAS 
    63                 data in XML files adheres to the cansas1d/1.0 standard: 
    64                 http://www.smallangles.net/wgwiki/index.php/cansas1d_documentation</para></glossdef> 
     62            <glossdef><para>Implement an IgorPro file reader to read the canSAS 1-D reduced SAS 
     63                data in XML files that adhere to the cansas1d/1.0 standard.</para></glossdef> 
    6564        </glossentry> 
    6665        <glossentry> 
  • 1dwg/trunk/doc/src/cansas1d_binding_Java.xml

    r130 r134  
    3636            </listitem> 
    3737            <listitem> 
    38                 <para>Answer : Java Architecture for XML Binding (JAXB): 
    39                     http://java.sun.com/developer/technicalArticles/WebServices/jaxb/</para> 
     38                <para>Answer :  
     39                    <link xlink:href="http://java.sun.com/developer/technicalArticles/WebServices/jaxb/" 
     40                        >Java Architecture for XML Binding (JAXB)</link>: 
     41                    <footnote><para> 
     42                        <link xlink:href="http://java.sun.com/developer/technicalArticles/WebServices/jaxb/" 
     43                        ><literal>http://java.sun.com/developer/technicalArticles/WebServices/jaxb/</literal></link></para></footnote> 
     44                    </para> 
    4045            </listitem> 
    4146            <listitem> 
     
    4348            </listitem> 
    4449            <listitem> 
    45                 <para>Answer : Ask Google. JAXB is for Java. One good advisory page: 
    46                     http://www.devx.com/ibm/Article/20261</para> 
     50                <para>Answer : Ask Google. JAXB is for Java. 
     51                    (<link xlink:href="http://java.sun.com/developer/technicalArticles/WebServices/jaxb/" 
     52                        >example</link>) 
     53                    <footnote><para> 
     54                        <link xlink:href="http://www.devx.com/ibm/Article/20261" 
     55                            ><literal>http://www.devx.com/ibm/Article/20261</literal></link></para></footnote> 
     56                </para> 
    4757            </listitem> 
    4858            <listitem> 
     
    5767        <title>JAXB_cansas1d_reader.java: example usage in JAVA</title> 
    5868        <para> 
    59             Here is a Java class that shows how to use the JAXB binding.Use this with any of the test data supplied with the cansas-1d-standard directory (above).By default, it shows what is in the <emphasis>1998spheres.xml</emphasis> example file: two samples.(You'll have to get the directory paths right until this documentation improves.) 
     69            Here is a Java class that shows how to use the JAXB binding. 
     70            Use this with any of the test data supplied with the cansas-1d-standard directory (above). 
     71            By default, it shows what is in the <emphasis>1998spheres.xml</emphasis> example file: two samples. 
     72            (You'll have to get the directory paths right until this documentation improves.) 
    6073        </para> 
    6174        <programlisting language="java" linenumbering="numbered"><textobject><textdata 
     
    6578        <title>example: how to retrieve I(Q)</title> 
    6679        <para> 
    67             Look for the line that has <emphasis role="bold">Qsas[i] = sdt.getIdata().get(i).getQ().getValue();</emphasis> to see the operations to unwind the data into usable double[] vectors. Pretty straightforward. 
     80            Look for the line that has  
     81            <literal>Qsas[i] = sdt.getIdata().get(i).getQ().getValue();</literal>  
     82            to see the operations to unwind the data into usable double[] vectors.  
     83            Pretty straightforward. 
    6884        </para> 
    6985        <itemizedlist> 
  • 1dwg/trunk/doc/src/cansas1d_definition_of_terms.xml

    r130 r134  
    1616    version="5.0"  
    1717    xmlns:xlink="http://www.w3.org/1999/xlink"> 
    18     <title>Definition of Terms</title> 
     18    <title>Glossary</title> 
    1919    <bridgehead> 
    2020        $Revision$ 
     
    2222    </bridgehead> 
    2323    <note> 
    24         <para> This Definition of Terms  
    25             may not be provided in future versions of this manual. </para></note> 
     24        <para> This Glossary  
     25            might not be provided in future versions of this manual. </para></note> 
    2626    <para> 
    2727        This section provides a glossary  
    28         <indexterm><primary>glossary</primary></indexterm>  
    29         <indexterm><primary>definition of terms</primary></indexterm> 
     28        <indexterm><primary>glossary</primary></indexterm> 
     29        <!--<indexterm><primary>definition of terms</primary><see>glossary</see></indexterm>--> 
    3030        defining the details about each specific field (XPath string,  
    3131        XML elements and attributes) in the cansas1d/1.0 standard.<indexterm><primary>cansas1d/1.0 standard</primary></indexterm>  
  • 1dwg/trunk/doc/src/elements.xml

    r132 r134  
    22<?oxygen RNGSchema="http://www.oasis-open.org/docbook/xml/5.0/rng/docbook.rng" type="xml"?> 
    33<!--  
    4     ########### SVN repository information ################### 
    5     # $Date$ 
    6     # $Author$ 
    7     # $Revision$ 
    8     # $HeadURL$ 
    9     # $Id$ 
    10     ########### SVN repository information ################### 
     4########### SVN repository information ################### 
     5# $Date$ 
     6# $Author$ 
     7# $Revision$ 
     8# $HeadURL$ 
     9# $Id$ 
     10########### SVN repository information ################### 
    1111--> 
    12 <chapter xml:id="wiki-elements" xmlns="http://docbook.org/ns/docbook" version="5.0" 
     12<section xml:id="wiki-elements" 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>Elements of the canSAS XML standard</title> 
     
    1818        Each of these is described below. 
    1919    </para> 
    20     <para> The <emphasis role="italic">Name</emphasis> is the XML tag to be used for this element of the standard.  
    21     </para> 
    22     <para> The <emphasis role="italic">Type</emphasis> may be a  
    23         <emphasis role="italic">container</emphasis>,  
    24         <emphasis role="italic">header</emphasis>, 
    25         or <emphasis role="italic">floating-point number</emphasis>, 
    26         or <emphasis role="italic">string</emphasis>.  
    27     </para> 
    28     <para> 
    29         Elements of type <emphasis role="italic">container</emphasis>  
    30         have subelements but no text for themselves.  
    31         These are similar to the NeXus NXDL <literal>group</literal> type. 
    32     </para> 
    33     <para> 
    34         Elements of type <emphasis role="italic">floating-point number</emphasis>  
    35         are obvious.  In most cases, a <literal>unit</literal> attribute 
    36         is required.  This will be noted. 
    37     </para> 
    38     <para> 
    39         Elements of type <emphasis role="italic">string</emphasis>  
    40         are any valid string (non-whitespace) sequence. 
    41     </para> 
    42     <para> 
    43         Elements of type <emphasis role="italic">header</emphasis>  
    44         describe the required XML header lines.  Use them without question. 
    45     </para> 
    46     <para>The number of times a particular element may appear is described in the <emphasis 
    47             role="italic">occurence</emphasis> column. A value of <emphasis role="italic" 
    48             >[0..1]</emphasis> indicates the element is optional but may appear one time. A value of 
    49             <emphasis role="italic">[0..inf]</emphasis> indicates the element is optional  
    50             but may appear an infinite number of times (also known as unbounded). </para> 
     20    <glosslist> 
     21        <glossentry> 
     22            <glossterm>Name</glossterm> 
     23            <glossdef><para><emphasis role="italic">Name</emphasis> is the XML tag to be used for this element of the standard.</para></glossdef> 
     24        </glossentry> 
     25        <glossentry> 
     26            <glossterm>Type</glossterm> 
     27            <glossdef> 
     28                <para> 
     29                    <emphasis role="italic">Type</emphasis> may be either of 
     30                    <glosslist> 
     31                        <glossentry> 
     32                            <glossterm><emphasis role="italic">header</emphasis></glossterm> 
     33                            <glossdef> 
     34                                <para> 
     35                                    Elements of type <emphasis role="italic">header</emphasis>  
     36                                    describe the required XML header lines.  Use them without question. 
     37                                </para> 
     38                            </glossdef> 
     39                        </glossentry> 
     40                        <glossentry> 
     41                            <glossterm><emphasis role="italic">container</emphasis></glossterm> 
     42                            <glossdef> 
     43                                <para> 
     44                                    Elements of type <emphasis role="italic">container</emphasis>  
     45                                    have subelements but no text for themselves.  
     46                                    These are similar to the NeXus NXDL <literal>group</literal> type. 
     47                                </para> 
     48                            </glossdef> 
     49                        </glossentry> 
     50                        <glossentry> 
     51                            <glossterm><emphasis role="italic">floating-point number</emphasis></glossterm> 
     52                            <glossdef> 
     53                                <para> 
     54                                    Elements of type <emphasis role="italic">floating-point number</emphasis>  
     55                                    are obvious.  In most cases, a <literal>unit</literal> attribute 
     56                                    is required.  This will be noted. 
     57                                </para> 
     58                            </glossdef> 
     59                        </glossentry> 
     60                        <glossentry> 
     61                            <glossterm><emphasis role="italic">string</emphasis></glossterm> 
     62                            <glossdef> 
     63                                <para> 
     64                                    Elements of type <emphasis role="italic">string</emphasis>  
     65                                    are any valid string (non-whitespace) sequence. 
     66                                </para> 
     67                            </glossdef> 
     68                        </glossentry> 
     69                    </glosslist> 
     70                </para> 
     71            </glossdef> 
     72        </glossentry> 
     73        <glossentry> 
     74            <glossterm>Occurence</glossterm> 
     75            <glossdef><para>The number of times a particular element may appear is described in the <emphasis 
     76                role="italic">occurence</emphasis> column. A value of <emphasis role="italic" 
     77                    >[0..1]</emphasis> indicates the element is optional but may appear one time. A value of 
     78                <emphasis role="italic">[0..inf]</emphasis> indicates the element is optional  
     79                but may appear an infinite number of times (also known as unbounded). </para></glossdef> 
     80        </glossentry> 
     81        <glossentry> 
     82            <glossterm>Description</glossterm> 
     83            <glossdef> 
     84                <para> 
     85                    <emphasis role="italic">Description</emphasis> provides useful information about this element. 
     86                </para> 
     87            </glossdef> 
     88        </glossentry> 
     89        <glossentry> 
     90            <glossterm>Attributes</glossterm> 
     91            <glossdef> 
     92                <para> 
     93                    <emphasis role="italic">Attributes</emphasis> 
     94                    <indexterm><primary>XML</primary><secondary>attributes</secondary></indexterm> 
     95                    list the required or optional attributes of this element.  Note that attributes must 
     96                    adhere to the well-formed XML guidelines 
     97                    <programlisting>attributename="value"</programlisting> 
     98                    where either single or double quotes surround the value.   
     99                    All attributes must have a value. 
     100                </para> 
     101            </glossdef> 
     102        </glossentry> 
     103    </glosslist> 
     104 
    51105    <xi:include href="cansas1d_element_XML_header.xml"/> 
    52106    <xi:include href="cansas1d_element_SASroot.xml"/> 
     
    61115    <xi:include href="cansas1d_element_SASnote.xml"/> 
    62116    <xi:include href="cansas1d_element_any.xml"/> 
    63 </chapter> 
     117</section> 
  • 1dwg/trunk/doc/src/manual.xml

    r132 r134  
    5757    <xi:include href="specification.xml"/> 
    5858    <xi:include href="tutorial.xml"/> 
    59     <xi:include href="elements.xml"/> 
    6059    <xi:include href="bindings.xml"/> 
    6160    <xi:include href="casestudies.xml"/> 
  • 1dwg/trunk/doc/src/other.xml

    r130 r134  
    22<?oxygen RNGSchema="http://www.oasis-open.org/docbook/xml/5.0/rng/docbook.rng" type="xml"?> 
    33<!--  
    4     ########### SVN repository information ################### 
    5     # $Date$ 
    6     # $Author$ 
    7     # $Revision$ 
    8     # $HeadURL$ 
    9     # $Id$ 
    10     ########### SVN repository information ################### 
     4########### SVN repository information ################### 
     5# $Date$ 
     6# $Author$ 
     7# $Revision$ 
     8# $HeadURL$ 
     9# $Id$ 
     10########### SVN repository information ################### 
    1111--> 
    1212<chapter xml:id="wiki-other" xmlns="http://docbook.org/ns/docbook" version="5.0" 
     
    6161        <title>Example XML Stylesheets</title> 
    6262        <para> 
    63             This section presents several examples of XML Stylesheets. 
     63            This section presents examples of XML Stylesheets  
     64            <indexterm> 
     65                <primary>XML Stylesheet</primary> 
     66            </indexterm> 
     67            useful for the cansas1d/1.0 standard.   
     68            XML Stylesheets (XSLT)  
     69            <indexterm> 
     70                <primary>XSLT</primary> 
     71                <see>XML Stylesheet</see> 
     72            </indexterm> 
     73            are used to transform XML documents into  
     74            other documents such as XML documents, xhtml documents, or even ASCII text. 
     75            XML stylesheets also can be used to extract metadata from XML files. 
    6476            <indexterm> 
    6577                <primary>XML Stylesheet</primary> 
  • 1dwg/trunk/doc/src/preface.xml

    r132 r134  
    2424    <note><para> 
    2525        Provide a note here describing canSAS and the initiative to establish 
    26         a standard file format.  Note that the data files must adhere to the  
    27         XML rules which includes being well-formed (including the use of closing tags).   
    28          
     26        a standard file format.  Note that the cansas1d/1.0 XML data files must adhere to the  
     27        XML rules which includes being well-formed 
     28        <indexterm><primary>XML</primary><secondary>well-formed</secondary></indexterm> 
     29        (including the use of closing tags).   
    2930        <footnote> 
    3031            <para> 
    3132                For example, see  
    32                 <literal>http://www.w3schools.com/xmL/xml_syntax.asp</literal> 
     33                <link xlink:href="http://www.w3schools.com/xmL/xml_syntax.asp" 
     34                    ><literal>http://www.w3schools.com/xmL/xml_syntax.asp</literal></link> 
    3335                for an explanation of the XML syntax. 
    3436            </para> 
    3537        </footnote> 
    3638        Files that can be validated  
    37         against <link 
     39        <indexterm><primary>cansas1d/1.0 standard</primary></indexterm> 
     40        <indexterm><primary>validation</primary></indexterm> 
     41        against  
     42        <link 
    3843            xlink:href="http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/cansas1d.xsd" 
    3944            ><literal>cansas1d.xsd</literal> </link> 
     
    4146    </para></note> 
    4247    <para> 
    43         The name "<emphasis role="italic">canSAS</emphasis>" 
     48        The name <emphasis role="italic">canSAS</emphasis> 
    4449        <indexterm><primary>canSAS</primary></indexterm> 
    45         stands for "Collective Action for Nomadic Small-Angle Scatterers. 
     50        stands for  
     51        <emphasis role="italic">Collective Action for Nomadic Small-Angle Scatterers</emphasis>. 
    4652    </para> 
    4753    <para> 
     
    5763            xlink:href="http://www.smallangles.net/wgwiki/index.php/1D_Data_Formats_Working_Group" 
    5864            >canSAS 1D Data Formats Working Group</link 
    59         ><footnote><para>http://www.smallangles.net/wgwiki/index.php/1D_Data_Formats_Working_Group</para></footnote> 
     65        ><footnote><para><link  
     66            xlink:href="http://www.smallangles.net/wgwiki/index.php/1D_Data_Formats_Working_Group" 
     67            ><literal>http://www.smallangles.net/wgwiki/index.php/1D_Data_Formats_Working_Group</literal></link 
     68            ></para></footnote> 
    6069        describes the members, timelines, and current status. 
    6170        There is a  
    6271        <link  
    6372            xlink:href="http://www.smallangles.net/wgwiki/index.php/Talk:1D_Data_Formats_Working_Group" 
    64             >discussion</link><footnote><para>http://www.smallangles.net/wgwiki/index.php/Talk:1D_Data_Formats_Working_Group</para></footnote>    
     73            >discussion</link> 
     74        <footnote><para><link  
     75            xlink:href="http://www.smallangles.net/wgwiki/index.php/Talk:1D_Data_Formats_Working_Group" 
     76            ><literal>http://www.smallangles.net/wgwiki/index.php/Talk:1D_Data_Formats_Working_Group</literal></link></para></footnote>    
    6577        page for some matters that preceded this revision. 
    6678    </para> 
     
    7082            the structure of 
    7183            the XML files and to define the spelling of the terms to be used.  
    72             However, should the information in this document and the <link 
     84            However, should the information in this document and the  
     85            <link 
    7386                xlink:href="http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/cansas1d.xsd" 
    7487                >cansas1d/1.0 SAS XML Schema</link> 
    75             <footnote><para>http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/cansas1d.xsd</para></footnote> 
     88            <footnote><para><link 
     89                xlink:href="http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/cansas1d.xsd" 
     90                ><literal>http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/cansas1d.xsd</literal></link></para></footnote> 
    7691            differ, the XML Schema will be deemed to have the most correct description of the standard.</para> 
    7792    </section> 
  • 1dwg/trunk/doc/src/specification.xml

    r132 r134  
    2222        <link xlink:href="http://www.w3.org/XML/Schema">XML Schema</link>. 
    2323    </para> 
     24    <para> 
     25        Note that the cansas1d/1.0 XML data files must adhere to the  
     26        XML rules which includes being well-formed 
     27        <indexterm><primary>XML</primary><secondary>well-formed</secondary></indexterm> 
     28        (including the use of closing tags).   
     29        <footnote> 
     30            <para> 
     31                For example, see  
     32                <link xlink:href="http://www.w3schools.com/xmL/xml_syntax.asp" 
     33                    ><literal>http://www.w3schools.com/xmL/xml_syntax.asp</literal></link> 
     34                for an explanation of the XML syntax. 
     35            </para> 
     36        </footnote> 
     37        Files that can be validated  
     38        <indexterm><primary>cansas1d/1.0 standard</primary></indexterm> 
     39        <indexterm><primary>validation</primary></indexterm> 
     40        against  
     41        <link 
     42            xlink:href="http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/cansas1d.xsd" 
     43            ><literal>cansas1d.xsd</literal> </link> 
     44        are deemed to be valid cansas1d/1.0 data files. 
     45    </para> 
    2446    <note><para>More needs to be written here.</para></note> 
     47 
     48 
     49    <xi:include href="elements.xml"/> 
    2550</chapter> 
  • 1dwg/trunk/doc/src/wiki.xml

    r132 r134  
    22<?oxygen RNGSchema="http://www.oasis-open.org/docbook/xml/5.0/rng/docbook.rng" type="xml"?> 
    33<!--  
    4     ########### SVN repository information ################### 
    5     # $Date$ 
    6     # $Author$ 
    7     # $Revision$ 
    8     # $HeadURL$ 
    9     # $Id$ 
    10     ########### SVN repository information ################### 
     4########### SVN repository information ################### 
     5# $Date$ 
     6# $Author$ 
     7# $Revision$ 
     8# $HeadURL$ 
     9# $Id$ 
     10########### SVN repository information ################### 
    1111--> 
    1212<chapter xml:id="wiki-chapter" xmlns="http://docbook.org/ns/docbook" version="5.0" 
    1313    xmlns:xlink="http://www.w3.org/1999/xlink"> 
    14     <title>Wiki Manual</title> 
     14    <title>Overview</title> 
    1515    <!-- from: http://www.smallangles.net/wgwiki/index.php/cansas1d_documentation --> 
    1616    <section xml:id="cansas1d_documentation-Objective"> 
    1717        <title>Objective</title> 
    18         <para>One of the first aims of the canSAS 
     18        <para>One of the first aims of the <emphasis role="bold">canSAS</emphasis> 
    1919            <indexterm><primary>canSAS</primary></indexterm> 
    2020            (Collective Action for Nomadic Small-Angle Scatterers)  
    2121            forum of users, software developers, and facility staff was to discuss 
    22             better sharing of SAS data analysis software. <link 
    23                 xlink:href="http://www.smallangles.net/canSAS">CanSAS</link> 
    24             <footnote><para>http://www.smallangles.net/canSAS</para></footnote> 
     22            better sharing of SAS data analysis software. The <link 
     23                xlink:href="http://www.smallangles.net/canSAS">canSAS</link> 
     24            <footnote><para> 
     25                <link xlink:href="http://www.smallangles.net/canSAS" 
     26                    ><literal>http://www.smallangles.net/canSAS</literal></link></para></footnote> 
    2527            identified that a significant need within the SAS 
    2628            community can be satisfied by a robust, self-describing, text-based, standard format to 
    27             communicate reduced one-dimensional small-angle scattering data, ''I(Q)'', between users 
     29            communicate reduced one-dimensional small-angle scattering data, <literal>I(Q)</literal>, between users 
    2830            of our facilities. Our goal has been to define such a format that leaves the data file 
    2931            instantly human-readable, editable in the simplest of editors, and importable by simple 
     
    7375                <footnote> 
    7476                    <para> 
    75                         http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/cansas1d.xml 
     77                        <link xlink:href="http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/cansas1d.xml" 
     78                            ><literal>http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/cansas1d.xml</literal></link> 
    7679                    </para> 
    7780                </footnote> 
     
    8386                <footnote> 
    8487                    <para> 
    85                         http://www.smallangles.net/wgwiki/index.php/1D_Data_Formats_Working_Group 
     88                        <link xlink:href="http://www.smallangles.net/wgwiki/index.php/1D_Data_Formats_Working_Group" 
     89                            ><literal>http://www.smallangles.net/wgwiki/index.php/1D_Data_Formats_Working_Group</literal></link> 
    8690                    </para> 
    8791                </footnote> 
     
    9296                <footnote> 
    9397                    <para> 
    94                         http://www.smallangles.net/wgwiki/index.php/Talk:1D_Data_Formats_Working_Group 
     98                        <link xlink:href="http://www.smallangles.net/wgwiki/index.php/Talk:1D_Data_Formats_Working_Group" 
     99                            ><literal>http://www.smallangles.net/wgwiki/index.php/Talk:1D_Data_Formats_Working_Group</literal></link> 
    95100                    </para> 
    96101                </footnote> 
     
    99104                    xlink:href="#cansas1d_documentation-Documentation-Definitions" 
    100105                    >glossary</link> 
    101                 <indexterm><primary>glossary</primary><see>definition of terms</see></indexterm> 
     106                <indexterm><primary>glossary</primary></indexterm> 
    102107                defining the details about each specific field (XPath string, XML elements and attributes) is provided. 
    103108                </para> 
     
    127132                </listitem> 
    128133                <listitem> 
    129                     <para> block diagrams </para> 
     134                    <para> block diagrams  
     135                    <warning><para>!!!Need some help here!!!</para></warning> 
     136                    </para> 
    130137                </listitem> 
    131138                <listitem> 
     
    139146                </listitem> 
    140147                <listitem> 
    141                     <para> Definition of terms: Details about each specific field (XPath string, XML 
     148                    <para> Glossary: Details about each specific field (XPath string, XML 
    142149                        elements and attributes) </para> 
    143150                </listitem> 
     
    485492            <itemizedlist> 
    486493                <listitem> 
    487                     <para>http://en.wikipedia.org/wiki/Cartesian_coordinate_system</para> 
    488                 </listitem> 
    489                 <listitem> 
    490                     <para>http://en.wikipedia.org/wiki/Right-hand_rule</para> 
    491                 </listitem> 
    492                 <listitem> 
    493                     <para>http://www.nexusformat.org/Coordinate_Systems</para> 
    494                 </listitem> 
    495                 <listitem> 
    496                     <para><literal>McStas</literal>: http://mcstas.risoe.dk/documentation/tutorial/node6.html</para> 
    497                 </listitem> 
    498                 <listitem> 
    499                     <para>http://webhost5.nts.jhu.edu/reza/book/kinematics/kinematics.htm</para> 
    500                 </listitem> 
     494                    <para>Cartesian: <link xlink:href="http://en.wikipedia.org/wiki/Cartesian_coordinate_system" 
     495                        ><literal>http://en.wikipedia.org/wiki/Cartesian_coordinate_system</literal></link></para> 
     496                </listitem> 
     497                <listitem> 
     498                    <para>Right-hand rule: <link xlink:href="http://en.wikipedia.org/wiki/Right-hand_rule" 
     499                        ><literal>http://en.wikipedia.org/wiki/Right-hand_rule</literal></link></para> 
     500                </listitem> 
     501                <listitem> 
     502                    <para>NeXus: <link xlink:href="http://www.nexusformat.org/Coordinate_Systems" 
     503                        ><literal>http://www.nexusformat.org/Coordinate_Systems</literal></link></para> 
     504                </listitem> 
     505                <listitem> 
     506                    <para><literal>McStas</literal>:  
     507                        <link xlink:href="http://mcstas.risoe.dk/documentation/tutorial/node6.html" 
     508                            ><literal>http://mcstas.risoe.dk/documentation/tutorial/node6.html</literal 
     509                            ></link></para> 
     510                </listitem> 
     511                <!-- PRJ, 2009-10-08: no longer available, this was a robotics book 
     512                    Now, that work is (from http://www.springer.com/engineering/book/978-0-387-32475-3) 
     513                    Theory of Applied Robotics 
     514                    Kinematics, Dynamics, and Control 
     515                    Jazar, Reza N. 
     516                    2007, XXI, 695 p. 200 illus., Hardcover 
     517                    ISBN: 978-0-387-32475-3 
     518                    <listitem> 
     519                    <para><link xlink:href="http://webhost5.nts.jhu.edu/reza/book/kinematics/kinematics.htm" 
     520                        ><literal>http://webhost5.nts.jhu.edu/reza/book/kinematics/kinematics.htm</literal></link></para> 
     521                </listitem>--> 
    501522            </itemizedlist> 
    502523            <para>The translation and orientation geometry definitions used here are different than 
    503524                those used by <link xlink:href="http://www.nanotech.wisc.edu/shadow"><emphasis 
    504525                        role="bold">SHADOW</emphasis></link> 
    505                 <footnote><para>http://www.nanotech.wisc.edu/shadow</para></footnote> 
     526                <footnote><para> 
     527                    <link xlink:href="http://www.nanotech.wisc.edu/shadow" 
     528                        ><literal>http://www.nanotech.wisc.edu/shadow</literal></link></para></footnote> 
    506529                where the <emphasis role="italic">y</emphasis> and <emphasis role="italic" 
    507530                    >z</emphasis> axes are swapped and the direction of <emphasis role="italic" 
     
    512535            <para>The  
    513536                <link xlink:href="http://www.smallangles.net/canSAS/xmlWriter/" 
    514                     ><emphasis role="italic"></emphasis>canSAS/xmlWriter</link> 
     537                    ><emphasis role="italic">canSAS/xmlWriter</emphasis></link> 
    515538                <footnote> 
    516                     <para> 
    517                         http://www.smallangles.net/canSAS/xmlWriter/ 
    518                     </para> 
     539                    <para><link xlink:href="http://www.smallangles.net/canSAS/xmlWriter/" 
     540                        ><literal>http://www.smallangles.net/canSAS/xmlWriter/</literal></link></para> 
    519541                </footnote> 
    520542                <indexterm><primary><literal>xmlWriter</literal></primary></indexterm> 
     
    524546                elements in the correct places. The form requests the SAS data of Q, I, and Idev 
    525547                (defined elsewhere on this page) and some basic metadata (title, run, sample info, 
    526                 ...). Press the <code>&lt;nowiki>Submit&lt;/nowiki></code> button and you will receive a nicely 
     548                ...). </para> 
     549            <para>Press the <code>Submit</code> button and you will receive a nicely 
    527550                formatted WWW page with the SAS data. If you then choose "View page source" (from 
    528551                one of your browser menus), you will see the raw XML of the cansas1d/1.0 XML format 
     
    544567                <link xlink:href="http://www.w3schools.com/xsd" 
    545568                    >XML Schema</link> 
    546                 <footnote><para><literal>http://www.w3schools.com/xsd</literal></para></footnote> 
     569                <footnote><para> 
     570                    <link xlink:href="http://www.w3schools.com/xsd" 
     571                        ><literal>http://www.w3schools.com/xsd</literal></link></para></footnote> 
    547572                <indexterm><primary>XML Schema</primary></indexterm> 
    548573                defines the rules for the XML file format 
    549574                <footnote> 
    550575                    <para> 
    551                         TRAC: <literal> 
    552                             http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/cansas1d.xsd 
    553                         </literal> 
     576                        TRAC: 
     577                        <link xlink:href="http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/cansas1d.xsd" 
     578                            ><literal>http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/cansas1d.xsd</literal></link> 
    554579                    </para> 
    555580                </footnote> 
    556581                <footnote> 
    557582                    <para> 
    558                         SVN: <literal> 
    559                             http://svn.smallangles.net/svn/canSAS/1dwg/trunk/cansas1d.xsd 
    560                         </literal> 
     583                        SVN: 
     584                        <link xlink:href="http://svn.smallangles.net/svn/canSAS/1dwg/trunk/cansas1d.xsd" 
     585                            ><literal>http://svn.smallangles.net/svn/canSAS/1dwg/trunk/cansas1d.xsd</literal></link> 
    561586                    </para> 
    562587                </footnote> 
     
    566591        <section xml:id="cansas1d_documentation-XML_Stylesheets"> 
    567592            <title>XML Stylesheets</title> 
     593            <para> 
     594                XML stylesheets (also known as XSLT) 
     595                <footnote> 
     596                    <para> 
     597                        <link xlink:href="http://www.w3schools.com/xsl/" 
     598                            ><literal>http://www.w3schools.com/xsl/</literal></link></para> 
     599                </footnote> 
     600                <indexterm> 
     601                    <primary>XML Stylesheet</primary> 
     602                </indexterm> 
     603                can be used to extract metadata or to convert into another file format. The 
     604                default canSAS stylesheet <literal>cansasxml-html.xsl</literal> 
     605                <footnote> 
     606                    <para> 
     607                        <link xlink:href="http://svn.smallangles.net/svn/canSAS/1dwg/trunk/cansasxml-html.xsl" 
     608                            ><literal>http://svn.smallangles.net/svn/canSAS/1dwg/trunk/cansasxml-html.xsl</literal></link></para> 
     609                </footnote> 
     610                should be copied into each folder with canSAS XML data 
     611                file(s). It can be used to display the data in a supporting WWW browser 
     612                (such as Firefox or Internet Explorer) or to import into Microsoft Excel 
     613                (with the added XML support in Excel). (See the excellent write-up by Steve 
     614                King, ISIS,  
     615                <footnote> 
     616                    <para> 
     617                        <link xlink:href="http://www.isis.rl.ac.uk/archive/LargeScale/LOQ/xml/cansas_xml_format.pdf" 
     618                            ><literal>http://www.isis.rl.ac.uk/archive/LargeScale/LOQ/xml/cansas_xml_format.pdf</literal></link> 
     619                    </para> 
     620                </footnote> 
     621                for an example.) By default, MS Windows binds <literal>*.xml</literal> files to start 
     622                Internet Explorer. Double-clicking on a canSAS XML data file with the 
     623                <literal>cansasxml-html.xsl</literal> (see above) 
     624                stylesheet in the same directory will produce a 
     625                WWW page with the SAS data and selected metadata.</para> 
     626        </section> 
     627        <section xml:id="cansas1d_documentation-programming_suggestions"> 
     628            <title>Suggestions for support software that writes cansas1d/1.0 XML data files</title> 
     629            <para> 
     630                Some common best practices have been identified in the list below. 
     631                <indexterm><primary>file</primary><secondary>Writing cansas1d/1.0 files</secondary></indexterm> 
     632                <indexterm><primary>best practices</primary></indexterm> 
     633            </para> 
    568634            <itemizedlist> 
    569635                <listitem> 
    570                     <para><literal>cansasxml-html.xsl</literal>: 
    571                         XSLT stylesheets 
    572                         <footnote> 
    573                             <para>http://www.w3schools.com/xsl/</para> 
    574                         </footnote> 
    575                         can be used to extract metadata or to convert into another file format. The 
    576                         default canSAS stylesheet 
    577                         <link xlink:href="http://svn.smallangles.net/svn/canSAS/1dwg/trunk/cansasxml-html.xsl" 
    578                             >http://svn.smallangles.net/svn/canSAS/1dwg/trunk/cansasxml-html.xsl</link> 
    579                         should be copied into each folder with canSAS XML data 
    580                         file(s). It can be used to display the data in a supporting WWW browser 
    581                         (such as Firefox or Internet Explorer) or to import into Microsoft Excel 
    582                         (with the added XML support in Excel). (See the excellent write-up by Steve 
    583                         King, ISIS,  
    584                         <footnote> 
    585                             <para> 
    586                                 <link xlink:href="http://www.isis.rl.ac.uk/archive/LargeScale/LOQ/xml/cansas_xml_format.pdf" 
    587                                     ><literal>http://www.isis.rl.ac.uk/archive/LargeScale/LOQ/xml/cansas_xml_format.pdf</literal></link> 
    588                             </para> 
    589                         </footnote> 
    590                         for an example.) By default, MS Windows binds <literal>*.xml</literal> files to start 
    591                         Internet Explorer. Double-clicking on a canSAS XML data file with the 
    592                         <literal>cansasxml-html.xsl</literal> (see above) 
    593                         stylesheet in the same directory will produce a 
    594                         WWW page with the SAS data and selected metadata.</para> 
    595                 </listitem> 
    596                 <listitem> 
    597                     <para>Suggestions for support software that writes cansas1d/1.0 XML data 
    598                         files:</para> 
     636                    <para>be sure to update to the latest SVN repository revision (command: 
     637                        <code>svn update</code>) </para> 
     638                </listitem> 
     639                <listitem> 
     640                    <para>check the output directory to see if it contains the default XSLT 
     641                        file.</para> 
     642                </listitem> 
     643                <listitem> 
     644                    <para>copy the latest XSLT file to the output directory if 
     645                        either:</para> 
    599646                    <itemizedlist> 
    600647                        <listitem> 
    601                             <para>be sure to update to the latest SVN repository revision (command: 
    602                                     <code>svn update</code>) </para> 
    603                         </listitem> 
    604                         <listitem> 
    605                             <para>check the output directory to see if it contains the default XSLT 
    606                                 file.</para> 
    607                         </listitem> 
    608                         <listitem> 
    609                             <para>copy the latest XSLT file to the output directory if 
    610                                 either:</para> 
    611                             <itemizedlist> 
    612                                 <listitem> 
    613                                     <para>the output directory contains an older revision</para> 
    614                                 </listitem> 
    615                                 <listitem> 
    616                                     <para>the output directory does not have the default XSLT 
    617                                         file</para> 
    618                                 </listitem> 
    619                             </itemizedlist> 
    620                         </listitem> 
    621                         <listitem> 
    622                             <para>The most recent XSLT file can be identified by examining the file 
    623                                 for the <literal>$ Revision: </literal> string. For example:  
    624                                 <code># &#36;Revision: 111 $</code> is version 111. </para> 
     648                            <para>the output directory contains an older revision</para> 
     649                        </listitem> 
     650                        <listitem> 
     651                            <para>the output directory does not have the default XSLT 
     652                                file</para> 
    625653                        </listitem> 
    626654                    </itemizedlist> 
     655                </listitem> 
     656                <listitem> 
     657                    <para>The most recent XSLT file can be identified by examining the file 
     658                        for the <literal>$ Revision: </literal> string. For example:  
     659                        <code># &#36;Revision: 111 $</code> is version 111. </para> 
    627660                </listitem> 
    628661            </itemizedlist> 
     
    633666                <listitem> 
    634667                    <para> 
    635                         <link xlink:href="http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/cansas1d.xml" 
    636                             >http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/cansas1d.xml</link> 
    637                         (basic example): Note that, for clarity, only one row of data is 
     668                        Basic example: 
     669                        <footnote><para> 
     670                            <link xlink:href="http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/cansas1d.xml" 
     671                                ><literal>http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/cansas1d.xml</literal></link></para></footnote> 
     672                        Note that, for clarity, only one row of data is 
    638673                        shown. This is probably a very good example to use as a starting point for 
    639674                        creating XML files with a text editor.</para> 
     
    641676                <listitem> 
    642677                    <para> 
    643                         <link xlink:href="http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/bimodal-test1.xml" 
    644                             >http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/bimodal-test1.xml</link>: 
    645                         Simulated SAS data to test size distribution calculation routines.</para> 
    646                 </listitem> 
    647                 <listitem> 
    648                     <para> 
    649                         <link xlink:href="http://www.smallangles.net/wgwiki/index.php/Glassy_Carbon_Round_Robin" 
    650                             >Glassy Carbon Round Robin</link>: 
    651                         <footnote><para>http://www.smallangles.net/wgwiki/index.php/Glassy_Carbon_Round_Robin</para></footnote> 
    652                         Glassy carbon 
    653                         samples measured at several facilities worldwide.</para> 
     678                        Bimodal test data: 
     679                        <footnote><para> 
     680                            <link xlink:href="http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/bimodal-test1.xml" 
     681                                ><literal>http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/bimodal-test1.xml</literal></link></para></footnote> 
     682                        Simulated SAS data (with added noise) calculated from model bimodal size distribution to test size distribution analysis routines.</para> 
     683                </listitem> 
     684                <listitem> 
     685                    <para> 
     686                        Glassy Carbon Round Robin: 
     687                        <footnote> 
     688                            <para> 
     689                            <link xlink:href="http://www.smallangles.net/wgwiki/index.php/Glassy_Carbon_Round_Robin" 
     690                                ><literal>http://www.smallangles.net/wgwiki/index.php/Glassy_Carbon_Round_Robin</literal 
     691                                ></link></para> 
     692                        </footnote> 
     693                        Samples of a commercial glassy carbon 
     694                        measured at several facilities worldwide.</para> 
    654695                </listitem> 
    655696                <listitem> 
     
    664705                    <para>SANS data from  
    665706                        <link xlink:href="#cansas1d_documentation-case_study-af1410" 
    666                             >AF1410 steel</link>: SANS study using magnetic 
     707                            >AF1410 steel</link>:  
     708                        <footnote><para> 
     709                            <link xlink:href="http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/examples/af1410/" 
     710                                ><literal>http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/examples/af1410/</literal 
     711                                ></link></para></footnote> 
     712                        SANS study using magnetic 
    667713                        contrast variation (with multiple samples and multiple data sets for each 
    668                         sample), the files can be viewed from TRAC (no description yet): 
    669                         [http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/examples/af1410/ 
    670                         http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/examples/af1410/]</para> 
    671                 </listitem> 
    672                 <listitem> 
    673                     <para><link xlink:href="http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/cansas1d-template.xml" 
    674                         >http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/cansas1d-template.xml</link>: 
     714                        sample), the files can be viewed from the TRAC site (no description yet).</para> 
     715                </listitem> 
     716                <listitem> 
     717                    <para> 
     718                        <literal>cansas1d-template.xml</literal>: 
     719                        <footnote><para> 
     720                            <link xlink:href="http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/cansas1d-template.xml" 
     721                                ><literal>http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/cansas1d-template.xml</literal></link></para></footnote> 
    675722                        This is used to test all the rules in the XML 
    676723                        Schema. This is probably not a very good example to use as a starting point 
     
    681728            <section xml:id="cansas1d_documentation-examples-multiple_experiments"> 
    682729                <title>XML layout for multiple experiments</title> 
    683                 <para>Each experiment is described with a single '''SASentry''' element. The 
     730                <para>Each experiment is described with a single <literal>SASentry</literal> element. The 
    684731                    fragment below shows how multiple experiments can be included in a single XML 
    685732                    file. Full examples of canSAS XML files with multiple experiments 
     
    687734                <itemizedlist> 
    688735                    <listitem> 
    689                         <para> ISIS LOQ SANS instrument: <link 
    690                                 xlink:href="http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/W1W2.XML" 
    691                                 >http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/W1W2.XML</link> 
     736                        <para> ISIS LOQ SANS instrument:  
     737                            <footnote><para> 
     738                                <link xlink:href="http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/W1W2.XML" 
     739                                    ><literal>http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/W1W2.XML</literal></link></para></footnote> 
     740                            multiple data sets. 
    692741                        </para> 
    693742                    </listitem> 
    694743                    <listitem> 
    695                         <para> AF1410 steel SANS contrast variation study from NIST: <link 
    696                                 xlink:href="http://svn.smallangles.net/svn/canSAS/1dwg/trunk/examples/af1410/cs_af1410.xml" 
    697                                 > 
    698                                 http://svn.smallangles.net/svn/canSAS/1dwg/trunk/examples/af1410/cs_af1410.xml 
    699                             </link> 
     744                        <para> AF1410 steel SANS contrast variation study from NIST:  
     745                            <footnote><para> 
     746                                <link xlink:href="http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/examples/af1410/cs_af1410.xml" 
     747                                    ><literal>http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/examples/af1410/cs_af1410.xml</literal></link></para></footnote> 
     748                            SANS study using magnetic 
     749                            contrast variation (with multiple samples and multiple data sets for each 
     750                            sample), the files can be viewed from the TRAC site (no description yet). 
    700751                        </para> 
    701752                    </listitem> 
     
    729780                        <link 
    730781                            xlink:href="http://svn.smallangles.net/trac/canSAS/browser/1dwg/data/Glassy%20Carbon/ISIS/GLASSYC_C4G8G9_withTL.xml" 
    731                             >http://svn.smallangles.net/trac/canSAS/browser/1dwg/data/Glassy%20Carbon/ISIS/GLASSYC_C4G8G9_withTL.xml</link> 
    732                     </para> 
     782                            ><literal>http://svn.smallangles.net/trac/canSAS/browser/1dwg/data/Glassy%20Carbon/ISIS/GLASSYC_C4G8G9_withTL.xml</literal></link></para> 
    733783                </footnote> 
    734784                This example uses a foreign namespace to record the transmission spectra related to 
     
    740790            <para> Also refer to <link 
    741791                    xlink:href="http://svn.smallangles.net/trac/canSAS/changeset/47">canSAS TRAC 
    742                     ticket #47</link> for an example of arranging the content in <emphasis 
    743                     role="bold">SASprocessnote</emphasis> to avoid the use of foreign namespace 
     792                    ticket #47</link> for an example of arranging the content in  
     793                <literal>SASprocessnote</literal> to avoid the use of foreign namespace 
    744794                elements. </para> 
    745795        </section> 
     
    751801            <itemizedlist> 
    752802                <listitem> 
    753                     <para><emphasis role="bold">FORTRAN</emphasis></para> 
    754                 </listitem> 
    755                 <listitem> 
    756                     <para><emphasis role="bold">IgorPro</emphasis></para> 
    757                 </listitem> 
    758                 <listitem> 
    759                     <para><emphasis role="bold">Java</emphasis></para> 
    760                 </listitem> 
    761                 <listitem> 
    762                     <para> 
    763                         <emphasis role="bold">Microsoft Excel</emphasis> Support for Microsoft Excel 
     803                    <para> 
     804                        <emphasis role="bold">FORTRAN</emphasis>: 
     805                        See the section titled 
     806                        <link xlink:href="#cansas1d_documentation-binding-Fortran" 
     807                            ><emphasis role="italic">Fortran binding</emphasis></link>. 
     808                        <indexterm> 
     809                            <primary>binding</primary> 
     810                            <secondary>FORTRAN</secondary> 
     811                        </indexterm> 
     812                        <indexterm> 
     813                            <primary>FORTRAN</primary> 
     814                            <see>binding, FORTRAN</see> 
     815                        </indexterm> 
     816                    </para> 
     817                </listitem> 
     818                <listitem> 
     819                    <para> 
     820                        <emphasis role="bold">IgorPro</emphasis>: 
     821                        See the section titled 
     822                        <link xlink:href="#cansas1d_documentation-binding-IgorPro" 
     823                            ><emphasis role="italic">IgorPro binding</emphasis></link>. 
     824                        <indexterm> 
     825                            <primary>binding</primary> 
     826                            <secondary>IgorPro</secondary> 
     827                        </indexterm> 
     828                        <indexterm> 
     829                            <primary>FORTRAN</primary> 
     830                            <see>binding, FORTRAN</see> 
     831                        </indexterm> 
     832                    </para> 
     833                </listitem> 
     834                <listitem> 
     835                    <para> 
     836                        <emphasis role="bold">Java</emphasis>: 
     837                        See the section titled 
     838                        <link xlink:href="#cansas1d_documentation-binding-Java" 
     839                            ><emphasis role="italic">Java JAXB binding</emphasis></link>. 
     840                        <indexterm> 
     841                            <primary>binding</primary> 
     842                            <secondary>Java</secondary> 
     843                        </indexterm> 
     844                        <indexterm> 
     845                            <primary>Java</primary> 
     846                            <see>binding, Java</see> 
     847                        </indexterm> 
     848                    </para> 
     849                </listitem> 
     850                <listitem> 
     851                    <para> 
     852                        <emphasis role="bold">Microsoft Excel</emphasis>: 
     853                        Support for Microsoft Excel 
     854                        <indexterm> 
     855                            <primary>binding</primary> 
     856                            <secondary>Microsoft Excel</secondary> 
     857                        </indexterm> 
     858                        <indexterm> 
     859                            <primary>Microsoft Excel</primary> 
     860                            <see>binding, Microsoft Excel</see> 
     861                        </indexterm> 
    764862                        is provided through the default canSAS stylesheet <link 
    765863                            xlink:href="http://svn.smallangles.net/svn/canSAS/1dwg/trunk/cansasxml-html.xsl" 
    766                             >cansasxml-html.xsl</link>. An <link 
    767                             xlink:href="http://www.isis.rl.ac.uk/archive/LargeScale/LOQ/xml/cansas_xml_format.pdf" 
    768                             >excellent description</link> of how to import data from the 
    769                         cansas1d/1.0 format into Excel is available from the <link 
     864                            >cansasxml-html.xsl</link>.  
     865                        The <link 
    770866                            xlink:href="http://www.isis.stfc.ac.uk/instruments/loq/loq2470.html" 
    771                             >ISIS LOQ instrument</link>. 
    772                         <footnote><para>http://www.isis.stfc.ac.uk/instruments/loq/loq2470.html</para></footnote> 
     867                            >ISIS LOQ instrument</link> has provided an <link 
     868                                xlink:href="http://www.isis.rl.ac.uk/archive/LargeScale/LOQ/xml/cansas_xml_format.pdf" 
     869                                >excellent description</link> 
     870                        <footnote><para><link 
     871                            xlink:href="http://www.isis.stfc.ac.uk/instruments/loq/loq2470.html" 
     872                            ><literal>http://www.isis.stfc.ac.uk/instruments/loq/loq2470.html</literal 
     873                            ></link></para></footnote> 
     874                        of how to import data from the 
     875                        cansas1d/1.0 format into Excel. 
    773876                        Also note that the 
    774877                            <link 
    775878                            xlink:href="http://www.isis.rl.ac.uk/archive/LargeScale/LOQ/loq.htm">old 
    776879                            WWW site</link> 
    777                         <footnote><para>http://www.isis.rl.ac.uk/LargeScale/LOQ/loq.htm</para></footnote> 
    778                         may still be available. </para> 
    779                 </listitem> 
    780                 <listitem> 
    781                     <para><emphasis role="bold">PHP</emphasis></para> 
    782                 </listitem> 
    783                 <listitem> 
    784                     <para><emphasis role="bold">Python</emphasis></para> 
    785                 </listitem> 
    786                 <listitem> 
    787                     <para><emphasis role="bold">XSLT</emphasis> (useful in a web browser)</para> 
     880                        <footnote><para><link 
     881                            xlink:href="http://www.isis.rl.ac.uk/LargeScale/LOQ/loq.htm" 
     882                            ><literal>http://www.isis.rl.ac.uk/LargeScale/LOQ/loq.htm</literal 
     883                            ></link></para></footnote> 
     884                        may still be available.  
     885                    </para> 
     886                </listitem> 
     887                <listitem> 
     888                    <para> 
     889                        <emphasis role="bold">PHP</emphasis>: 
     890                        The <link xlink:href="#cansas1d_documentation-converting_into_XML" 
     891                            ><emphasis role="italic">canSAS/xmlWriter</emphasis></link> 
     892                        <indexterm><primary><literal>xmlWriter</literal></primary></indexterm> 
     893                        is implemented in <link xlink:href="http://www.php.net">PHP</link>  
     894                        <footnote><para><link xlink:href="http://www.php.net" 
     895                            ><literal>http://www.php.net</literal></link></para></footnote> 
     896                        <indexterm> 
     897                            <primary>binding</primary> 
     898                            <secondary>PHP</secondary> 
     899                        </indexterm> 
     900                        <indexterm> 
     901                            <primary>PHP</primary> 
     902                            <see>binding, PHP</see> 
     903                        </indexterm> 
     904                        and writes a cansas1d/1.0 data file given three-column ASCII data as input. 
     905                        (<link 
     906                            xlink:href="http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/php/xmlWriter/index.php" 
     907                            >PHP source</link>) 
     908                        <footnote> 
     909                            <para> 
     910                                <link xlink:href="http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/php/xmlWriter/index.php" 
     911                                    ><literal>http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/php/xmlWriter/index.php</literal></link> 
     912                            </para> 
     913                        </footnote> 
     914                        The code uses <link xlink:href="http://www.php.net/DomDocument">DomDocument</link> 
     915                        <footnote><para><link xlink:href="http://www.php.net/DomDocument" 
     916                            ><literal>http://www.php.net/DomDocument</literal></link></para></footnote> 
     917                        to build the XML file.  Look for the line beginning with 
     918                        <literal>function prepare_cansasxml($post)</literal>. 
     919                    </para> 
     920                    <para> 
     921                        Another example of <literal>DomDocument</literal> 
     922                        is in the <literal>function surveillance($post)</literal> where 
     923                        logging information is inserted into an XML file. 
     924                    </para> 
     925                </listitem> 
     926                <listitem> 
     927                    <para> 
     928                        <emphasis role="bold">Python</emphasis>: 
     929                        See the section titled 
     930                        <link xlink:href="#cansas1d_documentation-binding-Python" 
     931                            ><emphasis role="italic">Python binding</emphasis></link>. 
     932                        <indexterm> 
     933                            <primary>binding</primary> 
     934                            <secondary>Python</secondary> 
     935                        </indexterm> 
     936                        <indexterm> 
     937                            <primary>Python</primary> 
     938                            <see>binding, Python</see> 
     939                        </indexterm> 
     940                    </para> 
     941                </listitem> 
     942                <listitem> 
     943                    <para> 
     944                        <emphasis role="bold">XSLT</emphasis> (useful in a web browser) 
     945                        is described later in the section titled  
     946                        <link xlink:href="#xml-stylesheet"><emphasis role="italic">Example XML Stylesheets</emphasis></link>. 
     947                        <indexterm> 
     948                            <primary>binding</primary> 
     949                            <secondary>XML Stylesheet (XSLT)</secondary> 
     950                        </indexterm> 
     951                    </para> 
    788952                </listitem> 
    789953            </itemizedlist> 
     
    795959                    <para><emphasis role="bold">TRAC</emphasis>: <link 
    796960                            xlink:href="http://svn.smallangles.net/trac/canSAS/browser/1dwg/tags/v1.0" 
    797                             >http://svn.smallangles.net/trac/canSAS/browser/1dwg/tags/v1.0</link></para> 
     961                            ><literal>http://svn.smallangles.net/trac/canSAS/browser/1dwg/tags/v1.0</literal></link></para> 
    798962                </listitem> 
    799963                <listitem> 
    800964                    <para><emphasis role="bold">Subversion</emphasis>: <link 
    801965                            xlink:href="http://svn.smallangles.net/svn/canSAS/1dwg/tags/v1.0" 
    802                             >http://svn.smallangles.net/svn/canSAS/1dwg/tags/v1.0</link></para> 
     966                            ><literal>http://svn.smallangles.net/svn/canSAS/1dwg/tags/v1.0</literal></link></para> 
    803967                </listitem> 
    804968            </itemizedlist> 
     
    809973        <orderedlist> 
    810974            <listitem> 
    811                 <para>open browser to: http://www.xmlvalidation.com/</para> 
     975                <para>open browser to:  
     976                    <link xlink:href="http://www.xmlvalidation.com/" 
     977                        ><literal>http://www.xmlvalidation.com/</literal></link></para> 
    812978            </listitem> 
    813979            <listitem> 
     
    816982            </listitem> 
    817983            <listitem> 
    818                 <para>press &lt;validate></para> 
     984                <para>press <literal>&lt;validate></literal></para> 
    819985            </listitem> 
    820986            <listitem> 
    821                 <para>paste content of 
    822                     <link xlink:href="http://svn.smallangles.net/svn/canSAS/1dwg/trunk/cansas1d.xsd" 
    823                         ><literal>http://svn.smallangles.net/svn/canSAS/1dwg/trunk/cansas1d.xsd</literal></link> 
     987                <para>paste content of  
     988                    <literal>cansas1d.xsd</literal> 
     989                    <footnote><para><link 
     990                        xlink:href="http://svn.smallangles.net/svn/canSAS/1dwg/trunk/cansas1d.xsd" 
     991                        ><literal>http://svn.smallangles.net/svn/canSAS/1dwg/trunk/cansas1d.xsd</literal 
     992                    ></link></para></footnote> 
    824993                    XSD file into form and press <literal>&lt;continue validation></literal>.</para> 
    825994            </listitem> 
  • 1dwg/trunk/doc/src/xml-help.xml

    r130 r134  
    22<?oxygen RNGSchema="http://www.oasis-open.org/docbook/xml/5.0/rng/docbook.rng" type="xml"?> 
    33<!--  
    4     ########### SVN repository information ################### 
    5     # $Date$ 
    6     # $Author$ 
    7     # $Revision$ 
    8     # $HeadURL$ 
    9     # $Id$ 
    10     ########### SVN repository information ################### 
     4########### SVN repository information ################### 
     5# $Date$ 
     6# $Author$ 
     7# $Revision$ 
     8# $HeadURL$ 
     9# $Id$ 
     10########### SVN repository information ################### 
    1111--> 
    1212<section xml:id="wiki-XML_Help" xmlns="http://docbook.org/ns/docbook" version="5.0" 
Note: See TracChangeset for help on using the changeset viewer.