Help:Guide

From Eco - English Wiki
Revision as of 03:51, 21 April 2021 by ZeelNightwolf (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

'This Guide Page is currently undergoing some changes Please join the ECO Contribution Wiki Discord for information about how to Edit the Wiki.'

The information here only applies to editing the wiki and was decided upon by other editors. Nothing here was set by SLG.

Welcome to the Eco Wiki Editing Guide!

This guide is an introduction to the structure and style of the Eco Wiki. Before doing extensive edits to the wiki, please read this guide.


Introduction to Wikicode[edit source]

MediaWiki has plenty of tutorials. Check out https://www.mediawiki.org/wiki/Help:Contents for an introduction to WikiCode.

Wiki Community[edit source]

The Eco Wiki is written and edited by volunteers. The website is hosted and run by Strange Loop Games.

Editor Collaboration[edit source]

  • ECO Contribution Wiki Discord - Join Discord for the quickest and most up-to-date response if you have a question about the wiki. This is a place for all people wishing to contribute to the Wiki to be able to discuss and help each other out.
  • Eco Discord - #wikiediting Channel. Join the Official Eco Discord.
  • Eco Wiki Editors Trello - This is where editors keep track of plans and tasks for the wiki. Anyone may view the board, but to participate, you must create a Trello account and get access from an admin. Ask for access in the Discord.
  • Talk pages - For questions and more focused discussions about editing specific pages, users should use that page's "Talk" page. Talk pages can be accessed by the "Discussion" tab in the top left of each page. Don't forget to sign your name with 4 tildes (~~~~) or the signature button.

Eco Wiki Admins[edit source]

Wiki admins have the power to delete pages, block accounts and IP addresses, protect pages from editing, and more. For issues such as these that require admin attention, please message use on discord: https://discord.gg/ynCVtN5.

Wiki Extensions[edit source]

Wiki Style[edit source]

Color[edit source]

#7BC2CE
Middle Blue
#4688C0
Green Blue Crayola
#337ab7
Steel Blue
#1a8aea
Bleu De France
#1165af
Green Blue
#333333
Jet

The color palette is used for many elements on the wiki. A brown color (same as the Eco inventory background) is used for infobox backgrounds, darkred for infobox headings, and the item "type" background is color-coded.

Third-Person[edit source]

Write in an impersonal style and don't use pronouns (i.e. no "I", "you", or "he/she"; use "the player" or "players" instead).

However, gameplay advice is strongly encouraged. It makes the wiki more useful for players.

Capitalization[edit source]

All references to specific items should be capitalized. But since many items in Eco have generic names, the reference to an item may be lowercase. Usage depends on if you're using the definite or indefinite article (e.g. "use an axe to cut down trees" vs "use the Stone Axe to cut down trees." or "skill scrolls" vs. "Agriculture Skill Scroll")

Links[edit source]

Per Wikipedia style, the first inline reference of the article name should be a link, which will make it show up bold.

The first reference of all items, skills, or game concepts should become links. All further references should not be links.

Comments[edit source]

Comments can only be seen when editing an article. To create a comment, edit source and write your text like this:

<!-- This is a comment -->

Make sure you include the end hyphens and closing tag so the entire article does not become a comment.

Comments should be used for documentation or clarification, not questions or discussions about page content. Use the Talk pages instead for content discussion.

Wiki Structure[edit source]

Wiki structure is centered around guide pages that thoroughly document game systems. Link structure should direct players to these pages. All items and skills in Eco should have the same page.

Guide pages[edit source]

Guide pages serve as jumping-off points for players interested in particular aspects of the game. They should contain thorough information and numerous links so they rank highly in search engines. These pages will also be featured on the main page.

Pages about certain aspect of these systems should become redirect pages to the relevant guide page. For example, all links to specific Skill Scroll items should redirect to Research#Skill_Scrolls. The calories page should redirect to Food#Calories. There are no hard rules about what pages should be a standalone pages and what should be incorporated into the guide pages and turned into redirects. Wiki editors will make calls on when guide page sections become too long and should be moved to individual pages on a case-by-case basis. Use the Talk page for the relevant guide page to discuss these issues.

Below is a list of guide pages. Some of these pages are missing or incomplete since these systems are not fully implemented yet.

  • Getting Started — Introductory guide that new players should start with. Include miscellaneous "Tips & Tricks" section for early-game play.
  • Food — Explains the food system and how nutrients and calories relate to skill gain. Lists all food and cooking recipes. Pages such as nutrients and calories should redirect here.
  • Skills — Explains skill points and lists all skills in the game.
  • Crafting — Explains crafting system and lists all crafting recipes in the game (except food and research recipes).
  • Research — Explains the research system and lists all research recipes. Pages such as skill scroll and skill book should redirect here.
  • Housing — Explains how rooms, building materials, and furniture interact with player skill points and crafting station function.
  • Agriculture — Explains how agriculture works.
  • Pollution — Explains how pollution works.
  • World — Explains how world generation works and lists different biomes.
  • Ecosystem — Explains how plants and animals grow, die, and interact in Eco.
  • Economy — Explains how stores, contracts, currencies, and individually imposed taxes work.
  • Laws — Explains how drafting, voting, and implementation of laws work.
  • Government — Explains how elections, world leadership, and centrally imposed taxes (through the Treasury) work.
  • Server — Explains what servers are and links to tutorials on setting up, running, adminning, and updating servers.
  • Modding — Explains modding, contains an up-to-date list of major mods, and resources and tutorials for modding.

Page Structure[edit source]

Item and Item Variant pages[edit source]

Every item in Eco should have a page associated with it. Though, there are some items that are Varients of an item that will be redirected to the default variant page instead.

The page should start off with an Infobox containing some information about the item, then have a section for general information. NOTE: Make sure there are no double returns between the infobox/initial comments and the beginning of the text content

Below the summary, add level 2 headings such as "Strategy" for strategy discussion and "Notes" for tips or useful facts in bullet form if it is content to include under those headings

Now, you can add a level 3 heading "See Also" which can be used for referencing to highly relevant pages like Housing or Food.

If the item page is a variant item call Template:VariantDetails.

Next, include a level 2 header for "Crafting", and call Template:GetRecipes as needed.

Then. a level 2 "Gallery" heading for any pictures.

A section for "History" should be included at the bottom of the page when the item has changed over updates to the game. This section can include bulleted notes about history or more specific version update tables. This is not a section for page edit history.

Below is an example of item page structure for the item page "Acorn":

<!-- ==INFOBOX== -->
{{Infobox_Item|name=Acorn}}

<!-- ==SUMMARY== -->
[[Acorn|Acorns]] are a seed from [[Oak|Oak trees]]. They can be planted to grow new Oak Trees, or used in cooking.<br>

===See Also===
For a list of food recipes, see [[Food]].
See [[Oak]] for Ideal Planting information.

<!-- ==CRAFTING== -->
==Crafting==
{{GetRecipes|item=Acorn}}

<!-- ==HISTORY== -->
==History==
{|class=wikitable width="70%"
|-
! colspan=2 | Changes
|-
! scope="row" style="width: 100px;" | 
| 
|}

Below is an example of item page structure for an item page that has variants "Adorned Ashlar Bench":

<!-- ==INFOBOX== -->
{{Infobox_Item|name=Adorned Ashlar Stone Bench}}

<!-- ==SUMMARY== -->
The [[Adorned Ashlar Bench|Adorned Ashlar Benches]] are furniture seats that give you General Housing points. They come in a range of colours determined by the [[Rock]] used when crafting.

===See Also===
See [[Housing]] for more information about General Housing Items.

<!-- ==VARIANT== -->
{{VariantDetails|name = Adorned Ashlar Stone Bench}}

'''Side-View of Adorned Ashlar Benches'''

[[File:AdornedAshlarBench_All.png|link=https://wiki.play.eco/en/File:AdornedAshlarBench_All.png|alt=|border|800x800px]]

== Crafting ==
{{GetRecipes|item=Adorned Ashlar Stone Bench}}

<!-- ==HISTORY== -->
==History==
{|class=wikitable width="70%"
|-
! colspan=2 | Changes
|-
! scope="row" style="width: 100px;" | 9.0.0 Beta
| Introduced to ECO
|}

Note: Descriptions are now no longer needed on a page as they are generated in the Infobox. Also, Categories are generated in the Infobox as well once you create the page using the above if it is missing a category then it can be added.

Animal pages[edit source]

Every animal in Eco should have a page associated with it and the page structure is similar to the item pages.

It begins with the Infobox_Animal and then has a quick Summary about the animal.

Below the summary, add level 2 headings such as "Behaviour", "Hunting", "Strategy" and, "Real Life Facts".

Then. a level 2 "Gallery" heading for any pictures.

A section for "History" should be included at the bottom of the page when the item has changed over updates to the game. This section can include bulleted notes about history or more specific version update tables. This is not a section for page edit history.

Below is an example of an animal page structure:

{{Infobox_Animal| name = nameofAnimal}}
<!-- Summary (no heading needed) -->

== Behavior ==
Write information about the behaviour of the animal in-game.

== Hunting ==
Tips on the best way to Hunt the animal. 

== Strategy ==
Tips on things about the animal. 

== Real life Facts ==
Add some Facts about the real-life animal with links. 

<!-- ==GALLERY== -->
== Gallery ==
<gallery>File:IMAGE.png|This is an Image.</gallery>

<!-- ==HISTORY== -->
==History==
{|class=wikitable width="70%"
|-
! colspan=2 | Changes
|-
! scope="row" style="width: 100px;" | 
| 
|}

Block pages[edit source]

INFORMATION COMING SOON...

Plant and Tree pages[edit source]

INFORMATION COMING SOON...

Skill pages[edit source]

Every profession, specialty, and skill in Eco should have its own page describing it.

Each page will begin with an Infobox_Skill template.

Then it will include an Unlocks table using Skills Details.

For a Speciality, include a Learning Heading with a Get Recipes template.

Below is an example of a skill page structure on the page Specialty, Smelting.

{{Infobox_Skill|name = Smelting}}
{{SkillDetails|skill = Smelting}}

== Learning ==
{{GetRecipes|item=Smelting Skill Book}}

Talent pages[edit source]

INFORMATION COMING SOON...

Categories[edit source]

Categories help us keep track of pages. Every page should have a category.

To add a category to a page, add "[[Category:Example]]" at the bottom of the page, where "Example" is the category.

If a page uses certain Modules you may not need to add Categories as they are automatically added within the Module. Modules that include Categories are:

  • Infobox_Item
  • TagDetails
  • TagList

Templates[edit source]


Templates are elements of the wiki that are pre-fabricated and are used across the wiki. Templates are inserted into a page with curly brackets. For example, to insert the Outdated template, an editor will simply type "{{Outdated}}". More information about each template and how to use them can be found on the template's page, and a full list of templates can be found by going to Special:AllPages and setting the namespace to Template.

Infoboxes[edit source]

Infoboxes are used on all item, skill, animal, plant, and tree pages as a "fast facts" reference for all the vital attributes regarding the item, skill, animal, plant, and tree.

Each infobox has its own parameters that currently must be entered manually. Visit each template page to see the params. A system for automating infobox params with information pulled from the game is in the works.

Infobox_Item[edit source]
{{Infobox_Item|name = 'Item name'}}

Template:Infobox_Item is used for pages about items such as food, tools, crafting materials, or blocks.

Infobox_Skill[edit source]
{{Infobox_Skill|name = 'Skill name'}}

Template:Infobox_Skill is used for skill pages.

Infobox_Animal[edit source]
{{Infobox_Animal|name = 'Animal name'}}

Template:Infobox_Animal is used for animal pages.

Infobox_Plant[edit source]
{{Infobox_Plant|plant='Plant name'}}
{{Infobox_Plant|tree='Tree name'}}

Template:Infobox_Plant is used for Plant and Tree pages.

Contentneeded[edit source]

{{contentneeded}}

Template:Contentneeded should be used for pages that need some more information or are incomplete. It adds a text box to the top of the page, and adds the page to Category:Content needed.

Imagesneeded[edit source]

{{imagesneeded}}

Template:Imagesneeded should be used for pages that need some screenshots or images to make them more interesting. It adds a text box to the top of the page, and adds the page to Category:Content needed.

Outdated[edit source]

{{Outdated}}
{{Outdated|Version}}

Template:Outdated creates a text box that warns players the information on the page may be outdated. If "Version" is specified, it notes it as the version in which the page became outdated. It also adds the page to Category:Outdated pages.

Delete[edit source]

{{Delete|Regular deletion reason}}
{{Delete|Speedy deletion reason|speedy}}

Template:Delete flags a page for deletion and adds it to Category:Candidates for deletion. This creates a text box at the top of the page announcing that the page has been flagged for the reason passed in to the template. If there is need for the page to be deleted in a short time, speedy can be specified. Adding "speedy" to the template adds the page to Category:Candidates for speedy deletion.

GetRecipes[edit source]

{{GetRecipes|item=Item Name}}
{{GetRecipes|table=Crafting Table}}
{{GetRecipes|table=Crafting Table|group=Group}}
{{GetRecipes|group=Group}}

Template:GetRecipes is used to get a list of applicable recipes from the game. The recipes are formatted in a wikitable, and are given appropriate level 3 headers. If "item" is specified, the template grabs all recipes that either create the item or that use the item as an ingredient. This parameter takes precedence over all other parameters. When "table" is specified, the template grabs all recipes that are available at the given crafting table. Specifying "group" causes the template to gather all recipes that create an item that belongs to the given group. Both "table" and "group" can be specified together to narrow down the list of recipes that are selected.
The logic handling for this template is done by Module:GetRecipes and Module:CraftingParser.
To manually create a list of recipes in the same wikitable format as used in this template, see Template:RecipeTable.

IconFrame[edit source]

{{IconFrame
    |file = Workbench.png
    |link = Workbench
    |text = <h3>[[Workbench]]</h3>
}}

Template:IconFrame creates a frame with a specific image, text, and link. This template can be used to create headings with the text param.

RecipeTable[edit source]

Template:RecipeTable is used to manually create a list of recipes. The table that is output by this template is in the same format as ones produced by Template:GetRecipes. For information on how to use this template, please see this template's page.