Author: rwesten
Date: Mon Feb 28 21:52:04 2011
New Revision: 1075557
URL: http://svn.apache.org/viewvc?rev=1075557&view=rev
Log:
changed all '<' to < outside of code segments
Modified:
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/stanbolenhancementstructure.mdtext
Modified:
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/stanbolenhancementstructure.mdtext
URL:
http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/stanbolenhancementstructure.mdtext?rev=1075557&r1=1075556&r2=1075557&view=diff
==============================================================================
---
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/stanbolenhancementstructure.mdtext
(original)
+++
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/stanbolenhancementstructure.mdtext
Mon Feb 28 21:52:04 2011
@@ -46,21 +46,21 @@ All the namespace prefixes used within t
Notations used by this specification:
-* **<{code}>** elements do refer to an instance identified by the URI {code}.
To improve the readability {codes} that refer to instances of concepts defined
by the Stanbol enhancement structure will use short forms (<ci> for a
ContentItem instance, <a> for anAnnotation instance ...).
-* **{prefix}:{localname}** is used as short form for <{namespace+localname}>.
The namespace -> prefix mappings are defined in the above list
+* **<{code}>** elements do refer to an instance identified by the URI
{code}. To improve the readability {codes} that refer to instances of concepts
defined by the Stanbol enhancement structure will use short forms (<ci> for
a ContentItem instance, <a> for anAnnotation instance ...).
+* **{prefix}:{localname}** is used as short form for
<{namespace+localname}>. The namespace -> prefix mappings are defined in the
above list
* **{value}^^dataType** The (xsd) dataType required by the value e.g.
xsd:float, xsd:anyUri, The default is xsd:string
* **?{var}** represent a resource that is unknown by the Stanbol Enhancer.
Usually a resource of the Users knowledge model that is not necessarily parsed
to the Stanbol
* **[{statement}]** represent statements that are typically used in
combination with the Stanbol Enhancement Structure but not required nor used by
the enhancement process itself.
-A special NOTE to the usage of <{code}> in comairism to {value}^^xsd:anyURI:
+A special NOTE to the usage of <{code}> in comairism to {value}^^xsd:anyURI:
* In both cases the value will be an URI
-* In case of <{code}> the URI identifies a resource that is created/defined by
the enhancement results - meaning that the returned knowledge contains all
information about that resource
+* In case of <{code}> the URI identifies a resource that is created/defined
by the enhancement results - meaning that the returned knowledge contains all
information about that resource
* {value}^^xsd:anyURI indicates that enhancement results will not provide
additional knowledge about this resource. If the consumer needs more
information about such resources he need to use other services to retrieve such
knowledge or parse special parameters to tell Stanbol to explicitly include
such knowledge in the response.
-### ContentItem <ci>
+### ContentItem <ci>
-The ContentItem <ci> represents a content enhanced by the Stanbol Enhancer. It
is the central resource used to link all the enhancements created by the
EnhancementEngines.
+The ContentItem <ci> represents a content enhanced by the Stanbol Enhancer.
It is the central resource used to link all the enhancements created by the
EnhancementEngines.
The Stanbol Enhancement Structure does not force client to distinguish between
content (data) and contentItem (interpretation of the data). Within the Stanbol
Enhancer only the contentItem is needed, because the Content is accessed via
the Java API. Client are free to use markup to explicitly identify these parts
of documents that need to be interpreted as content (e.g. an element in the DOM
tree). An example is provided below.
<ci> rdf:type sb:ContentItem
@@ -68,7 +68,7 @@ The Stanbol Enhancement Structure does n
[<ci> <{metadatafield}> {value(s)}]
[?parent sioc:content <ci>]
-The ContentItem itself does not define any properties however it is used as
domain (target type) of some properties within the Stanbol Enhancement
structure. Information extracted from metadata parsed with the content (e.g.
Dublin Core, EXIF, ID3 ...) can be added directly to the ContentItem <ci>.
+The ContentItem itself does not define any properties however it is used as
domain (target type) of some properties within the Stanbol Enhancement
structure. Information extracted from metadata parsed with the content (e.g.
Dublin Core, EXIF, ID3 ...) can be added directly to the ContentItem <ci>.
*TODO:* Describe here how to deal with embedded knowledge (e.g. RDFa,
MicroFormats â¦). Last time the discussion was to write such knowledge into an
own Graph and do not add it to the returned Enhancement Structure. However this
was only an suggestion and need to be reviewed.
@@ -110,8 +110,8 @@ The following code segments shows the kn
<e> dc:relation <relatedEnhancement>
<e> dc:requires <dependsOnEnhancement>
-The presence of the statement "<e> rdf:type sd:Enhancement" statement
indicated that enhancement metadata are present for the resource <e>. This also
means that if there is some configuration set to exclude such information, than
all the above properties MUST be removed from the results of the enhancement
process.
-The optional rdf:types sb:Annotation and sb:Occurrent do only indicate, that
typically any enhancement resource <e> is also of type sb:Annotation and/or
sb:Occurrent. See the according sections and the usage examples for more
information.
+The presence of the statement "<e> rdf:type sd:Enhancement" statement
indicated that enhancement metadata are present for the resource <e>. This
also means that if there is some configuration set to exclude such information,
than all the above properties MUST be removed from the results of the
enhancement process.
+The optional rdf:types sb:Annotation and sb:Occurrent do only indicate, that
typically any enhancement resource <e> is also of type sb:Annotation and/or
sb:Occurrent. See the according sections and the usage examples for more
information.
All of the metadata used to describe the enhancement process do use the
DCterms vocabulary.
@@ -124,7 +124,7 @@ All of the metadata used to describe the
### Annotations
The concept "Annotation" provides metadata about the extracted feature. This
information are important both for the enhancement process and the users of the
Stanbol Enhancer.
-The following code segment shows the knowledge typically provided by an
Annotation <a>. A description of the properties is provided below:
+The following code segment shows the knowledge typically provided by an
Annotation <a>. A description of the properties is provided below:
<a> rdf:type sb:Annotation
[<a> rdf:type sb:Enhancement, sb:Occurrence]
@@ -137,7 +137,7 @@ The following code segment shows the kno
<a> sb:entity-type entityType^^xsd:anyURI
<a> sb:suggestion <a1>
-The following properties are defined for Annotations <a>
+The following properties are defined for Annotations <a>
* **rdf:type sb:Annotation**: This states that someone can expect the resource
to provide all the information as defined by this specification
* **sb:extracted-from**: This links the annotation describing an feature with
the content item this feature is extracted from.
