source: 1dwg/trunk/doc/cansas1d_element_SASentry.xml @ 105

Last change on this file since 105 was 105, checked in by prjemian, 11 years ago

documentation for a couple of elements converted, refs #19

  • Property svn:executable set to *
  • Property svn:keywords set to Date Revision Author HeadURL Id
File size: 8.9 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
2<?oxygen RNGSchema="http://www.oasis-open.org/docbook/xml/5.0/rng/docbook.rng" type="xml"?>
3<!--
4    ########### SVN repository information ###################
5    # $Date$
6    # $Author$
7    # $Revision$
8    # $HeadURL$
9    # $Id$
10    ########### SVN repository information ###################
11-->
12<!-- from: http://www.smallangles.net/wgwiki/index.php/cansas1d_SASentry -->
13<section xml:id="cansas1d_documentation-element-SASentry" xmlns="http://docbook.org/ns/docbook"
14    version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink">
15    <title>SASentry element</title>
16    <figure>
17        <title>The SASentry element</title>
18        <mediaobject>
19            <imageobject>
20                <imagedata fileref="../graphics/1-SASroot.png" width="200px"
21                    scalefit="1"/>
22            </imageobject>
23            <textobject>
24                <phrase>cansas1d-v1-1-SASroot</phrase>
25            </textobject>
26            <caption>
27                <para/>
28            </caption>
29        </mediaobject>
30    </figure>
31    <itemizedlist mark="opencircle">
32        <listitem>
33            <para>
34                parent: SASroot
35            </para>
36        </listitem>
37    </itemizedlist>
38    <table>
39        <title/>
40        <tgroup cols='5'>
41            <tbody>
42                <row>
43                    <entry>
44                        Name
45                    </entry>
46                    <entry>
47                        Type
48                    </entry>
49                    <entry>
50                        occurrence
51                    </entry>
52                    <entry>
53                        Description
54                    </entry>
55                    <entry>
56                        Attributes
57                    </entry>
58                </row>
59                <row>
60                    <entry>
61                        <para>
62                            <emphasis role="bold">Title</emphasis>
63                        </para>
64                    </entry>
65                    <entry>
66                        string
67                    </entry>
68                    <entry>
69                        [1..1]
70                    </entry>
71                    <entry>
72                        Title of this <emphasis role="bold">SASentry</emphasis>.
73                    </entry>
74                    <entry/>
75                </row>
76                <row>
77                    <entry>
78                        <para>
79                            <emphasis role="bold">Run</emphasis>
80                        </para>
81                    </entry>
82                    <entry>
83                        string
84                    </entry>
85                    <entry>
86                        [1..unbounded]
87                    </entry>
88                    <entry>
89                        <para>
90                            Run identification for this '''SASentry'''. For many facilities, this is an integer. Use multiple instances of <emphasis role="bold">Run</emphasis> as needed.
91                        </para>
92                        <para>
93                            Note: How to correlate this with '''SASdata''' and '''SASinstrument''' configurations has not yet been defined.
94                        </para>
95                        <para>
96                            <emphasis role="bold">name</emphasis> is an optional string attribute to identify this particular <emphasis role="bold">Run</emphasis>. Could use this to associate (correlate) multiple '''SASdata''' elements with <emphasis role="bold">Run</emphasis> elements. (Give them the same <emphasis>short-Run-identifier</emphasis>.)
97                        </para>
98                    </entry>
99                    <entry>
100                        <para>
101                            <emphasis role="bold"><emphasis>name</emphasis></emphasis>={short-Run-identifier}
102                        </para>
103                    </entry>
104                </row>
105                <row>
106                    <entry>
107                        '''''{any}'''''
108                    </entry>
109                    <entry>
110                        container
111                    </entry>
112                    <entry>
113                        [0..unbounded]
114                    </entry>
115                    <entry>
116                        Any element(s) not defined in the cansas1d/1.0 standard can be placed at this point. See ''{any}'' for more details.
117                    </entry>
118                    <entry>
119                        <para>
120                            <emphasis role="bold"><emphasis>xmlns:{foreign-prefix}</emphasis></emphasis>={foreign-namespace}
121                        </para>
122                    </entry>
123                </row>
124                <row>
125                    <entry>
126                        '''SASdata'''
127                    </entry>
128                    <entry>
129                        container
130                    </entry>
131                    <entry>
132                        [1..unbounded]
133                    </entry>
134                    <entry>
135                        Reduced 1-D SAS data for this '''SASentry'''.
136                        Use multiple '''SASdata''' elements to represent multiple frames.
137                        Use this to associate (correlate) multiple '''SASdata'''
138                        elements with
139                        <emphasis role="bold">Run</emphasis> elements. (Give them the same name.)
140                    </entry>
141                    <entry>
142                        <para>
143                            <emphasis role="bold"><emphasis>name</emphasis></emphasis>={short-Run-identifier}
144                        </para>
145                    </entry>
146                </row>
147                <row>
148                    <entry>
149                        '''''{any}'''''
150                    </entry>
151                    <entry>
152                        container
153                    </entry>
154                    <entry>
155                        [0..unbounded]
156                    </entry>
157                    <entry>
158                        Any element(s) not defined in the cansas1d/1.0 standard can be placed at this point. See ''{any}'' for more details.
159                    </entry>
160                    <entry>
161                        <para>
162                            <emphasis role="bold"><emphasis>xmlns:{foreign-prefix}</emphasis></emphasis>={foreign-namespace}
163                        </para>
164                    </entry>
165                </row>
166                <row>
167                    <entry>
168                        '''SASsample'''
169                    </entry>
170                    <entry>
171                        container
172                    </entry>
173                    <entry>
174                        [1..1]
175                    </entry>
176                    <entry>
177                       
178                        Description of the sample.
179                    </entry>
180                    <entry>
181                        <para>
182                            <emphasis role="bold"><emphasis>name</emphasis></emphasis>={short-SASsample-identifier}
183                        </para>
184                    </entry>
185                </row>
186                <row>
187                    <entry>
188                        '''SASinstrument'''
189                    </entry>
190                    <entry>
191                        container
192                    </entry>
193                    <entry>
194                        [1..1]
195                    </entry>
196                    <entry>
197                        Description of the instrument
198                    </entry>
199                    <entry/>
200                </row>
201                <row>
202                    <entry>
203                        '''''SASprocess'''''
204                    </entry>
205                    <entry>
206                        container
207                    </entry>
208                    <entry>
209                        [0..unbounded]
210                    </entry>
211                    <entry>
212                        Description of a processing or analysis step.
213                    </entry>
214                    <entry>
215                        <para>
216                            <emphasis role="bold"><emphasis>name</emphasis></emphasis>={short-SASprocess-identifier}
217                        </para>
218                    </entry>
219                </row>
220                <row>
221                    <entry>
222                        '''SASnote'''
223                    </entry>
224                    <entry>
225                        container
226                    </entry>
227                    <entry>
228                        [1..unbounded]
229                    </entry>
230                    <entry>
231                        Free form description of anything not covered by other elements.
232                    </entry>
233                    <entry>
234                        <para>
235                            <emphasis role="bold"><emphasis>name</emphasis></emphasis>={short-SASnote-identifier}
236                        </para>
237                    </entry>
238                </row>
239            </tbody>
240        </tgroup>
241    </table>
242</section>
Note: See TracBrowser for help on using the repository browser.