-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathspecifications.html
331 lines (295 loc) · 14.2 KB
/
specifications.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="author" content="sed-ml.org">
<meta name="description" content="Simulation Experiment Description Language (SED-ML)">
<title>SED-ML | Specifications</title>
<link rel="shortcut icon" type="image/x-icon" href="favicon.ico">
<!-- css -->
<!-- Bootstrap Core CSS -->
<link href="css/bootstrap.min.css" rel="stylesheet">
<!-- Custom CSS -->
<link href="css/sb-admin.css" rel="stylesheet">
<!-- Morris Charts CSS -->
<link href="css/plugins/morris.css" rel="stylesheet">
<!-- Custom Fonts -->
<link href="font-awesome/css/font-awesome.min.css" rel="stylesheet" type="text/css">
<link rel="stylesheet" href="css/sed-ml.css" type="text/css"/>
<!-- JS -->
<script src="https://code.jquery.com/jquery-2.2.4.min.js" integrity="sha256-BbhdlvQf/xTY9gja0Dq3HiwQF8LaCRTXxZKRutelT44=" crossorigin="anonymous"></script>
<script src="_report/js/bootstrap-3.3.7.min.js"></script>
<script type="text/javascript" src="https://cdn.datatables.net/t/bs/jq-2.2.0,dt-1.10.11/datatables.min.js"></script>
<script type="text/javascript" src="https://cdn.datatables.net/1.10.15/js/jquery.dataTables.min.js"></script>
</head>
<body>
<div id="wrapper">
<!-- Navigation -->
<nav class="navbar navbar-inverse navbar-fixed-top" role="navigation">
<!-- Brand and toggle get grouped for better mobile display -->
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-ex1-collapse">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-left" href="index.html" style="background-color: white; text-decoration: none;"><img src="images/logoSEDML_H75.png" alt="SED-ML logo" height="50"/>
<span class="sedml-heading">Simulation Experiment Description Markup Language</span></a>
</div>
<!-- Top Menu Items -->
<ul class="nav navbar-right top-nav" style="background-color: white;">
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown"><i class="fa fa-question-circle"></i> Resources <b class="caret"></b></a>
<ul class="dropdown-menu" style="min-width: 230px;">
<li>
<a href="https://github.com/SED-ML/" target="_blank"><i class="fa fa-fw fa-code"></i> Source repository</a>
</li>
<li class="divider"></li>
<li>
<a href="https://github.com/SED-ML/sed-ml/issues" target="_blank"><i class="fa fa-fw fa-fire"></i>Proposal and Issue tracker</a>
</li>
<li>
<a href="https://groups.google.com/forum/#!forum/sed-ml-discuss" target="_blank"><i class="fa fa-fw fa-group"></i> Discussion forum</a>
</li>
<li class="divider"></li>
<li>
<a href="mailto:[email protected]"><i class="fa fa-fw fa-envelope"></i> Email editors</a>
</li>
</ul>
</li>
</ul>
<!-- Sidebar Menu Items - These collapse to the responsive navigation menu on small screens -->
<div class="collapse navbar-collapse navbar-ex1-collapse" style="background-color: white;">
<ul class="nav navbar-nav side-nav">
<li class="active">
<a href="index.html"><i class="fa fa-fw fa-home"></i> SED-ML</a>
</li>
<!--
<li class="dropdown">
<a href="index.html" class="dropdown-toggle" data-toggle="dropdown"><i class="fa fa-fw fa-home"></i> SED-ML></a>
<ul class="dropdown-menu">
<li>
<a href="index.html#languages"><i class="fa fa-fw fa-group"></i> Language URNS</a>
</li>
<li>
<a href="index.html#formats"><i class="fa fa-fw fa-group"></i> Format URNS</a>
</li>
<li>
<a href="index.html#symbols"><i class="fa fa-fw fa-group"></i> Symbols</a>
</li>
</ul>
</li>
-->
<li>
<a href="specifications.html"><i class="fa fa-fw fa-file-code-o"></i> Specification</a>
</li>
<li>
<a href="urns.html"><i class="fa fa-fw fa-paper-plane-o"></i> URNs</a>
</li>
<li>
<a href="examples.html"><i class="fa fa-fw fa-line-chart"></i> Examples</a>
</li>
<li>
<a href="showcase.html"><i class="fa fa-fw fa-wrench"></i> Tools & Libraries</a>
</li>
<li>
<a href="publications.html"><i class="fa fa-fw fa-file-text"></i> Publications</a>
</li>
<li>
<a href="contact.html"><i class="fa fa-fw fa-envelope"></i> Contact</a>
</li>
<li>
<a href="about.html"><i class="fa fa-fw fa-group"></i> Editors</a>
</li>
<!--
<li>
<a href="notes.html"><i class="fa fa-fw fa-book"></i> Editor Notes</a>
</li>
-->
</ul>
</div>
<!-- /.navbar-collapse -->
</nav>
<div id="page-wrapper">
<div class="container-fluid">
<!-- CONTENT -->
<!-- main -->
<div class="row">
<div class="col-lg-12">
<h1 class="page-header"><i class="fa fa-fw fa-file-code-o"></i> SED-ML Specification</h1>
<p>
The SED-ML specification is the official document describing SED-ML and how tools and libraries
should implement support for SED-ML.
</p>
<table class="table table-responsive">
<tbody>
<tr>
<td><b>Latest release:</b></td>
<td>
<a href="documents/sed-ml-L1V5.pdf" target="_blank">
<span class="btn btn-success" style="font-weight: bold;">
<img alt="logo" src="images/logoSEDML_w90_t.png" height="25"/>
L1V5
<img alt="pdf" src="images/pdf.png" height="35"/>
</span>
</a>
</td>
<td></td>
</tr>
<tr>
<td>
<b>Latest draft:</b>
</td>
<!--
<td>
<a href="https://github.com/SED-ML/sed-ml/raw/master/specification/level-1-version-4/sed-ml-L1V5.pdf" target="_blank">
<span class="btn btn-warning" style="font-weight: bold;">
<img alt="logo" src="images/logoSEDML_w90_t.png" height="25"/>
L1V5 draft
<img alt="pdf" src="images/pdf.png" height="35"/>
</span>
</a>
</td>
-->
<td>The source is available from <a href="https://github.com/SED-ML/sed-ml/tree/master/specification/level-1-version-4">https://github.com/SED-ML/sed-ml/tree/master/specification/level-1-version-4</a>.<br />
Please submit changes via pull requests against the repository.<br />
If you find issues with the specification please report them at <a href="https://github.com/SED-ML/sed-ml/issues">https://github.com/SED-ML/sed-ml/issues</a>.
</td>
</tr>
</tbody>
</table>
<h2 id="sedmlProposals">Feature requests and proposals</h2>
<p>We would like to encourage you to follow the procedure below for contributing to SED-ML development. </p>
<h3>Feature requests</h3>
<p>
Feature requests are “wishes for support” by SED-ML users. They are submitted and tracked using the
<a href="https://github.com/sed-ml/sed-ml/issues" target="_blank">feature request tracker</a>. The
<a href="about.html">SED-ML editors</a> will revise these wishes at their regular meetings and start discussion on
them <a href="https://groups.google.com/forum/#!forum/sed-ml-discuss" target="_blank">sed-ml-discuss</a> if necessary.
Solutions to feature requests can be provided (independently of a feature request) by starting a new proposal item.
</p>
<h3>Proposals</h3>
<p>
Proposals are welcome at all times via <a
href="https://github.com/sed-ml/sed-ml/issues" target="_blank">GitHub
issues</a>. Proposals could be derived from a
sed-ml-discuss discussion field (for example, in response
to a feature request), or created de novo.
</p>
<ul>
<li>Together with your proposal you must provide a
sufficiently detailed description of your desired
feature, including XML examples, i.e. SED-ML files,
containing the proposed new elements in Annotation
elements. Final element and attribute names may be
decided on later (maybe even hierarchy).
</li>
<li>The editors then collect vote on whether the
outlined proposal goes in to the right direction and
should become part of SED-ML.
<ul>
<li>The proposal will be voted on by sedml-discuss
members,
</li>
<li>requiring a majority in favour to be accepted.
The vote includes yes-no-revise options.
</li>
<li>There will be no minimum requirement for the
the number of votes needed.
</li>
<li>The voting process will take place over a 3
week period.
</li>
</ul>
</li>
<li>Proposals that are rejected will not be rejected
for all time, but would need to address the reasons
for their rejection before resubmission. Resubmission
therefore requires revision of the proposal.
</li>
<li>Accepted proposals will be integrated with the
specification document by the SED-ML editors with the next release.
Prerequisites are:
<ul>
<li>at least two implementations in applications (
to demonstrate interoperability)
</li>
<li>updated examples</li>
<li>a written description of the proposal</li>
</ul>
and ideally would include:
<ul>
<li>an XML schema for the proposed extension</li>
<li>UML diagrams illustrating any new class</li>
</ul>
</li>
</ul>
<h2>All specifications</h2>
<p>
<a href="documents/sed-ml-L1V5.pdf" target="_blank">
<span class="btn btn-default" style="font-weight: bold;">
L1V5 (official specification document)
<img alt="pdf" src="images/pdf.png" height="35"/>
</span>
</a>
</p>
<p>
<a href="documents/sed-ml-L1V4.pdf" target="_blank">
<span class="btn btn-default" style="font-weight: bold;">
L1V4 (official specification document)
<img alt="pdf" src="images/pdf.png" height="35"/>
</span>
</a>
</p>
<p>
<a href="documents/sed-ml-L1V3.pdf" target="_blank">
<span class="btn btn-default" style="font-weight: bold;">
L1V3 (official specification document)
<img alt="pdf" src="images/pdf.png" height="35"/>
</span>
</a>
</p>
<p>
<a href="documents/sed-ml-L1V2.pdf" target="_blank">
<span class="btn btn-default" style="font-weight: bold;">
L1V2 (official specification document)
<img alt="pdf" src="images/pdf.png" height="35"/>
</span>
</a>
</p>
<p>
<a href="documents/sed-ml-L1V1.pdf" target="_blank">
<span class="btn btn-default" style="font-weight: bold;">
L1V1 (official specification document)
<img alt="pdf" src="images/pdf.png" height="35"/></span>
</a>
</p>
</div>
</div>
<!-- END CONTENT -->
<!-- FOOTER -->
<div class="row">
<div class="col-lg-12">
<hr/>
<p>© 2017-2021 sed-ml.org. <a href="https://github.com/SED-ML/sed-ml.github.io/issues" target="_blank">Report website issue <i class="fa fa-github fa-fw"></i></a></p>
</div>
</div>
<!-- END FOOTER -->
</div>
<!-- /.container-fluid -->
</div>
<!-- /#page-wrapper -->
</div>
<!-- /#wrapper -->
<!-- jQuery -->
<script src="js/jquery.js"></script>
<!-- Bootstrap Core JavaScript -->
<script src="js/bootstrap.min.js"></script>
<!-- Morris Charts JavaScript -->
<script src="js/plugins/morris/raphael.min.js"></script>
<script src="js/plugins/morris/morris.min.js"></script>
<script src="js/plugins/morris/morris-data.js"></script>
</body>
</html>