Changeset 244 for 1dwg


Ignore:
Timestamp:
Aug 28, 2012 12:14:09 AM (7 years ago)
Author:
prjemian
Message:

refs #24

Location:
1dwg/trunk/doc
Files:
9 added
12 edited

Legend:

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

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

    r242 r244  
    4242**SHADOW** 
    4343        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  
     44        those used by *SHADOW* (http://www.nanotech.wisc.edu/shadow). 
     45        In *SHADOW*, the :math:`y` and :math:`z` axes are swapped and the direction  
    4646        of :math:`x` is changed. 
  • 1dwg/trunk/doc/source/elements.rst

    r242 r244  
    77=================================================== 
    88 
    9 .. _SASroot: 
     9.. _XML Header: 
    1010 
    11 SASroot 
    12 ============== 
     11XML Header 
     12=============== 
     13 
     14.. toctree:: 
     15   :maxdepth: 2 
     16    
     17   element_SASroot 
    1318 
    1419 
  • 1dwg/trunk/doc/source/examples.rst

    r243 r244  
    4545.. index:: XML Stylesheet 
    4646 
    47 The stylesheet in *data-simple.xml* (:ref:`ascii3col.xsl`) is a very basic XSLT. 
     47The stylesheet identified on line 2 in *data-simple.xml* (:ref:`ascii3col.xsl`) is a very basic XSLT. 
    4848When the *data-simple.xml* is opened in a browser (from a directory containing both 
    4949*data-simple.xml* and *ascii3col.xsl*), the result looked like this: 
  • 1dwg/trunk/doc/source/index.rst

    r242 r244  
    55==================== 
    66 
    7 The canSAS1d data format is used to communicate one-dimensional 
    8 reduced small-angle scattering data.  It is a text format and is based on XML. 
     7==========================================  ========================== 
     8.. figure:: ../../graphics/cswikilogo.png   The canSAS1d data format is used to communicate one-dimensional reduced small-angle scattering data.  It is a text format and is based on XML. 
     9==========================================  ========================== 
     10 
     11 
    912 
    1013Objective 
  • 1dwg/trunk/doc/source/manual.rst

    r242 r244  
    1111   specification 
    1212   tutorial 
     13   case-studies 
    1314   examples 
    1415   bindings 
  • 1dwg/trunk/doc/source/overview.rst

    r242 r244  
    357357.. index:: XML file; cansas1d-template.xml 
    358358 
    359 **cansas1d-template.xml** 
     359**Test all the cansas1d/1.1 rules** 
    360360        http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/cansas1d-template.xml 
    361361         
    362     This is used to test all the rules in the XML 
     362    The *cansas1d-template.xml* data file is used to test all the rules in the XML 
    363363    Schema. This is probably not a very good example to use as a starting point 
    364364    for creating XML files with a text editor since it tests many of the 
  • 1dwg/trunk/doc/source/preface.rst

    r241 r244  
    4545page for some matters that preceded this revision. 
    4646 
     47----------------- 
    4748     
    48 Disclaimer 
    49 =============== 
     49.. rubric:: Disclaimer 
    5050 
    5151This description is meant to inform the community how to arrange information within 
  • 1dwg/trunk/doc/source/tutorial.rst

    r242 r244  
    1111scattering data in XML files. 
    1212 
    13 At present, the tutorial section consists of two case studies, 
    14 which can serve as examples.  The opportunity is ripe for a 
    15 better tutorial. 
    16  
    17 .. 
    18         .. toctree:: 
    19            :maxdepth: 2 
    20             
    21            case-studies 
    22  
    23 Case Studies 
    24 ================ 
    25  
    26 .. _case_study-collagen: 
    27  
    28 Case Study: Dry Chick Collagen 
    29 -------------------------------- 
    30  
    31 .. _case_study-af1410: 
    32  
    33 Case Study: AF1410 steel 
    34 --------------------------------- 
     13At present, the tutorial section consists of two case studies  
     14(see the :ref:`case.studies` section), which can serve as examples.   
     15The opportunity could not be more ripe for a better tutorial. 
  • 1dwg/trunk/doc/source/validation.rst

    r242 r244  
    1515 
    1616#. press ``<validate>`` 
    17 #. paste content of *cansas1d.xsd* XSD file into form  
     17#. paste content of :download:`cansas1d.xsd <../../cansas1d.xsd>` XSD file into form  
    1818        and press ``<continue validation>`` 
    1919         
  • 1dwg/trunk/doc/source/xml-help.rst

    r242 r244  
    77=================================================== 
    88 
     9Listed below are various references useful in learning :index:`XML` and related topics. 
    910 
    10 .. 
    11     <title>XML Help</title> 
    12     <para>Listed below are various references useful in learning XML and related topics.</para> 
    13     <indexterm> 
    14         <primary>XML</primary> 
    15     </indexterm> 
    16     <itemizedlist mark="opencircle"> 
    17         <listitem> 
    18             <para><emphasis role="bold">XML</emphasis>: eXtensible Markup Language <itemizedlist> 
    19                     <listitem> 
    20                         <para>http://www.w3schools.com/xml/</para> 
    21                     </listitem> 
    22                     <listitem> 
    23                         <para>http://www.w3.org/XML/</para> 
    24                     </listitem> 
    25                     <listitem> 
    26                         <para>http://en.wikipedia.org/wiki/XML</para> 
    27                     </listitem> 
    28                     <listitem> 
    29                         <para>http://www.zvon.org/xxl/XPathTutorial/General/examples.html </para> 
    30                     </listitem> 
    31                 </itemizedlist></para> 
    32         </listitem> 
    33         <listitem> 
    34             <para><emphasis role="bold">XSL (or XSLT)</emphasis>: eXtensible Stylesheet Language 
    35                 (Transformation)  
    36                 <indexterm> 
    37                     <primary>XML Stylesheet</primary> 
    38                 </indexterm> 
    39                 <itemizedlist> 
    40                     <listitem> 
    41                         <para>http://www.w3schools.com/xsl/</para> 
    42                     </listitem> 
    43                     <listitem> 
    44                         <para>http://www.w3.org/Style/XSL/</para> 
    45                     </listitem> 
    46                     <listitem> 
    47                         <para>http://en.wikipedia.org/wiki/Extensible_Stylesheet_Language</para> 
    48                     </listitem> 
    49                     <listitem> 
    50                         <para>http://en.wikipedia.org/wiki/XSLT</para> 
    51                     </listitem> 
    52                 </itemizedlist></para> 
    53         </listitem> 
    54         <listitem> 
    55             <para><emphasis role="bold">XPath</emphasis>: XPath is a language for finding information 
    56                 in an XML document.  
    57                 <indexterm> 
    58                     <primary>XPath</primary> 
    59                 </indexterm> 
    60                 <itemizedlist> 
    61                     <listitem> 
    62                         <para>http://www.w3schools.com/xpath/</para> 
    63                     </listitem> 
    64                     <listitem> 
    65                         <para>http://www.w3.org/Style/XSL/</para> 
    66                     </listitem> 
    67                     <listitem> 
    68                         <para>http://en.wikipedia.org/wiki/XPath </para> 
    69                     </listitem> 
    70                 </itemizedlist></para> 
    71         </listitem> 
    72         <listitem> 
    73             <para><emphasis role="bold">Schema</emphasis>: An XML Schema describes the structure of 
    74                 an XML document. 
    75                 <indexterm> 
    76                     <primary>XML Schema</primary> 
    77                 </indexterm> 
    78                 <itemizedlist> 
    79                     <listitem> 
    80                         <para>http://www.w3schools.com/schema/</para> 
    81                     </listitem> 
    82                     <listitem> 
    83                         <para>http://www.w3.org/XML/Schema</para> 
    84                     </listitem> 
    85                     <listitem> 
    86                         <para>http://en.wikipedia.org/wiki/XSD </para> 
    87                     </listitem> 
    88                 </itemizedlist></para> 
    89         </listitem> 
    90         <listitem> 
    91             <para><emphasis role="bold">XML Namespaces</emphasis>: XML namespaces are used for 
    92                 providing uniquely named elements and attributes in an XML instance. 
    93                 <indexterm> 
    94                     <primary>XML Namespace</primary> 
    95                 </indexterm> 
    96                 <indexterm> 
    97                     <primary>namespace</primary> 
    98                     <see>XML Namespace</see> 
    99                 </indexterm> 
    100                 <itemizedlist> 
    101                     <listitem> 
    102                         <para>http://www.zvon.org/xxl/NamespaceTutorial/Output</para> 
    103                     </listitem> 
    104                     <listitem> 
    105                         <para>http://en.wikipedia.org/wiki/XML_namespaces</para> 
    106                     </listitem> 
    107                     <listitem> 
    108                         <para>http://www.w3schools.com/XML/xml_namespaces.asp</para> 
    109                     </listitem> 
    110                 </itemizedlist></para> 
    111         </listitem> 
    112         <listitem> 
    113             <para><emphasis role="bold">XML Foreign Elements</emphasis>:  
    114                 <indexterm> 
    115                     <primary>XML</primary> 
    116                     <secondary>foreign elements</secondary> 
    117                 </indexterm> 
    118                 Inclusion of elements, at 
    119                 select locations, that are not defined by the cansas1d.xsd XML Schema <itemizedlist> 
    120                     <listitem> 
    121                         <para>http://books.xmlschemata.org/relaxng/relax-CHP-11-SECT-4.html</para> 
    122                     </listitem> 
    123                     <listitem> 
    124                         <para>http://www.w3.org/TR/SVG/extend.html</para> 
    125                     </listitem> 
    126                     <listitem> 
    127                         <para>http://www.google.com/search?q=XML+foreign+elements</para> 
    128                     </listitem> 
    129                 </itemizedlist></para> 
    130         </listitem> 
    131     </itemizedlist> 
     11**XML** 
     12        eXtensible Markup Language 
     13 
     14        * http://www.w3schools.com/xml/ 
     15        * http://www.w3.org/XML/ 
     16        * http://en.wikipedia.org/wiki/XML 
     17        * http://www.zvon.org/xxl/XPathTutorial/General/examples.html 
     18 
     19.. index:: XML Stylesheet 
     20 
     21**XSL** (or **XSLT**) 
     22        eXtensible Stylesheet Language 
     23 
     24        * http://www.w3schools.com/xsl/ 
     25        * http://www.w3.org/Style/XSL/ 
     26        * http://en.wikipedia.org/wiki/Extensible_Stylesheet_Language 
     27        * http://en.wikipedia.org/wiki/XSLT 
     28 
     29**XPath** 
     30        XPath is a language for finding information in an XML document 
     31 
     32        * http://www.w3schools.com/xpath/ 
     33        * http://www.w3.org/Style/XSL/ 
     34        * http://en.wikipedia.org/wiki/XPath 
     35 
     36**Schema** 
     37        An XML Schema describes the structure of an XML document 
     38 
     39        * http://www.w3schools.com/schema/ 
     40        * http://www.w3.org/XML/Schema 
     41        * http://en.wikipedia.org/wiki/XSD 
     42 
     43.. index:: 
     44        see: namespace; XML Namespace 
     45 
     46**XML Namespaces** 
     47        An :index:`XML namespace` is used for providing uniquely-named  
     48        elements and attributes in an XML instance. 
     49         
     50        * http://www.zvon.org/xxl/NamespaceTutorial/Output 
     51        * http://en.wikipedia.org/wiki/XML_namespaces 
     52        * http://www.w3schools.com/XML/xml_namespaces.asp 
     53 
     54.. index:: XML; foreign elements 
     55 
     56**XML Foreign Elements** 
     57        Inclusion of elements, at select locations, that are not  
     58        defined by the cansas1d.xsd XML Schema 
     59         
     60        * http://books.xmlschemata.org/relaxng/relax-CHP-11-SECT-4.html 
     61        * http://www.w3.org/TR/SVG/extend.html 
     62        * http://www.google.com/search?q=XML+foreign+elements 
  • 1dwg/trunk/doc/src/data-simple.xml

    r243 r244  
    22<?xml-stylesheet type="text/xsl" href="ascii3col.xsl" ?> 
    33<SASroot version="1.1" 
    4                 xmlns="cansas1d/1.1" 
    5                 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    6                 xsi:schemaLocation="cansas1d/1.1 http://svn.smallangles.net/svn/canSAS/1dwg/trunk/cansas1d.xsd" 
    7                 > 
     4        xmlns="cansas1d/1.1" 
     5        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
     6        xsi:schemaLocation="cansas1d/1.1 http://svn.smallangles.net/svn/canSAS/1dwg/trunk/cansas1d.xsd" 
     7        > 
    88        <SASentry> 
    99                <Title>SAS bimodal test1</Title> 
Note: See TracChangeset for help on using the changeset viewer.