Wiki Utils

Tools and utilities for use in constructing wiki content

Contributing to the New TARDIS Mod Wiki

What am I allowed to contribute?

You are free to contribute anything to to the New TARDIS Mod Wiki, including new articles, image renders, changes to existing articles and more.

How do I contribute?

First, sign up for a BookStack App Account.

This wiki is managed through the use of the BookStack App but the account information will be held in a secure database hosted by one of our team members.

The sensitive information in this database won't be shared to any third party.

Wiki Account Setup

Creating a BookStack App Account
  1. Click the Sign Up button on the top right hand side of this website.
    1. 1_sign_up.png
  2. You will need to provide a Username, Preferred email address and Password. This information will be confidental and will not be released to the public.
  3. For security reasons, we currently only allow Gmail, Outlook/Hotmail and Yahoo email accounts to be used for signing up.
    1. 2_sign_up_new.png
  4. When you successfully register, you will need to confirm your email address. This can be done by logging in.
    1. 4_login.png
  5. Once logged in, a button will appear asking you to check your email for a confirmation link. You can also request a new confirmation link to be send to your account's email.
    1. The confirmation email may be sent to your email's Spam category.
    2. 5_confirm.png
  6. Check the email provider is "noreply@tardis-mod.com". 
    1. 6_confirm_1.png
  7. Click the Confirm button the email, or use the provided link
    1. 6_confirm_2.png
  8. You have now created an account for the Tardis Mod Wiki!
Modifying your Bookstack Account Details
  1. To edit your account details such as email, password and name, first sign in with your account if you have not already
  2. Click your profile at the top right hand corner
  3. Select "Edit Profile"
    1. image-1588810182697.png
  4. Make any changes you need
  5. Press "Save" at the bottom of the screen
    1. 8_save_changes.png

Gaining the Editor Role

To publish and make changes to articles on the Wiki, your account needs the Editor role on the wiki. Without it, you can only view pages.

To gain the Editor role, you need to do the following:

  1. Create an article or make changes to existing articles. To make changes to an existing article, you need to copy paste the current version of the webpage to an external editor and make your changes there.
  2. Share the document with one of the mod authors for review using a shareable link. 
    1. This approval is only required for the first article you create/edit. 
    2. Please use the Discord server or use Discord direct messages to share your article.  
  3. If the article is approved, you will be notified of your article's approval via Discord Private message.
  4. Your account will be granted access to the Editor Role, and you may publish your article to the live site.
  5. Make sure to follow the Wiki Documentation Guidelines when you publish to the live site.

This submission system is temporary until a better one can be implemented.

Article Guidelines

These guidelines outline the requirements your proposed article must meet in order to gain the Editor Role, as outline earlier.

  1. Article must be created externally, not on the Wiki.
  2. Articles must be able to be shared with the mod authors, preferably via a sharing link. You may use Cloud Storage platforms such as Google Docs, OneDrive or Dropbox. 
    1. If you use this ensure to sign in with your preferred email and not your work/school email. We wouldn't want to gain access to your personal details and we're sure you wouldn't want us to either.
  3. Articles must follow the Wiki Documentation Guidelines. You are free to use your own writing and formatting style, but these basic guidelines should be kept in mind.

Are there existing Wiki Resources?

Yes, see the Wiki Utils Book.

There are Templates you can use for writing your articles

You can also see how the wiki is currently setup in the Style Guide.

Again, feel free to create your own style of writing, the above links are just a guide if you don't have ideas on what do to.

Other Questions

Feel free to contact the mod authors via the Discord server if you have any further questions on contributing to this Wiki.

Wiki Documentation Guidelines

The Tardis Mod wiki allows any user to edit its wiki, provided they are granted the Editor role. The following guidelines need to be followed by editors to ensure the wiki content is well organised and consistent.


Wiki Articles

Article Content

Clarity and Expression

As a public documentation, this wiki needs to be written with clear and precise language, so anyone who has a basic grasp of the language this Wiki uses (currently only English) can understand it.

Grammar, Spelling and Punctuation

Correct grammar, spelling and punctuation for the page's language is required.

Bias, Accuracy and Appropriate Language

As readers of all ages can access this document, the language used in the articles must be made to a fairly high standard.

Accuracy

The information provided in the articles must be accurate in portraying how a particular feature is used and behaves. Please contact the mod authors via the Discord server if clarification about a feature is needed.

Bias

The information presented must also be as neutral as possible. This means personal opinions of a feature should not be written into a page edit.

Appropriate Language

As a public document designed to document a Minecraft Mod, this wiki does not support other discussions to be published, such as vulgar language, political opinions or misinformation about the mod. 

A general suggested guideline is aiming for articles to be appropriate for children over the age of 13 to read. 

Drafting and Publishing

Create drafts externally

We recommend you create drafts of your articles on another platform such as a cloud sharing platform such as Google Docs or Word Online. This is to ensure that you won't accidentally publish your changes live. It also allows you to proofread your work before you publish it.

Formatting Clean-Up

When you are satisfied with your work, you can paste it to the Wiki page editor. You will notice that the formatting may be different to what you originally setup. This is because the Wiki's editor uses formatting to the one you were using to draft the article. 

Therefore, make sure you make changes to your pasted content until your are satisfied.

Changelogs

Before you publish your page, please provide a changelog message. This changelog message should be short and concise and include what was changed.

The reason why this is recommended is because the wiki's current application, Bookstack App, does not have a comphrehensive version control system. It currently only allows users to overwrite the latest version of a page.

Therefore, a changelog allows wiki administrators to see what has changed, If something went wrong, they can easily fix it by using the changelog message of an article as a reference.


Wiki Structural Changes

General Conventions

You are free to make new articles and chapters, and sort existing books. 

However, if you would like to create a new Book, Shelf or Chapter, please contact one of the mod authors or wiki administrators for advice. Contributors to the wiki are recommended to follow BookStack App's document conventions of organising its content if you do want to change the structure.

Locked Content

Some parts of the wiki, such as the Home Book are intended to only be edited by the mod authors and require you to ask for permission to change. 

Please do not modify any of the following content without first gaining permission by the mod authors:

  1. Home Book
  2. Wiki Utils Book

If you feel there is a change that needs to be made, please contact them via the Discord Server. Please specify what you think needs to be changed, and reasons for doing so. 

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
Templates

Template:Item

A template and guidelines to creating articles about Tardis Mod Items. This article is subject to change.

For an example on this page, see the existing pages in Items.


Introduction (Do not include this heading)

Brief description


Crafting Recipe/Acquisition

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

Crafting Recipe – used if crafting recipe is one of the ways to obtain item

Name

Ingredients

Recipe [Type]

 

Alphabetical Order

·       [Quantity] x [Ingredient]

Screeenshot

Type = Shaped (Position of items matter), Shapeless (Any arrangement), Fixed Recipes (Fixed arrangement)

Acquisition

Used if the item has no crafting recipe or if it has both crafting recipe and other ways to obtain it.

Use sub headings if the item has multiple obtaining methods and make crafting recipe a sub heading of Acquisition if there is one present.

Uses

Any uses

Usage

How the block is used

Use sub headings for sub topics


 

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

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

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 item is present, the main variant will also be included in this gallery as the first image

 


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

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.

 

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.

Style Guide

Creating Wiki Assets

This article showcases the current methods used to standardise and maintain quality control of assets used across the wiki. Assets can include image renders of items, blocks or entities and more.


Extraction of Mod Assets

In order to provide renders of the mod's assets, the original model and texture files must be obtained. All assets are readily available through the GitLab Repository within the subfolder src/main/resources/assets/tardis.

An exception to this are Entity models. These models are only available through contacting the mod authors.


Images

Blocks

Image renders of blocks featured in the Tardis Mod use Third Angle Orthogonal Views to display the block. It can entail the use of Blockbench or Blender along with the extraction of mod assets from the Gitlab Respository.

An example render is the below image render of a Wooden Roundel.