Template

Tutorial

From Dogcraft Wiki

mNo edit summary
m (Moving documentation to /doc as a test)
Β 
Line 8: Line 8:
<span style="font-weight: 600; white-space:nowrap;">[[{{{next}}}|{{Clickable button|Next Β»|color=blue|disabled={{#if:{{{end|}}}|1}}}}]]</span>
<span style="font-weight: 600; white-space:nowrap;">[[{{{next}}}|{{Clickable button|Next Β»|color=blue|disabled={{#if:{{{end|}}}|1}}}}]]</span>
</div></div></div></includeonly><noinclude>{{documentation2}}[[Category:Navigation templates]] {{Interface template}}
</div></div></div></includeonly><noinclude>{{documentation2}}[[Category:Navigation templates]] {{Interface template}}
This template is for tying together multiple guide pages into a single tutorial one can step through.
==Examples==
<pre style="white-space:pre-line;">{{Tutorial
|titleΒ  Β  Β  = Starting on Dogcraft
|description = A guide to your first few days on the Dogcraft server & community.<br />Feel free to ask any {{Rank|Helper}}s or staff for assistance!
|previousΒ  Β  = Rules
|nextΒ  Β  Β  Β  = Features beyond Vanilla
|chaptersΒ  Β  = [[Guide:Linking|Account linking]] ([[Guide:Bedrock Account Linking|Bedrock]]) {{*}} [[Rules]] {{*}} [[Worlds]] {{*}} [[Features beyond Vanilla|Server information & features]]
}}</pre> generates:
{{Tutorial
|titleΒ  Β  Β  = Starting on Dogcraft
|description = A guide to your first few days on the Dogcraft server & community.<br />Feel free to ask any {{Rank|Helper}}s or staff for assistance!
|previousΒ  Β  = Rules
|nextΒ  Β  Β  Β  = Features beyond Vanilla
|chaptersΒ  Β  = [[Guide:Linking|Account linking]] ([[Guide:Bedrock Account Linking|Bedrock]]) {{*}} [[Rules]] {{*}} '''Worlds''' {{*}} [[Features beyond Vanilla|Server information & features]]
}}
===Navigation mode===
Useful for Previous/Next buttons at the bottom of pages.
<pre style="white-space:pre-line;">{{Tutorial
|previousΒ  Β  = Rules
|nextΒ  Β  Β  Β  = Features beyond Vanilla
|chaptersΒ  Β  = [[Guide:Linking|Account linking]] ([[Guide:Bedrock Account Linking|Bedrock]]) {{*}} [[Rules]] {{*}} [[Worlds]] {{*}} [[Features beyond Vanilla|Server information & features]]
|navΒ  Β  Β  Β  = true
}}</pre> generates:
{{Tutorial
|previousΒ  Β  = Rules
|nextΒ  Β  Β  Β  = Features beyond Vanilla
|chaptersΒ  Β  = [[Guide:Linking|Account linking]] ([[Guide:Bedrock Account Linking|Bedrock]]) {{*}} [[Rules]] {{*}} '''Worlds''' {{*}} [[Features beyond Vanilla|Server information & features]]
|navΒ  Β  Β  Β  = true
}}
==Template data==
<noinclude>
<templatedata>
{
"params": {
"border": {
"label": "Border color",
"description": "The color of the line at the box's bottom",
"example": "crimson",
"type": "string"
},
"background": {
"label": "Background color",
"description": "The box's background color",
"example": "yellow",
"type": "string"
},
"min_width": {
"label": "Minimum width",
"description": "The box's minimum width",
"type": "string",
"default": "50%"
},
"style": {
"label": "Further styles",
"description": "Free-form parameter for adding further CSS styles to the box.",
"type": "string"
},
"name": {
"label": "(Optional) Name",
"description": "An alternative name to the gray 'Tutorial' line at the template's top. This should mostly be unused.",
"type": "string",
"suggested": true
},
"title": {
"label": "Title",
"description": "The tutorial's title",
"example": "Server economy",
"type": "string",
"required": true,
"suggested": true
},
"description": {
"label": "(Optional) Description",
"description": "A short description of the entire tutorial's purpose.",
"example": "A guide to your first few days on Dogcraft.",
"type": "string",
"suggested": true
},
"previous": {
"label": "Previous chapter",
"description": "Page name of the previous chapter (guide) for linking",
"example": "Guide:Account_Linking",
"type": "wiki-page-name",
"required": true,
"suggested": true
},
"chapters": {
"label": "Chapters",
"description": "A list of links to all the pages which are tied together into the tutorial, usually separated with {{*}}s.",
"example": "[[Guide:Account Linking]] {{*}} [[Rules]] {{*}} [[Guide:Claiming land]]",
"type": "string",
"suggested": true
},
"next": {
"label": "Next chapter",
"description": "Page name of the next chapter (guide) for linking",
"example": "Guide:Claiming_land",
"type": "wiki-page-name",
"required": true,
"suggested": true
},
"nav": {
"label": "(Optional) Navigation mode",
"description": "Trigger for navigation mode: If true, Title and Description are not shown and Name is set to \"Tutorial navigation\".",
"type": "boolean",
"default": "false",
"suggested": true
},
"start": {
"label": "(Optional) Start",
"description": "Trigger signifying start of tutorial, disabled \"Previous\" button.",
"type": "boolean"
},
"end": {
"label": "(Optional) End",
"description": "Trigger signifying end of tutorial, disabled \"Next\" button.",
"type": "boolean"
}
},
"description": "For tying together multiple guide pages into a single step-through tutorial. ",
"paramOrder": [
"title",
"previous",
"next",
"chapters",
"description",
"name",
"nav",
"start",
"end",
"min_width",
"border",
"background",
"style"
],
"format": "block"
}
</templatedata>
</noinclude>

Latest revision as of 00:29, 3 February 2026

{{#ifeq: {{NAMESPACE}} | {{ns:Template}} | {{#ifeq: {{#sub:{{ROOTPAGENAME}}|0|8}} | Tutorial | [[Category:Tutorials]] |}} |}}<templatestyles src="Tutorial/styles.css" /><div id="tutorial" style="display:flex; justify-content:center; align-items:center; margin:10px 0;">
<div style="border-{{#if:{{{nav|}}}|top|bottom}}:3px solid {{{border|#8b0024}}}; background:{{{background|#e9edef}}}; padding:0.3em 1rem; text-align:center; min-width:{{{min_width|50%}}}; {{{style|}}}">
<div style="font-size:20px; font-weight:bold;"><div style="color:gray; font-size:small; margin-bottom:-5px;">{{{name|{{#if:{{{nav|}}}|Tutorial navigation|Tutorial}}}}}</div>{{#if:{{{nav|}}}||{{{title|Title}}}}}</div>
<div style="font-style:italic; font-size:14px; color:darkgray;">{{#if:{{{nav|}}}||{{{description|}}}}}</div>
<div id="tutorial-nav" class="flex-mobile-wrap slim" style="display:flex; flex-direction:row; align-items:center; justify-content:space-between; text-align:center; padding-top:0.3em;">
<span style="font-weight:600; white-space:nowrap;">[[{{{previous}}}|{{Clickable button|Β« Previous||disabled={{#if:{{{start|}}}|1}}}}]]</span>
<div id="tutorial-chapters" style="flex-grow:1; margin:0 10px; font-size:85%; word-wrap:anywhere;">{{{chapters|}}}</div>
<span style="font-weight: 600; white-space:nowrap;">[[{{{next}}}|{{Clickable button|Next Β»|color=blue|disabled={{#if:{{{end|}}}|1}}}}]]</span>
</div></div></div>
Show full sourceHide full source
Index of templates

Template documentation


This template is for tying together multiple guide pages into a single tutorial one can step through.

Examples

{{Tutorial
|title       = Starting on Dogcraft
|description = A guide to your first few days on the Dogcraft server & community.<br />Feel free to ask any {{Rank|Helper}}s or staff for assistance! 
|previous    = Rules
|next        = Features beyond Vanilla
|chapters    = [[Guide:Linking|Account linking]] ([[Guide:Bedrock Account Linking|Bedrock]]) {{*}} [[Rules]] {{*}} [[Worlds]] {{*}} [[Features beyond Vanilla|Server information & features]]
}}
generates:
Tutorial
Starting on Dogcraft
A guide to your first few days on the Dogcraft server & community.
Feel free to ask any [Helper]s or staff for assistance!

Navigation mode

Useful for Previous/Next buttons at the bottom of pages.

{{Tutorial
|previous    = Rules
|next        = Features beyond Vanilla
|chapters    = [[Guide:Linking|Account linking]] ([[Guide:Bedrock Account Linking|Bedrock]]) {{*}} [[Rules]] {{*}} [[Worlds]] {{*}} [[Features beyond Vanilla|Server information & features]]
|nav         = true
}}
generates:
Tutorial navigation


Template data

For tying together multiple guide pages into a single step-through tutorial.

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
Titletitle

The tutorial's title

Example
Server economy
Stringrequired
Previous chapterprevious

Page name of the previous chapter (guide) for linking

Example
Guide:Account_Linking
Page namerequired
Next chapternext

Page name of the next chapter (guide) for linking

Example
Guide:Claiming_land
Page namerequired
Chapterschapters

A list of links to all the pages which are tied together into the tutorial, usually separated with {{*}}s.

Example
[[Guide:Account Linking]] {{*}} [[Rules]] {{*}} [[Guide:Claiming land]]
Stringsuggested
(Optional) Descriptiondescription

A short description of the entire tutorial's purpose.

Example
A guide to your first few days on Dogcraft.
Stringsuggested
(Optional) Namename

An alternative name to the gray 'Tutorial' line at the template's top. This should mostly be unused.

Stringsuggested
(Optional) Navigation modenav

Trigger for navigation mode: If true, Title and Description are not shown and Name is set to "Tutorial navigation".

Default
false
Booleansuggested
(Optional) Startstart

Trigger signifying start of tutorial, disabled "Previous" button.

Booleanoptional
(Optional) Endend

Trigger signifying end of tutorial, disabled "Next" button.

Booleanoptional
Minimum widthmin_width

The box's minimum width

Default
50%
Stringoptional
Border colorborder

The color of the line at the box's bottom

Example
crimson
Stringoptional
Background colorbackground

The box's background color

Example
yellow
Stringoptional
Further stylesstyle

Free-form parameter for adding further CSS styles to the box.

Stringoptional
Background SRN Opening by Montenator