Changeset 132


Ignore:
Timestamp:
Oct 8, 2009 12:17:41 PM (10 years ago)
Author:
prjemian
Message:

make sure the canonical "cansas1d/1.0" is all lowercase in the documentation, refs #19

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

Legend:

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

    r130 r132  
    208208            attempts 
    209209            to open the fileand read its contents as if it conformed to the canSAS XML standard 
    210             forreduced 1-D SAS data (cansas1d/1.0, also known as SASXML). If the file is found to be 
    211             non-conforming, then <emphasis role="bold">CS_XmlReader(fileName)</emphasis> returns 
    212             with anerror code (show below), otherwise it returns <emphasis role="bold">0</emphasis> 
    213             that indicates <emphasis>no error</emphasis>.All data read by this code is left in the 
    214             IgorPro data folder <emphasis role="bold" 
    215                     ><emphasis>root:Packages:CS_XMLreader</emphasis></emphasis> for pickup by the 
     210            for reduced 1-D SAS data (cansas1d/1.0, also known as SASXML). If the file is found to be 
     211            non-conforming, then <literal>CS_XmlReader(fileName)</literal> returns 
     212            with an error code (show below), otherwise it returns <literal>0</literal> 
     213            that indicates <literal>no error</literal>.All data read by this code is left in the 
     214            IgorPro data folder <literal>root:Packages:CS_XMLreader</literal> for pickup by the 
    216215            calling routine.(Two examples are provided to show how a routine might retrieve the 
    217216            data.) </para> 
    218         <para> After opening the XML file (with a file identifier <emphasis>fileID</emphasis>), 
    219             control is passed to <emphasis role="bold">CS_1i_parseXml(fileID)</emphasis> which then 
    220             walks through the XMLelements. For each <emphasis role="bold">SASentry</emphasis> in the 
    221             file, a new data folder is createdwith the name derived from the Title element (or best 
    222             effort determination).Efforts are taken to avoid duplication of data folder names (using 
    223             standard IgorPro routines). For <emphasis role="bold">SASentry</emphasis> elements that 
    224             contain more than one SASdataelement, a <emphasis role="bold">SASdata</emphasis> folder 
    225             is created for each and the corresponding <emphasis>I(Q)</emphasis> is placed in that 
    226             subfolder. When only one <emphasis role="bold">SASdata</emphasis> is found, the 
    227                 <emphasis>I(Q)</emphasis>data is placed in the main <emphasis>Title</emphasis> 
     217        <para> After opening the XML file (with a file identifier <literal>fileID</literal>), 
     218            control is passed to <literal>CS_1i_parseXml(fileID)</literal> which then 
     219            walks through the XMLelements. For each <literal>SASentry</literal> in the 
     220            file, a new data folder is created with the name derived from the Title element (or best 
     221            effort determination).  Efforts are taken to avoid duplication of data folder names (using 
     222            standard IgorPro routines). For <literal>SASentry</literal> elements that 
     223            contain more than one SASdata element, a <literal>SASdata</literal> folder 
     224            is created for each and the corresponding <literal>I(Q)</literal> is placed in that 
     225            subfolder. When only one <literal>SASdata</literal> is found, the 
     226                <literal>I(Q)</literal>data is placed in the main <literal>Title</literal> 
    228227            folder. </para> 
    229228        <section> 
    230229            <title>data columns</title> 
    231             <para> Each column of data in the <emphasis role="bold">SASdata/Idata/*</emphasis> table 
    232                 is placed into a singleIgorPro wave. At present, the code does not check for 
     230            <para> Each column of data in the <literal>SASdata/Idata/*</literal> table 
     231                is placed into a single IgorPro wave. At present, the code does not check for 
    233232                non-standard data columns.(The capability is built into the code but is deactivated 
    234233                at present). </para> 
     
    248247                trouble when placed in a wave note. This will be the  
    249248                responsibility of the calling 
    250                 routineto <emphasis>clean these up</emphasis> if the need arises. 
     249                routine to <emphasis>clean these up</emphasis> if the need arises. 
    251250            </para></caution> 
    252251                <para> The code checks for most metadata elements and will check for repeated 
  • 1dwg/trunk/doc/src/cansas1d_element_XML_header.xml

    r127 r132  
    118118        <glosslist> 
    119119            <glossentry> 
    120                 <glossterm>Note 1: Required header for canSAS1d/1.0 XML files</glossterm> 
     120                <glossterm>Note 1: Required header for cansas1d/1.0 XML files</glossterm> 
    121121                <glossdef> 
    122122                    <programlisting>&lt;SASroot version="1.0" 
     
    129129            <glossentry> 
    130130                <glossterm> 
    131                     Note 2: Description of attributes in required header for canSAS1d/1.0 XML files 
     131                    Note 2: Description of attributes in required header for cansas1d/1.0 XML files 
    132132                </glossterm> 
    133133                <glossdef><programlisting>version="1.0" 
  • 1dwg/trunk/doc/src/elements.xml

    r129 r132  
    1212<chapter 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"> 
    14     <title>Elements of the CanSAS XML standard</title> 
     14    <title>Elements of the canSAS XML standard</title> 
    1515    <para>Starting the description of each element will be the current version control  
    1616        <emphasis>Revision</emphasis> and <emphasis>Date</emphasis> of the documentation section.   
    17         There are various elements (tag names) in the canSAS1d/1.0 standard.  
     17        There are various elements (tag names) in the cansas1d/1.0 standard.  
    1818        Each of these is described below. 
    1919    </para> 
  • 1dwg/trunk/doc/src/manual.xml

    r129 r132  
    1414    xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"> 
    1515    <info> 
    16         <title>CanSAS 1-D Data Format, v1.0</title> 
     16        <title>canSAS 1-D Data Format, v1.0</title> 
    1717        <author> 
    1818            <personname> 
  • 1dwg/trunk/doc/src/preface.xml

    r130 r132  
    2020            </imageobject> 
    2121        </mediaobject> 
    22         CanSAS 1-D Data Format, v1.0 
     22        canSAS 1-D Data Format, v1.0 
    2323    </para> 
    2424    <note><para> 
    25         Provide a note here describing CanSAS and the initiative to establish 
     25        Provide a note here describing canSAS and the initiative to establish 
    2626        a standard file format.  Note that the data files must adhere to the  
    2727        XML rules which includes being well-formed (including the use of closing tags).   
     
    4141    </para></note> 
    4242    <para> 
    43         The name "canSAS" 
     43        The name "<emphasis role="italic">canSAS</emphasis>" 
    4444        <indexterm><primary>canSAS</primary></indexterm> 
    4545        stands for "Collective Action for Nomadic Small-Angle Scatterers. 
    4646    </para> 
    4747    <para> 
    48         This work is the initiative of the CanSAS 1D Data Formats Working Group,  
     48        This work is the initiative of the canSAS 1D Data Formats Working Group,  
    4949        established at the canSAS-V workshop, NIST, Gaithersburg, Maryland,  
    5050        USA from October 29th to 31st 2007.  It derives many of its foundations 
     
    5656        <link  
    5757            xlink:href="http://www.smallangles.net/wgwiki/index.php/1D_Data_Formats_Working_Group" 
    58             >CanSAS 1D Data Formats Working Group</link 
     58            >canSAS 1D Data Formats Working Group</link 
    5959        ><footnote><para>http://www.smallangles.net/wgwiki/index.php/1D_Data_Formats_Working_Group</para></footnote> 
    6060        describes the members, timelines, and current status. 
  • 1dwg/trunk/doc/src/specification.xml

    r129 r132  
    1212<chapter xml:id="specification" 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"> 
    14     <title>canSAS1d/1.0 Specification</title> 
     14    <title>cansas1d/1.0 Specification</title> 
    1515    <para> 
    1616        This is the definitive specification of  
    17         <literal>canSAS1d/1.0</literal>, 
     17        <literal>cansas1d/1.0</literal>, 
    1818        <indexterm><primary>cansas1d/1.0 standard</primary></indexterm>  
    1919        the canSAS standard format for storing small-angle 
  • 1dwg/trunk/doc/src/test.xml

    r130 r132  
    1818    xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"> 
    1919    <info> 
    20         <title>CanSAS 1-D Data Format, v1.0</title> 
     20        <title>canSAS 1-D Data Format, v1.0</title> 
    2121        <author> 
    2222            <personname> 
  • 1dwg/trunk/doc/src/tutorial.xml

    r129 r132  
    1212<chapter xml:id="tutorial" 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"> 
    14     <title>canSAS1d/1.0 Tutorial</title> 
     14    <title>cansas1d/1.0 Tutorial</title> 
    1515    <para> 
    1616        This is a tutorial for 
    17         <literal>canSAS1d/1.0</literal>, 
     17        <literal>cansas1d/1.0</literal>, 
    1818        <indexterm><primary>cansas1d/1.0 standard</primary></indexterm>  
    1919        the canSAS standard format for storing small-angle 
  • 1dwg/trunk/doc/src/wiki.xml

    r131 r132  
    147147                <para> 
    148148                    <table frame="all"> 
    149                         <title>Basic elements of the CanSAS 1-D standard</title> 
     149                        <title>Basic elements of the canSAS 1-D standard</title> 
    150150                        <tgroup cols="2"> 
    151151                            <colspec colname="c1" colnum="1" colwidth="2*"/> 
     
    204204                                        </emphasis> 
    205205                                    </entry> 
    206                                     <entry>any non-cansas1d/1.0 element can be used at this 
     206                                    <entry>any cansas1d/1.0 element can be used at this 
    207207                                        point</entry> 
    208208                                </row> 
     
    229229                                        </emphasis> 
    230230                                    </entry> 
    231                                     <entry>any non-cansas1d/1.0 element can be used at this 
     231                                    <entry>any cansas1d/1.0 element can be used at this 
    232232                                        point</entry> 
    233233                                </row> 
     
    309309            <orderedlist> 
    310310                <listitem> 
    311                     <para> canSAS1d/1.0 XML data files will adhere to the standard if they can 
     311                    <para> cansas1d/1.0 XML data files will adhere to the standard if they can 
    312312                        successfully 
    313313                        <link xlink:href="cansas1d_documentation-schema_validation">validate</link> 
     
    318318                        against the established XML Schema 
    319319                        (<link xlink:href="http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/cansas1d.xsd" 
    320                             ><literal>cansas1d.xsd</literal></link>).</para> 
     320                            ><literal>canSAS1d.xsd</literal></link>).</para> 
    321321                </listitem> 
    322322                <listitem> 
     
    520520                <indexterm><primary><literal>xmlWriter</literal></primary></indexterm> 
    521521                is a WWW form 
    522                 to translate three-column ASCII text data into the canSAS1d/1.0 XML 
     522                to translate three-column ASCII text data into the cansas1d/1.0 XML 
    523523                format. This form will help you in creating an XML file with all the required 
    524524                elements in the correct places. The form requests the SAS data of Q, I, and Idev 
     
    526526                ...). Press the <code>&lt;nowiki>Submit&lt;/nowiki></code> button and you will receive a nicely 
    527527                formatted WWW page with the SAS data. If you then choose "View page source" (from 
    528                 one of your browser menus), you will see the raw XML of the canSAS1d/1.0 XML format 
     528                one of your browser menus), you will see the raw XML of the cansas1d/1.0 XML format 
    529529                and you can copy/paste this into an XML file. </para> 
    530530            <para>The SAS data that you paste into the form box is likely to be copied directly from 
     
    595595                </listitem> 
    596596                <listitem> 
    597                     <para>Suggestions for support software that writes canSAS1d/1.0 XML data 
     597                    <para>Suggestions for support software that writes cansas1d/1.0 XML data 
    598598                        files:</para> 
    599599                    <itemizedlist> 
     
    713713        <section xml:id="cansas1d_documentation-Foreign_Elements"> 
    714714            <title>Foreign Elements</title> 
    715             <para> To allow for inclusion of elements that are not defined by the cansas1d.xsd XML 
     715            <para> To allow for inclusion of elements that are not defined by the  
     716            <literal>cansas1d.xsd</literal> XML 
    716717                Schema, XML <emphasis role="italic">foreign elements</emphasis>  
    717718                <indexterm> 
     
    745746        <section xml:id="cansas1d_documentation-Support_Tools"> 
    746747            <title>Support tools for Visualization &amp; Analysis software</title> 
    747             <para> Support for importing canSAS1d/1.0 files exists for these languages: <note> 
     748            <para> Support for importing cansas1d/1.0 files exists for these languages: <note> 
    748749                    <para>Refactor the wiki pages here and link as appropriate.</para> 
    749750                </note></para> 
     
    789790        </section> 
    790791        <section xml:id="cansas1d_documentation-repositories"> 
    791             <title>Software repositories (for canSAS1d/1.0 standard)</title> 
     792            <title>Software repositories (for cansas1d/1.0 standard)</title> 
    792793            <itemizedlist> 
    793794                <listitem> 
Note: See TracChangeset for help on using the changeset viewer.