NMS:Wiki Reference

From STEP Modding Wiki
BannerLogo
NMS Wiki Reference

Contents

Introduction

This is a reference for creating new No Man's Sky wiki pages, as well as some helpful information around text formatting and available templates.

There are a few necessary steps when creating a new page.
No worries, they're easy! It looks like a lot of steps below, but the information is simply providing a lot of detail to ensure clarity.

Where to Create Pages

It's important to create pages with the correct URL structure to help maintain organization of the content.
To identify NMS pages from wiki pages of other games, all the NMS page must start with the same namespace : wiki.step-project.com/NMS:.


Next, users should determine the type of content that is being added. Is it a tutorial? A modding tool? A game file ? Something else?

  • Tutorials should use this URL structure: wiki.step-project.com/NMS:Tutorials/PageName
  • Modding Tools should use this URL structure: wiki.step-project.com/NMS:Modding_Tools/PageName
  • Game Structure should use this URL structure: wiki.step-project.com/NMS:Game_Structure/PageName
  • For any other content : wiki.step-project.com/NMS:PageName

Note that pages can remain or be moved (sorted) later, when necessary.

Creating a New Page

Side Notes

Magic Words

__NOTITLE__ required
This one is required to maintain the theme. It prevents the page title from being displayed at the top of the page, which is auto-placed by default.
__NOTOC__ optional
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.

Opening / Closing Templates

For the time being, the "theme" for NMS is managed and implemented using templates. These are required for the theme to work correctly.

Controlling the TOC

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

To create a new page:

  1. Copy and paste one of the URL structures from above
  2. Change PageName to the name of page being added (must be unique/can't already exist), and hit Enter/Return on your keyboard.
  3. Users will be presented with a page stating the content doesn't exist and a couple options. Select, the edit this page link.
  4. Users will be taken to the editor for content creation.


Once at the editor, there are a few things that must be included for the NMS theme to work correctly.
Here is the template for a standard page that you can copy/paste in the editor of your new page :

__NOTITLE__
{{NMSPage|contentTitle=PageTitle}}
[[Category:No Man's Sky]][[Category:NMS-Tutorial]]
{{TOC_right}}
== HeaderText ==

Page content here...

{{NMSPageClose}}

Here are more informations about each line :

  • Magic Words : __NOTITLE__ & __NOTOC__ control specific wiki features. See Side Notes.
  • NMSPAge Opening Template : This places the top half of the theme. The contentTitle value is the title of the page, placed in the themed header at the top. If no value is provided, PageName Magic Word will be used.
  • Categories : Add appropriated categories so that page will be sorted for users. The No Man's Sky category should always be added, then followed by the appropriate sub-categories. See the Category Reference for a list a available categories.
  • Table of Contents (TOC) : If the TOC isn't desired, skip this step and ensure the __NOTOC__ Magic Word is included, see Side Notes.
  • Content : Your content. It is highly recommended to begin any content with a level two heading: == HeaderText ==
  • NMSPageClose Closing template : This places the bottom half of the theme. Without it, the theme would be broken.

Linking Pages

You can link pages and display them either in the current explorer tab or into a new explorer tab.

To link a page and display it in the current tab, use double brackets, the local url, a vertical dash and the name displayed :

Example: [[NMS:Tutorials|Show Tutorials in the current tab]]
Result: Show Tutorials in the current tab


To link a page in a new tab, use single brackets, the full url, a space and the name displayed :

Example: [https://wiki.step-project.com/NMS:Tutorials Show Tutorials in a new tab]
Result: Show Tutorials in a new tab

Content Formatting

General formatting rules

For the whole rules you can use to format your page, please check This Content Formatting page


Avoid auto parsing

Sometimes the wiki will parse text into code that isn't desired to be parsed. This can be overcome a few different ways.

  1. No parsing, standard text : use <nowiki></nowiki> tags.
    nowiki tags will tell the parser to output whatever is between the tags as plain text. This is handy to print out markup on the page.
    Example: <nowiki><div style="color:#EEE;">My text is colored #EEE!</div></nowiki>
    Result: <div style="color:#EEE;">My text is colored #EEE!</div>
  2. No parsing, citation of a single line of text : Use <code>TextHere</code> tags.
    Code tags will envelop text within preformatted text.
    Example: <code>TextHere</code>
    Result: TextHere
  3. No parsing, citation of multiple lines of text, no markups : Use <pre></pre> tags.
    Preformatted tags will block out the text between them on the page, exactly as inputted (including spacing).
    Result:
            <Property value="TkSceneNodeAttributeData.xml">
              <Property name="Name" value="MATERIAL" />
              <Property name="AltID" value="" />
              <Property name="Value" value="MATERIALS/LIGHT.MATERIAL.MBIN" />
            </Property>
  1. No parsing, citation of multiple lines of text, with markups : Just be sure each of your lines start with a space.
    Any line of text starting with a space will be indented as copied and you keep any markup or content formatting ability.
    Result:
           <Property value="TkSceneNodeAttributeData.xml">
             <Property name="Name" value="MATERIAL" />
             <Property name="AltID" value="" />
             <Property name="Value" value="MATERIALS/LIGHT.MATERIAL.MBIN" />
           </Property>


Link page sections

For links, you can link subtitles directly.
All you have to do is adding # to your page url and the exact name of the subtitle (check Uppercases !), replacing spaces with _
IE : To access home page Getting Started section, simply add #Getting_Started to home page url.

Useful Templates

Images

Images can be included in a multitude of way as extensively described here.
But users can also easily include them with a template that creates a stylized instance of an image on the page.


GallerySimple Template 
Code: {{GallerySimple|id=galleryID|width=250|img=(Image:UploadedImage)|caption=UserText}} {{clear}}
or
Code: {{GallerySimple|id=galleryID|width=250|img=(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 code for an Uploaded Image:
{{GallerySimple|id=ImageSet1|width=144|img=Image:Explorer_2017-08-17_15-49-40.png|caption=Do this now!}} {{clear}}
Example code for an URL:
{{GallerySimple|id=ImageSet1|width=144|img=https://i.postimg.cc/4yR0dMSR/SWTOR-Guide-Logo.png|caption=Star Wars!<br>wait...wrong wiki...}} {{clear}}
Do this now!

Do this now!
Star Wars!<br>wait...wrong wiki...

Star Wars!
wait...wrong wiki...

Custom colors

When you need to highlight some text, it could be handy to only change its color. This can be done with the fc template :

Code: {{fc|YourColor|YourText}}
The color variable accepts any CSS-accepted value (e.g. #FFF, #FFFFFF, white, RGB(255,255,255)

Actually, the 2 main highlight color used on the NMS wiki are :

  • white #FFF
  • reddish #F88


Custom Tags

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

Code: {{CustomTag|color=ColorHere|tag=UserTextHere}}
The color variable accepts any CSS-accepted value (e.g. #FFF, #FFFFFF, white, RGB(255,255,255)


Exemples

This is some info Info!

Code: {{CustomTag|color=RGB(255,255,255)|tag=Info!}}

How about a warning next time! Warning

Code: {{CustomTag|color=red|tag=Warning}}

Is this thing new or old? New!

Code: {{CustomTag|color=#b1a9f1|tag=New!}}


Lists

You can use at least 2 kind of lists :

Dots
If you want a list where each line is preceded with a dot, use a * before your lines :
Code: * first line
Code: * second line
  • first line
  • second line


Numbers
To make each line preceded with an incremented number, use a # before your lines
Code: # first line
Code: # second line
  1. first line
  2. second line

Notices

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

Notice Small
Code: {{Notice Small|text=UserTextHere}}
Info-Logo.png      Notice:This is useful


Notice
Code: {{Notice|text=UserTextHere}}
Info-Logo.png Notice: This is VERY useful

Warnings

For very important notices, you can use either of the 2 warning templates

Warning Small
Code: {{Warning Small|text=UserTextHere}}
Warning-Logo.png      Warning:This is important


Warning
Code: {{Warning|text=UserTextHere}}
Warning-Logo.png Warning: This is VERY important