Skip to content

Commit

Permalink
Item13883: Doc updates, prepare to build Foswiki 2.1
Browse files Browse the repository at this point in the history
  • Loading branch information
gac410 committed Feb 2, 2016
1 parent e49e505 commit 924447d
Show file tree
Hide file tree
Showing 5 changed files with 84 additions and 53 deletions.
32 changes: 16 additions & 16 deletions EditRowPlugin/data/System/EditRowPlugin.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
%META:TOPICINFO{author="ProjectContributor" comment="" date="1454442548" format="1.1" version="1"}%
%META:TOPICINFO{author="ProjectContributor" comment="" date="1454442922" format="1.1" version="1"}%
---+!! !EditRowPlugin
<!--
One line description, required for extensions repository catalog.
Expand Down Expand Up @@ -266,7 +266,7 @@ Provides the vertical row editing interface like
Another great Foswiki extension from the <a style="text-decoration:none" href="http://wikiring.com"><img src="%ATTACHURLPATH%/wikiringlogo20x20.png" alt="" /> *WikiRing* </a> - working together to improve your wiki experience!

| Change History: | <!-- versions below in reverse order -->&nbsp; |
| 3.314 (02 Feb 2016) | Foswikitask:Item10916 Pencils disappear after row move when both js and non-js controls are present .|
| 3.314 (02 Feb 2016) | Foswikitask:Item10916 Pencils disappear after row move when both js and non-js controls are present.|
| 3.313 (26 Oct 2015) | Foswikitask:Item13834 Unable to edit cells containing utf-8 data.<br/> \
Foswikitask:Item13815 Typo in regular expression.<br/> \
Foswikitask:Item13817 Performance issues with large tables. |
Expand Down Expand Up @@ -337,17 +337,17 @@ Another great Foswiki extension from the <a style="text-decoration:none" href="h
%META:FIELD{name="License" title="License" value="[[http://www.gnu.org/licenses/gpl.html][GPL (Gnu General Public License)]]"}%
%META:FIELD{name="Home" title="Home" value="http://foswiki.org/Extensions/EditRowPlugin"}%
%META:FIELD{name="Support" title="Support" value="http://foswiki.org/Support/EditRowPlugin"}%
%META:FILEATTACHMENT{name="icons.png" attr="h" comment="" date="1454442548" size="2457" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="example3.png" attr="h" comment="" date="1454442548" size="15337" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="example4.png" attr="h" comment="" date="1454442548" size="22834" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="erp.css" attr="h" comment="" date="1454442548" size="1454" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="screenshot2.png" attr="h" comment="" date="1454442548" size="12013" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="TableSort.uncompressed.js" attr="h" comment="" date="1454442548" size="6803" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="erp.js" attr="h" comment="" date="1454442548" size="11898" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="erp.uncompressed.css" attr="h" comment="" date="1454442548" size="2130" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="example5.png" attr="h" comment="" date="1454442548" size="9132" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="erp.uncompressed.js" attr="h" comment="" date="1454442548" size="26625" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="screenshot1.png" attr="h" comment="" date="1454442548" size="19461" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="TableSort.js" attr="h" comment="" date="1454442548" size="3626" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="wikiringlogo20x20.png" attr="h" comment="" date="1454442548" size="1343" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="clock.gif" attr="h" comment="" date="1454442548" size="1418" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="icons.png" attr="h" comment="" date="1454442922" size="2457" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="example3.png" attr="h" comment="" date="1454442922" size="15337" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="example4.png" attr="h" comment="" date="1454442922" size="22834" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="erp.css" attr="h" comment="" date="1454442922" size="1454" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="screenshot2.png" attr="h" comment="" date="1454442922" size="12013" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="TableSort.uncompressed.js" attr="h" comment="" date="1454442922" size="6803" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="erp.js" attr="h" comment="" date="1454442922" size="11898" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="erp.uncompressed.css" attr="h" comment="" date="1454442922" size="2130" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="example5.png" attr="h" comment="" date="1454442922" size="9132" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="erp.uncompressed.js" attr="h" comment="" date="1454442922" size="26625" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="screenshot1.png" attr="h" comment="" date="1454442922" size="19461" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="TableSort.js" attr="h" comment="" date="1454442922" size="3626" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="wikiringlogo20x20.png" attr="h" comment="" date="1454442922" size="1343" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="clock.gif" attr="h" comment="" date="1454442922" size="1418" user="ProjectContributor" version="1"}%
60 changes: 43 additions & 17 deletions ModPerlEngineContrib/data/System/ModPerlEngineContrib.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
%META:TOPICINFO{author="ProjectContributor" date="1453007256" format="1.1" version="1"}%
%META:TOPICINFO{author="ProjectContributor" date="1454442922" format="1.1" version="1"}%
---+!! !ModPerlEngineContrib
<!--
One line description, required for extensions repository catalog.
Expand All @@ -25,21 +25,33 @@ each request.

---++ Installation Instructions


%T% As of Foswiki 2.0, !ModPerlEngineContrib is installed by default. <button class="twistyExpandAll foswikiButton">Show all Foswiki 1.x instructions</button>

%TWISTY{ start="hide" showlink="Show Foswiki 1.x details"}%
<div class="foswikiHelp">
*This block of instructions is only needed on Foswiki 1.x systems.*

Install [[Foswiki:Extensions/ModPerlEngineContrib][ModPerlEngineContrib]]
either manually (download the package and extract its contents over your
foswiki directory) or using [[%SCRIPTURL{"configure"}%][configure]]
(under =Extensions= section, push the =Find More Extensions= button).

%X% Foswiki 1.x installations *must* be configured before mod_perl is enabled
in Apache. Run [[%SCRIPTURL{"configure"}%][configure]] *before* enabling mod_perl in Apache.
or else Apache will not start, reporting an error about a missing
=lib/LocalSite.cfg=. You will need to:
1 Configure apache with standard CGI
1 Configure Foswiki using =bin/configure=
1 Re-configure Apache with =mod_perl= active.
</div>
%ENDTWISTY{}%

Visit the [[Foswiki:Support/ApacheConfigGenerator][apache config generator]]
and fill in the fields according to your environment. Select __mod_perl__ as your
__Runtime Engine__ and choose your apache version. Push the ==Update config file==
button and you'll get your config file.

%X% %RED% When installed for the first time, Foswiki *must* be configured. Run
[[%SCRIPTURL{"configure"}%][configure]] *before* enabling this contrib
or else Apache will not start, reporting an error about a missing
=lib/LocalSite.cfg= %ENDCOLOR%

In the web server configuration, you will need to load =mod_perl= but it is also recommended to load the
[[http://httpd.apache.org/apreq/][Apache HTTP Request Library]] (module apreq).
If =apreq= is not loaded, the following error may be encountered in certain situations, e.g., during login:
Expand All @@ -49,11 +61,16 @@ apache2: symbol lookup error: /usr/lib/perl5/auto/APR/Request/Apache2/Apache2.so

---+++ Confirming =mod_perl= installation

You may (though not necessarily) be able to confirm that =mod_perl= is installed and enabled by checking
On Foswiki 2.0 systems. visit System.FoswikiServerInformation. Look for the
=Engine= entry in the =General execution environment= table.

%TWISTY{start="hide" showlink="Show Foswiki 1.x details"}%
On Foswiki 1.x systems. you may (though not necessarily) be able to confirm that =mod_perl= is installed and enabled by checking
in configure's "Environment Variables" section. a sample:

| SERVER_SIGNATURE | Apache/2.2.9 (Debian) mod_apreq2-20051231/2.6.0 mod_perl/2.0.4 Perl/v5.10.0 Server at 127.0.0.1 Port 2116 |
| SERVER_SOFTWARE | Apache/2.2.9 (Debian) mod_apreq2-20051231/2.6.0 mod_perl/2.0.4 Perl/v5.10.0 |
%ENDTWISTY{}%

Another technique to see which modules are enabled is using =apache2ctl=
<verbatim>
Expand All @@ -65,19 +82,18 @@ If not found, enable mod_perl with
$ a2enmod mod_perl
</verbatim>


---+++ Foswiki configuration tuning

Forking new processes under =mod_perl= can be very slow, so some configuration
changes are recommended.

Access the [[%SCRIPTURL{"configure"}%][configure]] script and click the =Yes, I've read all the documentation=
button to show the expert settings.
Access the [[%SCRIPTURL{"configure"}%][configure]] script. (On Foswiki 1.x, you will need to click the =Yes, I've read all the documentation=
button to show the expert settings.)
Go to =Store Settings=:
* ={StoreImpl}=: adjust to =RcsLite=
* ={RCS}{SearchAlgorithm}=: use =Foswiki::Store::SearchAlgorithms::PurePerl= or Foswiki:Extensions/NativeSearchContrib
* =Store Implementation=: If using RCS, adjust to =RcsLite=. (If using the !PlainFile store, no change is needed.)
* =Search Algorithm=: use =Foswiki::Store::SearchAlgorithms::PurePerl= or Foswiki:Extensions/NativeSearchContrib

---+++ =mod_perl+ configuration tuning
---+++ =mod_perl= configuration tuning

=mod_perl= limits the size of attachments to 64M by default. Set the
=APREQ2_ReadLimit= to the maximum expected upload to permit larger
Expand All @@ -88,7 +104,7 @@ set in %USERSWEB%.SitePreferences, default taken from
%SYSTEMWEB%.SitePreferences.
<verbatim>
<IfModule mod_perl.c>
PerlSwitches -wT
PerlSwitches -wT # DO NOT USE THIS with Foswiki 2.0
# mod_perl_startup.pl must exist, otherwise Apache will not start.
PerlRequire "/var/www/foswiki/tools/mod_perl_startup.pl"
APREQ2_ReadLimit 104857600
Expand All @@ -97,23 +113,33 @@ set in %USERSWEB%.SitePreferences, default taken from

---++ Known Issues

* Apache must be =restart=ed in order for configuration changes take effect.
* You must ==restart== Apache in order for configuration changes take effect.

%TWISTY{start="hide" showlink="Show Foswiki 1.x details"}%
* The =bin/configure= script is an exception and should be run as a plain
CGI script. The required =SetHandler cgi-script= should already be specified
in the =<Files configure.*>= in your Apache config or =bin/.htaccess= file.
<blockquote><verbatim>
<verbatim>
<FilesMatch "configure.*">
SetHandler cgi-script
.
.
</FilesMatch>
</verbatim></blockquote>
</verbatim>
%ENDTWISTY{}%
* If you are using some extension that add files to the =bin/=
directory, you may face problems as they were not designed to be executed
under =mod_perl=. You should configure them to be run as plain CGI scripts.
You can replace =Files= directive by
[[http://httpd.apache.org/docs/2.2/mod/core.html#filesmatch][FilesMatch]]
and list all the exceptions.
<verbatim>
<FilesMatch "[script name needing CGI].*">
SetHandler cgi-script
.
.
</FilesMatch>
</verbatim>

---++ List of Files

Expand Down
6 changes: 3 additions & 3 deletions core/data/System/ReleaseHistory.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
%META:TOPICINFO{author="ProjectContributor" date="1452393879" format="1.1" version="1"}%
%META:TOPICINFO{author="ProjectContributor" date="1454442922" format="1.1" version="1"}%
%META:TOPICPARENT{name="AdminDocumentationCategory"}%
History of Foswiki
%STARTINCLUDE%
Expand All @@ -7,9 +7,9 @@ History of Foswiki
---+ Appendix A: Foswiki Development Time-line

%TOC%
---++ Foswiki Release 2.1.0 Beta 1 - 10 Jan 2016
---++ Foswiki Release 2.1.0 - 02 Feb 2016

Foswiki 2.1.0 Beta 1 was built on 10 Jan 2016. It is a release that contains 29 fixes and 12 enhancements. It closes 7 Feature Requests.
Foswiki 2.1.0 was built on 02 Feb 2016. It is a release that contains 35 fixes and 13 enhancements. It closes 7 Feature Requests.

---++ Foswiki Release 2.0.3 - 15 Nov 2015

Expand Down
18 changes: 10 additions & 8 deletions core/data/System/ReleaseNotes02x01.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
%META:TOPICINFO{author="ProjectContributor" date="1452393879" format="1.1" version="1"}%
%META:TOPICINFO{author="ProjectContributor" date="1454442922" format="1.1" version="1"}%
%META:TOPICPARENT{name="ReleaseHistory"}%
---+!! Foswiki Release 2.1.0

Expand Down Expand Up @@ -51,7 +51,7 @@ Foswiki is released under the GNU General Public License.
* 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{}%
* Foswiki 2.1.0 Beta 1 was built on 10 Jan 2016. It is a release that contains 29 fixes and 12 enhancements. It closes 7 Feature Requests.
* Foswiki 2.1.0 was built on 02 Feb 2016. It is a release that contains 35 fixes and 13 enhancements. It closes 7 Feature Requests.


---++ Pre-installed Extensions
Expand Down Expand Up @@ -165,17 +165,11 @@ Foswiki thanks the Translators for their efforts. If you are interesting in hel
| [[%FO%/Development.MakeZonesLessIntrusive][MakeZonesLessIntrusive]] | Make zones less intrusive, especially for non-HTML output |
| [[%FO%/Development.SplitTopicAttachmentNameFilters][SplitTopicAttachmentNameFilters]] | Separate the topic and attachment name filters, allow spaces in attachment names, remove colon from Topic names. |


</noautolink>

<noautolink>

---+++ Fixes

| [[%BUGS%/Item12067][Item12067]] | Removing members via WikiGroups not possible when login name different from WikiName. |
| [[%BUGS%/Item12569][Item12569]] | Sorting in tableplugin is wrong in German. |
| [[%BUGS%/Item13405][Item13405]] | Unicode Normalisation. |
| [[%BUGS%/Item13554][Item13554]] | Foswiki doesn't work with accented Template names. |
| [[%BUGS%/Item13699][Item13699]] | Mail sending fails when non-latin text in utf8 is being sent. |
| [[%BUGS%/Item13857][Item13857]] | Mac OS X RCS "not found" by configure. |
| [[%BUGS%/Item13863][Item13863]] | FileAttachment: generated filenames are not correct foswiki 2.0.3 mod_cgi, utf-8 store when uploaded from OS X. |
Expand All @@ -184,6 +178,7 @@ Foswiki thanks the Translators for their efforts. If you are interesting in hel

The following fixes will also be incorporated into Foswiki 2.0.4

| [[%BUGS%/Item10916][Item10916]] | Pencils disappear after row move when both js and non-js controls are present. |
| [[%BUGS%/Item11609][Item11609]] | No information how to un-set a topic parent. |
| [[%BUGS%/Item13677][Item13677]] | regression: extension tabs in configure aren't sorted alphabetically anymore. |
| [[%BUGS%/Item13860][Item13860]] | UploadFilter isn't blocking HTML attachments. |
Expand All @@ -197,19 +192,26 @@ The following fixes will also be incorporated into Foswiki 2.0.4
| [[%BUGS%/Item13890][Item13890]] | bulk_copy ignores --latest option. |
| [[%BUGS%/Item13891][Item13891]] | bulk_copy.pl does not copy user information for attachment histories. |
| [[%BUGS%/Item13893][Item13893]] | Performance fixes for Foswiki 2.0.4. |
| [[%BUGS%/Item13894][Item13894]] | RcsStore double-encodes utf8 comments into the attachment revision log. |
| [[%BUGS%/Item13896][Item13896]] | TWISTY incorrectly used in Sandbox.WebHome, generates broken HTML. |
| [[%BUGS%/Item13898][Item13898]] | JQueryAjaxHelper =jumpbox= code does not work with short URLs. |
| [[%BUGS%/Item13899][Item13899]] | save: ignores new topic text if it is empty. |
| [[%BUGS%/Item13900][Item13900]] | Logout redirects to wrong path when ForceDefaultHostUrl is enabled. |
| [[%BUGS%/Item13903][Item13903]] | Redirect for authentication breaks utf8 topic names. |
| [[%BUGS%/Item13906][Item13906]] | EditRowPlugin create table row without spaces. |
| [[%BUGS%/Item13913][Item13913]] | CLI scripts broken on windows. setlib.cfg issues "require CGI" which sets binmode on STDIN and breaks prompts. |
| [[%BUGS%/Item13917][Item13917]] | NameFilter not working on 2.0 / 2.1 if configure reset to default is used. |
| [[%BUGS%/Item13924][Item13924]] | Old style UserRegistration pages not working on 2.1 beta 1. |
| [[%BUGS%/Item13925][Item13925]] | Leading spaces in DefaultUrlHost causes malformed URL links. |
| [[%BUGS%/Item13926][Item13926]] | ModPerlEngineContrib is not backwards compatible with Foswiki 1.1.x. |
| [[%BUGS%/Item13927][Item13927]] | Configure rcs checker crashes if configured command is not found. |

---+++ Enhancements

| [[%BUGS%/Item12560][Item12560]] | NameFilter should reject colon, conflicts with Interwiki links. Restructure filters to improve flexibility. |
| [[%BUGS%/Item13436][Item13436]] | Adding the class parameter to the TablePlugin. |
| [[%BUGS%/Item13444][Item13444]] | Foswiki::Net::getExternalResource does a poor job of parsing URLs. |
| [[%BUGS%/Item13554][Item13554]] | Foswiki doesn't work with accented Template names. |
| [[%BUGS%/Item13848][Item13848]] | Deprecate, and restrict HTTP and HTTPS macros. |
| [[%BUGS%/Item13849][Item13849]] | Implement MakeZonesLessIntrusive. |
| [[%BUGS%/Item13854][Item13854]] | Implemement MakeItEasierToBlockSystemWebGuestAccess. |
Expand Down
Loading

0 comments on commit 924447d

Please sign in to comment.