Skip to content

Commit

Permalink
Item9693: Update release documents, and gen process
Browse files Browse the repository at this point in the history
 - Local links were not being converted to foswiki.org
 - Lots of broken links in topics result in edit links in the static
   pages
 - Use ReleaseNotes for 1.2
 - Document improved email auto-configure flow
 - More links to TextFormattingRules  should be EditingShorthand
  • Loading branch information
gac410 committed Feb 9, 2015
1 parent ce1cc17 commit aee1123
Show file tree
Hide file tree
Showing 12 changed files with 106 additions and 64 deletions.
6 changes: 3 additions & 3 deletions CommentPlugin/data/System/CommentPlugin.txt
@@ -1,4 +1,4 @@
%META:TOPICINFO{author="ProjectContributor" date="1421599902" format="1.1" version="1"}%
%META:TOPICINFO{author="ProjectContributor" date="1423445948" format="1.1" version="1"}%
%META:TOPICPARENT{name="Plugins"}%
---+!! Comment Plugin

Expand Down Expand Up @@ -45,7 +45,7 @@ The =target= attribute may specify a web, and may also specify an anchor within
<verbatim class="tml">
%COMMENT{type="above" target="%USERSWEB%.PersonalRemarks#InsertHere"}%
</verbatim>
This uses a standard in-topic anchor as the insertion location. See %SYSTEMWEB%.TextFormattingRules for more about Foswiki anchors.
This uses a standard in-topic anchor as the insertion location. See %SYSTEMWEB%.EditingShorthand for more about Foswiki anchors.

---+++ Default templates
Templates are used to define the "comment style" i.e. how comments appear in the page. The default is to add comments in "Blog like" style using bulleted lists, with the most recent comment at the top, but many other styles are available such as tables or Wiki thread mode comments. It is easy to define your own customer styles as well.
Expand Down Expand Up @@ -293,4 +293,4 @@ Another great extension from the <a style="text-decoration:none" href="http://wi
| Home: | http://foswiki.org/Extensions/%TOPIC% |
| Support: | http://foswiki.org/Support/%TOPIC% |

%META:FILEATTACHMENT{name="wikiringlogo20x20.png" attr="h" comment="" date="1421599902" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="wikiringlogo20x20.png" attr="h" comment="" date="1423445948" user="ProjectContributor" version="1"}%
4 changes: 2 additions & 2 deletions NatEditPlugin/data/System/NatEditWordHelpText.txt
@@ -1,4 +1,4 @@
%META:TOPICINFO{author="ProjectContributor" date="1421672966" format="1.1" version="1"}%
%META:TOPICINFO{author="ProjectContributor" date="1423445948" format="1.1" version="1"}%
%META:TOPICPARENT{name="NatEditPlugin"}%
---+ %TOPIC%
Help text for the NatEditPlugin editor
Expand All @@ -18,7 +18,7 @@ Help text for the NatEditPlugin editor
<tr>
<td valign="top">
* <a href="%SCRIPTURLPATH{"view"}%/%SYSTEMWEB%/GoodStyle" target="_blank">%MAKETEXT{"GoodStyle"}%</a>
* <a href="%SCRIPTURLPATH{"view"}%/%SYSTEMWEB%/TextFormattingRules" target="_blank">%MAKETEXT{"TextFormatting"}%</a>
* <a href="%SCRIPTURLPATH{"view"}%/%SYSTEMWEB%/EditingShorthand" target="_blank">%MAKETEXT{"EditingShorthand"}%</a>
* <a href="%SCRIPTURLPATH{"view"}%/%SYSTEMWEB%/Macros" target="_blank">%MAKETEXT{"Macros"}%</a>
* <a href="%SCRIPTURLPATH{"view"}%/%SYSTEMWEB%/FormattedSearch" target="_blank">%MAKETEXT{"Formatted Search"}%</a>
* <a href="%SCRIPTURLPATH{"view"}%/%SYSTEMWEB%/DataForms" target="_blank">%MAKETEXT{"Form based input"}%</a>
Expand Down
4 changes: 2 additions & 2 deletions PatternSkin/data/System/WebLeftBarExample.txt
@@ -1,4 +1,4 @@
%META:TOPICINFO{author="ProjectContributor" date="1400051171" format="1.1" version="1"}%
%META:TOPICINFO{author="ProjectContributor" date="1423445948" format="1.1" version="1"}%
%META:TOPICPARENT{name="WebHome"}%
%INCLUDE{"%IF{"context can_login" then="%SYSTEMWEB%.WebLeftBarLogin" else="<nop>"}%" warn="off"}%

Expand All @@ -16,7 +16,7 @@

* <b>%MAKETEXT{"User Reference"}%</b>
* BeginnersStartHere
* TextFormattingRules
* EditingShorthand
* [[%SYSTEMWEB%.Macros][Macros]]
* FormattedSearch
* QuerySearch
Expand Down
4 changes: 2 additions & 2 deletions core/data/System/CompleteDocumentation.txt
@@ -1,4 +1,4 @@
%META:TOPICINFO{author="ProjectContributor" date="1421090223" format="1.1" version="1"}%
%META:TOPICINFO{author="ProjectContributor" date="1423445948" format="1.1" version="1"}%
---+!! Reference Manual (%WIKIVERSION%)

This page contains all documentation topics as one long, complete reference sheet.
Expand All @@ -25,7 +25,7 @@ This page contains all documentation topics as one long, complete reference shee

%INCLUDE{"AccessControl" headingoffset="1"}%

%INCLUDE{"TextFormattingRules" headingoffset="1"}%
%INCLUDE{"EditingShorthand" headingoffset="1"}%

%INCLUDE{"Macros" headingoffset="1"}%

Expand Down
22 changes: 11 additions & 11 deletions core/data/System/InstallationGuide.txt
@@ -1,5 +1,6 @@
%META:TOPICINFO{author="ProjectContributor" date="1421366007" format="1.1" version="1"}%
%META:TOPICINFO{author="ProjectContributor" date="1423432587" format="1.1" version="1"}%
%META:TOPICPARENT{name="AdminDocumentationCategory"}%
<noautolink>
---+ Installation Guide

%TOC{title="Contents"}%
Expand Down Expand Up @@ -141,15 +142,15 @@ Different script execution mechanisms are disabled in different ways; see your w
* If the Foswiki installation can be accessed by more than one !protocol://domain, ensure the additional alternative URLs are set in ={PermittedRedirectHostUrls}=.
<div class="foswikiHelp">%T% *Example:* if ={DefaultUrlHost}= is set to =https://wiki.company.com=, an example ={PermittedRedirectHostUrls}= might contain: <verbatim class="html">https://company.com, http://111.222.123.234</verbatim> </div>

* If your server requires a Proxy in order to access external resources like your mail server, this is configured on the "Security and Authentication" tab, "Proxies" sub-tab.
* If your server requires a Proxy in order to access external resources like your mail server, this is configured on the "Security and Authentication" tab, "Proxies" sub-tab. Complete that before proceeding with the E-mail configuration.

* Setup the =Mail= section. Email should be available so Foswiki can send registration emails. Easiest way is to use the "Auto Configure Email" button on the "Basic Setup" sub-tab. Fill out the following parameters:
* The ={WebMasterEmail}= should be set to a valid email address. This will be the ID used to send Foswiki Emails and will also appear on webmaster mailto links.
* If you are running on a *nix server with a configured local mail transport agent, you can try pressing the [Autoconfigure Email] button now, if that fails, or you know it isn't available, continue filling out:
* The ={SMTP}{MAILHOST}= should be set to your email server hostame: ex: =smtp.gmail.com=
* On most systems, you will also have to configure ={SMTP}{Username}= and ={SMTP}{Password}=. These are used so that Foswiki can sign into the mail server for purposes of sending mail.
* *Click the [Autoconfigure Email] near the bottom of the page* This will probe the mail server to discover it's configuration, and will finish the configuration. If all goes well, the settings will have been fine tuned for your mail server and email is automatically enabled.
* *Click the [Send test email] button.* This will verify if the configuration is correct and able to send mail.
* Setup the =Mail= section. E-mail should be available so Foswiki can send registration e-mails. Easiest way is to use the "%T%auto-configure email" button on the "Basic settings and Auto-configure" sub-tab. Fill out the following parameters:
* The ={WebMasterEmail}= should be set to a valid e-mail address. This will be the From: ID used to send Foswiki Emails and will also appear on webmaster mailto: links. <div class="foswikiHelp">If you are running on a <nop>*nix server with a configured local mail transport agent, you can try pressing the "%T%auto-configure email" button now. If auto-configure succeeds, *proceed to Step 6*. If your server is a Windows server, if auto-configure failed, or you know a local transport agent is not available, continue with the SMTP e-mail configuration</div>
* The ={SMTP}{MAILHOST}= should be set to your e-mail server hostame: ex: =smtp.gmail.com=
* On most systems, you will also have to configure ={SMTP}{Username}= and ={SMTP}{Password}=. These are used so that Foswiki can sign into the e-mail server for purposes of sending e-mail.
* Click the "%T%auto-configure email" button. (__This can run a long time as Foswiki probes all possible e-mail configurations__) This will probe the mail server to discover it's configuration, and will finish the configuration. If all goes well, the settings will have been fine tuned for your e-mail server and e-mail is automatically enabled.
* Finally once auto-configure completes, *Click the "%T%Send test email" button. located on the ={WebMasterEmail}= field* This will verify if the configuration is correct and able to send mail. If e-mail is enabled, but not functional, you will be unable to register users.
<div class="foswikiHelp">If auto-configure fails to complete, you can use the "Advanced settings" tab to manually configure the e-mail server. You will also need to configure the basic information tab.</div>

#ProtectConfigure
---+++ Step 6: Protect configure
Expand Down Expand Up @@ -227,7 +228,7 @@ To add an initial administrator to the =AdminGroup=, perform the following steps
1 Click the Add Member button
1 Return to the AdminGroup by clicking the group name on the confirmation page.

%IF{"%BASETOPIC%='InstallationGuild'" then=" * View the =%USERSWEB%.AdminGroup= topic. Follow the instructions on the page to add users to the %USERSWEB%.AdminGroup. You do _not_ need to edit the topic."}%
%IF{"%BASETOPIC%='InstallationGuide'" then=" * View the =%USERSWEB%.AdminGroup= topic. Follow the instructions on the page to add users to the %USERSWEB%.AdminGroup. You do _not_ need to edit the topic."}%
Any member of the %USERSWEB%.AdminGroup can add subsequent members, you do not have to use the internal admin login.

To more easily debug access control issues, you may want to have a regular Foswiki user account for daily use, and a special one that belongs to the =AdminGroup= that you use only for administering your Foswiki site. See [[System.AccessControls][%SYSTEMWEB%.AccessControls]] for more information on access controls and user groups.
Expand Down Expand Up @@ -320,5 +321,4 @@ If a plugin exists both in a TWiki version and a Foswiki version, it is strongly

TWiki is a registered trademark of Peter Thoeny.
<!-- %JQREQUIRE{"chili"}% -->

</noautolink>
46 changes: 40 additions & 6 deletions core/data/System/ReleaseHistory.txt
@@ -1,9 +1,41 @@
%META:TOPICINFO{author="ProjectContributor" date="1421598394" format="1.1" version="1"}%
%META:TOPICINFO{author="ProjectContributor" date="1423445948" format="1.1" version="1"}%
%META:TOPICPARENT{name="ReferenceManual"}%
%STARTINCLUDE%
<noautolink>
---+ Appendix A: Foswiki Development Time-line

%TOC%
---++ Foswiki Release 1.1.9 - 19 Nov 2013

Foswiki 1.1.9 was built 18 Nov 2013. It is a release that contains 43 fixes and 4 enhancements.

---++ Foswiki Release 1.1.8 - 28 Feb 2013

Foswiki 1.1.8 was built 28 Feb 2013. It is a release that fixes *CVE-2013-1666*. It contains 4 fixes.

---++ Foswiki Release 1.1.7 - 01 Feb 2013

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 Release 1.1.6 - 02 Dec 2012

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 Release 1.1.5 - 10 Apr 2012

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 Release 1.1.4 - 20 Dec 2011

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 Release 1.1.3 - 16 Apr 2011

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 Release 1.1.2 - 09 Nov 2010

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 Release 1.1.1 - 25 Oct 2010

Expand Down Expand Up @@ -380,7 +412,7 @@ Most of the redesign, refactoring and new documentation work in Dakar release wa
| [[TWiki:Codev.DynamicFormOptionDefinitions][Dynamic form option definitions]] of DataForms with FormattedSearch | [[TWiki:Main.MartinCleaver][MartinCleaver]] |
| SEARCH enhancements with new parameters =excludeweb=, =newline=, =noempty=, =nofinalnewline=, =nonoise=, =recurse=, =zeroresults= | [[http://c-dot.co.uk][Crawford Currie]], [[Foswiki:Main.ArthurClemens][ArthurClemens]], [[http://www.structuredwikis.com/][Peter Thoeny]], [[TWiki:Main.ThomasWeigert][ThomasWeigert]] |
| FormattedSearch enhancements with =$changes=, =$count=, =$formfield(name, 30, ...)=, =$summary(expandvar)=, =$summary(noheaders)=, =$summary(showvarnames)= | [[TWiki:Main.ColasNahaboo][ColasNahaboo]], [[http://c-dot.co.uk][Crawford Currie]], [[http://www.structuredwikis.com/][Peter Thoeny]], [[http://www.home.org.au][Sven Dowideit]] |
| New TWikiVariables [[TWikiVariables#VarACTIVATEDPLUGINS][ACTIVATEDPLUGINS]], [[TWikiVariables#VarALLVARIABLES][ALLVARIABLES]], [[TWikiVariables#VarAUTHREALM][AUTHREALM]], [[TWikiVariables#VarEMAILS][EMAILS]], [[TWikiVariables#VarFAILEDPLUGINS][FAILEDPLUGINS]], [[TWikiVariables#VarHTTP][HTTP]], [[TWikiVariables#VarHTTPS][HTTPS]], [[TWikiVariables#VarICONURL][ICONURL]], [[TWikiVariables#VarICONURLPATH][ICONURLPATH]], [[TWikiVariables#VarIF][IF]], [[TWikiVariables#VarLANGUAGES][LANGUAGES]], [[TWikiVariables#VarLOCALSITEPREFS][LOCALSITEPREFS]], [[TWikiVariables#VarLOGIN][LOGIN]], [[TWikiVariables#VarLOGOUT][LOGOUT]], [[TWikiVariables#VarMAKETEXT][MAKETEXT]], [[TWikiVariables#VarMETA][META]], [[TWikiVariables#VarPLUGINDESCRIPTIONS][PLUGINDESCRIPTIONS]], [[TWikiVariables#VarQUERYSTRING][QUERYSTRING]], [[TWikiVariables#VarSTARTSECTION][STARTSECTION]]/[[TWikiVariables#VarENDSECTION][ENDSECTION]], [[TWikiVariables#VarSESSION_VARIABLE][SESSION_VARIABLE]], [[TWikiVariables#VarSESSIONID][SESSIONID]], [[TWikiVariables#VarSESSIONVAR][SESSIONVAR]], [[TWikiVariables#VarSPACEOUT][SPACEOUT]], [[TWikiVariables#VarUSERLANGUAGE][USERLANGUAGE]], [[TWikiVariables#VarWIKIHOMEURL][WIKIHOMEURL]] | [[Foswiki:Main.ArthurClemens][ArthurClemens]], [[TWiki:Main.AntonioTerceiro][AntonioTerceiro]], [[http://c-dot.co.uk][Crawford Currie]], [[TWiki:Main.GregAbbas][GregAbbas]], [[TWiki:Main.PeterThoeny][Peter Thoeny]], [[http://www.home.org.au][Sven Dowideit]], [[Foswiki:Main.WillNorris][WillNorris]] and many more |
| New TWikiVariables =ACTIVATEDPLUGINS=, =ALLVARIABLES=, =AUTHREALM=, =EMAILS=, =FAILEDPLUGINS=, =HTTP=, =HTTPS=, =ICONURL=, =ICONURLPATH=, =IF=, =LANGUAGES=, =LOCALSITEPREFS=, =LOGIN=, =LOGOUT=, =MAKETEXT=, =META=, =PLUGINDESCRIPTIONS=, =QUERYSTRING=, =STARTSECTION/ENDSECTION=, =SESSION_VARIABLE=, =SESSIONID=, =SESSIONVAR=, =SPACEOUT=, =USERLANGUAGE=, =WIKIHOMEURL= | [[Foswiki:Main.ArthurClemens][ArthurClemens]], [[TWiki:Main.AntonioTerceiro][AntonioTerceiro]], [[http://c-dot.co.uk][Crawford Currie]], [[TWiki:Main.GregAbbas][GregAbbas]], [[TWiki:Main.PeterThoeny][Peter Thoeny]], [[http://www.home.org.au][Sven Dowideit]], [[Foswiki:Main.WillNorris][WillNorris]] and many more |
| [[TWiki:Codev.TWikiFormWithHiddenType][TWiki form with hidden type]] and other form enhancements | [[Foswiki:Main.LynnwoodBrown][LynnwoodBrown]], [[TWiki:Main.ThomasWeigert][ThomasWeigert]] |
| [[TWiki:Codev.SupportTopicSpecificTemplates][Support topic-specific templates]] for TWiki applications | [[TWiki:Main.ThomasWeigert][ThomasWeigert]] |
| Direct save feature for one-click template-based topic creation | [[Foswiki:Main.LynnwoodBrown][LynnwoodBrown]], [[http://c-dot.co.uk][Crawford Currie]], [[TWiki:Main.ThomasWeigert][ThomasWeigert]] |
Expand Down Expand Up @@ -666,7 +698,7 @@ See more details at TWikiReleaseNotes04x00
* *01 Jun 2001* - TWiki:Main.PeterThoeny
* New =%<nop>URLPARAM{"name"}%= variable to query URL parameters. More in TWikiVariables.
* *01 Jun 2001* - TWiki:Main.AndreaSterbini
* API to extend TWiki, see [[TWikiPlugins#PluginAPI][TWikiPluginAPI]]
* API to extend TWiki, see TWikiPluginAPI
* *01 Jun 2001* - TWiki:Main.KlausWriessnegger, TWiki:Main.AndreaSterbini
* Forms to change/reset/install passwords, see ChangePassword & ResetPassword
* *01 May 2001* - TWiki:Main.AndreaSterbini
Expand All @@ -678,7 +710,7 @@ See more details at TWikiReleaseNotes04x00
* *01 May 2001* - TWiki:Main.JohnTalintyre
* Ability to rename/move topics, ManagingTopics
* *27 Mar 2001* - TWiki:Main.PeterThoeny
* The table syntax has been enhanced to (i) render ==| <nop>*bold*<nop> |== cells as table headers, (ii) render space padded cells ==| center aligned |== and ==| right aligned |==, (iii) span multiple columns using ==| empty cells |||==. More in TextFormattingRules.
* The table syntax has been enhanced to (i) render ==| <nop>*bold*<nop> |== cells as table headers, (ii) render space padded cells ==| center aligned |== and ==| right aligned |==, (iii) span multiple columns using ==| empty cells |||==. More in EditingShorthand.
* *25 Mar 2001* - TWiki:Main.PeterThoeny
* Security fix Questionable files like PHP scripts (executables) and ==.htaccess== files that are attached to a topic get a ==.txt== suffix appended to the file name. See also TWiki:Codev/FileAttachmentFilterSecurityAlert
* *28 Feb 2001* - TWiki:Main.AndreaSterbini, TWiki:Main.PeterThoeny
Expand Down Expand Up @@ -735,7 +767,7 @@ See more details at TWikiReleaseNotes04x00
* *19 Sep 2000* - TWiki:Main.PeterThoeny
* Fixed TWiki:Codev/AttachedNotificationLinksBug.
* *18 Sep 2000* - TWiki:Main.ManpreetSingh, TWiki:Main.PeterThoeny
* Added forced internal links. Write =[<nop>[text formatting FAQ]]= to get the link [[text formatting FAQ]] that points to topic TextFormattingFAQ.
* Added forced internal links. Write =[<nop>[Editing Shorthand]]= to get the link [[Editing Shorthand]] that points to topic EditingShorthand.
* *19 Aug 2000* - TWiki:Main.PeterThoeny
* Ref-By link searches all webs (not just the current web.)
* *16 Aug 2000* - TWiki:Main.PeterThoeny
Expand Down Expand Up @@ -820,7 +852,7 @@ See more details at TWikiReleaseNotes04x00
---++ 01-Jul-1999 Release

* *23 Jun 1999* - TWiki:Main.PeterThoeny
* New TextFormattingRules to write __bold italic__ text by enclosing words with double underline characters.
* New EditingShorthand to write __bold italic__ text by enclosing words with double underline characters.
* *23 Jun 1999* - TWiki:Main.PeterThoeny
* Separate wiki.pm into configuration (wikicfg.pm) and TWiki core (wiki.pm) . This is to ease the upgrade of TWiki installations, it also allows customized extensions to TWiki without affecting the TWiki core.
* *21 May 1999* - TWiki:Main.DavidWarman
Expand Down Expand Up @@ -906,3 +938,5 @@ The typical TWiki development flow...
* TWiki:Codev.DocsToDo: feature documentation pending
* TWiki:Codev.FeatureDocumented: documented feature
* ReferenceManual: reference manual for the latest TWiki

</noautolink>

0 comments on commit aee1123

Please sign in to comment.