Changeset 242


Ignore:
Timestamp:
Aug 27, 2012 7:24:27 PM (7 years ago)
Author:
prjemian
Message:

refs #24

Location:
1dwg/trunk/doc/source
Files:
4 added
9 edited

Legend:

Unmodified
Added
Removed
  • 1dwg/trunk/doc/source/bindings.rst

    r241 r242  
    11.. $Id$ 
    22 
    3 Language Bindings 
    4 ================= 
     3=================================================== 
     4Language Bindings and Software Support 
     5=================================================== 
    56 
     7Bindings (import/export drivers) and other software support  
     8        have been created and contributed.  These are listed here by the  
     9        language or software environment. 
    610 
    7 .. toctree:: 
    8    :maxdepth: 2 
     11.. 
     12        .. toctree:: 
     13           :maxdepth: 2 
     14            
     15           binding-fortran 
     16           binding-igorpro 
     17           binding-java-jaxb 
     18           binding-php 
     19           binding-python 
    920    
     21.. _fortran.binding: 
     22 
     23FORTRAN 
     24================ 
     25 
     26.. _igorpro.binding: 
     27 
     28IgorPro 
     29================ 
     30 
     31.. _java.jaxb.binding: 
     32 
     33Java JAXB 
     34================ 
     35 
     36.. _php.binding: 
     37 
     38PHP 
     39================ 
     40 
     41.. _Python.binding: 
     42 
     43Python 
     44================ 
     45 
  • 1dwg/trunk/doc/source/compatibility.rst

    r241 r242  
    1111The translation and orientation geometry used by this canSAS standard are consistent with: 
    1212 
    13 Cartesian: 
     13**Cartesian** 
    1414        http://en.wikipedia.org/wiki/Cartesian_coordinate_system 
    1515 
    16 Right-hand rule: 
     16**Right-hand rule** 
    1717        http://en.wikipedia.org/wiki/Right-hand_rule 
    1818 
    19 :index:`NeXus`: 
     19.. index:: NeXus 
     20 
     21**NeXus** 
    2022        http://www.nexusformat.org/Coordinate_Systems 
    2123 
    22 McStas: 
     24.. index:: McStas 
     25 
     26**McStas** 
    2327        http://mcstas.risoe.dk/documentation/tutorial/node6.html 
    2428 
     
    3236    ISBN: 978-0-387-32475-3 
    3337 
    34 The translation and orientation geometry definitions used here are different than 
    35 those used by *SHADOW* (http://www.nanotech.wisc.edu/shadow) 
    36 where the :math:`y` and :math:`z` axes are swapped and the direction  
    37 of :math:`x` is changed. 
     38--------------------------- 
     39 
     40.. index:: SHADOW 
     41 
     42**SHADOW** 
     43        The translation and orientation geometry **definitions used here are different** than 
     44        those used by *SHADOW* (http://www.nanotech.wisc.edu/shadow) 
     45        where the :math:`y` and :math:`z` axes are swapped and the direction  
     46        of :math:`x` is changed. 
  • 1dwg/trunk/doc/source/downloads.rst

    r241 r242  
    11.. $Id$ 
    22 
     3.. _downloads: 
     4 
     5========= 
    36Downloads 
    47========= 
  • 1dwg/trunk/doc/source/elements.rst

    • Property svn:keywords deleted
    r241 r242  
    1 .. $Id$ 
     1.. $Id: elements.rst 241 2012-08-27 07:15:24Z prjemian $ 
    22 
    33.. _elements: 
  • 1dwg/trunk/doc/source/index.rst

    • Property svn:keywords deleted
    r241 r242  
    1 .. $Id$ 
     1.. $Id: index.rst 241 2012-08-27 07:15:24Z prjemian $ 
    22 
    33==================== 
  • 1dwg/trunk/doc/source/manual.rst

    r241 r242  
    1111   specification 
    1212   tutorial 
     13   examples 
    1314   bindings 
    14  
    15 .. 
    16     <xi:include href="intensity-problem.xml"/> 
    17     <xi:include href="examples.xml"/> 
    18     <xi:include href="glossary.xml"/> 
    19     <xi:include href="xml-help.xml"/> 
     15   intensity-problem 
     16   xml-help 
  • 1dwg/trunk/doc/source/overview.rst

    r241 r242  
    306306 
    307307Examples and Case Studies 
    308 ---------------------------------- 
     308========================================================= 
    309309 
    310310.. index:: XML file; cansas1d.xml 
     
    335335    measured at several facilities worldwide. 
    336336 
    337  
    338 .. 
    339             <section xml:id="cansas1d_documentation-Documentation-Definitions"> 
    340                 <section xml:id="cansas1d_documentation-examples"> 
    341                         <listitem> 
    342                             <para>SAXS data from  
    343                                 <link xlink:href="#cansas1d_documentation-case_study-collagen" 
    344                                     >dry chick collagen</link> 
    345                                 <indexterm> 
    346                                     <primary>case study</primary> 
    347                                     <secondary>SAXS of dry chick collagen</secondary> 
    348                                 </indexterm> 
    349                                 illustrates the 
    350                                 minimum information necessary to meet the requirements of the standard 
    351                                 format</para> 
    352                         </listitem> 
    353                         <listitem> 
    354                             <para>SANS data from  
    355                                 <link xlink:href="#cansas1d_documentation-case_study-af1410" 
    356                                     >AF1410 steel</link>:<footnote><para> 
    357                                         <link xlink:href="http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/examples/af1410/" 
    358                                             ><literal>http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/examples/af1410/</literal 
    359                                             ></link></para></footnote> 
    360                                 <indexterm> 
    361                                     <primary>case study</primary> 
    362                                     <secondary>SANS of AF1410 steel</secondary> 
    363                                 </indexterm> 
    364                                 SANS study using magnetic 
    365                                 contrast variation (with multiple samples and multiple data sets for each 
    366                                 sample), the files can be viewed from the TRAC site (no description yet).</para> 
    367                         </listitem> 
    368                         <listitem> 
    369                             <para> 
    370                                 <literal>cansas1d-template.xml</literal>:<footnote><para> 
    371                                     <link xlink:href="http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/cansas1d-template.xml" 
    372                                         ><literal 
    373                                             >http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/cansas1d-template.xml</literal 
    374                                         ></link></para></footnote> 
    375                                 <indexterm> 
    376                                     <primary>XML file</primary> 
    377                                     <secondary>cansas1d-template.xml</secondary> 
    378                                 </indexterm> 
    379                                 This is used to test all the rules in the XML 
    380                                 Schema. This is probably not a very good example to use as a starting point 
    381                                 for creating XML files with a text editor since it tests many of the 
    382                                 special-case rules.</para> 
    383                         </listitem> 
    384                     </itemizedlist> 
    385                     <section xml:id="cansas1d_documentation-examples-multiple_experiments"> 
    386                         <title>XML layout for multiple experiments</title> 
    387                         <para>Each experiment is described with a single <literal>SASentry</literal> element. The 
    388                             fragment below shows how multiple experiments 
    389                             <indexterm> 
    390                                 <primary>multiple experiments</primary> 
    391                             </indexterm> 
    392                             <indexterm> 
    393                                 <primary>multiple data sets</primary> 
    394                             </indexterm> 
    395                             can be included in a single XML 
    396                             file. Full examples of canSAS XML files with multiple experiments 
    397                             include:</para> 
    398                         <itemizedlist> 
    399                             <listitem> 
    400                                 <para> ISIS LOQ SANS instrument:<footnote><para> 
    401                                     <link xlink:href="http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/W1W2.XML" 
    402                                         ><literal 
    403                                             >http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/W1W2.XML</literal 
    404                                         ></link></para></footnote> 
    405                                     <indexterm> 
    406                                         <primary>XML file</primary> 
    407                                         <secondary>W1W2.XML</secondary> 
    408                                     </indexterm> 
    409                                     multiple data sets. 
    410                                 </para> 
    411                             </listitem> 
    412                             <listitem> 
    413                                 <para> AF1410 steel SANS contrast variation study from NIST:<footnote><para> 
    414                                         <link xlink:href="http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/examples/af1410/cs_af1410.xml" 
    415                                             ><literal 
    416                                                 >http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/examples/af1410/cs_af1410.xml</literal 
    417                                             ></link></para></footnote> 
    418                                     <indexterm> 
    419                                         <primary>XML file</primary> 
    420                                         <secondary>cs_af1410.xml</secondary> 
    421                                     </indexterm> 
    422                                     SANS study using magnetic 
    423                                     contrast variation (with multiple samples and multiple data sets for each 
    424                                     sample), the files can be viewed from the TRAC site (no description yet). 
    425                                 </para> 
    426                             </listitem> 
    427                         </itemizedlist> 
    428                         <para>Here is a brief sketch of how a file would be arranged with multiple SASentry 
    429                             elements and multiple SASdata elements. 
    430                             <indexterm> 
    431                                 <primary>XML file</primary> 
    432                                 <secondary>brief-sketch-multiple.xml</secondary> 
    433                             </indexterm> 
    434                             <example> 
    435                                 <title>Brief sketch of a file with multiple SASentry and SASdata blocks.</title> 
    436                                 <programlisting language="xml" linenumbering="numbered"> 
    437                                     <textobject> 
    438                                         <textdata fileref="brief-sketch-multiple.xml"/> 
    439                                     </textobject> 
    440                                 </programlisting> 
    441                             </example> 
    442                         </para> 
    443                     </section> 
    444                 </section> 
    445  
    446  
    447  
    448                 <section xml:id="cansas1d_documentation-Foreign_Elements"> 
    449                     <title>Foreign Elements</title> 
    450                     <para> To allow for inclusion of elements that are not defined by the  
    451                         <literal>cansas1d.xsd</literal> XML 
    452                         Schema, XML <emphasis role="italic">foreign elements</emphasis>  
    453                         <indexterm> 
    454                             <primary>XML</primary> 
    455                             <secondary>foreign elements</secondary> 
    456                         </indexterm> 
    457                         are permitted at select locations in the 
    458                         cansas1d/1.1 format. Please refer to the section  
    459                         <link xlink:href="#wiki-XML_Help"><emphasis>XML Help</emphasis></link> 
    460                          for more help with XML foreign elements. </para> 
    461                     <para>  
    462                         There is an example that demonstrates the use of a foreign  
    463                         namespace:<footnote> 
    464                             <para> 
    465                                 <link 
    466                                     xlink:href="http://svn.smallangles.net/trac/canSAS/browser/1dwg/data/Glassy%20Carbon/ISIS/GLASSYC_C4G8G9_withTL.xml" 
    467                                     ><literal 
    468                                         >http://svn.smallangles.net/trac/canSAS/browser/1dwg/data/Glassy%20Carbon/ISIS/GLASSYC_C4G8G9_withTL.xml</literal></link></para> 
    469                         </footnote> 
    470                         This example uses a foreign namespace to record the transmission spectrum related to 
    471                         the acquisition of the SANS data at a time-of-flight facility. Look near line 153 
    472                         for this element:  
    473                         <informalexample> 
    474                             <programlisting>&lt;transmission_spectrum xmlns="urn:transmission:spectrum"></programlisting> 
    475                         </informalexample> 
    476                         The foreign namespace given 
    477                         (<literal>urn:transmission:spectrum</literal>) becomes the default namespace for just the 
    478                         <literal>transmission_spectrum</literal> element. </para> 
    479                     <para>Also refer to <link 
    480                         xlink:href="http://svn.smallangles.net/trac/canSAS/changeset/47">canSAS TRAC 
    481                         ticket #47</link> for an example of arranging the content in  
    482                         <literal>SASprocessnote</literal> to avoid the use of foreign namespace 
    483                         elements. </para> 
    484                 </section> 
    485                 <section xml:id="cansas1d_documentation-Support_Tools"> 
    486                     <title>Support tools for Visualization &amp; Analysis software</title> 
    487                     <para> Support for importing cansas1d/1.1 files exists for these  
    488                         languages and environments:  
    489                     </para> 
    490                     <itemizedlist> 
    491                         <listitem> 
    492                             <para> 
    493                                 <emphasis role="bold">FORTRAN</emphasis>: 
    494                                 See the section titled 
    495                                 <link xlink:href="#cansas1d_documentation-binding-Fortran" 
    496                                     ><emphasis role="italic">Fortran binding</emphasis></link>. 
    497                                 <indexterm> 
    498                                     <primary>binding</primary> 
    499                                     <secondary>FORTRAN</secondary> 
    500                                 </indexterm> 
    501                                 <indexterm> 
    502                                     <primary>FORTRAN</primary> 
    503                                     <see>binding, FORTRAN</see> 
    504                                 </indexterm> 
    505                             </para> 
    506                         </listitem> 
    507                         <listitem> 
    508                             <para> 
    509                                 <emphasis role="bold">IgorPro</emphasis>: 
    510                                 See the section titled 
    511                                 <link xlink:href="#cansas1d_documentation-binding-IgorPro" 
    512                                     ><emphasis role="italic">IgorPro binding</emphasis></link>. 
    513                                 <indexterm> 
    514                                     <primary>binding</primary> 
    515                                     <secondary>IgorPro</secondary> 
    516                                 </indexterm> 
    517                                 <indexterm> 
    518                                     <primary>IgorPro</primary> 
    519                                     <see>binding, IgorPro</see> 
    520                                 </indexterm> 
    521                             </para> 
    522                         </listitem> 
    523                         <listitem> 
    524                             <para> 
    525                                 <emphasis role="bold">Java</emphasis>: 
    526                                 See the section titled 
    527                                 <link xlink:href="#cansas1d_documentation-binding-Java" 
    528                                     ><emphasis role="italic">Java JAXB binding</emphasis></link>. 
    529                                 <indexterm> 
    530                                     <primary>binding</primary> 
    531                                     <secondary>Java</secondary> 
    532                                 </indexterm> 
    533                                 <indexterm> 
    534                                     <primary>Java</primary> 
    535                                     <see>binding, Java</see> 
    536                                 </indexterm> 
    537                             </para> 
    538                         </listitem> 
    539                         <listitem> 
    540                             <para> 
    541                                 <emphasis role="bold">Microsoft Excel</emphasis>: 
    542                                 Support for Microsoft Excel 
    543                                 <indexterm> 
    544                                     <primary>binding</primary> 
    545                                     <secondary>Microsoft Excel</secondary> 
    546                                 </indexterm> 
    547                                 <indexterm> 
    548                                     <primary>Microsoft Excel</primary> 
    549                                     <see>binding, Microsoft Excel</see> 
    550                                 </indexterm> 
    551                                 is provided through the default canSAS stylesheet <link 
    552                                     xlink:href="http://svn.smallangles.net/svn/canSAS/1dwg/trunk/cansasxml-html.xsl" 
    553                                     >cansasxml-html.xsl</link>.  
    554                                 The <link 
    555                                     xlink:href="http://www.isis.stfc.ac.uk/instruments/loq/loq2470.html" 
    556                                     >ISIS LOQ instrument</link> has provided an <link 
    557                                         xlink:href="http://www.isis.rl.ac.uk/archive/LargeScale/LOQ/xml/cansas_xml_format.pdf" 
    558                                         >excellent description</link><footnote><para><link 
    559                                     xlink:href="http://www.isis.stfc.ac.uk/instruments/loq/loq2470.html" 
    560                                     ><literal>http://www.isis.stfc.ac.uk/instruments/loq/loq2470.html</literal 
    561                                     ></link></para></footnote> 
    562                                 of how to import data from the 
    563                                 cansas1d/1.1 format into Excel. 
    564                                 Also note that the 
    565                                     <link 
    566                                     xlink:href="http://www.isis.rl.ac.uk/archive/LargeScale/LOQ/loq.htm">old 
    567                                     WWW site</link><footnote><para><link 
    568                                     xlink:href="http://www.isis.rl.ac.uk/LargeScale/LOQ/loq.htm" 
    569                                     ><literal>http://www.isis.rl.ac.uk/LargeScale/LOQ/loq.htm</literal 
    570                                     ></link></para></footnote> 
    571                                 may still be available.  
    572                             </para> 
    573                         </listitem> 
    574                         <listitem> 
    575                             <para> 
    576                                 <emphasis role="bold">PHP</emphasis>: 
    577                                 The <link xlink:href="#cansas1d_documentation-converting_into_XML" 
    578                                     ><emphasis role="italic">canSAS/xmlWriter</emphasis></link> 
    579                                 <indexterm><primary><literal>xmlWriter</literal></primary></indexterm> 
    580                                 is implemented in <link xlink:href="http://www.php.net">PHP</link 
    581                                 ><footnote><para><link xlink:href="http://www.php.net" 
    582                                     ><literal>http://www.php.net</literal></link></para></footnote> 
    583                                 <indexterm> 
    584                                     <primary>binding</primary> 
    585                                     <secondary>PHP</secondary> 
    586                                 </indexterm> 
    587                                 <indexterm> 
    588                                     <primary>PHP</primary> 
    589                                     <see>binding, PHP</see> 
    590                                 </indexterm> 
    591                                 and writes a cansas1d/1.1 data file given three-column ASCII data as input. 
    592                                 (<link 
    593                                     xlink:href="http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/php/xmlWriter/index.php" 
    594                                     >PHP source</link>)<footnote> 
    595                                     <para> 
    596                                         <link xlink:href="http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/php/xmlWriter/index.php" 
    597                                             ><literal>http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/php/xmlWriter/index.php</literal></link> 
    598                                     </para> 
    599                                 </footnote> 
    600                                 The code uses <link xlink:href="http://www.php.net/DomDocument">DomDocument</link 
    601                                 ><footnote><para><link xlink:href="http://www.php.net/DomDocument" 
    602                                     ><literal>http://www.php.net/DomDocument</literal></link></para></footnote> 
    603                                 to build the XML file.  Look for the line beginning with 
    604                                 <literal>function prepare_cansasxml($post)</literal>. 
    605                             </para> 
    606                             <para> 
    607                                 Another example of <literal>DomDocument</literal> 
    608                                 is in the <literal>function surveillance($post)</literal> where 
    609                                 logging information is inserted into an XML file. 
    610                             </para> 
    611                         </listitem> 
    612                         <listitem> 
    613                             <para> 
    614                                 <emphasis role="bold">Python</emphasis>: 
    615                                 See the section titled 
    616                                 <link xlink:href="#cansas1d_documentation-binding-Python" 
    617                                     ><emphasis role="italic">Python binding</emphasis></link>. 
    618                                 <indexterm> 
    619                                     <primary>binding</primary> 
    620                                     <secondary>Python</secondary> 
    621                                 </indexterm> 
    622                                 <indexterm> 
    623                                     <primary>Python</primary> 
    624                                     <see>binding, Python</see> 
    625                                 </indexterm> 
    626                             </para> 
    627                         </listitem> 
    628                         <listitem> 
    629                             <para> 
    630                                 <emphasis role="bold">XSLT</emphasis> (useful in a web browser) 
    631                                 is described later in the section titled  
    632                                 <link xlink:href="#xml-stylesheet"><emphasis role="italic">Example XML Stylesheets</emphasis></link>. 
    633                                 <indexterm> 
    634                                     <primary>binding</primary> 
    635                                     <secondary>XML Stylesheet (XSLT)</secondary> 
    636                                 </indexterm> 
    637                             </para> 
    638                         </listitem> 
    639                     </itemizedlist> 
    640                 </section> 
    641                 <section xml:id="cansas1d_documentation-repositories"> 
    642                     <title>Software repositories (for cansas1d/1.1 standard)</title> 
    643                     <itemizedlist> 
    644                         <listitem> 
    645                             <para><emphasis role="bold">TRAC</emphasis>: <link 
    646                                     xlink:href="http://svn.smallangles.net/trac/canSAS/browser/1dwg/tags/v1.0" 
    647                                     ><literal>http://svn.smallangles.net/trac/canSAS/browser/1dwg/tags/v1.0</literal></link></para> 
    648                         </listitem> 
    649                         <listitem> 
    650                             <para><emphasis role="bold">Subversion</emphasis>: <link 
    651                                     xlink:href="http://svn.smallangles.net/svn/canSAS/1dwg/tags/v1.0" 
    652                                     ><literal>http://svn.smallangles.net/svn/canSAS/1dwg/tags/v1.0</literal></link></para> 
    653                         </listitem> 
    654                     </itemizedlist> 
    655                 </section> 
    656             </section> 
    657             <section xml:id="cansas1d_documentation-schema_validation"> 
    658                 <title>Validation of XML against the Schema</title> 
    659                 <indexterm> 
    660                     <primary>validation</primary> 
    661                     <secondary>against XML Schema</secondary> 
    662                 </indexterm> 
    663                 <orderedlist> 
    664                     <listitem> 
    665                         <para>open browser to:  
    666                             <link xlink:href="http://www.xmlvalidation.com/" 
    667                                 ><literal>http://www.xmlvalidation.com/</literal></link></para> 
    668                     </listitem> 
    669                     <listitem> 
    670                         <para>paste content of candidate XML file (with reference in the header to the XML 
    671                             Schema as shown above) into the form</para> 
    672                     </listitem> 
    673                     <listitem> 
    674                         <para>press <literal>&lt;validate></literal></para> 
    675                     </listitem> 
    676                     <listitem> 
    677                         <para>paste content of  
    678                             <literal>cansas1d.xsd</literal><footnote><para><link 
    679                                 xlink:href="http://svn.smallangles.net/svn/canSAS/1dwg/trunk/cansas1d.xsd" 
    680                                 ><literal>http://svn.smallangles.net/svn/canSAS/1dwg/trunk/cansas1d.xsd</literal 
    681                             ></link></para></footnote> 
    682                             XSD file into form and press <literal>&lt;continue validation></literal>.</para> 
    683                     </listitem> 
    684                     <listitem> 
    685                         <para>check the results</para> 
    686                     </listitem> 
    687                 </orderedlist> 
    688             </section> 
     337.. index:: case study; dry chick collagen SAXS 
     338 
     339**dry chick collagen SAXS** 
     340        see :ref:`case_study-collagen` section 
     341         
     342        SAXS data from *dry chick collagen* illustrates the 
     343        minimum information necessary to meet the requirements of the standard 
     344        format. 
     345 
     346.. index:: case study; AF1410 steel SANS 
     347 
     348**AF1410 steel SANS** 
     349        see :ref:`case_study-af1410` section 
     350         
     351        SANS data from *AF1410 steel* using magnetic 
     352        contrast variation (with multiple samples and multiple data sets for each 
     353        sample), the files can be viewed from the TRAC site (no description yet). 
     354         
     355        http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/examples/af1410/ 
     356 
     357.. index:: XML file; cansas1d-template.xml 
     358 
     359**cansas1d-template.xml** 
     360        http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/cansas1d-template.xml 
     361         
     362    This is used to test all the rules in the XML 
     363    Schema. This is probably not a very good example to use as a starting point 
     364    for creating XML files with a text editor since it tests many of the 
     365    special-case rules. 
     366 
     367 
     368XML layout for multiple experiments 
     369------------------------------------------- 
     370 
     371.. index:: 
     372        single: multiple experiments 
     373        single: multiple data sets 
     374 
     375Each experiment is described with a single *SASentry* element. The 
     376fragment below shows how multiple experiments with multiple data sets 
     377can be included in a single XML file. This illustrates using more than 
     378one *SASentry* and more than one *SASdata* element. 
     379 
     380.. literalinclude:: ../src/brief-sketch-multiple.xml 
     381   :language: xml 
     382   :linenos: 
     383 
     384Full examples of canSAS XML files with multiple experiments 
     385include: 
     386 
     387.. index:: XML file; W1W2.XML 
     388 
     389**multiple data sets** 
     390        ISIS LOQ SANS instrument:  
     391        http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/W1W2.XML 
     392 
     393.. index:: XML file; cs_af1410.xml 
     394 
     395**multiple samples, multiple data sets** 
     396        AF1410 steel SANS contrast variation study from NIST: 
     397        http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/examples/af1410/cs_af1410.xml 
     398         
     399    SANS study using magnetic 
     400    contrast variation (with multiple samples and multiple data sets for each 
     401    sample), the files can be viewed from the TRAC site (no description yet). 
     402 
     403Foreign Elements 
     404------------------------ 
     405 
     406.. index:: XML; foreign elements 
     407 
     408To allow for inclusion of elements that are not defined by the  
     409*cansas1d.xsd* XML Schema, XML **foreign elements**  
     410are permitted at select locations in the 
     411cansas1d/1.1 format. Please refer to the :ref:`XML Help` section  
     412for more help with XML foreign elements. 
     413 
     414.. note::  **Need to make another example.** 
     415        This example was based on v1.0.  With v1.1, there is no need for 
     416        the foreign namespace in this example.   
     417 
     418There is an example that demonstrates the use of a foreign namespace: 
     419http://svn.smallangles.net/trac/canSAS/browser/1dwg/data/Glassy%20Carbon/ISIS/GLASSYC_C4G8G9_withTL.xml 
     420 
     421This example uses a foreign namespace to record the transmission spectrum related to 
     422the acquisition of the SANS data at a time-of-flight facility. Look near line 153 
     423for this element:: 
     424 
     425        <transmission_spectrum xmlns="urn:transmission:spectrum"> 
     426 
     427The foreign namespace given (``urn:transmission:spectrum``) becomes the  
     428default namespace for just the *transmission_spectrum* element.* 
     429 
     430Also refer to canSAS TRAC ticket #47 
     431(http://svn.smallangles.net/trac/canSAS/changeset/47) 
     432for an example of arranging the content in  
     433*SASprocessnote* to avoid the use of foreign namespace 
     434elements. 
     435 
     436Support tools for Visualization & Analysis software 
     437========================================================= 
     438 
     439Support for importing cansas1d/1.1 files exists for  
     440these languages and environments:  
     441 
     442.. index:: 
     443        single: binding; FORTRAN 
     444        see: FORTRAN; binding, FORTRAN 
     445 
     446**FORTRAN** 
     447        See the :ref:`fortran.binding` section. 
     448 
     449.. index:: 
     450        single: binding; IgorPro 
     451        see: IgorPro; binding, IgorPro 
     452 
     453**IgorPro** 
     454        See the :ref:`IgorPro.binding` section. 
     455 
     456.. index:: 
     457        single: binding; Java JAXB 
     458        see: Java JAXB; binding, Java JAXB 
     459 
     460**Java JAXB** 
     461        See the :ref:`Java.JAXB.binding` section. 
     462 
     463.. index:: 
     464        single: binding; Microsoft Excel 
     465        see: Microsoft Excel; binding, Microsoft Excel 
     466 
     467**Microsoft Excel** 
     468        Support for Microsoft Excel is provided through the default canSAS stylesheet, 
     469        *cansasxml-html.xsl* (http://svn.smallangles.net/svn/canSAS/1dwg/trunk/cansasxml-html.xsl). 
     470        The ISIS **LOQ** instrument (http://www.isis.stfc.ac.uk/instruments/loq/loq2470.html) 
     471        has provided an excellent description of how to import data from the cansas1d/1.1 format into Excel. 
     472        Also note that the old WWW site (http://www.isis.rl.ac.uk/archive/LargeScale/LOQ/loq.htm) 
     473        may still be available.  
     474 
     475.. index:: 
     476        single: binding; PHP 
     477        see: PHP; binding, PHP 
     478        single: xmlWriter 
     479 
     480**PHP** 
     481        See the :ref:`PHP.binding` section. 
     482         
     483        The *canSAS/xmlWriter* (http://www.smallangles.net/canSAS/xmlWriter/) 
     484        is implemented in PHP (http://www.php.net) and writes a cansas1d/1.1 data  
     485        file given three-column ASCII data as input.  The code uses 
     486        *DomDocument* (http://www.php.net/DomDocument) 
     487        to build the XML file.  Look for the line beginning with:: 
     488         
     489                function prepare_cansasxml($post) 
     490         
     491        Another example of *DomDocument* 
     492        is in the ``function surveillance($post)`` where 
     493        logging information is inserted into an XML file. 
     494         
     495        PHP source: http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/php/xmlWriter/index.php 
     496 
     497.. index:: 
     498        single: binding; Python 
     499        see: Python; binding, Python 
     500        single: xmlWriter 
     501 
     502**Python** 
     503        See the :ref:`Python.binding` section. 
     504 
     505.. index:: 
     506        single: binding; XML Stylesheet (XSLT) 
     507 
     508**XSLT** 
     509        *XSLT*  (useful in a web browser) is described later in the 
     510        :ref:`Example.XML.Stylesheets` section. 
     511 
     512 
     513Software repositories (for cansas1d/1.1 standard) 
     514========================================================= 
     515 
     516TRAC (bug reporting) 
     517        http://svn.smallangles.net/trac/canSAS/browser/1dwg/tags/v1.1 
     518 
     519SVN (*subversion* revision control system) 
     520        http://svn.smallangles.net/svn/canSAS/1dwg/tags/v1.1 
  • 1dwg/trunk/doc/source/tutorial.rst

    r241 r242  
    11.. $Id$ 
    22 
     3================ 
    34Tutorial 
    4 ======== 
     5================ 
    56 
     7.. index:: cansas1d/1.1 standard 
    68 
    7 .. toctree:: 
    8    :maxdepth: 2 
    9     
     9This is a tutorial for *cansas1d/1.1*, 
     10the canSAS standard format for storing small-angle 
     11scattering data in XML files. 
     12 
     13At present, the tutorial section consists of two case studies, 
     14which can serve as examples.  The opportunity is ripe for a 
     15better tutorial. 
     16 
     17.. 
     18        .. toctree:: 
     19           :maxdepth: 2 
     20            
     21           case-studies 
     22 
     23Case Studies 
     24================ 
     25 
     26.. _case_study-collagen: 
     27 
     28Case Study: Dry Chick Collagen 
     29-------------------------------- 
     30 
     31.. _case_study-af1410: 
     32 
     33Case Study: AF1410 steel 
     34--------------------------------- 
  • 1dwg/trunk/doc/source/validation.rst

    r241 r242  
    44 
    55=================================================== 
    6 Validation 
     6Validation of XML against the Schema 
    77=================================================== 
    88 
     9.. index:: validation; against XML Schema 
     10 
     11#. open browser to: http://www.xmlvalidation.com/ 
     12#. paste content of candidate XML file  
     13        (with reference in the header to the XML 
     14        Schema as shown above) into the form 
     15 
     16#. press ``<validate>`` 
     17#. paste content of *cansas1d.xsd* XSD file into form  
     18        and press ``<continue validation>`` 
     19         
     20        (http://svn.smallangles.net/svn/canSAS/1dwg/trunk/cansas1d.xsd) 
     21#. check the results 
Note: See TracChangeset for help on using the changeset viewer.