Enum SubStep

pub enum SubStep {
    Objective(String),
    OutOfScope(String),
    ActionSequence(Vec<Action>),
    Command(String),
    Image(String, String),
    Warning(String),
    Verification(Requirement),
    Resource(Resource),
    Context(String),
    Table(Table),
}

Each row within a step contributes to a SubStep. Some SubStep types (e.g. ActionSequence) contain information from multiple consecutive rows, whereas others (all others?) contain information from a single markup file row.

Variants

Objective(String)

Each objective of the process achieved in this step has a single SubStep of type Objective, simply passing through the string found

OutOfScope(String)

Each out-of-scope declaration tells what this procedure doesn’t do, and should tell where in the process library such scope can be found

ActionSequence(Vec<Action>)

Each element of the ActionSequence vector is the information from a single Action row. Consecutive Action rows in a markup file are bundled into the ActionSequence type of SubStep.

Command(String)

Each command row has a String that is verbatim what the operator should type (or paste) into a computer system

Image(String, String)

Each Image row has a file name of an image to display on screen (first tuple String) and the caption text to display under the image (second tuple String)

Warning(String)

Warning text is something the author wants to force the operator to read prior to proceeding

Verification(Requirement)

Each Verification row includes sufficient information to form a Verification struct

Resource(Resource)

Each Resource row has a String describing a single resource needed to perform the current step

Context(String)

Vanilla text blocks, to be used sparingly lest the process document get too wordy

Table(Table)

Arbitrary-sized table from comma-separated data