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

Last change on this file since 123 was 123, checked in by prjemian, 12 years ago

more cross-references, 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            <para>
23                                parent:
24                                <link xlink:href="#cansas1d_documentation-element-SASroot">SASroot</link>
25            </para>
26        </listitem>
27    </itemizedlist>
28    <figure>
29        <title>The SASentry element</title>
30        <mediaobject>
31            <imageobject>
32                <imagedata fileref="../graphics/1-SASroot.png" width="200pt"
33                    scalefit="1"/>
34            </imageobject>
35            <textobject>
36                <phrase>cansas1d-v1-1-SASroot</phrase>
37            </textobject>
38            <caption>
39                <para/>
40            </caption>
41        </mediaobject>
42    </figure>
43    <table orient="port" role="small">
44        <title/>
45        <tgroup cols="5">
46            <colspec colname="c1" colwidth="15*"/>
47            <colspec colname="c2" colwidth="15*"/>
48            <colspec colname="c3" colwidth="10*"/>
49            <colspec colname="c4" colwidth="30*"/>
50            <colspec colname="c5" colwidth="30*"/>
51            <tbody>
52                <row>
53                    <entry><?dblatex bgcolor="[gray]{0.8}"?>Name</entry>
54                    <entry><?dblatex bgcolor="[gray]{0.8}"?>Type</entry>
55                    <entry><?dblatex bgcolor="[gray]{0.8}"?>Occurrence</entry>
56                    <entry><?dblatex bgcolor="[gray]{0.8}"?>Description</entry>
57                    <entry><?dblatex bgcolor="[gray]{0.8}"?>Attributes</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..inf]
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..inf]
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                        <link xlink:href="#cansas1d_documentation-element-SASdata">SASdata</link>
127                    </entry>
128                    <entry>
129                        container
130                    </entry>
131                    <entry>
132                        [1..inf]
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..inf]
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                        <link xlink:href="#cansas1d_documentation-element-SASsample">SASsample</link>
169                    </entry>
170                    <entry>
171                        container
172                    </entry>
173                    <entry>
174                        [1..1]
175                    </entry>
176                    <entry>
177                        Description of the sample.
178                    </entry>
179                    <entry>
180                        <para>
181                            <emphasis role="bold"><emphasis>name</emphasis></emphasis>={short-SASsample-identifier}
182                        </para>
183                    </entry>
184                </row>
185                <row>
186                    <entry>
187                        <link xlink:href="#cansas1d_documentation-element-SASinstrument">SASinstrument</link>
188                    </entry>
189                    <entry>
190                        container
191                    </entry>
192                    <entry>
193                        [1..1]
194                    </entry>
195                    <entry>
196                        Description of the instrument
197                    </entry>
198                    <entry/>
199                </row>
200                <row>
201                    <entry>
202                        <link xlink:href="#cansas1d_documentation-element-SASprocess">SASprocess</link>
203                    </entry>
204                    <entry>
205                        container
206                    </entry>
207                    <entry>
208                        [0..inf]
209                    </entry>
210                    <entry>
211                        Description of a processing or analysis step.
212                    </entry>
213                    <entry>
214                        <para>
215                            <emphasis role="bold"><emphasis>name</emphasis></emphasis>={short-SASprocess-identifier}
216                        </para>
217                    </entry>
218                </row>
219                <row>
220                    <entry>
221                        <link xlink:href="#cansas1d_documentation-element-SASnote">SASnote</link>
222                    </entry>
223                    <entry>
224                        container
225                    </entry>
226                    <entry>
227                        [1..inf]
228                    </entry>
229                    <entry>
230                        Free form description of anything not covered by other elements.
231                    </entry>
232                    <entry>
233                        <para>
234                            <emphasis role="bold"><emphasis>name</emphasis></emphasis>={short-SASnote-identifier}
235                        </para>
236                    </entry>
237                </row>
238            </tbody>
239        </tgroup>
240    </table>
241</section>
Note: See TracBrowser for help on using the repository browser.