source: 1dwg/trunk/doc/wiki.xml @ 91

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

Start to convert documentation to DocBook?. Refs #19. This way, correct documentation can be kept with each revision of the standard.

  • Property svn:keywords set to Date Revision Author HeadURL Id
File size: 34.7 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<chapter xml:id="wiki-chapter" xmlns="http://docbook.org/ns/docbook" version="5.0"
13    xmlns:xlink="http://www.w3.org/1999/xlink">
14    <title>Wiki Manual</title>
15    <!-- from: http://www.smallangles.net/wgwiki/index.php/cansas1d_documentation -->
16    <section xml:id="cansas1d_documentation_Disclaimer">
17        <title>Disclaimer</title>
18        <para>This description is meant to inform the community how to layout the information within
19            the XML files. However, should the information in this document and the <link
20                xlink:href="http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/cansas1d.xsd"
21                >cansas1d/1.0 SAS XML Schema</link>
22            (http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/cansas1d.xsd) differ, the XML
23            Schema will be deemed to have the most correct description of the standard.</para>
24    </section>
25    <section xml:id="cansas1d_documentation_Objective">
26        <title>Objective</title>
27        <para>One of the first aims of the canSAS (Collective Action for Nomadic Small-Angle
28            Scatterers) forum of users, software developers, and facility staff was to discuss
29            better sharing of SAS data analysis software. <link
30                xlink:href="http://www.smallangles.net/canSAS">CanSAS</link>
31            (http://www.smallangles.net/canSAS) identified that a significant need within the SAS
32            community can be satisfied by a robust, self-describing, text-based, standard format to
33            communicate reduced one-dimensional small-angle scattering data, ''I(Q)'', between users
34            of our facilities. Our goal has been to define such a format that leaves the data file
35            instantly human-readable, editable in the simplest of editors, and importable by simple
36            text import filters in programs that need not recognise advanced structure in the file
37            nor require advanced programming interfaces. The file should contain both the primary
38            data of ''I(Q)'' and also any other descriptive information (metadata) about the sample,
39            measurement, instrument, processing, or analysis steps. </para>
40        <para>The cansas1d/1.0 standard meets the objectives for a 1D standard, incorporating
41            metadata about the measurement, parameters and results of processing or analysis steps.
42            Even multiple measurements (related or unrelated) may be included within a single XML
43            file. </para>
44        <section xml:id="cansas1d_documentation_Objective_Status">
45            <title>Status</title>
46            <para>Version 1.0 was tagged from the subversion repository on 2009-05-12 as no changes
47                were committed since January 2009. Use this command to checkout the tagged release.
48                <programlisting>svn checkout http://svn.smallangles.net/svn/canSAS/1dwg/tags/v1.0 cansas1dwg-1.0</programlisting></para>
49        </section>
50    </section>
51    <section xml:id="cansas1d_documentation-XMLLayout">
52        <title>General Layout of the XML Data</title>
53        <para>The canSAS 1-D standard for reduced 1-D SAS data is implemented using XML files. A
54            single file can contain SAS data from a single experiment or multiple experiments. All
55            types of relevant data (''I(Q)'', metadata) are described for each experiment. More
56            details are provided below.</para>
57        <section xml:id="cansas1d_documentation-XMLLayout-Overview">
58            <title>Overview</title>
59            <para>The basic elements of the cansas1d/1.0 standard are shown in the following table.
60                After an XML header, the root element of the file is [[cansas1d_SASroot | SASroot]]
61                which contains one or more [[cansas1d_SASentry | SASentry]] elements, each of which
62                describes a single experiment (data set, time-slice, step in a series, new sample,
63                etc.). Details of the [[cansas1d_SASentry | SASentry]] element are also shown in the
64                next figure. Refer to the [[cansas1d_block_diagrams | block diagrams]] for
65                alternative depictions. See
66                [http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/cansas1d.xml
67                cansas1d.xml] for an example XML file. Examples, Case Studies, and other background
68                information are below. More discussion can be found on the
69                [[1D_Data_Formats_Working_Group|canSAS 1D Data Formats Working Group]] page and its
70                [[Talk:1D_Data_Formats_Working_Group|discussion]] page. Details about each specific
71                field (XPath string, XML elements and attributes) are described on the
72                [[cansas1d_definition_of_terms]] page. </para>
73            <figure>
74                <title>block diagram of minimum elements required for cansas1d/1.0 standard</title>
75                <mediaobject>
76                    <imageobject>
77                        <imagedata fileref="../graphics/10-minimum.png" scale="80"/></imageobject>
78                </mediaobject>
79            </figure>
80            <itemizedlist>
81                <listitem>
82                    <para> SASroot: the root element of the file (after the XML header) </para>
83                </listitem>
84                <listitem>
85                    <para> SASentry: describes a single experiment (data set, time-slice, step in a
86                        series, new sample, etc.) </para>
87                </listitem>
88                <listitem>
89                    <para> block diagrams </para>
90                </listitem>
91                <listitem>
92                    <para> cansas1d.xml example XML file </para>
93                </listitem>
94                <listitem>
95                    <para> discussion of this format: basic more </para>
96                </listitem>
97                <listitem>
98                    <para> Seek outside help for XML </para>
99                </listitem>
100                <listitem>
101                    <para> Definition of terms: Details about each specific field (XPath string, XML
102                        elements and attributes) </para>
103                </listitem>
104            </itemizedlist>
105            <section xml:id="cansas1d_documentation-Basic_elements">
106                <title>Basic elements of the cansas1d/1.0 standard</title>
107                <para>
108                    <table frame="all">
109                        <title>Basic elements of the CanSAS 1-D standard</title>
110                        <tgroup cols="2">
111                            <colspec colname="c1" colnum="1"/>
112                            <colspec colname="c2" colnum="2"/>
113                            <thead>
114                                <row>
115                                    <entry>Element</entry>
116                                    <entry>Description</entry>
117                                </row>
118                            </thead>
119                            <tbody>
120                                <row>
121                                    <entry>XML Header</entry>
122                                    <entry>descriptive info required at the start of every XML
123                                        file</entry>
124                                </row>
125                                <row>
126                                    <entry>SASroot</entry>
127                                    <entry>root element of XML file</entry>
128                                </row>
129                                <row>
130                                    <entry>SASentry</entry>
131                                    <entry>data set, time-slice, step in a series, new sample,
132                                        etc.</entry>
133                                </row>
134                                <row>
135                                    <entry>:::Title</entry>
136                                    <entry>for this particular SASentry</entry>
137                                </row>
138                                <row>
139                                    <entry>:::Run</entry>
140                                    <entry>run number or ID number of experiment</entry>
141                                </row>
142                                <row>
143                                    <entry>:::[[cansas1d_any | {any}]]</entry>
144                                    <entry>any non-cansas1d/1.0 element can be used at this
145                                        point</entry>
146                                </row>
147                                <row>
148                                    <entry>:::[[cansas1d_SASdata | SASdata]]</entry>
149                                    <entry>this is where the reduced 1-D SAS data is stored</entry>
150                                </row>
151                                <row>
152                                    <entry>::::[[cansas1d_SASdata | Idata]]</entry>
153                                    <entry>a single data point in the dataset</entry>
154                                </row>
155                                <row>
156                                    <entry>:::[[cansas1d_any | {any}]]</entry>
157                                    <entry>any non-cansas1d/1.0 element can be used at this
158                                        point</entry>
159                                </row>
160                                <row>
161                                    <entry>:::[[cansas1d_SASsample | SASsample]]</entry>
162                                    <entry>description of the sample</entry>
163                                </row>
164                                <row>
165                                    <entry>:::[[cansas1d_SASinstrument | SASinstrument]]</entry>
166                                    <entry>description of the instrument</entry>
167                                </row>
168                                <row>
169                                    <entry>::::[[cansas1d_SASsource | SASsource]]</entry>
170                                    <entry>description of the source</entry>
171                                </row>
172                                <row>
173                                    <entry>::::[[cansas1d_SAScollimation | SAScollimation]]</entry>
174                                    <entry>description of the collimation</entry>
175                                </row>
176                                <row>
177                                    <entry>::::[[cansas1d_SASdetector | SASdetector]]</entry>
178                                    <entry>description of the detector</entry>
179                                </row>
180                                <row>
181                                    <entry>:::[[cansas1d_SASprocess | SASprocess]]</entry>
182                                    <entry>for each processing or analysis step</entry>
183                                </row>
184                                <row>
185                                    <entry>:::[[cansas1d_SASnote | SASnote]]</entry>
186                                    <entry>anything at all</entry>
187                                </row>
188                            </tbody>
189                        </tgroup>
190                    </table>
191                </para>
192            </section>
193            <section xml:id="cansas1d_documentation-required_header">
194                <title>Required XML file header</title>
195                <programlisting>
196&lt;?xml version="1.0"?>
197&lt;?xml-stylesheet type="text/xsl" href="cansasxml-html.xsl" ?>
198&lt;SASroot version="1.0"
199    xmlns="cansas1d/1.0"
200    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
201    xsi:schemaLocation="cansas1d/1.0
202        http://svn.smallangles.net/svn/canSAS/1dwg/trunk/cansas1d.xsd"
203    >
204                </programlisting>
205            </section>
206        </section>
207        <section xml:id="cansas1d_documentation-rules">
208            <title>Rules</title>
209            <orderedlist>
210                <listitem>
211                    <para> canSAS1d/1.0 XML data files will adhere to the standard if they can
212                        successfully [[cansas1d_documentation#Validation_of_XML_against_the_Schema |
213                        validate]] against the established XML Schema
214                        ([http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/cansas1d.xsd
215                        cansas1d.xsd])</para>
216                </listitem>
217                <listitem>
218                    <equation><mathphrase>Q=(4 pi / lambda) sin(theta)</mathphrase></equation>
219                    <para>where lambda is the wavelength of the radiation</para>
220                    <para>and 2theta is the angle through which the detected radiation has been
221                        scattered.</para>
222                    <figure>
223                        <title>definition of Q geometry for small-angle scattering</title>
224                        <mediaobject>
225                            <imageobject>
226                                <imagedata fileref="../graphics/Q-geometry.jpg" scale="80"
227                                /></imageobject>
228                        </mediaobject>
229                    </figure>
230                </listitem>
231                <listitem>
232                    <para> units to be given in standard SI abbreviations (eg, m, cm, mm, nm, K)
233                        with the following exceptions: </para>
234                    <orderedlist numeration="loweralpha">
235                        <listitem>
236                            <para>um=micrometres</para>
237                        </listitem>
238                        <listitem>
239                            <para>C=celsius</para>
240                        </listitem>
241                        <listitem>
242                            <para>A=Angstroms</para>
243                        </listitem>
244                        <listitem>
245                            <para>percent=%.</para>
246                        </listitem>
247                        <listitem>
248                            <para>fraction</para>
249                        </listitem>
250                        <listitem>
251                            <para>a.u.=arbitrary units</para>
252                        </listitem>
253                        <listitem>
254                            <para>none=no units are relevant (such as dimensionless)</para>
255                        </listitem>
256                    </orderedlist>
257                </listitem>
258                <listitem>
259                    <para> where reciprocal units need to be quoted the format shall be
260                        "1/abbreviation"</para>
261                </listitem>
262                <listitem>
263                    <para> when raised to a power, use similar to "A^3" or "1/m^4" (and not "A3" or
264                        "m-4")</para>
265                </listitem>
266                <listitem>
267                    <para> axes: </para>
268                    <orderedlist numeration="loweralpha">
269                        <listitem>
270                            <para>z is along the flight path (positive value in the direction of the
271                                detector)</para>
272                        </listitem>
273                        <listitem>
274                            <para>x is orthogonal to z in the horizontal plane (positive values
275                                increase to the right when viewed towards the incoming
276                                radiation)</para>
277                        </listitem>
278                        <listitem>
279                            <para>y is orthogonal to z and x in the vertical plane (positive values
280                                increase upwards)</para>
281                        </listitem>
282                        <listitem>
283                            <figure>
284                                <title>definition of translation and orientation geometry as viewed
285                                    from the detector towards the source</title>
286                                <mediaobject>
287                                    <imageobject>
288                                        <imagedata
289                                            fileref="../graphics/translation-orientation-geometry.jpg"
290                                            scale="80"/></imageobject>
291                                </mediaobject>
292                            </figure>
293                            <figure>
294                                <title>definition of translation and orientation geometry as viewed
295                                    from the source towards the detector</title>
296                                <mediaobject>
297                                    <imageobject>
298                                        <imagedata
299                                            fileref="../graphics/translation-orientation-geometry-2.jpg"
300                                            scale="80"/></imageobject>
301                                </mediaobject>
302                            </figure>
303                        </listitem>
304                    </orderedlist>
305                </listitem>
306                <listitem>
307                    <para>orientation (angles) describes one-axis rotations (rotations about
308                        multiple axes require more information): </para>
309                    <orderedlist numeration="loweralpha">
310                        <listitem>
311                            <para>roll is about z</para>
312                        </listitem>
313                        <listitem>
314                            <para>pitch is about x</para>
315                        </listitem>
316                        <listitem>
317                            <para>yaw is about y</para>
318                        </listitem>
319                    </orderedlist>
320                </listitem>
321                <listitem>
322                    <para> Unicode characters MUST NOT be used</para>
323                </listitem>
324                <listitem>
325                    <para> Binary data is not supported</para>
326                </listitem>
327            </orderedlist>
328            <para>
329            </para>
330        </section>
331        <section xml:id="cansas1d_documentation-geometry_compatibility">
332            <title>Compatibility of Geometry Definitions</title>
333            <para> Note: translation and orientation geometry used by canSAS are consistent with: </para>
334            <itemizedlist>
335                <listitem>
336                    <para>http://en.wikipedia.org/wiki/Cartesian_coordinate_system</para>
337                </listitem>
338                <listitem>
339                    <para>http://en.wikipedia.org/wiki/Right-hand_rule</para>
340                </listitem>
341                <listitem>
342                    <para>http://www.nexusformat.org/Coordinate_Systems</para>
343                </listitem>
344                <listitem>
345                    <para>http://mcstas.risoe.dk/documentation/tutorial/node6.html</para>
346                </listitem>
347                <listitem>
348                    <para>http://webhost5.nts.jhu.edu/reza/book/kinematics/kinematics.htm</para>
349                </listitem>
350            </itemizedlist>
351            <para>The translation and orientation geometry definitions used here are different than
352                those used by '''SHADOW''' (http://www.nanotech.wisc.edu/shadow) where the ''y'' and
353                ''z'' axes are swapped and the direction of ''x'' is changed.</para>
354        </section>
355        <section xml:id="cansas1d_documentation-converting_into_XML">
356            <title>Converting data into the XML format</title>
357            <para>A WWW form ([http://www.smallangles.net/canSAS/xmlWriter/ canSAS/xmlWriter]) is
358                available to translate three-column ASCII text data into the canSAS1d/1.0 XML
359                format. This form will help you in creating an XML file with all the required
360                elements in the correct places. The form requests the SAS data of Q, I, and Idev
361                (defined elsewhere on this page) and some basic metadata (title, run, sample info,
362                ...). Press the &lt;nowiki>Submit&lt;/nowiki> button and you will receive a nicely
363                formatted WWW page with the SAS data. If you then choose "View page source" (from
364                one of your browser menus), you will see the raw XML of the canSAS1d/1.0 XML format
365                and you can copy/paste this into an XML file. </para>
366            <para>The SAS data that you paste into the form box is likely to be copied directly from
367                a 3-column ASCII file from a text editor. Line breaks are OK, they will be treated
368                as white-space as will tabs and commas. Do not be concerned that the data looks
369                awful in the form entry box, just check the result to see that it comes out
370                OK.</para>
371        </section>
372    </section>
373    <section xml:id="cansas1d_documentation-Documentation-Definitions">
374        <title>Documentation and Definitions</title>
375        <itemizedlist>
376            <listitem>
377                <para><emphasis role="bold">Documentation</emphasis>: [[cansas1d_documentation]]
378                    (this page)</para>
379            </listitem>
380            <listitem>
381                <para><emphasis role="bold">Definitions</emphasis>:
382                    [[cansas1d_definition_of_terms]]</para>
383            </listitem>
384            <listitem>
385                <para><emphasis role="bold">Block diagrams</emphasis>:
386                    [[cansas1d_block_diagrams]]</para>
387            </listitem>
388        </itemizedlist>
389        <section xml:id="cansas1d_documentation-XML_Schema">
390            <title>XML Schema</title>
391            <para> The [http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/cansas1d.xsd
392                cansas1d.xsd] [http://www.w3schools.com/xsd XML Schema] defines the rules for the
393                XML file format
394                ([http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/cansas1d.xsd TRAC],
395                [http://svn.smallangles.net/svn/canSAS/1dwg/trunk/cansas1d.xsd SVN]) and is used to
396                validate any XML file for adherence to the format. </para>
397        </section>
398        <section xml:id="cansas1d_documentation-XML_Stylesheets">
399            <title>XML Stylesheets</title>
400            <itemizedlist>
401                <listitem>
402                    <para>'''cansasxml-html.xsl''': [http://www.w3schools.com/xsl/ XSLT stylesheets]
403                        can be used to extract metadata or to convert into another file format. The
404                        default canSAS stylesheet
405                        [[http://svn.smallangles.net/svn/canSAS/1dwg/trunk/cansasxml-html.xsl
406                        cansasxml-html.xsl]] should be copied into each folder with canSAS XML data
407                        file(s). It can be used to display the data in a supporting WWW browser
408                        (such as Firefox or Internet Explorer) or to import into Microsoft Excel
409                        (with the added XML support in Excel). (See the excellent write-up by Steve
410                        King, ISIS, at
411                        http://www.isis.rl.ac.uk/archive/LargeScale/LOQ/xml/cansas_xml_format.pdf
412                        for an example.) By default, MS Windows binds '''*.xml''' files to start
413                        Internet Explorer. Double-clicking on a canSAS XML data file with the
414                        [http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/cansasxml-html.xsl
415                        '''cansasxml-html.xsl'''] stylesheet in the same directory will produce a
416                        WWW page with the SAS data and selected metadata.</para>
417                </listitem>
418                <listitem>
419                    <para>Suggestions for support software that writes canSAS1d/1.0 XML data
420                        files:</para>
421                    <itemizedlist>
422                        <listitem>
423                            <para>be sure to update to the latest SVN repository revision (command:
424                                    <code>svn update</code>) </para>
425                        </listitem>
426                        <listitem>
427                            <para>check the output directory to see if it contains the default XSLT
428                                file.</para>
429                        </listitem>
430                        <listitem>
431                            <para>copy the latest XSLT file to the output directory if
432                                either:</para>
433                            <itemizedlist>
434                                <listitem>
435                                    <para>the output directory contains an older revision</para>
436                                </listitem>
437                                <listitem>
438                                    <para>the output directory does not have the default XSLT
439                                        file</para>
440                                </listitem>
441                            </itemizedlist>
442                        </listitem>
443                        <listitem>
444                            <para>The most recent XSLT file can be identified by examining the file
445                                for the '''$ Revision: ''' string. For example:
446                                <programlisting># \$Revision$</programlisting> is version 66
447                                (updated 2009-01-12). </para>
448                        </listitem>
449                    </itemizedlist>
450                </listitem>
451            </itemizedlist>
452        </section>
453        <section xml:id="cansas1d_documentation-examples">
454            <title>Examples and Case Studies</title>
455            <itemizedlist>
456                <listitem>
457                    <para>[http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/cansas1d.xml
458                        cansas1d.xml] basic example: Note that, for clarity, only one row of data is
459                        shown. This is probably a very good example to use as a starting point for
460                        creating XML files with a text editor.</para>
461                </listitem>
462                <listitem>
463                    <para>[http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/bimodal-test1.xml
464                        bimodal-test1.xml]: Simulated SAS data to test size distribution calculation
465                        routines.</para>
466                </listitem>
467                <listitem>
468                    <para>[[Glassy_Carbon_Round_Robin | Glassy Carbon Round Robin]]: Glassy carbon
469                        samples measured at several facilities worldwide.</para>
470                </listitem>
471                <listitem>
472                    <para>[[cansas1d_casestudy_collagen | dry chick collagen]]: illustrates the
473                        minimum information necessary to meet the requirements of the standard
474                        format</para>
475                </listitem>
476                <listitem>
477                    <para>[[cansas1d_casestudy_af1410 | AF1410 steel]]: SANS study using magnetic
478                        contrast variation (with multiple samples and multiple data sets for each
479                        sample), the files can be viewed from TRAC (no description yet):
480                        [http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/examples/af1410/
481                        http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/examples/af1410/]</para>
482                </listitem>
483                <listitem>
484                    <para>[http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/cansas1d-template.xml
485                        cansas1d-template.xml]: This is used to test all the rules in the XML
486                        Schema. This is probably not a very good example to use as a starting point
487                        for creating XML files with a text editor since it tests many of the
488                        special-case rules.</para>
489                </listitem>
490            </itemizedlist>
491            <section xml:id="cansas1d_documentation-examples-multiple_experiments">
492                <title>XML layout for multiple experiments</title>
493                <para>Each experiment is described with a single '''SASentry''' element. The
494                    fragment below shows how multiple experiments can be included in a single XML
495                    file. Full examples of canSAS XML files with multiple experiments
496                    include:</para>
497                <itemizedlist>
498                    <listitem>
499                        <para>[http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/W1W2.XML
500                            ISIS LOQ SANS instrument]</para>
501                    </listitem>
502                    <listitem>
503                        <para>[http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/cs_af1410.xml
504                            NIST SANS data]</para>
505                    </listitem>
506                </itemizedlist>
507                <para>Here is a brief sketch of how a file would be arranged with multiple SASentry
508                    elements and multiple SASdata elements.
509                    <programlisting>
510&lt;?xml version="1.0"?>
511&lt;?xml-stylesheet type="text/xsl" href="cansasxml-html.xsl" ?>
512&lt;SASroot version="1.0"
513   xmlns="cansas1d/1.0"
514   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
515   xsi:schemaLocation="cansas1d/1.0 http://svn.smallangles.net/svn/canSAS/1dwg/trunk/cansas1d.xsd"
516   >
517   &lt;SASentry name="071121.dat#S22">
518     &lt;!-\- contents of the first experiment in the file go here -\->
519   &lt;/SASentry>
520   &lt;SASentry name="example temperature series">
521     &lt;!-\- example with two SAS data sets related to the same sample -\->
522     &lt;Title>title of this series&lt;/Title>
523     &lt;Run name="run1">42-001&lt;/Run>
524     &lt;Run name="run2">42-002&lt;/Run>
525     &lt;SASdata name="run1">
526       &lt;!-\- data from 42-001 run comes here -\->
527     &lt;/SASdata>
528     &lt;SASdata name="run2">
529       &lt;!-\- data from 42-002 run comes here -\->
530     &lt;/SASdata>
531     &lt;!-\- other elements come here for this entry -\->
532   &lt;/SASentry>
533   &lt;SASentry name="other sample">
534     &lt;!-\- any number of additional experiments can be included, as desired -\->
535     &lt;!-\- SASentry elements in the same XML file do not have to be related -\->
536   &lt;/SASentry>
537&lt;/SASroot>
538                    </programlisting></para>
539            </section>
540        </section>
541        <section xml:id="cansas1d_documentation-Foreign_Elements">
542            <title>Foreign Elements</title>
543            <para> To allow for inclusion of elements that are not defined by the cansas1d.xsd XML
544                Schema, XML ''foreign elements'' are permitted at select locations in the
545                cansas1d/1.0 format. Please refer to the references (and others) [[#Help_for_XML |
546                below]] for deeper discussions on foreign elements. </para>
547            <para> No examples exist. <note>
548                    <para> 2009-09, PRJ: Actually, the ISIS glassy carbon data is now an example
549                    </para>
550                </note> At present, all examples of canSAS xml files using foreign namespaces have
551                been converted to bring that data into either the '''SASprocessnote''' or
552                '''SASnote''' elements. Refer to the
553                [http://svn.smallangles.net/trac/canSAS/changeset/47 TRAC changes] for an example of
554                arranging the content in '''SASprocessnote''' to avoid the use of foreign namespace
555                elements. </para>
556        </section>
557        <section xml:id="cansas1d_documentation-Support_Tools">
558            <title>Support tools for Visualization &amp; Analysis software</title>
559            <para> Support for importing canSAS1d/1.0 files exists for these languages: <note>
560                    <para>Refactor the wiki pages here and link as appropriate.</para>
561                </note></para>
562            <itemizedlist>
563                <listitem>
564                    <para><emphasis role="bold">FORTRAN</emphasis></para>
565                </listitem>
566                <listitem>
567                    <para><emphasis role="bold">IgorPro</emphasis></para>
568                </listitem>
569                <listitem>
570                    <para><emphasis role="bold">Java</emphasis></para>
571                </listitem>
572                <listitem>
573                    <para><emphasis role="bold">Microsoft Excel</emphasis></para>
574                </listitem>
575                <listitem>
576                    <para><emphasis role="bold">PHP</emphasis></para>
577                </listitem>
578                <listitem>
579                    <para><emphasis role="bold">Python</emphasis></para>
580                </listitem>
581                <listitem>
582                    <para><emphasis role="bold">XSLT</emphasis> (useful in a web browser)</para>
583                </listitem>
584            </itemizedlist>
585        </section>
586        <section xml:id="cansas1d_documentation-repositories">
587            <title>Software repositories (for canSAS1d/1.0 standard)</title>
588            <itemizedlist>
589                <listitem>
590                    <para><emphasis role="bold">TRAC</emphasis>:
591                        http://svn.smallangles.net/trac/canSAS/browser/1dwg/tags/v1.0</para>
592                </listitem>
593                <listitem>
594                    <para><emphasis role="bold">Subversion</emphasis>:
595                        http://svn.smallangles.net/svn/canSAS/1dwg/tags/v1.0</para>
596                </listitem>
597            </itemizedlist>
598        </section>
599    </section>
600    <section xml:id="cansas1d_documentation-schema_validation">
601        <title>Validation of XML against the Schema</title>
602        <orderedlist>
603            <listitem><para>open browser to:   http://www.xmlvalidation.com/</para></listitem>
604            <listitem><para>paste content of candidate XML file (with reference in the header to the XML Schema as shown above) into the form</para></listitem>
605            <listitem><para>press &lt;validate></para></listitem>
606            <listitem><para>paste content of [http://svn.smallangles.net/svn/canSAS/1dwg/trunk/cansas1d.xsd cansas1d.xsd] XSD file into form and press &lt;continue validation></para></listitem>
607            <listitem><para>check the results</para></listitem>
608        </orderedlist>
609    </section>
610    <section xml:id="cansas1d_documentation-XML_Help">
611        <title>Help for XML</title>
612        <para>The various references for help on XML have been moved to their own wiki page:
613            [[XmlHelp]] </para>
614    </section>
615</chapter>
Note: See TracBrowser for help on using the repository browser.