Template
Tutorial
From Dogcraft Wiki
(Created page with "<includeonly><div id="tutorial" style="display:flex; justify-content:center; align-items:center; margin:10px 0;"> <div style="border-bottom:3px solid {{{border|#8b0024}}}; bac...") Ā |
mNo edit summary Ā |
||
(6 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
<includeonly><div id="tutorial" style="display:flex; justify-content:center; align-items:center; margin:10px 0;"> | <includeonly>{{#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-bottom:3px solid {{{border|#8b0024}}}; background:{{{background|#e9edef}}}; padding:0.3em 1rem; text-align:center; min-width:{{{min_width|50%}}}; {{{style|}}}"> | <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|Tutorial}}}</div>{{{title|Title}}}</div> | <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;">{{{description|}}}</div> | <div style="font-style:italic; font-size:14px; color:darkgray;">{{#if:{{{nav|}}}||{{{description|}}}}}</div> | ||
<div id="tutorial-nav" style="display:flex; flex-direction:row; align-items:center; justify-content:space-between; text-align:center; padding-top:0. | <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}}}|Ā« Previous]]</span> | <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> | <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}}}|Next Ā»]]</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> | </div></div></div></includeonly><noinclude>[[Category:Navigation templates]] {{Interface template}} | ||
{{TemplateStyles}} | |||
==Tutorial template== | ==Tutorial template== | ||
This template is for tying together multiple guide pages into a single tutorial one can step through. Ā | 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 | <pre style="white-space:pre-line;">{{Tutorial | ||
|titleĀ Ā Ā = Starting on Dogcraft | |titleĀ Ā Ā = Starting on Dogcraft | ||
Line 27: | Line 28: | ||
|chaptersĀ Ā = [[Guide:Linking|Account linking]] ([[Guide:Bedrock Account Linking|Bedrock]]) {{*}} [[Rules]] {{*}} '''Worlds''' {{*}} [[Features beyond Vanilla|Server information & features]] | |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== | ==Template data== | ||
Line 99: | Line 116: | ||
"required": true, | "required": true, | ||
"suggested": 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" | |||
} | } | ||
}, | }, | ||
Line 109: | Line 143: | ||
"description", | "description", | ||
"name", | "name", | ||
"nav", | |||
"start", | |||
"end", | |||
"min_width", | "min_width", | ||
"border", | "border", |
Latest revision as of 13:30, 4 December 2023
This template uses TemplateStyles: |
Tutorial template
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:
Feel free to ask any [Helper]s or staff for assistance!
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:
Template data
For tying together multiple guide pages into a single step-through tutorial.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Title | title | The tutorial's title
| String | required |
Previous chapter | previous | Page name of the previous chapter (guide) for linking
| Page name | required |
Next chapter | next | Page name of the next chapter (guide) for linking
| Page name | required |
Chapters | chapters | A list of links to all the pages which are tied together into the tutorial, usually separated with {{*}}s.
| String | suggested |
(Optional) Description | description | A short description of the entire tutorial's purpose.
| String | suggested |
(Optional) Name | name | An alternative name to the gray 'Tutorial' line at the template's top. This should mostly be unused. | String | suggested |
(Optional) Navigation mode | nav | Trigger for navigation mode: If true, Title and Description are not shown and Name is set to "Tutorial navigation".
| Boolean | suggested |
(Optional) Start | start | Trigger signifying start of tutorial, disabled "Previous" button. | Boolean | optional |
(Optional) End | end | Trigger signifying end of tutorial, disabled "Next" button. | Boolean | optional |
Minimum width | min_width | The box's minimum width
| String | optional |
Border color | border | The color of the line at the box's bottom
| String | optional |
Background color | background | The box's background color
| String | optional |
Further styles | style | Free-form parameter for adding further CSS styles to the box. | String | optional |