Difference between revisions of "NMS:Wiki Reference"

From STEP Modding Wiki
m (Where to Create Pages)
(Where to Create Pages)
Line 17: Line 17:
 
* '''[[NMS:Tutorials|Tutorials]]''' should use the following URL structure:  
 
* '''[[NMS:Tutorials|Tutorials]]''' should use the following URL structure:  
 
*: <code>wiki.step-project.com/NMS:Tutorials/PageName</code>
 
*: <code>wiki.step-project.com/NMS:Tutorials/PageName</code>
* '''[[NMS:Game_Structure|References]]''' should use the following URL structure:
+
* '''[[NMS:Reference_Guides|References]]''' should use the following URL structure:
 
*: <code>wiki.step-project.com/NMS:Game Structure/PageName</code>
 
*: <code>wiki.step-project.com/NMS:Game Structure/PageName</code>
 
* '''[[NMS:Modding_Tools|Modding Tools]]''' should use the following URL structure:
 
* '''[[NMS:Modding_Tools|Modding Tools]]''' should use the following URL structure:

Revision as of 11:53, August 10, 2020

BannerLogo
NMS Wiki Reference

Contents

Introduction

This is a reference for creating new pages on the wiki in regards to No Man's Sky (NMS), 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. However, before a new page is created, lets ensure the page is being placed within the correct structure. Continue below...

Where to Create Pages

It's important to create pages with the correct URL structure to help maintain organization of the content. The first item that all No Man's Sky URL structures will begin with is the Namespace. Namespaces separate content and data structures on the wiki, and the NMS: namespace designates pages as No Man's Sky content. Thus, all pages created for NMS should be created within the No Man's Sky Namespace.

Namespace
NMS:
wiki.step-project.com/NMS:


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

  • Tutorials should use the following URL structure:
    wiki.step-project.com/NMS:Tutorials/PageName
  • References should use the following URL structure:
    wiki.step-project.com/NMS:Game Structure/PageName
  • Modding Tools should use the following URL structure:
    wiki.step-project.com/NMS:Modding_Tools/PageName


All content that doesn't fit into a specified structure above, can use the following:

wiki.step-project.com/NMS:PageName
This content 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. Continue to the steps below...


Once at the editor, there are a few things that must be included for the NMS theme to work correctly.

  • Magic Words that control specific wiki features. They are placed at the top of the document. There is one Magic Word that is required and the other is optional. See Side Notes.
  • The opening template, which places the top half of the theme.
__NOTITLE__
{{NMSPage|contentTitle=PageTitle}}

The opening template has one control parameter to fill in, contentTitle, which places the title of the content/page within the themed headers at the top. This additional parameter is not required, but is highly recommended! If it's not included, it will autofill with the PageName Magic Word.


Next, add the categories that are appropriate for the content so that it 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.

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


Next is including the Table of Contents (TOC). If the TOC isn't desired, skipped this step and ensure the __NOTOC__ Magic Word is included, see Side Notes.

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


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|contentTitle=PageTitle}}
[[Category:No Man's Sky]][[Category:NMS-Tutorial]]
{{TOC_right}}
== HeaderText ==

Page content here...


The last step is to add the required closing template, which places the bottom half of the theme. Without it, the theme will be broken. A completed page should look like the following at the top and bottom (with customized parameters and user content between, of course):

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

Page content here...

{{NMSPageClose}}

Helpful Links

Content Formatting


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

  1. 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: <div style="color:#EEE;">My text is colored #EEE!</div>
  2. Use <code>TextHere</code> tags.
    Code tags will envelop text within preformatted text.
    Example: TextHere
  3. Use <pre></pre> tags.
    Preformatted tags will block out the text between them on the page, exactly as inputted (including spacing).
    Example:
            <Property value="TkSceneNodeAttributeData.xml">
              <Property name="Name" value="MATERIAL" />
              <Property name="AltID" value="" />
              <Property name="Value" value="MATERIALS/LIGHT.MATERIAL.MBIN" />
            </Property>

Useful Templates

Images

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 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 Tags

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

Code: {{CustomTag|color=ColorHere|tag=UserTextHere}}
The color will accept 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