Module write_html

Write a single HTML file from a single EBML file input

Some assumptions are made:

• Common HTML assets (CSS, template images) are in a folder ../assets/
• Cross-crate knowledge of the Process struct is required

A single public function performs this HTML writing task, which calls private functions to write their portions of the HTML file.

Functions

compose_bottom_of_html_file 🔒

Close html

compose_html_body 🔒

Body portion, which is the bulk of the HTML file. The composition is broken up into other sequential functions:

compose_html_body_end_of_sections_and_banners 🔒

Close out the sections, and include the process document’s header and footer banners

compose_html_body_rev_req_page 🔒

Revisions and Requirements pages

compose_html_body_section 🔒

Write every Section in the Process, sequentially. Include Steps within Sections and SubSteps within Steps.

compose_html_body_section_step_action_sequence 🔒

Print ActionSequence type SubStep

compose_html_body_section_step_command 🔒

Print Command type SubStep

compose_html_body_section_step_context 🔒

Print Context type SubStep

compose_html_body_section_step_image 🔒

Print Image type SubStep

compose_html_body_section_step_objective 🔒

Print Objective type SubStep

compose_html_body_section_step_out_of_scope 🔒

Print Out of Scope type SubStep

compose_html_body_section_step_table 🔒

Print an arbitrary table in its own div element, based on the contents of a “Table” struct (including a caption)

compose_html_body_section_step_verification 🔒

Print Verification type SubStep

compose_html_body_section_step_warning 🔒

Print Warning type SubStep

compose_html_body_title_page 🔒

The Title Page

compose_html_body_toc 🔒

Table of Contents page, and the Subject/Product Resources page…

compose_html_head 🔒

Head portion, which references external style files, stored in the Process struct at “Templates”

compose_top_of_html_file 🔒

Basic doctype declaration and html opening

generate_complete_html

Single public function that writes out a specially-formatted HTML file “filename” according to the data stored in the Process struct “p”