incubator-hise-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From r.@apache.org
Subject svn commit: r983238 - in /incubator/hise/trunk/hise-docs/src/main/resources: deadline.xml notifications.xml task-properties.xml
Date Sat, 07 Aug 2010 15:02:43 GMT
Author: rr
Date: Sat Aug  7 15:02:43 2010
New Revision: 983238

URL: http://svn.apache.org/viewvc?rev=983238&view=rev
Log:
HISE-65: Documentation (thanks to Michał Więcław)

Modified:
    incubator/hise/trunk/hise-docs/src/main/resources/deadline.xml
    incubator/hise/trunk/hise-docs/src/main/resources/notifications.xml
    incubator/hise/trunk/hise-docs/src/main/resources/task-properties.xml

Modified: incubator/hise/trunk/hise-docs/src/main/resources/deadline.xml
URL: http://svn.apache.org/viewvc/incubator/hise/trunk/hise-docs/src/main/resources/deadline.xml?rev=983238&r1=983237&r2=983238&view=diff
==============================================================================
--- incubator/hise/trunk/hise-docs/src/main/resources/deadline.xml (original)
+++ incubator/hise/trunk/hise-docs/src/main/resources/deadline.xml Sat Aug  7 15:02:43 2010
@@ -28,20 +28,20 @@ obsolete and are removed.</para>
 	   <![CDATA[
 		<htd:deadlines>
 	    	  
-		    <htd:startDeadline>*
-    		        <htd:documentation xml:lang="xsd:language"?>*
+		    <htd:startDeadline>
+    		        <htd:documentation xml:lang="xsd:language">
       			    Text
     		        </htd:documentation>
     		
-			( <htd:for expressionLanguage="anyURI"?>
+			( <htd:for expressionLanguage="anyURI">
         		      duration-expression
 			  </htd:for>
-			| <htd:until expressionLanguage="anyURI"?>
+			| <htd:until expressionLanguage="anyURI">
 			      deadline-expression
  			  </htd:until>
 			)
     		
-			<htd:escalation name="NCName">*
+			<htd:escalation name="NCName">
       				...
 			</htd:escalation>
   
@@ -62,7 +62,7 @@ obsolete and are removed.</para>
 	   <para>Escalations is a definition of actions to be executed if a task's status
is not reached within a certain time. An escalation must specify exactly one escalation action
( notification or reassignment). In one deadline could be defined many escalations. 
 		<programlisting>
 	  	 <![CDATA[
-			<htd:escalation name="NCName">*
+			<htd:escalation name="NCName">
       				...
 			</htd:escalation>
 		]]>
@@ -84,7 +84,7 @@ The escalatino definition may contain:
 
 		<programlisting>
 	  	 <![CDATA[
-			<htd:condition expressionLanguage="anyURI"?>?
+			<htd:condition expressionLanguage="anyURI">
   				boolean-expression
 			</htd:condition>
 		]]>
@@ -100,12 +100,12 @@ If not, then the toPart elements are use
 		<programlisting>
 	  	 <![CDATA[
 			<!-- notification specified by reference -->
-			<htd:localNotification reference="QName">?
-  			  <htd:priority expressionLanguage="anyURI"?>?
+			<htd:localNotification reference="QName">
+  			  <htd:priority expressionLanguage="anyURI">
     			  	integer-expression
   			  </htd:priority>
 
-  			  <htd:peopleAssignments>?
+  			  <htd:peopleAssignments>
     			      <htd:recipients>
       				...
    			      </htd:recipients>
@@ -115,7 +115,7 @@ If not, then the toPart elements are use
             		...
             
 			<!-- notification specified inline -->
-			<htd:notification name="NCName">?
+			<htd:notification name="NCName">
   				...
 			</htd:notification>
 		]]>
@@ -129,8 +129,8 @@ If not, then the toPart elements are use
 
 		<programlisting>
 	  	 <![CDATA[
-			<htd:toParts>?
-  			    <htd:toPart part="NCName" expressionLanguage="anyURI"?>
+			<htd:toParts>
+  			    <htd:toPart part="NCName" expressionLanguage="anyURI">
     				expression
   			    </htd:toPart>
    				...
@@ -149,7 +149,7 @@ Ready after reassignment.
 
 		<programlisting>
 	  	 <![CDATA[
-			<htd:reassignment>?
+			<htd:reassignment>
   			    <htd:potentialOwners>
      				...
   			    </htd:potentialOwners>

Modified: incubator/hise/trunk/hise-docs/src/main/resources/notifications.xml
URL: http://svn.apache.org/viewvc/incubator/hise/trunk/hise-docs/src/main/resources/notifications.xml?rev=983238&r1=983237&r2=983238&view=diff
==============================================================================
--- incubator/hise/trunk/hise-docs/src/main/resources/notifications.xml (original)
+++ incubator/hise/trunk/hise-docs/src/main/resources/notifications.xml Sat Aug  7 15:02:43
2010
@@ -4,7 +4,7 @@
     </para>
 
     <para>Notifications are simple human interactions that do not block the progress
of the
-caller, that is the caller does not wait for the notification to be completed. The notification
appears on the task list of all notification recipients. They may have multiple recipients
and business administators. The generic human roles task initiator, task stakeholders, potential
+caller, that is the caller does not wait for the notification to be completed. The notification
appears on the task list of all notification recipients. Notifications may have multiple recipients
and business administators. The generic human roles task initiator, task stakeholders, potential
 owners, actual owner and excluded owners play no role. Notifications do not have ad-hoc attachments,
comments or deadlines.
     </para>
 	
@@ -14,7 +14,7 @@ owners, actual owner and excluded owners
 	<htd:notification name="NCName">
 
   	  <htd:interface portType="QName" operation="NCName"/>
-    	  <htd:priority expressionLanguage="anyURI"?>?
+    	  <htd:priority expressionLanguage="anyURI">
     	       integer-expression
     	  </htd:priority>
   
@@ -22,7 +22,7 @@ owners, actual owner and excluded owners
     	     <htd:recipients>
       		...
     	     </htd:recipients>
-             <htd:businessAdministrators>?
+             <htd:businessAdministrators>
       		...
     	     </htd:businessAdministrators>
   	  </htd:peopleAssignments>
@@ -31,7 +31,7 @@ owners, actual owner and excluded owners
     		...
   	  </htd:presentationElements>
   
-	  <htd:renderings>?
+	  <htd:renderings>
     		...
           </htd:renderings>
 	</htd:notification>
@@ -45,12 +45,11 @@ owners, actual owner and excluded owners
 
 	<para>The following attributes and elements are defined for notifications:
 	<itemizedlist>
-	     <listitem>name</listitem>
-	     <listitem>interface</listitem>
-	     <listitem>priority</listitem>
-	     <listitem>peopleAssignments</listitem>
-	     <listitem>presentationElements</listitem>
-	     <listitem>rendering</listitem>
+	     <listitem><link linkend="task_name">name</link></listitem>
+	     <listitem><link linkend="task_priority">priority</link></listitem>
+	     <listitem><link linkend="task_peopleAssignments">peopleAssignments</link></listitem>
+	     <listitem><link linkend="presentationElements">presentationElements</link></listitem>
+	     <listitem><link linkend="rendering">rendering</link></listitem>
 	</itemizedlist>
 	</para>
 

Modified: incubator/hise/trunk/hise-docs/src/main/resources/task-properties.xml
URL: http://svn.apache.org/viewvc/incubator/hise/trunk/hise-docs/src/main/resources/task-properties.xml?rev=983238&r1=983237&r2=983238&view=diff
==============================================================================
--- incubator/hise/trunk/hise-docs/src/main/resources/task-properties.xml (original)
+++ incubator/hise/trunk/hise-docs/src/main/resources/task-properties.xml Sat Aug  7 15:02:43
2010
@@ -4,13 +4,13 @@
 	<para>The fallowing basic attributs are defined for tasks:
 
 	<sect2>
-	     <title>name</title>
+	     <title><para id='task_name'>name</para></title>
              <para>This attribute is mandatory. It is used to specity the name of the
task. 
 		The name, combined with namespace create a unique identifier the task definition.
 	     </para>
         </sect2>
 	<sect2>  
-	     <title>priority</title>
+	     <title><para id='task_priority'>priority</para></title>
              <para>This element is used to specify the priority of the task. It is
an
 		optional element which value is an integer expression. If not present, the priority of
the 			task is set to 0 what is the highest priority. Larger numbers identify lower priorites.
              </para>
@@ -28,7 +28,7 @@
              </para>
         </sect2>
 	<sect2>
-	     <title>peopleAssignments</title>
+	     <title><para id='task_peopleAssignments'>peopleAssignments</para></title>
 	     <para> It is used to assign people and group of people to different generic human
role. 
 		This element is mandatory and is defined by &quot;Using Literals&quot; 
 		or &quot;Logical people groups&quot;.



Mime
View raw message