v50 Steam/Premium information for editors
  • v50 information can now be added to pages in the main namespace. v0.47 information can still be found in the DF2014 namespace. See here for more details on the new versioning policy.
  • Use this page to report any issues related to the migration.
This notice may be cached—the current version can be found here.

Difference between revisions of "Dwarf Fortress Wiki:Versions"

From Dwarf Fortress Wiki
Jump to navigation Jump to search
(Created page with 'This is a proposal for a new method of organizing information on the wiki in light of the upcoming release of Dwarf Fortress 2010. It is completely up for discussion …')
 
(add shortcuts)
(27 intermediate revisions by 11 users not shown)
Line 1: Line 1:
This is a proposal for a new method of organizing information on the wiki in light of the upcoming release of [[DF2010|Dwarf Fortress 2010]].  It is completely up for discussion and all input is welcome.  Feel free to make changes to this directly if you think you have a great idea. If you have a suggestion you think might be questionable or if you disagree with a portion of the proposal that has already been suggested, please bring it up on the [[Dwarf Fortress Wiki Talk:Versions|talk page]] to get the input of every editor until we can hopefully reach a consensus on the best way of approaching the recent change, and all future upkeep of the wiki to avoid obsolete information.
+
{{shortcut|DF:V|DF:VER}}
 +
[[category:Wikiprojects]]
 +
These are the methods we use to organize versions on the wiki. Please bring any questions to the [[Dwarf Fortress Wiki Talk:Versions|talk page]].  
  
 
== Goal ==
 
== Goal ==
  
The goal of this effort is to effectively yet subtely mark articles according to how up-to-date they currently are.  Ultimately there are two goals:
+
The goal of this effort is to effectively mark articles according to the version they are about.  Ultimately there are two goals:
  
*Allow users to know exactly how up to date or not a particular article is
+
*Allow users to know what major version (23a, 40d, etc...) an article pertains to.
*Allow editors to easily find articles which are out of date.
+
*Allow editors to easily find topics for which a current version article is not complete.
  
== Proposed Approach ==
+
'''This is not intended to''':
 +
*Remove all information about older versions. These articles have been moved to appropriate namespaces (ex. 40d:, 23a:), and the {{tl|ArticleVersion}} template (which should be added to every version specific page) links between the various versions, noting clearly (through color and message) whether it is the current version.
  
We could utilize an approach based off of creative use of templates and categories.  We can have a template that we place on all relevant articles which marks how up to date the article is, for example:
+
== Approach ==
  
<pre>
+
=== Per topic ===
{{Version|40d}}
+
Each feature or idea that has an article will feature the "up to date" version and "old" versions: (note, if an article is version independent these points do not apply)
Article information
 
</pre>
 
  
<pre>
+
*The mainspace article will (usually) never contain anything.
{{Version|pre DF2010}}
+
*There will be namespaces for every major version: "DF2014" (likely to be renamed once a new save-incompatible DF version is released), "v0.34", "v0.31", "40d", and "23a".
Article information
+
*The cv: alias will redirect to the current version, ie. "{{DF:Current}}".
</pre>
 
  
<pre>
+
=== Version articles ===
{{Version|DF2010}}
+
There is a template that should be placed on all version-specific pages. It looks like this (though it looks different on actual articles):
Article information
+
{{av}}
</pre>
 
  
This will place a small box in the top-right corner of the article which will give information to the user that this article is either up to date, or how out of date it currently is. It will also place an article into a category based off of how obsolete or not the information currently is.
+
An example of this template on a real page can be seen at "milk": [[{{DF:Current}}:Milk]], [[v0.31:Milk]], [[40d:Milk]], [[23a:Milk]].
  
One version will be considered "current", and articles marked with that version will be placed into a category marking it as such, all other articles will be put into a category marking them as Obsolete, and also placing them into a category of how out of date they currently are.
+
This template is added by placing {{tl|av}} (or {{tl|ArticleVersion}}) at the top of an article.
  
In this way when a new version comes out, a small change can be made to the template which will mark many articles "obsolete", and editors can comb through these articles over time and making sure all information on them is accurate as of the most recent version, which they can note in the template at the top.
+
The template will check the namespace of the article and use that to determine if the article pertains to the current version or not.
  
This ensures that random articles don't lay dormant without being updated for many versions, and also that this can be done with minimal effort.
+
It will also place an article into a category based on whether or not it pertains to the current version.
 +
 
 +
One version will be considered "current", and articles in that namespace with the version template will be placed into a category marking it as such, all other articles will be put into a category marking them as Obsolete, and also placing them into a category based off of their version (from the article namespace).
 +
 
 +
With very little effort (read the [[template:av|documentation]]) every page's version template can be automatically updated when a new version arrives. This process automatically changes what namespace shows up as current on each page and what categories pages are put into. This makes it wonderfully easy the next time a new version comes around.
 +
 
 +
=== Redirects ===
 +
{{shortcut|DF:R|DF:REDIR}}
 +
Redirects to content in the current namespace should almost always be created in the current namespace, ''not'' the main namespace, and should use the current namespace as the namespace for the redirect. Redirects created in the main namespace to pages in a versioned namespace should only redirect to pages with the same name (create double redirects if needed). For example, [[{{DF:Current}}:Kitten]] should redirect to [[{{DF:Current}}:Cat]], not [[Cat]] or [[cv:Cat]]. In cases where a redirect does need to be created in the main namespace, use "cv" for the redirects namespace instead (this is a shortcut to the current namespace). ('''Note''': Currently there seems to be a bug with such redirects in that they redirect to the v0.34 namespace instead of DF2014.)
 +
 
 +
Pages in the mainspace should only redirect to an older versioned page if that content no longer exists in the current version of the game (e.g. [[Cave river]], [[Chunk]]). In these cases the cv: alias cannot be used. 
 +
 
 +
Redirects inside a versioned namespace should always use that namespace as the prefix (e.g. [[DF2014:Dodging]], [[v0.31:Drink]]), not the cv: alias.
 +
 
 +
An example of redirecting the page "kitten" to "cat":
 +
 
 +
{|class="wikitable"
 +
! !! Main namespace !! {{ns|{{current/version}}}}
 +
|-
 +
|| '''Kitten''' || '''Kitten''' <hr> ``#REDIRECT [[cv:Kitten]]`` &rarr; || '''{{ns|{{current/version}}}}:Kitten''' <hr> ``#REDIRECT [[{{ns|{{current/version}}}}:Cat]]`` &darr;
 +
|-
 +
|| '''Cat''' || '''Cat''' <hr> ``#REDIRECT [[cv:Cat]]`` &rarr; || '''{{ns|{{current/version}}}}:Cat''' <hr> content about cats
 +
|}
  
 
----
 
----
  
It is likely that the above description will require some tweaking over time so feel free to make any changes you think might be useful or bring up any comments on the [[Dwarf Fortress Wiki Talk:Versions|talk page]].
+
Although a lot of this is already underway, you should still feel free to make suggestions or bring up any comments on the [[Dwarf Fortress Wiki Talk:Versions|talk page]].

Revision as of 23:57, 27 June 2019

Shortcuts:
DF:V
DF:VER

These are the methods we use to organize versions on the wiki. Please bring any questions to the talk page.

Goal

The goal of this effort is to effectively mark articles according to the version they are about. Ultimately there are two goals:

  • Allow users to know what major version (23a, 40d, etc...) an article pertains to.
  • Allow editors to easily find topics for which a current version article is not complete.

This is not intended to:

  • Remove all information about older versions. These articles have been moved to appropriate namespaces (ex. 40d:, 23a:), and the {{ArticleVersion}} template (which should be added to every version specific page) links between the various versions, noting clearly (through color and message) whether it is the current version.

Approach

Per topic

Each feature or idea that has an article will feature the "up to date" version and "old" versions: (note, if an article is version independent these points do not apply)

  • The mainspace article will (usually) never contain anything.
  • There will be namespaces for every major version: "DF2014" (likely to be renamed once a new save-incompatible DF version is released), "v0.34", "v0.31", "40d", and "23a".
  • The cv: alias will redirect to the current version, ie. "Main".

Version articles

There is a template that should be placed on all version-specific pages. It looks like this (though it looks different on actual articles):

This article is in the DF wiki namespace.

An example of this template on a real page can be seen at "milk": Main:Milk, v0.31:Milk, 40d:Milk, 23a:Milk.

This template is added by placing {{av}} (or {{ArticleVersion}}) at the top of an article.

The template will check the namespace of the article and use that to determine if the article pertains to the current version or not.

It will also place an article into a category based on whether or not it pertains to the current version.

One version will be considered "current", and articles in that namespace with the version template will be placed into a category marking it as such, all other articles will be put into a category marking them as Obsolete, and also placing them into a category based off of their version (from the article namespace).

With very little effort (read the documentation) every page's version template can be automatically updated when a new version arrives. This process automatically changes what namespace shows up as current on each page and what categories pages are put into. This makes it wonderfully easy the next time a new version comes around.

Redirects

Shortcuts:
DF:R
DF:REDIR

Redirects to content in the current namespace should almost always be created in the current namespace, not the main namespace, and should use the current namespace as the namespace for the redirect. Redirects created in the main namespace to pages in a versioned namespace should only redirect to pages with the same name (create double redirects if needed). For example, Main:Kitten should redirect to Main:Cat, not Cat or cv:Cat. In cases where a redirect does need to be created in the main namespace, use "cv" for the redirects namespace instead (this is a shortcut to the current namespace). (Note: Currently there seems to be a bug with such redirects in that they redirect to the v0.34 namespace instead of DF2014.)

Pages in the mainspace should only redirect to an older versioned page if that content no longer exists in the current version of the game (e.g. Cave river, Chunk). In these cases the cv: alias cannot be used.

Redirects inside a versioned namespace should always use that namespace as the prefix (e.g. DF2014:Dodging, v0.31:Drink), not the cv: alias.

An example of redirecting the page "kitten" to "cat":

Main namespace Main
Kitten Kitten
#REDIRECT cv:Kitten
Main:Kitten
#REDIRECT Main:Cat
Cat Cat
#REDIRECT cv:Cat
Main:Cat
content about cats

Although a lot of this is already underway, you should still feel free to make suggestions or bring up any comments on the talk page.