No edit summary |
Punctuation, case, and some minor tense updates. |
||
| Line 13: | Line 13: | ||
<!--T:31--> | <!--T:31--> | ||
# Just edit it! You don't need any special status, approval or permission to edit the wiki. | # Just edit it! You don't need any special status, approval or permission to edit the wiki. | ||
# Don't send us drafts or WIPs. Just edit away. We'll work on content as we go :) | # Don't send us drafts or WIPs. Just edit away. We'll work on content as we go. :) | ||
# Don't use Google Docs or Word to draft documentation. Writing directly in the wiki helps you to think like a wiki. | # Don't use Google Docs or Word to draft documentation. Writing directly in the wiki helps you to think like a wiki. | ||
# Follow the principle of "progressive enhancement" Good -> Better -> Best | # Follow the principle of "progressive enhancement." Good -> Better -> Best | ||
=== Style === <!--T:30--> | === Style === <!--T:30--> | ||
When writing we don't really have a "writing style" to follow but we do have some guidelines: | When writing, we don't really have a "writing style" to follow, but we do have some guidelines: | ||
* Link to other articles lots! | * Link to other articles lots! Cross linking articles is fantastic. | ||
* Write using proper sentences and casing. | * Write using proper sentences and casing. | ||
** Avoid over capitalization. | ** Avoid over capitalization. | ||
* Write using you and we instead of I - This brings the user along for the journey with you. | * Write using you and we instead of I - This brings the user along for the journey with you. | ||
* Avoid article names that are sentences. "ProtoFlux" is better than "What is ProtoFlux" in this case ProtoFlux | * Avoid article names that are sentences. "ProtoFlux" is better than "What is ProtoFlux" in this case, ProtoFlux should contain information about what ProtoFlux is without saying it in the title. | ||
* Use headings... lots | * Use headings... lots. They help with readability. | ||
* Use bullet pointed lists | * Use bullet pointed lists. They're great. | ||
* Avoid tables for large paragraphs of text. | * Avoid tables for large paragraphs of text. | ||
** Factual data, numerical data etc are fine. But we often see tables that would be better served as a collection of multiple tables or a collection of multiple bullet pointed lists or headings. | ** Factual data, numerical data, etc. are fine. But we often see tables that would be better served as a collection of multiple tables, or a collection of multiple bullet pointed lists or headings. | ||
=== Formatting === <!--T:32--> | === Formatting === <!--T:32--> | ||
| Line 37: | Line 37: | ||
* Avoid using ancient HTML tags. | * Avoid using ancient HTML tags. | ||
** <pre><b>,<br>,<i>,<div> etc</pre> should be avoided. Use the WikiText Equivalents wherever possible. | ** <pre><b>,<br>,<i>,<div> etc</pre> should be avoided. Use the WikiText Equivalents wherever possible. | ||
** If you need a line break add a literal line break. | ** If you need a line break, add a literal line break. | ||
* Avoid starting a page with a heading which is a copy of the page name. The title of the page is the page name, not the first heading. | * Avoid starting a page with a heading which is a copy of the page name. The title of the page is the page name, not the first heading. | ||
=== Colors === | === Colors === | ||
* Avoid manually setting color related properties on wiki pages. This can break the light/dark mode switcher for elements you touch. | * Avoid manually setting color related properties on wiki pages. This can break the light/dark mode switcher for elements you touch. | ||
* We're researching a way to use our Skin's color theming instead which would make items work with light and dark mode and ensure | * We're researching a way to use our Skin's color theming instead, which would make items work with light and dark mode and ensure consistency. | ||
= Finding content to edit = <!--T:15--> | = Finding content to edit = <!--T:15--> | ||
The Resonite Wiki is a very fast moving environment as the community | The Resonite Wiki is a very fast moving environment as the community tries to keep up with various Resonite changes and updates. To that end, it can be unclear what needs to be edited or tweaked. | ||
== Stubs == <!--T:19--> | == Stubs == <!--T:19--> | ||
To help with this we have a number of pages which list content that is in need of attention. These pages are called Stubs. You can find a list of stubs on these automatically generated pages: | To help with this, we have a number of pages which list content that is in need of attention. These pages are called Stubs. You can find a list of stubs on these automatically generated pages: | ||
* [[:Category:Stubs]] | * [[:Category:Stubs]] | ||
* [[:Category:ProtoFluxStubs]] | * [[:Category:ProtoFluxStubs]] | ||
| Line 60: | Line 60: | ||
=== Templates === <!--T:23--> | === Templates === <!--T:23--> | ||
Currently we do not have proper component/node templates | Currently we do not have proper component/node templates. This will be updated once they are developed! | ||
=== ProtoFlux Nodes === <!--T:21--> | === ProtoFlux Nodes === <!--T:21--> | ||
Check [[:Category:NodeMenu]] for a list of nodes | Check [[:Category:NodeMenu]] for a list of nodes. It resembles the in-game Node Browser. Any nodes could do with reviews, edits and updates but if you see a Node with a Red link, that means it is undocumented. Please feel free to type documentation for it! | ||
=== Components === <!--T:22--> | === Components === <!--T:22--> | ||
| Line 69: | Line 69: | ||
== Making Larger Changes == <!--T:17--> | == Making Larger Changes == <!--T:17--> | ||
When making changes to the wiki, the general principle is to go right ahead. However, when making changes to larger pages such as the [[Main Page]] or pages which are edited, touched or translated frequently please be careful. There are sometimes subtleties and nuances that need to be covered when editing these pages. Please double check in the Wiki channel of the Resonite Discord before you make such changes. The community there will say yes a lot of the time but sometimes a discussion may be required. | When making changes to the wiki, the general principle is to go right ahead. However, when making changes to larger pages such as the [[Main Page]] or pages which are edited, touched or translated frequently, please be careful. There are sometimes subtleties and nuances that need to be covered when editing these pages. Please double check in the Wiki channel of the Resonite Discord before you make such changes. The community there will say yes a lot of the time, but sometimes a discussion may be required. | ||
= Editing Help = <!--T:13--> | = Editing Help = <!--T:13--> | ||
<!--T:14--> | <!--T:14--> | ||
The Resonite Wiki uses Media Wiki as its wiki engine and MediaWiki has [https://www.mediawiki.org/wiki/Help:Editing_pages extensive documentation on how to edit Wiki pages]. | The Resonite Wiki uses Media Wiki as its wiki engine, and MediaWiki has [https://www.mediawiki.org/wiki/Help:Editing_pages extensive documentation on how to edit Wiki pages]. | ||
<!--T:4--> | <!--T:4--> | ||
| Line 80: | Line 80: | ||
== Categories == <!--T:12--> | == Categories == <!--T:12--> | ||
A Category is a way to categorize pages that follow a certain theme or topic. You can use them to group together these pages as a category page will create a table of pages within its category. For more information on categories [https://www.mediawiki.org/wiki/Help:Categories please see Media Wiki's guide on categories]. However here are some specific Resonite Wiki items of guidance: | A Category is a way to categorize pages that follow a certain theme or topic. You can use them to group together these pages, as a category page will create a table of pages within its category. For more information on categories, [https://www.mediawiki.org/wiki/Help:Categories please see Media Wiki's guide on categories]. However, here are some specific Resonite Wiki items of guidance: | ||
* Category Pages can contain information and text. Use this to explain what the category is and what it does. | * Category Pages can contain information and text. Use this to explain what the category is and what it does. | ||
* Subcategories can exist | * Subcategories can exist. | ||
** To Create one, put a Category page into another Category. | ** To Create one, put a Category page into another Category. | ||
** For example, Category:Animals, Could contain Category:Animals:Mammals. | ** For example, Category:Animals, Could contain Category:Animals:Mammals. | ||
** To do this, | ** To do this, make sure Category:Animals:Mammals is named exactly like that and then ensure it also has <nowiki>[[Category:Animals]]</nowiki> within it. | ||
* A page can be in more than one category. | * A page can be in more than one category. | ||
* '''Please try to avoid creating categories that have only one page within them.''' | * '''Please try to avoid creating categories that have only one page within them.''' | ||
** Be careful when nesting categories. Members of a category should not also be a category themselves. Category:Vegetables is fine. However, Potato being its own | ** Be careful when nesting categories. Members of a category should not also be a category themselves. Category:Vegetables is fine. However, Potato being its own category is NOT ok. | ||
= Translating = | = Translating = | ||
Revision as of 23:15, 12 January 2024
The Resonite Wiki is a community project. Thank you for all your help and contributions! We are a tiny team and maintaining it wouldn't be possible without you. Everyone regardless of their status in Resonite can edit the wiki. Any contributions are welcome and wanted. Please edit away!
Wiki Moderation
For each user, their first few edits will be placed in a Moderation queue, these are usually approved quickly.
Once approved, users are usually added to the automoderated user group, which prevents subsequent edits from needing moderation.
Editing guidelines
Before you get started, here are some guidelines on editing the wiki to keep in mind.
Drafts/Reviews etc
- Just edit it! You don't need any special status, approval or permission to edit the wiki.
- Don't send us drafts or WIPs. Just edit away. We'll work on content as we go. :)
- Don't use Google Docs or Word to draft documentation. Writing directly in the wiki helps you to think like a wiki.
- Follow the principle of "progressive enhancement." Good -> Better -> Best
Style
When writing, we don't really have a "writing style" to follow, but we do have some guidelines:
- Link to other articles lots! Cross linking articles is fantastic.
- Write using proper sentences and casing.
- Avoid over capitalization.
- Write using you and we instead of I - This brings the user along for the journey with you.
- Avoid article names that are sentences. "ProtoFlux" is better than "What is ProtoFlux" in this case, ProtoFlux should contain information about what ProtoFlux is without saying it in the title.
- Use headings... lots. They help with readability.
- Use bullet pointed lists. They're great.
- Avoid tables for large paragraphs of text.
- Factual data, numerical data, etc. are fine. But we often see tables that would be better served as a collection of multiple tables, or a collection of multiple bullet pointed lists or headings.
Formatting
Due to the ever changing nature of the wiki and its internationalization requirements, we'll need you to format things in a certain way.
You can find a quick guide to Wikitext formatting on the MediaWiki Formatting help page.
- Avoid using ancient HTML tags.
<b>,<br>,<i>,<div> etc
should be avoided. Use the WikiText Equivalents wherever possible.- If you need a line break, add a literal line break.
- Avoid starting a page with a heading which is a copy of the page name. The title of the page is the page name, not the first heading.
Colors
- Avoid manually setting color related properties on wiki pages. This can break the light/dark mode switcher for elements you touch.
- We're researching a way to use our Skin's color theming instead, which would make items work with light and dark mode and ensure consistency.
Finding content to edit
The Resonite Wiki is a very fast moving environment as the community tries to keep up with various Resonite changes and updates. To that end, it can be unclear what needs to be edited or tweaked.
Stubs
To help with this, we have a number of pages which list content that is in need of attention. These pages are called Stubs. You can find a list of stubs on these automatically generated pages:
Check these pages regularly for lists of pages that need help.
Components & Nodes
Resonite Users use a huge amount of ProtoFlux Nodes and Components to create in-game content. All of these need documentation!
Templates
Currently we do not have proper component/node templates. This will be updated once they are developed!
ProtoFlux Nodes
Check Category:NodeMenu for a list of nodes. It resembles the in-game Node Browser. Any nodes could do with reviews, edits and updates but if you see a Node with a Red link, that means it is undocumented. Please feel free to type documentation for it!
Components
We have a list of components on Category:Components which can have gaps or missing pages. If you find a component that is missing documentation please go ahead and add it.
Making Larger Changes
When making changes to the wiki, the general principle is to go right ahead. However, when making changes to larger pages such as the Main Page or pages which are edited, touched or translated frequently, please be careful. There are sometimes subtleties and nuances that need to be covered when editing these pages. Please double check in the Wiki channel of the Resonite Discord before you make such changes. The community there will say yes a lot of the time, but sometimes a discussion may be required.
Editing Help
The Resonite Wiki uses Media Wiki as its wiki engine, and MediaWiki has extensive documentation on how to edit Wiki pages.
Everyone can make a wiki account to contribute to existing pages and create new ones.
Categories
A Category is a way to categorize pages that follow a certain theme or topic. You can use them to group together these pages, as a category page will create a table of pages within its category. For more information on categories, please see Media Wiki's guide on categories. However, here are some specific Resonite Wiki items of guidance:
- Category Pages can contain information and text. Use this to explain what the category is and what it does.
- Subcategories can exist.
- To Create one, put a Category page into another Category.
- For example, Category:Animals, Could contain Category:Animals:Mammals.
- To do this, make sure Category:Animals:Mammals is named exactly like that and then ensure it also has [[Category:Animals]] within it.
- A page can be in more than one category.
- Please try to avoid creating categories that have only one page within them.
- Be careful when nesting categories. Members of a category should not also be a category themselves. Category:Vegetables is fine. However, Potato being its own category is NOT ok.
Translating
We're double checking how translations work here, please stand by.
To prepare a page for translation, please edit it to add tag
to the first line of the page to display language selector box and wrap the rest of the page in
tags to mark translatable content.
Follow the "Mark this page for translation" link that will now appear in page header. You can review translation units and hit "Mark this version for translation" button at the bottom to get translation process going.
Page header will now feature translation links for all logged in Wiki users.
Links to other pages can be translated using [[Main Page|Translation]] denotation in order to keep them pointing at the original page.