Ignore:
Timestamp:
Mar 15, 2013 10:42:50 PM (6 years ago)
Author:
prjemian
Message:

simplify to just one XSLT, rename, and revise XML files accordingly, update the docs (and call the format "cansas1d:1.1" now)

File:
1 edited

Legend:

Unmodified
Added
Removed
  • 1dwg/branches/v1.1/doc/source/overview.rst

    r271 r284  
    2929================ 
    3030 
    31 .. index:: ! cansas1d/1.1 standard 
     31.. index:: ! cansas1d:1.1 standard 
    3232.. index:: canSAS; objective 
    3333 
    34 The cansas1d/1.1 
     34The cansas1d:1.1 
    3535standard meets the objectives for a 1D standard, incorporating :index:`metadata` 
    3636about the measurement, parameters and results of processing or analysis steps. 
     
    5252.. index:: element; SASentry 
    5353 
    54 The basic elements of the cansas1d/1.1 standard are shown in the following table. 
     54The basic elements of the cansas1d:1.1 standard are shown in the following table. 
    5555After an XML header, the root element of the file is :ref:`SASroot` 
    5656which contains one or more :ref:`SASentry` 
     
    6060next figure.  
    6161See the section :ref:`elements` 
    62 for examples of cansas1d/1.1 XML data files.  
     62for examples of cansas1d:1.1 XML data files.  
    6363Examples, Case Studies, and other background information 
    6464are below. More discussion can be found on the 
     
    6969 
    7070        .. figure:: ../../graphics/10-minimum.png 
    71             :alt: cansas1d/1.1 standard block diagram, minimum elements 
     71            :alt: cansas1d:1.1 standard block diagram, minimum elements 
    7272             
    73             block diagram of minimum elements required for *cansas1d/1.1* standard 
     73            block diagram of minimum elements required for *cansas1d:1.1* standard 
    7474 
    7575:ref:`SASroot` 
     
    8383.. _XML.header: 
    8484 
    85 .. rubric:: Required header for cansas1d/1.1 XML files 
     85.. rubric:: Required header for cansas1d:1.1 XML files 
    8686 
    8787.. code-block:: xml 
     
    9090        <?xml version="1.0"?> 
    9191        <SASroot version="1.1" 
    92                 xmlns="cansas1d/1.1" 
     92                xmlns="cansas1d:1.1" 
    9393                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    94                 xsi:schemaLocation="cansas1d/1.1 
     94                xsi:schemaLocation="cansas1d:1.1 
    9595                    http://www.cansas.org/svn/1dwg/trunk/cansas1d.xsd" 
    9696                > 
     
    154154        single: geometry; orientation (rotation) 
    155155 
    156 #. A cansas1d/1.1 XML data files will adhere to the standard if it can 
     156#. A cansas1d:1.1 XML data files will adhere to the standard if it can 
    157157        successfully :ref:`validate <validate>` against the established XML Schema. 
    158158          
     
    247247The canSAS/xmlWriter (http://www.cansas.org/formats/tools/xmlWriter/) 
    248248is a WWW form 
    249 to translate three-column ASCII text data into the cansas1d/1.1 XML 
     249to translate three-column ASCII text data into the cansas1d:1.1 XML 
    250250format. This form will help you in creating an XML file with all the required 
    251251elements in the correct places. The form requests the SAS data of *Q*, *I*, and *Idev* 
     
    255255Press the *Submit* button and you will receive a nicely 
    256256formatted WWW page with the SAS data. If you then choose *View page source* 
    257 (from one of your browser menus), you will see the raw XML of the cansas1d/1.1 XML format 
     257(from one of your browser menus), you will see the raw XML of the cansas1d:1.1 XML format 
    258258and you can copy/paste this into an XML file.  
    259259 
     
    322322 
    323323 
    324 Suggestions for support software that write cansas1d/1.1 XML data files 
     324Suggestions for support software that write cansas1d:1.1 XML data files 
    325325------------------------------------------------------------------------- 
    326326 
    327327.. index:: 
    328         single: file; Writing cansas1d/1.1 files 
     328        single: file; Writing cansas1d:1.1 files 
    329329        single: best practices 
    330330 
     
    401401.. index:: XML file; cansas1d-template.xml 
    402402 
    403 :Test all the cansas1d/1.1 rules: 
     403:Test all the cansas1d:1.1 rules: 
    404404        http://www.cansas.org/trac/browser/1dwg/trunk/cansas1d-template.xml 
    405405         
     
    455455*cansas1d.xsd* XML Schema, XML **foreign elements**  
    456456are permitted at select locations in the 
    457 cansas1d/1.1 format. Please refer to the :ref:`XML Help` section  
     457cansas1d:1.1 format. Please refer to the :ref:`XML Help` section  
    458458for more help with XML foreign elements. 
    459459 
     
    483483========================================================= 
    484484 
    485 Support for importing cansas1d/1.1 files exists for  
     485Support for importing cansas1d:1.1 files exists for  
    486486these languages and environments:  
    487487 
     
    515515        *cansasxml-html.xsl* (http://www.cansas.org/svn/1dwg/trunk/cansasxml-html.xsl). 
    516516        The ISIS **LOQ** instrument (http://www.isis.stfc.ac.uk/instruments/loq/loq2470.html) 
    517         has provided an excellent description of how to import data from the cansas1d/1.1 format into Excel. 
     517        has provided an excellent description of how to import data from the cansas1d:1.1 format into Excel. 
    518518        Also note that the old WWW site (http://www.isis.rl.ac.uk/archive/LargeScale/LOQ/loq.htm) 
    519519        may still be available.  
     
    528528         
    529529        The *canSAS/xmlWriter* (http://www.cansas.org/xmlWriter/) 
    530         is implemented in PHP (http://www.php.net) and writes a cansas1d/1.1 data  
     530        is implemented in PHP (http://www.php.net) and writes a cansas1d:1.1 data  
    531531        file given three-column ASCII data as input.  The code uses 
    532532        *DomDocument* (http://www.php.net/DomDocument) 
     
    557557 
    558558 
    559 Software repositories (for cansas1d/1.1 standard) 
     559Software repositories (for cansas1d:1.1 standard) 
    560560========================================================= 
    561561 
Note: See TracChangeset for help on using the changeset viewer.