Difference between revisions of "NetHackWiki:Next version"

From NetHackWiki
Jump to navigation Jump to search
(needs lesser precision)
(rewrite to not make the page sound like 3.6.0 has only recently been released; rewrite list and present it as de facto standards that have emerged, not a proposal)
Line 1: Line 1:
We now have the [[NetHack 3.6.0|next version of NetHack]] on our hands. There shall be much rejoicing—and much work to be done on NetHackWiki. Much information on NetHackWiki shall be out of date and need to be updated. NetHackWiki editors have no experience of such an event: nearly every word here was written in the [[NetHack 3.4.3]] era. Toward that end, this project proposes a way to identify articles that need to be updated.
+
Following the release of [[NetHack 3.6.0]], there was much rejoicing — and much work to be done on NetHackWiki. Much of the information on NetHackWiki was made out of date and needed to be updated. At the time, NetHackWiki editors had no experience of such an event: nearly every word on the wiki was written in the [[NetHack 3.4.3]] era. Thus, this wiki needed to develop a system of tracking articles that were updated versus articles that had not yet been updated, especially after further versions of 3.6 were subsequently released and it became possible for a page to be updated to a 3.6 version and still out of date. Toward that end, this project proposes a way to identify articles that need to be updated.
  
The present proposal (subject to revision given input from NetHackWiki editors) is to tag articles with one of the following templates:
+
The present de facto standard for articles about vanilla NetHack (subject to revision given input from NetHackWiki editors) is the following:
  
*<nowiki>{{</nowiki>[[Template:nethack-360|nethack-360]]}}, articles that pertain to [[:Category:Nethack-360 articles|NetHack 3.6.0]].
+
# If you are editing a page and know that the entire page is up-to-date with the current version of NetHack, apply the template for the current version to the bottom of the page. For example, if the last released version is [[NetHack 3.6.6]], use the <nowiki>{{</nowiki>[[Template:NetHack-366|nethack-366]]}} template, which puts the page into [[:Category:Nethack-366 articles]].
**Remake this template to <nowiki>{{</nowiki>[[Template:nethack-36|nethack-36]]}} for all 3.6.x revisions or all revisions after 3.6.1.  Make 3.7 follow the same pattern.
+
# Pages that are only known to be updated through some non-current version of NetHack should have the template for that non-current version.
*<nowiki>{{</nowiki>[[Template:nethack-343|nethack-343]]}}, articles that pertain to [[:Category:Nethack-343 articles|NetHack 3.4.3 and now need to be updated]].
+
#* Pages typically fall into this category by a new version being released, rather than through actively being edited that way.
*<nowiki>{{</nowiki>[[Template:slashem-7E7|slashem-7E7]]}}, articles that pertain to [[SLASH'EM]] 0.0.7E7 and need to be updated when the next version of SLASH'EM is released. SLASH'EM gets its own tag because of the large number of articles relating to it.
+
#* Examples of templates like this are <nowiki>{{</nowiki>[[Template:Nethack-343|nethack-343]]}} or <nowiki>{{</nowiki>[[Template:Nethack-361|nethack-361]]}}, which place the page into [[:Category:Nethack-343 articles]] and [[:Category:Nethack-361 articles]] respectively.
*<nowiki>{{</nowiki>[[Template:variant-343|variant-343]]}}, articles that pertain to a variant of NetHack 3.4.3 other than SLASH'EM and need to be updated when that variant incorporates NetHack 3.6.0. This tag is only used for variants such as [[UnNetHack]] that are still under active development.
+
#* Articles in categories for previous versions should be reviewed for anything that is outdated, updated to describe the current version if necessary, and have their tag changed to the current version's tag.
*<nowiki>{{</nowiki>[[Template:noversion|noversion]]}}, articles that do not need to be revised; this tag is for historical articles such as the version writeups, or articles on defunct variants, people, external programs, and the like.
+
# Articles that do not need to be revised when the next version is released should be given <nowiki>{{</nowiki>[[Template:noversion|noversion]]}}. This tag is for historical articles such as the version writeups, or articles on defunct variants, defunct features, people, external programs, and the like.
*<nowiki>{{</nowiki>[[Template:unknownversion|unknownversion]]}}, articles that are new and not tagged by its author; this tag is for bots ([[User:ChasonBot|ChasonBot]] will eventually be one) that tag new articles pending review, and is meant to be manually replaced by one of the other tags.
+
# Articles that are new and not tagged by their author may have <nowiki>{{</nowiki>[[Template:unknownversion|unknownversion]]}} applied to them by bots ([[User:ChasonBot|ChasonBot]] will eventually be one) that tag new articles pending review. This is meant to be manually replaced by one of the other tags.
 +
 
 +
There are also a couple existing standards for articles about variants:
 +
 
 +
# Articles pertaining to [[SLASH'EM]] 0.0.7E7 should be tagged with <nowiki>{{</nowiki>[[Template:slashem-7E7|slashem-7E7]]}}. SLASH'EM gets its own tag because of the large number of articles relating to it, though it may become unnecessary in the future to track its version because development on it has ceased.
 +
# Articles pertaining to an actively developed variant of NetHack 3.4.3 other than SLASH'EM may use <nowiki>{{</nowiki>[[Template:variant-343|variant-343]]}}. This is ostensibly for tracking articles that need to be updated when that variant incorporates NetHack 3.6; however, no 3.4.3-based variant has done this so far.
  
 
The tag templates display a small icon at the top of the page.
 
The tag templates display a small icon at the top of the page.

Revision as of 02:39, 28 June 2020

Following the release of NetHack 3.6.0, there was much rejoicing — and much work to be done on NetHackWiki. Much of the information on NetHackWiki was made out of date and needed to be updated. At the time, NetHackWiki editors had no experience of such an event: nearly every word on the wiki was written in the NetHack 3.4.3 era. Thus, this wiki needed to develop a system of tracking articles that were updated versus articles that had not yet been updated, especially after further versions of 3.6 were subsequently released and it became possible for a page to be updated to a 3.6 version and still out of date. Toward that end, this project proposes a way to identify articles that need to be updated.

The present de facto standard for articles about vanilla NetHack (subject to revision given input from NetHackWiki editors) is the following:

  1. If you are editing a page and know that the entire page is up-to-date with the current version of NetHack, apply the template for the current version to the bottom of the page. For example, if the last released version is NetHack 3.6.6, use the {{nethack-366}} template, which puts the page into Category:Nethack-366 articles.
  2. Pages that are only known to be updated through some non-current version of NetHack should have the template for that non-current version.
    • Pages typically fall into this category by a new version being released, rather than through actively being edited that way.
    • Examples of templates like this are {{nethack-343}} or {{nethack-361}}, which place the page into Category:Nethack-343 articles and Category:Nethack-361 articles respectively.
    • Articles in categories for previous versions should be reviewed for anything that is outdated, updated to describe the current version if necessary, and have their tag changed to the current version's tag.
  3. Articles that do not need to be revised when the next version is released should be given {{noversion}}. This tag is for historical articles such as the version writeups, or articles on defunct variants, defunct features, people, external programs, and the like.
  4. Articles that are new and not tagged by their author may have {{unknownversion}} applied to them by bots (ChasonBot will eventually be one) that tag new articles pending review. This is meant to be manually replaced by one of the other tags.

There are also a couple existing standards for articles about variants:

  1. Articles pertaining to SLASH'EM 0.0.7E7 should be tagged with {{slashem-7E7}}. SLASH'EM gets its own tag because of the large number of articles relating to it, though it may become unnecessary in the future to track its version because development on it has ceased.
  2. Articles pertaining to an actively developed variant of NetHack 3.4.3 other than SLASH'EM may use {{variant-343}}. This is ostensibly for tracking articles that need to be updated when that variant incorporates NetHack 3.6; however, no 3.4.3-based variant has done this so far.

The tag templates display a small icon at the top of the page.

If multiple tags appear on a single article, they can be separated using an "offset" parameter like this: {{nethack-360|offset=2}}{{slashem-7E7|offset=1}}{{variant-343}}. {{noversion}} should never need to be used with another of these tags, but supports offset anyway, so it can be used together with the featured article tag.

With the articles so tagged, once the next version is released, the relevant tag template can be changed to display a prominent header, and add the article to a category. Once an editor has reviewed the article, and either updated it or determined that its information is still current, one can change the tag template to {{nethack-360}}. This shall go back to showing a small icon, and remove the header from the article and the article from the category.

A note on the tile images

Tile images have been revised in the past and the next version may do so again. If this happens, the old tiles ought not be overwritten, as they are still be needed for the version writeups; rather, they ought be moved to the historic tiles page and the new tiles uploaded with new names. The What links here link for the old images can identify articles that need to point to the new tile. Alternatively, the old images can be renamed, the version writeups revised, and the new tiles uploaded using the original name.

See also