Procedure:Mark up SOP

From OpenVCE

This procedure can be used to mark up an informal description of an SOP with special tags. The aim of marking up an SOP is to facilitate automated processing of the SOP and formally relating it to other SOPs.

Subtask: Insert objective

The {{#objective:...}} tag can be used to define the objective accomplished by the procedure. If the SOP does not contain an explicit objective, the objective is implicitly defined by the name of the procedure, i.e. the name and the objective of the SOP are the identical, namely the title of the article. A method must not contain more than one objective tag.

For example, the objective of this SOP could be defined to be "Mark up SOP" specified by adding the tag {{#objective:Mark up SOP}}. However, since this is also the name of this SOP, no objective tag is required.

If another SOP specifies a subtask that is the same as the objective of this procedure, then this other SOP can be used to accomplish that subtask and thereby constitute part of the implementation of the this procedure. A procedure is recursive if its own objective also appears as a subtask.

For example, this SOP (Procedure:Mark up SOP) can be used to accomplish the final subtask of the SOP Procedure:Write new SOP.

Subtask: Insert subtasks

The {{#subtask:...}} tag defines the subtasks that need to be accomplished when this procedure is implemented. Subtasks must be specified in the order in which they are to be accomplished, i.e. there is currently no partial ordering of subtasks. The number of subtasks attached to a procedure is not limited.

For example, this SOP lists two subtasks specified by the tags:

• {{#subtask:Insert objective}}
• {{#subtask:Insert subtasks}}

Note that there are currently no SOPs defined for any of these tasks, but it would be easy enough to extend the library of SOPs by creating an article that has one of the above subtasks as its objective.