Difference between revisions of "Wiki Contributions & Translations"
(Marked this version for translation) |
|||
| (23 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
<languages/> | <languages/> | ||
<translate> | <translate> | ||
| − | + | <!--T:1--> | |
| − | Neos 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. | + | The Neos 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 Neos can edit the wiki. Any contributions are welcome and wanted. Please edit away! |
| − | == | + | == Editing guidelines == <!--T:28--> |
| − | The Neos Wiki is a very fast moving environment as the community try to keep up with various Neos Changes and updates. To that end it can be unclear what needs to be edited or tweaked. 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: | + | Before you get started, here are some guidelines on editing the wiki to keep in mind. |
| + | |||
| + | === Drafts/Reviews etc === <!--T:29--> | ||
| + | |||
| + | <!--T:31--> | ||
| + | # 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 === <!--T:30--> | ||
| + | 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 | ||
| + | * Avoid article names that are sentences. "LogiX" is better than "What is LogiX" in this case Logix, should contain information about what LogiX is without saying it. | ||
| + | * 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 === <!--T:32--> | ||
| + | Due to the ever changing nature of the wiki and its internationalization requirements, we'll need you to format things in a certain way. | ||
| + | |||
| + | <!--T:33--> | ||
| + | * Avoid using ancient HTML tags. | ||
| + | ** <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. | ||
| + | * 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. | ||
| + | |||
| + | = Finding content to edit = <!--T:15--> | ||
| + | The Neos Wiki is a very fast moving environment as the community try to keep up with various Neos Changes and updates. To that end it can be unclear what needs to be edited or tweaked. | ||
| + | |||
| + | == 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: | ||
* [[:Category:Stubs]] | * [[:Category:Stubs]] | ||
| + | * [[:Category:LogixStubs]] | ||
* [[:Category:ComponentStubs]] | * [[:Category:ComponentStubs]] | ||
| + | <!--T:16--> | ||
Check these pages regularly for lists of pages that need help. | Check these pages regularly for lists of pages that need help. | ||
| − | === Making Larger Changes == | + | == Components & Nodes == <!--T:20--> |
| + | Neos Users use a huge amount of LogiX Nodes and Components to create in-game content. All of these need documentation! | ||
| + | |||
| + | === Templates === <!--T:23--> | ||
| + | Before writing Node or Component pages it is important that you get a copy of the latest templates. | ||
| + | |||
| + | <!--T:25--> | ||
| + | These can all be found pinned in the Wiki channel of the [https://discord.gg/nesovr Neos Discord] but for brevity you can also find them via this [http://files.aerizeon.net/sharex/2021/NeosWiki.zip direct link]. | ||
| + | |||
| + | <!--T:26--> | ||
| + | These files were created by Epsilion using a [[Plugins|Plugin]] for neos. | ||
| + | |||
| + | <!--T:24--> | ||
| + | The templates include: | ||
| + | * A Stub page to get you started | ||
| + | * A picture of the Node/Component which you should upload | ||
| + | |||
| + | === LogiX Nodes === <!--T:21--> | ||
| + | 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--> | ||
| + | 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 == <!--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 Neos 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 Neos 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--> | |
<!--T:14--> | <!--T:14--> | ||
| Line 22: | Line 82: | ||
Everyone with a Neos Account is able to contribute to existing pages, translate and create new ones. | Everyone with a Neos Account is able to contribute to existing pages, translate and create new ones. | ||
| − | + | == 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] | + | 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 Neos 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 <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 Category is NOT ok. | ||
| − | + | = Translating = <!--T:2--> | |
To prepare a page for translation, please edit it to add tag | To prepare a page for translation, please edit it to add tag | ||
| Line 51: | Line 117: | ||
Links to other pages can be translated using <code><nowiki> [[Main Page|Translation]] </nowiki></code> denotation in order to keep them pointing at the original page. | Links to other pages can be translated using <code><nowiki> [[Main Page|Translation]] </nowiki></code> denotation in order to keep them pointing at the original page. | ||
| − | + | = Known bugs = <!--T:3--> | |
| − | We are working | + | == Getting logged out == |
| + | We are aware that the wiki will periodically log you out and are working on a solution. | ||
| + | |||
| + | <!--T:27--> | ||
| + | For now, please save your contributions and translations before pressing "Save Changes". An empty Notepad document works well here. | ||
| + | |||
| + | = External Resources = <!--T:18--> | ||
| + | * [https://www.mediawiki.org/wiki/Help:Links MediaWiki's help on links] | ||
| + | * [https://www.mediawiki.org/wiki/Help:Images MediaWiki's help on images] | ||
| + | * [https://www.mediawiki.org/wiki/Help:Formatting MediaWiki's help on formatting] | ||
| + | * [https://www.mediawiki.org/wiki/Help:Tables MediaWiki's help on tables] | ||
| + | * [https://www.mediawiki.org/wiki/Help:Templates MediaWiki's help on templates] | ||
| + | * [https://www.mediawiki.org/wiki/Help:Categories MediaWiki's help on categories] | ||
</translate> | </translate> | ||
Latest revision as of 05:00, 6 November 2021
The Neos 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 Neos can edit the wiki. Any contributions are welcome and wanted. Please edit away!
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
- Avoid article names that are sentences. "LogiX" is better than "What is LogiX" in this case Logix, should contain information about what LogiX is without saying it.
- 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.
- 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.
Finding content to edit
The Neos Wiki is a very fast moving environment as the community try to keep up with various Neos 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
Neos Users use a huge amount of LogiX Nodes and Components to create in-game content. All of these need documentation!
Templates
Before writing Node or Component pages it is important that you get a copy of the latest templates.
These can all be found pinned in the Wiki channel of the Neos Discord but for brevity you can also find them via this direct link.
These files were created by Epsilion using a Plugin for neos.
The templates include:
- A Stub page to get you started
- A picture of the Node/Component which you should upload
LogiX 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 Neos 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 Neos Wiki uses Media Wiki as its wiki engine and MediaWiki has extensive documentation on how to edit Wiki pages.
Everyone with a Neos Account is able to contribute to existing pages, translate 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 Neos 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
To prepare a page for translation, please edit it to add tag
<languages/>
to the first line of the page to display language selector box and wrap the rest of the page in
<translate></translate>
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.
Known bugs
Getting logged out
We are aware that the wiki will periodically log you out and are working on a solution.
For now, please save your contributions and translations before pressing "Save Changes". An empty Notepad document works well here.