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
(→‎Proposed Approach: what I feel is the current consensus)
 
(23 intermediate revisions by 8 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 an article is up to date
+
*Allow users to know what major version (23a, 40d, etc...) an article pertains to.  
*If an article isn't up to date, allow a user to know exactly how out of date it currently is.
+
*Allow editors to easily find topics for which a current version article is not complete.
*Allow editors to easily find articles which are out of date and improve them.
 
  
 
'''This is not intended to''':
 
'''This is not intended to''':
*Remove all information about older versions. These items can be moved to the end of the articles and labeled with the [[Template:version|Version template]] or something similar.
+
*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.
  
:Comment: In the past, 100% of legacy info was deleted as undesirable.  No comments about "in past verions", no "until recently it worked like this..." - if it wasn't up-to-date, it was confusing, and dumped.  If we go with another wiki - regardless if we use this engine or another one - we can leave this here for as a "mostly(?) complete" d40 manual and move forward with DF2010 separately, copy/pasting if appropriate, but without losing any of this. (Otoh, if d40 is going the way of the 2-Dimensional version etc, maybe this will all be pointless to save, or save for very long.)--[[User:Albedo|Albedo]] 09:42, 1 March 2010 (UTC)
+
== Approach ==
:Comment: Would it be possible to have a link to a pdf of the d40 manual?  Would it even make sense?--[[User:Kwieland|Kwieland]] 17:31, 3 March 2010 (UTC)
 
 
 
== Proposed Approach ==
 
  
 
=== Per topic ===
 
=== Per topic ===
Each feature or idea that has an article will feature the "up to date" version and "old" versions
+
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 main article, which will contain information about the new version, and will contain a box with a link to the previous version information. If the topic is no longer relevant to the current version then the article will simply redirect to the old version article
+
*The mainspace article will contain content for the latest DF version ({{DF:Current}}).
*A version of the article referring to a version of the game based on a different "namespaces", ex. [[40d:Weapons]]
+
*There are namespaces for major historical versions: "DF2014", "v0.34", "v0.31", "40d", and "23a".
 +
*The cv: alias will redirect to the current version, ie. "{{DF:Current}}".
  
 
=== Version articles ===
 
=== Version articles ===
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 version articles which marks how up to date the article is, for example:
+
There is a template that should be placed on all version-specific pages. It looks like this (though it looks different on actual articles):
 +
{{av}}
  
<pre>
+
An example of this template on a real page can be seen at "milk": [[{{DF:Current}}:Milk]], [[v0.31:Milk]], [[40d:Milk]], [[23a:Milk]].
{{Version}}
 
Article information
 
</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.
+
This template is added by placing {{tl|av}} (or {{tl|ArticleVersion}}) at the top of an article.
  
The template will read in the namespace of the article and use that to determine if this article is the most up to date version.  If it's in the "main" namespace then it is the most up to date.
+
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 off of how obsolete or not the information currently is.
+
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).
 
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).
  
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 will provide in them a link to the location of the most up to date versionEditors can comb through these articles over time and fill in the new articles with relevant information.
+
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 should always point to a page in the same namespace as the redirect (e.g. [[DF2014:Dodging]], [[v0.31:Drink]]). Do not use the "cv:" alias.
 +
 
 +
Pages in the main namespace 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.   
 +
 
 +
=== Premium/Classic ===
 +
Current articles cover both the Premium and Classic builds of DF. This means that, whenever possible, content should be available for both versions. This includes graphics - for instance, if adding a premium graphic, do not remove an existing classic graphic/diagram (but do update it if it is out of date).
  
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.
+
==== Premium graphics ====
 +
We have permission from Kitfox to upload premium screenshots and sprites. Please ''do not'' upload complete sprite sheets, or anything that would enable recreating Premium DF.
  
 
----
 
----
  
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]].

Latest revision as of 04:21, 1 January 2023

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[edit]

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[edit]

Per topic[edit]

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 contain content for the latest DF version (Main).
  • There are namespaces for major historical versions: "DF2014", "v0.34", "v0.31", "40d", and "23a".
  • The cv: alias will redirect to the current version, ie. "Main".

Version articles[edit]

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[edit]

Shortcuts:
DF:R
DF:REDIR

Redirects should always point to a page in the same namespace as the redirect (e.g. DF2014:Dodging, v0.31:Drink). Do not use the "cv:" alias.

Pages in the main namespace 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.

Premium/Classic[edit]

Current articles cover both the Premium and Classic builds of DF. This means that, whenever possible, content should be available for both versions. This includes graphics - for instance, if adding a premium graphic, do not remove an existing classic graphic/diagram (but do update it if it is out of date).

Premium graphics[edit]

We have permission from Kitfox to upload premium screenshots and sprites. Please do not upload complete sprite sheets, or anything that would enable recreating Premium DF.


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.