NoMansSky:Wiki Reference: Difference between revisions
TechAngel85 (talk | contribs) |
TechAngel85 (talk | contribs) |
||
Line 33: | Line 33: | ||
==== Opening Magic Words ==== | ==== Opening Magic Words ==== | ||
Once at the editor, there are a few things that must be included for the NMS theme to work correctly. First, are the 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: | |||
; <nowiki>__NOTITLE__</nowiki> {{CustomTag|color=red|tag=required}} | ; <nowiki>__NOTITLE__</nowiki> {{CustomTag|color=red|tag=required}} | ||
: This | : 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. | ||
; <nowiki>__NOTOC__</nowiki> | ; <nowiki>__NOTOC__</nowiki> {{CustomTag|color=#DDD|tag=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 | : 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. | ||
<pre>__NOTITLE__</pre> | <pre>__NOTITLE__</pre> |
Revision as of 19:29, July 29, 2020
Introduction
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
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 really there aren't. The information below is simply providing a lot of detail! But before users can create pages, lets ensure the page is being created with 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: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 Page
To create a new page:
- Copy and paste the URL structure from above
- Change 'PageName to the name of page being added (must be unique/can't already exist), and hit Enter/Return on your keyboard.
- Users will be presented with a page stating the content doesn't exist and a couple options. Select, the edit this page link.
- Users will be taken to the editor for content creation. Continue to the steps below...
Opening Magic Words
Once at the editor, there are a few things that must be included for the NMS theme to work correctly. First, are the 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:
- __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.
__NOTITLE__
(Step 2) Opening Template
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
Controlling the TOC
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
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
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:
- On the top navigation bar, hover over TOOLBOX and select [UPLOAD FILE].
- 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
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
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}}
- Notice Small
- Code:
{{Notice Small|text=UserTextHere}}