Jump to content

Template:TissueDB Simulator Layout

From Appropedia
Template documentationedit documentation

This template creates TissueDB Simulator build pages. It generates the complete page structure for documenting how to construct a medical training simulator from locally available materials. It is part of the TissueDB project.

Simulator build pages document construction only — how to physically build the simulator. Usage instructions, learning objectives, assessment criteria, and teaching guides belong in separate SELF Module pages, not here.

When to Use This Template

[edit source]

Use this template for all new simulator pages. Older pages using the original TissueDB Simulator template will be migrated to this Layout template over time.

General Information Table

[edit source]

The General Information table follows the SELF Developer Playbook (January 2026, Section 9.2). The canonical fields are:

Field Source Notes
General Information Playbook 9.2 Free-text overview of the simulator
Features and Basic Operation Playbook 9.2 What the simulator can do; what procedures it supports
Current Development Status Playbook 9.2, DM-0401-04 Must use the 4-tier staging vocabulary: "Gen AI only" (GenAI-generated, no human validation), "First pass engineering" (built by engineering team, not yet clinically reviewed), "First pass clinical" (reviewed by clinical team, not yet study-validated), or "Validated" (study-backed with published paper containing construction and results)
Estimated Build Time and Cost Playbook 9.2 Combined field. Use "Not specified in source documentation" when unknown
Specialized Tools and Equipment Playbook 9.2 List any tools beyond basic household items. Use "None" if none required
Version Playbook 9.2 Current version only. Do not include version history
Development Team Contact Information Playbook 9.2 Team name and/or contact details

Do not add fields that are not in this list. If source documentation includes extra information (e.g. difficulty level, clinical setting), place it in the General Information free-text field rather than creating a new table row.

Required Parameters

[edit source]
Parameter Description Source
procedure Clinical procedure this simulator trains (e.g. "Wound packing and management") Playbook
lead_paragraph Introduction paragraph describing the simulator, its origin, and purpose Playbook
build_time Estimated construction time (e.g. "3–5 hours"). Renders on its own line whenever supplied; it may be given alongside cost and build_time_cost Playbook 9.2
cost Estimated materials cost (e.g. "Under $5 USD"). Renders on its own line whenever supplied; it may be given alongside build_time and build_time_cost Playbook 9.2
tissues_rows HTML table rows (<tr>) for the Tissues table. See Tissues Table section below Playbook p.51
structural_parts_rows HTML table rows for the Structural Parts table. See Structural Parts section below Playbook p.51
build_instructions Complete build instructions using === Phase === subsections with numbered steps Playbook p.51–52

Pages missing required parameters are automatically categorised under Category:TissueDB Pages Missing Required Parameters (Platform convention).

Optional Parameters

[edit source]
Parameter Description Source
hero_image Filename only (no File: prefix). Should show the complete, assembled simulator ready for use Convention
hero_image_size Image width (default: 350px) Platform
hero_image_alt Alt text for accessibility Platform
hero_image_caption Caption displayed below the image Convention
general_info Content for the General Information row in the table Playbook 9.2
features Features and Basic Operation row content Playbook 9.2
dev_status Current Development Status. Must use 4-tier vocabulary: "Gen AI only", "First pass engineering", "First pass clinical", or "Validated" (DM-0401-04). See General Information Table section for definitions Playbook 9.2
build_time_cost Combined build time and cost. Not an alternative to the separate fields — all three are additive and each renders on its own line, cost first. Most pages supply both this and build_time Playbook 9.2
specialized_tools Specialized Tools and Equipment row content Playbook 9.2
version Version identifier Playbook 9.2
development_team Development Team Contact Information row content Playbook 9.2
build_intro_image Image markup to display at the top of Build Instructions Convention
references References section content with <ref> tags Convention
alternative_names Comma-separated synonyms (passed to simulator data template) Convention

Tissues Table

[edit source]

The Tissues table contains only items that simulate named anatomical tissues. Each row represents a tissue that a surgeon would encounter during the clinical procedure.

Column structure (Playbook p.51):

Column Content Rules
Tissue Name of the anatomical tissue being simulated Must link to the corresponding [[TissueDB/Tissues/Name|Display]] page
Qty Quantity with dimensions and cut sizes where applicable Playbook p.51: quantity, dimensions, cut sizes required
Material The simulation material used Must link to [[TissueDB/Materials/Name|Display]] where a materials page exists
Cost Approximate cost per build Research-based estimates only; do not fabricate
Notes Preparation tips from source documentation Source-traced content only. No fidelity ratings (e.g. "Visual: Partial") in this column

Classification test: "Does this item simulate a specific named anatomical tissue that a surgeon would encounter during the procedure?" If yes → Tissues table. If no → Structural Parts table.

Row format: Use HTML <tr><td> rows. The template provides the table headers automatically.

Structural Parts Table

[edit source]

The Structural Parts table contains structural, filling, assembly, and fixation items — materials that provide physical support but do not simulate named anatomical tissues.

Same column structure as Tissues (Part Name, Qty, Material, Cost, Notes) but:

  • Part names are plain text (no wiki links) — structural parts do not get pages
  • Items serving filling functions (e.g. cotton stuffing for organ bulk) belong here, not in Tissues
  • Items serving assembly functions (e.g. suture material for construction, rubber bands) belong here

Build Instructions

[edit source]

Build instructions follow the verb-first format with verification checkpoints (Playbook p.51–52).

Structure:

  • Use === Phase N: Description === subsections for distinct construction phases
  • Use === Variant N: Description === when the simulator has alternative build methods (not sequential phases)
  • Number each step: '''Step 1.''' Action description.
  • Include specific measurements, times, and temperatures from the source documentation
  • Do not estimate or fabricate values that are not in the source

Content boundary: Build instructions describe construction only. Do not include:

  • How to use the simulator for training (→ SELF Module)
  • Learning objectives or competencies (→ SELF Module)
  • Assessment criteria or checklists (→ SELF Module)
  • Setup, positioning, or reset procedures (→ SELF Module)

Video references: YouTube or other video links should be placed as external links within the relevant build section, not as template calls. Example: '''Assembly video:''' [https://youtu.be/XXXXX Watch the guide]

What NOT to Include

[edit source]

The following sections are not permitted on simulator build pages:

  • "Features and Basic Operation" as a standalone section (content goes in the General Information table)
  • "Avoid Antiskills" unless every warning is traceable to published literature or expert review
  • "Quality Verification" / "Validation Status" unless traceable to source documentation with page numbers
  • "Version History" or "Development History" (current version only)
  • Quick Start, Getting Started, or usage/operation guides (→ SELF Module)

Measurement Units

[edit source]

Simulator pages retain the original units from their source documentation and add metric equivalents where necessary. This differs from Materials and Tissues pages, which use metric-first format.

Example

[edit source]
{{TissueDB Simulator Layout
| procedure = Example surgical procedure
| build_time = 2–3 hours
| cost = $10–$15 USD
| lead_paragraph = The '''Example Procedure Simulator''' is a low-cost trainer for...
| hero_image = Example_hero.jpg
| hero_image_caption = Completed simulator ready for use.
| development_team = Example University Team
| tissues_rows =
<tr><td>[[TissueDB/Tissues/Skin|Skin]]</td><td>1 piece (10 × 10 cm)</td><td>[[TissueDB/Materials/Silicone|Silicone sheet]]</td><td>~$3.00</td><td>Cut to size before assembly.</td></tr>
| structural_parts_rows =
<tr><td>Base platform</td><td>1</td><td>Wood block</td><td>$1–$2</td><td>15 × 15 × 2 cm minimum.</td></tr>
| build_instructions = === Phase 1: Base Assembly ===

'''Step 1.''' Cut the wood block to 15 × 15 cm.

'''Step 2.''' Sand all edges smooth.

| references =
* Source: [https://example.org Original documentation]
<references />
| alternative_names = Example Trainer, Example Practice Model
}}

{{tl|Page data}}

Note: {{Page data}} is placed at page level after the Layout template closes (Platform convention).

Technical Notes

[edit source]
  • Sections only render when their parameters are provided — empty parameters produce no output (prevents doubled sections on hybrid pages)
  • The template automatically includes hero image, General Information table, Tissues table, Structural Parts table, Build Instructions, and References sections
  • {{Page data}} and {{Simulator data}} are placed at page level, NOT inside the template
  • The template adds categories: TissueDB, Simulators

Creates TissueDB Simulator build pages. Generates the complete structure for documenting medical training simulator construction. Part of the TissueDB project on Appropedia.

Template parameters[Edit template data]

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
Simulator Namename

Display name of the simulator

Stringrequired
Procedureprocedure

Clinical procedure this simulator trains

Stringrequired
Lead Paragraphlead_paragraph

Introduction paragraph describing the simulator

Contentrequired
Build Timebuild_time

Estimated construction time

Stringoptional
Costcost

Estimated materials cost

Stringoptional
Build Time and Costbuild_time_cost

Combined build time and cost. Additive with build_time and cost, not an alternative to them; each supplied field renders on its own line, cost first.

Stringoptional
Hero Imagehero_image

Filename only (no File: prefix)

Fileoptional
Hero Image Sizehero_image_size

Image width (default: 350px)

Default
350px
Stringoptional
Hero Image Althero_image_alt

Alt text for accessibility

Stringoptional
Hero Image Captionhero_image_caption

Caption below the image

Stringoptional
General Informationgeneral_info

Content for the General Information row

Contentoptional
Featuresfeatures

Features and Basic Operation row content

Contentoptional
Development Statusdev_status

Current Development Status. Values: Gen AI only, First pass engineering, First pass clinical, or Validated

Stringoptional
Specialized Toolsspecialized_tools

Tools beyond basic household items

Contentoptional
Versionversion

Version identifier

Stringoptional
Development Teamdevelopment_team

Team name and contact details

Stringoptional
Tissues Rowstissues_rows

HTML table rows for the Tissues table

Contentrequired
Structural Parts Rowsstructural_parts_rows

HTML table rows for the Structural Parts table

Contentrequired
Build Instructionsbuild_instructions

Complete build instructions with Phase subsections

Contentrequired
Build Intro Imagebuild_intro_image

Image markup for top of Build Instructions

Contentoptional
Referencesreferences

References section content

Contentoptional
Alternative Namesalternative_names

Comma-separated synonyms

Stringoptional


Additional section parameters

[edit source]

These are read by the template but were previously undocumented. Each renders its own section, and each is optional — the section is omitted entirely when the parameter is unset.

Parameter Renders Notes Source
var006_important_note A note at the very top of the page, above the hero image Use for a caveat the reader must see before anything else. Convention
var002_accuracy_rows == Anatomical Accuracy == table: Anatomical Structure, Accuracy Level, Notes Setting this replaces the Tissues table — the template renders one or the other, never both. Convention
var002_hardware == Hardware and Digital Files == For 3D-print files, CAD, and hardware manifests. Convention
structural_parts_extra Prose immediately above the Structural Parts table Context for the table; not a row. Convention
consumables_rows == Consumables == table: Consumable, Quantity, Material, Approximate Cost, Notes HTML <tr><td> rows, as elsewhere. Convention
var005_electronics == Electronics and Sensor Setup == Convention
var005_software == Software Setup == Convention
var006_digital_resources == Digital Resources == Rendered after the References section. Convention
dev_team_contact The "Development Team Contact Information" row of the summary table Falls back to development_team when unset. If both are unset the row reads "Not stated in source". Convention

Not parameters

[edit source]

These appear on live pages but this template never reads them. Counts are from a full-corpus scan of all 75 pages transcluding it, 19 July 2026. Nothing here renders.

Name On pages Why it is here What to do
hero_image_license 28 This template displays no licence line at all. Harmless leftover. Licence belongs on the File page.
name 25 The worked example in this document used to include it, which is how it spread. The page title is the name. Harmless leftover; removed from the example above.
clinical_setting, difficulty, target_tissue 2, 1, 1 Read by an earlier version of this template, still visible at Template:TissueDB Simulator Layout/sandbox. Harmless leftovers of a superseded contract.
alt 1 Misspelling of hero_image_alt, which this template does read. Fix if you are already editing that page.
general_info 1 The template renders general_info_extra, not general_info. A populated parameter can be undeclared and silently non-rendering. Fix if you are already editing that page.

Note that unlike the Material, Tissue and Structure Layouts, this template does declare and read references, and emits the section only when it is set.

Cookies help us deliver our services. By using our services, you agree to our use of cookies.