Changeset 110


Ignore:
Timestamp:
Sep 26, 2009 1:46:17 PM (10 years ago)
Author:
prjemian
Message:

more documentation, refs #19

Location:
1dwg/trunk/doc
Files:
2 added
5 edited

Legend:

Unmodified
Added
Removed
  • 1dwg/trunk/doc/cansas1d_element_SASroot.xml

    r105 r110  
    2525            </textobject> 
    2626            <caption> 
    27                 <para/> 
     27                <para>The SASroot element</para> 
    2828            </caption> 
    2929        </mediaobject> 
  • 1dwg/trunk/doc/cansas1d_element_SASsample.xml

    r109 r110  
    1818        <mediaobject> 
    1919            <imageobject> 
    20                 <imagedata fileref="../graphics/3-SASsample.png" width="200px" 
    21                     scalefit="1"/> 
     20                <imagedata fileref="../graphics/3-SASsample.png" width="200px" scalefit="1"/> 
    2221            </imageobject> 
    2322            <textobject> 
     
    3130    <itemizedlist mark="opencircle"> 
    3231        <listitem> 
    33             <para> 
    34                 parent: SASentry 
    35             </para> 
     32            <para> parent: SASentry </para> 
    3633        </listitem> 
    3734    </itemizedlist> 
    3835    <table> 
    3936        <title/> 
    40         <tgroup cols='5'> 
     37        <tgroup cols="5"> 
    4138            <tbody> 
    4239                <row> 
    43                     <entry> 
    44                         {{Headcellstyle}} | Name 
    45                     </entry> 
    46                     <entry> 
    47                         {{Headcellstyle}} | Type 
    48                     </entry> 
    49                     <entry> 
    50                         {{Headcellstyle}} | occurrence 
    51                     </entry> 
    52                     <entry> 
    53                         {{Headcellstyle}} | Description 
    54                     </entry> 
    55                     <entry> 
    56                         {{Headcellstyle}} | Attributes 
    57                     </entry> 
     40                    <entry> Name </entry> 
     41                    <entry> Type </entry> 
     42                    <entry> occurrence </entry> 
     43                    <entry> Description </entry> 
     44                    <entry> Attributes </entry> 
    5845                </row> 
    5946                <row> 
     
    6350                        </para> 
    6451                    </entry> 
    65                     <entry> 
    66                         string 
    67                     </entry> 
    68                     <entry> 
    69                         [1..1] 
    70                     </entry> 
    71                     <entry> 
    72                         Text string that identifies this sample. 
    73                     </entry> 
     52                    <entry> string </entry> 
     53                    <entry> [1..1] </entry> 
     54                    <entry> Text string that identifies this sample. </entry> 
    7455                    <entry> 
    7556                    </entry> 
     
    8162                        </para> 
    8263                    </entry> 
    83                     <entry> 
    84                         floating-point number 
    85                     </entry> 
    86                     <entry> 
    87                         [0..1] 
    88                     </entry> 
    89                     <entry> 
    90                         Thickness of this sample. Must specify the unit as an attribute. 
    91                     </entry> 
    92                     <entry> 
    93                         <para> 
    94                             <emphasis role="bold">unit</emphasis>={unit} 
    95                         </para> 
     64                    <entry> floating-point number </entry> 
     65                    <entry> [0..1] </entry> 
     66                    <entry> Thickness of this sample. Must specify the unit as an attribute. </entry> 
     67                    <entry> 
     68                        <para> 
     69                            <emphasis role="bold">unit</emphasis>={unit} </para> 
    9670                    </entry> 
    9771                </row> 
     
    10276                        </para> 
    10377                    </entry> 
    104                     <entry> 
    105                         floating-point number 
    106                     </entry> 
    107                     <entry> 
    108                         [0..1] 
    109                     </entry> 
    110                     <entry> 
    111                         Transmission (1-attenuation) of this sample. Express this as a fraction, not as a percentage. NOTE: there is no unit attribute. 
    112                     </entry> 
     78                    <entry> floating-point number </entry> 
     79                    <entry> [0..1] </entry> 
     80                    <entry> Transmission (1-attenuation) of this sample. Express this as a fraction, 
     81                        not as a percentage. NOTE: there is no unit attribute. </entry> 
    11382                    <entry> 
    11483                    </entry> 
     
    12089                        </para> 
    12190                    </entry> 
    122                     <entry> 
    123                         floating-point number 
    124                     </entry> 
    125                     <entry> 
    126                         [0..1] 
    127                     </entry> 
    128                     <entry> 
    129                         Temperature of this sample. Must specify the unit as an attribute. 
    130                     </entry> 
    131                     <entry> 
    132                         <para> 
    133                             <emphasis role="bold">unit</emphasis>={unit} 
    134                         </para> 
    135                     </entry> 
    136                 </row> 
    137                 <row> 
    138                     <entry> 
    139                         '''''position''''' 
    140                     </entry> 
    141                     <entry> 
    142                         container 
    143                     </entry> 
    144                     <entry> 
    145                         [0..1] 
    146                     </entry> 
    147                     <entry> 
    148                         Location in X, Y, and Z of the sample. 
    149                     </entry> 
    150                     <entry> 
    151                     </entry> 
    152                 </row> 
    153                 <row> 
    154                     <entry> 
    155                         '''''orientation''''' 
    156                     </entry> 
    157                     <entry> 
    158                         container 
    159                     </entry> 
    160                     <entry> 
    161                         [0..1] 
    162                     </entry> 
    163                     <entry> 
    164                         Orientation (rotation) of the sample. 
    165                     </entry> 
     91                    <entry> floating-point number </entry> 
     92                    <entry> [0..1] </entry> 
     93                    <entry> Temperature of this sample. Must specify the unit as an attribute. </entry> 
     94                    <entry> 
     95                        <para> 
     96                            <emphasis role="bold">unit</emphasis>={unit} </para> 
     97                    </entry> 
     98                </row> 
     99                <row> 
     100                    <entry> '''''position''''' </entry> 
     101                    <entry> container </entry> 
     102                    <entry> [0..1] </entry> 
     103                    <entry> Location in X, Y, and Z of the sample. </entry> 
     104                    <entry> 
     105                    </entry> 
     106                </row> 
     107                <row> 
     108                    <entry> '''''orientation''''' </entry> 
     109                    <entry> container </entry> 
     110                    <entry> [0..1] </entry> 
     111                    <entry> Orientation (rotation) of the sample. </entry> 
    166112                    <entry> 
    167113                    </entry> 
     
    173119                        </para> 
    174120                    </entry> 
    175                     <entry> 
    176                         string 
    177                     </entry> 
    178                     <entry> 
    179                         [0..unbounded] 
    180                     </entry> 
    181                     <entry> 
    182                         Any additional sample details. 
    183                     </entry> 
    184                     <entry> 
    185                     </entry> 
    186                 </row> 
    187                 <row> 
    188                     <entry> 
    189                         '''''{any}''''' 
    190                     </entry> 
    191                     <entry> 
    192                         container 
    193                     </entry> 
    194                     <entry> 
    195                         [0..unbounded] 
    196                     </entry> 
    197                     <entry> 
    198                         Any element(s) not defined in the cansas1d/1.0 standard can be placed at this point. See ''{any}'' for more details. 
    199                     </entry> 
    200                     <entry> 
    201                         <para> 
    202                             <emphasis role="bold"><emphasis>xmlns:{foreign-prefix}</emphasis></emphasis>={foreign-namespace} 
    203                         </para> 
    204                     </entry> 
    205                 </row> 
    206             </tbody></tgroup> 
     121                    <entry> string </entry> 
     122                    <entry> [0..unbounded] </entry> 
     123                    <entry> Any additional sample details. </entry> 
     124                    <entry> 
     125                    </entry> 
     126                </row> 
     127                <row> 
     128                    <entry> '''''{any}''''' </entry> 
     129                    <entry> container </entry> 
     130                    <entry> [0..unbounded] </entry> 
     131                    <entry> Any element(s) not defined in the cansas1d/1.0 standard can be placed at 
     132                        this point. See ''{any}'' for more details. </entry> 
     133                    <entry> 
     134                        <para> 
     135                            <emphasis role="bold" 
     136                                ><emphasis>xmlns:{foreign-prefix}</emphasis></emphasis>={foreign-namespace} 
     137                        </para> 
     138                    </entry> 
     139                </row> 
     140            </tbody> 
     141        </tgroup> 
    207142    </table> 
    208     <section><title>geometry</title> 
     143    <section> 
     144        <title>geometry</title> 
    209145        <para> 
    210146            <table> 
    211                 <title></title><tgroup cols='2'><tbody><row> 
    212                     <entry> 
    213                         <mediaobject> 
    214                             <imageobject> 
    215                                 <imagedata fileref="../graphics/translation-orientation-geometry.jpg" width='200px' scalefit='1'/> 
    216                             </imageobject> 
    217                             <textobject> 
    218                                 <phrase></phrase> 
    219                             </textobject> 
    220                             <caption> 
    221                                 <para>view from source</para> 
    222                             </caption> 
    223                         </mediaobject> 
    224                     </entry> 
    225                     <entry> 
    226                         <mediaobject> 
    227                             <imageobject> 
    228                                 <imagedata fileref="../graphics/translation-orientation-geometry-2.jpg" width='200px' scalefit='1'/> 
    229                             </imageobject> 
    230                             <textobject> 
    231                                 <phrase></phrase> 
    232                             </textobject> 
    233                             <caption> 
    234                                 <para>view from detector</para> 
    235                             </caption> 
    236                         </mediaobject> 
    237                     </entry> 
    238                 </row> 
    239                 </tbody></tgroup> 
     147                <title/> 
     148                <tgroup cols="2"> 
     149                    <tbody> 
     150                        <row> 
     151                            <entry> 
     152                                <mediaobject> 
     153                                    <imageobject> 
     154                                        <imagedata 
     155                                            fileref="../graphics/translation-orientation-geometry.jpg" 
     156                                            width="200px" scalefit="1"/> 
     157                                    </imageobject> 
     158                                    <textobject> 
     159                                        <phrase/> 
     160                                    </textobject> 
     161                                    <caption> 
     162                                        <para>view from source</para> 
     163                                    </caption> 
     164                                </mediaobject> 
     165                            </entry> 
     166                            <entry> 
     167                                <mediaobject> 
     168                                    <imageobject> 
     169                                        <imagedata 
     170                                            fileref="../graphics/translation-orientation-geometry-2.jpg" 
     171                                            width="200px" scalefit="1"/> 
     172                                    </imageobject> 
     173                                    <textobject> 
     174                                        <phrase/> 
     175                                    </textobject> 
     176                                    <caption> 
     177                                        <para>view from detector</para> 
     178                                    </caption> 
     179                                </mediaobject> 
     180                            </entry> 
     181                        </row> 
     182                    </tbody> 
     183                </tgroup> 
    240184            </table> 
    241185        </para> 
    242186    </section> 
    243     <section><title>position</title> 
     187    <section> 
     188        <title>position</title> 
    244189        <table> 
    245             <title></title><tgroup cols='5'><tbody><row> 
    246                 <entry> 
    247                     {{Headcellstyle}} | Name 
    248                 </entry> 
    249                 <entry> 
    250                     {{Headcellstyle}} | Type 
    251                 </entry> 
    252                 <entry> 
    253                     {{Headcellstyle}} | occurrence 
    254                 </entry> 
    255                 <entry> 
    256                     {{Headcellstyle}} | Description 
    257                 </entry> 
    258                 <entry> 
    259                     {{Headcellstyle}} | Attributes 
    260                 </entry> 
    261             </row> 
    262                 <row> 
    263                     <entry> 
    264                         <para> 
    265                             <emphasis role="bold">x</emphasis> 
    266                         </para> 
    267                     </entry> 
    268                     <entry> 
    269                         floating-point number 
    270                     </entry> 
    271                     <entry> 
    272                         [0..1] 
    273                     </entry> 
    274                     <entry> 
    275                         Position of the sample in X. The                             <emphasis role="bold">unit</emphasis> attribute is required. See cansas1d_documentation#Rules for acceptable values. 
    276                     </entry> 
    277                     <entry> 
    278                         <para> 
    279                             <emphasis role="bold">unit</emphasis>={units} 
    280                         </para> 
    281                     </entry> 
    282                 </row> 
    283                 <row> 
    284                     <entry> 
    285                         <para> 
    286                             <emphasis role="bold">y</emphasis> 
    287                         </para> 
    288                     </entry> 
    289                     <entry> 
    290                         floating-point number 
    291                     </entry> 
    292                     <entry> 
    293                         [0..1] 
    294                     </entry> 
    295                     <entry> 
    296                         Position of the sample in Y. The <emphasis role="bold">unit</emphasis> attribute is required. See cansas1d_documentation#Rules for acceptable values. 
    297                     </entry> 
    298                     <entry> 
    299                         <para> 
    300                             <emphasis role="bold">unit</emphasis>={units} 
    301                         </para> 
    302                     </entry> 
    303                 </row> 
    304                 <row> 
    305                     <entry> 
    306                         <para> 
    307                             <emphasis role="bold">z</emphasis> 
    308                         </para> 
    309                     </entry> 
    310                     <entry> 
    311                         floating-point number 
    312                     </entry> 
    313                     <entry> 
    314                         [0..1] 
    315                     </entry> 
    316                     <entry> 
    317                         Position of the sample in Z. The <emphasis role="bold">unit</emphasis> attribute is required. See cansas1d_documentation#Rules for acceptable values. Note: While Z dimension is allowed by the standard (provided by use of a standard element in the XML Schema), it does not make sense for small-angle scattering. 
    318                     </entry> 
    319                     <entry> 
    320                         <para> 
    321                             <emphasis role="bold">unit</emphasis>={units} 
    322                         </para> 
    323                     </entry> 
    324                 </row> 
    325             </tbody></tgroup> 
     190            <title/> 
     191            <tgroup cols="5"> 
     192                <tbody> 
     193                    <row> 
     194                        <entry> Name </entry> 
     195                        <entry> Type </entry> 
     196                        <entry> occurrence </entry> 
     197                        <entry> Description </entry> 
     198                        <entry> Attributes </entry> 
     199                    </row> 
     200                    <row> 
     201                        <entry> 
     202                            <para> 
     203                                <emphasis role="bold">x</emphasis> 
     204                            </para> 
     205                        </entry> 
     206                        <entry> floating-point number </entry> 
     207                        <entry> [0..1] </entry> 
     208                        <entry> Position of the sample in X. The <emphasis role="bold" 
     209                                >unit</emphasis> attribute is required. See 
     210                            cansas1d_documentation#Rules for acceptable values. </entry> 
     211                        <entry> 
     212                            <para> 
     213                                <emphasis role="bold">unit</emphasis>={units} </para> 
     214                        </entry> 
     215                    </row> 
     216                    <row> 
     217                        <entry> 
     218                            <para> 
     219                                <emphasis role="bold">y</emphasis> 
     220                            </para> 
     221                        </entry> 
     222                        <entry> floating-point number </entry> 
     223                        <entry> [0..1] </entry> 
     224                        <entry> Position of the sample in Y. The <emphasis role="bold" 
     225                                >unit</emphasis> attribute is required. See 
     226                            cansas1d_documentation#Rules for acceptable values. </entry> 
     227                        <entry> 
     228                            <para> 
     229                                <emphasis role="bold">unit</emphasis>={units} </para> 
     230                        </entry> 
     231                    </row> 
     232                    <row> 
     233                        <entry> 
     234                            <para> 
     235                                <emphasis role="bold">z</emphasis> 
     236                            </para> 
     237                        </entry> 
     238                        <entry> floating-point number </entry> 
     239                        <entry> [0..1] </entry> 
     240                        <entry> Position of the sample in Z. The <emphasis role="bold" 
     241                                >unit</emphasis> attribute is required. See 
     242                            cansas1d_documentation#Rules for acceptable values. Note: While Z 
     243                            dimension is allowed by the standard (provided by use of a standard 
     244                            element in the XML Schema), it does not make sense for small-angle 
     245                            scattering. </entry> 
     246                        <entry> 
     247                            <para> 
     248                                <emphasis role="bold">unit</emphasis>={units} </para> 
     249                        </entry> 
     250                    </row> 
     251                </tbody> 
     252            </tgroup> 
    326253        </table> 
    327254    </section> 
    328     <section><title>orientation</title> 
     255    <section> 
     256        <title>orientation</title> 
    329257        <table> 
    330             <title></title><tgroup cols='5'><tbody><row> 
    331                 <entry> 
    332                     {{Headcellstyle}} | Name 
    333                 </entry> 
    334                 <entry> 
    335                     {{Headcellstyle}} | Type 
    336                 </entry> 
    337                 <entry> 
    338                     {{Headcellstyle}} | occurrence 
    339                 </entry> 
    340                 <entry> 
    341                     {{Headcellstyle}} | Description 
    342                 </entry> 
    343                 <entry> 
    344                     {{Headcellstyle}} | Attributes 
    345                 </entry> 
    346             </row> 
    347                 <row> 
    348                     <entry> 
    349                         <para> 
    350                             <emphasis role="bold">roll</emphasis> 
    351                         </para> 
    352                     </entry> 
    353                     <entry> 
    354                         floating-point number 
    355                     </entry> 
    356                     <entry> 
    357                         [0..1] 
    358                     </entry> 
    359                     <entry> 
    360                         Rotation about the <emphasis>Z</emphasis> axis (roll). The <emphasis role="bold">unit</emphasis> attribute is required. See cansas1d_documentation#Rules for acceptable values. 
    361                     </entry> 
    362                     <entry> 
    363                         <para> 
    364                             <emphasis role="bold">unit</emphasis>={units} 
    365                         </para> 
    366                     </entry> 
    367                 </row> 
    368                 <row> 
    369                     <entry> 
    370                         <para> 
    371                             <emphasis role="bold">pitch</emphasis> 
    372                         </para> 
    373                     </entry> 
    374                     <entry> 
    375                         floating-point number 
    376                     </entry> 
    377                     <entry> 
    378                         [0..1] 
    379                     </entry> 
    380                     <entry> 
    381                         Rotation about the <emphasis>X</emphasis> axis (pitch). The <emphasis role="bold">unit</emphasis> attribute is required. See cansas1d_documentation#Rules for acceptable values. 
    382                     </entry> 
    383                     <entry> 
    384                         <para> 
    385                             <emphasis role="bold">unit</emphasis>={units} 
    386                         </para> 
    387                     </entry> 
    388                 </row> 
    389                 <row> 
    390                     <entry> 
    391                         <para> 
    392                             <emphasis role="bold">yaw</emphasis> 
    393                         </para> 
    394                     </entry> 
    395                     <entry> 
    396                         floating-point number 
    397                     </entry> 
    398                     <entry> 
    399                         [0..1] 
    400                     </entry> 
    401                     <entry> 
    402                         Rotation about the <emphasis>Y</emphasis> axis (yaw). The <emphasis role="bold">unit</emphasis> attribute is required. See cansas1d_documentation#Rules for acceptable values. 
    403                     </entry> 
    404                     <entry> 
    405                         <para> 
    406                             <emphasis role="bold">unit</emphasis>={units} 
    407                         </para> 
    408                     </entry> 
    409                 </row> 
    410             </tbody></tgroup> 
     258            <title/> 
     259            <tgroup cols="5"> 
     260                <tbody> 
     261                    <row> 
     262                        <entry> Name </entry> 
     263                        <entry> Type </entry> 
     264                        <entry> occurrence </entry> 
     265                        <entry> Description </entry> 
     266                        <entry> Attributes </entry> 
     267                    </row> 
     268                    <row> 
     269                        <entry> 
     270                            <para> 
     271                                <emphasis role="bold">roll</emphasis> 
     272                            </para> 
     273                        </entry> 
     274                        <entry> floating-point number </entry> 
     275                        <entry> [0..1] </entry> 
     276                        <entry> Rotation about the <emphasis>Z</emphasis> axis (roll). The <emphasis 
     277                                role="bold">unit</emphasis> attribute is required. See 
     278                            cansas1d_documentation#Rules for acceptable values. </entry> 
     279                        <entry> 
     280                            <para> 
     281                                <emphasis role="bold">unit</emphasis>={units} </para> 
     282                        </entry> 
     283                    </row> 
     284                    <row> 
     285                        <entry> 
     286                            <para> 
     287                                <emphasis role="bold">pitch</emphasis> 
     288                            </para> 
     289                        </entry> 
     290                        <entry> floating-point number </entry> 
     291                        <entry> [0..1] </entry> 
     292                        <entry> Rotation about the <emphasis>X</emphasis> axis (pitch). The 
     293                                <emphasis role="bold">unit</emphasis> attribute is required. See 
     294                            cansas1d_documentation#Rules for acceptable values. </entry> 
     295                        <entry> 
     296                            <para> 
     297                                <emphasis role="bold">unit</emphasis>={units} </para> 
     298                        </entry> 
     299                    </row> 
     300                    <row> 
     301                        <entry> 
     302                            <para> 
     303                                <emphasis role="bold">yaw</emphasis> 
     304                            </para> 
     305                        </entry> 
     306                        <entry> floating-point number </entry> 
     307                        <entry> [0..1] </entry> 
     308                        <entry> Rotation about the <emphasis>Y</emphasis> axis (yaw). The <emphasis 
     309                                role="bold">unit</emphasis> attribute is required. See 
     310                            cansas1d_documentation#Rules for acceptable values. </entry> 
     311                        <entry> 
     312                            <para> 
     313                                <emphasis role="bold">unit</emphasis>={units} </para> 
     314                        </entry> 
     315                    </row> 
     316                </tbody> 
     317            </tgroup> 
    411318        </table> 
     319        <note> 
     320            <para> The <emphasis role="bold">orientation</emphasis> element is intended to describe 
     321                simple rotations about a single axis rather than a full set of rotations as in a 
     322                crystallographic context. </para> 
     323        </note> 
    412324    </section> 
    413325</section> 
  • 1dwg/trunk/doc/elements.xml

    r109 r110  
    2222    <xi:include href="cansas1d_element_SASdata.xml"/> 
    2323    <xi:include href="cansas1d_element_SASsample.xml"/> 
    24     <!--<xi:include href="cansas1d_element_SASinstrument.xml"/>--> 
    25     <!--<xi:include href="cansas1d_element_SASsource.xml"/>--> 
     24    <xi:include href="cansas1d_element_SASinstrument.xml"/> 
     25    <xi:include href="cansas1d_element_SASsource.xml"/> 
    2626    <!--<xi:include href="cansas1d_element_SAScollimation.xml"/>--> 
    2727    <!--<xi:include href="cansas1d_element_SASdetector.xml"/>--> 
  • 1dwg/trunk/doc/manual.xml

    r109 r110  
    7070        cansas1d_SASdata 
    7171        cansas1d_SASsample 
    72     cansas1d_SASinstrument 
    73     cansas1d_SASsource 
     72        cansas1d_SASinstrument 
     73        cansas1d_SASsource 
    7474    cansas1d_SAScollimation 
    7575    cansas1d_SASdetector 
Note: See TracChangeset for help on using the changeset viewer.