Easy Button Markup Language (EBML) Cheat Sheet

Lines that begin with "//" are comments, and are ignored by Stanhope.

// This is a comment
Context | This is NOT a comment!
/ This is also not a comment... it's not a valid EBML line!

Whitespace and tab characters are generally ignored before and after the pipe characters ("|"), so you can make your EBML source files visually structured to your liking.

For instance, this

Section | Prepare all procedure materials
 
	Step | Gather EGSE
		Resource | Calibrated Multimeter
 
	Step | Note the time, temperature, and humidity

...is equivalent to...

Section|Prepare all procedure materials
Step|Gather EGSE
Resource|Calibrated Multimeter
Step|Note the time, temperature, and humidity

The first one is easier to read and maintain, but both are equivalent.

Best Practices: include these lines at the top of your EBML file:

Template | CSS FILENAME FOUND IN ASSETS FOLDER
 
Title        | PROCESS TITLE
Number       | PROCESS NUMBER
Author       | PROCESS AUTHOR
Reviewer     | PROCESS REVIEWER
Process Type | CATEGORY, e.g. Test Procedure
 
Subject       | THING TO WHICH THE PROCESS APPLIES
Subject Image | FILENAME OF IMAGE OF SUBJECT
Product       | THING PRODUCED BY THIS PROCESS - optional
Product Image | FILENAME OF IMAGE OF PRODUCT - optional
 
Revision | LATEST REV NUM       | DESCRIPTION OF CHANGE
Revision | INTERMEDIATE REV NUM | DESCRIPTION OF CHANGE
Revision | FIRST REV NUM        | INITIAL DESCTIPTION
EBML You Type Style you get with Assets Starter Pack
Modify and augment as needed!
Template | ESD.css
Template | FOD.css
Template | Welding.css
Template | CleanRoom.css
Template | COMSEC.css
Template | HazOps.css
Template | PowerON.css
Template | RadioEmission.css
Template | DistributionD.css

Only one Distribution statement will be used (whichever is listed LAST). Statements A, B, C, D, and E all mimic text from here: DoDI 5230.24

↓ Once, on the title page ↓
Section | This is a Section
Section X: This is a Section
Step | First Step (empty)
Step | Second Step
Context | Words in Second Step
Step | Third Step (empty)

Must have a "Section" above it somewhere!

Step X.X: First Step (empty)
Step X.X: Second Step
Words in Second Step
Step X.X: Third Step (empty)
CSV Start | Three columns, three data rows
Header C1, Header C2, Header C3
Data R1C1, Data R1C2, Data R1C3
Data R2C1, Data R2C2, Data R2C3
Data R3C1, Data R3C2, Data R3C3
CSV End |

Must have a "Step" above it!

Three columns, three data rows
Header C1 Header C2 Header C3
Data R1C1 Data R1C2 Data R1C3
Data R2C1 Data R2C2 Data R2C3
Data R3C1 Data R3C2 Data R3C3
Objective | This is an objective line

Must have a "Step" above it!
Note: All Objective lines get summarized at the top of the document, in addition to being rendered in-place as shown at right. The summary at the top of the process happens automatically.

This is an objective line
Out of Scope | This is an Out of Scope line

Must have a "Step" above it!
Note: All Out of Scope lines get summarized at the top of the document, in addition to being rendered in-place as shown at right. The summary at the top of the process happens automatically.

This is an Out of Scope line
Command | This is a Command

Must have a "Step" above it!

This is a Command
Warning | This is a Warning

Must have a "Step" above it!

This is a Warning
Context | This is a Context

Must have a "Step" above it!

This is a Context
Image | ImageFile.ext | Caption text below

Must have a "Step" above it!


Caption text below
Resource | Wrench
Resource | That one specific laptop
Resource | Hydraulic Lift (Harbor Freight)

Must have a "Step" above it!

3 named resources are identified to perform this step:
Wrench
That one specific laptop
Hydraulic Lift (Harbor Freight)
Action | First Action | First Expectation
Action | Second Action | Second Expectation | TPV
Action | Third Action | Third Expectation

Must have a "Step" above it!

Action to perform Expected Result Done TPV
First Action First Expectation N/A
Second Action Second Expectation
Third Action Third Expectation N/A
Verification | R01 | This shall be analyzed. | A
Verification | R02 | This shall be inspected. | I
Verification | R03 | This shall be demonstrated. | D
Verification | R04 | This shall be tested. | T
Verification | R05 | This shall be sampled. | S

Must have a "Step" above it!
Note: All Verification lines get summarized at the top of the document, in addition to being rendered in-place as shown at right. The summary at the top of the process happens automatically.

This step produces the evidence of verification for this requirement:
R01: "This shall be analyzed." (Verify by Analysis)
Please ensure the evidence produced passes the requirement before proceding. This might require consulting this procedure's author, [AUTHOR].
This step produces the evidence of verification for this requirement:
R02: "This shall be inspected." (Verify by Inspection)
Please ensure the evidence produced passes the requirement before proceding. This might require consulting this procedure's author, [AUTHOR].
This step produces the evidence of verification for this requirement:
R03: "This shall be demonstrated." (Verify by Demonstration)
Please ensure the evidence produced passes the requirement before proceding. This might require consulting this procedure's author, [AUTHOR].
This step produces the evidence of verification for this requirement:
R04: "This shall be tested." (Verify by Test)
Please ensure the evidence produced passes the requirement before proceding. This might require consulting this procedure's author, [AUTHOR].
This step produces the evidence of verification for this requirement:
R05: "This shall be sampled." (Verify by Sampling)
Please ensure the evidence produced passes the requirement before proceding. This might require consulting this procedure's author, [AUTHOR].