source: 1dwg/trunk/doc/src/cansas1d_element_SASentry.xml @ 131

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

more cross-references, formatting, & indices, refs #19

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