source: 1dwg/trunk/doc/source/elements.rst @ 271

Last change on this file since 271 was 263, checked in by prjemian, 8 years ago

now completely done with all DocBook? sources

  • Property svn:eol-style set to native
File size: 2.1 KB
RevLine 
[242]1.. $Id: elements.rst 241 2012-08-27 07:15:24Z prjemian $
[241]2
3.. _elements:
4
5===================================================
6Elements of the canSAS XML standard
7===================================================
8
[263]9There are various elements (tag names) in the cansas1d/1.1 standard.
10Each of these is described below.
11
12:Name:
13        XML tag to be used for this element of the standard.
14
15
16:Type:
17        A *Type* may be either of:
18       
19        :header:
20                Describes the required XML header lines. 
21                Without questions, use the header
22                in the section titled :ref:`XML header`.
23
24        :container:
25                A *container* element has subelements but
26                no text of its own.
27                These are similar to the NeXus NXDL
28                ``group`` type.
29
30        :floating-point number:
31                Elements of type *floating-point number*
32                are obvious.  In most cases, a ``unit`` attribute
33                is required.  This will be noted.
34
35        :string:
36                Elements of type *string*
37                are any valid string (non-whitespace) sequence.
38
39:Occurence:
40        The number of times a particular element may appear is
41        described in the *occurence* column. A value of *[0..1]* 
42        indicates the element is optional but may appear one time. A value of
43        *[0..inf]* indicates the element is optional
44        but may appear an infinite number of times (also known as unbounded).
45
46.. index:: ! XML; attributes
47.. index:: XML; well-formed
48
49:Attributes:
50       
51        *Attributes* list the required or optional attributes of this element. 
52        Note that attributes must adhere to the well-formed [#]_
53        XML guidelines::
54       
55                attributename="value"
56       
57        where either single or double quotes surround the value. 
58        All attributes must have a value.  Attributes may be given in any order.
59       
60        .. [#] well-formed XML: http://www.w3schools.com/xmL/xml_syntax.asp
61
62
63
64
[244]65.. toctree::
66   :maxdepth: 2
67   
[255]68   element_XML_header
[244]69   element_SASroot
[253]70   element_SASentry
[255]71   element_SASdata
72   element_SAStransmission_spectrum
73   element_SASsample
74   element_SASinstrument
75   element_SASsource
[253]76   element_SAScollimation
[255]77   element_SASdetector
78   element_SASprocess
79   element_SASnote
80   element_any
Note: See TracBrowser for help on using the repository browser.