Author: stain
Date: Thu Jun 30 16:27:41 2016
New Revision: 1750827
URL: http://svn.apache.org/viewvc?rev=1750827&view=rev
Log:
Update (somewhat) the scufl2 docs
Modified:
incubator/taverna/site/trunk/content/documentation/scufl2/api.md
incubator/taverna/site/trunk/content/documentation/scufl2/index.md
incubator/taverna/site/trunk/content/documentation/scufl2/ontology.md
Modified: incubator/taverna/site/trunk/content/documentation/scufl2/api.md
URL:
http://svn.apache.org/viewvc/incubator/taverna/site/trunk/content/documentation/scufl2/api.md?rev=1750827&r1=1750826&r2=1750827&view=diff
==============================================================================
--- incubator/taverna/site/trunk/content/documentation/scufl2/api.md (original)
+++ incubator/taverna/site/trunk/content/documentation/scufl2/api.md Thu Jun 30
16:27:41 2016
@@ -22,11 +22,23 @@ Apache Taverna Language is a library and
-See
[incubator-taverna-language](https://github.com/apache/incubator-taverna-language)'s
README for documentation for the different modules of Taverna Language.
-
-###Previous Versions
-
-For information on previous non-Apache versions of the SCUFL2 API, see the
- [myGrid pages](http://dev.mygrid.org.uk/wiki/display/developer/SCUFL2+API).
+**Apache Taverna Language** (incubating) is a Java API that gives programmatic
+access to inspecting, modifying and converting
+[SCUFL2](/documentation/scufl2/) workflow definitions and
+[Research Object Bundles](https://w3id.org/bundle).
+
+You can [download Taverna Language](/download/taverna-language) or use it
through
+Maven.
+
+## Usage and Javadoc
+
+See the [Taverna Language
+Javadoc](http://taverna.incubator.apache.org/javadoc/taverna-language/) for
+documentation of classes and methods of Taverna Language. Good starting
+points:
+ *
[org.apache.taverna.scufl2.api](http://taverna.incubator.apache.org/javadoc/taverna-language/org/apache/taverna/scufl2/api/package-summary.html)
+ *
[org.apache.taverna.robundle](http://taverna.incubator.apache.org/javadoc/taverna-language/org/apache/taverna/robundle/package-summary.html)
+ *
[org.apache.taverna.databundle](http://taverna.incubator.apache.org/javadoc/taverna-language/org/apache/taverna/databundle/package-summary.html)
+See
[incubator-taverna-language](https://github.com/apache/incubator-taverna-language)'s
README for further documentation for the different modules of Taverna Language.
Modified: incubator/taverna/site/trunk/content/documentation/scufl2/index.md
URL:
http://svn.apache.org/viewvc/incubator/taverna/site/trunk/content/documentation/scufl2/index.md?rev=1750827&r1=1750826&r2=1750827&view=diff
==============================================================================
--- incubator/taverna/site/trunk/content/documentation/scufl2/index.md
(original)
+++ incubator/taverna/site/trunk/content/documentation/scufl2/index.md Thu Jun
30 16:27:41 2016
@@ -16,55 +16,53 @@ Notice: Licensed to the Apache Softwa
specific language governing permissions and limitations
under the License.
-SCUFL2 is the new (since Taverna 3) mechanism for specifying Taverna
workflows.
-SCUFL2 defines a model, a workflow bundle file format (.wfbundle), and a Java
API for working with workflow structures.
+SCUFL2 is the new (since Taverna 3) mechanism for specifying Taverna workflows.
+SCUFL2 defines a model, a workflow bundle file format (.wfbundle), and a Java
API for working with workflow structures.
SCUFL2 is the workflow language for Taverna 3, and replaces Taverna 2's t2flow
format.
-##Summary
+## Summary
-SCUFL2 is the Taverna 3 mechanism for specifying Taverna workflows.
-SCUFL2 adopts Linked Data technology and preservation methodologies to create
a platform-independent workflow language
+SCUFL2 is the Taverna 3 mechanism for specifying Taverna workflows.
+SCUFL2 adopts Linked Data technology and preservation methodologies to create
a platform-independent workflow language
that can be inspected, modified, created and executed.
-SCUFL2 comes with a [Java API](/documentation/scufl2/api) that can be used for
programmatic access to read and write SCUFL2
- [workflow bundles](/documentation/scufl2/bundle).
-A workflow bundle is a structured ZIP file with the workflow definitions
included as XML documents.
-Those workflow documents are described by an XML Schema and are also valid
RDF/XML.
-The XML Schema allows tools to read and write SCUFL2 workflow definitions as
regular structured XML.
+SCUFL2 comes with a [Java API](/documentation/scufl2/api) that can be used for
programmatic access to read and write SCUFL2
+ [workflow bundles](/documentation/scufl2/bundle).
+
+A workflow bundle is a structured ZIP file with the workflow definitions
included as XML documents.
+Those workflow documents are described by an XML Schema and are also valid
RDF/XML.
+The XML Schema allows tools to read and write SCUFL2 workflow definitions as
regular structured XML.
The RDF allows RDF-enabled tools to link workflow definitions with external
resources.
The workflow structure is defined using an [OWL
ontology](/documentation/scufl2/ontology)
- and annotated with URIs so that third parties can form semantic statements
about any component of a Scufl2 workflow,
- for example to state that a particular service produces outputs of a
certain type,
+ and annotated with URIs so that third parties can form semantic statements
about any component of a Scufl2 workflow,
+ for example to state that a particular service produces outputs of a
certain type,
or that a data link was added by a specific researcher.
-Semantic annotations and a manifest for the bundle declare the purpose of,
- and links between the different components forming a workflow.
+Semantic annotations and a manifest for the bundle declare the purpose of,
+ and links between the different components forming a workflow.
This allows third parties to extract and append annotations about data and
services used by the workflow.
-##Motivation
+## Motivation
-The t2flow serialization format suffers from being very close to the Java
object model,
- and contains various items that are simply Java beans serialized using
*XMLBeans*.
-As the t2flow format is very verbose, it can be difficult to deal with for
third party software to do
- **inspection** ("Which services does this workflow use?"), **modification**
- ("Change all calls to *broken.com* to *fixed.com*") and **generation**
+The t2flow serialization format suffers from being very close to the Java
object model,
+ and contains various items that are simply Java beans serialized using
*XMLBeans*.
+As the t2flow format is very verbose, it can be difficult to deal with for
third party software to do
+ **inspection** ("Which services does this workflow use?"), **modification**
+ ("Change all calls to *broken.com* to *fixed.com*") and **generation**
("Build a custom workflow from a button").
-Developers have informed us that the old SCUFL format of Taverna 1 was
significantly easier to work with.
-However, this format also has its caveats, like no schema,
- unidentified ways to extend service definitions for Taverna plugins and
+Developers have informed us that the old SCUFL format of Taverna 1 was
significantly easier to work with.
+However, this format also has its caveats, like no schema,
+ unidentified ways to extend service definitions for Taverna plugins and
not supporting various new features in the Taverna 2 engine.
We have therefore decided to form a new serialisation format for workflows,
called **SCUFL2**.
-##Overview
+## Overview
SCUFL2 consists of:
- [SCUFL2 language](/documentation/scufl2/language)
- SCUFL2 [Workflow Bundle](/documentation/scufl2/bundle) format
- [SCUFL2 API](/documentation/scufl2/api) for Java
-
-
-
Modified: incubator/taverna/site/trunk/content/documentation/scufl2/ontology.md
URL:
http://svn.apache.org/viewvc/incubator/taverna/site/trunk/content/documentation/scufl2/ontology.md?rev=1750827&r1=1750826&r2=1750827&view=diff
==============================================================================
--- incubator/taverna/site/trunk/content/documentation/scufl2/ontology.md
(original)
+++ incubator/taverna/site/trunk/content/documentation/scufl2/ontology.md Thu
Jun 30 16:27:41 2016
@@ -1,4 +1,4 @@
-Title: Scufl2 Ontology
+Title: Scufl2 Ontology
Notice: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -16,4 +16,22 @@ Notice: Licensed to the Apache Softwa
specific language governing permissions and limitations
under the License.
-Details of the Scufl2 Ontology will be available here later.
\ No newline at end of file
+The [SCUFL2](.) ontology defines the terms used to describe a Taverna workflow
+within a [workflow bundle](workflow).
+
+* Namespace: `http://ns.taverna.org.uk/2010/scufl2#`
+* Formats:
[Turtle](https://taverna.incubator.apache.org/ns/2010/scufl2/scufl2.ttl),
[RDF/XML](https://taverna.incubator.apache.org/ns/2010/scufl2/scufl2.rdf)
+* [Ontology
documentation](http://www.essepuntato.it/lode/http://ns.taverna.org.uk/2010/scufl2)
+* [Ontology
source](https://github.com/apache/incubator-taverna-language/tree/master/taverna-scufl2-schemas/src/main/resources/org/apache/taverna/scufl2/rdf)
+* [Example
usage](https://github.com/apache/incubator-taverna-language/tree/master/taverna-scufl2-wfbundle/src/test/resources/org/apache/taverna/scufl2/rdfxml/example)
+
+The myGrid wiki has archived some [further documentation on
SCUFL2](http://dev.mygrid.org.uk/wiki/display/developer/Scufl2+Ontology), but
+be aware that it is _outdated_, as its examples uses an _n3_ serialization
rather than
+the current _RDF/XML_ serialization.
+
+## Extensions
+
+Taverna 2.2 features are in the namespace
`http://ns.taverna.org.uk/2010/taverna/2.2/`
+
+[Activities](/download/common-activities/) define their own namespaces for
+their SCUFL2 type and configuration properties.
