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

Last change on this file since 138 was 138, 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.5 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><para><literal> Title </literal></para></entry>
62                    <entry>
63                        string
64                    </entry>
65                    <entry>
66                        [1..1]
67                    </entry>
68                    <entry>
69                        Title of this <emphasis role="bold">SASentry</emphasis>.
70                    </entry>
71                    <entry/>
72                </row>
73                <row>
74                    <entry><para><literal> Run </literal></para></entry>
75                    <entry>
76                        string
77                    </entry>
78                    <entry>
79                        [1..inf]
80                    </entry>
81                    <entry>
82                        <para>
83                            Run identification for this <literal>SASentry</literal>.
84                            For many facilities, this is an integer.
85                            Use multiple instances of <literal>Run</literal> as needed.
86                        </para>
87                        <para>
88                            Note:
89                            How to correlate this with <literal>SASdata</literal> and
90                            <literal>SASinstrument</literal> 
91                            configurations has not yet been defined.
92                        </para>
93                        <para>
94                            <literal>name</literal> is an optional string attribute to identify
95                            this particular <literal>Run</literal>.
96                            Could use this to associate (correlate) multiple <literal>SASdata</literal>
97                            elements with <literal>Run</literal> elements.
98                            (Give them the same <literal>{short-Run-identifier}</literal>.)
99                        </para>
100                    </entry>
101                    <entry>
102                        <para>
103                            <literal>name</literal>={short-Run-identifier}
104                        </para>
105                    </entry>
106                </row>
107                <row>
108                    <entry>
109                        <link xlink:href="#cansas1d_documentation-element-any"><literal>{any}</literal></link>
110                    </entry>
111                    <entry>
112                        container
113                    </entry>
114                    <entry>
115                        [0..inf]
116                    </entry>
117                    <entry>
118                        Any element(s) not defined in the cansas1d/1.0 standard can be placed at this point.
119                        See <link xlink:href="#cansas1d_documentation-element-any"><literal>{any}</literal></link> 
120                        for more details.
121                    </entry>
122                    <entry>
123                        <para>
124                            <literal>xmlns:{foreign-prefix}={foreign-namespace}</literal>
125                        </para>
126                    </entry>
127                </row>
128                <row>
129                    <entry>
130                        <link xlink:href="#cansas1d_documentation-element-SASdata"><literal>SASdata</literal></link>
131                    </entry>
132                    <entry>
133                        container
134                    </entry>
135                    <entry>
136                        [1..inf]
137                    </entry>
138                    <entry>
139                        Reduced 1-D SAS data for this <literal>SASentry</literal>.
140                        Use multiple <literal>SASdata</literal> elements to represent multiple frames.
141                        Use this to associate (correlate) multiple <literal>SASdata</literal>
142                        elements with <literal>Run</literal> elements. (Give them the same name.)
143                    </entry>
144                    <entry>
145                        <para><literal>name={short-Run-identifier}</literal></para>
146                    </entry>
147                </row>
148                <row>
149                    <entry>
150                        <link xlink:href="#cansas1d_documentation-element-any"><literal>{any}</literal></link>
151                    </entry>
152                    <entry>
153                        container
154                    </entry>
155                    <entry>
156                        [0..inf]
157                    </entry>
158                    <entry>
159                        Any element(s) not defined in the cansas1d/1.0 standard can be placed at this point.
160                        See <link xlink:href="#cansas1d_documentation-element-any"><literal>{any}</literal></link> 
161                        for more details.
162                    </entry>
163                    <entry>
164                        <para><literal>xmlns:{foreign-prefix}={foreign-namespace}</literal></para>
165                    </entry>
166                </row>
167                <row>
168                    <entry>
169                        <link xlink:href="#cansas1d_documentation-element-SASsample"><literal>SASsample</literal></link>
170                    </entry>
171                    <entry>
172                        container
173                    </entry>
174                    <entry>
175                        [1..1]
176                    </entry>
177                    <entry>
178                        Description of the sample.
179                    </entry>
180                    <entry>
181                        <para><literal>name={short-SASsample-identifier}</literal></para>
182                    </entry>
183                </row>
184                <row>
185                    <entry>
186                        <link xlink:href="#cansas1d_documentation-element-SASinstrument"><literal>SASinstrument</literal></link>
187                    </entry>
188                    <entry>
189                        container
190                    </entry>
191                    <entry>
192                        [1..1]
193                    </entry>
194                    <entry>
195                        Description of the instrument
196                    </entry>
197                    <entry/>
198                </row>
199                <row>
200                    <entry>
201                        <link xlink:href="#cansas1d_documentation-element-SASprocess"><literal>SASprocess</literal></link>
202                    </entry>
203                    <entry>
204                        container
205                    </entry>
206                    <entry>
207                        [0..inf]
208                    </entry>
209                    <entry>
210                        Description of a processing or analysis step.
211                    </entry>
212                    <entry>
213                        <para><literal>name={short-SASprocess-identifier}</literal></para>
214                    </entry>
215                </row>
216                <row>
217                    <entry>
218                        <link xlink:href="#cansas1d_documentation-element-SASnote"><literal>SASnote</literal></link>
219                    </entry>
220                    <entry>
221                        container
222                    </entry>
223                    <entry>
224                        [1..inf]
225                    </entry>
226                    <entry>
227                        Free form description of anything not covered by other elements.
228                    </entry>
229                    <entry>
230                        <para><literal>name={short-SASnote-identifier}</literal></para>
231                    </entry>
232                </row>
233            </tbody>
234        </tgroup>
235    </table>
236</section>
Note: See TracBrowser for help on using the repository browser.