Template:Module documentation: Difference between revisions

From Space Station 14 Wiki
(Created page with "<includeonly> {| style="float: left;" ! <div style="width:100%; padding:3px 0px; text-align:center; font-size: large;">Module documentation</div> |- | <!-- # if a custom link is not provided, then use the /doc page link, unless we are on a page that ends with /doc - in that case, use the current page link. # this prevents docs link on a /doc page of a module pointing to further /doc subpage, instead appearing in bold since it's linking to itself. -->{{#vardefine: page_li...")
 
(moved notices to docs)
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
<includeonly>
<includeonly>
{| style="float: left;"
{| style="float: left; border: 2px solid var(--border-color); padding: 0.4rem; background-color: color-mix(in srgb, var(--action-color-dark-x2) 5%, transparent); border-radius: .2rem;"
! <div style="width:100%; padding:3px 0px; text-align:center; font-size: large;">Module documentation</div>
! <div style="width:100%; padding:3px 0px; text-align:center; font-size: large;">Module documentation</div>
|-
|-
Line 6: Line 6:
# this prevents docs link on a /doc page of a module pointing to further /doc subpage, instead appearing in bold since it's linking to itself.
# this prevents docs link on a /doc page of a module pointing to further /doc subpage, instead appearing in bold since it's linking to itself.
-->{{#vardefine: page_link|{{{1|{{#ifeq: {{#invoke:String|endswith|{{FULLPAGENAME}}|/doc}}|yes|{{FULLPAGENAME}}|{{FULLPAGENAME}}/doc}} }}}}}<!--
-->{{#vardefine: page_link|{{{1|{{#ifeq: {{#invoke:String|endswith|{{FULLPAGENAME}}|/doc}}|yes|{{FULLPAGENAME}}|{{FULLPAGENAME}}/doc}} }}}}}<!--
-->View or edit [[{{#var:page_link}}|this documentation]] {{dot}} ([[Template:Module documentation|about module documentation]])
-->View or edit [[{{#var:page_link}}|this documentation]] {{colored text|gray|•}} ([[Template:Module documentation|about module documentation]])
|}<!--
|}<!--


Line 19: Line 19:
{{clear}}</includeonly><noinclude>
{{clear}}</includeonly><noinclude>


{{Documentation|bb=
{{has alias templates|Module docs}}
{{has alias templates|Module docs}}
 
}}
{{Documentation}}


[[Category:Templates for documenting modules]]
[[Category:Templates for documenting modules]]

Latest revision as of 12:02, 17 August 2024


Template documentation
view or edit this documentation about template documentation
Has an alias
This template has an alternative name:

Usage

{{Module documentation
| link to page with docs
| below banner = content to insert below the documentation "banner", before the actual documentation.
| bb = alias for "below banner"
}}

See also

This template is used to insert descriptions on template pages.

Template parameters[Edit template data]

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Link override1

Override for the documentation link.

Default
/doc (relative to the page, where this template is included).
Page nameoptional
Content below bannerbelow banner bb

Content to insert below banner and above documentation.

Contentoptional