Template:TissueDB Tissue Layout/doc
Overview
[edit source]{{TissueDB Tissue Layout}} creates TissueDB Tissues pages for anatomical tissue types, including skin, muscle, fascia, bone, blood vessels, connective tissue, organ tissues and bodily fluids. It is part of the TissueDB project.
This document describes the current published Layout and its approved conventions. Later approved changes take precedence over historical examples. The Layout supplies the section headings and their order. Put content in the matching parameter. Do not add extra level-two headings in the lead, parameter values or page body outside the Layout call. In particular, related_structures is inline prose, not a separate Related Structures section.
Visible Section Order
[edit source]- Optional hero image and lead paragraph, with no heading.
== Materials ==, whenmaterialsis populated.== Things to Look Out For ==, whenantiskillsis populated.- Related-anatomy prose from
related_structures, with no heading. == Simulators ==, whensimulatorsis populated.== Simulation Requirements ==, whensimulation_requirementsis populated.== References ==.
These are the only section headings supplied for Tissue entry pages. Omit empty optional content rather than adding replacement headings. The historical At a Glance and Background boxes are hidden and do not appear in this order.
Parameters
[edit source]| Parameter | Input | Purpose |
|---|---|---|
| lead_paragraph | Wikitext; required | A brief, sourced description of the tissue and its clinical significance, normally 100–150 words. Use metric measurements first. Do not include a section heading. |
| hero_image | Filename | Optional image filename without the File: prefix. The Layout creates the image markup and reads licence and author information from the File page. |
| hero_image_caption | Text | Caption for the optional hero image. |
| materials | HTML table rows | Rows passed to {{TissueDB Tissue Materials Table}}. Supply row content, not a second Materials heading. |
| antiskills | Wikitext | Source-supported warnings passed to {{TissueDB Tissue Antiskills}}, under Things to Look Out For. |
| related_structures | Wikitext | Inline prose with links to relevant TissueDB/Structures/ pages. Do not insert a Related Structures heading. |
| simulators | Wikitext | Simulator links and source-supported context passed to {{TissueDB Tissue Simulators}}. |
| simulation_requirements | HTML table rows | Source-supported requirements passed to {{TissueDB Tissue Simulation Requirements}}. |
| references | Reference-list markup | Optional; defaults to <references />. See References below. |
Historical Hidden Parameters
[edit source]overview, synonyms_text, clinical_context and related_structures_background remain in existing page sources for historical retention. The Layout's guards read these values without displaying them. The At a Glance and Background boxes are hidden, including their former Overview, Synonyms, Clinical Context and Related Structures subsections.
Do not populate these parameters on new pages or reactivate their former headings. Do not delete, promote or automatically move existing historical values merely because they are hidden. Any future visible content must fit an approved current field and retain its source context. The active related_structures prose field is distinct from the hidden related_structures_background field.
References
[edit source]references is a declared, optional Layout parameter. Its default is <references />. The Layout supplies the References heading; do not add a second References heading inside the value or after the Layout call.
Pass | references = <references /> explicitly when the page uses citations. This also puts the literal reference-list tag in the page's own source for Cite tracking. An empty value does not supply a reference list. Existing supplied values may contain named reference definitions; preserve those definitions and their corresponding citations when editing.
Content Rules
[edit source]- Use only the visible section order above; do not add free-standing sections before or after the Layout.
- Use Materials and Things to Look Out For as the section names. Do not substitute Materials Quick-Pick or Avoid Antiskills.
- Keep
related_structuresas inline prose without any heading. - Visual and tactile assessments use Yes, Partial or No, with source-supported notes; do not introduce rating scales.
- All warnings and simulation requirements must be source-supported.
- Accessibility & Infrastructure Factors belongs to Material pages, not Tissue pages.
- Use metric measurements first and avoid emoji section headers.
- Keep internal editorial codes out of published content.
- Place {{Page data}} and synonym metadata at page level after the Layout closes.
Placement Example
[edit source]This example shows parameter placement. Replace illustrative labels and assessments with source-supported content. The Layout calls the section sub-templates; pass their row or prose content into the Layout fields.
{{TissueDB Tissue Layout
| lead_paragraph = '''Skin''' — add a brief, sourced description of the tissue.
| hero_image = Skin_cross_section.png
| hero_image_caption = Cross-section of human skin layers
| materials =
<tr>
<td>[[TissueDB/Materials/Silicone|Silicone]]</td>
<td>Yes</td>
<td>Partial</td>
<td>[[TissueDB/Simulators/Z-Plasty Simulator|Z-Plasty Simulator]]</td>
<td>Source-supported explanation of the visual and tactile assessments.</td>
</tr>
| antiskills = Add source-supported warnings relevant to this tissue.
| related_structures = Related anatomy includes [[TissueDB/Structures/Abdominal Wall|the abdominal wall]].
| simulators =
* [[TissueDB/Simulators/Z-Plasty Simulator|Z-Plasty Simulator]]
| simulation_requirements =
<tr><td>Visual</td><td>Source-supported visual requirement.</td></tr>
<tr><td>Tactile</td><td>Source-supported tactile requirement.</td></tr>
| references = <references />
}}
{{TissueDB synonym data
| case = Skin, skin, SKIN
| regional = Peau (French), Piel (Spanish)
}}
{{Page data
| keywords = skin, tissue, simulation
| description = Simulation materials for skin tissue
| hide = yes
}}
Technical Notes
[edit source]- The Layout renders {{TissueDB tissue notice}} at the top of the page.
- Materials, Things to Look Out For, Simulators and Simulation Requirements render only when their corresponding fields are populated. References always has a heading.
- The Layout supplies the section-template calls. Table fields contain HTML rows; prose fields contain their content.
- Page data is outside the Layout. Historical hidden values remain stored but are not displayed.
Template Data
[edit source]Creates TissueDB Tissue pages with the approved visible section order. Related anatomy is inline prose; historical At a Glance and Background fields are hidden.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Lead Paragraph | lead_paragraph | Brief sourced tissue description and clinical significance; no heading. | Content | required |
| Hero Image | hero_image | Filename only, without File: prefix. Licence and author information come from the File page. | File | optional |
| Hero Image Caption | hero_image_caption | Caption below the image. | String | optional |
| Materials | materials | HTML rows for the Materials table; the Layout supplies the section heading and table template. | Content | optional |
| Things to Look Out For | antiskills | Source-supported warnings; no section heading in the value. | Content | optional |
| Related Anatomy Prose | related_structures | Inline prose with links to TissueDB/Structures/ pages; no heading. | Content | optional |
| Simulators | simulators | Simulator links and source-supported context; the Layout supplies the heading. | Content | optional |
| Simulation Requirements | simulation_requirements | HTML rows containing source-supported simulation requirements. | Content | optional |
| References | references | Reference-list markup; defaults to <references />. Preserve named reference definitions. | Content | optional |
| Overview (historical, hidden) | overview | Historical value retained in source; the current Layout does not display it. | Content | deprecated |
| Synonyms (historical, hidden) | synonyms_text | Historical value retained in source; the current Layout does not display it. | Content | deprecated |
| Clinical Context (historical, hidden) | clinical_context | Historical value retained in source; the current Layout does not display it. | Content | deprecated |
| Related Structures Background (historical, hidden) | related_structures_background | Historical value retained in source; the current Layout does not display it. | Content | deprecated |