Style Guide

This Style Guide is still in development, as the wiki is still being organized. For discussion about these guidelines, feel free to leave a comment on this page or start a thread in the talk button in the dropdown above.

Currently, the plan for this wiki is to have two main types of pages. Formal API documentation pages, and Informal Guides.

API Documentation
These pages are meant to describe the usage of specific parts of the modding API in a formally written language, as one would use in other wikis. API/AddRecipeTab is a good example of how to write a formal documentation page for an API function. The page Template:API Function was written to explain how an API function page is structured.

The Examples section in these pages is a good place to put more informal instructions on the usage of the contents of that specific page.

In addition to documenting functions such as AddRecipeTab, the API docs will include pages for (and not limited to) behaviors, brains, components, and prefabs. In most cases, functions that are defined in a prefab or component should be listed in the page for that prefab/component.

Page Naming
Naming pages for an API documentation typically involves an hierarchical structure, which isn't applicable to a fandom wiki. This makes it difficult to organize pages by page name such as API/AddRecipe, or components/builder. In addition to this issue, such a naming convention makes it difficult to search for the names of specific pages in the wiki.

For these reasons, API page names should not include prefixes such as API/ or components/. Categories can be applied to these pages instead. If there are conflicts between the names of two pages, a disambiguation can be created to resolve it.

Pages with these prefixes will be renamed soon.

For pages that belong to specific categories such as components, prefabs, or API functions, their page can simply be added to their respective category.

Formatting
Tables of Contents currently don't fit will in the current documentation pages, so they should be omitted by adding  at the top of the page.

Small pieces of code should be formatted with tags, while large blocks of code should be formatted with tags.

For API Function pages the function with all parameters is placed on the top of the page with tags.

Guides
Guides are typically informal, instructional pages, to provide more in-depth information outside what can be written in the formal API pages.

They can be written to explain how to use concepts from multiple pages, or other informal explanations. While there are some pages with informal writing on the wiki, there are none yet that have been categorized as guides.