Minecraft Wiki:Style guide/Versions

From Minecraft Wiki
Jump to navigation Jump to search

All version articles should use the following layout, to allow for consistency between version articles. Themed update articles (like World of Color Update or Tricky Trials) are not version articles and should not use the following layout.

Introduction

[edit source]

Right before the lead, {{infobox version}} should be placed.

After the template should be an introduction with a general description. This description should contain the release date of the update, the official name (if it has one), the edition and development phase the version was released for, and a brief description of the update. If it is a development version, it should state which version of it is a development version.

If the version has been re-uploaded, the lead should list the changes in the re-upload(s). If there are many changes (typically for old pre-Alpha versions), a separate page may be created for the re-upload(s); for example, each version of Java Edition Indev 0.31 is technically a re-upload of the first one but it would be unwieldy to have them all on one page.

Lead examples

[edit source]
Major release versions
1.10, the first release of the Frostburn Update,[1] is a major update to Minecraft (Java Edition) released on June 8, 2016, which adds (...)
Minor release versions
1.14.1 is a minor update to Java Edition released on May 13, 2019, which improves performance and fixes bugs in 1.14. It is not compatible with 1.14 servers.
Development versions
18w43b is the second snapshot for Java Edition 1.14, released on October 24, 2018, which fixes bugs in 18w43a.

Additions, Changes, Removals

[edit source]

These sections are combined in the guide due to similarity: in actual articles these shall be separate sections called Additions, Changes, and (if applicable) Removals. General changes in a version should go within the sections as follows:

  • Additions: Any new features added in the version. This includes features added in development versions.
  • Changes: Any changes to old features from the version. This includes features changed in development versions.
  • Removals: If applicable, any complete removals shall be listed here, unless they are directly related to a change in the Changes section (such as a replacement, or a splitting of an existing feature).

If the version is a full release or has a lot of features, each section also should have the following subsections:

  • Blocks
  • Items
  • Mobs
  • Non-mob entities (armor stands, minecarts, etc)
  • World generation
  • Gameplay: gameplay mechanics (achievements, status effects, game modes, etc).
  • Command format: command-related mechanics (commands, block/entity tags, functions, etc)
  • General (options, splashes, graphics changes, etc)

If the features have not appeared in a development version yet, the feature should be contained in the separate but similar section Planned additions or Planned changes.

Each feature of a numbered update or snapshot version should be named in bold as a pseudo-heading, then described using a bulleted list under that heading. For any additions, this list should be mostly comprehensive, including any major details about the feature, but should also be as condensed as possible for easier readability. Most additions should be covered in 8 or fewer bullet points and should rarely ever be more than 12. Any changes, as well as the rare case of additions that are not covered on their own page, should include all relevant details, even less important ones, although they should still be as brief as possible without losing any information. For abnormally large changes, such as the Flattening in Java Edition 1.13, it may be desired to split them into a separate page and summarize them briefly on the version page.

Isometric render(s) of the feature (if applicable) should be added before the name of the feature in the heading if and only if the feature was added in the version, or its texture or model was changed in the version.

Named update pages, such as Update Aquatic, should only list individual additions, not describing their usage or behavior at all, and summarize any changes as briefly as possible.

Experimental

[edit source]

Additions and changes that happen only under experiments should be included in this section, and should be formatted as outlined in § Additions, Changes, Removals.

Unconfirmed features

[edit source]

Unless the information is well sourced, this section is not recommended to be added. This section is only for versions under development, and only contains features:

  • no longer confirmed as planned or upcoming for that (or any particular) version,
  • and evidenced, since the version started development, by:
    • a screenshot showing that a developer has worked on the feature,
    • or a developer's statement indicating they do plan to add the feature – not merely a statement responding to another person's idea.

It should start with the text: These features are not confirmed for <version>, but they were mentioned or showcased by developers during <version> development. Main article: Mentioned features

Each feature should consist of:

  • A name or short description of the feature,
  • No details, beyond what it takes to identify the feature (these belong on Mentioned features),
    • The purpose of this section is just for readers to identify the features that are unconfirmed, and to communicate why that is so – not to get into the feature's details.
  • A brief explanation, with supporting references, of when the feature was mentioned and why it is not confirmed.

Bugs fixed in this version using {{fixes}}. Bugs should also be organised into sections using the following headers:

  • From released versions before <parent version> (;old)
    • If applicable, this should be split into "From released versions before 1.x.0", "From 1.x.0", "From 1.x.1", etc., for versions after a 1.x.1 release (e.g., 1.14.3).
  • From the <parent version> development versions (;dev)
  • From the previous development version (;prev)
  • From the current version, hotfixed (;hotfix)
  • Private issues (;private)

Note that {{fixes}} supports shortcuts for common headers.

The titles from the bug tracker issues may be freely edited to comply with the style guide. While users are encouraged to fix the titles as they find them, fixing the titles is not required; specifically when first adding the issues. Editors may make major changes to the title (such as rewording the whole title), though this is discouraged unless the original title fails to adequately describe the issue (eg, change "I found a bug" to "The player cannot jump when up against a block").

Bug fixes may only be added to a version page if the resolution is explicitly marked as “Fixed”. Bug fixes which have a resolution other than “Fixed” are subject to immediate removal.

Videos

[edit source]

The videos section of version pages should go below the fixes section, but above any other sections, such as trivia, gallery, and references. These videos are made as an unofficial, personal project by slicedlime, the Tech Lead for Java Edition, and are highlights of the additions and changes in each version and development version. Using {{slicedlime}}, simply replace "video_id" to the YouTube video ID:

== Videos ==
{{slicedlime|video_id}}

Multiple videos may be added and the header may be automatically added as well; see documentation.

Trivia

[edit source]

Notable information may be added in a Trivia section as described by MCW:TRIVIA. This may include unique information about the development cycle of this version, statistics, and information on this being the first version since some specified previous version to have some specific attribute.

[edit source]