Template:Which version/sandbox: Difference between revisions

Latest revision as of 20:06, 10 January 2013

Template documentation

This template is used to produce easily-updatable documentation on which version of the SMF software the user should install. Example:

{{Which version
|currentstable=1.1.13
|currentseries=1.1
|firstinseries
|deprecatedseries=1.0
|obsoleteseries=0.0
}}

currentstable The current stable version of the SMF software -- the first listed on the downloads page
currentseries The series to which the current stable version belongs (1.1.13 is in the series 1.1)
firstinseries If the current stable version is the first in a new series (2.0, 1.0, etc), include this parameter. Otherwise, leave it out.
deprecatedseries (optional) The currently deprecated series; the series which is no longer current. With the release of 1.1, the 1.0 series became deprecated. Still supported. No new features to be added. Important bugfixes possible.
obsoleteseries (optional) Any previous series which is no longer supported, and for which no new bugfixes are to be released

The above documentation is transcluded from Template:Which version/doc. (edit \| history) Editors can experiment in this template's sandbox (edit) and testcases (create) pages. Please add categories and interwikis to the /doc subpage. Subpages of this template.

@@ Line 1: / Line 1: @@
-===Current Stable Version===
+<includeonly>The current stable version, at [http://download.simplemachines.org download.simplemachines.org], is always recommended. This version has been tested and declared stable, and has all the latest features and security enhancements. Please read the client and server requirements for more information on installation requirements, to make certain your server will be able to run the current stable version of SMF. If you are preparing to install SMF for the first time, you should install the current stable version.
+For forums that are limited to running earlier branches of SMF, the current stable version of that branch is recommended. This version has the latest available security features.
+For more information, please read about [[Installing]], [[Updating]], [[Upgrading]], and [[Patching]] SMF. If you wish to convert from another forum system to SMF, please also read about [[Converting]] to SMF.
+===Current Stable Version {{{currentstable|}}}===
 The current stable version is {{{currentstable|}}}<!--
 -->{{#ifexpr: {{{firstinseries|0}}} = 1
@@ Line 7: / Line 12: @@
 If you are running an earlier version in the current series (a version in the {{{currentseries|}}}.x earlier than version {{{currentstable|}}}) it is recommended that you update to the current stable version as soon as possible. The current stable version has all the latest security enhancements, features, and bug fixes.
 To bring your forum to the latest version in the current series, your options may include:
-*'''Please update''' prompt.  If an update patch is available for your version, you will find a message, with a link, requesting you to automatically install the update, using SMF's Package Manager.  If your forum passes all the install tests, all of your installed mods will be retained. A complete list of available [[Patching|Package Manager Updates]] is available on the Simple Machines website at [http://custom.simplemachines.org/upgrades/ Package Manager Updates]. If this works, it will retain your installed mods.
+*'''[[Patching|Package Manager Updates]]''' -- the easy way to update, one minor version at a time.  Look for an [[Patching#Download_the_patch_through_the_admin_panel}update available]] message in the administration center. Follow the '''update your forum''' link to download the update patch, then apply it using the Package Manager. If all install tests pass, and you are able to apply the patch, this approach will retain all your installed mods.
-* If you are a few versions behind in the current series, it may be possible to apply one patch after another in order to reach the current stable version.
+*'''[[Updating|Small Update]]''' or '''[[Upgrading|Large Upgrade]]''' might be your best bet if '''Patching''' does not work for you. The procedure is similar to the initial SMF install, and will require you to first uninstall all mods, then reinstall them afterwards.
-*'''[[Updating|Small Update]]''', if you are using the previous version in the series. Available from [http://download.simplemachines.org download.simplemachines.org]. Uninstall all mods before beginning, and reinstall them afterwards.
-*'''[[Upgrading|Large Upgrade]]''', if you are using an earlier version in the series, or your mods give you trouble. Available from [http://download.simplemachines.org download.simplemachines.org]. Uninstall all mods before beginning, and reinstall them afterwards.
+If you are new to using SMF, and [[Patching]] did not work, you may wish to ask for help in the SMF support boards before deciding on the best course of action.
-*'''[[Installing|Full Install]]''', if all else fails. Available from [http://download.simplemachines.org download.simplemachines.org]. Reinstall all mods afterwards.
 }}<!--
 -->{{#if: {{{deprecatedseries|}}} |&nbsp;
-===Deprecated series===
+===Deprecated series -- {{{deprecatedseries|}}}===
 The {{{deprecatedseries|}}}.x series is deprecated. There will be no new features. Security updates and/or fixes for any major bugs will be made as required, in the best judgement of the team. It is still supported by the SMF team.  Upgrading to the current stable version is recommended, as long as your server meets the [[Requirements]] for the current series. If upgrade is difficult because of modifications and other customizations, upgrading to the most recent version of {{{deprecatedseries|}}}.x is recommended as a '''short term measure only'''. The most recent version of the {{{deprecatedseries|}}}.x series has the latest security features for {{{deprecatedseries|}}}.x forums, and several update and upgrade options can be found in the [http://download.simplemachines.org/?archive SMF archives]
@@ Line 21: / Line 25: @@
 -->{{#if: {{{obsoleteseries|}}}|&nbsp;
-===Obsolete series===
+===Obsolete series -- {{{obsoleteseries|}}}===
 The {{{obsoleteseries|}}}.x series is obsolete and will no longer be supported at simplemachines.org. It is recommended that the administrator obtain any assistance required to [[Upgrading|upgrade]] to the current stable version. No new features, bug fixes, or security updates will be released for the {{{obsoleteseries|}}}.x series. While obsolete series can be found in the [http://download.simplemachines.org/?archive SMF archives], they are recommended only for reference as you prepare to upgrade to the current stable version.
 Use the '''Large Upgrade''' at [http://download.simplemachines.org download.simplemachines.org] to bring your files and database up to date.}}
+===Development versions===
+Development versions (beta or RC) are not recommended for live SMF forums, as they are still being tested. Interested admins may install development versions in order to familiarize themselves with new features and options for users and administrators, and for testing. They are available at [http://download.simplemachines.org download.simplemachines.org]. Many of your favorite mods may not be compatable with the development versions of the forum. Check your mods' support threads for more information on mods.</includeonly><noinclude>{{Documentation}}</noinclude>

Navigation

Search

Tools

Template:Which version/sandbox: Difference between revisions From Online Manual

Latest revision as of 20:06, 10 January 2013