NoMansSky:Wiki Reference: Difference between revisions

From Step Mods | Change The Game
Line 57: Line 57:
   
   
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.
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 is including the Table of Contents (TOC). If the TOC isn't desired, skipped this step and ensure the '''<nowiki>__NOTOC__</nowiki>''' Magic Word is included, see Side Notes.
Next is including the Table of Contents (TOC). If the TOC isn't desired, skipped this step and ensure the '''<nowiki>__NOTOC__</nowiki>''' Magic Word is included, see Side Notes.
<pre>
<pre>
__NOTITLE__
__NOTITLE__
Line 65: Line 65:
{{TOC_right}}
{{TOC_right}}
</pre>
</pre>


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: <code><nowiki>== HeaderText ==</nowiki></code>
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: <code><nowiki>== HeaderText ==</nowiki></code>
<pre>
<pre>
__NOTITLE__
__NOTITLE__
<nowiki>{{NMSPage}}</nowiki>
<nowiki>{{NMSPage|contentTitle=PageTitle}}</nowiki>
<nowiki>{{TOC_right|limit=2}}</nowiki>
<nowiki>{{TOC_right}}</nowiki>
<nowiki>== HeaderText ==</nowiki>
<nowiki>== HeaderText ==</nowiki>
</pre>
</pre>


=== (Step 4) Closing Template ===
The second required template is the closing template, which places the bottom half of the theme. Without it, the theme will be broken.
; [[Template:NMSPageClose|Closing template]] {{CustomTag|color=red|tag=required}}
: Code: <code><nowiki>{{NMSPageClose}}</nowiki></code>
: This template must be included at the bottom of the page following the user's content


The second, and last required template is the closing template, which places the bottom half of the theme. Without it, the theme will be broken.
<pre>
<pre>
__NOTITLE__
__NOTITLE__
<nowiki>{{NMSPage}}</nowiki>
<nowiki>{{NMSPage|contentTitle=PageTitle}}</nowiki>
<nowiki>{{TOC_right|limit=2}}</nowiki>
<nowiki>{{TOC_right}}</nowiki>
<nowiki>== HeaderText ==</nowiki>
<nowiki>== HeaderText ==</nowiki>


User content...
Page content here...


<nowiki>{{NMSPageClose}}</nowiki>
<nowiki>{{NMSPageClose}}</nowiki>

Revision as of 20:41, July 29, 2020

Template:TOC right

Introduction[edit | edit source]

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[edit | edit source]

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:Reference_Guides/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[edit | edit source]

To create a new page:

  1. Copy and paste the URL structure 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 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}}
{{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}}
{{TOC_right}}
== HeaderText ==




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

__NOTITLE__
{{NMSPage|contentTitle=PageTitle}}
{{TOC_right}}
== HeaderText ==

Page content here...

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