Help:Updating to a new version
| CrawlWiki (Edit box) |
|---|
This is what users of the CrawlWiki should do when a new version is released:
- Update the current stable version of Crawl.
- Create an article containing the official changelog of the new version.
- Go down the changelog, create articles for new mechanics, items, spells, etc. and update all articles which are affected by a change.
- Update the version templates of all articles not affected by the new version to the new version.
Contents
1. Update the current version of Crawl
- Go to Module:Version.
- Update "local STABLE = " to the new version number. This will automatically update the front page and all version templates.
- Create a new template with the version which is now in trunk. For example, after version 0.21 was released, we created the article Template:Version022. The content of this article is
{{version|022}}
where 022 is replaced with the new version number excluding the dot.
2. Create the version article
- Enter into the search bar http://crawl.chaosforge.org/index.php?title=0.22 where "0.22" is replaced with the new version number. Then click the "Create" button in the top right corner. This will bring up the editing box and allow you to create a new article.
- Copy and paste the following line as the first line of the new article, where "0.21" is replaced by the new version number and the date is replaced with the date the new version was released:
'''0.21''' is a version of ''Dungeon Crawl Stone Soup''. It was released on January 5, 2018.
- Copy and paste the changelog for the new version, which can be found at http://github.com/crawl/crawl/blob/stone_soup-0.21/crawl-ref/docs/changelog.txt where 0.21 in the "stone_soup-0.21" section is replaced with the new version.
- Fix the formatting on section headers: in the changelogs these are underlined. Remove these underlines and add '==' to both sides of the section header, eg.
Monsters changes to ==Monsters== --------
- Fix the formatting on bullet points: helpfully, level 1 bullet points (*) are formatted correctly already. Level 2 bullet points are shown as an indent and '-' in the changelog - remove the indent and replace it with '**'.
- Add wikilinks. Anything that you think or know is an article should be linked. This is done by surrounding the hyperlinks with '' and ''. For more information see https://www.mediawiki.org/wiki/Help:Links#Internal_links. Make sure all links work except those which refer to articles pertaining to new additions which have not yet been created.
3. Create articles and update all affected articles
- New additions are the first priority. Create articles in the same way as you did for the version article.
- Look at an article which pertains to a similar topic - ie. if a wand is added, look at the article for another wand; if a spell is added, look at the article for a spell of a similar type.
- Use all templates which are in that article for your new article. Add content which you think is relevant to the new article, and a history section containing the version the addition was added.
- Submit the new article.
- After all new additions, go down the changelog and look at each change one-by-one in turn.
- For each change, update articles directly relating to the topic, and where necessary include a note in the article's history section about the change that occurred.
- If the name of something has been changed, do not delete it or create a new article. Instead simply move (rename) the old article (in the "More" tab in the top right) to it's new name.
- If something has been removed, do not flag the article for deletion (Very rarely do we want to delete articles). Instead simply replace its version tag with {{obsolete}} and add a note in the article's history section about when it was removed.
- For everything you do in this section, include or update the version template at the top of the page to
{{version021}}
where 021 is replaced with the new version number. This indicates to the wiki community that this page does not need updating again until the next version is released.
4. Update all unaffected articles
- All articles which you didn't update by going down the changelog will be found in the category pages for preceding versions, for example Category:0.20 articles.
- Work through all of these articles, checking them for things which are now outdated (this includes changes which occurred in previous versions as well as the current version), making changes where necessary, and then updating their version tag to the up-to-date version.
- This is important for a few reasons:
- Readers want to know that the content that they are reading is up to date.
- Updating articles means less work will have to be done in future versions.
- Changing the version template ensures that the category pages are accurate, which is helpful for administration come the next update.
