Toggle menu
Toggle preferences menu
Toggle personal menu
Not logged in
Your IP address will be publicly visible if you make any edits.

Join the Playtest on Steam Now: SpiritVale

Guides:Eviand's Wiki Guide Creation: Difference between revisions

From SpiritVale Wiki
No edit summary
 
(19 intermediate revisions by the same user not shown)
Line 1: Line 1:
<noinclude>[[Category:Guides]]</noinclude>
<noinclude>[[Category:Guides]]</noinclude>
{{Template:PageHeader
{{Template:PageHeader
| PageImage = SpiritValeLogo.png
| PageImage = SpiritValeLogo.png
| PageHeader = Eviand's Wiki Guide Creation
| PageHeader = Eviand's Wiki Guide Creation
}}
}}


== Using this Guide ==
== Using this Guide ==
This guide's main purpose is to let anyone create a guide page, so that they can publish their build in a static environment. If you feel like you have a great build that isn't anywhere in Discord or the Wiki, or that you wish the Wiki had something better than what it currently has, this page will give you some helpful guidance on how to navigate through a wiki.
This guide's main purpose is to let anyone create a guide page, so that they can publish their build in a static environment. If you feel like you have a great build that isn't anywhere in Discord or the Wiki, or that you wish the Wiki had something better than what it currently has, this page will give you some helpful guidance on how to navigate through a wiki.


If you need detailed instructions on how to start editing Wiki pages, I recommend reading up on how to '''[https://www.mediawiki.org/wiki/Help:Editing_pages| Edit a Wiki Page]''' and how to '''[https://www.mediawiki.org/wiki/Help:Starting_a_new_page| Start a New Wiki Page]''' as this guide will assume that users understand how to edit pages, preview their edits, and publish that page. Note that the stuff in here overrides what is in those pages, so when it doubt, trust this page.
If you need detailed instructions on how to start editing Wiki pages, I recommend reading up on how to '''[https://www.mediawiki.org/wiki/Help:Editing_pages| Edit a Wiki Page]''' and how to '''[https://www.mediawiki.org/wiki/Help:Starting_a_new_page| Start a New Wiki Page]''' as this guide will assume that users understand how to edit pages, preview their edits, and publish that page. Note that the stuff in here overrides what is in those pages, so when it doubt, trust this page.
Otherwise, the rest of the guide provides some examples on how to properly spin up a Class Build page.


== Creating the Page ==
== Creating the Page ==
The quickest way to create a guide is to add a link in an appropriate Guides page (e.g., [[Guides:Acolyte Builds]]):


The easiest way to create a page will be directly create a clickable link in one of the many guide guide spaces, such as [[Guides:Acolyte Builds]].
* Edit the page where your guide link should live.
 
* Under any section, add a bullet using an asterisk (<nowiki>*</nowiki>).
* Edit the page you wish to add a guide to.
* Name your guide in the Guides namespace (<nowiki>Guides:Example Guide Name</nowiki>).
* Under any section, add a bullet point by using an asterisk (*<nowiki />)
** Example: <nowiki>Guides:Example Guide Name</nowiki>
* Create a name for your guide, starting with the word Guides, and with a colon (:<nowiki />)
* Wrap the name in double brackets:
** Example: Guides:Special Setup of Gear
** Example: <nowiki>[[Guides:Example Guide Name]]</nowiki>
* Wrap the new name with two sets of opening and closing brackets.
* Save the page.
** Example: <nowiki>[[Guides:Special Setup of Gear]]</nowiki>
* Save the changes to the page.
 
The page will reload, and now you will see a Red link, like so: [[Guides:Special Setup of Gear]].
 
Simply click on that new link, and you'll be editing the page in no time.


===Naming Conventions===
The new link will appear in red (a “redlink”): [[Guides:Example Guide Name]]. Click it to start editing the new page.


=== Naming Conventions ===
It's important for Wiki management to align with standard naming conventions in order to organize and sort pages into their correct locations.
It's important for Wiki management to align with standard naming conventions in order to organize and sort pages into their correct locations.


Please make sure that when creating a new guide, always format it as "Guides:Example_Name". The colon tells the wiki that these pages belong to the Guides namespace, and this is where all guides will be part of as they are created.
Please make sure that when creating a new guide, always format it as "Guides:Example Name". The colon tells the wiki that these pages belong to the Guides namespace, and this is where all guides will be part of as they are created.


== Understanding the Editor ==
== Understanding the Editor ==
There are two edit modes:


The wiki editor is split into two parts: Edit, and Edit Source.
* '''Edit''' (visual): What-you-see-is-what-you-get editing.
** Pros: Fast for typos, formatting, and template fields.
** Cons: Some advanced features aren’t available.


* '''Edit''' allows you to directly edit the page in a visual way, and you can make changes directly to the page. Including via templates.
* '''Edit source''' (wikitext): Directly edit the page’s source.
** Pros - Great for quick edits, like fixing mistakes or spelling errors, and allows for quick editing of templates.
** Pros: Precise control; faster for experienced editors.
** Cons - Doesn't have all the functionality that editing the source does.
** Cons: Requires familiarity with wikitext; dense pages can be harder to read.
* '''Edit Source''' allows for the traditional wiki editing experience, including the ability to utilize code.
** Pros - If the user knows what they are doing it's quicker and more efficient to edit directly in the source.
** Cons - Requires knowledge and experience to access, and can be very dense in some places with a lot of customer code.


Please use whatever version you are more comfortable with, and you can always ask for help in Discord if you need it, just @Eviand.
Please use whatever version you are more comfortable with, and you can always ask for help in Discord if you need it, just @Eviand.


== Templates and What They Do ==
== Templates and What They Do ==
Templates are reusable page pieces you can drop into any page. They save time by handling the fancy formatting for you—you just fill in the fields.
=== Option 1: Visual Editor (recommended) ===
Use this if you prefer forms and buttons.
[[File:Edit Template Example.png|center|600px|alt=Editing a template in Visual Editor]]
'''To insert a new template'''
# Click '''Edit''' at the top of the page (not “Edit source”).
# In the toolbar, choose '''Insert > Template''' (puzzle-piece icon).
# Search for the template name (for example, '''ClassInfoBox'''), then click '''Add template'''.
# A form opens with fields, examples, and short descriptions. Fill in what you know.
# Click '''Insert''' (or '''Apply changes'''), then '''Publish changes'''.
'''To edit an existing template on the page'''
# In Visual Editor, double-click the template table/box, or click the small '''Edit''' button on it.
# Update any fields you want.
# Click '''Apply changes''', then '''Publish changes'''.
''You can leave fields blank as most templates hide empty info automatically.''
----
=== Option 2: Edit Source (advanced) ===
Use this if you like wikitext.
A basic insert looks like this:
<nowiki>
{{Example Insert
| Example Parameter = Example Value
}}
</nowiki>
When you save, the wiki turns that block into the styled template. 
You can switch between editors any time:
* In Visual Editor: you can switch in the menu at the top.
* In Source Editor: click the normal '''Edit''' tab next time.
'''Example (source)'''
<nowiki>
{{ClassInfoBox
| Role    = Melee <br> Poison
| Weapons = Dagger
| STR = 9
| AGI = 12
| VIT = 1
| INT = 1
| DEX = 9 
| LUK = 1
}}
</nowiki>
'''Result'''
Look at the far right, and now you can see the infobox that populates on each class page.
{{ClassInfoBox
| Role    = Melee <br> Poison
| Weapons = Dagger
| STR = 9 | AGI = 12 | VIT = 1
| INT = 1 | DEX = 9  | LUK = 1
}}
'''Tips'''
* Using the correct names for things is important, as some fields will try to do fancy things with the text. For example, it may try to link to the database.
* Use <nowiki><br/></nowiki> to add a new line inside a field. This will break up the text, making it look cleaner.
* If a link shows red, the page title might be misspelled or missing—double-check.
== Wiki Headers (Sections) ==
You can create headings with equal signs around the text:
* <nowiki>= Level 1 Header =</nowiki>
* <nowiki>== Level 2 Header ==</nowiki>
* <nowiki>=== Level 3 Header ===</nowiki>
* <nowiki>==== Level 4 Header ====</nowiki>
* <nowiki>===== Level 5 Header =====</nowiki>
Note that for consistency, try to only use Levels 2 and 3 for most things, as the rest are often overkill, and can make a wiki page a lot more difficult to read and edit. However, go crazy if you feel that it will work!
Example:
<nowiki>== Example Two Level Section ==
Quick description
=== Example Three Level Section ===
Another quick description
</nowiki>
== Adding Images and Links ==
Link to other pages with double brackets:
* <nowiki>[[Example]]</nowiki>
* Renders as: [[Example]]
Link to a section with a hash:
* <nowiki>[[Example#Example Level 2 Section]]</nowiki>
* Renders as: [[Example#Example Level 2 Section]]
Change the displayed text with a pipe:
* <nowiki>[[Example|My new name!]]</nowiki>
* Renders as: [[Example|My new name!]]
Combine section + custom text:
* <nowiki>[[Example#Example Level 2 Section|My new name!]]</nowiki>
* Renders as: [[Example#Example Level 2 Section|My new name!]]
Add an image (with a 15px width):
* <nowiki>[[File:FireIcon.png|15px]]</nowiki>
* Renders as: [[File:FireIcon.png|15px]]
==== List of Pre-made Image Icons ====
Here is a full list of all the icons you can use in your text, along side a link to each section. Just copy and paste any of these into your page to make your words and images stand out!
'''Attributes'''
<nowiki>
[[File:Strength.png|15px]] [[Attributes#Strength_(STR)|STR]]
[[File:Vitality.png|15px]] [[Attributes#Vitality_(VIT)|VIT]]
[[File:Dexterity.png|15px]] [[Attributes#Dexterity_(DEX)|DEX]]
[[File:Agility.png|15px]] [[Attributes#Agility_(AGI)|AGI]]
[[File:Intelligence.png|15px]] [[Attributes#Intelligence_(INT)|INT]]
[[File:Luck.png|15px]] [[Attributes#Luck_(LUK)|LUK]]
</nowiki>
How it looks when on a page:
* [[File:Strength.png|15px]] [[Attributes#Strength_(STR)|STR]]
* [[File:Vitality.png|15px]] [[Attributes#Vitality_(VIT)|VIT]]
* [[File:Dexterity.png|15px]] [[Attributes#Dexterity_(DEX)|DEX]]
* [[File:Agility.png|15px]] [[Attributes#Agility_(AGI)|AGI]]
* [[File:Intelligence.png|15px]] [[Attributes#Intelligence_(INT)|INT]]
* [[File:Luck.png|15px]] [[Attributes#Luck_(LUK)|LUK]]
'''Elements'''
<nowiki>
[[File:FireIcon.png|15px]] [[Elements#Fire|Fire]]
[[File:WaterIcon.png|15px]] [[Elements#Water|Water]]
[[File:EarthIcon.png|15px]] [[Elements#Earth|Earth]]
[[File:WindIcon.png|15px]] [[Elements#Wind|Wind]]
[[File:ShadowIcon.png|15px]] [[Elements#Shadow|Shadow]]
[[File:PoisonIcon.png|15px]] [[Elements#Poison|Poison]]
[[File:UndeadIcon.png|15px]] [[Elements#Undead|Undead]]
[[File:HolyIcon.png|15px]] [[Elements#Holy|Holy]]
[[File:NeutralIcon.png|15px]] [[Elements#Neutral|Neutral]]
</nowiki>
How it looks when on a page:
* [[File:FireIcon.png|15px]] [[Elements#Fire|Fire]]
* [[File:WaterIcon.png|15px]] [[Elements#Water|Water]]
* [[File:EarthIcon.png|15px]] [[Elements#Earth|Earth]]
* [[File:WindIcon.png|15px]] [[Elements#Wind|Wind]]
* [[File:ShadowIcon.png|15px]] [[Elements#Shadow|Shadow]]
* [[File:PoisonIcon.png|15px]] [[Elements#Poison|Poison]]
* [[File:UndeadIcon.png|15px]] [[Elements#Undead|Undead]]
* [[File:HolyIcon.png|15px]] [[Elements#Holy|Holy]]
* [[File:NeutralIcon.png|15px]] [[Elements#Neutral|Neutral]]
== Linking to the Database ==
You can link an item directly from the database by using a special WikiLink called an external link.
In order to find items, please use the following link to directly access the database: [https://spiritvale.info/ https://spiritvale.info/]


A template is a pre-made wiki page that intended to be transcluded (or in other words, inserted) into another page. This allows for complex pieces of wiki formatting and code to be re-used across multiple pages, and allows for contributors to easily fill out a complicated table.
<nowiki>
[https://www.example.com Example]
</nowiki>


When creating a page it may be a good idea to see if a template exists that could make your job easier, and transclude it directly into your page. This page will also include common template inserts so that you can just use this to create one!
Which will then look like this:
[https://www.example.com Example]


The insert looks like this:
=== Creating Database Link ===


{Example Insert
# Find the page that you wish to link to, and copy the URL at the top.
| Example Parameter = Example Value
## https://spiritvale.info/equipment/tome-of-the-first-hymn
|}
# Add the brackets to each side of the URL.
## <nowiki> [https://spiritvale.info/equipment/tome-of-the-first-hymn]</nowiki>
# Add a space at the end, and then put in the name of the item.
## <nowiki> [https://spiritvale.info/equipment/tome-of-the-first-hymn Tome of the First Hymn]</nowiki>


This will check for a template page called "Example Insert", and then you're more than welcome to fill in all the values. When a page is inserted
If done correctly, you will have a like will look and function like this: [https://spiritvale.info/equipment/tome-of-the-first-hymn Tome of the First Hymn]

Latest revision as of 03:28, 10 September 2025


Join the Playtest on Steam Now: SpiritVale


Eviand's Wiki Guide Creation



Using this Guide

edit edit source

This guide's main purpose is to let anyone create a guide page, so that they can publish their build in a static environment. If you feel like you have a great build that isn't anywhere in Discord or the Wiki, or that you wish the Wiki had something better than what it currently has, this page will give you some helpful guidance on how to navigate through a wiki.

If you need detailed instructions on how to start editing Wiki pages, I recommend reading up on how to Edit a Wiki Page and how to Start a New Wiki Page as this guide will assume that users understand how to edit pages, preview their edits, and publish that page. Note that the stuff in here overrides what is in those pages, so when it doubt, trust this page.

Creating the Page

edit edit source

The quickest way to create a guide is to add a link in an appropriate Guides page (e.g., Guides:Acolyte Builds):

  • Edit the page where your guide link should live.
  • Under any section, add a bullet using an asterisk (*).
  • Name your guide in the Guides namespace (Guides:Example Guide Name).
    • Example: Guides:Example Guide Name
  • Wrap the name in double brackets:
    • Example: [[Guides:Example Guide Name]]
  • Save the page.

The new link will appear in red (a “redlink”): Guides:Example Guide Name. Click it to start editing the new page.

Naming Conventions

edit edit source

It's important for Wiki management to align with standard naming conventions in order to organize and sort pages into their correct locations.

Please make sure that when creating a new guide, always format it as "Guides:Example Name". The colon tells the wiki that these pages belong to the Guides namespace, and this is where all guides will be part of as they are created.

Understanding the Editor

edit edit source

There are two edit modes:

  • Edit (visual): What-you-see-is-what-you-get editing.
    • Pros: Fast for typos, formatting, and template fields.
    • Cons: Some advanced features aren’t available.
  • Edit source (wikitext): Directly edit the page’s source.
    • Pros: Precise control; faster for experienced editors.
    • Cons: Requires familiarity with wikitext; dense pages can be harder to read.

Please use whatever version you are more comfortable with, and you can always ask for help in Discord if you need it, just @Eviand.

Templates and What They Do

edit edit source

Templates are reusable page pieces you can drop into any page. They save time by handling the fancy formatting for you—you just fill in the fields.

Option 1: Visual Editor (recommended)

edit edit source

Use this if you prefer forms and buttons.

Editing a template in Visual Editor

To insert a new template

  1. Click Edit at the top of the page (not “Edit source”).
  2. In the toolbar, choose Insert > Template (puzzle-piece icon).
  3. Search for the template name (for example, ClassInfoBox), then click Add template.
  4. A form opens with fields, examples, and short descriptions. Fill in what you know.
  5. Click Insert (or Apply changes), then Publish changes.

To edit an existing template on the page

  1. In Visual Editor, double-click the template table/box, or click the small Edit button on it.
  2. Update any fields you want.
  3. Click Apply changes, then Publish changes.

You can leave fields blank as most templates hide empty info automatically.


Option 2: Edit Source (advanced)

edit edit source

Use this if you like wikitext.

A basic insert looks like this:

{{Example Insert
| Example Parameter = Example Value
}}
 

When you save, the wiki turns that block into the styled template.

You can switch between editors any time:

  • In Visual Editor: you can switch in the menu at the top.
  • In Source Editor: click the normal Edit tab next time.

Example (source)

{{ClassInfoBox
| Role    = Melee <br> Poison
| Weapons = Dagger
| STR = 9 
| AGI = 12 
| VIT = 1
| INT = 1 
| DEX = 9  
| LUK = 1
}}
 

Result

Look at the far right, and now you can see the infobox that populates on each class page.

Class Overview
Role Melee
Poison
Weapons Dagger
Attributes
STR 9
AGI 12
VIT 1
INT 1
DEX 9
LUK 1




Tips

  • Using the correct names for things is important, as some fields will try to do fancy things with the text. For example, it may try to link to the database.
  • Use <br/> to add a new line inside a field. This will break up the text, making it look cleaner.
  • If a link shows red, the page title might be misspelled or missing—double-check.

Wiki Headers (Sections)

edit edit source

You can create headings with equal signs around the text:

  • = Level 1 Header =
  • == Level 2 Header ==
  • === Level 3 Header ===
  • ==== Level 4 Header ====
  • ===== Level 5 Header =====

Note that for consistency, try to only use Levels 2 and 3 for most things, as the rest are often overkill, and can make a wiki page a lot more difficult to read and edit. However, go crazy if you feel that it will work!

Example:

== Example Two Level Section ==
Quick description

=== Example Three Level Section ===
Another quick description
 
edit edit source

Link to other pages with double brackets:

Link to a section with a hash:

Change the displayed text with a pipe:

Combine section + custom text:

  • [[Example#Example Level 2 Section|My new name!]]
  • Renders as: My new name!

Add an image (with a 15px width):

  • [[File:FireIcon.png|15px]]
  • Renders as:

List of Pre-made Image Icons

edit edit source

Here is a full list of all the icons you can use in your text, along side a link to each section. Just copy and paste any of these into your page to make your words and images stand out!

Attributes

[[File:Strength.png|15px]] [[Attributes#Strength_(STR)|STR]]
[[File:Vitality.png|15px]] [[Attributes#Vitality_(VIT)|VIT]]
[[File:Dexterity.png|15px]] [[Attributes#Dexterity_(DEX)|DEX]]
[[File:Agility.png|15px]] [[Attributes#Agility_(AGI)|AGI]]
[[File:Intelligence.png|15px]] [[Attributes#Intelligence_(INT)|INT]]
[[File:Luck.png|15px]] [[Attributes#Luck_(LUK)|LUK]]
 

How it looks when on a page:

Elements

[[File:FireIcon.png|15px]] [[Elements#Fire|Fire]]
[[File:WaterIcon.png|15px]] [[Elements#Water|Water]]
[[File:EarthIcon.png|15px]] [[Elements#Earth|Earth]]
[[File:WindIcon.png|15px]] [[Elements#Wind|Wind]]
[[File:ShadowIcon.png|15px]] [[Elements#Shadow|Shadow]]
[[File:PoisonIcon.png|15px]] [[Elements#Poison|Poison]]
[[File:UndeadIcon.png|15px]] [[Elements#Undead|Undead]]
[[File:HolyIcon.png|15px]] [[Elements#Holy|Holy]]
[[File:NeutralIcon.png|15px]] [[Elements#Neutral|Neutral]]
 

How it looks when on a page:

Linking to the Database

edit edit source

You can link an item directly from the database by using a special WikiLink called an external link.

In order to find items, please use the following link to directly access the database: https://spiritvale.info/

[https://www.example.com Example]
 

Which will then look like this: Example

edit edit source
  1. Find the page that you wish to link to, and copy the URL at the top.
    1. https://spiritvale.info/equipment/tome-of-the-first-hymn
  2. Add the brackets to each side of the URL.
    1. [https://spiritvale.info/equipment/tome-of-the-first-hymn]
  3. Add a space at the end, and then put in the name of the item.
    1. [https://spiritvale.info/equipment/tome-of-the-first-hymn Tome of the First Hymn]

If done correctly, you will have a like will look and function like this: Tome of the First Hymn