Misc: Wiki Contribution Guide

For the most part, articles can be written however the writer chooses, as long as it follows the code of conduct and this guide.

Home/index/landing pages can ignore most of these rules, such as Expression 2.

We consider two types of regular articles on the wiki, Documentation and Guide articles.

Documentation articles pertain to documenting how a certain part of Wiremod is used and is meant to be concrete, informative, and neutral. A documentation article can have examples but should not focus on complex examples. Documentation articles can have preambles explaining theory, usage, and other relevant information. Documentation articles should generally be limited to a single focus, such as a single E2 extension, gate category, or tool.

Guide articles pertain to instructing the reader on how to perform a task or use a feature in Wiremod and can be more personalized to the writer's style. A guide article can describe various Wiremod features but should not be overly technical. Guides can be broad but not random. Consider enhancing a preexisting guide instead of creating a new one if the subjects are similar.

Titles

Titles should be labeled by the relevant category it belongs to, separated by a colon and space. Guide articles should have Guide added after the category, such as E2 Guide:. Misc guides are exempt from this, but can do so anyway. An Expression 2 article should be labeled E2:. A gate article should be labeled Gate:. A tool article should be labeled Tool:. Articles for developers should be labeled Dev:. Any other article should be labeled Misc:.

Linking

Please link to your article from another page once you have finished writing it. This helps other people find it much easier. Generally you should do this in the index page for the category and/or sidebar. Do not link directly from unrelated categories. Misc articles are exempt but encouraged to link if reasonable. When linking, use the name of the article as the anchor text and only include the path to the article, such as [Expression 2](/wiremod/wire/wiki/Expression-2).

Sample code

Sample (example) code should follow best E2 practices and refrain from including deprecated features, unless there is good reason. Sample code should use syntax highlighting. There is no perfect language for syntax highlighting, but we recommend golo, ts, and ruby. You are free to use any language you find fit, however.

function myFunction(MyVar:string) { print("Hello " + MyVar) } # prints 'Hello' followed by MyVar, golo

function myFunction(MyVar:string) { print("Hello " + MyVar) } # prints 'Hello' followed by MyVar, ts

function myFunction(MyVar:string) { print("Hello " + MyVar) } # prints 'Hello' followed by MyVar, ruby

Difficulty

Difficulty should be assigned to guides to represent the expected experience level of the reader. Difficulty is difficult to gauge objectively, so the following lists provides terse examples to help visualize the skill required. Difficulty should be represented using the same icons for consistency.

• 🔰 Beginner - "Hello World" Introduces the reader to a single concept/feature of Wiremod/E2 that is foundational to using it.
• 🟢 Easy - "Simple Cars" Presents simple concepts that should be easy after learning the syntax/usage.
• 🟨 Intermediate - "Automated Turrets" Combines previous knowledge to make a more complex example.
• 🔶 Advanced - "Computers" Uses advanced logic, math, or ideas that less experienced users may be uncomfortable with.
• 🔺 Expert - "AI Robot" Covers concepts that are only relevant to advanced users.