JAL-1527 opening a project saved with JMol should use JMol (disregard
[jalview.git] / schemas / JalviewWsParamSet.xsd
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2)
4  * Copyright (C) 2014 The Jalview Authors
5  * 
6  * This file is part of Jalview.
7  * 
8  * Jalview is free software: you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License 
10  * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
11  *  
12  * Jalview is distributed in the hope that it will be useful, but 
13  * WITHOUT ANY WARRANTY; without even the implied warranty 
14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
15  * PURPOSE.  See the GNU General Public License for more details.
16  * 
17  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
18  * The Jalview Authors are detailed in the 'AUTHORS' file.
19 -->
20 <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
21         targetNamespace="www.jalview.org/xml/wsparamset">
22         <xs:complexType name="WebServiceParameterSet">
23                 <xs:sequence>
24                         <xs:element name="Version" maxOccurs="1" minOccurs="0"
25                                 type="xs:string">
26                                 <xs:annotation>
27                                         <xs:documentation>
28                                                 A Jalview Web Service Parameter Set container
29                                                 version number.
30                                                 Version 1 created for storing Jaba user presets.
31                                         </xs:documentation>
32                                 </xs:annotation>
33                         </xs:element>
34                         <xs:element name="description" minOccurs="0" maxOccurs="1"
35                                 type="xs:string">
36                                 <xs:annotation>
37                                         <xs:documentation>Short description - as utf8 encoded text. This is
38                                                 usually displayed
39                                                 in the body of an HTML capable tooltip, so HTML tags may be embedded
40                                                 using standard UTF8 encoding.
41                                         </xs:documentation>
42                                 </xs:annotation>
43                         </xs:element>
44                         <xs:element name="serviceURL" minOccurs="1" maxOccurs="unbounded"
45                                 type="xs:anyURI">
46                                 <xs:annotation>
47                                         <xs:documentation>
48                                                 URL for which the parameter set is valid. Jalview will use it to
49                                                 match up parameter sets to service instances that can parse the
50                                                 parameter set payload.
51                                 </xs:documentation>
52                                 </xs:annotation>
53                         </xs:element>
54
55                         <xs:element name="parameters" maxOccurs="1" minOccurs="1"
56                                 type="xs:string">
57                                 <xs:annotation>
58                                         <xs:documentation>
59                                                 UTF8 encoded string to be processed into a specific web services'
60                                                 parameter set. Note - newlines may be important to the structure
61                                                 of this file.
62                                 </xs:documentation>
63                                 </xs:annotation>
64                         </xs:element>
65                 </xs:sequence>
66                 <xs:attribute name="name" type="xs:string" use="required">
67                         <xs:annotation>
68                                 <xs:documentation>
69                                         The short name for the parameter set. This will be shown amongst the
70                                         other presets for the web service.
71                 </xs:documentation>
72                         </xs:annotation>
73                 </xs:attribute>
74         </xs:complexType>
75 </xs:schema>