|
|
| (28 intermediate revisions by 7 users not shown) |
| Line 1: |
Line 1: |
| The '''Style Guide''' is a descriptive standard for Yume Wiki style, conventions, and formatting to help users edit consistently. The proper venue to discuss these guidelines is in the [[YumeWiki talk:Style Guide|talk]] page. Many questions of style are left "to the discretion of the editor," but it should be noted that these choices should be consistent within an article, and that just because an edit isn't outlawed by the Style Guide doesn't mean that it can't be reverted. It should also be noted that in certain circumstances there can be exceptions to possibly any rule here.
| | {{StyleGuideNav}} |
|
| |
|
| ==Spelling and Grammar==
| | The '''Style Guide''' is the descriptive standard for Yume Wiki's style and formatting conventions to ensure users edit consistently. |
| ===Pronouns===
| |
| For actions done by the game protagonist, use the name (e.g. "Madotsuki") or the appropriate gendered pronouns (usually she/her). For example, the protagonist falls asleep, not the player, so you would say "Madotsuki falls asleep."
| |
|
| |
|
| Use the phrase "the player" or 2nd person pronouns when referring to actions done by or to the player. For example, the player interacts with the user interface, such as menus. Another context in which 2nd person pronouns can be used is when something is visible on the screen, as it is the player who sees the top-down view displayed on the screen, not the protagonist.
| | Editors should generally follow the contents of this guide, though some exceptions may apply. Please ''do '''not''''' make substantive edits to this guide without consensus. |
|
| |
|
| Note that this policy is contested in the cases of using effects and interacting with objects or NPCs, as it is something that the protagonist does in-game, but also a choice made by the player. It is up to the editor's discretion to decide, based on the context, when it is appropriate to refer to the protagonist or to the player. Individual articles should be consistent in their use of pronouns.
| | If you have questions, concerns, or suggestions about these guidelines, please use the [[YumeWiki talk:Style Guide|talk page]]. |
|
| |
|
| ==Variations in Standard English== | | ==Contents== |
| It is up to the editor's discretion whether they use American, British, or other spellings, as long as all spellings are standard across an article. Rare spelling variations and slang should be avoided, unless it is used by communities users are likely to be a part of, such as general gaming, RPG Maker, or YNFG vocabulary and slang.
| | For ease of reading, the Style Guide has been split into separate sections. |
|
| |
|
| The Oxford comma is also up to the editor's discretion, as long as its use or lack thereof is consistent within an article.
| | * [[/Spelling and Typography|'''Spelling and Typography''']] contains formatting conventions, mostly related to spelling, punctuation, capitalization, and special formatting conventions for numbers. It also contains our guidelines for Japanese romanization. |
| | * [[/Grammar and Usage|'''Grammar and Usage''']] contains conventions related to appropriate use of grammar on the Yume Wiki. It contains guidelines for grammatical person, grammatical tense, and contractions. |
| | * [[/Tone|'''Tone''']] contains conventions related to creating an encyclopedic and professional tone on the Yume Wiki, and general advice for writing clearly and informatively. It also describes reliability standards for article content. |
| | * [[/Links|'''Links''']] contains conventions related to creating links on the Yume Wiki, to both internal and external pages. |
| | * [[/Titles and Article Organization|'''Titles and Article Organization''']] contains conventions for naming and organizing articles. It also describes acceptable formats for articles. |
| | * [[/Location Pages|'''Location Pages''']] contains conventions specific to creating location pages, which are the most common type of page on the Yume Wiki. It also contains all of our guidance on creating readable maps of locations. |
| | * [[/Media|'''Media''']] contains conventions related to uploading and formatting media on the Yume Wiki. It contains all of our guidelines for uploading images and audio, and adding galleries to pages. |
| | * [[/Outdated or Unused Content|'''Outdated or Unused Content''']] contains conventions related to documenting content that is inaccessible through regular gameplay or has been removed. |
| | * [[/Miscellaneous|'''Miscellaneous Guidelines''']] contains everything that does not fit anywhere else. Specifically, it contains guidelines concerning page styling (including the use of color), the use of text in images, non-breaking spaces, the creation of pronunciation guides, and content related to badges. |
|
| |
|
| ===Numbers===
| | [[Category:Rules and guidelines]] |
| Numbers from 0-12 should be written out as words, e.g. "six" unless in a mathematical or statistical context. Large numbers should be written in using numerals, e.g. "123". The cut off is generally between twenty and twenty-one, because hyphenated numbers are best written using numerals for ease of reading and spelling. Exceptions can be made at the editor's discretion, but be consistent.
| | [[Category:Yume Wiki Style Guide]] |
| | |
| ===Version Numbers===
| |
| The preferred way to refer to versions is the version number and letter, e.g. "0.100a". ''Don't'' use ".100a" or "100a" or "ver0.100a" in articles. The long way of referring to a version is "version 0.100a", with version uncapitalized (unless at the beginning of a sentence or as part of a header). In the case of patches, write out the word patch then the number, e.g. "0.100a patch 3."
| |
| | |
| ===Effects===
| |
| The capitalization convention for effect names is to capitalize the name of the effect, but not the word "effect", e.g. "Wolf effect".
| |
| | |
| ==Media<span id="Images"></span>==
| |
| ===Animated Media===
| |
| As a safety measure, exercise caution in including animated images and videos pertinent to the game, especially those containing rapid flashes, for the sake of any readers who have photosensitive epilepsy. Consider using the [https://trace.umd.edu/peat Photosensitive Epilepsy Analysis Tool (PEAT)] to test if the animated content is safe for viewing given such conditions. An additional guide can be found [https://www.useragentman.com/blog/2017/04/02/using-peat-to-create-seizureless-web-animations/ here].
| |
| | |
| ===Galleries and Slideshows===
| |
| Pictures in galleries should be present in the current version of the game or else moved to the "Trivia" section in accordance with [[YumeWiki:Style Guide#Outdated or Unused Content|Outdated or Unused Content]].
| |
| | |
| Slideshows shouldn't be used for articles in which there are many images so the user isn't forced to click excessively. For that reason, and also because slideshows don't allow the user to know what images are present until it is clicked through completely, it is probably best to use normal galleries in articles, although this is left at the discretion of the editor.
| |
| | |
| ===Captions===
| |
| While humorous captions on images can be acceptable, they shouldn't be used if useful information or descriptions can be given instead. {{SITENAME}} strives to be informative and professional first and foremost, so practice good judgment in caption selection.
| |
| | |
| ==Links==
| |
| When using internal links to other wiki pages in articles, only the first mention of the page should be a link. An exception is for pages using Locationbox or [[Template:NPCBox|NPCBox]], where the pages listed in the boxes should be links even if the link exists on the article. Another exception is that every location listed in the "Directions" section of world pages should be links.
| |
| | |
| When linking to Wikipedia or other external wikis, it is preferred to use [[wikipedia:Help:Interwiki linking|interwiki links]] rather than linking their URL, as it is a much cleaner and simpler way to link to such pages. Currently the only interwiki link is <code><nowiki>[[wikipedia:Example]]</nowiki></code>.
| |
| | |
| ==World Pages==
| |
| ===Naming===
| |
| When naming a new world, the name of the world should generally be based on its original (probably Japanese) name, which can be found in a few possible ways:
| |
| #Opening the game using RPG Maker (2000 or 2003) and checking the name.<!-- how does this actually work?-->
| |
| #Checking the name of the ''Chipset'' used by the world.
| |
| #For ''Yume 2kki'', in the changelog (found in the file changelog.txt)
| |
| There are many exceptions to using the original name, such as if the name is too similar to another name (in which case it should be something else to avoid confusion), if the Japanese name sounds awkward when translated into English, or if the world name is missing/generic. When creating a page for a world, it is good policy to check the names other people are using if any. ''Yume 2kki'' worlds may have world names suggested in [[Yume 2kki:Map IDs|Map IDs]] and [[Yume 2kki:Version History|Version History]].
| |
| | |
| Do not start a world name with "The" even if it would make sense: doing so makes it hard to find, sort, and link to. For example, [[Yume 2kki:Spaceship]] is always referred to as "the Spaceship," but does not include "The" in the page name.
| |
| | |
| Avoid using special characters like '''&''' or '''?'''; these are reserved URL parameter delimiters, and doing otherwise will break APIs (e.g. those used in external projects like Yume 2kki Explorer or YNOproject) making use of wiki content.
| |
| | |
| ===Locationboxes===
| |
| Each world page should use the [[Template:Locationbox|Locationbox template]], including an image of the world, often the entrance.
| |
| | |
| ====Original Names====
| |
| A map's original names, along with their corresponding romanizations and/or translations (if needed) should be provided in the <code>Name</code> field.
| |
| | |
| For ''Yume 2kki'' maps, the <code>JapaneseName</code> field should be filled in with exactly one value, which is the map's original name written in Japanese. If the map's equivalent name is available on the [https://wikiwiki.jp/yume2kki-t/%E3%83%84%E3%82%AF%E3%83%A9%E3%83%BC%E5%88%A5%E3%83%9E%E3%83%83%E3%83%97%E4%B8%80%E8%A6%A7 JP wiki], use the name provided there, and if the map is counted as a sub-area there, include the parent area's name, separating the names with the <code>：</code> full-width colon (e.g. Parent area name：Child area name). This field is used in displaying an area's Japanese name in the [[Yume 2kki:Yume 2kki Explorer|Yume 2kki Explorer]].
| |
| | |
| ====Connections====
| |
| The <code>Connections</code> field (and <code>RemovedConnections</code> field) of the Locationbox template makes use of the [[Template:Connection|Connection template]] for each connection; the parameters are explained in the template documentation (found on the link page). <!--A guide on using connection types can be found below. Commented out because it's outdated, uncomment and delete this sentence after updating it.
| |
| <div class="mw-collapsible mw-collapsed">
| |
| <big>'''Connection Types'''</big>
| |
| <div class="mw-collapsible-content">
| |
| =====<u>One-way Connections</u>=====
| |
| The list of connections to the world should make use of the NoReturn {{OneWay|NoReturn}} or NoEntry {{OneWay|NoEntry}} symbols when appropriate. Keep in mind that NoReturn connections on one page correspond to NoEntry connections on another.
| |
| | |
| =====<u>Unlockable Connections</u>=====
| |
| In the case of unlockable connections that are unlocked by visiting the area from another map, the locked side uses Locked {{Unlockable|Locked}}.
| |
| | |
| <pre>{{Unlockable|Locked}}</pre>
| |
| | |
| The opposite side uses {{Unlockable|Unlock}}.
| |
| | |
| <pre>{{Unlockable|Unlock}}</pre>
| |
| | |
| If the conditions are more complex, use {{Unlockable|LockedCondition|#Locationboxes|Link to instructions.}}, including a link to the instructions for unlocking the connection in the third field or use the fourth field to add instructions {{Unlockable|LockedCondition||Instructions here.}}.
| |
| | |
| <pre>{{Unlockable|LockedCondition|Link to instructions about how to unlock|Description}}</pre>
| |
| | |
| <pre>{{Unlockable|LockedCondition||Instructions about how to unlock}}</pre>
| |
| | |
| =====<u>Connections Requiring Effects</u>=====
| |
| For connections only accessible with effects, use the {{NeedsEffect}} symbol. If the required effect is known, include the effect name(s) as such:
| |
| | |
| <pre>{{{NeedsEffect|Bike}}}</pre>
| |
| to signify that the Bike effect is required to enter.<br /><br />
| |
| If multiple effects are needed, separate them with commas:
| |
| | |
| <pre>{{{NeedsEffect|Bike, Chainsaw, Wolf}}}</pre>
| |
| | |
| For cases where either one of a set of effects are required, include Or as the third field:
| |
| | |
| <pre>{{{NeedsEffect|Child, Fairy|Or}}}</pre>
| |
| | |
| =====<u>Isolated Connections</u>=====
| |
| For connections that lead to an isolated section of another world. For the isolated section, use {{Isolated|DeadEnd}} in the article of the area where it belongs:
| |
| | |
| <pre>{{Isolated|DeadEnd}}</pre>
| |
| | |
| For the area that leads to the isolated section, use {{Isolated|Return}}:
| |
| | |
| <pre>{{Isolated|Return}}</pre>
| |
| | |
| =====<u>Chance Connections</u>=====
| |
| For connections that are only available by chance {{Chance}}.
| |
| | |
| <pre>{{Chance|Optional description}}</pre>
| |
| | |
| =====<u>Telephone Connections</u>=====
| |
| For shortcuts accessible from the telephone found in [[Yume 2kki:Urotsuki's Dream Apartments|Urotsuki's Dream Apartments]].
| |
| | |
| The {{Phonebooth|ExitPoint}} symbol is used in the [[Yume 2kki:Urotsuki's Dream Apartments|Urotsuki's Dream Apartments]] article.
| |
| | |
| <pre>{{Phonebooth|ExitPoint}}</pre>
| |
| | |
| The {{Phonebooth|Shortcut}} symbol is used in the article of the area where the shortcut leads.
| |
| | |
| <pre>{{Phonebooth|Shortcut}}</pre>
| |
| | |
| =====<u>Seasonal Connections</u>=====
| |
| For connections available only in certain [[Yume 2kki:Randomizers#Seasonal_System|seasons]]:
| |
| | |
| Winter {{Seasonal|Winter}}
| |
| <pre>{{Seasonal|Winter}}</pre>
| |
| | |
| Spring {{Seasonal|Spring}}
| |
| <pre>{{Seasonal|Spring}}</pre>
| |
| | |
| Summer {{Seasonal|Summer}}
| |
| <pre>{{Seasonal|Summer}}</pre>
| |
| | |
| Fall {{Seasonal|Fall}}
| |
| <pre>{{Seasonal|Fall}}</pre>
| |
| | |
| =====<u>Removed Connections</u>=====
| |
| For connections that have been removed from the game, '''list them down in the <code>RemovedConnnections</code> field of Locationbox instead''', and remember to specify:
| |
| <pre>|is_removed=true</pre>.
| |
| </div></div> comment out, delete this after updating-->
| |
| | |
| ====BGM====
| |
| The BGM list must use the [[Template:BGM|BGM template]]. The <code>title</code> of the BGM is usually the name used in the game files. The <code>filename</code> is instead the name of the '''uploaded audio file''' on the wiki. It is recommended to ''always'' upload the audio file and include the <code>filename</code>. More information can be found on the template page.
| |
| | |
| Blank template:
| |
| <pre>{{BGM|title = (e.g. examplesong)|filename = (e.g. Example.ogg)|label = |soundroom = }}</pre>
| |
| | |
| ====Authors====
| |
| The following applies to games with multiple authors, such as ''Yume 2kki'' and ''Uneven Dream''.
| |
| | |
| When specifying a map's <code>Primary</code> author, use the original capitalization of the author's name.
| |
| | |
| If an author has made additions to an existing map that isn't theirs, or has only implemented a map by proxy without actually "authoring" it, the <code>Contributing</code> field should provide the author(s) who have performed such additions, formatted in a comma-separated list. Again, use the original capitalizations of the names.
| |
| | |
| ===Maps===
| |
| All world maps intended for use in navigation are inserted using the [[Template:LocationMap|LocationMap template]].
| |
| | |
| Example:
| |
| <pre>{{LocationMap|filename=Eyeball_World.png|caption=Map of Eyeball World}}</pre>
| |
| | |
| Maps should have connections labeled. Labels are usually white bubbles with the names in black text, using a simple font like Arial or Century Gothic. Teleporters and important items such as effects and notable NPCs should also be labelled. For mazes, paths should be drawn from the entrance(s) of the world to its exit(s). This policy is especially important for maps with many entrances, exits, and teleporters. Labels and paths should keep in mind accessibility concerns (for example, using ''only'' colors will make it hard to read for those who are colorblind).
| |
| | |
| Maps can be edited to make the content more clear. This includes:
| |
| *Changing the background from the panorama to a solid color
| |
| *Dimming/hiding useless paths in mazes
| |
| *Circling notable content that is hard to see
| |
| *Moving rooms around to better draw paths between them.
| |
| Remember that although maps are supposed to be as accurate to the game as possible, an unreadable map is useless and must be changed.
| |
| | |
| Maps that are included for trivia or other purposes, such as maps of older versions, do not have the same policies as described above, and '''should not''' use the LocationMap template.
| |
| | |
| Examples of free image editing and digital painting software are [https://www.gimp.org/downloads/ GIMP] and [https://medibangpaint.com/en/app-download/ Medibang].
| |
| | |
| ===Directions===
| |
| When listing the directions to an area, always consider the shortest possible path (in terms of worlds visited) that does not require any prerequisites (e.g. effects or unlockable shortcuts) to entry. If there is a shorter path that has prerequisites to reaching it, it should be listed as secondary, specifying what would be required to follow that path. As an example:
| |
| | |
| <pre>
| |
| Nexus → Location A → Location B → Location C → Location D → Location E
| |
| | |
| *With the <effectname> effect equipped:
| |
| Nexus → Location A → Location X → Location E
| |
| </pre>
| |
| There may be even more alternate paths for worlds with multiple shortcuts, that rely on different prequisites to become available. If these exists, list them too.
| |
| | |
| All world names in the "Directions" section must be links to the location pages, excluding the name of the world the page is about. This applies even if a world name appears multiple times across the multiple paths.
| |
| | |
| ===Categorization<span id="Categorisation"></span>===
| |
| <!--Need to update this section-->
| |
| Worlds must be categorized as [[:Category:In Development|In Development]] if a future update to the world is confirmed. Removed worlds should be categorized as [[:Category:Removed Content|Removed Content]].
| |
| | |
| The Locationbox template used in world pages automatically inserts the appropriate [[:Category:Locations|Locations category]] for that game, as well as inserting the [[:Category:Authors|primary author's category]] if one specified.
| |
| | |
| ==Outdated or Unused Content==
| |
| Outdated or unused content should go in the "Trivia" section of the article if it may interest users, or else be removed completely.
| |
| | |
| If a whole world is removed, then change the connections of that world to removed connections. This includes changing the connections ''from other world pages'' to the removed world. In the article's introductory paragraph, note that the world is removed.
| |
| | |
| In addition, if you are writing a page for a world that has already been removed (for example, the page [[Yume 2kki:Droplets World]] was written long after the world itself was removed), you should use past tense. Changing all the tenses from present to past in world page that was removed later on is not an urgent matter, but does improve the article.
| |
| [[Category:Help]]
| |
