Wikidot provides you with the ability to import another page's source code into your current page, and change variables within it. This is done using a Includes. You can even include pages from other wikis. This becomes very useful when you are re-inserting very similar code on multiple pages.
This wiki utilizes Includes throughout it's pages. Below you will find a comprehensive list of Includes available, along with examples of their use.
Utility or Maintenance Includes
Several Includes exist to facilitate the operation and maintenance of the wiki. These are listed below, along with guides for their intended function.
Incomplete Alert Box
For use when a page or section of a page is incomplete. Particularly useful for clarification when a page or specific section of a page has content that appears definitive, but is in fact still unfinished. The source code below, should be placed at the top of the page, or section being referenced, above any other content.
Example
This {$type} is incomplete, because {$reason}. Please help to improve it, or discuss the issue by clicking the Discuss button at the bottom of this page.
Variables
This template takes the following variables:| Variable | Default? | Description/Context |
|---|---|---|
| {$type} | page | "page" or "section", outputs "This $type is incomplete" |
| {$reason} | omitted | the reason for adding the tag, it will output ", because $reason" |
Source
[[include inc:incomplete
| type=page
| reason=a reason goes here
]]
Locked Page Alert Box
For use when a page has been locked to protect against editing. Particularly useful when a page contains sensitive content that only an Admin should change or has been the target of vandalism. The source code below, should be placed at the top of the page, or section being referenced, above any other content.
Example
This page is locked, because {$reason}! If you'd like to discuss the issue click the Discuss button at the bottom of this page.
Variables
This template takes the following variables:| Variable | Default? | Description/Context |
|---|---|---|
| {$reason} | omitted | the reason for adding the tag, it will output ", because $reason" |
Source
[[include inc:locked
| reason=a reason goes here
]]
Link to Full Description
Adds a small line of text offering a link to additional related content. Useful for providing a link to a full page underneath a header of a summary section. It's important to understand that the line of text will be in a smaller font with minimal line-spacing above or below. This formatting is intentional.
Example
for more information see: urlVariables
This template takes the following variables:| Variable | Default? | Description/Context |
|---|---|---|
| {$url} | input required | the URL to link to. This may be internal or external, and may include anchor tags. |
Source
[[include inc:link-to-full
| url=url-goes-here#anchors-ok
]]
Spoiler Box
For use when a page contains spoilers that you want to hide from the viewer. Provides a button to toggle the hiding and showing of spoiler content.
Example
{$spoiler}
Variables
This template takes the following variables:| Variable | Default? | Description/Context |
|---|---|---|
| {$float} | none | left, right, or omitted for full width. |
| {$uid} | 0 | A unique identifier. Numbers or basic A-Z alpha characters only. No symbols or you'll break your spoiler box. This is necessary on page where you have multiple spoiler boxes, otherwise clicking the show button will reveal all spoilers on the page. |
| {$name} | SPOILERS!!! | The text for the toggle button. |
| {$spoiler} | omitted | the spoiler to hide/show, it will output in full |
Source
[[include inc:spoiler
| uid=1
| spoiler=spoiler goes here
]]
Ship of Heroes Includes
These includes facilitate the display of archetypes, npc characters, and zones. All Ship of Heroes Includes are prefixed with soh-.
Archetype Box
The Archetype Box facilitates the display of Archetypes for Ship of Heroes. It features several options, and can be floated or appear full width.
Example
Name{$fluff}
| Primary: | {$pri} |
| Secondary: | {$sec} |
| Inherit: | {$inh} |
| Hitpoints (base/max): | {$hpbase} / {$hpmax} |
Primary Power Pool:
- {$powers1}
Secondary Power Pool:
- {$powers2}
Ancillary Powers:
- {$powers3}
Modifiers:
{$modifiers}
Limits:
{$limits}
Variables
This template takes the following variables:| Variable | Default? | Description/Context |
|---|---|---|
| {$float} | omitted | left, right, or omitted for full width. |
| {$name} | omitted | The Name of the archetype. |
| {$fluff} | omitted | A brief piece of fluff text. |
| {$icon} | default icon | Tanker, Brawler, Enhancer, Devastator, Controller, Commander |
| {$pri} | unknown | Primary role or function. |
| {$sec} | unknown | Secondary role or function. |
| {$inh} | unknown | Inherited abilities. |
| {$hpbase} | omitted | Base Hitpoints. |
| {$hpmax} | omitted | Max Hitpoints. |
| {$powers1} | none | Primary Power Pool. |
| {$powers2} | none | Secondary Power Pool. |
| {$powers3} | none | Ancillary Power Pool. |
| {$modifiers} | omitted | Modifiers to this Archetype's abilities or powers. |
| {$limits} | omitted | Limits to this Archetype's abilities or powers. |
| {$notes} | omitted | Notes or other information. You may use basic Wiki formatting. |
| {$link1url} | omitted | An additional link. |
| {$link1text} | omitted | The text to display for an additional link. |
| {$link2url} | omitted | An additional link. |
| {$link2text} | omitted | The text to display for an additional link. |
Source
[[include inc:soh-archetype
| float=right
| name=Tanker
| fluff=A brief piece of fluff text.
| pri=Defense
| sec=Offense
| notes=They take hits for the team by using their melee powers to taunt enemies into attacking them instead of their more fragile teammates.
| link1url=url-for-link-1
| link1text=Text to link 1
| link2url=url-for-link-2
| link2text=Text to link 2
]]
