Skip to content

Commit

Permalink
Item13883: Start Release 2.2. release notes
Browse files Browse the repository at this point in the history
  • Loading branch information
gac410 committed Mar 15, 2017
1 parent 5244f3d commit d6542de
Show file tree
Hide file tree
Showing 2 changed files with 185 additions and 0 deletions.
184 changes: 184 additions & 0 deletions core/data/System/ReleaseNotes02x02.txt
@@ -0,0 +1,184 @@
%META:TOPICINFO{author="ProjectContributor" date="1489544864" format="1.1" version="1"}%
%META:TOPICPARENT{name="ReleaseHistory"}%
---+!! Foswiki Release 2.1.3

%TWISTY{showlink="Table of Contents..." hidelink="hide TOC"}%
%TOC%
%ENDTWISTY{}%

---++ Foswiki - The Free and Open Source Wiki

Foswiki is an enterprise collaboration and information sharing tool targeted for professional use in many types of organizations: from small businesses to multi-nationals, from one-product open source groups, to worldwide research networks.

Foswiki is a wiki: fundamentally, a website with editable web pages. It looks like a normal web site but it encourages contributions, edits, updates, questions, and answers from its users. It's a powerful way of enabling a community to communicate asynchronously using intranet and public Internet websites. Foswiki is simple to learn and use. It aims to provide a transparent way for you to publish and exchange your ideas with others over the web and eliminates the one-webmaster syndrome of outdated intranet content.

Foswiki is a structured wiki with tools that enable users without programming skills to build powerful yet simple applications to process information and support workflows. Developers can extend the functionality of Foswiki with plugins.

Foswiki is backwards compatible with content generated on all previous Foswiki versions, and even content and many plugins from TWiki installations (Foswiki ships with a !TWikiCompatibilityPlugin, thus enabling most extensions made for TWiki to work in Foswiki. TWiki<sup>&reg;</sup> is a registered trademark of Peter Thoeny.)

Foswiki is released under the GNU General Public License.


---++ Foswiki Releases

%TWISTY{showlink="Release 1.0 releases..." hidelink="hide Release 1.0"}%
* Foswiki 1.0.0, the first Foswiki was released on 09 Jan 2009.
* Foswiki 1.0.1, 1.0.2 and 1.0.3 were released internally in the development community, but were never publicly released.
* Foswiki 1.0.4 was built 19 Mar 2009. It is a patch release with more than 120 bug fixes relative to 1.0.0 and only very few minor enhancements.
* Foswiki 1.0.5 was built 25 Apr 2009. It is a patch release with more than 150 bug fixes relative to 1.0.0 and a few enhancements. This patch release further enhances the robustness and the security of the Foswiki software.
* Foswiki 1.0.6 was built 21 Jun 2009. It is a patch release with more than 200 bug fixes relative to 1.0.0 and some enhancements. This version introduces a major enhancement in security against Cross-Site Request Forgery. Further more a central translation framework got introduced which ease the translation process and enables all users to contribute to translations.
* Foswiki 1.0.7 was built 20 Sep 2009. It is a patch release with more than 240 bug fixes relative to 1.0.0 and some enhancements. This release fixes some serious issues introduced by the CSRF fix and the redirect cache fix in 1.0.6. Major enhancement that also fixes many annoying editor bugs is the upgrade of the !Tiny MCE editor to version 3.2.2.
* Foswiki 1.0.8 was built 29 Nov 2009. It is a patch release with more than 280 bug fixes relative to 1.0.0 and some enhancements. This release fixes a short list of quite annoying old bugs incl a bug that prevented efficient use of MailerContrib for producing newsletters. The Wysiwyg editor has been upgraded with the latest Tiny MCE editor release 3.2.7.
* Foswiki 1.0.9 was built 17 Jan 2010. It is a patch release with more than 320 bug fixes relative to 1.0.0 and several enhancements. This release fixes many bugs in the Wysiwyg editor, bugs related to more advanced wiki applications and bugs in the Plugin API. It contains several bug fixes and enhancements related to security and spam fighting.
* Foswiki 1.0.10 was built 08 Sep 2010 as a patch release with more than 410 bug fixes relative to 1.0.0. It is assumed to be the last 1.0.X release.
%ENDTWISTY{}%
%TWISTY{showlink="Release 1.1 releases..." hidelink="hide Release 1.1"}%
* Foswiki 1.1.0 was built 04 Oct 2010. It is a release with more than 270 bug fixes relative to 1.0.10 and more than 680 bug fixes relative to 1.0.0. And the release adds more than 100 enhancements. Foswiki 1.1.0 introduces jQuery Javascript user interface framework, improved topic history display, new QUERY and FORMAT macros, better user interfaces for groups, much improved WYSIWYG editor, facelift of the default skin, much improved configure tool, and many more enhancements.
* Foswiki 1.1.1 was built 25 Oct 2010. It is a release that fixes some important bugs that were introduced in 1.1.0. It is highly recommended that all running 1.1.0 upgrade to 1.1.1.
* Foswiki 1.1.2 was built 09 Nov 2010. It is a release that fixes some very important bugs incl. a security related bug. Installations running 1.1.0 and 1.1.1 should be upgraded to 1.1.2
* Foswiki 1.1.3 was built 16 Apr 2011. It is a release that fixes more than 150 bugs. jQuery has been updated to 1.4.3. The default PatternSkin has some usability improvements.
* Foswiki 1.1.4 was built 20 Dec 2011. It is a release that fixes some very important including some security related issues. It contains 143 fixes and 27 enhancements. jQuery has been updated to 1.7.1.
* Foswiki 1.1.5 was built 10 Apr 2012. It is a release that fixes some very important issues including some security related issues. It contains 100 fixes and 20 enhancements.
* Foswiki 1.1.6 was built 02 Dec 2012. It is a release that fixes some important issues including some minor security related issues. It contains 94 fixes and 27 enhancements.
* Foswiki 1.1.7 was built 01 Feb 2013. It is a release that fixes *CVE-2012-6329* and *CVE-2012-6330*. It contains 20 fixes and 4 enhancements.
* Foswiki 1.1.8 was built 28 Feb 2013. It is a release that fixes *CVE-2013-1666*. It contains 4 fixes.
* Foswiki 1.1.9 was built 18 Nov 2013. It is a release that contains 44 fixes and 4 enhancements..
* Foswiki 1.1.10 was built 23 Nov 2015. It is a release that contains 8 fixes and 8 enhancements.
%ENDTWISTY{}%
%TWISTY{showlink="Release 2.0 releases..." hidelink="hide Release 2.0"}%
* Foswiki 2.0.0 was built on 04 Jul 2015. It is a release that contains 312 fixes and 157 enhancements, and closes 59 Feature Requests.
* Foswiki 2.0.1 was built on 03 Aug 2015. It is a release that contains 28 fixes and 3 enhancements.
* Foswiki 2.0.2 was built on 01 Oct 2015. It is a release that contains 65 fixes and 5 enhancements.
* Foswiki 2.0.3 was built on 15 Nov 2015. It is a release that contains 17 fixes and 1 enhancement.
%ENDTWISTY{}%
%TWISTY{showlink="Release 2.1 releases..." hidelink="hide Release 2.1"}%
* Foswiki 2.1.0 was built on 02 Feb 2016. It is a release that contains 37 fixes and 14 enhancements. It closes 7 Feature Requests.
* Foswiki 2.1.1 was built on 30 Apr 2016. It is a release that contains 36 fixes and 21 enhancements.
* Foswiki 2.1.2 was built on 2 May 2016. It is a release that contains 1 fix.
* Foswiki 2.1.3 was built on 12 Feb 2017. It is a release that contains 68 fixes and 21 enhancements.
%ENDTWISTY{}%
* Foswiki 2.2.0 was built...

---++ Pre-installed Extensions

Foswiki 2.1 is shipped with the following:
* *Plugins:* AutoViewTemplatePlugin, CommentPlugin, ConfigurePlugin, EditRowPlugin, EmptyPlugin, HistoryPlugin, HomePagePlugin, InterwikiPlugin, JQueryPlugin, NatEditPlugin, PreferencesPlugin, PubLinkFixupPlugin, RenderListPlugin, SlideShowPlugin, SmiliesPlugin, SpreadSheetPlugin, SubscribePlugin, TablePlugin, TinyMCEPlugin, TwistyPlugin, UpdatesPlugin, WysiwygPlugin
* *Contribs:* CompareRevisionsAddOn, FamFamFamContrib, FastCGIEngineContrib, JEditableContrib, JSCalendarContrib, JsonRpcContrib, MailerContrib, ModPerlEngineContrib, PlainFileStoreContrib, RCSStoreContrib, TipsContrib, TopicUserMappingContrib
* *Skins:* PatternSkin
* *Compatibility support* - TWikiCompatibilityPlugin

<div class="foswikiHelp">%X% *Caution:* If you are upgrading from a release prior to Foswiki 2.1.3, you should review the release notes for
[[https://foswiki.org/System/ReleaseNotes02x01.txt][Foswiki 2.1]] and [[https://foswiki.org/System/ReleaseNotes02x00.txt][Foswiki 2.0]] for
critical changes.</div>

---++ Known issues
For up-to-date information, see [[https://foswiki.org/Support/KnownIssuesOfFoswiki02x02][Known issues of Foswiki 2.2]]

---+++ Use of non-default ={Store}{Encoding}=

*WARNING* About ={Store}{Encoding}=: If you intend to use high-bit characters in attachment filenames (such as umlauts and accents), then links to these
attachments on Foswiki pages *will not work* on a non-utf-8 Store without modification. This is because Foswiki works internally using Unicode, but the store saves files to disk using your chosen
{Store}{Encoding}. Running the Store with other than =utf-8= encoding is considered a transitional step and not recommended for long-term operation.
The *strongly recommended* solution is to convert your store to UTF8 at the earliest opportunity.

A partial workaround is implemented in the PubLinkFixupPlugin This Plugin will attempt to rewrite broken links. This _generally_ gets linked images and other attachments working.
However the TinyMCEPlugin is still unable to render image links while editing a topic.

See [[%BUGS%/Item13696][Item13696]] for up-to-date details.

---++ Important changes in Foswiki 2.2

---+++ Security issues addressed in this release.

---+++ The default Attachment Link formats have changed.

The attachment link format has been changed to be more flexible. If you are using the default link formats, no changes are needed. If you have
overridden the defaults, you should escape any macros in your revised links by changing =%= to =$percnt=.

For example:
<verbatim>
* Set ATTACHEDFILELINKFORMAT = \n * [[%ATTACHURL%/$fileurl][$filename]]: $comment
* Set ATTACHEDIMAGEFORMAT = \n * $comment: <br />\n <img src="%ATTACHURLPATH%/$fileurl" alt="$filename" $size />
</verbatim>
changed to:
<verbatim>
* Set ATTACHEDFILELINKFORMAT = \n * [[$percntATTACHURL$percnt/$fileurl][$filename]]%IF{"'$comment'=''" else=": $comment"}%
* Set ATTACHEDIMAGEFORMAT = \n%IF{"'$comment'=''" else=" * $comment: <br />\n"}% <img src="$percntATTACHURLPATH$percnt/$fileurl" alt="$filename" $size />
</verbatim>

If you don't escape the macros, they will be expanded when the link is initially created which will impact the ability to rename topics.

---++ Important changes in Foswiki 2.1

---+++ Deprecations

The =%<nop>HTTP%= and =%<nop>HTTPS%= macros are deprecated and will be removed in a future release. These macros now restrict the available information to the
=Accept-language= and =User-Agent= headers. The list of available headers is now configurable.

The PatternSkin created =contentheader= and =contentfooter= as aliases for the =beforetext= and =aftertext= templates and deprecated the older templates. As
this broke compatibity with other skins, that deprecation has been reversed. For best compatibiliy continue to use =beforetext= and =aftertext=.

---++ API Change

The Foswiki API version is incremented to version 2.4 in Foswiki 2.1.0. Foswiki 2.1 permits template names using Unicode characters.

---+++ Improvements in International Character Set support

Foswiki 2.1 has further improved support for =utf-8= based character sets. Topics and data forms can use utf-8 characters. They will be properly rendered and
preserved during edit. The Foswiki core has been fully converted to utf-8 and unicode. All encoding / decoding is done "at the edge", when reading from
/ writing to the Foswiki store.

* Foswiki 2.1 International support
* Emails sent by Foswiki now fully support International Character Sets.
* Foswiki now uses NFC Normalization of Unicode characters. This greatly improves compatibility with Operating Systems like OSX which use NFD form characters by default.
* Template names are no longer restricted to ASCII characters.

* Foswiki 2.0 International support
* New sites will use utf-8 by default. Internationalizaiton should just work.
* Sites migrating data from a previous installation have two choices:
* Set ={Store}{Encoding} to match the previous ={Site}{CharSet}=. (Default was =iso-8859-1=)
* Migrate the data to utf-8 by using the =tools/bulk_copy.pl= script. This is the recommended solution.
* Support for Locales is still known to have issues. ={UseLocales}= should not be enabled in the configuration.

<div class='foswikiHelp'>%X% *ACTION REQUIRED* If you are upgrading an existing system, you
should review the existing data and determine if migration to utf-8 should be performed.
See the [[%FO%/System.UpgradeGuide][UpgradeGuide]] for more details. Note that the topic and
attachment name filters no longer filter international characters, so migration to utf-8 is
strongly recommended.

Due to the extensive internal changes, extensions may require changes for
compatibility with this release.
* See [[%FO%/Support.Utf8MigrationConsiderations][Utf8MigrationConsiderations]] for guidance on upgrading local extensions
* See [[%BUGS%/Item13483][Item13483]] for known extensions compatibility issues.
</div>

---++ Translation Status

As of this release,
* Italian and Ukrainian are 100% complete.
* Traditional Chinese, French and German are >99% complete.
* Czech, Danish are >95% complete.

For more details on translation status, see [[%FO%/Community.TranslationTeam][TranslationTeam]] and [[http://translate.foswiki.org/projects/foswiki][Foswiki's Weblate translation server]].
Foswiki thanks the Translators for their efforts. If you are interesting in helping with the translation, please contact foswiki-translations@lists.sourceforge.net.

---++ Foswiki Release 2.2 Details
---+++ New Features
<noautolink>
| [[%FO%/Development.AddConcatOptionToAttrs][AddConcatOptionToAttrs]] | Add +"more" and key+"more" options to Foswiki::Attrs |

---+++ Fixes


</noautolink>

---

<!-- Note: Do not use Bugs: interwiki links because interwiki rule might not be defined
* Set BUGS = https://foswiki.org/Tasks
* Set FEAT = https://foswiki.org/Development
* Set FO = https://foswiki.org
* Set NOAUTOLINK = 1
-->

*Related Topic:* ReleaseHistory
1 change: 1 addition & 0 deletions core/lib/Foswiki/Contrib/core/MANIFEST
Expand Up @@ -153,6 +153,7 @@ data/System/ReleaseNotes01x00.txt 0644
data/System/ReleaseNotes01x01.txt 0644
data/System/ReleaseNotes02x00.txt 0644
data/System/ReleaseNotes02x01.txt 0644
data/System/ReleaseNotes02x02.txt 0644
data/System/RenameWeb.txt 0644
data/System/SearchHelp.txt 0644
data/System/SearchPatternCookbook.txt 0644
Expand Down

0 comments on commit d6542de

Please sign in to comment.