Difference between revisions of "Help:Editing/Page Creation"

From Frictional Wiki
Jump to navigation Jump to search
(→‎Formatting: Added more code guidelines)
 
Line 17: Line 17:
 
* When describing a sequence of steps in tutorials and guides, use '''numbered lists''' and not bulleted lists. Numbered lists provide a clearer approach when describing steps that should be followed one after the other.  
 
* When describing a sequence of steps in tutorials and guides, use '''numbered lists''' and not bulleted lists. Numbered lists provide a clearer approach when describing steps that should be followed one after the other.  
 
* Image usage to demonstrate a concept or action is recommended. See more in [[Help:Editing/Images|images]].
 
* Image usage to demonstrate a concept or action is recommended. See more in [[Help:Editing/Images|images]].
* Use <syntaxhighlight> when plugging code snippets into the page.
 
 
* Assign relevant [[Help:Editing/Categories|categories]] to your page. It is important to keep pages organized and easy to find within groups and categories.
 
* Assign relevant [[Help:Editing/Categories|categories]] to your page. It is important to keep pages organized and easy to find within groups and categories.
 +
* Use:
 +
**&lt;syntaxhighlight> when plugging code snippets into the page. Make sure to mark the correct language. For this wiki, C++ is the most common: <code>&lt;syntaxhighlight lang="cpp"></code>. Other ones are "batch" and "shell" for OS scripts.
 +
**<pre>&lt;pre>preformatted blocks for code that isn't similar to any language supported by the code block higlighting.&lt;/pre></pre>
 +
**<code>&lt;code>Code tags for inline code (whenever referencing code fragments outside a code block)&lt;/code></code>.
  
 
=== Point of View ===
 
=== Point of View ===

Latest revision as of 22:15, 23 July 2020

The easiest route to create a page is to simply type the name of it in the search bar at the top, and follow the link it gives you. You can also type it in your address bar or go to it through a red link.

Do not make a page without providing at least some actual information about it! If you see a page doesn't exist even though it should, we would prefer you do not make it if you don't actually know anything about it. An acceptable alternative is to create a red link to the page somewhere and add the template we call todo.

Note icon.png Page titles are case-sensitive, except for the first letter. Use DISPLAYTITLE to change the title of the page at the top of it (but not the URL).


Guidelines

Structure is important to make people feel that the wiki is intuitive to use. Therefore we expect all articles to adhere to a few simple guidelines.

Introduction

The beginning of the page should have a small introduction or summary of the rest of the page, and comes before any additional headings. This enables it to appear above the table of contents.

Formatting

Proper formatting allows the wiki to structure itself more predictably. Consider the following practices when creating pages:

  • Use Heading for new sections and Sub-headings for sections that go under it. This allows the table of contents to lay itself out in a way that makes sense. See more in Table of Contents for examples.
  • When describing a sequence of steps in tutorials and guides, use numbered lists and not bulleted lists. Numbered lists provide a clearer approach when describing steps that should be followed one after the other.
  • Image usage to demonstrate a concept or action is recommended. See more in images.
  • Assign relevant categories to your page. It is important to keep pages organized and easy to find within groups and categories.
  • Use:
    • <syntaxhighlight> when plugging code snippets into the page. Make sure to mark the correct language. For this wiki, C++ is the most common: <syntaxhighlight lang="cpp">. Other ones are "batch" and "shell" for OS scripts.
    • <pre>preformatted blocks for code that isn't similar to any language supported by the code block higlighting.</pre>
    • <code>Code tags for inline code (whenever referencing code fragments outside a code block)</code>.

Point of View

Articles should be writen in the third person, avoiding the usage of "I" (first person) and "you" (second person) whenever possible. If referring to gameplay, use "the player" rather than "you" ("The player can press the button to open the door".) In tutorials and other material related to development, the word "you" can be acceptable, or it may be possible to remove it, for example changing "Next, you tie the brush to..." to "Next, tie the brush to...". In tutorials, phrasing such as "I prefer to use the..." should be changed to "A good choice is the...".

Links

Provide links to other pages on different topics, instead of writing existing content in detail several times. This allows us to keep information in one place which makes it easier to update when things change. However, you are free to provide smaller snippets or examples as this may be convenient, but please include a link for further information on the topic regardless. Additionally, when selecting which text the hyperlink appears on, include enough text to describe where the link leads, as if read in isolation. If the destination is on a specific topic, this might only include the name of the topic itself, however if the name of the topic is not obvious or included in your article, you may extend the text to a sentence that encapsulates a description instead.

Public Domain

This wiki provides information to the public for free and we expect the content to not infringe on others' copyrights. You may still quote such content as long as it falls under fair use.

Page Features

See toolbar page for help with the top bar.

The Summary box allows to describe changes. It's completely optional. It has a 255 character limit.

This is a minor edit marks your edit as minor. Reserve this for changes such as fixing typos. This should not be marked on any edits that change the actual information being told to readers.

Watch this page will tell the website to add the page you are editing to your watchlist.

The Show preview button allows you to see what your changes will look like before saving them. Please use this, instead of making many, many revisions to a page in rapid succession. Doing so creates clutter on edit history logs.

Show changes will summarize all the changes your current unsaved edit will make.

Click Save page when you are done editing.

User Pages

Your user page is your own personal editing spot. Write about yourself or whatever you want. Typically, only the associated user should be editing their user page.

Talk Pages

Talk pages are for discussing the content of their associated pages. You can also talk about pages in the official discord server of Frictional Games.