Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
development:wiki [2021/06/20 02:25] – Fix typo wdavery | development:wiki [2021/07/12 18:08] (current) – external edit 127.0.0.1 | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== Wiki guideline for editors | + | ====== Wiki Guidelines |
- | First of all, thank you for your efforts to make this wiki better. Seriously, with a lot of blocks and items it is near to impossible for developers to keep wiki up-to-date. | + | First of all, thank you for your efforts to make this wiki better. Seriously, with a lot of blocks and items it is near to impossible for developers to keep wiki up-to-date. |
- | \\ | + | |
- | ===== Wiki Structure | + | See our **[[development: |
- | In order to have breadcrumbs we have 3 major sections: | + | |
- | This approach introduce kind of burden to create page for a particular block or item twice. First page - with content with one of above mentioned major section. Second page is redirect required by plugins used to help with items and recipes. | + | ==== Wiki Structure ==== |
+ | In order to have breadcrumbs we have 3 major sections:\\ | ||
+ | **Energy** - Any item or block that uses power. Including cables, generators, batteries, machines, and powered tools.\\ | ||
+ | **Items** - Non-power related items. Including cells, dusts, ingots, parts, etc.\\ | ||
+ | **Blocks** | ||
- | ===== Plugins ===== | + | Each item or block will require two pages:\\ |
- | We have two plugins | + | 1. A redirect page at its // |
+ | 2. A content page in one of the three sections above | ||
+ | ==== Syntax | ||
+ | Here are some syntax examples for the two [P]lugins | ||
- | ==== Minecraft Items ==== | + | < |
- | Allows you to insert a fancy link to a block or item | + | * [[# |
+ | * [[# | ||
+ | * [[# | ||
+ | * [[# | ||
+ | |||
+ | <pane id=" | ||
+ | === Minecraft Items Plugin | ||
+ | **Allows you to insert a fancy link to a block or item**\\ | ||
Syntax: | Syntax: | ||
< | < | ||
- | //namespace// is “minecraft” for vanilla | + | '' |
- | //item_name// is the registry name for an item | + | '' |
Example: | Example: | ||
- | < | + | < |
+ | < | ||
< | < | ||
</ | </ | ||
Line 25: | Line 40: | ||
< | < | ||
- | This will automatically generate a link to a page //mods: | + | <callout type=" |
- | That page requires a redirect | + | If this produces something that is grammatically incorrect |
+ | </ | ||
- | Redirect syntax for items is: | + | This will automatically generate a link to the page '' |
- | < | + | That page requires a redirect to the page with real content following wiki structure.\\ |
- | Where // | + | |
- | Can also be nested, like “energy: | + | |
- | ==== Minecraft Recipes | + | <callout type=" |
- | Allows for pretty formatted recipes | + | **There should be no content besides redirects under the '' |
+ | </ | ||
+ | </ | ||
+ | |||
+ | <pane id=" | ||
+ | === Minecraft Recipe Plugin | ||
+ | Allows for pretty formatted recipes. | ||
- | Example Crafting Table recipe: | ||
< | < | ||
< | < | ||
- | input techreborn: | + | size 3x3 |
- | input minecraft:glass_pane techreborn: | + | input air air air |
- | input techreborn: | + | input air minecraft:coal air |
- | output techreborn:basic_solar_panel | + | input air minecraft:stick air |
+ | output | ||
+ | tool minecraft:crafting_table | ||
</ | </ | ||
</ | </ | ||
- | Produces: | + | |
< | < | ||
- | input techreborn:coal_dust | + | size 3x3 |
- | input minecraft:glass_pane techreborn:coal_dust | + | input air air air |
- | input techreborn:electronic_circuit techreborn:solid_fuel_generator techreborn:electronic_circuit | + | input air minecraft:coal air |
- | output techreborn:basic_solar_panel | + | input air minecraft:stick air |
+ | output minecraft:torch,4 | ||
+ | tool minecraft: | ||
+ | </ | ||
+ | |||
+ | == Attributes == | ||
+ | |||
+ | ^ Attribute ^ Default Value ^ Allowed Values ^ Description ^ | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' | ||
+ | |||
+ | <callout type=" | ||
+ | === Specifying Quantities === | ||
+ | |||
+ | Both commands '' | ||
+ | < | ||
+ | wiki_page, | ||
+ | |||
+ | minecraft:torch,4 | ||
+ | minecraft: | ||
+ | </ | ||
+ | |||
+ | '' | ||
+ | |||
+ | '' | ||
+ | |||
+ | Note that tool also takes an item stack as an argument, but it will ignore any amounts. | ||
+ | </ | ||
+ | |||
+ | |||
+ | === Additional Examples === | ||
+ | |||
+ | < | ||
+ | < | ||
+ | input air minecraft:stick air | ||
+ | input minecraft:wood_planks minecraft: | ||
+ | input minecraft:wood_planks air air | ||
+ | output techreborn:treetap | ||
</ | </ | ||
+ | </ | ||
+ | |||
+ | < | ||
+ | input air minecraft: | ||
+ | input minecraft: | ||
+ | input minecraft: | ||
+ | output techreborn: | ||
+ | </ | ||
+ | |||
\\ | \\ | ||
Example furnace recipe (note: size and tool are optional): | Example furnace recipe (note: size and tool are optional): | ||
Line 69: | Line 138: | ||
tool minecraft: | tool minecraft: | ||
</ | </ | ||
+ | </ | ||
+ | |||
+ | <pane id=" | ||
+ | === Manual Links === | ||
+ | Images and links can also be specified manually using this format: | ||
+ | < | ||
+ | Which produces: {{: | ||
+ | |||
+ | For a plain in-line link to a page you could use: < | ||
+ | Which would produce [[mods: | ||
+ | |||
+ | <callout type=" | ||
+ | Use links with images wherever it makes sense. You can use an image for non-item pages too, like an Insulated Copper Cable image {{: | ||
+ | </ | ||
+ | </ | ||
+ | |||
+ | <pane id=" | ||
+ | === Redirects === | ||
+ | <callout icon=" | ||
+ | Redirect syntax for items is: | ||
+ | < | ||
+ | Where '' | ||
+ | Namespaces can also be nested, like < | ||
+ | **Contextual example: | ||
+ | On the page '' | ||
+ | === Vanilla Redirects === | ||
+ | Also works for external links for vanilla items, for example: | ||
+ | < | ||
+ | </ | ||
+ | </ |