Jump to: navigation, search

Difference between revisions of "Help:Info/Activity"

 
(19 intermediate revisions by the same user not shown)
Line 11: Line 11:
 
<table>
 
<table>
 
<tr>
 
<tr>
−
<td>'''Purpose'''
+
<td>'''Purpose:'''
 
</td>
 
</td>
 
<td>
 
<td>
 
Articles created here have to describe an {{UBIK}} workflow activity and its usage within an {{UBIK}} workflow.
 
Articles created here have to describe an {{UBIK}} workflow activity and its usage within an {{UBIK}} workflow.
 +
</td>
 +
</tr>
 +
<tr>
 +
<td style="vertical-align:top">'''Name:'''
 +
</td>
 +
<td>''<ActivityName>'' (Activity)
 +
</td>
 +
</tr>
 +
<tr>
 +
<td>'''Categories:'''
 +
</td>
 +
<td>
 +
The category [[:Category:Activities]] is automatically set via the template. Add additional categories related to the purpose of the activity, browse the [[Site map]] for more categories.
 +
</td>
 +
</tr>
 +
<tr>
 +
<td style="vertical-align:top">'''Structure:'''
 +
</td>
 +
<td>'''DO NOT''' use <nowiki>==</nowiki> headings within a tab section, start leveling by using <nowiki>===</nowiki> sections.<br />
 +
Tab ''Description'': describes the '''Arguments''' and '''Usage''' of the activity within a workflow<br />
 +
Tab ''Example'': shows an actual example how the activity is used within a workflow and/or valid values of the arguments
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
−
 
−
 
−
:
 
−
<br />
 
−
'''Categories''': The category [[Category:Activities]] is automatically set via the template. Add additional categories related to the purpose of the activity, browse the [[Site map]] for more categories.
 
−
<br />
 
−
'''Structure''':
 
−
* The article should consist of a two main sections:
 
−
** ''Description'': describes the '''Arguments''' and '''Usage''' of the activity within a workflow
 
−
** ''Example'': shows an actual example how the activity is used within a workflow and/or valid values of the arguments
 
−
* The article should always be named as ''<ActivityName>'' (Activity)
 
−
*
 
−
 
−
 
 
</td>
 
</td>
 
</tr>
 
</tr>
Line 40: Line 47:
 
<!-- ROW GUIDELINE -->
 
<!-- ROW GUIDELINE -->
 
</table>
 
</table>
−
 
−
 
−
{| class="wikitable"
 
−
|-
 
−
! Description !! Value !! Example
 
−
|-
 
−
| Article name || <Name of activity> (Activity)|| WriteLogEntry (Activity)
 
−
|-
 
−
| Example || Example || Example
 
−
|-
 
−
| Example || Example || Example
 
−
|}
 
−
 
−
 
−
* Tab ''Description''
 
−
** Arguments
 
−
** Usage
 
−
* Tab ''Example''
 

Latest revision as of 09:20, 7 May 2015

Activity article wizard

Purpose:

Articles created here have to describe an UBIK® workflow activity and its usage within an UBIK® workflow.

Name: <ActivityName> (Activity)
Categories:

The category Activities is automatically set via the template. Add additional categories related to the purpose of the activity, browse the Site map for more categories.

Structure: DO NOT use == headings within a tab section, start leveling by using === sections.

Tab Description: describes the Arguments and Usage of the activity within a workflow
Tab Example: shows an actual example how the activity is used within a workflow and/or valid values of the arguments

Retrieved from "https://wiki.augmensys.com/index.php?title=Help:Info/Activity&oldid=14960"