Wiki Utils

Tools and utilities for use in constructing wiki content

Templates

Sample page structures for use in creating wiki pages

Templates

Template:Block

[Name of block in Title]

Introduction

E.g.

{@https://tardis-mod.com/books/blocks/page/steady-state-microwelding-station}

 

Details

Sample Headings

Crafting Recipe/ Acquisition
Functions/Abilities
Usage
Trivia

Conclusion

[WIP] Version History

 

Templates

Tables:Crafting Recipe

Template and specifications used in Crafting Recipes

Template

Name Ingredients Recipe
[Name of Block]
  • [Amount] x [Item]
  • Items must be ordered alphabetically

Image of recipe

 

Specifications

Name of Block

Capital case letters for Proper nouns E.g. Steady State Microwelding Station.

Lower case letters for non-proper nouns E.g. Elixir of Life.

Ingredients

Format: [Amount] x [Item]

E.g. 2 x Ender Pearl

Recipe

Use screenshot of JEI recipe.

Size of image:

  1. Crop JEI recipe to the crafting grid. Should be 372 (w) x 186 (h) px in image editing software. E.g. Paint.net
    1. template.crafting.recipe-crop.PNG

      Figure 1 - Crop image until borders of crafting grid

  2. When insert into wiki, use the image properties tool to reduce size to 248 (width) x124 px (height). Make sure the "Constrain Properties" box is ticked
    1. template.crafting.recipe-insert-adjust.PNG

      Figure 2 - The Image Properties button when an image is inserted into the wiki

    2. template.crafting.recipe-insert-adjust-box.PNG

      Figure 3 - Image adjustment boxes highlighted in Image Properties Window.

  3. This ensures the recipe image is as clear enough for easy viewing without breaking formatting for mobile users.

Formatting

Usage

Formatting

  1. Shrink the each table column width to fit the text inside comfortably. Make sure the Recipe column does not shrink or expand the image when resizing the column or leave excess space before or after the column
    1. template.crafting.table-formatting.png
  2. Fixing long table (text appears shifted downwards
    1. template.crafting.table-formatting-text.png
Templates

Template:Entities

A template and guidelines to creating articles about an entity. This article is subject to change.

Introduction (Do not include this heading)

Brief description

Attributes

AI Behavior

Any AI behaviour that is unique to the entity

A sub-heading is included for variant-specific behaviour if there is any present. If not, all variants will inherit the same AI behaviour.

If an image or video is required to explain the behaviour, they may be attached within this heading if it is relevant and succinct. Any unnecessary media should be placed in the Gallery section.

Variants

If the entity has unique variants, such as different aesthetics, behaviour or alternate variants they will listed. If there are no unique variants, this heading can be omitted.

Spawn Behavior

Includes the Dimension, Biome, Number of entities per spawn pattern

Drops

Min. Number - Max. Number x Item

gallery-entity.PNG
Figure 1 - An example of a gallery section for entities. All images are presented in a table. The main variant is placed first. Each image has its own label and caption

Any additional image that is not relevant to main article such as alternate angles, behaviour states etc.

Each image will be presented in a table, with one cell for the image and a cell below. The cell below will contain a caption and label to clarify what the image is.

If multiple variants of the entity is present, the main variant will also be included in this gallery as the first image

A horizontal line is included on the same line as this heading to separate it from the main article.

Trivia

An optional dot point or numbered list of features that are not relevant to the main article, but make for unique insights.

A horizontal line is included on the same line as this heading to separate it from the main article.

Notes

An optional numbered list of features or extra detail that do not fit in the main article but are useful to the reader. this is generally the last heading in an article.

Again, a horizontal line is included on the same line as this heading to separate it from the main article.

Any part of the article that mentions a specific note will use a superscript number to refer to a specific note.

Example 1:

Main article extract: The quick brown fox has a tail1.

Notes

  1. The tail is a light orange colour

Style Guide

A set of guidelines used by the wiki in the writing of its articles

Style Guide

Formatting

This article explains the writing style of this wiki and provides a guideline for both existing and future articles. The contents of this article is subject to change.

General articles

Headings

In most articles such as entity, item, block articles, the Medium heading is used for main sections such as crafting recipes. Small headings are used as sub-headings, while Tiny headings for sub-sub headings. 

All heading types (Large - Tiny) will be visible in the 'Page Navigation' panel of the page (left hand side) so it is recommended to use the headings sparingly and with justified purpose.

Formatting

Bold, Italics, Underline

If further sub-headings are required, such as for extra detail, but are not important as to be featured on the Page Navigation panel, text formatting such as bold, italics and underline is recommended.

The heirachy used is intended for ease of reading and can be changed depending on the content created and the heading's importance.

  1. Bold
  2. Underline
  3. Italics

A combination of the above formatting types can be used more flexibly such as using bold italics to highlight a certain phrase, the use of bold  to highlight a pronoun or italics to highlight proper nouns of a reference E.g. (Doctor Episode Name)

Bookstack Formatting

Bookstack, the software on which this wiki is hosted on, has unique formatting such as:

Block Quote

CodeBlock (Used for custom scripts or programs)

Inline Code

Callouts

These formatting types can be used in a flexible manner across different writing styles. In this wiki however, the general usage for the formatting is as followings:

  1. Inline Code: Commands
  2. Info : Information - extra detail.
  3. Warning: Highlighting the removal/disabling of a feature
  4. Danger: Highlighting unpatched bugs or issues with a feature

Tutorials

Tutorial articles are often longer and more detailed than most articles, so a wider variety of headings are used in these articles.

When using multiple headings, the WYSIWYG (What You See Is What You Get) editor has the following default styles:

template.headings-default.PNG

Figure 1 - Default WYSIWYG edit Heading styles

In tutorial articles, Small and Tiny Headers will often look similar, so one method used is to use Bold and Italics on the Small Header to distinguish it more easily from Tiny Header. The Tiny Header is left with default settings.

Example 1:

template.headings-tutorial.PNG

Figure 2 - Use of Bold and Italics in Tutorial article Headings. Here, the small header uses Bolds + Italics while Tiny Header is left with default settings.