source: 1dwg/trunk/doc/src/cansas1d_element_SASsample.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: 13.4 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_SASsample -->
13<section xml:id="cansas1d_documentation-element-SASsample" xmlns="http://docbook.org/ns/docbook"
14    version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink">
15    <title>SASsample element</title>
16    <bridgehead>
17        $Revision$
18        $Date$
19    </bridgehead>
20    <itemizedlist mark="opencircle">
21        <listitem>
22            <indexterm><primary>SASsample</primary></indexterm>
23            <para>
24                parent:
25                <link xlink:href="#cansas1d_documentation-element-SASentry">SASentry</link>
26            </para>
27        </listitem>
28    </itemizedlist>
29    <figure>
30        <title>The SASsample element</title>
31        <mediaobject>
32            <imageobject>
33                <imagedata fileref="../../graphics/3-SASsample.png" width="200pt" scalefit="1"/>
34            </imageobject>
35            <textobject>
36                <phrase>cansas1d-v1-3-SASsample</phrase>
37            </textobject>
38            <caption>
39                <para>The SASsample element</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><para><literal> ID </literal></para></entry>
61                    <entry> string </entry>
62                    <entry> [1..1] </entry>
63                    <entry> Text string that identifies this sample. </entry>
64                    <entry/>
65                </row>
66                <row>
67                    <entry><para><literal> thickness </literal></para></entry>
68                    <entry> floating-point number </entry>
69                    <entry> [0..1] </entry>
70                    <entry> Thickness of this sample. Must specify the unit as an attribute. </entry>
71                    <entry>
72                        <para><literal>unit={unit}</literal></para>
73                    </entry>
74                </row>
75                <row>
76                    <entry><para><literal> transmission </literal></para></entry>
77                    <entry> floating-point number </entry>
78                    <entry> [0..1] </entry>
79                    <entry> Transmission (1-attenuation) of this sample. Express this as a fraction,
80                        not as a percentage. NOTE: there is no unit attribute. </entry>
81                    <entry/>
82                </row>
83                <row>
84                    <entry><para><literal> temperature </literal></para></entry>
85                    <entry> floating-point number </entry>
86                    <entry> [0..1] </entry>
87                    <entry> Temperature of this sample. Must specify the unit as an attribute. </entry>
88                    <entry>
89                        <para><literal>unit={unit}</literal></para>
90                    </entry>
91                </row>
92                <row>
93                    <entry> <literal>position</literal> </entry>
94                    <entry> container </entry>
95                    <entry> [0..1] </entry>
96                    <entry> Location in X, Y, and Z of the sample. </entry>
97                    <entry/>
98                </row>
99                <row>
100                    <entry> <literal>orientation</literal> </entry>
101                    <entry> container </entry>
102                    <entry> [0..1] </entry>
103                    <entry> Orientation (rotation) of the sample. </entry>
104                    <entry/>
105                </row>
106                <row>
107                    <entry>
108                        <para><literal>details</literal></para>
109                    </entry>
110                    <entry> string </entry>
111                    <entry> [0..inf] </entry>
112                    <entry> Any additional sample details. </entry>
113                    <entry/>
114                   
115                </row>
116                <row>
117                    <entry>
118                        <link xlink:href="#cansas1d_documentation-element-any"><literal>{any}</literal></link>
119                    </entry>
120                    <entry> container </entry>
121                    <entry> [0..inf] </entry>
122                    <entry> Any element(s) not defined in the cansas1d/1.0 standard can be placed at
123                        this point. See
124                        <link xlink:href="#cansas1d_documentation-element-any"><literal>{any}</literal></link>
125                        for more details. </entry>
126                    <entry>
127                        <para><literal>xmlns:{foreign-prefix}={foreign-namespace}</literal></para>
128                    </entry>
129                </row>
130            </tbody>
131        </tgroup>
132    </table>
133    <section>
134        <title>geometry</title>
135        <para>
136            <table>
137                <title/>
138                <tgroup cols="2">
139                    <tbody>
140                        <row>
141                            <entry>
142                                <mediaobject>
143                                    <imageobject>
144                                        <imagedata
145                                            fileref="../../graphics/translation-orientation-geometry.jpg"
146                                            width="200pt" scalefit="1"/>
147                                    </imageobject>
148                                    <textobject>
149                                        <phrase/>
150                                    </textobject>
151                                    <caption>
152                                        <para>view from source</para>
153                                    </caption>
154                                </mediaobject>
155                            </entry>
156                            <entry>
157                                <mediaobject>
158                                    <imageobject>
159                                        <imagedata
160                                            fileref="../../graphics/translation-orientation-geometry-2.jpg"
161                                            width="200pt" scalefit="1"/>
162                                    </imageobject>
163                                    <textobject>
164                                        <phrase/>
165                                    </textobject>
166                                    <caption>
167                                        <para>view from detector</para>
168                                    </caption>
169                                </mediaobject>
170                            </entry>
171                        </row>
172                    </tbody>
173                </tgroup>
174            </table>
175        </para>
176    </section>
177    <section>
178        <title>position</title>
179        <table orient="port" role="small">
180            <title/>
181            <tgroup cols="5">
182                <colspec colname="c1" colwidth="15*"/>
183                <colspec colname="c2" colwidth="15*"/>
184                <colspec colname="c3" colwidth="10*"/>
185                <colspec colname="c4" colwidth="30*"/>
186                <colspec colname="c5" colwidth="30*"/>
187                <tbody>
188                    <row>
189                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Name</entry>
190                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Type</entry>
191                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Occurrence</entry>
192                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Description</entry>
193                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Attributes</entry>
194                    </row>
195                    <row>
196                        <entry><para><literal> x </literal></para></entry>
197                        <entry> floating-point number </entry>
198                        <entry> [0..1] </entry>
199                        <entry> Position of the sample in X. The <emphasis role="bold"
200                                >unit</emphasis> attribute is required. See
201                            cansas1d_documentation#Rules for acceptable values. </entry>
202                        <entry><para><literal>unit={unit}</literal></para></entry>
203                    </row>
204                    <row>
205                        <entry><para><literal> y </literal></para></entry>
206                        <entry> floating-point number </entry>
207                        <entry> [0..1] </entry>
208                        <entry> Position of the sample in Y. The <emphasis role="bold"
209                                >unit</emphasis> attribute is required. See
210                            cansas1d_documentation#Rules for acceptable values. </entry>
211                        <entry><para><literal>unit={unit}</literal></para></entry>
212                    </row>
213                    <row>
214                        <entry><para><literal> z </literal></para></entry>
215                        <entry> floating-point number </entry>
216                        <entry> [0..1] </entry>
217                        <entry> Position of the sample in Z. The <emphasis role="bold"
218                                >unit</emphasis> attribute is required. See
219                            cansas1d_documentation#Rules for acceptable values. Note: While Z
220                            dimension is allowed by the standard (provided by use of a standard
221                            element in the XML Schema), it does not make sense for small-angle
222                            scattering. </entry>
223                        <entry><para><literal>unit={unit}</literal></para></entry>
224                    </row>
225                </tbody>
226            </tgroup>
227        </table>
228    </section>
229    <section>
230        <title>orientation</title>
231        <table orient="port" role="small">
232            <title/>
233            <tgroup cols="5">
234                <colspec colname="c1" colwidth="15*"/>
235                <colspec colname="c2" colwidth="15*"/>
236                <colspec colname="c3" colwidth="10*"/>
237                <colspec colname="c4" colwidth="30*"/>
238                <colspec colname="c5" colwidth="30*"/>
239                <tbody>
240                    <row>
241                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Name</entry>
242                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Type</entry>
243                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Occurrence</entry>
244                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Description</entry>
245                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Attributes</entry>
246                    </row>
247                    <row>
248                        <entry><para><literal> roll </literal></para></entry>
249                        <entry> floating-point number </entry>
250                        <entry> [0..1] </entry>
251                        <entry> Rotation about the <emphasis>Z</emphasis> axis (roll). The <emphasis
252                                role="bold">unit</emphasis> attribute is required. See
253                            cansas1d_documentation#Rules for acceptable values. </entry>
254                        <entry><para><literal>unit={unit}</literal></para></entry>
255                    </row>
256                    <row>
257                        <entry><para><literal> pitch </literal></para></entry>
258                        <entry> floating-point number </entry>
259                        <entry> [0..1] </entry>
260                        <entry> Rotation about the <emphasis>X</emphasis> axis (pitch). The
261                                <emphasis role="bold">unit</emphasis> attribute is required. See
262                            cansas1d_documentation#Rules for acceptable values. </entry>
263                        <entry><para><literal>unit={unit}</literal></para></entry>
264                    </row>
265                    <row>
266                        <entry><para><literal> yaw </literal></para></entry>
267                        <entry> floating-point number </entry>
268                        <entry> [0..1] </entry>
269                        <entry> Rotation about the <emphasis>Y</emphasis> axis (yaw). The <emphasis
270                                role="bold">unit</emphasis> attribute is required. See
271                            cansas1d_documentation#Rules for acceptable values. </entry>
272                        <entry><para><literal>unit={unit}</literal></para></entry>
273                    </row>
274                </tbody>
275            </tgroup>
276        </table>
277        <note>
278            <para> The <emphasis role="bold">orientation</emphasis> element is intended to describe
279                simple rotations about a single axis rather than a full set of rotations as in a
280                crystallographic context. </para>
281        </note>
282    </section>
283</section>
Note: See TracBrowser for help on using the repository browser.