×
Create a new article
Write your page title here:
We currently have 2,829 articles on YumeWiki. Type your article name above or click on one of the titles below and start writing!



    YumeWiki
    YumeWiki
    2,829Articles
    in:
    Help

    YumeWiki:Style Guide: Difference between revisions

    m (fixed some stuff, added filenames guidance)
    (mainly trimming text but keeping same meaning + add exception rule to version numbers + move connection types to Help:Connections + remove rule on nexus name in directions section + nexus world categories)
     
    (4 intermediate revisions by the same user 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.
    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]]. Although following the guide is highly encouraged, most (but not all) questions of style are usually left "to the discretion of the editor," as long as it is consistent within an article.


    ==Spelling and Grammar==
    ==Spelling and Grammar==
    ===Pronouns===
    ===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."
    For actions done by the game protagonist, use the name or the appropriate gendered pronouns (such as 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.
    Use the phrase "the player" or second-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 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.


    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.
    There are many cases where both are valid: both the player and protagonist can be said to equip effects, interact with NPCs, be transferred to another location, etc. In such cases there is no preference, but it may be best for an article to be consistent, e.g. if an earlier section says the character interacted with an NPC, later sections should also refer to the character, and not switch to referring to the player.


    ===Variations in Standard English===
    ===Variations in Standard English===
    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.
    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. This includes grammar variations such as the [[wikipedia:Serial comma|Oxford comma]]. Rare spelling variations and slang should be avoided, unless it is related to general gaming, RPG Maker, or YNFG.
     
    The Oxford comma is also up to the editor's discretion, as long as its use or lack thereof is consistent within an article.


    ===Numbers===
    ===Numbers===
    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.
    Numbers from 0-20 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. The important thing is to be consistent in the article.


    ===Version Numbers===
    ===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."
    Refer to versions using the version number and letter, e.g. "0.100a" or "version 0.100a." ''Don't'' use ".100a," or "100a," or "ver0.100a" in articles. In the case of patches, write out the word patch then the number, e.g. "0.100a patch 3." If a wiki consistently uses a different format, stay consistent with the wiki and do not change all its pages to the format outlined here.


    ===Effects===
    ===Capitalization<span id="Capitalisation"></span><span id="Effects"></span>===
    The capitalization convention for effect names is to capitalize the name of the effect, but not the word "effect", e.g. "Wolf effect".
    The capitalization convention for effect names is to capitalize the name of the effect, but not the word "effect", e.g. "[[Yume 2kki:Effects#Wolf|Wolf]] effect". The convention for location names is to copy the title of the location without making any changes. For example, for as long as [[Yume 2kki:Gallery Of Me|Gallery Of Me]] remains having incorrect title case, it is expected to be written that way in pages.


    ==Media<span id="Images"></span>==
    ==Links==
    ===Filenames===
    When using internal links to other wiki pages in articles, only the first mention of the page should be a link. Some exceptions apply:
    Filenames should be descriptive in what they contain, but short enough to be convenient. An image of a connection between two locations would probably include the locations' names, but writing their ''full, unabbreviated'' names would make the filename ridiculously long and annoying to use. Writing generic names such as <code>connection2.png</code> creates a similar issue, where it is still hard to use due to being hard to discover and keep track of.
    #[[:Category:Infobox templates|Infoboxes]] should have links even if the link exists in the article.
     
    #Every location listed in the "Directions" section of location pages should be links, besides the first and last locations.
    ===Captions===
    #Image captions in galleries may repeat links, at the discretion of the editor.
    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.
     
    ===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.


    ==Links==
    When writing links for effects, make the effect name a link but not the word "effect" itself. For example, [[Yume 2kki:Urotsuki|Urotsuki]] uses the [[Yume 2kki:Effects#Chainsaw|Chainsaw]] effect.
    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>.
    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>. If you wish to mimic the look of normal links while the link is actually an external one, wrap the link around <code><nowiki><span class="plainlinks"> </span></nowiki></code>.


    ==World Pages==
    ==Page Naming<span id="Naming"></span>==
    ===Naming===
    When naming a new location, it should generally be based on its original (probably Japanese) name, which can be found in a few possible ways:
    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 its engine and checking the map's internal name.
    #Opening the game using RPG Maker (2000 or 2003) and checking the name.<!-- how does this actually work?-->
    #Checking the name of the ''ChipSet'' (tileset) used by the map.
    #Checking the name of the ''Chipset'' used by the world.
    #In a changelog file if any (for ''Yume 2kki'' it is changelog.txt)
    #For ''Yume 2kki'', in the changelog (found in the file changelog.txt)
    There are many exceptions to using the original name, such as it being 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 map name is missing/generic. When creating a page for a location, it is good policy to check the names other people in the community are using, if any. ''Yume 2kki'' locations may have names suggested in [[Yume 2kki:Version History|Version History]] or [[Yume 2kki:Map IDs|Map IDs]].
    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.
    Do not start any article name with the indefinite article "The" even if it would make sense grammatically: 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. [[wikipedia:WP:THE|There may be a few rare exceptions.]] On the wiki, there are pages that do not follow this rule as changing the names may cause external projects to break, and it is not worth the risk.


    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.
    '''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:Yume 2kki Explorer|Yume 2kki Explorer]] or [[YNOproject:YNOproject Wiki|YNOproject]]) making use of wiki content. Alternate names may need to be chosen. For example, the character page [[Yume 2kki:***-tsuki|***-tsuki]] uses that name instead of the more common ''???-tsuki'' due to this limitation.


    ===Locationboxes===
    ==Location Pages<span id="World Pages"></span>==
    Each world page should use the [[Template:Locationbox|Locationbox template]], including an image of the world, often the entrance.
    ===Locationbox===
    Every location page must use the [[Template:Locationbox|Locationbox template]]. This template presents the basic information of the location. The template is used heavily to supply information for APIs. The only location pages that should not use the template are [[:Category:Multi-page Locations|multi-page locations]].


    ====Original Names====
    ====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.
    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]].
    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/ツクラー別マップ一覧 JP wiki,] use the name provided there. 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 Explorer. Other games are permitted to include the original japanese name in the <code>Name</code> field instead.


    ====Connections====
    ====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 linked 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.
    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. For a full guide, see [[Help:Connections]].
    <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====
    ====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.
    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. More information can be found on the template page. Information on how to style uploaded audio files is covered elsewhere in this guide.


    Blank template:
    Example:
    <pre>{{BGM|title = (e.g. examplesong)|filename = (e.g. Example.ogg)|label = |soundroom = }}</pre>
    <pre>{{BGM|title = examplesong|filename = game_examplesong_100.ogg|label = Plays in a subarea|soundroom = 008C}}</pre>


    ====Authors====
    ====Authors====
    The following applies to games with multiple authors, such as ''Yume 2kki'' and ''Uneven Dream''.
    ''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.
    Always use the original capitalization of an author's name, but do not include any special characters that are usually omitted from page or category names.


    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.
    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, that author should be listed in the <code>Contributing</code> field.


    ===Maps===
    ===Maps===
    Line 163: Line 73:
    <pre>{{LocationMap|filename=Eyeball_World.png|caption=Map of Eyeball World}}</pre>
    <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 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 major features like exits. These policies are 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:
    Maps can be edited to make the content more clear. This includes:
    *Changing the background from the panorama to a solid color
    *Changing the background from the panorama to a solid color
    *Dimming bright panoramas
    *Dimming/hiding useless paths in mazes
    *Dimming/hiding useless paths in mazes
    *Circling notable content that is hard to see
    *Circling or otherwise highlighting notable content that is hard to see
    *Moving rooms around to better draw paths between them.
    *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.
    Remember that although maps are supposed to be as accurate to the game as possible, the readability takes priority, as an unreadable map is useless.


    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.
    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].
    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===
    ===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:
    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 ''in addition'', specifying what would be required to follow that path. As an example:


    <pre>
    <pre>
    Nexus → Location A → Location B → Location C → Location D → Location E
    Nexus → Location A → Location B → Location C → Location D → Location E
    *With the <effectname> effect equipped:
    *With the <effectname> effect equipped:
    Nexus → Location A → Location X → Location E
    Nexus → Location A → Location X → Location E
    </pre>
    </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.
    There may be even more alternate paths for worlds with multiple shortcuts that rely on different prequisites to become available. If these exist, list them too. If there are multiple paths tied for the shortest length, list them all.
     
    All world names in the "Directions" section must be links to the location pages, excluding the initial location (usually the Nexus) and the location the article is about. This applies even if a world name appears multiple times across the multiple paths.
     
    Do not bold any location names in the section.
     
    ===Location Categories<span id="Categorization"></span><span id="Categorisation"></span>===
    Locations must be categorized under the wiki's specific [[:Category:In Development|In Development category]] if a future update to the world is confirmed. Removed content of any kind should be under the wiki's specific [[:Category:Removed Content|Removed Content category]]. Locations that currently connect to the game's Nexus (or Nexus equivalent) should be categorized under the wiki's specific [[:Category:Nexus Worlds|Nexus Worlds category.]]
     
    The Locationbox template used in location 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.
     
    ==Media<span id="Images"></span>==
    ===Images===
    Screenshots of games must be at least 640x480 in pixel size. Smaller screenshots should be replaced. Ideally the screenshot should be scaled to a multiple of the game resolution to avoid blur or artifacts, but this is a minor issue that is usually unnoticeable.
     
    ===Audio===
    BGM tracks uploaded for use in Locationbox and [[:Category:Soundtracks|soundtracks]] must be edited to meet the following requirements:
    *Speed (along with pitch) changed to match the one in-game
    *Converted to the [[wikipedia:Ogg|.ogg]] file format
    *Extended to at least 1 minute (this is not needed for full-length tracks or those that do not loop)
    *No added fade in or fade out
    It is preferred that BGM uploaded for other purposes such as trivia also follow these guidelines.
     
    SFX should also be edited to match the speed in-game, unless the purpose is to show the original file for comparison.
     
    ===Filenames===
    ====Image Filenames====
    Filenames of images should be descriptive in what they contain, but short enough to be convenient. Generic names such as <code>connection2.png</code> make the file hard to use and keep track of. Generally, try choosing a name for the file that is unlikely to be chosen for any other purpose. Abbreviating the game name or world names is a common way to make the name short but unique. Although there is no current rule on case, Title Case and lowercase see common usage.
     
    ====Audio Filenames====
    All audio files uploaded to the wiki must use the following format:
     
    <pre>[game name]_[original name]_[pitch].ogg</pre>
     
    For example:
     
    <pre>Yume_Nikki_【FC】BGM_003_90.ogg</pre>
     
    *<code>Yume Nikki</code> is the game name as written on the wiki
    *<code>【FC】BGM_003</code> is the original name in the game files
    *<code>90</code> is the speed setting used in-game (meaning 90% speed)
    If the speed is unchanged, the filename should still have <code>_100</code> appended. Be aware that in MediaWiki, spaces and underscores are interchangeable.
     
    ===Captions===
    While humorous captions on images can be acceptable, they should be avoided 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.
     
    ===Animated Media===
    Exercise caution in including animated images and videos, especially those containing rapid flashes. It can distract or annoy readers, and is especially a problem for any readers with 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.] It may be necessary to hide the flashing image under a collapsible section with a clear warning of the contents.


    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.
    ===Galleries<span id="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]].


    ===Categorization<span id="Categorisation"></span>===
    Normal galleries are usually preferred over slideshows. The [https://www.mediawiki.org/wiki/Extension:MultimediaViewer MultimediaViewer] feature allows users to interact with the gallery as a slideshow, and is enabled by default, making slideshow style galleries redundant.
    <!--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.
    ===Media Categories===
    Currently, there is no site-wide standard for file categories. There is a suggested [[Template:Infobox image|structure for images]] that has limited [[:Category:Amillusion Images|use in the Amillusion wiki]], but this has not been formally adopted. For now, files are not expected to have any categories on their pages.


    ==Outdated or Unused Content==
    ==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.
    Outdated or unused content should go in the "Trivia" section of the article if it may interest users, or else be removed completely. Images showcasing outdated content, such as old screenshots and maps, may be included in a subheading titled "Old Images" under "Trivia," separate from the main "Gallery." However, placing these images in the normal gallery is still accepted, and may be favourable if there are only a couple images.
     
    If a location is removed, update the connections of that location to be removed connections. This includes updating the connections from other location pages to the removed one. In the article's introductory paragraph, note that the world is removed. There is also a <code>VersionRemoved</code> parameter in Locationbox that must be added.


    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 location 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 a location page that was removed later on is not an urgent matter, but does improve the article.


    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]]
    [[Category:Help]]

    Latest revision as of 00:42, 15 July 2024

    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 talk page. Although following the guide is highly encouraged, most (but not all) questions of style are usually left "to the discretion of the editor," as long as it is consistent within an article.

    Spelling and Grammar

    Pronouns

    For actions done by the game protagonist, use the name or the appropriate gendered pronouns (such as she/her). For example, the protagonist falls asleep, not the player, so you would say "Madotsuki falls asleep."

    Use the phrase "the player" or second-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 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.

    There are many cases where both are valid: both the player and protagonist can be said to equip effects, interact with NPCs, be transferred to another location, etc. In such cases there is no preference, but it may be best for an article to be consistent, e.g. if an earlier section says the character interacted with an NPC, later sections should also refer to the character, and not switch to referring to the player.

    Variations in Standard English

    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. This includes grammar variations such as the Oxford comma. Rare spelling variations and slang should be avoided, unless it is related to general gaming, RPG Maker, or YNFG.

    Numbers

    Numbers from 0-20 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. The important thing is to be consistent in the article.

    Version Numbers

    Refer to versions using the version number and letter, e.g. "0.100a" or "version 0.100a." Don't use ".100a," or "100a," or "ver0.100a" in articles. In the case of patches, write out the word patch then the number, e.g. "0.100a patch 3." If a wiki consistently uses a different format, stay consistent with the wiki and do not change all its pages to the format outlined here.

    Capitalization

    The capitalization convention for effect names is to capitalize the name of the effect, but not the word "effect", e.g. "Wolf effect". The convention for location names is to copy the title of the location without making any changes. For example, for as long as Gallery Of Me remains having incorrect title case, it is expected to be written that way in pages.

    Links

    When using internal links to other wiki pages in articles, only the first mention of the page should be a link. Some exceptions apply:

    1. Infoboxes should have links even if the link exists in the article.
    2. Every location listed in the "Directions" section of location pages should be links, besides the first and last locations.
    3. Image captions in galleries may repeat links, at the discretion of the editor.

    When writing links for effects, make the effect name a link but not the word "effect" itself. For example, Urotsuki uses the Chainsaw effect.

    When linking to Wikipedia or other external wikis, it is preferred to use 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 [[wikipedia:Example]]. If you wish to mimic the look of normal links while the link is actually an external one, wrap the link around <span class="plainlinks"> </span>.

    Page Naming

    When naming a new location, it should generally be based on its original (probably Japanese) name, which can be found in a few possible ways:

    1. Opening the game using its engine and checking the map's internal name.
    2. Checking the name of the ChipSet (tileset) used by the map.
    3. In a changelog file if any (for Yume 2kki it is changelog.txt)

    There are many exceptions to using the original name, such as it being 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 map name is missing/generic. When creating a page for a location, it is good policy to check the names other people in the community are using, if any. Yume 2kki locations may have names suggested in Version History or Map IDs.

    Do not start any article name with the indefinite article "The" even if it would make sense grammatically: 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. There may be a few rare exceptions. On the wiki, there are pages that do not follow this rule as changing the names may cause external projects to break, and it is not worth the risk.

    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. Alternate names may need to be chosen. For example, the character page ***-tsuki uses that name instead of the more common ???-tsuki due to this limitation.

    Location Pages

    Locationbox

    Every location page must use the Locationbox template. This template presents the basic information of the location. The template is used heavily to supply information for APIs. The only location pages that should not use the template are multi-page locations.

    Original Names

    A map's original names, along with their corresponding romanizations and/or translations (if needed) should be provided in the Name field.

    For Yume 2kki maps, the JapaneseName 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 JP wiki, use the name provided there. If the map is counted as a sub-area there, include the parent area's name, separating the names with the ： 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 Explorer. Other games are permitted to include the original japanese name in the Name field instead.

    Connections

    The Connections field (and RemovedConnections field) of the Locationbox template makes use of the Connection template for each connection. The parameters are explained in the template documentation. For a full guide, see Help:Connections.

    BGM

    The BGM list must use the BGM template. The title of the BGM is usually the name used in the game files. The filename is instead the name of the uploaded audio file on the wiki. More information can be found on the template page. Information on how to style uploaded audio files is covered elsewhere in this guide.

    Example: 

    {{BGM|title = examplesong|filename = game_examplesong_100.ogg|label = Plays in a subarea|soundroom = 008C}}

    Authors

    The following applies to games with multiple authors, such as Yume 2kki and Uneven Dream.

    Always use the original capitalization of an author's name, but do not include any special characters that are usually omitted from page or category names.

    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, that author should be listed in the Contributing field.

    Maps

    All world maps intended for use in navigation are inserted using the LocationMap template.

    Example: 

    {{LocationMap|filename=Eyeball_World.png|caption=Map of Eyeball World}}

    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 major features like exits. These policies are 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 bright panoramas
    • Dimming/hiding useless paths in mazes
    • Circling or otherwise highlighting 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, the readability takes priority, as an unreadable map is useless.

    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 GIMP and 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 in addition, specifying what would be required to follow that path. As an example: 

    Nexus → Location A → Location B → Location C → Location D → Location E
*With the <effectname> effect equipped:
Nexus → Location A → Location X → Location E

    There may be even more alternate paths for worlds with multiple shortcuts that rely on different prequisites to become available. If these exist, list them too. If there are multiple paths tied for the shortest length, list them all.

    All world names in the "Directions" section must be links to the location pages, excluding the initial location (usually the Nexus) and the location the article is about. This applies even if a world name appears multiple times across the multiple paths.

    Do not bold any location names in the section.

    Location Categories

    Locations must be categorized under the wiki's specific In Development category if a future update to the world is confirmed. Removed content of any kind should be under the wiki's specific Removed Content category. Locations that currently connect to the game's Nexus (or Nexus equivalent) should be categorized under the wiki's specific Nexus Worlds category.

    The Locationbox template used in location pages automatically inserts the appropriate Locations category for that game, as well as inserting the primary author's category if one specified.

    Media

    Images

    Screenshots of games must be at least 640x480 in pixel size. Smaller screenshots should be replaced. Ideally the screenshot should be scaled to a multiple of the game resolution to avoid blur or artifacts, but this is a minor issue that is usually unnoticeable.

    Audio

    BGM tracks uploaded for use in Locationbox and soundtracks must be edited to meet the following requirements:

    • Speed (along with pitch) changed to match the one in-game
    • Converted to the .ogg file format
    • Extended to at least 1 minute (this is not needed for full-length tracks or those that do not loop)
    • No added fade in or fade out

    It is preferred that BGM uploaded for other purposes such as trivia also follow these guidelines.

    SFX should also be edited to match the speed in-game, unless the purpose is to show the original file for comparison.

    Filenames

    Image Filenames

    Filenames of images should be descriptive in what they contain, but short enough to be convenient. Generic names such as connection2.png make the file hard to use and keep track of. Generally, try choosing a name for the file that is unlikely to be chosen for any other purpose. Abbreviating the game name or world names is a common way to make the name short but unique. Although there is no current rule on case, Title Case and lowercase see common usage.

    Audio Filenames

    All audio files uploaded to the wiki must use the following format: 

    [game name]_[original name]_[pitch].ogg

    For example: 

    Yume_Nikki_【FC】BGM_003_90.ogg
    • Yume Nikki is the game name as written on the wiki
    • 【FC】BGM_003 is the original name in the game files
    • 90 is the speed setting used in-game (meaning 90% speed)

    If the speed is unchanged, the filename should still have _100 appended. Be aware that in MediaWiki, spaces and underscores are interchangeable.

    Captions

    While humorous captions on images can be acceptable, they should be avoided if useful information or descriptions can be given instead. YumeWiki strives to be informative and professional first and foremost, so practice good judgment in caption selection.

    Animated Media

    Exercise caution in including animated images and videos, especially those containing rapid flashes. It can distract or annoy readers, and is especially a problem for any readers with photosensitive epilepsy. Consider using the Photosensitive Epilepsy Analysis Tool (PEAT) to test if the animated content is safe for viewing given such conditions. An additional guide can be found here. It may be necessary to hide the flashing image under a collapsible section with a clear warning of the contents.

    Galleries

    Pictures in galleries should be present in the current version of the game or else moved to the "Trivia" section in accordance with Outdated or Unused Content.

    Normal galleries are usually preferred over slideshows. The MultimediaViewer feature allows users to interact with the gallery as a slideshow, and is enabled by default, making slideshow style galleries redundant.

    Media Categories

    Currently, there is no site-wide standard for file categories. There is a suggested structure for images that has limited use in the Amillusion wiki, but this has not been formally adopted. For now, files are not expected to have any categories on their pages.

    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. Images showcasing outdated content, such as old screenshots and maps, may be included in a subheading titled "Old Images" under "Trivia," separate from the main "Gallery." However, placing these images in the normal gallery is still accepted, and may be favourable if there are only a couple images.

    If a location is removed, update the connections of that location to be removed connections. This includes updating the connections from other location pages to the removed one. In the article's introductory paragraph, note that the world is removed. There is also a VersionRemoved parameter in Locationbox that must be added.

    In addition, if you are writing a page for a location 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 a location page that was removed later on is not an urgent matter, but does improve the article.

    Retrieved from "https://yume.wiki/index.php?title=YumeWiki:Style_Guide&oldid=481922"