Actions vocabulary, based on 2012 discussions and final minimal draft.
authordanbri <danbri@google.com>
Thu, 10 Jan 2013 17:02:16 +0000
changeset 66 8876b2592504
parent 65 b0c4601c2bec
child 67 f1101c0c11e0
Actions vocabulary, based on 2012 discussions and final minimal draft.
schema.org/ext/action.html
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/schema.org/ext/action.html	Thu Jan 10 17:02:16 2013 +0000
@@ -0,0 +1,208 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>RDFa Lite Reflection</title>
+    <meta charset="utf-8" />
+    <style type="text/css">
+      span.h {
+        padding-left: 0px;
+        font-weight: bold;
+      }
+      span {
+        display: block;
+        padding-left: 10px;
+      }
+    </style>
+  </head>
+  <body>
+
+    <h1>Action Vocabulary</h1>
+
+    <p>See <a href="http://www.w3.org/wiki/WebSchemas/ActivityActions">wiki</a> and <a href="http://www.w3.org/wiki/images/7/79/Schema.orgActionsMinimaldraft.pdf">minimal draft doc</a> for details.</p>
+
+<h2>Types</h2>
+	
+	<!-- TODO: ul/li -->
+	
+	<div typeof="rdfs:Class" resource="http://schema.org/Action">
+      <span class="h" property="rdfs:label">Action</span>
+      <span property="rdfs:comment">An action that may be carried out by some 'performer' such as a Person or Organization.</span>
+      <span>Subclass of: <a property="rdfs:subClassOf" href="http://schema.org/Intangible">Intangible</a></span>
+    </div>
+ 
+<div typeof="rdfs:Class" resource="http://schema.org/ActionStatusValue">
+  <span class="h" property="rdfs:label">ActionStatusValue</span>
+  <span property="rdfs:comment">Enumeration of values for use with actionStatus property.</span>
+  <span>Subclass of: <a property="rdfs:subClassOf" href="http://schema.org/Enumeration">Enumeration</a></span>
+</div>
+
+<div typeof="rdfs:Class" resource="http://schema.org/ActionHandler">
+  <span class="h" property="rdfs:label">ActionHandler</span>
+  <span property="rdfs:comment">An application or service that allows an Action to be performed.</span>
+  <span>Subclass of: <a property="rdfs:subClassOf" href="http://schema.org/Intangible">Intangible</a></span>
+  <span>Notes: User Agents may invoke ActionHandlers in order to perform an action. An 
+ActionHandler is typically passed a description of the Action instance as input"</span>
+</div>
+
+<!-- This could be dropped from the core -->
+<div typeof="rdfs:Class" resource="http://schema.org/ActionType">
+  <span class="h" property="rdfs:label">ActionType</span>
+  <span property="rdfs:comment">ActionType represents those subtypes of Action that are intended to be usefully actionable according to the schema.org Action-description machinery. This allows for other subtypes of Action to be declared for other descriptive purposes.</span>
+  <span>Subclass of: <a property="rdfs:subClassOf" href="http://schema.org/Class">Class</a></span>
+<span>Notes: ActionType can be used to indicate specific sub-types of Action which are 
+designed to participate in the Action-description machinery described here. While 
+not essential, this allows other useful sub-types of Action to be defined for other 
+purposes without confusion.</span>
+</div>
+
+
+<h2>Enumerations</h2>
+
+<div>We introduce an 'actionStatus' property, which relates an Action to one of several enumerated ActionStatusValue options.</div>
+
+<ul>
+ <li>
+  <div typeof="schema:ActionStatusValue" resource="http://schema.org/PossibleAction">
+   <span class="h" property="rdfs:label">PossibleAction</span>
+   <span property="rdfs:comment">PossibleAction - The action has not been performed yet.</span>
+  </div>
+ </li>
+ <li>
+  <div typeof="schema:ActionStatusValue" resource="http://schema.org/PendingAction">
+  <span class="h" property="rdfs:label">PendingAction</span>
+  <span property="rdfs:comment">PendingAction - The action is in the process of being performed.</span>
+  </div>
+ </li>
+ <li>
+  <div typeof="schema:ActionStatusValue" resource="http://schema.org/CancelledAction">
+  <span class="h" property="rdfs:label">CancelledAction</span>
+  <span property="rdfs:comment">CancelledAction - The action was cancelled.</span>
+  </div>
+ </li>
+</ul>
+
+<h2>Other Changes</h2>
+
+<div>
+Note: 'Action' is a sibling type to '<a href="http://schema.org/Event">Event</a>', sharing some of its properties, such as 'performer' and spatial/temporal information. Applicable properties include: ‘performer’, ‘duration’, ‘startDate’, ‘endDate’ … (these would have domainIncludes amended to mention Action). <!-- TODO. -->
+</div>
+
+
+<h2>Properties</h2>
+
+    <div typeof="rdf:Property" resource="http://schema.org/actionStatus">
+      <span class="h" property="rdfs:label">actionStatus</span>
+      <span property="rdfs:comment">relates an Action to one of several enumerated ActionStatusValue</span>
+      <span>Domain: <a property="http://schema.org/domain" href="http://schema.org/Action">Action</a></span>
+      <span>Range: <a property="http://schema.org/range" href="http://schema.org/ActionStatusValue">ActionStatusValue</a></span>
+    </div>
+
+    <div typeof="rdf:Property" resource="http://schema.org/possibleAction">
+      <span class="h" property="rdfs:label">possibleAction</span>
+      <span property="rdfs:comment">An action that might be performed with this Thing.</span>
+      <span>Domain: <a property="http://schema.org/domain" href="http://schema.org/Thing">Thing</a></span>
+      <span>Range: <a property="http://schema.org/range" href="http://schema.org/Action">Action.</a></span>
+    </div>
+
+<!-- todo: Optionally, we introduce a parallel property “eventStatus”, Enumeration type, 
+EventStatusValue ... -->
+
+    <div typeof="rdf:Property" resource="http://schema.org/possibleActionType">
+      <span class="h" property="rdfs:label">possibleActionType</span>
+      <span property="rdfs:comment">A (sub)type of Action that might be performed with this type of Thing.</span>
+      <span>Domain: <a property="http://schema.org/domain" href="http://schema.org/Class">Class</a></span>
+      <span>Range: <a property="http://schema.org/range" href="http://schema.org/ActionType">ActionType</a></span>
+    </div>
+
+    <div typeof="rdf:Property" resource="http://schema.org/handler">
+      <span class="h" property="rdfs:label">handler</span>
+      <span property="rdfs:comment">Associates a specific Action instance with a specific ActionHandler.</span>
+      <span>Domain: <a property="http://schema.org/domain" href="http://schema.org/Action">Action</a></span>
+      <span>Range: <a property="http://schema.org/range" href="http://schema.org/ActionHandler">ActionHandler</a></span>
+    </div>
+
+
+    <div typeof="rdf:Property" resource="http://schema.org/optionalProperty">
+      <span class="h" property="rdfs:label">optionalProperty</span>
+      <span property="rdfs:comment">Property that can be specified on the Action that the handler supports.</span>
+      <span>Domain: <a property="http://schema.org/domain" href="http://schema.org/Action">Action</a></span>
+      <span>Range: <a property="http://schema.org/range" href="http://schema.org/Property">Property</a></span>
+    </div>
+
+
+    <div typeof="rdf:Property" resource="http://schema.org/requiredProperty">
+      <span class="h" property="rdfs:label">requiredProperty</span>
+      <span property="rdfs:comment">Property that must be given in an Action description, for it to be handled by its ActionHandler.</span>
+      <span>Domain: <a property="http://schema.org/domain" href="http://schema.org/Action">Action</a></span>
+      <span>Range: <a property="http://schema.org/range" href="http://schema.org/Property">Property</a></span>
+    </div>
+
+    <div typeof="rdf:Property" resource="http://schema.org/handledActionType">
+      <span class="h" property="rdfs:label">handledActionType</span>
+      <span property="rdfs:comment">Indicates the general type(s) of action that some handler can accept. (previous draft called this 'actionType').</span>
+      <span>Domain: <a property="http://schema.org/domain" href="http://schema.org/ActionHandler">ActionHandler</a></span>
+      <span>Range: <a property="http://schema.org/range" href="http://schema.org/ActionType">ActionType</a></span>
+    </div>
+
+<h2>Specific Handler types</h2>
+
+<div typeof="rdfs:Class" resource="http://schema.org/WebActionHandler">
+  <span class="h" property="rdfs:label">WebActionHandler</span>
+  <span property="rdfs:comment">Any action which can be carried out by simply following an url (property of the Action) is handled by a WebActionHandler".</span>
+  <span>Subclass of: <a property="rdfs:subClassOf" href="http://schema.org/ActionHandler">ActionHandler</a></span>
+</div>
+
+<div typeof="rdfs:Class" resource="http://schema.org/HTTPActionHandler">
+  <span class="h" property="rdfs:label">HTTPActionHandler</span>
+  <span property="rdfs:comment">Any action which can be carried out by simple HTTP transaction.</span>
+  <span>Subclass of: <a property="rdfs:subClassOf" href="http://schema.org/ActionHandler">ActionHandler</a></span>
+</div>
+
+<!-- todo: detail here? more properties over time...
+HTTPActionHandler, with properties ‘url’ (inherited from Thing), ‘method’, 
+‘encoding’, ‘authorization’. We introduce a type ‘HTTPRequestMethod’ as a sub-type of  Enumeration. We enumerate two instances of it: HTTPGET, HTTPPOST. -->
+
+<h2>Example Action Schemas</h2>
+
+<p>A few example Action types are provided as built-ins; others can be modeled in the same style.</p>
+
+<ul>
+ <li>
+  <div typeof="rdfs:Class schema:ActionType" resource="http://schema.org/AcceptAction">
+   <span class="h" property="rdfs:label">AcceptAction</span>
+   <span property="rdfs:comment">Action for confirming something, e.g. an invitation, an offer.</span>
+   <span>Subclass of: <a property="rdfs:subClassOf" href="http://schema.org/Action">Action</a></span>
+  </div>
+  <div typeof="rdf:Property" resource="http://schema.org/accepted">
+    <span class="h" property="rdfs:label">accepted</span>
+    <span property="rdfs:comment">The thing that is accepted in an AcceptAction.</span>
+    <span>Domain: <a property="http://schema.org/domain" href="http://schema.org/AcceptAction">AcceptAction</a></span>
+    <span>Range: <a property="http://schema.org/range" href="http://schema.org/Thing">Thing.</a></span>
+  </div>
+ </li>
+
+ <li>
+  <div typeof="rdfs:Class schema:ActionType" resource="http://schema.org/AddAction">
+   <span class="h" property="rdfs:label">AddAction</span>
+   <span property="rdfs:comment">Action for confirming something, e.g. an invitation, an offer.</span>
+   <span>Subclass of: <a property="rdfs:subClassOf" href="http://schema.org/Action">Action</a></span>
+  </div>
+  <div typeof="rdf:Property" resource="http://schema.org/added">
+    <span class="h" property="rdfs:label">added</span>
+    <span property="rdfs:comment">The thing that is added in an AddAction.</span>
+    <span>Domain: <a property="http://schema.org/domain" href="http://schema.org/AddAction">AddAction</a></span>
+    <span>Range: <a property="http://schema.org/range" href="http://schema.org/Thing">Thing.</a></span>
+  </div>
+ </li>
+</ul>
+
+<div>More Action types can be added later.</div>
+
+
+<br/>
+<br/>
+<br/>
+<br/>
+
+  </body>
+</html>