Skip to content

Commit 172aecc

Browse files
Update guides-tutorial-template.md
Updated Tutorial article template to reflect the standard set by the [lawnmower-tutorial](https://morrowind-modding.github.io/guides/groundcover/lawnmower-tutorial)
1 parent c5f7b63 commit 172aecc

File tree

1 file changed

+58
-18
lines changed

1 file changed

+58
-18
lines changed

mmw-content/contributing/templates/guides-tutorial-template.md

+58-18
Original file line numberDiff line numberDiff line change
@@ -5,27 +5,67 @@ tags:
55
description:
66
---
77

8-
%% Populate the tags in Properties %%
9-
%% Description property adds a description to this article when it appears in another index's listings. Description should be concise and catchy %%
8+
## About
109

11-
%% Add a brief description of what the page does. It should be at the top of the article and text should be italicized %%
12-
%% E.G. *This page contains three tutorials of varying difficulty on how to create an ESP Replacer Patch:* %%
10+
> [!infobox|n-th]
11+
>
12+
> ## Article Title
13+
>
14+
> > [!caption|center wfull txt-s]
15+
> >
16+
> > %%Insert Image%%
17+
> > %%caption%%
18+
> > %%[(image source)]()%%
19+
>
20+
> ### Tutorial Info
21+
>
22+
> | Type | Name |
23+
> | --- | --- |
24+
> | **Requirements** | |
25+
> | **Tutorial Files** | %% list names of tutorial files %% |
26+
>
27+
> %% embed download link to tutorial files if applicable %%
1328
14-
%% Add a backlink to any relevant Guides pages which provide background on the subject matter of the tutorial %%
15-
%%* E.g. See [[guides/patches/creating-a-patch-for-an-esp|Creating a Patch for an ESP]] for more information on what patches are and how they work.* %%
29+
### Goals
1630

17-
# Tutorial 1:
18-
%%![[comparison-screenshot-of-two-conflicting-mods.png]]%% %% add an introductory image or screenshot related to the tutorial %%
19-
* **Difficulty level:** %% Beginner, Intermediate or Advanced %%
20-
* **Requirements:**
21-
* %% list required tools %%
22-
* **Tutorial Files:**
23-
* %%`your tutorial mod.esp`%%
24-
* %% List any files created for the tutorials that users require in order to follow along with the tutorial, e.g. two ESPs for an ESP patch tutorial%%
31+
By the end of this tutorial, you should be able to:
2532

26-
%% Add a download link to any Tutorial Files. To make it a downloadable link, the full directory needs to be entered starting from [Assets/] %%
27-
%% E.G. ![[mmw-patches-esp-replacer-v1.zip]]%%
33+
1. %% goal 1 %%
34+
2. %% goal 2 %%
35+
3. %% goal 3 %%
2836

37+
### Prerequisites
2938

30-
**Scenario:** %% Outline the scenario for the tutorial, summarizing what the problem or goal is, and what the tutorial will teach in order to solve or achieve this %%
31-
%% *E.G. `MMW_Patches_ESP-Replacer_1a.esp` adds a house to Caldera. `MMW_Patches_ESP-Replacer_1b.esp` adds a thatch tower to Caldera in the same place - follow the tutorial to create an ESP replacer for `Replacer_1a.esp` which solves the conflict:*%%
39+
%% Explain the requirements listed in the infobox, and detail any set-up required in order to follow the tutorial %%
40+
41+
---
42+
43+
## H2 (step 1)
44+
45+
%% elaborate on goal 1 %%
46+
47+
---
48+
49+
## H2 (step 2)
50+
51+
%% elaborate on goal 2 %%
52+
53+
### H3 (elaborate on aspect of H2 step, or break it down into smaller sub-steps)
54+
55+
---
56+
57+
## H3 (step 3)
58+
59+
%% elaborate on goal 3 %%
60+
61+
%% further steps can be added as needed %%
62+
63+
---
64+
65+
## Further Reading
66+
67+
%% bullet point internal or external links to articles relevant to the tutorial %%
68+
69+
- %% link %%
70+
- %% link %%
71+
- %% link %%

0 commit comments

Comments
 (0)