===================================================
   view template for Foswiki release notes   
===================================================
}%%TMPL:INCLUDE{"view"}%
%TMPL:DEF{"content"}%
%IF{
  "$'LATEST_RELEASE_TOPIC'=$'TOPIC'"
  then="$percentCALC{\"$SET(release_type, LATEST)\"}$percent"
  else="$percentIF{
    \"$'LATEST_RELEASE_TOPIC'>$'TOPIC'\"
    then=\"$dollarpercentCALC{\\"$dollarSET(release_type$comma ARCHIVED)\\"}$dollarpercent\"
    else=\"$dollarpercentCALC{\\"$dollarSET(release_type$comma BETA)\\"}$dollarpercent\"
  }$percent"
}%%IF{
  "'%CALC{"$GET(release_type)"}%' = 'LATEST'"
  then="---+!! Foswiki Release $percntQUERY{Release}$percnt"
}%%IF{
  "'%CALC{"$GET(release_type)"}%' = 'ARCHIVED'"
  then="---+!! Foswiki archived release
<div class='foswikiNotification'><span class='foswikiAlert'>$percntICON{alert}$percnt This release is superseded by Foswiki $percntQUERY{'%LATEST_RELEASE_TOPIC%'/Release}$percnt. [[%LATEST_RELEASE_TOPIC%][Visit the download page]].</span></div>"
}%%IF{
  "'%CALC{"$GET(release_type)"}%' = 'BETA'"
  then="---+!! Foswiki Beta release $percntQUERY{Release}$percnt
<div class='foswikiNotification'><span class='foswikiAlert'>$percntICON{alert}$percnt This is a BETA release. Download [[%LATEST_RELEASE_TOPIC%][the latest official release ($percntQUERY{'%LATEST_RELEASE_TOPIC%'/Release}$percnt)]].</span></div>"
}%

See [[ReleaseDates][Release Dates]] for the complete list of available releases.
<style>
.foswikiToc {
  float: right;
  background: #F1F1F1;
  border: 1px solid #DADADA;
  padding: 15px;
  font-size: 85%;
  max-width: 40%;
  margin: 0 0 0 20px;
}
.foswikiToc ul {
  padding: 0;
}
.foswikiToc li {
  margin-left: 0;
  padding-left: 15px;
}
</style>
%TOC{title="Table of Contents"}%
%QUERY{"Summary"}%

%SEARCH{
  "AffectedReleases=~'\b%TOPIC%\b'"
  topic="Security*"
  type="query"
  web="Support"
  nonoise="on"
  header="<div class='foswikiNotification'><span class='foswikiAlert'>$percntX$percnt *Security alerts or advisories apply to this release:* </span>"
  format="   * [[$web.$topic][$percntIF{
    \"'$web.$topic'/CVEID\"
    then=\"CVE-$formfield(CVEID): \"
  }$percnt$formfield(Summary)]]"
  footer="<span class='foswikiAlert'> *This release is vulnerable to the above alerts. Instructions on how to mitigate these issues are described in the alert details.* </span></div>"
}%

#DownloadRelease
---++ Download

GPG Signatures and MD5 checksums are provided for verifying the integrity of the files for the primary download packages.

%INCLUDE{
  "Download.FoswikiReleaseViewTemplate"
  section="download-%FORMFIELD{"DownloadSource" topic="%BASEWEB%.%BASETOPIC%"}%"
}%
%IF{
  "NOT NoUpgrade"
  then="$percntINCLUDE{\"Download.FoswikiReleaseViewTemplate\" section=\"upgrade-header\"}$percnt$percntINCLUDE{
    \"Download.FoswikiReleaseViewTemplate\"
    section=\"download-%FORMFIELD{"DownloadSource" topic="%BASEWEB%.%BASETOPIC%"}%-upgrade\"
  }$percnt"
}%
<verbatim class="foswikiHidden">
%STARTSECTION{"download-none"}%
<blockquote class="foswikiAlert"> *This release has not been built yet!*  This is a draft of the release announcement.  If you want an early start to testing, see Development.GitBasedInstall.</blockquote>
%ENDSECTION{"download-none"}%

%STARTSECTION{"download-topic"}%
%INCLUDE{"Download.FoswikiReleaseViewTemplate" section="download"
  release="%FORMFIELD{"Release" topic="%BASETOPIC%"}%"
  url="%PUBURLPATH%/%BASEWEB%/%BASETOPIC%"
  upgraded=""
  upgrade=""
}%
%ENDSECTION{"download-topic"}%

%STARTSECTION{"download-topic-upgrade"}%
%INCLUDE{"Download.FoswikiReleaseViewTemplate" section="download"
  release="%FORMFIELD{"Release" topic="%BASETOPIC%"}%"
  url="%PUBURLPATH%/%BASEWEB%/%BASETOPIC%"
  upgraded="upgrade-"
  upgrade="upgrade"
}%
%ENDSECTION{"download-topic-upgrade"}%

%STARTSECTION{"download-sourceforge"}%
%INCLUDE{"Download.FoswikiReleaseViewTemplate" section="download"
  release="%FORMFIELD{"Release" topic="%BASETOPIC%"}%"
  url="http://sourceforge.net/projects/foswiki/files/foswiki/%FORMFIELD{"Release" topic="%BASETOPIC%"}%"
  upgraded=""
  upgrade=""
}%
%ENDSECTION{"download-sourceforge"}%

%STARTSECTION{"download-sourceforge-upgrade"}%
%INCLUDE{"Download.FoswikiReleaseViewTemplate" section="download"
  release="%FORMFIELD{"Release" topic="%BASETOPIC%"}%"
  url="http://sourceforge.net/projects/foswiki/files/foswiki/%FORMFIELD{"Release" topic="%BASETOPIC%"}%"
  upgraded="upgrade-"
  upgrade="upgrade"
}%
%ENDSECTION{"download-sourceforge-upgrade"}%

%STARTSECTION{"download-github"}%
%INCLUDE{"Download.FoswikiReleaseViewTemplate" section="download"
  release="%FORMFIELD{"Release" topic="%BASETOPIC%"}%"
  url="https://github.com/foswiki/distro/releases/download/%FORMFIELD{"ReleaseTag" topic="%BASETOPIC%"}%"
  upgraded=""
  upgrade=""
}%
%ENDSECTION{"download-github"}%

%STARTSECTION{"download-github-upgrade"}%
%INCLUDE{"Download.FoswikiReleaseViewTemplate" section="download"
  release="%FORMFIELD{"Release" topic="%BASETOPIC%"}%"
  url="https://github.com/foswiki/distro/releases/download/%FORMFIELD{"ReleaseTag" topic="%BASETOPIC%"}%"
  upgraded="upgrade-"
  upgrade="upgrade"
}%
%ENDSECTION{"download-github-upgrade"}%

%STARTSECTION{"download"}%
%TABLE{sort="off"}%
| *File* | *GPG* | *MD5* | *Description* |
| [[%url%/Foswiki-%upgraded%%release%.tgz][%ICON{download}% Foswiki-%upgraded%%release%.tgz]] | [[%url%/Foswiki-%upgraded%%release%.tgz.asc][GPG]] | [[%url%/Foswiki-%release%.md5][MD5]] | %upgrade% tar gz version of Foswiki |
| [[%url%/Foswiki-%upgraded%%release%.zip][%ICON{download}% Foswiki-%upgraded%%release%.zip]] | [[%url%/Foswiki-%upgraded%%release%.zip.asc][GPG]] | [[%url%/Foswiki-%release%.md5][MD5]] | %upgrade% zip version of Foswiki |%IF{"'%upgraded%'='' and '%FORMFIELD{"VMImage" topic="%BASETOPIC%"}%'='1'" then="
| [[%url%/Foswiki-%release%-vmware.%FORMFIELD{"VMFormat" topic="%BASETOPIC%"}%][%ICON{download}% Foswiki-%release%-vmware.%FORMFIELD{"VMFormat" topic="%BASETOPIC%"}%]] | [[%url%/Foswiki-%release%-vmware.%FORMFIELD{"VMFormat" topic="%BASETOPIC%"}%.asc][GPG]] | [[%url%/Foswiki-%release%-vmware.md5][MD5]] | [[Support.VirtualMachineImages][VM Image (instructions)]] |"}%%ENDSECTION{"download"}%

%STARTSECTION{"upgrade-header"}%
---++ Upgrade packages

%IF{"'%BASETOPIC%'/UpgradeFrom=''" 
   else="These packages can be used to upgrade __Foswiki Release %FORMFIELD{"UpgradeFrom" topic="%BASETOPIC%"}% or newer__. See [[#Upgrade_Instructions]] for further information"
   then="If you already have an earlier version of Foswiki %FORMFIELD{"ReleaseMajor" topic="%BASETOPIC%"}%.%FORMFIELD{"ReleaseMinor" topic="%BASETOPIC%"}%.X installed, you can extract an upgrade package on top of the installation. The =major.minor= part of the release should not be changed by an upgrade package."}%

%X% Upgrade packages must not be used to upgrade older releases.

%ENDSECTION{"upgrade-header"}%
</verbatim>
%IF{
  "OtherDownloads"
  then="---+++ Other downloads/installers$n$percntQUERY{OtherDownloads}$percnt"
}%

---++ Getting help & providing feedback
%IF{
  "'%CALC{"$GET(release_type)"}%' = 'BETA'" then="Refer to the INSTALL.html and !UpgradeGuide.html shipped in the root of the Beta distribution" else="
Don't forget to use the [[System.UpgradeGuide][upgrade]] or [[System.InstallationGuide][installation guides]]."}% If you need help, there are several options:
   * The [[Support.GetLiveSupport][IRC channel]]
   * [[Community.MailingLists][foswiki-discuss]] mailing list
   * [[Support.WebHome][Support forum]]
   * [[Support.WikiConsultants][Paid support]]

We want to hear from you! Especially if you have noticed a bug, have some ideas we could use, or just want to contribute:
   * [[Tasks.CreateNewTask][File a new task]] for bug reports
   * Create, review or comment on [[Development.FeatureProposals][feature proposals]] to help influence the future of Foswiki
   * Chat with other users, developers, translators, and testers on our friendly [[Support.GetLiveSupport][IRC channel]]
   * If E-mail is more your thing, try our [[Community.MailingLists][foswiki-discuss]] mailing list

%INCLUDE{"%BASEWEB%.%BASETOPIC%"}%

---++ Installation

Please refer to the INSTALL.html which can be found the downloaded tgz/zip.  It can be also found on Foswiki.org in the  [[System.InstallationGuide]] 

---++ Upgrade Instructions

%IF{"NoUpgrade" 
  then="<div class=\"foswikiHelp\">Upgrade packages are not available for this release.  Install as a new release and migrate the configuration and data.</div>"
  else="<div class=\"foswikiHelp\">
      %IF{"UpgradeFrom" 
         then="In-place upgrade from any release prior to %FORMFIELD{"UpgradeFrom" topic="%BASETOPIC%"}% is __not recommended__.  Older Foswiki installations should install Foswiki as a new release,  configure, and then migrate data to the new installation."
         else="In-place upgrade from any release prior to Foswiki %FORMFIELD{"ReleaseMajor" topic="%BASETOPIC%"}%.%FORMFIELD{"ReleaseMinor" topic="%BASETOPIC%"}%.0 is __not recommended__.  Older Foswiki installations should install Foswiki as a new release,  configure, and then migrate data to the new installation."
      }%
   </div>
   * See [[System.UpgradeGuide]] for details on upgrading from older versions of Foswiki
   * See [[System.SystemRequirements]] for the latest System Requirements.
   * Be sure to take a backup!
   * The upgrade packages excludes files \"commonly\" modified, for example,  !WebHome, !WebPreferences, AdminGroup, etc. If your installation has modified other topics, or template files, those updates will be lost!
   * If you use =tar=,  then you can extract the upgrade package on top of your installation by using: *(Be sure to run this as your web server user to avoid changing file ownership.)*
<verbatim>
cd /var/www/foswiki
tar --strip-components=1 -zxf /path/to/Foswiki-upgrade-2.x.x.tgz
cd tools
./configure --save
</verbatim>
   * Similarly, if you are using the =zip= upgrade package, then
<verbatim>
cd /var/www/foswiki
unzip -o /path/to/Foswiki-upgrade-2.x.x.zip
cd tools
./configure --save
</verbatim>
   * After upgrade, restart the web server, clear the foswiki page cache, clear your browser cache.
   * If things are not fully working, verify file system permissions and ownership.  See [[System.InstallationGuide#Step_2:_Confirm_file_and_directory_ownership_and_permissions]]
"}%

%FORMFIELD{"UpgradeNotes" topic="%BASETOPIC%"}%

---++ License

   * This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
   * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
   * See the GNU General Public License for more details, published at http://www.gnu.org/copyleft/gpl.html

---++ Release Details
   * Build date %FORMFIELD{"BuildDate"}%
   * Publish date %FORMFIELD{"PublishDate"}%
   * Built from %IF{"'%TOPIC%'/BuildSVNRev = ''" else="%FORMFIELD{"BuildSVNBranch"}% svn revision %FORMFIELD{"BuildSVNRev"}%" then="[[%FORMFIELD{"BuildGitRepo"}%/commit/%FORMFIELD{"BuildGitCommit"}%][github commit %CALC{"$SUBSTRING(%FORMFIELD{"BuildGitCommit"}%,1,10)"}%]]"}%
%TMPL:END%
%TMPL:DEF{"junk"}%
   * Set NOWYSIWYG = 1
   * Set ALLOWTOPICCHANGE = Main.MaintainGroup
%TMPL:END%
%TMPL:DEF{"form"}%%TMPL:END%%{
===================================================