Help:Editing: Difference between revisions
m (→Images) |
m (update capitalization style) |
||
| Line 6: | Line 6: | ||
===Capitalization=== | ===Capitalization=== | ||
Article pages should follow the capitalization of the subject if it appears in-game. This guideline should also be followed when linking to other articles. For example, the item ''[[Poké Ball]]'' is capitalized. Article page titles which do not refer to in-game subjects should be in sentence case, and lowercase when linked. For example, ''[[held items]]'' is not capitalized. | |||
===Point of View=== | ===Point of View=== | ||
| Line 12: | Line 12: | ||
==Files== | ==Files== | ||
File names should be | File names should follow the capitalization of the subject. Files which do not refer to in-game subjects should be in sentence case. The Wiki will automatically capitalize it on the file's page. If the file name contains spaces, replace them with underscores before uploading. Once uploaded, the file can be linked using spaces. | ||
If there are multiple files with the same name, suffix the additional files with a descriptor. For existing cases of similar file names, like block and item sprites, item sprite files should take precedence and should have the original file name. | If there are multiple files with the same name, suffix the additional files with a descriptor surrounded by parenthesis. For existing cases of similar file names, like block and item sprites, item sprite files should take precedence and should have the original file name. | ||
For example, as <code> | For example, as <code>Red_Apricorn.png</code> denotes the item sprite image, the file name for the block render image should be <code>Red Apricorn_(block).png</code>. | ||
For blocks or other subjects that may have multiple variations like crop stages, add the variation label at the end of the file name. For block renders, this will come after <code>block</code>. For example, <code> | For blocks or other subjects that may have multiple variations like crop stages, add the variation label at the end of the file name. For block renders, this will be separated with a comma and come after <code>block</code>. For example, <code>Apricorn_Block_'''(stage_1)'''.png</code> or <code>Healing_Machine_(block,_'''charge_2)'''.png</code>. | ||
If an item has any additional models, such as Poké Balls when held in the main or off-hand, suffix the file name with <code>model</code>. | If an item has any additional models, such as Poké Balls when held in the main or off-hand, suffix the file name with <code>(model)</code>. | ||
===Images=== | ===Images=== | ||
Revision as of 16:22, 13 May 2023
Style Guide
The purpose of this section is to establish a standardized format for articles and files.
Articles
Pages on in-game subjects like blocks and items should start with a small description of the subject. The first instance of the subject name should be bold.
Capitalization
Article pages should follow the capitalization of the subject if it appears in-game. This guideline should also be followed when linking to other articles. For example, the item Poké Ball is capitalized. Article page titles which do not refer to in-game subjects should be in sentence case, and lowercase when linked. For example, held items is not capitalized.
Point of View
Articles should be written in an encyclopedic manner, therefore the point of view should be in third person. When referring to the player, use "the player" or "players" instead of "you".
Files
File names should follow the capitalization of the subject. Files which do not refer to in-game subjects should be in sentence case. The Wiki will automatically capitalize it on the file's page. If the file name contains spaces, replace them with underscores before uploading. Once uploaded, the file can be linked using spaces.
If there are multiple files with the same name, suffix the additional files with a descriptor surrounded by parenthesis. For existing cases of similar file names, like block and item sprites, item sprite files should take precedence and should have the original file name.
For example, as Red_Apricorn.png denotes the item sprite image, the file name for the block render image should be Red Apricorn_(block).png.
For blocks or other subjects that may have multiple variations like crop stages, add the variation label at the end of the file name. For block renders, this will be separated with a comma and come after block. For example, Apricorn_Block_(stage_1).png or Healing_Machine_(block,_charge_2).png.
If an item has any additional models, such as Poké Balls when held in the main or off-hand, suffix the file name with (model).
Images
For formality and standardization, an isometric view is preferred for images of in-game subjects like blocks. Avoid taking default in-game screenshots. Isometric projection renders can be generated through programs like Blockbench or through mods like Isometric Renders.
Blocks
For images of blocks, make sure the image dimensions conform to the size of a standard block. This ensures image uniformity, and will make transitioning between images cleaner for infoboxes and galleries. If a block is smaller than the standard block size, do not crop the image, revise the image dimensions to be equivalent to the dimensions of a standard block image instead. If a block is larger than a standard block like a door block, then revise the image dimensions to be that of an image that encompasses the amount of standard block sized spaces the block will take up.
Apricorn block within a standard block for reference.
- Red apricorn block.png
Apricorn block with reference removed. Note that the image dimensions do not change.
Moving
If moving or renaming files, do not allow the old file name to redirect to the new one.