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. 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.
Spelling and Grammar
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 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 in which second-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.
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.
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. 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 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.
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."
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. An exception is for pages using Locationbox or 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 location pages should be links.
When writing links for effects, the convention is to 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:
- Opening the game using RPG Maker (2000 or 2003) and checking the map's name.
- Checking the name of the ChipSet used by the map.
- 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 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 Map IDs and Version History.
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, including a picture that represents the area. The template is also used heavily to supply information for APIs. The only location pages that should not use the template are those that cover multiple areas, such as the Yume Nikki:Dense Woods page.
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, and 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.
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 found on the template's page. A guide on using connection types can be found below.
Connection Types
One-way Connections
The connection should make use of the one_way_type parameter when appropriate. If a Location A can lead you to a Location B, but you are unable to connect back, it is a NoReturn connection. Keep in mind that NoReturn connections on one page correspond to NoEntry connections on another. In this example, Location B has an exit from Location A, which is a connection with NoEntry specified.
Unlockable Connections
In the case of connections that are only unlocked by visiting the location using the other side, the locked connection uses unlock_type=Locked, and the other side of the connection - which unlocks the first - should use unlock_type=Unlock. A good example is the Yume 2kki:Library connection to the Yume 2kki:Infinite Library being Locked, and the reverse connection having Unlock.
If the conditions are more complex, use unlock_type=LockedCondition. You can specify a short description on what the conditions are using unlock_conditions, or link to a full page of conditions using unlock_instruction_link. The link formate is the same as wikilinks, i.e. Namespace:World Name.
Connections Requiring Effects
For connections only accessible with effects, specifiy it using effects_needed. If multiple effects are needed, separate them with commas. If only one of the specified effects is needed for the connection, specify effect_conjunction=Or.
Isolated Connections
For connections that lead to an isolated section of another world. For the isolated section, use isolation_type=DeadEnd in the article of the location where it belongs, to signify that the connection only exists to serve as a dead end.
On the page of the location that leads to the isolated section, use isolation_type=Return for that connection, to signify that the only option after following that connection is to return to the location.
Chance Connections
For connections that are only available by chance, write the fractional probability using chance_description. It is common practice to write something like "1/3 chance". You can optionally include the percentage by also specifying chance_percentage
Telephone Connections
For shortcuts accessible from the telephone found in Urotsuki's Dream Apartments. Naturally, the parameter is used extensively in said article and its connections. For the connections to other worlds from Urostuki's Dream Apartments, specify phonebooth_type=ExitPoint, and for connections from other worlds to Urostuki's Dream Apartments, specify phonebooth_type=Shortcut.
Seasonal Connections
For connections available only in certain seasons, e.g. season=Winter.
Removed Connections
For connections that have been removed from the game, list them down in the RemovedConnections field of Locationbox instead, and remember to specify
is_removed=true.
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. It is recommended to always upload the audio file and include the filename. More information can be found on the template page.
Blank template:
{{BGM|title = (e.g. examplesong)|filename = (e.g. Example.ogg)|label = |soundroom = }}
Authors
The following applies to games with multiple authors, such as Yume 2kki and Uneven Dream.
When specifying a map's Primary 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 Contributing 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 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 exit(s). 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 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 as secondary, specifying what would be required to follow that path. As an example:
The Nexus → Location A → Location B → Location C → Location D → Location E *With the <effectname> effect equipped: The 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. "The Nexus" is the preferred way to refer to the area, even if the wiki's name for the page is just "Nexus".
Location Categories
Locations must be categorized under their specific In Development category if a future update to the world is confirmed. For example, locations in Yume 2kki would be categorized under Yume 2kki In Development. Removed worlds are (for now) categorized as Removed Content.
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
Filenames
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 location names, but writing their full, unabbreviated names would make the filename ridiculously long and annoying to use. Writing generic names such as connection2.png creates a similar issue, where it is still hard to use due to being hard to discover and keep track of. Generally, try choosing a name for the file that is unlikely to be chosen for any other purpose.
Most BGM uploaded for use on the wiki is named the same way as the original audio file from the game's folder. This name may contain non-ASCII characters such as Japanese text. It is expected to follow this convention and keep the original names, as it is widely done throughout the site, despite it making the files hard to read and write to English speakers.
There is no convention for the style of filenames. Possible styles are PascalCase, Snake_case and Title_Case. Note that in MediaWiki the case of the first letter of filenames is ignored, and spaces are interchangeable with underscores; world name.png is equivalent to World_name.png
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
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 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.
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 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.
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 whole world is removed, update the connections of that world to be removed connections. This includes updating the connections from other world pages to the removed world. 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 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.