Changeset 111


Ignore:
Timestamp:
Sep 26, 2009 3:41:11 PM (10 years ago)
Author:
prjemian
Message:

more documentation translated, refs #19

Location:
1dwg/trunk/doc
Files:
4 added
11 edited

Legend:

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

    r109 r111  
    1818        <mediaobject> 
    1919            <imageobject> 
    20                 <imagedata fileref="../graphics/2-SASdata.png" width="200px" 
     20                <imagedata fileref="../graphics/2-SASdata.png" width="200pt" 
    2121                    scalefit="1"/> 
    2222            </imageobject> 
     
    3333        <mediaobject> 
    3434            <imageobject> 
    35                 <imagedata fileref="../graphics/Q-geometry.jpg" width="200px" 
     35                <imagedata fileref="../graphics/Q-geometry.jpg" width="200pt" 
    3636                    scalefit="1"/> 
    3737            </imageobject> 
  • 1dwg/trunk/doc/cansas1d_element_SASentry.xml

    r105 r111  
    1818        <mediaobject> 
    1919            <imageobject> 
    20                 <imagedata fileref="../graphics/1-SASroot.png" width="200px" 
     20                <imagedata fileref="../graphics/1-SASroot.png" width="200pt" 
    2121                    scalefit="1"/> 
    2222            </imageobject> 
  • 1dwg/trunk/doc/cansas1d_element_SASinstrument.xml

    r110 r111  
    1818        <mediaobject> 
    1919            <imageobject> 
    20                 <imagedata fileref="../graphics/4-SASinstrument.png" width="200px" 
     20                <imagedata fileref="../graphics/4-SASinstrument.png" width="200pt" 
    2121                    scalefit="1"/> 
    2222            </imageobject> 
  • 1dwg/trunk/doc/cansas1d_element_SASroot.xml

    r110 r111  
    1818        <mediaobject> 
    1919            <imageobject> 
    20                 <imagedata fileref="../graphics/1-SASroot.png" width="200px" 
     20                <imagedata fileref="../graphics/1-SASroot.png" width="200pt" 
    2121                    scalefit="1"/> 
    2222            </imageobject> 
  • 1dwg/trunk/doc/cansas1d_element_SASsample.xml

    r110 r111  
    1818        <mediaobject> 
    1919            <imageobject> 
    20                 <imagedata fileref="../graphics/3-SASsample.png" width="200px" scalefit="1"/> 
     20                <imagedata fileref="../graphics/3-SASsample.png" width="200pt" scalefit="1"/> 
    2121            </imageobject> 
    2222            <textobject> 
     
    154154                                        <imagedata 
    155155                                            fileref="../graphics/translation-orientation-geometry.jpg" 
    156                                             width="200px" scalefit="1"/> 
     156                                            width="200pt" scalefit="1"/> 
    157157                                    </imageobject> 
    158158                                    <textobject> 
     
    169169                                        <imagedata 
    170170                                            fileref="../graphics/translation-orientation-geometry-2.jpg" 
    171                                             width="200px" scalefit="1"/> 
     171                                            width="200pt" scalefit="1"/> 
    172172                                    </imageobject> 
    173173                                    <textobject> 
  • 1dwg/trunk/doc/cansas1d_element_SASsource.xml

    r110 r111  
    1818        <mediaobject> 
    1919            <imageobject> 
    20                 <imagedata fileref="../graphics/5-SASsource.png" width="200px" 
     20                <imagedata fileref="../graphics/5-SASsource.png" width="200pt" 
    2121                    scalefit="1"/> 
    2222            </imageobject> 
     
    213213                                <mediaobject> 
    214214                                    <imageobject> 
    215                                         <imagedata fileref="../graphics/translation-orientation-geometry.jpg" width='200px' scalefit='1'/> 
     215                                        <imagedata fileref="../graphics/translation-orientation-geometry.jpg" width='200pt' scalefit='1'/> 
    216216                                    </imageobject> 
    217217                                    <caption> 
     
    223223                                <mediaobject> 
    224224                                    <imageobject> 
    225                                         <imagedata fileref="../graphics/translation-orientation-geometry-2.jpg" width='200px' scalefit='1'/> 
     225                                        <imagedata fileref="../graphics/translation-orientation-geometry-2.jpg" width='200pt' scalefit='1'/> 
    226226                                    </imageobject> 
    227227                                    <caption> 
  • 1dwg/trunk/doc/cansas1d_element_XML_header.xml

    r108 r111  
    1818        <mediaobject> 
    1919            <imageobject> 
    20                 <imagedata fileref="../graphics/1-SASroot.png" width="200px" scalefit="1"/> 
     20                <imagedata fileref="../graphics/1-SASroot.png" width="200pt" scalefit="1"/> 
    2121            </imageobject> 
    2222            <textobject> 
  • 1dwg/trunk/doc/elements.xml

    r110 r111  
    2424    <xi:include href="cansas1d_element_SASinstrument.xml"/> 
    2525    <xi:include href="cansas1d_element_SASsource.xml"/> 
    26     <!--<xi:include href="cansas1d_element_SAScollimation.xml"/>--> 
    27     <!--<xi:include href="cansas1d_element_SASdetector.xml"/>--> 
    28     <!--<xi:include href="cansas1d_element_SASprocess.xml"/>--> 
    29     <!--<xi:include href="cansas1d_element_SASnote.xml"/>--> 
     26    <xi:include href="cansas1d_element_SAScollimation.xml"/> 
     27    <xi:include href="cansas1d_element_SASdetector.xml"/> 
     28    <xi:include href="cansas1d_element_SASprocess.xml"/> 
     29    <xi:include href="cansas1d_element_SASnote.xml"/> 
    3030    <xi:include href="cansas1d_element_any.xml"/> 
    3131</chapter> 
  • 1dwg/trunk/doc/manual.xml

    r110 r111  
    5757            CanSAS 1-D Data Format Manual, v1.0 
    5858        </para> 
     59        <note><para> 
     60            Provide a note here describing CanSAS and the initiative to establish 
     61            a standard file format. 
     62        </para></note> 
     63        <para> 
     64            "CanSAS" stands for "Collective Action for Nomadic Small-Angle Scatterers. 
     65        </para> 
     66        <para> 
     67            This work is the initiative of the CanSAS 1D Data Formats Working Group,  
     68            established at the canSAS-V workshop, NIST, Gaithersburg, Maryland,  
     69            USA from October 29th to 31st 2007.  It derives many of its foundations 
     70            from previous works such as the SASXML format, a joint collaboration 
     71            between ISIS and ILL. 
     72        </para> 
    5973    </preface> 
    6074 
     
    7286        cansas1d_SASinstrument 
    7387        cansas1d_SASsource 
    74     cansas1d_SAScollimation 
    75     cansas1d_SASdetector 
    76     cansas1d_SASprocess 
    77     cansas1d_SASnote 
     88        cansas1d_SAScollimation 
     89        cansas1d_SASdetector 
     90        cansas1d_SASprocess 
     91        cansas1d_SASnote 
    7892        cansas1d_block_diagrams 
    7993        1D_Data_Formats_Working_Group 
  • 1dwg/trunk/doc/wiki.xml

    r106 r111  
    6464                next figure. Refer to the [[cansas1d_block_diagrams | block diagrams]] for 
    6565                alternative depictions. See <link 
    66                     xlink:href="http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/cansas1d.xml">http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/cansas1d.xml</link> 
    67                 for an example XML file. Examples, Case Studies, and other background 
    68                 information are below. More discussion can be found on the 
     66                    xlink:href="http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/cansas1d.xml" 
     67                    >http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/cansas1d.xml</link> 
     68                for an example XML file. Examples, Case Studies, and other background information 
     69                are below. More discussion can be found on the 
    6970                [[1D_Data_Formats_Working_Group|canSAS 1D Data Formats Working Group]] page and its 
    7071                [[Talk:1D_Data_Formats_Working_Group|discussion]] page. Details about each specific 
     
    7576                <mediaobject> 
    7677                    <imageobject> 
    77                         <imagedata fileref="../graphics/10-minimum.png" scalefit="1" width="200px"/> 
     78                        <imagedata fileref="../graphics/10-minimum.png" scalefit="1" width="200pt"/> 
    7879                    </imageobject> 
    7980                </mediaobject> 
     
    195196                <title>Required XML file header</title> 
    196197                <programlisting> 
    197 &lt;?xml version="1.0"?> 
    198 &lt;?xml-stylesheet type="text/xsl" href="cansasxml-html.xsl" ?> 
    199 &lt;SASroot version="1.0" 
    200     xmlns="cansas1d/1.0" 
    201     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    202     xsi:schemaLocation="cansas1d/1.0  
    203         http://svn.smallangles.net/svn/canSAS/1dwg/trunk/cansas1d.xsd" 
    204     > 
     198                    &lt;?xml version="1.0"?> 
     199                    &lt;?xml-stylesheet type="text/xsl" href="cansasxml-html.xsl" ?> 
     200                    &lt;SASroot version="1.0" 
     201                    xmlns="cansas1d/1.0" 
     202                    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
     203                    xsi:schemaLocation="cansas1d/1.0  
     204                    http://svn.smallangles.net/svn/canSAS/1dwg/trunk/cansas1d.xsd" 
     205                    > 
    205206                </programlisting> 
    206207            </section> 
     
    225226                        <mediaobject> 
    226227                            <imageobject> 
    227                                 <imagedata fileref="../graphics/Q-geometry.jpg"   
    228                                     scalefit="1" width="200px" 
    229                                 /></imageobject> 
     228                                <imagedata fileref="../graphics/Q-geometry.jpg" scalefit="1" 
     229                                    width="200pt"/></imageobject> 
    230230                        </mediaobject> 
    231231                    </figure> 
     
    286286                                <title>definition of translation and orientation geometry as viewed 
    287287                                    from the detector towards the source</title> 
    288                                 <mediaobject> 
    289                                     <imageobject> 
    290                                         <imagedata 
    291                                             fileref="../graphics/translation-orientation-geometry.jpg" 
    292                                             scalefit="1" width="200px"/></imageobject> 
    293                                 </mediaobject> 
    294                             </figure> 
    295                             <figure> 
    296                                 <title>definition of translation and orientation geometry as viewed 
    297                                     from the source towards the detector</title> 
    298                                 <mediaobject> 
    299                                     <imageobject> 
    300                                         <imagedata 
    301                                             fileref="../graphics/translation-orientation-geometry-2.jpg" 
    302                                             scalefit="1" width="200px"/></imageobject> 
    303                                 </mediaobject> 
     288                                <para> 
     289                                    <table> 
     290                                        <title/> 
     291                                        <tgroup cols="2"> 
     292                                            <tbody> 
     293                                                <row> 
     294                                                    <entry> 
     295                                                        <mediaobject> 
     296                                                            <imageobject> 
     297                                                                <imagedata 
     298                                                                    fileref="../graphics/translation-orientation-geometry.jpg" 
     299                                                                    width="200pt" scalefit="1"/> 
     300                                                            </imageobject> 
     301                                                            <caption> 
     302                                                                <para>as viewed from source</para> 
     303                                                            </caption> 
     304                                                        </mediaobject> 
     305                                                    </entry> 
     306                                                    <entry> 
     307                                                        <mediaobject> 
     308                                                            <imageobject> 
     309                                                                <imagedata 
     310                                                                    fileref="../graphics/translation-orientation-geometry-2.jpg" 
     311                                                                    width="200pt" scalefit="1"/> 
     312                                                            </imageobject> 
     313                                                            <caption> 
     314                                                                <para>as viewed from detector</para> 
     315                                                            </caption> 
     316                                                        </mediaobject> 
     317                                                    </entry> 
     318                                                </row> 
     319                                            </tbody> 
     320                                        </tgroup> 
     321                                    </table> 
     322                                </para> 
    304323                            </figure> 
    305324                        </listitem> 
     
    424443                        <listitem> 
    425444                            <para>be sure to update to the latest SVN repository revision (command: 
    426                                     <code>svn update</code>) </para> 
     445                                <code>svn update</code>) </para> 
    427446                        </listitem> 
    428447                        <listitem> 
     
    510529                    elements and multiple SASdata elements. 
    511530                    <programlisting> 
    512 &lt;?xml version="1.0"?> 
    513 &lt;?xml-stylesheet type="text/xsl" href="cansasxml-html.xsl" ?> 
    514 &lt;SASroot version="1.0" 
    515    xmlns="cansas1d/1.0" 
    516    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    517    xsi:schemaLocation="cansas1d/1.0 http://svn.smallangles.net/svn/canSAS/1dwg/trunk/cansas1d.xsd" 
    518    > 
    519    &lt;SASentry name="071121.dat#S22"> 
    520      &lt;!-\- contents of the first experiment in the file go here -\-> 
    521    &lt;/SASentry> 
    522    &lt;SASentry name="example temperature series"> 
    523      &lt;!-\- example with two SAS data sets related to the same sample -\-> 
    524      &lt;Title>title of this series&lt;/Title> 
    525      &lt;Run name="run1">42-001&lt;/Run> 
    526      &lt;Run name="run2">42-002&lt;/Run> 
    527      &lt;SASdata name="run1"> 
    528        &lt;!-\- data from 42-001 run comes here -\-> 
    529      &lt;/SASdata> 
    530      &lt;SASdata name="run2"> 
    531        &lt;!-\- data from 42-002 run comes here -\-> 
    532      &lt;/SASdata> 
    533      &lt;!-\- other elements come here for this entry -\-> 
    534    &lt;/SASentry> 
    535    &lt;SASentry name="other sample"> 
    536      &lt;!-\- any number of additional experiments can be included, as desired -\-> 
    537      &lt;!-\- SASentry elements in the same XML file do not have to be related -\-> 
    538    &lt;/SASentry> 
    539 &lt;/SASroot> 
     531                        &lt;?xml version="1.0"?> 
     532                        &lt;?xml-stylesheet type="text/xsl" href="cansasxml-html.xsl" ?> 
     533                        &lt;SASroot version="1.0" 
     534                        xmlns="cansas1d/1.0" 
     535                        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
     536                        xsi:schemaLocation="cansas1d/1.0 http://svn.smallangles.net/svn/canSAS/1dwg/trunk/cansas1d.xsd" 
     537                        > 
     538                        &lt;SASentry name="071121.dat#S22"> 
     539                        &lt;!-\- contents of the first experiment in the file go here -\-> 
     540                        &lt;/SASentry> 
     541                        &lt;SASentry name="example temperature series"> 
     542                        &lt;!-\- example with two SAS data sets related to the same sample -\-> 
     543                        &lt;Title>title of this series&lt;/Title> 
     544                        &lt;Run name="run1">42-001&lt;/Run> 
     545                        &lt;Run name="run2">42-002&lt;/Run> 
     546                        &lt;SASdata name="run1"> 
     547                        &lt;!-\- data from 42-001 run comes here -\-> 
     548                        &lt;/SASdata> 
     549                        &lt;SASdata name="run2"> 
     550                        &lt;!-\- data from 42-002 run comes here -\-> 
     551                        &lt;/SASdata> 
     552                        &lt;!-\- other elements come here for this entry -\-> 
     553                        &lt;/SASentry> 
     554                        &lt;SASentry name="other sample"> 
     555                        &lt;!-\- any number of additional experiments can be included, as desired -\-> 
     556                        &lt;!-\- SASentry elements in the same XML file do not have to be related -\-> 
     557                        &lt;/SASentry> 
     558                        &lt;/SASroot> 
    540559                    </programlisting></para> 
    541560            </section> 
     
    548567                below]] for deeper discussions on foreign elements. </para> 
    549568            <para> No examples exist. <note> 
    550                     <para> 2009-09, PRJ: Actually, the ISIS glassy carbon data is now an example 
    551                     </para> 
    552                 </note> At present, all examples of canSAS xml files using foreign namespaces have 
     569                <para> 2009-09, PRJ: Actually, the ISIS glassy carbon data is now an example 
     570                </para> 
     571            </note> At present, all examples of canSAS xml files using foreign namespaces have 
    553572                been converted to bring that data into either the '''SASprocessnote''' or 
    554573                '''SASnote''' elements. Refer to the 
     
    560579            <title>Support tools for Visualization &amp; Analysis software</title> 
    561580            <para> Support for importing canSAS1d/1.0 files exists for these languages: <note> 
    562                     <para>Refactor the wiki pages here and link as appropriate.</para> 
    563                 </note></para> 
     581                <para>Refactor the wiki pages here and link as appropriate.</para> 
     582            </note></para> 
    564583            <itemizedlist> 
    565584                <listitem> 
     
    574593                <listitem> 
    575594                    <para> 
    576                         <emphasis role="bold">Microsoft Excel</emphasis> 
    577                         Support for Microsoft Excel is provided through the default  
    578                         canSAS stylesheet  
    579                         <link  
    580                             xlink:href="http://svn.smallangles.net/svn/canSAS/1dwg/trunk/cansasxml-html.xsl">cansasxml-html.xsl</link>. 
    581                         An  
    582                         <link  
    583                             xlink:href="http://www.isis.rl.ac.uk/archive/LargeScale/LOQ/xml/cansas_xml_format.pdf">excellent description</link> 
    584                         of how to import data from the cansas1d/1.0 format into Excel is available  
    585                         from the  
    586                         <link xlink:href="http://www.isis.stfc.ac.uk/instruments/loq/loq2470.html">ISIS LOQ instrument</link> 
    587                         (http://www.isis.stfc.ac.uk/instruments/loq/loq2470.html). 
    588                         Also note the 
    589                         <link  
    590                             xlink:href="http://www.isis.rl.ac.uk/atchive/LargeScale/LOQ/loq.htm">old WWW site</link>. 
    591                         (http://www.isis.rl.ac.uk/LargeScale/LOQ/loq.htm) may still be available. 
    592                     </para> 
     595                        <emphasis role="bold">Microsoft Excel</emphasis> Support for Microsoft Excel 
     596                        is provided through the default canSAS stylesheet <link 
     597                            xlink:href="http://svn.smallangles.net/svn/canSAS/1dwg/trunk/cansasxml-html.xsl" 
     598                            >cansasxml-html.xsl</link>. An <link 
     599                                xlink:href="http://www.isis.rl.ac.uk/archive/LargeScale/LOQ/xml/cansas_xml_format.pdf" 
     600                                >excellent description</link> of how to import data from the 
     601                        cansas1d/1.0 format into Excel is available from the <link 
     602                            xlink:href="http://www.isis.stfc.ac.uk/instruments/loq/loq2470.html" 
     603                            >ISIS LOQ instrument</link> 
     604                        (http://www.isis.stfc.ac.uk/instruments/loq/loq2470.html). Also note the 
     605                        <link 
     606                            xlink:href="http://www.isis.rl.ac.uk/atchive/LargeScale/LOQ/loq.htm">old 
     607                            WWW site</link>. (http://www.isis.rl.ac.uk/LargeScale/LOQ/loq.htm) may 
     608                        still be available. </para> 
    593609                </listitem> 
    594610                <listitem> 
     
    607623            <itemizedlist> 
    608624                <listitem> 
    609                     <para><emphasis role="bold">TRAC</emphasis>: 
    610                         <link xlink:href="http://svn.smallangles.net/trac/canSAS/browser/1dwg/tags/v1.0">http://svn.smallangles.net/trac/canSAS/browser/1dwg/tags/v1.0</link></para> 
    611                 </listitem> 
    612                 <listitem> 
    613                     <para><emphasis role="bold">Subversion</emphasis>: 
    614                         <link xlink:href="http://svn.smallangles.net/svn/canSAS/1dwg/tags/v1.0">http://svn.smallangles.net/svn/canSAS/1dwg/tags/v1.0</link></para> 
     625                    <para><emphasis role="bold">TRAC</emphasis>: <link 
     626                        xlink:href="http://svn.smallangles.net/trac/canSAS/browser/1dwg/tags/v1.0" 
     627                        >http://svn.smallangles.net/trac/canSAS/browser/1dwg/tags/v1.0</link></para> 
     628                </listitem> 
     629                <listitem> 
     630                    <para><emphasis role="bold">Subversion</emphasis>: <link 
     631                        xlink:href="http://svn.smallangles.net/svn/canSAS/1dwg/tags/v1.0" 
     632                        >http://svn.smallangles.net/svn/canSAS/1dwg/tags/v1.0</link></para> 
    615633                </listitem> 
    616634            </itemizedlist> 
     
    620638        <title>Validation of XML against the Schema</title> 
    621639        <orderedlist> 
    622             <listitem><para>open browser to:   http://www.xmlvalidation.com/</para></listitem> 
    623             <listitem><para>paste content of candidate XML file (with reference in the header to the XML Schema as shown above) into the form</para></listitem> 
    624             <listitem><para>press &lt;validate></para></listitem> 
    625             <listitem><para>paste content of [http://svn.smallangles.net/svn/canSAS/1dwg/trunk/cansas1d.xsd cansas1d.xsd] XSD file into form and press &lt;continue validation></para></listitem> 
    626             <listitem><para>check the results</para></listitem> 
     640            <listitem> 
     641                <para>open browser to: http://www.xmlvalidation.com/</para> 
     642            </listitem> 
     643            <listitem> 
     644                <para>paste content of candidate XML file (with reference in the header to the XML 
     645                    Schema as shown above) into the form</para> 
     646            </listitem> 
     647            <listitem> 
     648                <para>press &lt;validate></para> 
     649            </listitem> 
     650            <listitem> 
     651                <para>paste content of 
     652                    [http://svn.smallangles.net/svn/canSAS/1dwg/trunk/cansas1d.xsd cansas1d.xsd] XSD 
     653                    file into form and press &lt;continue validation></para> 
     654            </listitem> 
     655            <listitem> 
     656                <para>check the results</para> 
     657            </listitem> 
    627658        </orderedlist> 
    628659    </section> 
     
    631662        <para>The various references for help on XML have been moved to their own wiki page: 
    632663            [[XmlHelp]] </para> 
    633         <note><para>chapter="Other" section="XML Help" xml:id="wiki-XML_Help"</para></note> 
     664        <note> 
     665            <para>chapter="Other" section="XML Help" xml:id="wiki-XML_Help"</para> 
     666        </note> 
    634667    </section> 
    635668</chapter> 
Note: See TracChangeset for help on using the changeset viewer.