Toggle search
Toggle menu
58
161
6
1.3K
SpiritVale Wiki
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
More actions
← Older editNewer edit →
VisualWikitext
No edit summary
No edit summary
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.


Line 12: Line 11:


== 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 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:Your_Guide_Name</nowiki>).
* Under any section, add a bullet point by using an asterisk (*<nowiki />)
** Example: <nowiki>Guides:Special_Setup_of_Gear</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:Special_Setup_of_Gear]]</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:Special Setup of Gear]]. 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.


Line 34: Line 29:


== 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 components that you “transclude” (which is a fancy word for "insert directly into a page") into another page. This lets you reuse complex formatting with simple parameters.


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.
A basic insert looks like this:
 
  <nowiki>{{Example Insert
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!
| Example Parameter = Example Value
 
}} </nowiki>
The insert looks like this:
 
  {Example Insert
| Example Parameter = Example Value
|}


This will check for a template page called "Example Insert", and then you're more than welcome to fill in all the values. When you "Save changes" the insert transforms into the template, and automatically fills out all the empty fields.
This will check for a template page called "Example Insert", and then you can fill in all the values. When you "Save changes" the insert transforms into the template, and automatically fills out all the empty fields.


It allows the creation of fancy tables like this, without any programming skills.
It allows the creation of fancy tables like this, without any programming skills.


This:
Example:


  <nowiki>{{ClassInfoBox
<nowiki>{{ClassInfoBox
| Role = Melee <br> Poison
| Role = Melee <br> Poison
| Weapons = Dagger
| Weapons = Dagger
Line 73: Line 64:
| DEX = 9
| DEX = 9
| LUK = 1
| LUK = 1
  }}</nowiki>
}}
 
</nowiki>
turns into that ------>
→
 
{{ClassInfoBox
{{ClassInfoBox
| Role = Melee <br> Poison
| Role = Melee <br> Poison
| Weapons = Dagger
| Weapons = Dagger
| STR = 9
| STR = 9
| AGI = 12
| AGI = 12
| VIT = 1
| VIT = 1
| INT = 1
| INT = 1
| DEX = 9
| DEX = 9
| LUK = 1
| LUK = 1
}}
}}






You can also use the normal edit function to directly edit a table. Simply doubleclick on any inserted template, and a popup box will show up that will let you enter in all the individual fields (click to expand):
You can also use the normal edit function to directly edit a table. Simply doubleclick on any inserted template, and a popup box will show up that will let you enter in all the individual fields:


[[File:Edit Template Example.png|250px]]
[[File:Edit Template Example.png|250px]]


== Wiki Headers (Sections) ==
== Wiki Headers (Sections) ==
 
You can create headings with equal signs around the text:
Wikis organize page information by putting things into headers, which are done by using the Equal Sign (<nowiki>=</nowiki>) surrounding a word or a line of text.
 
Example: <nowiki>== Level 2 Header ==</nowiki>
 
You can create different levels of headers by adding an additional set of equal signs, all the way to five levels:


* <nowiki>= Level 1 Header =</nowiki>
* <nowiki>= Level 1 Header =</nowiki>
Line 110: Line 95:
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!
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!


An example section would be:
Example:
<nowiki>== Example Two Level Section ==
Quick description


== Example Two Level Section ==
=== Example Three Level Section ===
Quick description
Another quick description
 
</nowiki>
=== Example Three Level Section ==
Another quick description


== Adding Images and Links ==
== Adding Images and Links ==
 
Link to other pages with double brackets:
For making your guides pop out, it's a good idea to become familiar with how to use both images and links to other pages, including directly to the database.
 
To pull up another page, you would simply put the page name in double brackets:
 
* <nowiki>[[Example]]</nowiki>
* <nowiki>[[Example]]</nowiki>
* [[Example]]
* Renders as: [[Example]]
 
If you need to link to a specific section, you can call out that section by using the Number Sign (<nowiki>#</nowiki>) with the name of the section:
 
*<nowiki>[[Example#Example Level 2 Section]]</nowiki>
* [[Example#Example Level 2 Section]]


You can change how the text looks by adding a Pipe Sign (<nowiki>|</nowiki> and before the closing brackets:
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>
* <nowiki>[[Example|My new name!]]</nowiki>
* [[Example|My new name!]]
* Renders as: [[Example|My new name!]]
 
You can also combine all of that into a single link:


Combine section + custom text:
* <nowiki>[[Example#Example Level 2 Section|My new name!]]</nowiki>
* <nowiki>[[Example#Example Level 2 Section|My new name!]]</nowiki>
* [[Example#Example Level 2 Section|My new name!]]
* Renders as: [[Example#Example Level 2 Section|My new name!]]
 
Finally, you can add an image before your link, especially if you want it to pop out. If doing this via text, make sure to use the Pipe Sign and add in a pixel (px) limit of 15:


Add an image (with a 15px width):
* <nowiki>[[File:FireIcon.png|15px]]</nowiki>
* <nowiki>[[File:FireIcon.png|15px]]</nowiki>
* [[File:FireIcon.png|15px]]
* Renders as: [[File:FireIcon.png|15px]]


==== List of Premade Image Icons ====
==== 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!
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'''
'''Attributes'''
  <nowiki>
  <nowiki>
[[File:Strength.png|15px]] [[Attributes#Strength_(STR)|STR]]
[[File:Strength.png|15px]] [[Attributes#Strength_(STR)|STR]]
Line 162: Line 138:
  </nowiki>
  </nowiki>


How it looks when on a page:
* [[File:Strength.png|15px]] [[Attributes#Strength_(STR)|STR]]
* [[File:Strength.png|15px]] [[Attributes#Strength_(STR)|STR]]
* [[File:Vitality.png|15px]] [[Attributes#Vitality_(VIT)|VIT]]
* [[File:Vitality.png|15px]] [[Attributes#Vitality_(VIT)|VIT]]
Line 181: Line 158:
[[File:HolyIcon.png|15px]] [[Elements#Holy|Holy]]
[[File:HolyIcon.png|15px]] [[Elements#Holy|Holy]]
[[File:NeutralIcon.png|15px]] [[Elements#Neutral|Neutral]]
[[File:NeutralIcon.png|15px]] [[Elements#Neutral|Neutral]]
  </nowiki>
  </nowiki>


How it looks when on a page:
* [[File:FireIcon.png|15px]] [[Elements#Fire|Fire]]
* [[File:FireIcon.png|15px]] [[Elements#Fire|Fire]]
* [[File:WaterIcon.png|15px]] [[Elements#Water|Water]]
* [[File:WaterIcon.png|15px]] [[Elements#Water|Water]]
Line 194: Line 171:
* [[File:NeutralIcon.png|15px]] [[Elements#Neutral|Neutral]]
* [[File:NeutralIcon.png|15px]] [[Elements#Neutral|Neutral]]


 
== Guide-Specific Section ==
 
This section explains how to approach different kinds of guides.
== Guide Specific Section ==
 
This section will provide some guidance and input on how best to create different types of guides. Feel free to read up if you're looking to create a guide.


=== Class Build Guides ===
=== Class Build Guides ===
Class build guides focus on a core mechanic or unique playstyle for a class. They offer alternative ways to play and add variety to the game.


Class build guides are specific guides built around a core or unique mechanic around a class. They are often provide players with alternative ways to play a class, and provide a diversity of different play styles.
Create your build in the appropriate class page:
 
First, you should make your guide in one of the Class Build namespaces below:
 
* [[Guides:Warrior Builds]]
* [[Guides:Warrior Builds]]
* [[Guides:Knight Builds]]
* [[Guides:Knight Builds]]
Line 214: Line 186:
* [[Guides:Acolyte Builds]]
* [[Guides:Acolyte Builds]]


Once there, add in the name of your new guide, and begin editing it.
Add your guide link there, then open it and start editing.


Here is a list of already to go templates: just insert these into your new page, and you'll be able to spin up any guide you want.
Here are two ready-to-use templates (click to expand, copy the contents):


<div class="toccolours mw-collapsible mw-collapsed" style="width: 500px; overflow:auto;">
<div class="toccolours mw-collapsible mw-collapsed" style="width:100%; max-width:650px; overflow:auto;">
<div style="font-weight:bold;line-height:1.6;">Leveling Template</div>
<div style="font-weight:bold; line-height:1.6;">Leveling Template</div>
<div class="mw-collapsible-content">
<div class="mw-collapsible-content">


<nowiki>
<nowiki>
<noinclude>[[Category:Guides]]</noinclude>
<noinclude>[[Category:Guides]]</noinclude>
{{Template:PageHeader
{{Template:PageHeader
Line 577: Line 549:
== Tips and Tricks ==
== Tips and Tricks ==
Content here.
Content here.
 
</nowiki>
</nowiki>
</div></div>
</div></div>


 
<div class="toccolours mw-collapsible mw-collapsed" style="width:100%; max-width:650px; overflow:auto;">
<div class="toccolours mw-collapsible mw-collapsed" style="width: 500px; overflow:auto;">
<div style="font-weight:bold; line-height:1.6;">Specialized Build Template</div>
<div style="font-weight:bold;line-height:1.6;">Specialized Build Template</div>
<div class="mw-collapsible-content">
<div class="mw-collapsible-content">


<nowiki>
<nowiki>
<noinclude>[[Category:Guides]]</noinclude>
<noinclude>[[Category:Guides]]</noinclude>
{{Template:PageHeader
{{Template:PageHeader
Line 698: Line 668:
|ArtifactModifier=
|ArtifactModifier=
}}
}}
 
</nowiki>
</nowiki>
</div></div>
</div></div>
Retrieved from "https://spiritvale.info/wiki/Guides:Eviand%27s_Wiki_Guide_Creation"