NoMansSky:Wiki Reference: Difference between revisions

From Step Mods | Change The Game
Line 76: Line 76:
<nowiki>{{NMSPageClose}}</nowiki>
<nowiki>{{NMSPageClose}}</nowiki>
</pre>
</pre>
== Helpful Links ==
* [https://www.mediawiki.org/wiki/Help:Formatting Content Formatting]


== Useful Templates ==
== Useful Templates ==

Revision as of 18:21, July 29, 2020

Template:TOC right

Introduction[edit | edit source]

This is a reference for the use of the wiki in regards to No Man's Sky (NMS). Below are helpful links, as well as, information regarding creating new pages.

Creating New Pages[edit | edit source]

There are a few necessary steps when creating a new page. No worries, they're easy! But before that, ensure the page is being created with the correct structure.

Where to Create Pages[edit | edit source]

Namespace
All pages created for No Man's Sky should be created within the No Man's Sky namespace. Namespaces separate content on the wiki, and the NMS: namespace designates it as No Man's Sky content.
wiki.step-project.com/NMS:

(Step 1) Opening Magic Words[edit | edit source]

Several Magic Words are available for use that control specific wiki features. They are placed at the top of the document. The following are Magic Words are for consideration:

__NOTITLE__ required
This Magic Word is required to maintain the theme. It will remove the page title from the wiki page, which is auto-placed by default.
__NOTOC__
This Magic Word is optional. Including it will disable the Table of Contents from displaying on the page, which is auto-placed when at least 4 headers are used on the page.
__NOTITLE__

(Step 2) Opening Template[edit | edit source]

For the time being, the "theme" for NMS is managed and implemented using templates. There are two templates that must be included. The first is the opening template, which places the top half of the theme.

Opening template required
Code: {{NMSPage}}
This template must be included at the top of the page following the opening Magic Words

This template has one control parameter, contentTitle, which places the title of the content/page within the themed headers at the top. Code: {{NMSPage|contentTitle=My Super Awesome Guide!}}
This additional parameter is not required, but is highly recommended! If it's not included, it will autofill with the PageName Magic Word.

__NOTITLE__
{{NMSPage}}

(Step 3) Content[edit | edit source]

Controlling the TOC[edit | edit source]

Users can float the Table of Contents (TOC) to the right using a template. Code: {{TOC_right}}

There is one control parameter for this template, limit, which controls the headings depth displayed on the TOC. Code: {{TOC right|limit=#}}

__NOTITLE__
{{NMSPage}}
{{TOC_right|limit=2}}

Users can now fill the page with the content they desire. However, is it highly recommended to begin the content with a level two heading: == HeaderText ==

__NOTITLE__
{{NMSPage}}
{{TOC_right|limit=2}}
== HeaderText ==

(Step 4) Closing Template[edit | edit source]

The second required template is the closing template, which places the bottom half of the theme. Without it, the theme will be broken.

Closing template required
Code: {{NMSPageClose}}
This template must be included at the bottom of the page following the user's content
__NOTITLE__
{{NMSPage}}
{{TOC_right|limit=2}}
== HeaderText ==

User content...

{{NMSPageClose}}

Helpful Links[edit | edit source]

Useful Templates[edit | edit source]

Images[edit | edit source]

Images can be included in a multitude of way. For all the default options see this document. Else, users can include them with a template that creates a stylized instance of an image on the page. This template is explained below:

GallerySimple
Code: {{GallerySimple|id=galleryID|width=250|img=(Image:UploadedImage) or (ImageURL)|caption=UserText}} {{clear}}
This template has several parameters that can be set. See this page to learn what they are and what they accept.
The img parameter accepts URLs (use "direct links"), however, it's recommended to upload the images to the wiki To do so:
  1. On the top navigation bar, hover over TOOLBOX and select [UPLOAD FILE].
  2. Once uploaded, use the image name from the browser's address bar (e.g. wiki.step-project.com/File:Explorer_2017-08-17_15-49-40.png )
Example - Uploaded Image: {{GallerySimple|id=ImageSet1|width=144|img=Image:Explorer_2017-08-17_15-49-40.png|caption=Do this now!}} {{clear}}
Example - URL: {{GallerySimple|id=ImageSet1|width=144|img=https://i.postimg.cc/4yR0dMSR/SWTOR-Guide-Logo.png|caption=Star Wars!<br>wait...wrong wiki...}} {{clear}}

Custom Tag[edit | edit source]

This template creates stylized, superscript text. Its use varies.

Custom Tag
Code: {{CustomTag|color=ColorHere|tag=UserTextHere}}
The color will accept any CSS-accepted value (e.g. #FFF, red, RGB(255,255,255) )

This is normal text. UserTextHere
How about a warning next time! Warning
Is this thing new or old? New!

Notices[edit | edit source]

There are two templates here. Both display notice blocks on page. The Notice template will display a large notice centered on the page. The Notice Small displays a smaller notice and can be used in lists.

Notice
Code: {{Notice|text=UserTextHere}}

Template:Notice

Notice Small
Code: {{Notice Small|text=UserTextHere}}

Template:Notice Small

Template:NMSPageClose