buildrelease
authorTWikiContributor <TWikiContributor>
Wed, 1 Feb 2006 12:01:26 +0000 (12:01 +0000)
committerTWikiContributor <TWikiContributor>
Wed, 1 Feb 2006 12:01:26 +0000 (12:01 +0000)
245 files changed:
Main/WebAtom.mdwn [new file with mode: 0644]
Main/WebStatistics.mdwn
TWiki/ATasteOfTWiki.mdwn
TWiki/AccessKeys.mdwn
TWiki/AdminDocumentationCategory.mdwn [new file with mode: 0644]
TWiki/AdminSkillsAssumptions.mdwn
TWiki/AdminToolsCategory.mdwn [new file with mode: 0644]
TWiki/AnApplicationWithWikiForm.mdwn [new file with mode: 0644]
TWiki/AppendixEncodeURLsWithUTF8.mdwn
TWiki/BookView.mdwn
TWiki/BulkRegistration.mdwn [new file with mode: 0644]
TWiki/BulkResetPassword.mdwn [new file with mode: 0644]
TWiki/BumpyWord.mdwn
TWiki/CategoryCategory.mdwn [new file with mode: 0644]
TWiki/ChangeEmailAddress.mdwn [new file with mode: 0644]
TWiki/ChangePassword.mdwn
TWiki/ClassMethod.mdwn [new file with mode: 0644]
TWiki/ClassicSkin.mdwn
TWiki/CommentPlugin.mdwn
TWiki/DeleteOrRenameATopic.mdwn
TWiki/DeleteOrRenameAnAttachment.mdwn
TWiki/DeveloperDocumentationCategory.mdwn [new file with mode: 0644]
TWiki/DontNotify.mdwn
TWiki/EditDoesNotIncreaseTheRevision.mdwn
TWiki/EditTablePlugin.mdwn
TWiki/EmptyPlugin.mdwn
TWiki/FileAttachment.mdwn
TWiki/FileAttribute.mdwn
TWiki/ForceNewRevision.mdwn [new file with mode: 0644]
TWiki/FormattedSearch.mdwn
TWiki/GnuGeneralPublicLicense.mdwn
TWiki/GoBox.mdwn
TWiki/GoodStyle.mdwn
TWiki/HiddenAttachment.mdwn
TWiki/IfStatements.mdwn [new file with mode: 0644]
TWiki/IncludeTopicsAndWebPages.mdwn
TWiki/InstalledPlugins.mdwn
TWiki/InstantEnhancements.mdwn
TWiki/InterWikis.mdwn
TWiki/InterwikiPlugin.mdwn
TWiki/JSCalendarContrib.mdwn [new file with mode: 0644]
TWiki/LoginName.mdwn [new file with mode: 0644]
TWiki/MailerContrib.mdwn [new file with mode: 0644]
TWiki/MainFeatures.mdwn
TWiki/ManagingTopics.mdwn
TWiki/ManagingUsers.mdwn
TWiki/ManagingWebs.mdwn
TWiki/MoveTopic.mdwn
TWiki/NewUserTemplate.mdwn
TWiki/ObjectMethod.mdwn [new file with mode: 0644]
TWiki/PatternSkin.mdwn
TWiki/PatternSkinCss.mdwn
TWiki/PatternSkinCssCookbook.mdwn [new file with mode: 0644]
TWiki/PatternSkinCssCookbookCenterPage.mdwn [new file with mode: 0644]
TWiki/PatternSkinCssCookbookCenterPageBorder.mdwn [new file with mode: 0644]
TWiki/PatternSkinCssCookbookEditTableStyle.mdwn [new file with mode: 0644]
TWiki/PatternSkinCssCookbookFonts.mdwn [new file with mode: 0644]
TWiki/PatternSkinCssCookbookNoLeftBar.mdwn [new file with mode: 0644]
TWiki/PatternSkinCssCookbookNoTopBar.mdwn [new file with mode: 0644]
TWiki/PatternSkinCustomization.mdwn
TWiki/PeterThoeny.mdwn
TWiki/PlainSkin.mdwn
TWiki/PreferencesPlugin.mdwn [new file with mode: 0644]
TWiki/PreviewBackground.mdwn
TWiki/PrintSkin.mdwn
TWiki/QuietSave.mdwn
TWiki/RegistrationApprovals.mdwn [new file with mode: 0644]
TWiki/RegularExpression.mdwn
TWiki/RenameWeb.mdwn [new file with mode: 0644]
TWiki/RenderListPlugin.mdwn
TWiki/ResetPassword.mdwn
TWiki/SearchDoesNotWork.mdwn
TWiki/SearchHelp.mdwn
TWiki/SearchPatternCookbook.mdwn [new file with mode: 0644]
TWiki/SimultaneousEdits.mdwn
TWiki/SiteChanges.mdwn [new file with mode: 0644]
TWiki/SiteMap.mdwn
TWiki/SitePermissions.mdwn [new file with mode: 0644]
TWiki/SlideShowPlugin.mdwn
TWiki/SmiliesPlugin.mdwn
TWiki/SourceCode.mdwn [new file with mode: 0644]
TWiki/SpreadSheetPlugin.mdwn
TWiki/StandardColors.mdwn
TWiki/StartingPoints.mdwn
TWiki/StaticMethod.mdwn [new file with mode: 0644]
TWiki/TWikiAccessControl.mdwn
TWiki/TWikiAccessControlExceptionDotPm.mdwn [new file with mode: 0644]
TWiki/TWikiAccessDotPm.mdwn [new file with mode: 0644]
TWiki/TWikiAttachDotPm.mdwn [new file with mode: 0644]
TWiki/TWikiAttrsDotPm.mdwn [new file with mode: 0644]
TWiki/TWikiCompatibilityDotPm.mdwn [new file with mode: 0644]
TWiki/TWikiContributor.mdwn
TWiki/TWikiCss.mdwn
TWiki/TWikiDocGraphics.mdwn
TWiki/TWikiDocumentation.mdwn
TWiki/TWikiDotPm.mdwn [new file with mode: 0644]
TWiki/TWikiDownload.mdwn
TWiki/TWikiEnhancementRequests.mdwn
TWiki/TWikiFAQ.mdwn
TWiki/TWikiFormDotPm.mdwn [new file with mode: 0644]
TWiki/TWikiForms.mdwn
TWiki/TWikiFuncDotPm.mdwn [new file with mode: 0644]
TWiki/TWikiGlossary.mdwn
TWiki/TWikiHistory.mdwn
TWiki/TWikiI18NDotPm.mdwn [new file with mode: 0644]
TWiki/TWikiI18NExtractDotPm.mdwn [new file with mode: 0644]
TWiki/TWikiInstallationGuide.mdwn
TWiki/TWikiJavascripts.mdwn [new file with mode: 0644]
TWiki/TWikiLogos.mdwn
TWiki/TWikiMergeDotPm.mdwn [new file with mode: 0644]
TWiki/TWikiMetaData.mdwn
TWiki/TWikiMetaDotPm.mdwn [new file with mode: 0644]
TWiki/TWikiNetDotPm.mdwn [new file with mode: 0644]
TWiki/TWikiOopsExceptionDotPm.mdwn [new file with mode: 0644]
TWiki/TWikiPlannedFeatures.mdwn
TWiki/TWikiPluginDotPm.mdwn [new file with mode: 0644]
TWiki/TWikiPlugins.mdwn
TWiki/TWikiPluginsDotPm.mdwn [new file with mode: 0644]
TWiki/TWikiPluralsDotPm.mdwn [new file with mode: 0644]
TWiki/TWikiPreferences.mdwn
TWiki/TWikiPreferencesForm.mdwn [new file with mode: 0644]
TWiki/TWikiPrefsDotPm.mdwn [new file with mode: 0644]
TWiki/TWikiPrefsParserDotPm.mdwn [new file with mode: 0644]
TWiki/TWikiPrefsPrefsCacheDotPm.mdwn [new file with mode: 0644]
TWiki/TWikiReferenceManual.mdwn [new file with mode: 0644]
TWiki/TWikiRegistration.mdwn
TWiki/TWikiRenderDotPm.mdwn [new file with mode: 0644]
TWiki/TWikiSandboxDotPm.mdwn [new file with mode: 0644]
TWiki/TWikiScripts.mdwn [new file with mode: 0644]
TWiki/TWikiSearchDotPm.mdwn [new file with mode: 0644]
TWiki/TWikiSite.mdwn
TWiki/TWikiSiteTools.mdwn
TWiki/TWikiSkinBrowser.mdwn
TWiki/TWikiSkins.mdwn
TWiki/TWikiStoreDotPm.mdwn [new file with mode: 0644]
TWiki/TWikiStoreRcsFileDotPm.mdwn [new file with mode: 0644]
TWiki/TWikiStoreRcsLiteDotPm.mdwn [new file with mode: 0644]
TWiki/TWikiStoreRcsWrapDotPm.mdwn [new file with mode: 0644]
TWiki/TWikiSystemRequirements.mdwn
TWiki/TWikiTemplates.mdwn
TWiki/TWikiTemplatesDotPm.mdwn [new file with mode: 0644]
TWiki/TWikiTimeDotPm.mdwn [new file with mode: 0644]
TWiki/TWikiTip001.mdwn [new file with mode: 0644]
TWiki/TWikiTip002.mdwn [new file with mode: 0644]
TWiki/TWikiTip003.mdwn [new file with mode: 0644]
TWiki/TWikiTip004.mdwn [new file with mode: 0644]
TWiki/TWikiTip005.mdwn [new file with mode: 0644]
TWiki/TWikiTip006.mdwn [new file with mode: 0644]
TWiki/TWikiTip007.mdwn [new file with mode: 0644]
TWiki/TWikiTip008.mdwn [new file with mode: 0644]
TWiki/TWikiTip009.mdwn [new file with mode: 0644]
TWiki/TWikiTip010.mdwn [new file with mode: 0644]
TWiki/TWikiTip011.mdwn [new file with mode: 0644]
TWiki/TWikiTip012.mdwn [new file with mode: 0644]
TWiki/TWikiTip013.mdwn [new file with mode: 0644]
TWiki/TWikiTip014.mdwn [new file with mode: 0644]
TWiki/TWikiTip015.mdwn [new file with mode: 0644]
TWiki/TWikiTip016.mdwn [new file with mode: 0644]
TWiki/TWikiTip017.mdwn [new file with mode: 0644]
TWiki/TWikiTip018.mdwn [new file with mode: 0644]
TWiki/TWikiTip019.mdwn [new file with mode: 0644]
TWiki/TWikiTip020.mdwn [new file with mode: 0644]
TWiki/TWikiTip021.mdwn [new file with mode: 0644]
TWiki/TWikiTip022.mdwn [new file with mode: 0644]
TWiki/TWikiTip023.mdwn [new file with mode: 0644]
TWiki/TWikiTip024.mdwn [new file with mode: 0644]
TWiki/TWikiTip025.mdwn [new file with mode: 0644]
TWiki/TWikiTip026.mdwn [new file with mode: 0644]
TWiki/TWikiTip027.mdwn [new file with mode: 0644]
TWiki/TWikiTip028.mdwn [new file with mode: 0644]
TWiki/TWikiTip029.mdwn [new file with mode: 0644]
TWiki/TWikiTips.mdwn [new file with mode: 0644]
TWiki/TWikiTipsOfTheDay.mdwn [new file with mode: 0644]
TWiki/TWikiTipsOfTheDayAddNew.mdwn [new file with mode: 0644]
TWiki/TWikiTipsOfTheDayAdmin.mdwn [new file with mode: 0644]
TWiki/TWikiTipsOfTheDayInclude.mdwn [new file with mode: 0644]
TWiki/TWikiTipsOfTheDayTemplate.mdwn [new file with mode: 0644]
TWiki/TWikiTopics.mdwn
TWiki/TWikiTutorial.mdwn
TWiki/TWikiUIChangeFormDotPm.mdwn [new file with mode: 0644]
TWiki/TWikiUIDotPm.mdwn [new file with mode: 0644]
TWiki/TWikiUIEditDotPm.mdwn [new file with mode: 0644]
TWiki/TWikiUIManageDotPm.mdwn [new file with mode: 0644]
TWiki/TWikiUIOopsDotPm.mdwn [new file with mode: 0644]
TWiki/TWikiUIRDiffDotPm.mdwn [new file with mode: 0644]
TWiki/TWikiUIRegisterDotPm.mdwn [new file with mode: 0644]
TWiki/TWikiUISaveDotPm.mdwn [new file with mode: 0644]
TWiki/TWikiUISearchDotPm.mdwn [new file with mode: 0644]
TWiki/TWikiUIStatisticsDotPm.mdwn [new file with mode: 0644]
TWiki/TWikiUIUploadDotPm.mdwn [new file with mode: 0644]
TWiki/TWikiUIViewDotPm.mdwn [new file with mode: 0644]
TWiki/TWikiUpgradeGuide.mdwn
TWiki/TWikiUserAuthentication.mdwn
TWiki/TWikiUsersApacheHtpasswdUserDotPm.mdwn [new file with mode: 0644]
TWiki/TWikiUsersDotPm.mdwn [new file with mode: 0644]
TWiki/TWikiUsersGuide.mdwn [new file with mode: 0644]
TWiki/TWikiUsersPasswordDotPm.mdwn [new file with mode: 0644]
TWiki/TWikiVariables.mdwn
TWiki/TablePlugin.mdwn
TWiki/TemplateWeb.mdwn
TWiki/TextEditor.mdwn
TWiki/TextFormattingFAQ.mdwn
TWiki/TextFormattingRules.mdwn
TWiki/TimBernersLee.mdwn
TWiki/TipsContrib.mdwn [new file with mode: 0644]
TWiki/TwistyContrib.mdwn [new file with mode: 0644]
TWiki/UserDocumentationCategory.mdwn [new file with mode: 0644]
TWiki/UserToolsCategory.mdwn [new file with mode: 0644]
TWiki/WebAtom.mdwn [new file with mode: 0644]
TWiki/WebAtomBase.mdwn [new file with mode: 0644]
TWiki/WebChanges.mdwn
TWiki/WebChangesAlert.mdwn
TWiki/WebHome.mdwn
TWiki/WebLeftBar.mdwn
TWiki/WebLeftBarCookbook.mdwn
TWiki/WebLeftBarExample.mdwn
TWiki/WebLeftBarLogin.mdwn [new file with mode: 0644]
TWiki/WebLeftBarPersonalTemplate.mdwn
TWiki/WebLeftBarSearch.mdwn [new file with mode: 0644]
TWiki/WebLeftBarWebsList.mdwn [new file with mode: 0644]
TWiki/WebPreferences.mdwn
TWiki/WebPreferencesHelp.mdwn [new file with mode: 0644]
TWiki/WebRss.mdwn
TWiki/WebRssBase.mdwn
TWiki/WebSearch.mdwn
TWiki/WebSearchAdvanced.mdwn
TWiki/WebSiteTools.mdwn
TWiki/WebStatistics.mdwn
TWiki/WebTopBar.mdwn
TWiki/WebTopicCreator.mdwn [new file with mode: 0644]
TWiki/WebTopicNonWikiTemplate.mdwn
TWiki/WebTopicViewTemplate.mdwn
TWiki/WelcomeGuest.mdwn
TWiki/WhatDoesTWikiStandFor.mdwn [new file with mode: 0644]
TWiki/WhatIsWikiWiki.mdwn
TWiki/WikiCulture.mdwn
TWiki/WikiName.mdwn
TWiki/WikiNotation.mdwn
TWiki/WikiReferences.mdwn
TWiki/WikiSyntax.mdwn
TWiki/WikiSyntaxSummary.mdwn
TWiki/WikiWord.mdwn
TWiki/WysiwygPlugin.mdwn [new file with mode: 0644]
TWiki/WysiwygPluginTopicLister.mdwn [new file with mode: 0644]
TWiki/YouAreHere.mdwn

diff --git a/Main/WebAtom.mdwn b/Main/WebAtom.mdwn
new file mode 100644 (file)
index 0000000..8b13789
--- /dev/null
@@ -0,0 +1 @@
+
index 1e7c315..d8269e8 100644 (file)
     <td>
     </td>
   </tr>
-  <tr>
-    <td> Aug 2004 </td>
-    <td align="right"> 65 </td>
-    <td align="right"> 8 </td>
-    <td align="right"> 0 </td>
-    <td>   8 [[Main/TWikiGroups]]<br />   7 [[Main/WebPreferences]]<br />   4 [[Main/WebRss]]<br />   4 [[Main/TWikiGroupTemplate]]<br />   3 [[Main/WebStatistics]]<br />   3 [[Main/WebHome]]<br />   3 [[Main/WebNotify]]<br />   3 [[Main/WebIndex]]<br />   3 [[Main/WebChanges]]<br />   2 [[Main/WebSearchAdvanced]]<br />   2 [[Main/PeterThoeny]]</td>
-    <td>   7 [[Main/PeterThoeny]]<br />   1 [[Main/ArthurClemens]]</td>
-  </tr>
 </table>
 
 **_Notes:_**
 
-- Do not edit this topic, it is updated automatically. (You can also [force](http://www.dementia.org/twiki//statistics/%WEB%) an update)
+- This topic is updated by the statistics script. (You can also [force](http://www.dementia.org/twiki/statistics/%WEB%) an update)
 - [[TWikiDocumentation]] tells you how to enable the automatic updates of the statistics.
 - Suggestion: You could archive this topic once a year and delete the previous year's statistics from the table.
index 2a41bf8..20fdd6f 100644 (file)
@@ -1,40 +1,37 @@
-This is a short introduction training course for TWiki beginners (newbies).
+This is a short introductory training course for TWiki beginners.
 
 <a name="StartPresentation"></a> <span>[[Main/WebHome?slideshow=on;skin=print#GoSlide1]]</span>
 
 ## <a name="Slide 1: A Taste of TWiki"></a> Slide 1: A Taste of TWiki
 
-The basic function of TWiki is a Wiki (if that helps!)
-
-A Wiki is like a normal web site, except that you can edit the content in your browser
-
-<table width="100%">
+<table cellspacing="10">
   <tr>
-    <td>
+    <td><img alt="Hula girl" height="111" src="http://www.dementia.org/twiki//view/hula.gif" width="113" /></td>
+    <td> The basic function of TWiki is a Wiki (if that helps!) <p> A Wiki is like a web site, except that you can edit the content in your browser </p>
+      <p>
+      </p>
       <ul>
         <li> "Wiki" is short for "wiki wiki", the Hawaiian for "Quick" </li>
         <li> The idea originates from <a href="http://www.hyperdictionary.com/computing/hypercard" target="_top">Macintosh Hypercard</a>, via <a href="http://www.c2.com/cgi/wiki?WardCunningham" target="_top">Ward Cunningham</a></li>
         <li> In Ward's words, Wiki is <em>"the simplest online database that could possibly work"</em></li>
-        <li> A Wiki is basically a shared, online, persistant whiteboard </li>
+        <li> A Wiki is basically a shared, online, persistent whiteboard </li>
       </ul>
     </td>
-    <td align="right"><img alt="" height="112" src="http://www.dementia.org/twiki//view/hula.gif" width="88" /></td>
   </tr>
 </table>
 
 ## <a name="Slide 2: TWiki Wiki"></a> Slide 2: TWiki Wiki
 
-TWiki implements the basic Wiki idea of a shared whiteboard
-
-<table width="100%">
+<table cellspacing="10">
   <tr>
-    <td>
+    <td><img alt="Whiteboard" height="160" src="http://www.dementia.org/twiki//view/whiteboard.gif" width="240" /></td>
+    <td>TWiki implements the basic Wiki idea of a shared whiteboard <p>
+      </p>
       <ul>
         <li> Anyone can add content<br />... or change what is written<br />... or change the organisation of the content </li>
         <li> Whatever what you write is<br />... nicely presented<br />... remembered... and never forgotten </li>
       </ul>
     </td>
-    <td align="right"><img alt="" height="112" src="http://www.dementia.org/twiki//view/anarchy.gif" width="112" /></td>
   </tr>
 </table>
 
@@ -47,10 +44,21 @@ TWiki is an Open-Source development on [TWiki.org](http://twiki.org/)
 
 ## <a name="Slide 3: Where is it used?"></a> Slide 3: Where is it used?
 
-- TWiki is mainly used in commercial environments, often on corporate intranets
-  - Examples: Disney, SAP, British Telecom, Wind River, Motorola, [Epic Games](http://udn.epicgames.com/Main/WebHome)
-- A number of public Wiki sites also use TWiki
-  - Examples: <br /><http://www.trommetter.com/cgi-bin/view.cgi/><br /><http://csci.mrs.umn.edu/twiki/view><br />
+TWiki is mainly used in commercial environments, often on corporate intranets
+
+- Examples: Disney, British Telecom, SAP, Wind River, Motorola, [Epic Games](http://udn.epicgames.com/Main/WebHome)<br /><table cellspacing="20">
+  <tr>
+    <td><img alt="Disney logo" height="31" src="http://www.dementia.org/twiki//view/Disney_logo.gif" width="80" /></td>
+    <td><img alt="British Telecom logo" height="41" src="http://www.dementia.org/twiki//view/BT_logo.gif" width="80" /></td>
+    <td><img alt="SAP logo" height="40" src="http://www.dementia.org/twiki//view/SAP_logo.gif" width="80" /></td>
+    <td><img alt="Motorola logo" height="65" src="http://www.dementia.org/twiki//view/Motorola_logo.gif" width="80" /></td>
+    <td><img alt="Epic Games logo" height="65" src="http://www.dementia.org/twiki//view/EpicGames_logo.gif" width="80" /></td>
+  </tr>
+</table>
+
+A number of public Wiki sites also use TWiki
+
+- Examples: <br /><https://uimon.cern.ch/twiki/bin/view/><br /><http://csci.mrs.umn.edu/twiki/view>
 
 ## <a name="Slide 4: TWiki Features"></a> Slide 4: TWiki Features
 
@@ -58,7 +66,7 @@ TWiki builds on the original Wiki concept and adds a number of features that mak
 
 - TWiki pages are fully revision controlled, so a record of every change to every page is kept <table border="0" cellpadding="3" cellspacing="0">
   <tr>
-    <td bgcolor="#D0D0D0"><font color="black" size="-1">r1.6 <a>&gt;</a> r1.5 <a>&gt;</a> r1.4</font></td>
+    <td bgcolor="#D0D0D0"><font color="black" size="-1">r6 <a>&lt;</a> r5 <a>&lt;</a> r4</font></td>
   </tr>
 </table>
 - The look-and-feel is highly configurable, through use of templates
@@ -137,7 +145,7 @@ It will also usually contain a number of 'links' that you can click on. You will
 - Go <input name="topic" size="16" type="text" />
  - lets you type in the name of a page you already know
 
-## <a name="Slide 9: The Page Header"></a> Slide 9: The Page Header
+## <a name="Slide 9: The Page Header ... con"></a> Slide 9: The Page Header ... continued
 
 <table bgcolor="white" border="0" cellpadding="3" cellspacing="0" width="90%">
   <tr>
@@ -162,7 +170,7 @@ The footer of the page is also highlighted in colour, and is usually where you w
 
 <table bgcolor="white" border="0" cellpadding="3" cellspacing="0" width="90%">
   <tr bgcolor="#D0D0D0">
-    <td colspan="2" valign="top"><font color="black" size="-1"> <a href="none"><b>Edit</b></a> | <a href="none">Attach</a> | <a href="none">Diffs</a> | r1.2 <a href="none">&gt;</a> r1.1 | <a href="none">More</a> </font></td>
+    <td colspan="2" valign="top"><font color="black" size="-1"> <a href="none"><b>Edit</b></a> | <a href="none">Attach</a> | <a href="none">Diffs</a> | r2 <a href="none">&gt;</a> r1 | <a href="none">More</a> </font></td>
   </tr>
   <tr>
     <td valign="top"><font color="black" size="-1">Revision r1.2 - 13 Feb 2004 - 09:09 GMT - <a href="none">TWikiPresenter</a> </font></td>
@@ -294,7 +302,7 @@ TWiki understands pages in plain text just fine, but you can %RED% **_jazz_** %E
     - <code>\[[BumpyWords]\[bumpy words]] appears as [[bumpy words|Main/BumpyWords]]</code>
 - An ordinary URL pasted into text will appear as a link - <http://www.google.com>
   - You can also prettify URLs using square brackets:
-    - `[[http://www..google.com][google]]` appears as [google](http://www.google.com)
+    - `[[http://www.google.com/][Google]]` appears as [Google](http://www.google.com/)
 - Use %SEARCH. This is an interface to a sophisticated search engine that embeds the results of the search in your page. See [[TWikiVariables]] for full details.
 
 ## <a name="Slide 19: More formatting"></a> Slide 19: More formatting
@@ -390,7 +398,7 @@ You may see a comment box on a page in ThreadMode that makes it easy to quickly
 - A Wiki trick for grouping pages together
 - Example: to group together a set of pages all relating to the weather:
   1. Create a page called 'CategoryWeather'
-  2. Put a SEARCH that contain the word 'CategoryWeather' into it
+  2. Put a SEARCH that contains the word 'CategoryWeather' into it
     - `%SEARCH{"CategoryWeather" nosearch="on" nosummary="on"}%`
   3. Put the [[BumpyWord]] 'CategoryWeather' on all the pages relating to the weather<br />(usually at the bottom, below a horizontal bar)
 
@@ -417,7 +425,7 @@ Here's a brief description of some of the more common plugins, together with the
 
 The following plugins are installed on this TWiki: [[SpreadSheetPlugin]], [[CommentPlugin]], [[EditTablePlugin]], [[InterwikiPlugin]], [[PreferencesPlugin]], [[SlideShowPlugin]], [[SmiliesPlugin]], [[TablePlugin]], [[TwistyPlugin]]
 
-There are many other plugins, see <http://www.twiki.org/cgi-bin/view/Plugins>
+There are many other plugins, see <http://TWiki.org/cgi-bin/view/Plugins>
 
 ## <a name="Slide 29: Credits and Acknowledg"></a> Slide 29: Credits and Acknowledgements
 
@@ -428,5 +436,3 @@ There are many other plugins, see <http://www.twiki.org/cgi-bin/view/Plugins>
 - The latest version of this presentation is available at TWiki:%WEB%.%TOPIC%, where you can also provide feedback
 
 **_Related topics:_** [[WelcomeGuest]], [[TWikiTutorial]], [[ATasteOfTWikiTemplate]]
-
--- TWiki:Main.CrawfordCurrie - 17 Feb 2004
index 61e7ed2..5e7b1fb 100644 (file)
@@ -26,3 +26,5 @@ This depends on the browser you are using (see also cross-browser support below)
   - Press the required letter
 
 [Learn more](http://www.salford.gov.uk/online/howto/accesskeys.htm)
+
+**_Related Topics:_** [[UserDocumentationCategory]]
diff --git a/TWiki/AdminDocumentationCategory.mdwn b/TWiki/AdminDocumentationCategory.mdwn
new file mode 100644 (file)
index 0000000..37bbc25
--- /dev/null
@@ -0,0 +1,5 @@
+# <a name="A List of TWiki Administrator Do"></a> A List of TWiki Administrator Documentation
+
+# <a name="TWiki Installation Error"></a> TWiki Installation Error
+
+Incorrect format of searchformat template (missing sections? There should be 4 %SPLIT% tags)
index 44821b7..51996b6 100644 (file)
@@ -11,8 +11,10 @@ Installing TWiki is **not** recommended for people who only know HTML and web de
 
 Although the [[TWikiInstallationGuide]] is quite complete, there will on occasion be parts that don't work in your local environment (particularly with TWiki:Codev/TWikiOnWebHostingSites, which are sometimes challenging even for those with good OS and web server skills).
 
-There are many excellent resources for learning how to administer your OS and web server, including books, web sites, web forums, IM and email lists. The TWiki:Support web must **not** be depended on as a resource for this purpose - in other words, it is not there to answer basic questions about operating system and web server administration. Asking and answering questions is time consuming for all concerned and is best used for specific _TWiki related_ issues, rather than helping you learn the OS and web server.
+There are many excellent resources for learning how to administer your OS and web server, including books, web sites, web forums, IM and e-mail lists. The TWiki:Support web must **not** be depended on as a resource for this purpose - in other words, it is not there to answer basic questions about operating system and web server administration. Asking and answering questions is time consuming for all concerned and is best used for specific _TWiki related_ issues, rather than helping you learn the OS and web server.
 
-One of the best training courses for Linux is **Basic Linux Training** at <http://basiclinux.net/> - this is a 2 month distance-learning course (via email). The course operators are friendly, and all students are newbies. A nice tool for people migrating from Windows is <http://www.MidnightCommander.org/>. It is already installed on Linux systems: try <code>**mc -ac**</code> and <code>**ESC 1**</code> to get help.
+r.
 
--- TWiki:Main.RichardDonkin - 27 Apr 2002 %BR% -- TWiki:Main.GrantBow - 15 Jan 2003 %BR% -- TWiki:Main.PeterMasiar - 28 May 2003
+To get started with Linux, visit <http://linuxbasics.org/>. LinuxBasics.org offers Linux tutorials, a mailing-list and an IRC-channel to answer questions, and links to sites with information to install and use Linux. A nice tool for people migrating from Windows is <http://www.MidnightCommander.org/>. It is already installed on Linux systems: try <code>**mc -ac**</code> and <code>**ESC 1**</code> to get help.
+
+**_Related Topics:_** [[AdminDocumentationCategory]]
diff --git a/TWiki/AdminToolsCategory.mdwn b/TWiki/AdminToolsCategory.mdwn
new file mode 100644 (file)
index 0000000..b6b377a
--- /dev/null
@@ -0,0 +1,70 @@
+# <a name="Admin tools"></a> Admin tools
+
+Manage whole **%WIKITOOLNAME%** site from one screen.
+
+- **[[Users|Main/TWikiUsers]]:** [[Register|Main/TWikiRegistration]], [[NewUserTemplate]], [[UserForm]], [[ResetPassword]], [[ChangePassword]]
+- **[[Site Tools|Main/TWikiSiteTools]]:** [Configure](http://www.dementia.org/twiki/configure), [[TWikiPreferences]], [[InterWikis]], [[Variables|Main/TWikiVariables]]
+- **Managing:** [[Topics|Main/ManagingTopics]], [[Webs|Main/ManagingWebs]], [[YouAreHere]]
+- **Webs:**
+
+> <table bgcolor="#000000" border="0" cellpadding="3" cellspacing="2" width="100%">
+>   <tr bgcolor="#99CCCC">
+>     <th>Web</th>
+>     <th>Tools</th>
+>     <th>Use to...</th>
+>   </tr>
+>   <tr>
+>     <td>
+>       <h1><a name="TWiki Installation Error"></a> TWiki Installation Error </h1>Incorrect format of searchformat template (missing sections? There should be 4 %SPLIT% tags) </td>
+>   </tr>
+>   <tr bgcolor="#ffffff">
+>     <td colspan="3"><font size="-1">This table is updated automatically based on WebPreferences settings of the individual webs. </font></td>
+>   </tr>
+> </table>
+> <table border="0" cellpadding="0" cellspacing="2">
+>   <tr bgcolor="#ffffff">
+>     <td valign="top"><font size="-1"> Legend: </font></td>
+>     <td valign="top">  </td>
+>     <td valign="top"><font size="-1"> <img alt="Home of web" border="0" height="16" src="http://www.dementia.org/twiki//view/TWiki/TWikiDocGraphics/home.gif" width="16" /> WebHome </font></td>
+>     <td valign="top"><font size="-1"> <img alt="Search web" border="0" height="16" src="http://www.dementia.org/twiki//view/TWiki/TWikiDocGraphics/searchtopic.gif" width="16" /> WebSearch </font></td>
+>     <td valign="top"><font size="-1"> <img alt="Recent changes in the web" border="0" height="16" src="http://www.dementia.org/twiki//view/TWiki/TWikiDocGraphics/recentchanges.gif" width="16" /> WebChanges </font></td>
+>     <td valign="top"><font size="-1"> <img alt="Get notified of changes to the web" border="0" height="16" src="http://www.dementia.org/twiki//view/TWiki/TWikiDocGraphics/notify.gif" width="16" /> WebNotify </font></td>
+>   </tr>
+>   <tr bgcolor="#ffffff">
+>     <td valign="top">  </td>
+>     <td valign="top">  </td>
+>     <td valign="top"><font size="-1"> <img alt="Preferences of web" border="0" height="16" src="http://www.dementia.org/twiki//view/TWiki/TWikiDocGraphics/wrench.gif" width="16" /> WebPreferences </font></td>
+>     <td valign="top"><font size="-1"> <img alt="Statistics of web" border="0" height="16" src="http://www.dementia.org/twiki//view/TWiki/TWikiDocGraphics/statistics.gif" width="16" /> WebStatistics </font></td>
+>     <td valign="top"><font size="-1"> <img alt="Bullet list of all topics" border="0" height="16" src="http://www.dementia.org/twiki//view/TWiki/TWikiDocGraphics/indexlist.gif" width="16" /> WebTopicList </font></td>
+>     <td valign="top"><font size="-1"> <img alt="Index of all topics" border="0" height="16" src="http://www.dementia.org/twiki//view/TWiki/TWikiDocGraphics/index.gif" width="16" /> WebIndex </font></td>
+>   </tr>
+> </table>
+
+## <a name="All Admin Tools Category topics"></a> All Admin Tools Category topics
+
+# <a name="TWiki Installation Error"></a> TWiki Installation Error
+
+Incorrect format of searchformat template (missing sections? There should be 4 %SPLIT% tags)
+
+## <a name="Plugins"></a> Plugins
+
+Administrators can enable and disable plugins using [configure](http://www.dementia.org/twiki/configure).
+
+- [[SpreadSheetPlugin]] <span>(any TWiki, 10197)</span>:
+- [[CommentPlugin]] <span>(Dakar, 11359)</span>: Allows users to quickly post comments to a page without an edit/preview/save cycle
+- [[EditTablePlugin]] <span>(any TWiki, 11646)</span>:
+- [[InterwikiPlugin]] <span>(Dakar, $Rev: 11935$)</span>:
+- [[PreferencesPlugin]] <span>(Dakar, 9839)</span>:
+- [[SlideShowPlugin]] <span>(Any TWiki, $Rev: 12847$)</span>:
+- [[SmiliesPlugin]] <span>(Dakar, 8154)</span>:
+- [[TablePlugin]] <span>(1.020, 12339)</span>:
+- [[TwistyPlugin]] <span>(1.2.0, $Rev: 12154$)</span>:
+
+see also: [[TWikiPlugins]]
+
+## <a name="TWiki Version"></a> TWiki Version
+
+- TWiki engine: TWiki-4.1.2, Sat, 03 Mar 2007, build 13046
+- Plugin API: 1.11
+
+**_Related Topics:_** [[AdminDocumentationCategory]]
diff --git a/TWiki/AnApplicationWithWikiForm.mdwn b/TWiki/AnApplicationWithWikiForm.mdwn
new file mode 100644 (file)
index 0000000..b5b0c4d
--- /dev/null
@@ -0,0 +1,37 @@
+## <a name="FAQ:"></a> FAQ:
+
+How can I create a simple [[TWiki Form|Main/TWikiForms]] based application?
+
+## <a name="Answer:"></a> Answer:
+
+1. Create a [[TWiki Form|Main/TWikiForms]] and define fields ([[TWikiForms]])
+2. Add the form in the list of Web Forms. Set the variable WEBFORMS in [[WebPreferences]]
+3. Create a Template Topic and in Edit mode
+4. In edit mode add the [[TWiki Form|Main/TWikiForms]] you defined to the Template Topic
+5. Create a HTML Form with necessary fields
+6. Define `SEARCH` function for listing items. See [[TWikiVariables#VarSEARCH]]
+
+For more information follow the links...
+
+The following is the code source of [[TWikiFAQ]]:
+
+    <form action="%SCRIPTURLPATH{edit}%/%WEB%/">
+    New FAQ topic: &nbsp; (Use a name in TWiki.WikiNotation) <br />
+    <input type="text" name="topic" size="32" />&nbsp;<input type="submit" class="twikiSubmit" value="Create Topic" />
+    <input type="hidden" name="onlywikiname" value="on" />
+    <input type="hidden" name="templatetopic" value="TWikiFaqTemplate" />
+    <input type="hidden" name="topicparent" value="%TOPIC%" />
+    <br />
+    </form>
+
+----
+
+And the `SEARCH` function:
+
+    %SEARCH{ "Back to\:__ TWikiFAQ" casesensitive="on" regex="on" nosearch="on" nototal="on"}%
+
+**_Back to:_** [[TWikiFAQ]]
+
+**_Related Topics:_** [[UserDocumentationCategory]]
+
+-- TWiki:Main.MiyokoTakushima - 18 Oct 2004 <br />
index 37f9b5a..9b425f5 100644 (file)
@@ -1,6 +1,6 @@
 <div>
   <ul>
-    <li><a href="#Appendix C: Encode URLs With UTF"> Appendix C: Encode URLs With UTF8 </a><ul>
+    <li><a href="#Appendix B: Encode URLs With UTF"> Appendix B: Encode URLs With UTF8 </a><ul>
         <li><a href="#Current Status"> Current Status</a></li>
         <li><a href="#Details of Implementation"> Details of Implementation</a></li>
         <li><a href="#Testing and Limitation"> Testing and Limitation</a></li>
 
 <a name="EncodeURLsUTF8"></a>
 
-# <a name="Appendix C: Encode URLs With UTF"></a> Appendix C: Encode URLs With UTF8
+# <a name="Appendix B: Encode URLs With UTF"></a> Appendix B: Encode URLs With UTF8
 
-_This page addresses implemented UTF-8 support for URLs only. The overall plan for UTF-8 support for TWiki is described in TWiki:Codev.ProposedUTF8SupportForI18N ._
+_Use internationalised characters within WikiWords and attachment names_
+
+This topic addresses implemented UTF-8 support for URLs only. The overall plan for UTF-8 support for TWiki is described in TWiki:Codev.ProposedUTF8SupportForI18N.
 
 ## <a name="Current Status"></a> Current Status
 
@@ -27,9 +29,9 @@ System requirements are updated as follows:
 - Perl 5.8 sites using any character set do not require additional modules, since CPAN:Encode is installed as part of Perl.
 - This feature still works on Perl 5.005\_03 as per [[TWikiSystemRequirements]], or Perl 5.6, as long as CPAN:Unicode::MapUTF8 is installed.
 
-ISO-2022-\*, HZ-\* and other 'non-ASCII-safe' multi-byte character sets are now specifically excluded from use as the site character set, since they interfere with TWiki ML; however, many multi-byte character sets work fine, e.g. EUC-JP, GB2312, etc.
+The following 'non-ASCII-safe' character encodings are now excluded from use as the site character set, since they interfere with TWiki markup: ISO-2022-\*, HZ-\*, Shift-JIS, MS-Kanji, GB2312, GBK, GB18030, Johab and UHC. However, many multi-byte character sets work fine, e.g. EUC-JP, EUC-KR, EUC-TW, and EUC-CN. In addition, UTF-8 can already be used, with some limitations, for East Asian languages where EUC character encodings are not acceptable - see TWiki:Codev.ProposedUTF8SupportForI18N.
 
-It's now possible to override the site character set defined in the `$siteLocale` setting in TWiki.cfg - this enables you to have a slightly different spelling of the character set in the server locale (e.g. 'eucjp') and the HTTP header sent to the browser (e.g. 'euc-jp').
+It's now possible to override the site character set defined in the `{SiteLocale}` setting in [configure](http://www.dementia.org/twiki/configure) - this enables you to have a slightly different spelling of the character set in the server locale (e.g. 'eucjp') and the HTTP header sent to the browser (e.g. 'euc-jp').
 
 This feature should also support use of Mozilla Browser with TWiki:Codev.TWikiOnMainframe (as long as mainframe web server can convert or pass through UTF-8 URLs) - however, this specific combination is not tested. Other browser-server combinations should not have any problems.
 
@@ -51,7 +53,7 @@ The code automatically detects whether a URL is UTF-8 or not, taking care to avo
 
 The main point is that you can use TWiki with international characters in [[WikiWords]] without changing your browser setup from the default, and you can also still use TWiki using non-UTF-8 URLs. This works on any Perl version from 5.005\_03 onwards and corresponds to Phase 1 of TWiki:Codev.ProposedUTF8SupportForI18N. You can have different users using different URL formats transparently on the same server.
 
-UTF-8 URLs are automatically converted to the current `$siteCharset` (from the `TWiki.cfg` locale setting), using modules such as CPAN:Encode if needed.
+UTF-8 URLs are automatically converted to the current [\{Site\}\{Charset\}](http://www.dementia.org/twiki/configure#Localisation), using modules such as CPAN:Encode if needed.
 
 TWiki generates the whole page in the site charset, e.g. ISO-8859-1 or EUC-JP, but the browser dynamically UTF-8 encodes the attachment's URL when it's used. Since Apache serves attachment downloads without TWiki being involved, TWiki's code can't do its UTF-8 decoding trick, so TWiki URL-encodes such URLs in ISO-8859-1 or whatever when generating the page, to bypass this URL encoding, ensuring that the URLs and filenames seen by Apache remain in the site charset.
 
@@ -65,4 +67,4 @@ Opera Browser on the P800 smartphone is working for page viewing but leads to co
 
 For up to date information see TWiki:Codev.EncodeURLsWithUTF8
 
--- TWiki:Main.RichardDonkin - 7 Jan 2004 %BR% -- TWiki:Main.MattWilkie - 10 Aug 2004 %BR% -- TWiki:Main.PeterThoeny - 14 Aug 2004
+**_Related Topics:_** [[AdminDocumentationCategory]]
index 51d1655..3d904f2 100644 (file)
@@ -1 +1,3 @@
-**BookView** is an option available from the [[WebSearch]] topic. It allows you to display the result in "book view", that is, the whole content of topics is shown instead of a topic summary. This allows you to easily see a whole set of pages, which is useful for printing.
+**BookView** is an option available from the [[advanced search|Main/WebSearchAdvanced]] topic. It allows you to display the result in "book view", that is, the whole content of topics is shown instead of a topic summary. This allows you to easily see a whole set of pages, which is useful for printing.
+
+**_Related Topics:_** [[UserDocumentationCategory]]
diff --git a/TWiki/BulkRegistration.mdwn b/TWiki/BulkRegistration.mdwn
new file mode 100644 (file)
index 0000000..2909d98
--- /dev/null
@@ -0,0 +1,57 @@
+# <a name="Bulk Registration"></a> Bulk Registration
+
+The [[TWikiAdminGroup]] can use %TOPIC% to register (i.e. create logins and [[UserTopics]]) for a group of people quickly. Create a table in the REGISTERTOPIC named below, setting each row to represent each user and each column to correspond to the metadata. Then press the button on this page to perform registration for those users. Unlike normal registration the administrator is assumed to have correct e-mail addresses for the users, so no verification is required. Note that the new users are not notified that they have an account. This is so you can prepare and verify the accounts before announcing them. To announce them use the [[BulkResetPassword]] feature: this will assign a new random password and notify users.
+
+## <a name="Bulk Registration usage"></a> Bulk Registration usage
+
+Any fields you define in this table will end up in the User's topic. If a form (such as [[UserForm]]) is attached to [[NewUserTemplate]] then the data will go in as META:FIELDS, meaning that you can use SEARCH formfield constructs to search.
+
+If you use the [[UserForm]] then ensure that it contains all the fields you define here. Otherwise they will disappear when the user edits their home topic!
+
+### <a name="Mandatory fields"></a> Mandatory fields
+
+- [[WikiName]]
+- Email
+- FirstName
+- LastName
+
+### <a name="Optional fields"></a> Optional fields
+
+- [[LoginName]] - if not set will register with [[WikiName]]
+
+## <a name="Settings"></a> Settings
+
+- - Set REGISTERTOPIC = [[UnprocessedRegistrations]]
+  - Set LOGTOPIC = %REGISTERTOPIC%Log
+
+- - Set OVERWRITEHOMETOPICS = 0
+
+### <a name="Example format"></a> Example format
+
+The following should be inserted into your REGISTERTOPIC as a table.
+
+    | FirstName | LastName | Email | WikiName | CustomFieldThis | SomeOtherRandomField | WhateverYouLike |
+    | Test | User | you@example.com | TestUser | A | B | C |
+
+To use this:
+
+1. Make sure that the Custom fields appear on the [[UserForm]]
+2. Copy the above table to your clipboard
+3. Click through and paste this on %REGISTERTOPIC%, save the topic and return here.
+4. Click the Bulk register button below
+5. Read %LOGTOPIC%
+6. When you are ready, use the [[BulkResetPassword]] page to assign passwords and notify the users of their new accounts.
+
+Notes:
+
+1. The first row of the table dictates the heading format and that the fieldnames must be plain, i.e. **must not contain bolded** entries.
+2. You are responsible for ensuring that the fieldnames appear in the [[Main.UserForm|Main/UserForm]]
+3. Only members of the [[TWikiAdminGroup]] can run this.
+
+<form action="http://www.dementia.org/twiki/manage/%REGISTERTOPIC%" method="post" name="bulkRegister"><input name="action" type="hidden" value="bulkRegister" /> <input type="submit" value="Bulk Register these people" /> <input name="LogTopic" type="hidden" value="%LOGTOPIC%" /> <input name="OverwriteHomeTopics" type="hidden" value="%OVERWRITEHOMETOPICS%" /></form>
+
+## <a name="%REGISTERTOPIC%"></a> %REGISTERTOPIC%
+
+## <a name="%LOGTOPIC%"></a> %LOGTOPIC%
+
+**_Related Topics:_** [[AdminToolsCategory]]
diff --git a/TWiki/BulkResetPassword.mdwn b/TWiki/BulkResetPassword.mdwn
new file mode 100644 (file)
index 0000000..40e11a4
--- /dev/null
@@ -0,0 +1,47 @@
+# <a name="Bulk Reset Passwords"></a> Bulk Reset Passwords
+
+The [[TWikiAdminGroup]] can use %TOPIC% to reset any number of passwords. Users whose passwords are reset with this will be sent an e-mail at the address recorded in their home topic (the administrator will **not** be told the new passwords).
+
+<div>
+  <form action="http://www.dementia.org/twiki/resetpasswd/%WEB%/%TOPIC%" method="post">
+    <table border="0">
+      <tr>
+        <th colspan="4"> This text will be sent to users in their "reset" e-mail: </th>
+      </tr>
+      <tr>
+        <td colspan="4">
+          <textarea cols="70" name="Introduction" rows="4" style="width: 99%">
+Welcome! The site ready for your use. Please use the login name and password listed below and contact me if you have any questions.
+</textarea>
+        </td>
+      </tr>
+      <tr>
+        <th colspan="4">
+          <p> Click the checkboxes below for the users whose passwords you want to reset: </p>
+        </th>
+      </tr>
+      <tr bgcolor="lightgray">
+        <th>WikiName</th>
+        <th>Created</th>
+        <th>Changed</th>
+        <th>Reset</th>
+      </tr>
+      <tr>
+        <td>
+          <h1><a name="TWiki Installation Error"></a> TWiki Installation Error </h1>Incorrect format of searchformat template (missing sections? There should be 4 %SPLIT% tags) </td>
+      </tr>
+      <tr>
+        <td align="center" colspan="4"><input name="action" type="hidden" value="resetPassword" /> <input type="submit" value="Reset selected passwords now" /></td>
+      </tr>
+    </table>
+  </form>
+</div>
+
+**_Note_** if you don't see all the users you expect in the table below, make sure their home topic has an attached [[UserForm]]. This is used to identify users.
+
+----
+
+**_Related Topics:_** [[AdminToolsCategory]]
+
+- - Set ALLOWTOPICVIEW = [[TWikiAdminGroup]]
+  - Set ALLOWTOPICCHANGE = [[TWikiAdminGroup]]
index 303139b..f14a25e 100644 (file)
@@ -1 +1,3 @@
 See %WEB%.WikiWord
+
+**_Related Topics:_** [[UserDocumentationCategory]]
diff --git a/TWiki/CategoryCategory.mdwn b/TWiki/CategoryCategory.mdwn
new file mode 100644 (file)
index 0000000..b1e20e4
--- /dev/null
@@ -0,0 +1,5 @@
+# <a name="List of all Category topics"></a> List of all Category topics
+
+# <a name="TWiki Installation Error"></a> TWiki Installation Error
+
+Incorrect format of searchformat template (missing sections? There should be 4 %SPLIT% tags)
diff --git a/TWiki/ChangeEmailAddress.mdwn b/TWiki/ChangeEmailAddress.mdwn
new file mode 100644 (file)
index 0000000..1c8bc4d
--- /dev/null
@@ -0,0 +1,46 @@
+# <a name="Change E-mail Address"></a> Change E-mail Address
+
+[[TWikiUsers]] has a full list of user names.
+
+This form is used to change your registered e-mail addresses. Your registered e-mails are used by TWiki for sending you e-mails, include notifications of password changes. The addresses you register via this form are kept secret and will **not** be published anywhere on this site.
+
+%X% **_Security Note_**: You really ought to register a valid e-mail address. If TWiki can't find a registered e-mail for you in the secret database, it will look in your user topic for a line like this:
+
+       * Set Email = user@example.com
+
+If your user topic is not protected from changes by other people, and you don't register an e-mail address using this form, then your user account could be hijacked by someone else.
+
+If your old e-mail addresses are all invalid (you can't receive mail there any more) and you have forgotten your password, please contact .
+
+Registered e-mail addresses for currently logged in user (`admin`):
+
+<form action="http://www.dementia.org/twiki/passwd/%WEB%/%TOPIC%" method="post" name="passwd">
+  <table border="1" cellpadding="0" cellspacing="0">
+    <tr>
+      <td align="right"> Your [[TWiki/LoginName]]: </td>
+      <td><input name="username" size="40" type="text" value="admin" /> <code><font color="red">**</font></code></td>
+    </tr>
+    <tr>
+      <td align="right"> Password: </td>
+      <td><input name="oldpassword" size="40" type="password" value="" /> <code><font color="red">**</font></code></td>
+    </tr>
+    <tr>
+      <td align="right"> New e-mails (space-separated list): </td>
+      <td><input name="email" size="40" type="text" /> <code><font color="red">**</font></code></td>
+    </tr>
+    <tr>
+      <td colspan="2"><input type="submit" value="Change e-mail address" />    (Fields marked <code><font color="red">**</font></code> are required) </td>
+    </tr>
+  </table><input name="TopicName" type="hidden" value="%TOPIC%" /> <input name="action" type="hidden" value="changePassword" /></form>
+
+After submitting this form your e-mail will be changed, and you will be returned to this form.
+
+If you have questions please contact the TWiki administrator .
+
+<table bgcolor="yellow">
+  <tr>
+    <td><strong><em>Note to administrator:</em></strong> This form applies only if TWiki uses a {PasswordManager} that supports storing e-mails (e.g. TWiki::Users::HtPasswdUser). Otherwise replace this topic with a note describing how to change registered e-mail in your organization). </td>
+  </tr>
+</table>
+
+**_Related Topics:_** [[ChangePassword]], [[AdminToolsCategory]], [[UserToolsCategory]]
index 09498c4..6ab941a 100644 (file)
@@ -1,16 +1,18 @@
-<font>Change password</font>
+# <a name="Change Password"></a> Change Password
 
-**_Forgot your old password?_** Then use [[ResetPassword]] instead. Please only use ResetPassword in case you really forgot your password. Thank you.
+**_Forgotten your password?_** Then use [[ResetPassword]] instead.
 
-<form action="http://www.dementia.org/twiki//manage/TWiki/WebHome" method="post" name="passwd">
+[[TWikiUsers]] has a full list of user names.
+
+<form action="http://www.dementia.org/twiki/passwd/TWiki/WebHome" method="post" name="passwd">
   <table border="1" cellpadding="0" cellspacing="0">
     <tr>
-      <td align="right"> Your [[TWiki/WikiName]]: </td>
-      <td><input name="username" size="40" type="text" value="" /> <code><font color="red">**</font></code></td>
+      <td align="right"> Your [[TWiki/LoginName]]: </td>
+      <td><input name="username" size="40" type="text" value="admin" /> <code><font color="red">**</font></code></td>
     </tr>
     <tr>
       <td align="right"> Old password: </td>
-      <td><input name="oldpassword" size="40" type="password" /> <code><font color="red">**</font></code></td>
+      <td><input name="oldpassword" size="40" type="password" value="" /> <code><font color="red">**</font></code></td>
     </tr>
     <tr>
       <td align="right"> New password: </td>
     </tr>
     <tr>
       <td align="right">  <input name="TopicName" type="hidden" value="%TOPIC%" /></td>
-      <td><input name="action" type="hidden" value="changePassword" /> <input type="submit" value=" Request password change " />    (Fields marked <code><font color="red">**</font></code> are required) </td>
+      <td><input name="action" type="hidden" value="changePassword" /> <input type="submit" value="Change password" />    (Fields marked <code><font color="red">**</font></code> are required) </td>
     </tr>
   </table>
 </form>
 
 After submitting this form your password will be changed.
 
-If you have questions please contact the TWiki webmaster .
+If you have questions please contact the TWiki administrator .
+
+<table bgcolor="yellow">
+  <tr>
+    <td><strong><em>Note to administrator:</em></strong> This form applies only if TWiki uses a {PasswordManager} that supports changing passwords (e.g. TWiki::Users::HtPasswdUser). Otherwise replace this topic with a note describing how to change the password in your organization). See [[Main/TWikiUserAuthentication]] for more information. </td>
+  </tr>
+</table>
 
-**_Note to administrator:_** The change password form applies only if TWiki uses Basic Authentication, e.g. a `.htpassword` file managed by TWiki. It does not apply if you are using external authentication, such as an IT managed password system. (remove this note if you are using Basic Authentication; else replace this topic with a note describing how to change the password in your organization)
+**_Related Topics:_** [[ChangeEmailAddress]], [[AdminToolsCategory]], [[UserToolsCategory]]
diff --git a/TWiki/ClassMethod.mdwn b/TWiki/ClassMethod.mdwn
new file mode 100644 (file)
index 0000000..514bdaa
--- /dev/null
@@ -0,0 +1,13 @@
+A [[ClassMethod]] is a method that must be called relative to the containing class object. This normally only applies to the `new` method used to create new object instances. For example,
+
+# <a name="package Telecoms"></a> package Telecoms
+
+## <a name="ClassMethod new()"></a> [[ClassMethod]] new()
+
+    my $mobile = new Telecoms();
+
+or
+
+    my $mobile = Telecoms->new();
+
+**_Related Topics:_** [[DeveloperDocumentationCategory]], [[StaticMethod]], [[ObjectMethod]]
index 0514227..b15a4c5 100644 (file)
@@ -1,21 +1,23 @@
 # <a name="Classic Skin"></a> Classic Skin
 
-The classic TWiki skin is a bare bone and functional skin, supporting any browser, and has a minimum of graphics
-
-This is not really a skin. It is the set of default templates, shown if no skin is activated. The default templates are part of every TWiki distribution.
+The classic TWiki skin is the traditional TWiki skin, as seen in previous TWiki versions.
 
 ## <a name="Skin Info"></a> Skin Info
 
 <table border="1" cellpadding="0" cellspacing="0">
   <tr>
     <td align="right"> Description: </td>
-    <td> The classic TWiki skin, bare bone and functional, for any browser, with a minimum of graphics </td>
+    <td> Bare bone and functional, for any browser, with a minimum of graphics </td>
   </tr>
   <tr>
     <td align="right"> Screenshot: </td>
     <td><a href="http://www.dementia.org/twiki//view/fullscreen.gif"><img alt="Click for full screen image" height="130" src="http://www.dementia.org/twiki//view/screenshot.gif" width="600" /></a></td>
   </tr>
   <tr>
+    <td align="right"> Preview: </td>
+    <td>[[%WEB%/%TOPIC%?skin=classic]]</td>
+  </tr>
+  <tr>
     <td align="right"> Base Name: </td>
     <td> classic </td>
   </tr>
@@ -47,10 +49,12 @@ This is not really a skin. It is the set of default templates, shown if no skin
     <td align="right"> Feedback: </td>
     <td><a href="http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev" target="_top">http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev</a></td>
   </tr>
+  <tr>
+    <td align="right"> Appraisal: </td>
+    <td><a href="http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Appraisal" target="_top">http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Appraisal</a></td>
+  </tr>
 </table>
 
 **_Note:_** The Description, Screenshot and Base Name rows are needed by the [[TWikiSkinBrowser]]
 
-**_Related topic:_** [[TWikiSkins]], [[TWikiSkinBrowser]]
-
--- TWiki:Main/PeterThoeny - 25 Jul 2004
+**_Related topic:_** [[TWikiSkins]], [[TWikiSkinBrowser]], [[UserDocumentationCategory]], [[AdminDocumentationCategory]]
index 8c35b51..c7e54a5 100644 (file)
@@ -4,6 +4,8 @@ This plugin allows users to quickly post comments to a page without an edit/prev
 
 _( Discussion in TWiki:Plugins/CommentPluginDev )_
 
+**_Note: this version of the [[CommentPlugin]] will _not_ work with TWiki versions released prior to June 2005_**
+
 <div>
   <ul>
     <li><a href="#Features"> Features</a></li>
@@ -22,7 +24,6 @@ _( Discussion in TWiki:Plugins/CommentPluginDev )_
         <li><a href="#The <code>OUTPUT</code> template"> The OUTPUT template</a></li>
       </ul>
     </li>
-    <li><a href="#Important Note regarding Locks"> Important Note regarding Locks</a></li>
     <li><a href="#Settings"> Settings</a></li>
     <li><a href="#Plugin Installation Instructions"> Plugin Installation Instructions</a></li>
     <li><a href="#Plugin Info"> Plugin Info</a></li>
@@ -51,7 +52,7 @@ Write the command `%COMMENT{` _attributes_ `}%` anywhere in a TWiki topic. %COMM
   </tr>
   <tr>
     <td><code>type</code></td>
-    <td> (Required) This is the name of the template to use for this comment. Comment templates are defined in a TWiki template - see [[Main/WebHome#TemPlates]], below. If this attribute is not defined, the type is whatever is defined by COMMENTPLUGIN_DEFAULT_TYPE, either in this topic or in your [[Main/WebPreferences]]. By default this is 'below'. </td>
+    <td> This is the name of the template to use for this comment. Comment templates are defined in a TWiki template - see [[Main/WebHome#TemPlates]], below. If this attribute is not defined, the type is whatever is defined by COMMENTPLUGIN_DEFAULT_TYPE, either in this topic or in your [[Main/WebPreferences]]. By default this is 'below'. </td>
   </tr>
   <tr>
     <td><code>target</code></td>
@@ -69,6 +70,10 @@ Write the command `%COMMENT{` _attributes_ `}%` anywhere in a TWiki topic. %COMM
     <td><code>nonotify</code></td>
     <td> Set to "on" to disable change notification for target topics </td>
   </tr>
+  <tr>
+    <td><code>noform</code></td>
+    <td> Set to "on" to disable the automatic form that encloses your comment block - <em>remember</em> to insert <code>&lt;FORM&gt;</code> tags yourself! </td>
+  </tr>
 </table>
 
 ## <a name="Positioning the comment"></a> Positioning the comment
@@ -101,10 +106,14 @@ will place comments above the first occurence of the string `Flights of Fancy` i
 
 **Warning** of course, if a user's comment contains the string "Flights of Fancy" they may and up _changing the location_ for the next comment! Also, if you use a tag in the location, then you've just inserted another tag in the page that contains the `%COMMENT`! So be very careful how you specify the RE for `location`. Note that the RE is matched using perl "multiple line" mode, so ^ and $ match the start of a line and the end of a line respectively.
 
+I look forward to someone leveraging this feature to create - for example - threaded conversations using `%COMMENT`.
+
 If you specify an anchor _and_ a `location`, the anchor will be ignored.
 
 ## <a name="Default templates"></a> 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.
+
 A set of default comment templates are shipped with the plugin. These are:
 
 <table border="1" cellpadding="0" cellspacing="0">
@@ -114,27 +123,31 @@ A set of default comment templates are shipped with the plugin. These are:
   </tr>
   <tr>
     <td><code>top</code></td>
-    <td> Comments, signed and dated, added at top of the topic (the anchor is ignored) </td>
+    <td> Comments, signed and dated (server time), added at top of the topic (the anchor is ignored) </td>
   </tr>
   <tr>
     <td><code>bottom</code></td>
-    <td> Comments, signed and dated, added at end of the target topic (the anchor is ignored) </td>
+    <td> Comments, signed and dated (server time), added at end of the target topic (the anchor is ignored) </td>
   </tr>
   <tr>
     <td><code>above</code></td>
-    <td> Comments, signed and dated, added immediately before the target anchor, or the <code>%COMMENT</code> if no anchor is specified </td>
+    <td> Comments, signed and dated (server time), added immediately before the target anchor, or the <code>%COMMENT</code> if no anchor is specified </td>
   </tr>
   <tr>
     <td><code>below</code></td>
-    <td> Comments, signed and dated, added immediately below the target anchor, or the <code>%COMMENT</code> if no anchor is specified </td>
+    <td> Comments, signed and dated (server time), added immediately below the target anchor, or the <code>%COMMENT</code> if no anchor is specified </td>
+  </tr>
+  <tr>
+    <td><code>threadmode</code></td>
+    <td> Wiki thread mode comment, signed and dated (server time) </td>
   </tr>
   <tr>
     <td><code>tableprepend</code></td>
-    <td> Comments, signed and dated, formatted as an HTML table row, added below the anchor (which must be in an HTML &lt;table&gt;) </td>
+    <td> Comments, signed and dated (server time), formatted as an HTML table row, added below the anchor (which must be in an HTML &lt;table&gt;) </td>
   </tr>
   <tr>
     <td><code>tableappend</code></td>
-    <td> Comments, signed and dated, formatted as an HTML table row, added above the anchor (which must be in an HTML &lt;table&gt;) </td>
+    <td> Comments, signed and dated (server time), formatted as an HTML table row, added above the anchor (which must be in an HTML &lt;table&gt;) </td>
   </tr>
 </table>
 
@@ -149,15 +162,22 @@ Customisation of the comment plugin requires
 - familiarity with HTML forms,
 - some familiarity with the [[TWiki templating language|TWiki/TWikiTemplates]].
 
-The plugin picks up its templates from a standard TWiki template file, named "comments". This allows different templates to be defined for different TWiki skins. This template file may include other template files, or may include a topic from a user web (this is an extension to the normal handling of `%TMPL:INCLUDE` described in the documentation). The shipped plugin defines default templates in `comments.tmpl` and then includes the topic [[CommentsTmpl]]. If you want to define your own templates, add them to [[UserTemplates]]. Note that you can use `%TMPL:INCLUDE` in this file to include other files of templates. Note also that if you want to override any of the default templates shipped with the plugin, you can simply do so by defining them in [[UserTemplates]], and they will replace the installed versions.
-
 To define a comment type, you have to provide two simple template definitions in the template file; one for the prompt box, and one for the generated output. If we have a template type "mytype", these are named `PROMPT:mytype` and `OUTPUT:mytype` respectively. See `comments.tmpl` in the templates directory for examples.
 
+The plugin picks up these template definitions from a standard TWiki template file, `templates/comments.tmpl`. This allows different templates to be defined for different TWiki skins. By default, this template includes the topic [[CommentsTemplate]], which contains all the shipped standard templates and in turn includes TWiki.UserCommentsTemplate. This allows for several levels of customisation:
+
+1. To override all default templates, everywhere, change `comments.tmpl` to include a different topic (this customisation will be lost next time you upgrade, though).
+2. To add site-wide local template customisations, add them to TWiki.UserCommentsTemplate. You can redefine the standard templates here if you want, and your definitions will override the standard definitions.
+3. To override templates on a web-by-web basis, add a topic UserCommentsTemplate to the web (this will replace TWiki.UserCommentsTemplate)
+4. To override templates for a specific skin, add them to TWiki.UserComments&lt;Skin&gt;Template (where &lt;Skin&gt; is the name of the skin with the first letter capitalised, e.g. Pattern)
+
+%X% Templates are picked up by following the [[standard TWiki rules|Main/TWikiTemplates#Finding_Templates]] for locating template files. Note that you can use `%TMPL:INCLUDE` to include other files of templates.
+
 ## <a name="The &lt;code&gt;PROMPT&lt;/code&gt; template"></a> The `PROMPT` template
 
 The `PROMPT` template defines the contents of an HTML form that is used to capture the comment. This form invokes the comment generator when submitted. Parameters to the comment generator are defined using standard HTML input fields, such as `input`, `textarea` and `select`. The user enters values for these parameters, and these are then available when the `OUTPUT` template is expanded, in the form of `%URLPARAM%`s.
 
-Only the input fields of the form need be defined. The plugin automatically generates the `>form<` and `&gt:/form<` tags. **Note** that you must define a "submit" button if you want the form to work!
+Only the input fields of the form need be defined. The plugin automatically generates the `>form<` and `&gt:/form<` tags, unless you specify `noform="on"`, in which case you have to provide them yourself. **Note** that you must define a "submit" button if you want the form to work!
 
 <a name="MoreAttrs"></a> If an attribute is given to the `%COMMENT` tag that is not one of the [[standard attributes|Main/WebHome#StandardAttrs]], then that attribute is taken as the name of a parameter to be expanded in the `PROMPT` template. Expressions in the template of the form `%`_param_`|`_default_`%` (e.g. `%rows|3%`, `%button|Push me%`) are expanded to the values given in the `%COMMENT`. For example, if the `PROMPT` template 'example' contains:
 
@@ -165,11 +185,11 @@ Only the input fields of the form need be defined. The plugin automatically gene
 
 and the %COMMENT tag is:
 
-    %COMMENT{type="example" rows="5" cols="20"}%
+    %COMMENT{type="example" cols="75"}%
 
 then the template will be expanded as
 
-    <textarea rows=5 cols="20" value="Rubbish">
+    <textarea rows="3" cols="75" value="Rubbish">
 
 As well as support for all the usual TWiki variables in templates, the following special variables are supported in the `PROMPT` definition:
 
@@ -184,7 +204,7 @@ As well as support for all the usual TWiki variables in templates, the following
   </tr>
   <tr>
     <td><code>%DISABLED%</code></td>
-    <td> Set to 'disabled' when you cannot comment (see [[Main/WebHome#HandlingPageLock]], below). </td>
+    <td> Set to 'disabled' when you cannot comment (e.g. in preview mode). </td>
   </tr>
 </table>
 
@@ -215,140 +235,44 @@ There are also four position tags that are used to indicate where the comment sh
 
 Note that these position tags are obviously mutually exclusive. If you define more than one, the result is undefined. If none is present, the default is taken from the plugin setting `DEFAULT_TYPE`
 
-<a name="HandlingPageLock"></a>
-
-# <a name="Important Note regarding Locks"></a> Important Note regarding Locks
-
-The plugin checks if the page is locked for edit. When a locked page is displayed in 'view' mode, comment input is automatically disabled.
-
-Note that if the page was read long time ago, it's possible that page was locked by another user **after** it was read, and the lock is still outstanding. In this case, comments cannot be saved, and you will be redirected to a "topic is locked" page. You then have two options:
-
-- **Cancel** - throw away your comment and return to viewing the page.
-- **Back** - **WARNING** some browsers might requery the page and **lose** your comments - so test how your browser behaves before using the Back button.
-
-To help avoid edit conflict, a reminder to refresh the page before entering comments is the default text for a `%COMMENT`. When the target page is known to be locked, the `PROMPT` form is automatically disabled.
+All the usual [[TWikiVariables]] that can be used in a topic template can also be used in an `OUTPUT` template. See [[TWikiVariables]] for details.
 
 # <a name="Settings"></a> Settings
 
 - Description:
   - Set SHORTDESCRIPTION = Allows users to quickly post comments to a page without an edit/preview/save cycle.
-- templates; includes user templates from [[CommentsTmpl]]
+- Name of file in the 'templates' directory that contains the comment templates. The default 'comments.tmpl' automatically includes user templates from [[CommentsTmpl]]
   - Set TEMPLATES = comments
 - default template type (if not present, defaults to "below")
-  - Set DEFAULT\_TYPE = above
+  - Set DEFAULT\_TYPE = below
 
 # <a name="Plugin Installation Instructions"></a> Plugin Installation Instructions
 
-\* Make sure you have the TWiki:Plugins/SharedCode module installed. Among other things, TWiki:Plugins/SharedCode includes a compatibility module that enables plugins to use new TWiki features with earlier TWiki releases. If you don't already have it, install it now.
-
-- Download the ZIP file from the Plugin web (see below)
-- Unzip <code>**%TOPIC%.zip**</code> in your twiki installation directory. Content: <table border="1" cellpadding="0" cellspacing="0">
-  <tr>
-    <th bgcolor="#99CCCC"><strong> File: </strong></th>
-    <th bgcolor="#99CCCC"><strong> Description: </strong></th>
-  </tr>
-  <tr>
-    <td><code><b>data/TWiki/CommentPlugin.txt</b></code></td>
-    <td> Plugin doc page (this page) </td>
-  </tr>
-  <tr>
-    <td><code><b>data/TWiki/CommentsTmpl.txt</b></code></td>
-    <td> Example user templates </td>
-  </tr>
-  <tr>
-    <td><code><b>templates/comments.tmpl</b></code></td>
-    <td> Master comment templates </td>
-  </tr>
-  <tr>
-    <td><code><b>lib/TWiki/Plugins/CommentPlugin.pm</b></code></td>
-    <td> Plugin Perl module </td>
-  </tr>
-  <tr>
-    <td><code><b>lib/TWiki/Plugins/CommentPlugin/Comment.pm</b></code></td>
-    <td> Plugin Perl module </td>
-  </tr>
-  <tr>
-    <td><code><b>lib/TWiki/Plugins/CommentPlugin/Templates.pm</b></code></td>
-    <td> Plugin Perl module </td>
-  </tr>
-  <tr>
-    <td><code><b>lib/TWiki/Plugins/CommentPlugin/test.zip</b></code></td>
-    <td> Tests </td>
-  </tr>
-  <tr>
-    <td><code><b>lib/TWiki/Plugins/CommentPlugin/build.pl</b></code></td>
-    <td> Build file </td>
-  </tr>
-</table>
-
-- The Plugin depends on the `viewauth` script to authenticate the user. As described in [[TWikiAccessControl]], copy the `view` script to `viewauth` (or better, create a symbolic link) and add `viewauth` to the list of authenticated scripts in the `.htaccess` file.
-
-If installed correctly, you should see a `%COMMENT` edit box below here.
-
-<form action="http://www.dementia.org/twiki/save/Sandbox/Comments" enctype="multipart/form-data" id="top0" method="post" name="top0"><input name="comment_action" type="hidden" value="save" /><input name="comment_type" type="hidden" value="top" /><input name="comment_index" type="hidden" value="0" /></form>
+- This plugin is pre-installed in most TWiki releases. However if you need to upgrade the plugin for any reason:
+  - Download the archive file from the Plugin web (see below)
+  - Unpack the archive in your twiki installation directory.
+  - You may need to correct file permissions.
+  - Run <code>**%TOPIC%\_installer**</code> to automatically check and install other modules that this module depends on. You can also do this step manually. Dependencies: None
+  - Visit `configure` in your TWiki installation, and enable the plugin in the \{Plugins\} section.
 
 # <a name="Plugin Info"></a> Plugin Info
 
 <table border="1" cellpadding="0" cellspacing="0">
   <tr>
     <td align="right"> Plugin Author: </td>
-    <td> v1.0 TWiki:Main/DavidWeller v2.0 TWiki:Main/PeterMasiar v3.0 TWiki:Main/CrawfordCurrie </td>
-  </tr>
-  <tr>
-    <td align="right"> Plugin Version: </td>
-    <td> 3.0 </td>
-  </tr>
-  <tr>
-    <td align="right"> Change History: </td>
-    <td> 3.003 11 Apr 2004: Minor line termination problem fixed, and "security" hyphen on standard comment removed and replaced with a bulleted list. </td>
-  </tr>
-  <tr>
-    <td>   </td>
-    <td> 3.002 6 April 2004: Applied patches (thanks Peter Thoeny) for multiple comment adding, BOTTOM and TOP inside meta-data, and moved example to Sandbox. </td>
-  </tr>
-  <tr>
-    <td>   </td>
-    <td> 3.001 13 March 2004: Modified to use viewauth save technique (safer), add nonotify parameter, move templates fully into topics, with a hook for site-specifics, support %COMMENT%, internationalisation fixes </td>
-  </tr>
-  <tr>
-    <td>   </td>
-    <td> 3.000 18 Feb 2004: TWiki:Main/CrawfordCurrie rewrote for standard templates and other user requests. Recognition to Patrice Fournier and Sam Abrams for terrific testing and patch support. </td>
-  </tr>
-  <tr>
-    <td>   </td>
-    <td> 7 Feb 2004: TWiki:Main/CrawfordCurrie rewrote this page and [[Main/CommentTemplates]] in an effort to make the plugin more user friendly. Added {TIME} variable. Also updated CVS. </td>
-  </tr>
-  <tr>
-    <td>   </td>
-    <td> 23 Sep 2003 TWiki:Main/PeterMasiar: 80% rewrite/refactor, adding templates </td>
-  </tr>
-  <tr>
-    <td>   </td>
-    <td> 15 July 2003: TWiki:Main/PeterMasiar added "reminder" parameter and feature to pass comments to oopslockedcomments.tmpl template to copy-paste later </td>
-  </tr>
-  <tr>
-    <td>   </td>
-    <td> 5 March 2002 Bug fixes, TWiki:Main/JonLambert created oopslockedcomments.tmpl template </td>
-  </tr>
-  <tr>
-    <td>   </td>
-    <td> 24 Feb 2002 added a few more user requests, made "English" text configurable </td>
-  </tr>
-  <tr>
-    <td>   </td>
-    <td> 4 Dec 2001: 1.01 release, changed name to [[Main/CommentPlugin]], added $button var, changed textarea WRAP setting to "soft" </td>
+    <td> TWiki:Main.DavidWeller, TWiki:Main.PeterMasiar, TWiki:Main.CrawfordCurrie <a href="http://www.c-dot.co.uk" target="_top">http://www.c-dot.co.uk</a></td>
   </tr>
   <tr>
-    <td>   </td>
-    <td> 30 Nov 2001: Initial version </td>
+    <td> Change History: </td>
+    <td> Please refer to the TWiki Subversion repository for a complete change history of this plugin. </td>
   </tr>
   <tr>
     <td align="right"> Dependencies: </td>
-    <td>   </td>
+    <td> None </td>
   </tr>
   <tr>
     <td align="right"> Perl Version: </td>
-    <td> 5.0 </td>
+    <td> &gt;= 5.6.1 </td>
   </tr>
   <tr>
     <td align="right"> Plugin Home: </td>
@@ -362,4 +286,4 @@ If installed correctly, you should see a `%COMMENT` edit box below here.
 
 **_Related Topics:_** [[TWikiPreferences]], [[TWikiPlugins]]
 
--- TWiki:Main/DavidWeller - 05 Mar 2002 <br /> -- TWiki:Main/PeterMasiar - 15 Jul 2003, 23 Sep 2003<br /> -- TWiki:Main/CrawfordCurrie - 21 May 2004
+-- TWiki:Main/CrawfordCurrie - 23:00:07 01 February 2006
index 4f54767..c085dbd 100644 (file)
@@ -16,4 +16,4 @@ Note for site administrators: To remove a topic permanently move it to the Trash
 
 **_Back to:_** [[TWikiFAQ]]
 
--- [[PeterThoeny]] - 09 May 2003
+**_Related Topics:_** [[UserDocumentationCategory]]
index 90b3a78..9c1bde3 100644 (file)
@@ -14,4 +14,4 @@ Note for system administrators: To remove an attachment permanently move it to t
 
 **_Back to:_** [[TWikiFAQ]]
 
--- [[PeterThoeny]] - 09 May 2003
+**_Related Topics:_** [[UserDocumentationCategory]]
diff --git a/TWiki/DeveloperDocumentationCategory.mdwn b/TWiki/DeveloperDocumentationCategory.mdwn
new file mode 100644 (file)
index 0000000..3a43f4c
--- /dev/null
@@ -0,0 +1,5 @@
+# <a name="A List of TWiki Developer Docume"></a> A List of TWiki Developer Documentation
+
+# <a name="TWiki Installation Error"></a> TWiki Installation Error
+
+Incorrect format of searchformat template (missing sections? There should be 4 %SPLIT% tags)
index d5b5bb0..186834b 100644 (file)
@@ -3,3 +3,5 @@ Use the "Minor changes, don't notify" checkbox in preview in case you only make
 **_Note:_** No new revision is created in case you save the same topic again within a certain time frame (default is one hour). You only need to checkmark the "Minor change, don't notify" checkbox once within this time frame, because subsequent save operations do not notify users.
 
 **_Note:_** The initial state of the checkbox can be set to on with the `DONTNOTIFYCHECKBOX` preferences variable. See [[TWikiPreferences]] for more.
+
+**_Related Topics:_** [[UserDocumentationCategory]]
index 910b3ee..0015821 100644 (file)
@@ -8,4 +8,4 @@ The same topic revision will be used when you save a topic again within a certai
 
 **_Back to:_** [[TWikiFAQ]]
 
--- [[PeterThoeny]] - 27 Nov 2000 <br />
+**_Related Topics:_** [[UserDocumentationCategory]]
index 3940e06..292df9f 100644 (file)
@@ -37,7 +37,7 @@ Add a `%EDITTABLE{...}%` variable just before an existing table to make it edita
   </tr>
   <tr>
     <td><code>format</code></td>
-    <td> The format of one column when editing the table. A cell can be a text input field, or any of these edit field types:%BR% - Text input field (1 line):%BR%   <code>| text, &lt;size&gt;, &lt;initial value&gt; |</code> %BR% - Textarea input field:%BR%   <code>| textarea, &lt;rows&gt;x&lt;columns&gt;, &lt;initial value&gt; |</code> %BR% - Drop down box: %BR%   <code>| select, &lt;size&gt;, &lt;option 1&gt;, &lt;option 2&gt;, etc |</code> %BR% - Fixed label: %BR%   <code>| label, 0, &lt;label text&gt; |</code> %BR% - Row number: %BR%   <code>| row, &lt;offset&gt; |</code> %BR% - Date: %BR%   <code>| date, &lt;size&gt;, &lt;initial value&gt;, &lt;DHTML date format&gt; |</code></td>
+    <td> The format of one column when editing the table. A cell can be a text input field, or any of these edit field types:%BR% • Text input field (1 line):%BR%   <code>| text, &lt;size&gt;, &lt;initial value&gt; |</code> %BR% • Textarea input field:%BR%   <code>| textarea, &lt;rows&gt;x&lt;columns&gt;, &lt;initial value&gt; |</code> %BR% • Drop down box: %BR%   <code>| select, &lt;size&gt;, &lt;option 1&gt;, &lt;option 2&gt;, etc |</code> %BR% • Radio buttons: %BR%   <code>| radio, &lt;size*&gt;, &lt;option 1&gt;, &lt;option 2&gt;, etc |</code> %BR%   <code>*</code> size indicates the number of buttons per line in edit mode %BR% • Checkboxes: %BR%   <code>| checkbox, &lt;size*&gt;, &lt;option 1&gt;, &lt;option 2&gt;, etc |</code> %BR%   <code>*</code> size indicates the number of checkboxes per line in edit mode %BR% • Fixed label: %BR%   <code>| label, 0, &lt;label text&gt; |</code> %BR% • Row number: %BR%   <code>| row, &lt;offset&gt; |</code> %BR% • Date: %BR%   <code>| date, &lt;size&gt;, &lt;initial value&gt;, &lt;DHTML date format&gt; |</code></td>
     <td><code>"text, 16"</code> %BR% for all cells </td>
   </tr>
   <tr>
@@ -132,32 +132,35 @@ It is also possible to place the edit button inside a cell instead of default lo
 
 ## <a name="Examples"></a> Examples
 
-Line before table: `%EDITTABLE{ header="|*Nr*|*Text field sandbox*|*Drop down sandbox*|*Timestamp*|" format="| row, -1 | text, 20, init | select, 1, one, two, three, four | label, 0, %SERVERTIME{"$day $mon $year $hour:$min"}% |" changerows="on" }%` <a name="edittable1"></a>
+Line before table: `%EDITTABLE{ format="| row, -1 | text, 20, init | select, 1, one, two, three, four | radio, 3,:-),:-I,:-( | label, 0, %SERVERTIME{"$day $mon $year $hour:$min"}% |" changerows="on" }%` <a name="edittable1"></a>
 
 <div>
   <form action="http://www.dementia.org/twiki/viewauth#edittable1" method="post" name="edittable1"><input name="ettablenr" type="hidden" value="1" /> <input name="etedit" type="hidden" value="on" /><table border="1" cellpadding="0" cellspacing="0">
       <tr>
         <th bgcolor="#99CCCC"><strong> Nr </strong></th>
-        <th bgcolor="#99CCCC"><strong> Text field sandbox </strong></th>
-        <th bgcolor="#99CCCC"><strong> Drop down sandbox </strong></th>
+        <th bgcolor="#99CCCC"><strong> Text field </strong></th>
+        <th bgcolor="#99CCCC"><strong> Drop down </strong></th>
+        <th bgcolor="#99CCCC"><strong> Mood </strong></th>
         <th bgcolor="#99CCCC"><strong> Timestamp </strong></th>
       </tr>
       <tr>
         <td> 1 </td>
         <td> hello table </td>
         <td> one </td>
+        <td> :-) </td>
         <td> 26 Jun 2002 12:30 </td>
       </tr>
       <tr>
         <td> 2 </td>
         <td>   </td>
         <td> two </td>
+        <td> :-( </td>
         <td> 27 Jun 2002 12:40 </td>
       </tr>
     </table><input name="etrows" type="hidden" value="3" /> <input type="submit" value="Edit table" /></form>
 </div>
 
-%RED% **_Note:_** Please use TWiki:Sandbox.EditTablePluginTesting if you want to try out this Plugin %ENDCOLOR%
+%RED% **_Note:_** Please do not save this example table! Use TWiki:Sandbox.EditTablePluginTesting if you want to try out this Plugin %ENDCOLOR%
 
 If this plugin is installed you will see an **[ Edit table ]** button above; if you were to click on it (please don't, use TWiki:Sandbox.EditTablePluginTesting for testing) you get this form:
 
@@ -165,8 +168,9 @@ If this plugin is installed you will see an **[ Edit table ]** button above;
   <table border="1" cellpadding="0" cellspacing="1">
     <tr>
       <th bgcolor="#99CCCC"> Nr </th>
-      <th bgcolor="#99CCCC"> Text field sandbox </th>
-      <th bgcolor="#99CCCC"> Drop down sandbox </th>
+      <th bgcolor="#99CCCC"> Text field </th>
+      <th bgcolor="#99CCCC"> Drop down </th>
+      <th bgcolor="#99CCCC"> Mood </th>
       <th bgcolor="#99CCCC"> Timestamp </th>
     </tr>
     <tr>
@@ -176,7 +180,8 @@ If this plugin is installed you will see an **[ Edit table ]** button above;
           <option>two</option>
           <option>three</option>
           <option>four</option></select></td>
-      <td bgcolor="#FFFFFF"> 26 Jun 2002 12:30<input name="etcell2x4" type="hidden" value="26 Jun 2002 12:30" /></td>
+      <td bgcolor="#FFFFFF"><input checked name="etcell2x4" type="radio" value=":-)" /> <img alt="smile" border="0" src="http://www.dementia.org/twiki//view/%WEB%/SmiliesPlugin/smile.gif" title="smile" /> <input name="etcell2x4" type="radio" value=":-I" /> <img alt="indifferent" border="0" src="http://www.dementia.org/twiki//view/%WEB%/SmiliesPlugin/indifferent.gif" title="indifferent" /> <input name="etcell2x4" type="radio" value=":-(" /> <img alt="frown" border="0" src="http://www.dementia.org/twiki//view/%WEB%/SmiliesPlugin/frown.gif" title="frown" /></td>
+      <td bgcolor="#FFFFFF"> 26 Jun 2002 12:30<input name="etcell2x5" type="hidden" value="26 Jun 2002 12:30" /></td>
     </tr>
     <tr>
       <td bgcolor="#FFFF99"> 2<input name="etcell3x1" type="hidden" value="2" /></td>
@@ -185,7 +190,8 @@ If this plugin is installed you will see an **[ Edit table ]** button above;
           <option selected>two</option>
           <option>three</option>
           <option>four</option></select></td>
-      <td bgcolor="#FFFF99"> 27 Jun 2002 12:40<input name="etcell3x4" type="hidden" value="27 Jun 2002 12:40" /></td>
+      <td bgcolor="#FFFF99"><input name="etcell2x4" type="radio" value=":-)" /> <img alt="smile" border="0" src="http://www.dementia.org/twiki//view/%WEB%/SmiliesPlugin/smile.gif" title="smile" /> <input name="etcell2x4" type="radio" value=":-I" /> <img alt="indifferent" border="0" src="http://www.dementia.org/twiki//view/%WEB%/SmiliesPlugin/indifferent.gif" title="indifferent" /> <input checked name="etcell2x4" type="radio" value=":-(" /> <img alt="frown" border="0" src="http://www.dementia.org/twiki//view/%WEB%/SmiliesPlugin/frown.gif" title="frown" /></td>
+      <td bgcolor="#FFFF99"> 27 Jun 2002 12:40<input name="etcell3x5" type="hidden" value="27 Jun 2002 12:40" /></td>
     </tr>
   </table><input name="etsave" onclick="return(false);" type="submit" value="Save table" /> <input name="etqsave" onclick="return(false);" type="submit" value="Quiet save" /> <input name="etaddrow" onclick="return(false);" type="submit" value="Add row" /> <input name="etdelrow" onclick="return(false);" type="submit" value="Delete last row" /> <input name="etcancel" onclick="return(false);" type="submit" value="Cancel" /> (demo only, these buttons do not work) </form>
 
@@ -312,13 +318,21 @@ Plugin settings are stored as preferences variables. To reference a plugin setti
   </tr>
   <tr>
     <td align="right"> Plugin Version: </td>
-    <td> 01 Aug 2004 </td>
+    <td> 8670 </td>
   </tr>
   <tr>
     <td align="right"> Change History: </td>
     <td>  </td>
   </tr>
   <tr>
+    <td align="right"> 21 Jan 2006: </td>
+    <td> TWiki:Main.CrawfordCurrie ported to TWiki-4.0.0, changed to use [[Main/JSCalendarContrib]]</td>
+  </tr>
+  <tr>
+    <td align="right"> 16 Sep 2004: </td>
+    <td> Added radio buttons and checkbox controls; escaped "|" pipe symbol found in input fields to preserve tables </td>
+  </tr>
+  <tr>
     <td align="right"> 01 Aug 2004: </td>
     <td> Fixed bug where edittable did not work if at the end of a topic </td>
   </tr>
@@ -403,12 +417,8 @@ Plugin settings are stored as preferences variables. To reference a plugin setti
     <td> Initial version </td>
   </tr>
   <tr>
-    <td align="right"> CPAN Dependencies: </td>
-    <td> none </td>
-  </tr>
-  <tr>
-    <td align="right"> Other Dependencies: </td>
-    <td><a href="http://dynarch.com/mishoo/calendar.epl" target="_top">Mishoo DHTML calendar</a> (version 0.9.5 preinstalled); TWiki version 01 Feb 2003 or later </td>
+    <td align="right"> Dependencies: </td>
+    <td> None </td>
   </tr>
   <tr>
     <td align="right"> Perl Version: </td>
@@ -430,4 +440,4 @@ Plugin settings are stored as preferences variables. To reference a plugin setti
 
 **_Related Topics:_** [[TWikiPreferences]], [[TWikiPlugins]]
 
--- TWiki:Main/PeterThoeny - 01 Aug 2004
+-- TWiki:Main/PeterThoeny - 16 Sep 2004
index d8069a3..75de54f 100644 (file)
@@ -19,7 +19,7 @@ Plugin settings are stored as preferences variables. To reference a plugin setti
 - One line description, is shown in the [[TextFormattingRules]] topic:
   - Set SHORTDESCRIPTION = This plugin does nothing, but can be used as a template for your own plugins.
 
-- Your own setting, i.e.:
+- Your own setting, for example:
   - Set EXAMPLE = got it!
 
 - Debug plugin: (See output in `data/debug.txt`)
@@ -38,7 +38,7 @@ Plugin settings are stored as preferences variables. To reference a plugin setti
   </tr>
   <tr>
     <td align="right"> Plugin Version: </td>
-    <td> 21 Mar 2003 </td>
+    <td> 21 Mar 2004 </td>
   </tr>
   <tr>
     <td align="right"> Change History: </td>
@@ -80,8 +80,10 @@ Plugin settings are stored as preferences variables. To reference a plugin setti
     <td align="right"> Feedback: </td>
     <td><a href="http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev" target="_top">http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev</a></td>
   </tr>
+  <tr>
+    <td align="right"> Appraisal: </td>
+    <td><a href="http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Appraisal" target="_top">http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Appraisal</a></td>
+  </tr>
 </table>
 
-**_Related Topics:_** [[TWikiPreferences]], [[TWikiPlugins]], [[DefaultPlugin]]
-
--- TWiki:Main.AndreaSterbini - 27 Feb 2001 %BR% -- TWiki:Main.PeterThoeny - 21 Mar 2004
+**_Related Topics:_** [[DeveloperDocumentationCategory]], [[AdminDocumentationCategory]], [[TWikiPreferences]], [[TWikiPlugins]]
index b1edf3b..aec4477 100644 (file)
@@ -26,7 +26,7 @@ _Each topic can have one or more files of any type attached to it by using the A
 
 ## <a name="What Are Attachments Good For?"></a> What Are Attachments Good For?
 
-File Attachments can be used to create powerful customized groupware solutions, like file sharing and document management systems, and quick Web page authoring.
+File Attachments can be used to archive data, or to create powerful customized groupware solutions, like file sharing and document management systems, and quick Web page authoring.
 
 ### <a name="Document Management System"></a> Document Management System
 
@@ -49,6 +49,10 @@ File Attachments can be used to create powerful customized groupware solutions,
   - The previous upload path is retained for convenience. In case you make some changes to the local file and want to upload it, again you can copy the previous upload path into the Local file field.
   - TWiki can limit the file size. This is defined by the `%ATTACHFILESIZELIMIT%` variable of the [[TWikiPreferences]], currently set at %ATTACHFILESIZELIMIT% KB.
     - %X% It's not recommended to upload files greater than a few hundred K through a browser. Large files can be extremely slow-loading, and often time out. Use an FTP site for large file uploads.
+- Automatic attachments:
+  - When enabled, all files in a topic's attachment directory are shown as attachments to the topic - even if they were directly copied to the directory and never attached by using an 'Attach' link. This is a convenient way to quickly "attach" files to a topic without uploading them one by one; although at the cost of losing audit trail and version control.
+  - To enable this feature, set the \{AutoAttachPubDir\} configuration option.
+  - **_NOTE:_** The automatic attachment feature can only be used by an administrator who has access to the server's file system.
 
 ## <a name="Downloading Files"></a> Downloading Files
 
@@ -78,14 +82,14 @@ Move unwanted Attachments to web `Trash`, topic `TrashAttachment`.
   3. <code>**Preview**</code>: `%ATTACHURL%/Sample.txt` text appears as: <http://www.dementia.org/twiki//view/%WEB%/%TOPIC%/Sample.txt>, a link to the text file.
 
 - To reference an attachment located in another topic, enter:
-  - `%PUBURL%/%WEB%/OtherTopic/Sample.txt` (if it's within the same web)
-  - `%PUBURL%/Otherweb/OtherTopic/Sample.txt` (if it's in a different web)
+  - `%PUBURLPATH%/%WEB%/OtherTopic/Sample.txt` (if it's within the same web)
+  - `%PUBURLPATH%/Otherweb/OtherTopic/Sample.txt` (if it's in a different web)
 
 - Attached HTML files and text files can be inlined in a topic. Example:
   1. <code>**Attach**</code> file: `Sample.txt`
   2. <code>**Edit**</code> topic and write text: `%INCLUDE{"%ATTACHURL%/Sample.txt"}%`
     - Content of attached file is shown inlined.
-    - Read more in [[IncludeTopicsAndWebPages]].
+    - Read more about INCLUDE in [[TWikiVariables|Main/TWikiVariables#VarINCLUDE]]
 
 - GIF, JPG and PNG images can be attached and shown embedded in a topic. Example:
   1. <code>**Attach**</code> file: `Smile.gif`
@@ -98,121 +102,103 @@ Move unwanted Attachments to web `Trash`, topic `TrashAttachment`.
 
 Files attached to a topic are displayed in a directory table, displayed at the bottom of the page, or optionally, hidden and accessed when you click **Attach**.
 
-> <table border="1" cellpadding="20" cellspacing="0" width="90%">
+> <table border="1" cellpadding="1" cellspacing="0">
 >   <tr>
->     <td>
->       <table border="1" cellpadding="1" cellspacing="0">
->         <tr>
->           <th align="center" bgcolor="#99CCCC"><strong><a href="FileAttachment">Attachment</a></strong></th>
->           <th align="center" bgcolor="#99CCCC"><strong>Action</strong></th>
->           <th align="center" bgcolor="#99CCCC"><strong>Size</strong></th>
->           <th align="center" bgcolor="#99CCCC"><strong>Date</strong></th>
->           <th align="center" bgcolor="#99CCCC"><strong>Who</strong></th>
->           <th align="center" bgcolor="#99CCCC"><strong>Comment</strong></th>
->         </tr>
->         <tr>
->           <td><img align="top" height="16" src="http://www.dementia.org/twiki//view/icn/txt.gif" width="16" /> <a href="http://www.dementia.org/twiki//viewfile/%WEB%/%TOPIC%?rev=&filename=Sample.txt">Sample.txt</a></td>
->           <td><a href="http://www.dementia.org/twiki//attach/%WEB%/%TOPIC%?filename=Sample.txt&revInfo=1">manage</a></td>
->           <td align="right"> 0.1 K </td>
->           <td> 22 Jul 2000 - 19:37 </td>
->           <td><a href="PeterThoeny">PeterThoeny</a></td>
->           <td> Just a sample </td>
->         </tr>
->         <tr>
->           <td><img align="top" hight="16" src="http://www.dementia.org/twiki//view/icn/bmp.gif" width="16" /> <a href="http://www.dementia.org/twiki//viewfile/%WEB%/%TOPIC%?rev=&filename=Smile.gif">Smile.gif</a></td>
->           <td><a href="http://www.dementia.org/twiki//attach/%WEB%/%TOPIC%?filename=Smile.gif&revInfo=1">manage</a></td>
->           <td align="right"> 0.1 K </td>
->           <td> 22 Jul 2000 - 19:38 </td>
->           <td><a href="PeterThoeny">PeterThoeny</a></td>
->           <td> Smiley face </td>
->         </tr>
->       </table>
->     </td>
+>     <th align="center" bgcolor="#99CCCC"><strong>I</strong></th>
+>     <th align="center" bgcolor="#99CCCC"><strong>Attachment</strong></th>
+>     <th align="center" bgcolor="#99CCCC"><strong>Action</strong></th>
+>     <th align="center" bgcolor="#99CCCC"><strong>Size</strong></th>
+>     <th align="center" bgcolor="#99CCCC"><strong>Date</strong></th>
+>     <th align="center" bgcolor="#99CCCC"><strong>Who</strong></th>
+>     <th align="center" bgcolor="#99CCCC"><strong>Comment</strong></th>
+>   </tr>
+>   <tr>
+>     <td><img align="top" alt="txt" border="0" height="16" src="http://www.dementia.org/twiki//view/Main/WebHome/txt.gif" width="16" /></td>
+>     <td><a href="http://www.dementia.org/twiki/viewfile/%WEB%/%TOPIC%?rev=&filename=Sample.txt">Sample.txt</a></td>
+>     <td><a href="http://www.dementia.org/twiki/attach/%WEB%/%TOPIC%?filename=Sample.txt&revInfo=1">manage</a></td>
+>     <td align="right"> 0.1 K </td>
+>     <td> 22 Jul 2000 - 19:37 </td>
+>     <td><a href="UploadingUser">UploadingUser</a></td>
+>     <td> Just a sample </td>
+>   </tr>
+>   <tr>
+>     <td><img align="top" alt="bmp" border="0" height="16" src="http://www.dementia.org/twiki//view/Main/WebHome/bmp.gif" width="16" /></td>
+>     <td><a href="http://www.dementia.org/twiki/viewfile/%WEB%/%TOPIC%?rev=&filename=Smile.gif">Smile.gif</a></td>
+>     <td><a href="http://www.dementia.org/twiki/attach/%WEB%/%TOPIC%?filename=Smile.gif&revInfo=1">manage</a></td>
+>     <td align="right"> 0.1 K </td>
+>     <td> 22 Jul 2000 - 19:38 </td>
+>     <td><a href="UploadingUser">UploadingUser</a></td>
+>     <td> Smiley face </td>
 >   </tr>
 > </table>
 
 ## <a name="File Attachment Controls"></a> File Attachment Controls
 
-Clicking on a <code>**Manage**</code> link takes you to a new page that looks like this:
+Clicking on a <code>**Manage**</code> link takes you to a new page that looks a bit like this (depending on what [[skin|Main/TWikiSkins]] is selected):
 
 > <form>
 >   <table border="1" cellpadding="20" cellspacing="0">
 >     <tr>
 >       <td>
->         <table border="1" cellpadding="1" cellspacing="0">
->           <tr>
->             <th align="center" bgcolor="#99CCCC"><strong><a href="FileAttachment">Attachment</a></strong></th>
->             <th align="center" bgcolor="#99CCCC"><strong>Action</strong></th>
->             <th align="center" bgcolor="#99CCCC"><strong>Size</strong></th>
->             <th align="center" bgcolor="#99CCCC"><strong>Date</strong></th>
->             <th align="center" bgcolor="#99CCCC"><strong>Who</strong></th>
->             <th align="center" bgcolor="#99CCCC"><strong>Comment</strong></th>
->             <th align="center" bgcolor="#99CCCC"><strong><a href="FileAttribute">Attribute</a></strong></th>
->           </tr>
->           <tr>
->             <td><img align="top" height="16" src="http://www.dementia.org/twiki//view/icn/txt.gif" width="16" /> <a href="http://www.dementia.org/twiki//viewfile/TWiki/%WEB%/%TOPIC%?rev=&filename=Sample.txt">Sample.txt</a></td>
->             <td><a href="http://www.dementia.org/twiki//attach/%WEB%/%TOPIC%?filename=Sample.txt&revInfo=1">manage</a></td>
->             <td align="right"> 0.1 K </td>
->             <td> 22 Jul 2000 - 19:37 </td>
->             <td><a href="PeterThoeny">PeterThoeny</a></td>
->             <td> Just a sample </td>
->             <td align="center">   </td>
->           </tr>
->           <tr>
->             <td><img align="top" height="16" src="http://www.dementia.org/twiki//view/icn/bmp.gif" width="16" /> <a href="http://www.dementia.org/twiki//viewfile/%WEB%/%TOPIC%?rev=&filename=Smile.gif">Smile.gif</a></td>
->             <td><a href="http://www.dementia.org/twiki//attach/%WEB%/%TOPIC%?filename=Smile.gif&revInfo=1">manage</a></td>
->             <td align="right"> 0.1 K </td>
->             <td> 22 Jul 2000 - 19:38 </td>
->             <td><a href="PeterThoeny">PeterThoeny</a></td>
->             <td> Smiley face </td>
->             <td align="center">   </td>
->           </tr>
->         </table>
->         <p>
->         </p>
 >         <h2>Update attachment <code>Sample.txt</code></h2>
+>         <div>
+>           <table border="1" cellpadding="1" cellspacing="0">
+>             <tr>
+>               <th align="center" bgcolor="#99CCCC"><strong>Version</strong></th>
+>               <th align="center" bgcolor="#99CCCC"><strong>Action</strong></th>
+>               <th align="center" bgcolor="#99CCCC"><strong>Date</strong></th>
+>               <th align="center" bgcolor="#99CCCC"><strong>Who</strong></th>
+>               <th align="center" bgcolor="#99CCCC"><strong>Comment</strong></th>
+>             </tr>
+>             <tr>
+>               <td> 1 </td>
+>               <td><a href="http://www.dementia.org/twiki/viewfile/%WEB%/%TOPIC%?rev=1&filename=Sample.txt">view</a></td>
+>               <td> 22 Jul 2000 - 19:37 </td>
+>               <td><a href="UploadingUser">UploadingUser</a></td>
+>               <td> Just a sample </td>
+>             </tr>
+>           </table>
+>         </div>
 >         <p>
 >         </p>
->         <table border="1" cellpadding="1" cellspacing="0">
->           <tr>
->             <th align="center" bgcolor="#99CCCC"><strong>Version</strong></th>
->             <th align="center" bgcolor="#99CCCC"><strong>Action</strong></th>
->             <th align="center" bgcolor="#99CCCC"><strong>Date</strong></th>
->             <th align="center" bgcolor="#99CCCC"><strong>Who</strong></th>
->             <th align="center" bgcolor="#99CCCC"><strong>Comment</strong></th>
->           </tr>
->           <tr>
->             <td> 1.1 </td>
->             <td><a href="http://www.dementia.org/twiki//viewfile/%WEB%/%TOPIC%?rev=1.1&filename=Sample.txt">view</a></td>
->             <td> 2001.08.30.09.28.56 </td>
->             <td><a href="PeterThoeny">PeterThoeny</a></td>
->             <td>   </td>
->           </tr>
->         </table>
->         <p>
->         </p>
->         <table width="100%">
->           <tr>
->             <td align="right"> Previous <br /> upload: </td>
->             <td><code>C:\DATA\Sample.txt</code> (<a href="PeterThoeny">PeterThoeny</a>) </td>
->           </tr>
->           <tr>
->             <td align="right"> Local file: </td>
->             <td><input name="filename" type="hidden" value="Sample.txt" /> <input name="filepath" size="50" type="file" value="C:\DATA\Sample.txt" /></td>
->           </tr>
->           <tr>
->             <td align="right"> Comment: </td>
->             <td><input maxlength="50" name="filecomment" size="50" type="text" value="Just a sample" /></td>
->           </tr>
->           <tr>
->             <td align="right"> Link: </td>
->             <td><input name="createlink" type="checkbox" /> Create a link to the attached file at the end of the topic. </td>
->           </tr>
->           <tr>
->             <td align="right"> Hide file: </td>
->             <td><input name="hidefile" type="checkbox" /> Hide attachment in normal topic view. </td>
->           </tr>
->         </table><em>Help text ...</em><p> Topic <b>FileAttachment</b> . { </p><input type="submit" value="   Upload file   " /> | <input name="changeproperties" type="submit" value="Change properties" /> | <a href="http://www.dementia.org/twiki//rename/%WEB%/%TOPIC%?attachment=Sample.txt">Move attachment</a> | <a href="FileAttachment">Cancel</a> } </td>
+>         <div>
+>           <table>
+>             <tr>
+>               <th>Previous upload</th>
+>               <td><code>Sample.txt</code> <span>(<a href="http://visiblearea.com/devtwiki/bin/view/Main/TWikiContributor">TWikiContributor</a>)</span></td>
+>               <td>Select a new local file to update this attachment.</td>
+>             </tr>
+>             <tr>
+>               <th> Local file </th>
+>               <td><input name="filename" type="hidden" value="Sample.txt" /><input name="filepath" size="30" type="file" value="Sample.txt" /></td>
+>               <td> Upload up to 10000 KB. </td>
+>             </tr>
+>             <tr>
+>               <th> Comment </th>
+>               <td><input maxlength="256" name="filecomment" size="50" type="text" value="Just a sample" /></td>
+>               <td>
+>               </td>
+>             </tr>
+>             <tr>
+>               <th> Link </th>
+>               <td><input id="createlink" name="createlink" type="checkbox" /><label for="createlink">Create a link to the attached file</label>
+>               </td>
+>               <td> Images will be displayed, for other attachments a link will be created. </td>
+>             </tr>
+>             <tr>
+>               <th> Hide file </th>
+>               <td><input id="hidefile" name="hidefile" type="checkbox" /><label for="hidefile">Do not show attachment in table</label>
+>               </td>
+>               <td>Attachments will not be shown in topic view page.</td>
+>             </tr>
+>             <tr>
+>               <th>
+>               </th>
+>               <td colspan="2"><input name="changeproperties" type="submit" value="Change properties only" /></td>
+>             </tr>
+>           </table>
+>         </div>
+>       </td>
 >     </tr>
 >   </table>
 > </form>
@@ -226,3 +212,6 @@ Clicking on a <code>**Manage**</code> link takes you to a new page that looks li
 ## <a name="Known Issues"></a> Known Issues
 
 - Unlike topics, attachments are not locked during editing. As a workaround, you can change the comment to indicate an attachment file is being worked on - the comment on the specific version isn't lost, it's there when you list all versions of the attachment.
+- Attachments are not secured. Anyone can read them if they know the name of the web, topic and attachment.
+
+**_Related Topics:_** [[UserDocumentationCategory]]
index e71a12a..8ceec42 100644 (file)
@@ -1,3 +1,3 @@
-Each [[FileAttachment]] in a Topic has an attribute string. At present only only the hidden attribute is supported. If the attribute includes _h_ then the attachment is considered to be hidden. It is not listed in the topic, but is displayed when attach page is displayed.
+Each [[FileAttachment]] in a Topic has an attribute string. At present only the hidden attribute is supported. If the attribute includes _h_ then the attachment is considered to be hidden. It is not listed in the topic, but is displayed when attach page is displayed.
 
--- TWiki:Main.JohnTalintyre - 30 Aug 2001
+**_Related Topics:_** [[UserDocumentationCategory]], [[DeveloperDocumentationCategory]]
diff --git a/TWiki/ForceNewRevision.mdwn b/TWiki/ForceNewRevision.mdwn
new file mode 100644 (file)
index 0000000..975241b
--- /dev/null
@@ -0,0 +1,9 @@
+Normally, if you make subsequent edits within a one hour period (configuration item `ReplaceIfEditedAgainWithin`), %WIKITOOLNAME% will fold together your changes. This is often the "right thing to do", as it can reduce the visual clutter of diffs.
+
+The "Force New Revision" checkbox is a way to force it to create a separate revision each time you save.
+
+The [[TWiki.TWikiPreferences|TWiki/TWikiPreferences]] variable `FORCENEWREVISIONCHECKBOX` controls whether this is checked by default or not.
+
+On a related note, you can force **_every_** save to be a new revision number by setting `ReplaceIfEditedAgainWithin` to 0.
+
+**_Related Topics:_** [[UserDocumentationCategory]], [[AdminDocumentationCategory]]
index 9fef989..4cab16e 100644 (file)
@@ -1,6 +1,6 @@
 <div>
   <ul>
-    <li><a href="#TWiki Formatted Search Results"> TWiki Formatted Search Results</a><ul>
+    <li><a href="#TWiki Formatted Search"> TWiki Formatted Search</a><ul>
         <li><a href="#Syntax"> Syntax</a></li>
         <li><a href="#Examples"> Examples</a><ul>
             <li><a href="#Bullet list showing topic name a"> Bullet list showing topic name and summary</a></li>
   </ul>
 </div>
 
-# <a name="TWiki Formatted Search Results"></a> TWiki Formatted Search Results
+# <a name="TWiki Formatted Search"></a> TWiki Formatted Search
 
 _Inline search feature allows flexible formatting of search result_
 
-The <code>[[%SEARCH{...}%|Main/TWikiVariables#VarSEARCH]]</code> variable documented in [[TWikiVariables]] has a fixed format for the search result, that is, a table consisting of topic names and topic summaries. Use the `format="..."` parameter to specify a customized format of the search result. The string of the format parameter is typically a bullet list or table row containing variables (such as `%SEARCH{ "food" format="| $topic | $summary |" }%`).
+The default output format of a <code>[[%SEARCH{...}%|Main/TWikiVariables#VarSEARCH]]</code> is a table consisting of topic names and topic summaries. Use the `format="..."` parameter to customize the search result. The format parameter typically defines a bullet or a table row containing variables, such as `%SEARCH{ "food" format="| $topic | $summary |" }%`.
 
 ## <a name="Syntax"></a> Syntax
 
@@ -116,15 +116,15 @@ Variables that can be used in the format string:
   </tr>
   <tr>
     <td><code>$date</code></td>
-    <td> Time stamp of last topic update, e.g. <code>29 Jun 2010 - 15:46</code></td>
+    <td> Time stamp of last topic update, e.g. <code>29 Jun 2010 - 15:56</code></td>
   </tr>
   <tr>
     <td><code>$isodate</code></td>
-    <td> Time stamp of last topic update, e.g. <code>2010-06-29T15:46Z</code></td>
+    <td> Time stamp of last topic update, e.g. <code>2010-06-29T15:56Z</code></td>
   </tr>
   <tr>
     <td><code>$rev</code></td>
-    <td> Number of last topic revision, e.g. <code>1.4</code></td>
+    <td> Number of last topic revision, e.g. <code>4</code></td>
   </tr>
   <tr>
     <td><code>$username</code></td>
@@ -140,23 +140,43 @@ Variables that can be used in the format string:
   </tr>
   <tr>
     <td><code>$createdate</code></td>
-    <td> Time stamp of topic revision 1.1 </td>
+    <td> Time stamp of topic revision 1 </td>
   </tr>
   <tr>
     <td><code>$createusername</code></td>
-    <td> Login name of topic revision 1.1, e.g. <code>jsmith</code></td>
+    <td> Login name of topic revision 1, e.g. <code>jsmith</code></td>
   </tr>
   <tr>
     <td><code>$createwikiname</code></td>
-    <td> Wiki user name of topic revision 1.1, e.g. <code>JohnSmith</code></td>
+    <td> Wiki user name of topic revision 1, e.g. <code>JohnSmith</code></td>
   </tr>
   <tr>
     <td><code>$createwikiusername</code></td>
-    <td> Wiki user name of topic revision 1.1, e.g. <code>Main.JohnSmith</code></td>
+    <td> Wiki user name of topic revision 1, e.g. <code>Main.JohnSmith</code></td>
   </tr>
   <tr>
     <td><code>$summary</code></td>
-    <td> Topic summary </td>
+    <td> Topic summary, just the plain text, all formatting and line breaks removed; up to 162 characters </td>
+  </tr>
+  <tr>
+    <td><code>$summary(50)</code></td>
+    <td> Topic summary, up to 50 characters shown </td>
+  </tr>
+  <tr>
+    <td><code>$summary(showvarnames)</code></td>
+    <td> Topic summary, with <code>%ALLTWIKI{...}%</code> variables shown as <code>ALLTWIKI{...}</code></td>
+  </tr>
+  <tr>
+    <td><code>$summary(noheader)</code></td>
+    <td> Topic summary, with leading <code>---+ headers</code> removed%BR% <strong><em>Note:</em></strong> The tokens can be combined, for example <code>$summary(100, showvarnames, noheader)</code></td>
+  </tr>
+  <tr>
+    <td><code>$changes</code></td>
+    <td> Summary of changes between latest rev and previous rev </td>
+  </tr>
+  <tr>
+    <td><code>$changes(n)</code></td>
+    <td> Summary of changes between latest rev and rev n </td>
   </tr>
   <tr>
     <td><code>$formname</code></td>
@@ -180,11 +200,15 @@ Variables that can be used in the format string:
   </tr>
   <tr>
     <td><code>$pattern(reg-exp)</code></td>
-    <td> A regular expression pattern to extract some text from a topic (does not search meta data; use <code>$formfield</code> instead). In case of a <code>multiple="on"</code> search, the pattern is applied to the line found in each search hit.%BB% Specify a [[Main/RegularExpression]] that covers the whole text (topic or line), which typically starts with <code>.*</code>, and must end in <code>.*</code> %BB% Put text you want to keep in parenthesis, like <code>$pattern(.*?(from here.*?to here).*)</code> %BB% Example: <code>$pattern(.*?\*.*?Email\:\s*([^\n\r]+).*)</code> extracts the email address from a bullet of format <code>* Email: ...</code> %BB% This example has non-greedy <code>.*?</code> patterns to scan for the first occurance of the Email bullet; use greedy <code>.*</code> patterns to scan for the last occurance %BB% Limitation: Do not use <code>.*)</code> inside the pattern, e.g. <code>$pattern(.*foo(.*)bar.*)</code> does not work, but <code>$pattern(.*foo(.*?)bar.*)</code> does %BB% Note: Make sure that the integrity of a web page is not compromised; for example, if you include an HTML table make sure to include everything including the table end tag </td>
+    <td> A regular expression pattern to extract some text from a topic (does not search meta data; use <code>$formfield</code> instead). In case of a <code>multiple="on"</code> search, the pattern is applied to the line found in each search hit.%BB% Specify a [[Main/RegularExpression]] that covers the whole text (topic or line), which typically starts with <code>.*</code>, and must end in <code>.*</code> %BB% Put text you want to keep in parenthesis, like <code>$pattern(.*?(from here.*?to here).*)</code> %BB% Example: <code>$pattern(.*?\*.*?Email\:\s*([^\n\r]+).*)</code> extracts the e-mail address from a bullet of format <code>* Email: ...</code> %BB% This example has non-greedy <code>.*?</code> patterns to scan for the first occurance of the Email bullet; use greedy <code>.*</code> patterns to scan for the last occurance %BB% Limitation: Do not use <code>.*)</code> inside the pattern, e.g. <code>$pattern(.*foo(.*)bar.*)</code> does not work, but <code>$pattern(.*foo(.*?)bar.*)</code> does %BB% Note: Make sure that the integrity of a web page is not compromised; for example, if you include an HTML table make sure to include everything including the table end tag </td>
+  </tr>
+  <tr>
+    <td><code>$count(reg-exp)</code></td>
+    <td> Count of number of times a regular expression pattern appears in the text of a topic (does not search meta data). Follows guidelines for use and limitations outlined above under <code>$pattern(reg-exp)</code>. Example: <code>$count(.*?(---[+][+][+][+]) .*)</code> counts the number of &lt;H4&gt; headers in a page. </td>
   </tr>
   <tr>
     <td><code>$n</code> or <code>$n()</code></td>
-    <td> New line </td>
+    <td> New line. Use <code>$n()</code> if followed by alphanumeric character, e.g. write <code>Foo$n()Bar</code> instead of <code>Foo$nBar</code></td>
   </tr>
   <tr>
     <td><code>$nop</code> or <code>$nop()</code></td>
@@ -235,13 +259,13 @@ To get this:
     <th bgcolor="#99CCCC"><strong>OsVersion:</strong></th>
   </tr>
   <tr>
-    <td><a href="http://www.dementia.org/twiki//view/Sandbox/IncorrectDllVersionW32PTH10DLL">IncorrectDllVersionW32PTH10DLL</a></td>
-    <td><a href="http://www.dementia.org/twiki//view/Sandbox/OsWin">OsWin</a></td>
+    <td>[[Sandbox/IncorrectDllVersionW32PTH10DLL]]</td>
+    <td>[[Sandbox/OsWin]]</td>
     <td> 95/98 </td>
   </tr>
   <tr>
-    <td><a href="http://www.dementia.org/twiki//view/Sandbox/WinDoze95Crash">WinDoze95Crash</a></td>
-    <td><a href="http://www.dementia.org/twiki//view/Sandbox/OsWin">OsWin</a></td>
+    <td>[[Sandbox/WinDoze95Crash]]</td>
+    <td>[[Sandbox/OsWin]]</td>
     <td> 95 </td>
   </tr>
 </table>
@@ -331,17 +355,16 @@ Use an HTML form and an embedded formatted search on the same topic. You can lin
 
 **Write this:**
 
-    <form action="%SCRIPTURLPATH%/view%SCRIPTSUFFIX%/%WEB%/%TOPIC%">
+    <form action="%SCRIPTURLPATH{"view"}%/%WEB%/%TOPIC%">
     Find Topics:
-    <input type="text" name="q" size="32" value="%URLPARAM{"q"}%" />
-    <input type="submit" value="Search" />
+    <input type="text" name="q" size="32" value="%URLPARAM{"q"}%" />&nbsp;<input type="submit" class="twikiSubmit" value="Search" />
     </form>
     Result:
     %SEARCH{ search="%URLPARAM{"q"}%" format="   * $web.$topic: %BR% $summary" nosearch="on" }%
 
 **To get this:**
 
-<form action="http://www.dementia.org/twiki//view/%WEB%/%TOPIC%"> Find Topics: <input name="q" size="32" type="text" value="" /> <input type="submit" value="Search" /></form>
+<form action="http://www.dementia.org/twiki/view/%WEB%/%TOPIC%"> Find Topics: <input name="q" size="32" type="text" value="" /> <input type="submit" value="Search" /></form>
 
 Result:
 
@@ -349,4 +372,4 @@ Result:
 
 Incorrect format of searchformat template (missing sections? There should be 4 %SPLIT% tags)
 
--- TWiki:Main.PeterThoeny - 26 Jul 2004
+**_Related Topics:_** [[UserDocumentationCategory]]
index e10e100..175d916 100644 (file)
@@ -10,8 +10,6 @@ TWiki is distributed under the GNU General Public License, see [[TWikiDownload]]
 - 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>
 
-Please note that TWiki is not distributed under the LGPL (Lesser General Public Licence), which implies TWiki can only be used with software that is licensed under conditions compliant with the GPL. Embedding in proprietary software requires an alternative license. Contact the author for details.
-
 **_Back to:_** [[TWikiFAQ]]
 
--- TWiki:Main.PeterThoeny - 27 Nov 2000
+**_Related Topics:_** [[UserDocumentationCategory]]
index 2300290..b40514c 100644 (file)
@@ -1,6 +1,6 @@
 # <a name="Go Box"></a> Go Box
 
-The box at the top or sidebar of each page.
+The box at the top or sidebar of each page, also called Jump box.
 
 Enter a topic name to quickly jump to the topic, for example:
 
@@ -17,4 +17,4 @@ Incorrect format of searchformat template (missing sections? There should be 4 %
 
 **_Note:_** The Go box is not a search box
 
--- TWiki:Main.PeterThoeny - 15 Aug 2004
+**_Related Topics:_** [[UserDocumentationCategory]]
index 78ca620..0771d4b 100644 (file)
@@ -35,4 +35,4 @@
 
 - **TIP:** Check the source when you want to find out how something is formatted: click <code>**Edit**</code> on the lower toolbar. To see earlier versions, click <code>**More**</code>, then check <code>**Raw text format**</code> and click <code>**View revision**</code>. A bit of HTML experience can't hurt, but you'll soon see with [[TWikiShorthand]] how far that is from necessary.
 
--- TWiki:Main.MikeMannix - 01 Dec 2001 %BR% -- TWiki:Main.PeterThoeny - 13 Mar 2004
+**_Related Topics:_** [[UserDocumentationCategory]]
index 74ff127..bcebb60 100644 (file)
@@ -6,4 +6,4 @@ You can hide/unhide file attachments.
 - enable the **Hide file** checkbox,
 - then click **Change properties**
 
--- [[PeterThoeny]] - 13 Nov 2001
+**_Related Topics:_** [[UserDocumentationCategory]]
diff --git a/TWiki/IfStatements.mdwn b/TWiki/IfStatements.mdwn
new file mode 100644 (file)
index 0000000..ee4814b
--- /dev/null
@@ -0,0 +1,179 @@
+The `%IF%` construct gives TWiki the power to include content in topics based on the value of simple expressions.
+
+`%IF{"CONDITION" then="THEN" else="ELSE"}%`
+
+In the example above, if CONDITION evaluates to TRUE, then THEN will be included in the topic; otherwise ELSE will be included.
+
+What can be included in the THEN and ELSE parameters is obviously limited by standard TWiki syntax for parameters. The best way to use this feature is to define two [[TWikiVariables]], one for the THEN case and the other for the ELSE case. For example:
+
+    <!--
+       * Set LI = Fred is here!
+       * Set LO = Fred is there!
+    -->
+    %IF{"context authenticated and defined WIKINAME and $ WIKINAME='FredBloggs'" then="%LI%" else="%LO%"}%
+
+The basic syntax of a condition is as follows:
+
+    expr ::= '(' expr ')' ;
+    expr ::= andexpr | andexpr 'or' expr ;
+    andexpr ::= notexpr | notexpr 'and' andexpr ;
+    notexpr ::= basexpr | 'not' baseexpr ;
+    basexpr ::= atom | uop atom | atom bop basexpr ;
+    uop ::= 'context' | 'defined' | '$' ;
+    bop ::= '=' | '!=' | '>' | '<' | '>=' | '<=' ;
+    atom ::= context identifier, TWiki variable name, single-quoted string
+<table border="1" cellpadding="0" cellspacing="0">
+  <tr>
+    <th bgcolor="#99CCCC" colspan="2"><strong> Operators </strong></th>
+  </tr>
+  <tr>
+    <td> and </td>
+    <td> True if both sides are true </td>
+  </tr>
+  <tr>
+    <td> or </td>
+    <td> True if one or other side is true </td>
+  </tr>
+  <tr>
+    <td> not </td>
+    <td> negate the following expression </td>
+  </tr>
+  <tr>
+    <td> =, != </td>
+    <td> String comparison </td>
+  </tr>
+  <tr>
+    <td> &lt;, &gt;, &lt;=, &gt;= </td>
+    <td> Number comparison (there is no explicit numeric =) </td>
+  </tr>
+  <tr>
+    <td> context </td>
+    <td> True if the current context is set (see below) </td>
+  </tr>
+  <tr>
+    <td> defined </td>
+    <td> True if a preference variable or url parameter of this name is defined. </td>
+  </tr>
+  <tr>
+    <td> $ </td>
+    <td> expands a URL parameter or [[Main/TWikiVariables]]. Plugin handlers <strong>are not called</strong>. Built-in variables and user-defined preferences are supported. You can pass a limited subset of parameters to TWiki variables by enclosing the variable name in single quotes; for example, <code>$ 'VARIABLE{value}'</code>. The quoted string may <strong>not</strong> contain quotes (' or "). </td>
+  </tr>
+</table>
+
+examples:
+
+    %IF{"defined WIKINAME" then="WIKINAME is defined" else="WIKINAME is not defined"}%
+
+    You are %IF{ "$ WIKINAME='TWikiGuest' and not defined OPEN_DAY" then="not" }% allowed to
+    %IF{ "context view" then="view" else="edit"}% this TWiki today.
+
+    %IF{ "defined search" then="Search: %URLPARAM{search}%" else="No search passed in"}%
+
+    url param t is %IF{ "0 < $ t and $ t < 1000" then="in" else="out of"}% range.
+
+    %IF{ "$'URLPARAM{scope}'='text'" then="Plain text search" }%
+
+Given
+
+- Set OPEN\_DAY = yes
+
+this expands to:
+
+You are allowed to edit this TWiki today.
+
+Context identifiers are used in TWiki to label various stages of the rendering process. They are especially useful for [[skin|Main/TWikiSkins]] authors to find out where they are in the rendering process. The following context identifiers are available:
+
+<table border="1" cellpadding="0" cellspacing="0">
+  <tr>
+    <th bgcolor="#99CCCC"><strong> id </strong></th>
+    <th bgcolor="#99CCCC"><strong> context </strong></th>
+  </tr>
+  <tr>
+    <td> absolute_urls </td>
+    <td> Set if absolute URLs are required </td>
+  </tr>
+  <tr>
+    <td> authenticated </td>
+    <td> a user is authenticated </td>
+  </tr>
+  <tr>
+    <td> body_text </td>
+    <td> when the body text is being processed in a view (useful in plugin handlers) </td>
+  </tr>
+  <tr>
+    <td> can_login </td>
+    <td> current environment supports login </td>
+  </tr>
+  <tr>
+    <td> changes </td>
+    <td> in changes script (see [[Main/TWikiScripts]]) </td>
+  </tr>
+  <tr>
+    <td> command_line </td>
+    <td> the running script was run from the command line, and not from CGI </td>
+  </tr>
+  <tr>
+    <td> diff </td>
+    <td> in rdiff script (see [[Main/TWikiScripts]]) </td>
+  </tr>
+  <tr>
+    <td> edit </td>
+    <td> in edit script (see [[Main/TWikiScripts]]) </td>
+  </tr>
+  <tr>
+    <td> footer_text </td>
+    <td> when the footer text is being processed in a view (useful in plugin handlers) </td>
+  </tr>
+  <tr>
+    <td> header_text </td>
+    <td> when the header text is being processed in a view (useful in plugin handlers) </td>
+  </tr>
+  <tr>
+    <td> i18n_enabled </td>
+    <td> when user interface [[Main/I18N]] support is enabled (i.e., user can choose the language for UI) </td>
+  </tr>
+  <tr>
+    <td> inactive </td>
+    <td> if active links such as 'edit' and 'attach' should be disabled </td>
+  </tr>
+  <tr>
+    <td> mirror </td>
+    <td> if this is a mirror </td>
+  </tr>
+  <tr>
+    <td> new_topic </td>
+    <td> if the topic doesn't already exist </td>
+  </tr>
+  <tr>
+    <td> oops </td>
+    <td> in oops script (see [[Main/TWikiScripts]]) </td>
+  </tr>
+  <tr>
+    <td> preview </td>
+    <td> in preview script (see [[Main/TWikiScripts]]) </td>
+  </tr>
+  <tr>
+    <td> rss </td>
+    <td> if this is an RSS skin rendering </td>
+  </tr>
+  <tr>
+    <td> save </td>
+    <td> in save script (see [[Main/TWikiScripts]]) </td>
+  </tr>
+  <tr>
+    <td> search </td>
+    <td> in search script (see [[Main/TWikiScripts]]) </td>
+  </tr>
+  <tr>
+    <td> view </td>
+    <td> in view script (see [[Main/TWikiScripts]]) </td>
+  </tr>
+  <tr>
+    <td> rest </td>
+    <td> in rest script (see [[Main/TWikiScripts]]) </td>
+  </tr>
+</table>
+
+In addition there is an identifier for each enabled plugin; for example, if `GallousBreeksPlugin` is installed **and enabled**, then the context ID `GallousBreeksPluginEnabled` will be set.
+
+The `%IF%` statement is deliberately kept simple. In particular, note that there is no way to conditionally execute a Set statement. If you need more sophisticated control over formatting, then consider using the [[SpreadSheetPlugin]].
index 01524f3..09fd0c0 100644 (file)
@@ -1,10 +1,10 @@
-# <a name="Include Topics and Web Pages Usi"></a><a name=" Include Topics and Web Pages Us"></a> Include Topics and Web Pages Using <code>**%INCLUDE\{...\}%**</code> Variable
+# <a name="Include Topics and Web Pages Usi"></a><a name=" Include Topics and Web Pages Us"></a> Include Topics and Web Pages Using `%INCLUDE{...}%` Variable
 
-Use the <code>**%INCLUDE\{...\}%**</code> variable to embed the content of another topic or web page inside a %WIKITOOLNAME% topic. The whole content or only parts of a page can be included. If needed, set a proxy server in [[TWikiPreferences]].
+Use the `%INCLUDE{...}%` variable to embed the content of another topic or web page inside a TWiki topic. The whole content or only parts of a page can be included. If needed, set a proxy server in [[TWikiPreferences]].
 
 <div>
   <ul>
-    <li><a href="#Syntax"> Syntax</a></li>
+    <li><a href="#Syntax Example"> Syntax Example</a></li>
     <li><a href="#Usage Examples"> Usage Examples</a><ul>
         <li><a href="#1. Display regression test resul"> 1. Display regression test results in a TWiki page</a></li>
         <li><a href="#2. Display Google's robot.txt fi"> 2. Display Google's robot.txt file</a></li>
@@ -14,20 +14,15 @@ Use the <code>**%INCLUDE\{...\}%**</code> variable to embed the content of anoth
   </ul>
 </div>
 
-## <a name="Syntax"></a> Syntax
+## <a name="Syntax Example"></a> Syntax Example
 
-<code>**%INCLUDE\{ "page" pattern="reg-exp" rev="1.2" \}%**</code>
+`%INCLUDE{ "page" pattern="reg-exp" rev="2" warn="off" section="clients" }%`
 
-- <code>**"page"**</code>: %BR% The nameless parameter specifies the page to include. It is
-  - The name of a topic located in the current web, e.g., <code>**%INCLUDE\{"WebNotify"\}%**</code>
-  - A `Web.Topic` name specifying a topic in another web, e.g., <code>**%INCLUDE\{"TWiki.SiteMap"\}%**</code>
-  - A full qualified URL with <code>**http**</code> protocol, domain name and optional port number, e.g., <code>**%INCLUDE\{"http://twiki.org:80/index.html"\}%**</code>. Supported content types are <code>**text/html**</code> and <code>**text/plain**</code>. The full page is included by default, but the HTML header and scripts are stripped in case it is a web page.
+The `pattern` parameter is optional and allows you to extract some parts of a web page. Specify a [[RegularExpression]] that scans from start (`'^'`) to end and contains the text you want to keep in parenthesis, e.g., `pattern="^.*?(from here.*?to here).*"`. You need to make sure that the integrity of a web page is not compromised; for example, if you include a table, make sure to include everything including the table end tag.
 
-- <code>**pattern="reg-exp"**</code>: %BR% The **pattern** parameter is optional and allows you to extract some parts of a web page. Specify a [[RegularExpression]] that scans from start (`'^'`) to end and contains the text you want to keep in parenthesis, e.g., <code>**pattern="^.\*?(from here.\*?to here).\*"**</code>. You need to make sure that the integrity of a web page is not compromised; for example, if you include a table, make sure to include everything including the table end tag.
+[[TWikiVariables#VarINCLUDE]] explains the other parameters.
 
-- <code>**rev="1.x"**</code>: %BR% The **rev** parameter is optional and allows you to include an earlier revision of a topic. This can be used to include an official version of a topic, e.g. one that has been signed of by management. This parameter does not apply to URLs.
-
-**_Note:_** All text of a topic is included unless you specify <code>**%STARTINCLUDE%**</code>, <code>**%STOPINCLUDE%**</code> and/or a **pattern** parameter. A pattern will only search between <code>**%STARTINCLUDE%**</code> and <code>**%STOPINCLUDE%**</code>.
+**_Note:_** All text of a topic is included unless it contains a `%STARTINCLUDE%` and `%STOPINCLUDE%`, or you specify a `section` parameter and/or a `pattern` parameter. A pattern will only search between `%STARTINCLUDE%` and `%STOPINCLUDE%`.
 
 ## <a name="Usage Examples"></a> Usage Examples
 
@@ -39,8 +34,7 @@ Use the <code>**%INCLUDE\{...\}%**</code> variable to embed the content of anoth
 
 ### <a name="2. Display Google&#39;s robot.txt fi"></a> 2. Display Google's robot.txt file
 
-- You type:
-  - <code>**%INCLUDE\{"http://www.google.com/robots.txt"\}%**</code>
+      %INCLUDE{"http://www.google.com/robots.txt"}%
 
 ### <a name="3. Display the current time in T"></a> 3. Display the current time in Tokyo in a TWiki page
 
@@ -49,6 +43,4 @@ Use the <code>**%INCLUDE\{...\}%**</code> variable to embed the content of anoth
 - You get:
   - Tokyo:
 
-See also other [[TWikiVariables]].
-
--- TWiki:Main.PeterThoeny - 15 Aug 2004
+**_Related Topics:_** [[TWikiVariables#VarINCLUDE]], [[UserDocumentationCategory]]
index c7b0b56..795bbd3 100644 (file)
@@ -1,6 +1,6 @@
 # <a name="Installed Plugins"></a> Installed Plugins
 
-Plugins are mainly user-contributed add-ons that enhance and extend TWiki features and capabilities. A limited number of plugins are included in the core TWiki distribution - and most those can be removed - while the rest are optional, available from TWiki:Plugins/WebHome.
+Plugins are mainly user-contributed add-ons that enhance and extend TWiki features and capabilities. A limited number of plugins are included in the core TWiki distribution - and any those can be removed - while the rest are optional, available from TWiki:Plugins.PluginPackage.
 
 Here is a list of the plugins currently installed and enabled on this TWiki site:
 
@@ -14,6 +14,14 @@ Here is a list of the plugins currently installed and enabled on this TWiki site
 - [[TablePlugin]] <span>(1.020, 12339)</span>:
 - [[TwistyPlugin]] <span>(1.2.0, $Rev: 12154$)</span>:
 
+Administrators can enable and disable plugins using [<img src="http://www.dementia.org/twiki//view/Main/WebHome/wrench.gif" width="16" height="16" alt="wrench" /> configure](http://www.dementia.org/twiki/configure).
+
+## <a name="Contrib Modules"></a> Contrib Modules
+
+# <a name="TWiki Installation Error"></a> TWiki Installation Error
+
+Incorrect format of searchformat template (missing sections? There should be 4 %SPLIT% tags)
+
 # <a name="Plugin Diagnostics"></a> Plugin Diagnostics
 
 <table border="1">
@@ -111,6 +119,4 @@ Plugins: could not fully register TwistyPlugin, no plugin topic
 
 **_Note:_** The diagnostics are provided by the `%FAILEDPLUGINS%` variable
 
-**_Related Topics:_** [[TWikiPlugins]], [[TWikiPreferences]]
-
--- TWiki:Main.MikeMannix - 12 May 2002 %BR% -- TWiki:Main.PeterThoeny - 18 May 2004
+**_Related Topics:_** [[TWikiPlugins]], [[TWikiPreferences]], [[AdminDocumentationCategory]], [[AdminToolsCategory]]
index b89a5fd..0173965 100644 (file)
@@ -1,19 +1,19 @@
 # <a name="Instant TWiki Site Enhancements"></a><a name=" Instant TWiki Site Enhancements"></a> Instant TWiki Site Enhancements
 
-These quick enhancements are aimed at improving TWiki's ease-of-use. New TWiki site administrators are especially encouraged to review this document for ideas before deploying a new [[TWikiSite]]. The metaphor of building a house is useful. The listed enhancements are some of the details possible when moving into a new office or home. These small changes can make a **big** differences for user satisfaction at your site. All modifications can be done through your Web browser, and they don't take more then in a couple of minutes. No system administration expertise is required. Some of these enhancements are also mentioned in the reference manual and other topics.
+These quick enhancements are aimed at improving and customising your TWiki. New TWiki site administrators are especially encouraged to review this document for ideas before deploying a new [[TWikiSite]]. The metaphor of building a house is useful. The listed enhancements are some of the details possible when moving into a new office or home. These small changes can make a **big** differences for user satisfaction at your site. All modifications can be done through your Web browser, and they don't take more then in a couple of minutes. No system administration expertise is required. Some of these enhancements are also mentioned in the reference manual and other topics.
 
 Many of these tips are based on setting some special [[TWikiVariables]].
 
-%S% We recommend implementing at least **_some_** of these enhancements **_right after installation_**, to get a taste for what is possible. Some of these tips and enhancements _should_ be implemented before or during initial roll-out.
+%S% We recommend implementing at least **_some_** of these enhancements **_right after installation_** to get a taste for what is possible. Some of these tips and enhancements _should_ be implemented before or during initial roll-out.
 
-This may spark your imagination to **really** customize your site so that it's optimal for **your** users. Slightly more advanced customization tips are listed in [[TWikiAdminCookBook]].
+This may spark your imagination to **really** customize your site so that it's optimal for **your** users. Slightly more advanced customization tips are listed in TWiki:TWiki.TWikiAdminCookBook.
 
 <div>
   <ul>
-    <li><a href="#Tips using _TWikiVariables"> Tips using TWikiVariables</a><ul>
+    <li><a href="#Tips using TWiki Variables"> Tips using TWiki Variables</a><ul>
         <li><a href="#Change Colors of Page Header/Foo"> Change Colors of Page Header/Footer</a></li>
         <li><a href="#Set Page Background Color"> Set Page Background Color </a></li>
-        <li><a href="#Titles-Only Topic List - _WebTop"> Titles-Only Topic List - WebTopicList</a></li>
+        <li><a href="#Titles-Only Topic List - _WebTo"> Titles-Only Topic List - WebTopicList</a></li>
         <li><a href="#Simple way to create %RED% color"> Simple way to create %RED% colored text %ENDCOLOR% and graphics</a></li>
         <li><a href="#EZ Graphic Icons to Highlight Te"> EZ Graphic Icons to Highlight Text</a></li>
         <li><a href="#Use TOC variable to create table"> Use TOC variable to create table of content</a></li>
@@ -29,17 +29,18 @@ This may spark your imagination to **really** customize your site so that it's o
       </ul>
     </li>
     <li><a href="#Hidden Edit Lock for Individual"> Hidden Edit Lock for Individual Topics</a></li>
-    <li><a href="#Change the Default Site Logo"> Change the Default Site Logo</a></li>
+    <li><a href="#Change the Default Logo"> Change the Default Logo</a></li>
     <li><a href="#Customize Topic Classification F"> Customize Topic Classification Forms</a></li>
     <li><a href="#Add Your Favorite _JavaScript Fe"> Add Your Favorite JavaScript Features</a></li>
+    <li><a href="#Customize The Left Navigation Ba"> Customize The Left Navigation Bar</a></li>
   </ul>
 </div>
 
 ----
 
-## <a name="Tips using _TWikiVariables"></a> Tips using [[TWikiVariables]]
+## <a name="Tips using TWiki Variables"></a> Tips using TWiki Variables
 
-You need to know what is the variable name, and in what page is/should be defined.
+[[TWikiVariables]] are a great resource to customize your site. You need to know the variable name and decide where to put it.
 
 ### <a name="Change Colors of Page Header/Foo"></a> Change Colors of Page Header/Footer
 
@@ -60,11 +61,11 @@ It's just as easy to refine later on, so you're not locked in, just looking bett
 
 ### <a name="Set Page Background Color"></a> Set Page Background Color
 
-Without getting into the [[TWikiTemplates]] system yet, you can easily edit the <code>**view.tmpl**</code> (in the `templates` directory). In the HTML at the top, the body tag has the page background hardcoded to white <code>**bgcolor="#ffffff"**</code>. You can change that color value to new variable. First, define a new preferences variable in the site-level [[TWikiPreferences]], e.g. `* Set =PAGEBGCOLOR = #d0d0d0`, then edit the <code>**view.tmpl**</code> template file and change <code>**bgcolor="#ffffff"**</code> to <code>**bgcolor="%PAGEBGCOLOR%"**</code>. If you want you can set the page background color individualy per web, simple add a `* Set =PAGEBGCOLOR = #d0d0d0` bullet to the [[WebPreferences]] to overload the site-level preferences. (Without font color control, you'll have to stick to light colors.
+Without getting into the [[TWikiTemplates]] system yet, you can easily edit the <code>**view.tmpl**</code> (in the `templates` directory). In the HTML at the top, the body tag has the page background hardcoded to white <code>**bgcolor="#ffffff"**</code>. You can change that color value to new variable. First, define a new preferences variable in the site-level [[Main.TWikiPreferences|Main/TWikiPreferences]], e.g. `* Set =PAGEBGCOLOR = #d0d0d0`, then edit the <code>**view.tmpl**</code> template file and change <code>**bgcolor="#ffffff"**</code> to <code>**bgcolor="%PAGEBGCOLOR%"**</code>. If you want, you can set the page background color individually per web, simple add a `* Set =PAGEBGCOLOR = #d0d0d0` bullet to the [[WebPreferences]] to overload the site-level preferences. (Without font color control, you'll have to stick to light colors.)
 
-### <a name="Titles-Only Topic List - _WebTop"></a> Titles-Only Topic List - [[WebTopicList]]
+### <a name="Titles-Only Topic List - _WebTop"></a> Titles-Only Topic List - WebTopicList
 
-**_A good first navigation tool for new users,_** a fast-loading linked list (page titles only) of a web's topics is a quick and easy way see what's available. By default, slower, but more powerfull [[WebIndex]] is used.
+[[WebTopicList]] is a **_good first navigation tool for new users,_** a fast-loading linked list (page titles only) of a web's topics is a quick and easy way see what's available. By default, slower, but more powerful [[WebIndex]] is used.
 
 Without explaining what WEBTOPICLIST is, just try it:
 
@@ -77,25 +78,33 @@ This should be enabled, see the "Miscellaneous Settings" in the [[TWikiPreferenc
 
 ### <a name="EZ Graphic Icons to Highlight Te"></a> EZ Graphic Icons to Highlight Text
 
-Graphics in text (like this: %X%) is done also by defining special variables. See [[TWiki.TWikiPreferences|TWiki/TWikiPreferences]]. Some may prefer longer names, like `HELP`, `WARN` etc. You can also add your own images, e.g. a `NEW`, or a `ASK` to ask question.
+Icons can do a lot to enhance scannability of topics. For instance, on **HELP** pages, most people tend to jump around looking for answers rather than reading through - icons help point out the most important bits.
 
-%T% Using graphic icons to highlight important text right from the start can seriously improve how well new users take to a TWiki site. A minimum set of two or three icons can make content much easier to follow, eye-catching, EXCITING. Research says, people tend not to read pages through, but scan them first - and graphics (used sparringly ;-) of course) can help them. On **HELP** pages, most people tend to jump around looking for answers rather than reading through - icons help point out the most important bits.
+[[TWikiDocGraphics]] has a whole collection of ready icon images. You can use these images in any topic by referring to their name. For example, TWikiDocGraphics has an image attachment called `days.gif`. To show this image in a topic, write `%ICON{"days"}%` to get <img src="http://www.dementia.org/twiki//view/Main/WebHome/days.gif" width="16" height="16" alt="days" />.
 
-**How to create your own set of icons:**
+**Creating image variables**
 
-1. Go to the <code>**Preferences**</code> topic: [[TWikiPreferences]] for site-wide use, or [[WebPreferences]] for use in one web only.
-2. <code>**Attach**</code> a graphic (the ones on this page are 16x16 pixels), then define a Preference Variable with a short but recognizable name.
+You may find it easier to write shorthand graphic notation. You can create your own image variables by defining them in a preference topic (most likely [[Main.TWikiPreferences|Main/TWikiPreferences]].)
+
+A variable name may be one letter, like `Y`, or may be longer like `HELP`, `WARN` etc. You can also add your own images, e.g. a `NEW`, or a `ASK` to ask question.
+
+For instance, if we want to write `%DOWN%` instead of `%ICON{"arrowbdown"}%`, define the new variable like this:
+
+       * Set DOWN = %ICON{"arrowbdown"}%
+
+Or if you have a custom image to use, attach this to [[Main.TWikiPreferences|Main/TWikiPreferences]] and write:
+
+       * Set DOWN = <img src="%ATTACHURL%/my_image.gif" border="0" alt="DOWN" width="16" height="16" />
+
+Most images in [[TWikiDocGraphics]] are 16 x 16 pixels.
 
-- **_Example:_** Enter `%TEST%` to get %TEST% - see how it's [[done|Main/WebPreferences#DefineIcon]].
-- %T% Ideas for quick icons: NEW; UPDATE; a STAR or other bullet; key symbols relating to your site content.
-- For documentation and help, this [[TWiki|TWiki/WebHome]] web uses three main icons: %H% for **HELP**, %T% for **TIP**, %X% for **IMPORTANT**.
 - **_Related:_** There are other approaches for creating more extensive TWiki icon libraries. This is a simply and quick way to get started. See [[TWikiDocGraphics]] for more info.
 
 ### <a name="Use TOC variable to create table"></a> Use TOC variable to create table of content
 
 TOC is Table-Of-Content, generated automagically from headers (defined like that: <code>**---++**</code> , see [[TWikiShorthand]]).
 
-For example, you may want to put all your custom variables in [[TWikiPreferences]] right on top of the page, and generate table of contens, like:
+For example, you may want to put all your custom variables in [[Main.TWikiPreferences|Main/TWikiPreferences]] right on top of the page, and generate table of contents, like:
 
 - Preferences for easy creating nice pages
   - Graphics icons in text
@@ -113,7 +122,7 @@ Non-admin users wil be interested only in first part, non-system preferences.
 
 ## <a name="Personal Productivity - Tools an"></a> Personal Productivity - Tools and Tips for Working Faster
 
-Although this area applies to all TWiki set-ups, the initial focus is on TWiki site managers working on a Linux/Apache TWiki site, from a Windows local PC. The assumption being: if you're working with Linux as your desktop, you're probably a programmer or system admin and have these basics handled!
+Although this area applies to all TWiki setups, the initial focus is on TWiki site managers working on a Linux/Apache TWiki site, from a Windows local PC. The assumption being: if you're working with Linux as your desktop, you're probably a programmer or system admin and have these basics handled!
 
 ### <a name="Use your favorite text editor fo"></a> Use your favorite text editor for major edits
 
@@ -125,7 +134,7 @@ When you have a fair bit of TWiki formatting work - for example, compiling new i
 
 **_Browser Integration:_** Some web browsers can be configured to automatically use an external editor. See your browser documentation for details. Such a configuration and a small tool for Linux is described in an example on TWiki.org. TWiki:Codev/EditDaemonWithGVimIntegration
 
-**_Alternate Browser:_** While your main browser might not have the features for TWikic topic editing, another one might.
+**_Alternate Browser:_** While your main browser might not have the features for TWiki topic editing, another one might.
 
 - An example on the Linux platform is the `w3m` pager/browser for Linux. This is a text based version similar to `lynx` but it includes text editor features and a configurable command set to act like `lynx` if you are more accustomed to it.
 
@@ -156,7 +165,7 @@ The SEARCH variable has many more formatting options, see [[TWikiVariables]].
 
 ### <a name="Recently changed pages"></a> Recently changed pages
 
-Here, last 15 is formatted into neat table.
+Here are the last 15 changed pages, formatted into a neat table.
 
     <table>
     %SEARCH{ "\.*" scope="topic" regex="on" nosearch="on" nototal="on" order="modified" reverse="on"  format="<tr><td>  [[$topic][$topic]] </td><td>  $wikiusername  </td><td> $date  </td></tr>" limit="15" }%
@@ -170,21 +179,26 @@ When you're creating main gateway pages, you may want to temporarily (or permane
 
 - **_Example:_** <code>**Set ALLOWTOPICCHANGE = Main.UserName, Main.GroupName**</code>
 - %T% **To hide the setting:** Use HTML comment tags - put <code>**&lt;!--**</code> on the line \_above the setting, and <code>**--&gt;**</code> on the line below.
-- _This is in the regular help files but worth highlighting._
 
 ----
 
-## <a name="Change the Default Site Logo"></a> Change the Default Site Logo
+## <a name="Change the Default Logo"></a> Change the Default Logo
+
+If you want to change the logo per TWiki web, simply attach a new logo.gif to the web's WebPreferences, and change the logo's filename by overriding the name using WEBLOGONAME in WebPreferences:
 
-If you want to change the default TWiki logo, attach a new graphic to a topic of choice and change the WIKILOGOIMG variable in the [[TWikiPreferences]], e.g.
+- `Set WEBLOGONAME = filename.gif`
 
-- `Set WIKILOGOIMG = %PUBURL%/TWiki/MyLogo/mylogo.gif`
+Other cusomtisations are possible using `WEBLOGOIMG`, `WEBLOGOURL`, and `WEBLOGOALT` (they mirror the `WIKILOGO*` TWiki variables, but are applied to each web, rather than to the %WIKITOOLNAME%-based references)
+
+If you'd like to have the same customised logo for all the webs, make these changes in [[TWikiPreferences]] instead of each web's WebPreferences, e.g.,
+
+- `Set WEBLOGOIMG = %PUBURLPATH%/TWiki/WebPreferences/mylogo.gif`
 
 ----
 
 ## <a name="Customize Topic Classification F"></a> Customize Topic Classification Forms
 
-With a simple one or two-line default topic form available for every topic - in **Edit** mode, click the <code>**[Add]**</code> button, and select the form if it isn't alredy enabled. Then, click the title to get to the actual form, <code>**[Edit]**</code>, and carefully change values, probably basic page classifications. You'll get some increased value, and hands-on experience with [[TWikiForms]], without having to read up about them first. %X% **_(add the corresponding search per category - copy a default and change)_**
+With a simple one or two-line default topic form available for every topic - in **Edit** mode, click the <code>**[Add]**</code> button, and select the form if it isn't already enabled. Then, click the title to get to the actual form, <code>**[Edit]**</code>, and carefully change values, probably basic page classifications. You'll get some increased value, and hands-on experience with [[TWikiForms]], without having to read up about them first. %X% **_(add the corresponding search per category - copy a default and change)_**
 
 ----
 
@@ -198,6 +212,14 @@ You're no doubt familiar or better with HTML, JS, and "webmastering". Without ge
 
 ----
 
+## <a name="Customize The Left Navigation Ba"></a> Customize The Left Navigation Bar
+
+Customize the contents of the [[WebLeftBar]] for each web to include important topics for that web, or to link to an important topic for the overall site. Each web has its own [[WebLeftBar]] page. (This is specific to the [[PatternSkin]].)
+
+----
+
 %T% **_NOTE:_** Feel free to add your own tips to TWiki:%WEB%.%TOPIC% as quick notes at the end of the list, following the existing format!
 
-**Contributors:** TWiki:Main.GrantBow, TWiki:Main.LynnwoodBrown, TWiki:Main.MikeMannix, TWiki:Main.PeterMasiar, TWiki:Main.PeterThoeny, TWiki:Main.MattWilkie
+**_Related Topics:_** [[AdminDocumentationCategory]]
+
+-- **_Contributors:_** TWiki:Main.GrantBow, TWiki:Main.LynnwoodBrown, TWiki:Main.MikeMannix, TWiki:Main.PeterMasiar, TWiki:Main.PeterThoeny, TWiki:Main.MattWilkie, TWiki:Main.AmandaSmith
index 0abe468..b3cd8d2 100644 (file)
@@ -25,6 +25,11 @@ Whenever you write <code>**ExternalSite:Page**</code> it will be linked automati
     <td> Look up '$page' on Acronym Finder site </td>
   </tr>
   <tr>
+    <td> CPAN </td>
+    <td><a href="http://search.cpan.org/perldoc" target="_top">http://search.cpan.org/perldoc</a>? </td>
+    <td> CPAN perl repository </td>
+  </tr>
+  <tr>
     <td> Dictionary </td>
     <td><a href="http://www.dictionary.com/cgi-bin/dict.pl?term=" target="_top">http://www.dictionary.com/cgi-bin/dict.pl?term=</a></td>
     <td> Look up '$page' at Dictionary.com </td>
@@ -45,6 +50,11 @@ Whenever you write <code>**ExternalSite:Page**</code> it will be linked automati
     <td> Book with ISBN#$page (One click patent? Say no to Amazon!) </td>
   </tr>
   <tr>
+    <td> News </td>
+    <td><a href="http://news.google.com/news?q=" target="_top">http://news.google.com/news?q=</a></td>
+    <td> Search for '$page' on Google news </td>
+  </tr>
+  <tr>
     <td> RFC </td>
     <td><a href="http://www.faqs.org/rfcs/rfc$page.html" target="_top">http://www.faqs.org/rfcs/rfc$page.html</a></td>
     <td> IETF RFC #$page </td>
@@ -70,6 +80,11 @@ Whenever you write <code>**ExternalSite:Page**</code> it will be linked automati
     <td> Search '$page' on the original 'WikiWikiWeb' site </td>
   </tr>
   <tr>
+    <td> DokuWiki </td>
+    <td><a href="http://wiki.splitbrain.org/wiki" target="_top">http://wiki.splitbrain.org/wiki</a>: </td>
+    <td> '$page' on Doku Wiki site </td>
+  </tr>
+  <tr>
     <td> DolphinWiki </td>
     <td><a href="http://www.object-arts.co.uk/wiki/html/Dolphin/$page.htm" target="_top">http://www.object-arts.co.uk/wiki/html/Dolphin/$page.htm</a></td>
     <td> '$page' on Dolphin Wiki site </td>
@@ -101,7 +116,7 @@ Whenever you write <code>**ExternalSite:Page**</code> it will be linked automati
   </tr>
   <tr>
     <td> MoinMoin </td>
-    <td><a href="http://moin.sourceforge.net/cgi-bin/moin/moin/" target="_top">http://moin.sourceforge.net/cgi-bin/moin/moin/</a></td>
+    <td><a href="http://moinmoin.wikiwikiweb.de/" target="_top">http://moinmoin.wikiwikiweb.de/</a></td>
     <td> '$page' on 'MoinMoin' Wiki site </td>
   </tr>
   <tr>
@@ -171,4 +186,6 @@ Whenever you write <code>**ExternalSite:Page**</code> it will be linked automati
   </tr>
 </table>
 
-**_Note:_** This topic is powered by the [[InterwikiPlugin]].
+**_Note:_** This topic configures the [[InterwikiPlugin]].
+
+**_Related Topics:_** [[TWikiPlugins]], [[UserDocumentationCategory]], [[AdminDocumentationCategory]]
index f96209a..3b9fe3f 100644 (file)
@@ -24,7 +24,7 @@ The %TOPIC% links <code>**ExternalSite:Page**</code> text to external sites base
 Plugin settings are stored as Preferences variables. To reference a plugin setting write <code>**%&lt;plugin&gt;\_&lt;setting&gt;%**</code>, for example, <code>**%INTERWIKIPLUGIN\_SHORTDESCRIPTION%**</code>
 
 - One-line description, shown in the [[TextFormattingRules]] topic:
-  - Set SHORTDESCRIPTION = Link <code>**ExternalSite:Page**</code> text to external sites based on aliases defined in the %WEB%.InterWikis topic
+  - Set SHORTDESCRIPTION = Link <code>**ExternalSite:Page**</code> text to external sites based on aliases defined in a rules topic
 
 - Link rules topic name: (default is [[InterWikis]])
   - Set RULESTOPIC =
@@ -32,9 +32,6 @@ Plugin settings are stored as Preferences variables. To reference a plugin setti
 - Suppress tooltip help for links: (<code>****</code> or <code>**1**</code>, default is <code>****</code>)
   - Set SUPPRESSTOOLTIP = 0
 
-- Debug plugin: (See output in `data/debug.txt`)
-  - Set DEBUG = 0
-
 ## <a name="Plugin Installation Instructions"></a> Plugin Installation Instructions
 
 %X% **NOTE:** This Plugin is included in the TWiki distribution package. You do not need to install it unless you want to upgrade to a newer version.
@@ -69,15 +66,19 @@ Plugin settings are stored as Preferences variables. To reference a plugin setti
   </tr>
   <tr>
     <td align="right"> Plugin Version: </td>
-    <td> 25 Aug 2004, 1.005 </td>
+    <td> 1.008 </td>
   </tr>
   <tr>
     <td align="right"> Change History: </td>
     <td>  </td>
   </tr>
   <tr>
+    <td align="right"> 26 Feb 2005: </td>
+    <td> 1.008 TWiki:Main.CrawfordCurrie cleaned up code and made Dakar-ready </td>
+  </tr>
+  <tr>
     <td align="right"> 25 Aug 2004: </td>
-    <td> Updated [[Main/InterWikis]] link rules (no code change) </td>
+    <td> 1.005 TWiki:Main.PeterThoeny updated [[Main/InterWikis]] link rules (no code change) </td>
   </tr>
   <tr>
     <td align="right"> 09 Mar 2004: </td>
@@ -121,7 +122,7 @@ Plugin settings are stored as Preferences variables. To reference a plugin setti
   </tr>
   <tr>
     <td align="right"> 20 Feb 2001: </td>
-    <td> Initial version </td>
+    <td> TWiki:Main.AndreaSterbini, TWiki:Main.PeterThoeny - Initial version </td>
   </tr>
   <tr>
     <td align="right"> CPAN Dependencies: </td>
@@ -137,14 +138,12 @@ Plugin settings are stored as Preferences variables. To reference a plugin setti
   </tr>
   <tr>
     <td align="right"> Plugin Home: </td>
-    <td><a href="http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%" target="_top">http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%</a> (TWiki:Plugins/%TOPIC%) </td>
+    <td> TWiki:Plugins/%TOPIC% (TWiki:Plugins/%TOPIC%) </td>
   </tr>
   <tr>
     <td align="right"> Feedback: </td>
-    <td><a href="http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev" target="_top">http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev</a> (TWiki:Plugins/%TOPIC%Dev) </td>
+    <td> TWiki:Plugins/%TOPIC%Dev (TWiki:Plugins/%TOPIC%Dev) </td>
   </tr>
 </table>
 
 **_Related Topics:_** [[InterWikis]], [[TWikiPreferences]], [[TWikiPlugins]]
-
--- TWiki:Main.AndreaSterbini - 20 Oct 2000 <br /> -- TWiki:Main.MikeMannix - 01 Oct 2001 <br /> -- TWiki:Main.PeterThoeny - 25 Aug 2004 <br />
diff --git a/TWiki/JSCalendarContrib.mdwn b/TWiki/JSCalendarContrib.mdwn
new file mode 100644 (file)
index 0000000..274da70
--- /dev/null
@@ -0,0 +1,476 @@
+[Mishoo JSCalendar](http://dynarch.com/mishoo/calendar.epl), packaged for use by plugins, skins and add-ons.
+
+# <a name="Summary of Contents"></a> Summary of Contents
+
+This module packages the [Mishoo JSCalendar](http://dynarch.com/mishoo/calendar.epl) Javascript in a form suitable for use with TWiki.
+
+# <a name="Detailed Documentation"></a> Detailed Documentation
+
+Read [the Mishoo documentation](http://www.dementia.org/twiki//view/doc/html/reference.html) or [visit the demo page](http://www.dementia.org/twiki//view).
+
+This package also includes a small Perl module to make using the calendar easier from TWiki plugins. This module includes the function:
+
+    addHEAD( $setup )
+
+that can automatically add the required headers to the page being rendered. `$setup` is the name of the calendar setup module; it can either be ommitted, in which case the method described in the Mishoo documentation can be used to create calendars, or it can be `'twiki'`, in which case a helper function is added that simplifies using calendars to set a value in a text field. For example,
+
+        # Add styles and javascript for the calendar
+        require TWiki::Contrib::JSCalendarContrib;
+        if( $@ || !$TWiki::Contrib::JSCalendarContrib::VERSION ||
+            $TWiki::Contrib::JSCalendarContrib::VERSION < 0.961 ) {
+            TWiki::Func::writeWarning('JSCalendarContrib >=0.961 not found '.$@);
+        } else {
+            TWiki::Contrib::JSCalendarContrib::addHEAD( 'twiki' );
+        }
+
+        $html .= CGI::textfield(
+            { name => 'datefield',
+              id => "id_datefield" });
+        $html .=
+              CGI::image_button(
+                          -name => 'datefield_calendar',
+                          -onclick =>
+                              "return showCalendar('id_datefield','%e %B %Y')",
+                          -src=> TWiki::Func::getPubUrlPath() . '/' .
+                            TWiki::Func::getTwikiWebname() .
+                                '/JSCalendarContrib/img.gif',
+                          -alt => 'Calendar',
+                          -align => 'MIDDLE' );
+                }
+            }
+
+The first parameter to showCalendar is the id of the textfield. See the Mishoo documentation for details of the '$e %B %Y' parameter.
+
+Note that the header will only be added once, regardless of the number of times that addHEAD is called.
+
+`addHEAD` can be called from `commonTagsHandler` for adding the header to all pages, or to `beforeEditHandler` just for edit pages etc.
+
+## <a name="Settings"></a> Settings
+
+- Name of the perl package
+  - Set STUB = TWiki::Contrib::JSCalendarContrib
+
+## <a name="Installation Instructions"></a> Installation Instructions
+
+- Download the ZIP file from the Plugin web (see below)
+- Unzip <code>**%TOPIC%.zip**</code> in your twiki installation directory. Content: <table border="1" cellpadding="0" cellspacing="0">
+  <tr>
+    <th bgcolor="#99CCCC"><strong> File: </strong></th>
+    <th bgcolor="#99CCCC"><strong> Description: </strong></th>
+  </tr>
+  <tr>
+    <td><code><b>data/TWiki/JSCalendarContrib.txt</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>lib/TWiki/Contrib/JSCalendarContrib/build.pl</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>lib/TWiki/Contrib/JSCalendarContrib.pm</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/twiki.js</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/bugtest-hidden-selects.html</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/calendar-blue2.css</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/calendar-blue.css</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/calendar-brown.css</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/calendar-green.css</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/calendar.js</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/calendar.php</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/calendar-setup.js</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/calendar-setup_stripped.js</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/calendar_stripped.js</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/calendar-system.css</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/calendar-tas.css</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/calendar-win2k-1.css</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/calendar-win2k-2.css</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/calendar-win2k-cold-1.css</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/calendar-win2k-cold-2.css</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/ChangeLog</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/dayinfo.html</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/doc/html/field-button.jpg</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/doc/html/reference.css</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/doc/html/reference.html</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/doc/html/reference-Z-S.css</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/doc/reference.pdf</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/img.gif</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/index.html</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-af.js</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-al.js</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-bg.js</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-big5.js</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-big5-utf8.js</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-br.js</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-ca.js</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-cs-utf8.js</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-cs-win.js</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-da.js</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-de.js</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-du.js</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-el.js</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-en.js</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-es.js</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-fi.js</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-fr.js</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-he-utf8.js</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-hr.js</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-hr-utf8.js</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-hu.js</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-it.js</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-jp.js</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-ko.js</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-ko-utf8.js</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-lt.js</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-lt-utf8.js</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-lv.js</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-nl.js</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-no.js</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-pl.js</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-pl-utf8.js</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-pt.js</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-ro.js</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-ru_win_.js</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-ru.js</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-si.js</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-sk.js</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-sp.js</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-sv.js</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-tr.js</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-zh.js</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/lang/cn_utf8.js</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/skins/aqua/active-bg.gif</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/skins/aqua/dark-bg.gif</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/skins/aqua/hover-bg.gif</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/skins/aqua/menuarrow.gif</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/skins/aqua/normal-bg.gif</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/skins/aqua/rowhover-bg.gif</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/skins/aqua/status-bg.gif</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/skins/aqua/theme.css</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/skins/aqua/title-bg.gif</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/skins/aqua/today-bg.gif</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/menuarrow.gif</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/menuarrow2.gif</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/multiple-dates.html</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/README</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/release-notes.html</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/simple-1.html</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/simple-2.html</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/simple-3.html</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/test.php</b></code></td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><code><b>pub/TWiki/JSCalendarContrib/test-position.html</b></code></td>
+    <td>   </td>
+  </tr>
+</table>
+
+- Make sure that all files are readable by the web server user
+
+## <a name="Contrib Info"></a> Contrib Info
+
+<table border="1" cellpadding="0" cellspacing="0">
+  <tr>
+    <td align="right"> Author: </td>
+    <td> TWiki:Main/CrawfordCurrie <a href="http://www.c-dot.co.uk" target="_top">http://www.c-dot.co.uk</a></td>
+  </tr>
+  <tr>
+    <td align="right"> Version: </td>
+    <td> 8670 of the Mishoo calendar </td>
+  </tr>
+  <tr>
+    <td align="right"> Copyright ©: </td>
+    <td> See <a href="http://www.dementia.org/twiki//view/doc/html/reference.html" target="_top">the Mishoo documentation</a></td>
+  </tr>
+  <tr>
+    <td align="right"> License: </td>
+    <td> GNU LGPL </td>
+  </tr>
+  <tr>
+    <td align="right"> Dependencies: </td>
+    <td> None </td>
+  </tr>
+  <tr>
+    <td align="right"> 27/12/05 </td>
+    <td> updated to calendar version 1.0; set style for Safari to win2k-1 </td>
+  </tr>
+  <tr>
+    <td align="right"> 14/08/04 </td>
+    <td> Separated out from [[Main/SharedCode]] module </td>
+  </tr>
+  <tr>
+    <td align="right"> Home: </td>
+    <td><a href="http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%" target="_top">http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%</a></td>
+  </tr>
+  <tr>
+    <td align="right"> Feedback: </td>
+    <td><a href="http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev" target="_top">http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev</a></td>
+  </tr>
+</table>
+
+**_Related Topics:_** [[TWikiPreferences]]
+
+-- TWiki:Main/CrawfordCurrie - 23:00:11 01 February 2006
diff --git a/TWiki/LoginName.mdwn b/TWiki/LoginName.mdwn
new file mode 100644 (file)
index 0000000..2fdbcff
--- /dev/null
@@ -0,0 +1,23 @@
+# <a name="The name you log in with"></a> The name you log in with
+
+A login name is a sequence of alphanumeric characters and underscores.
+
+You cannot alter your LoginName: you have to get the administrator to do this for you.
+
+## <a name="How to find yours"></a> How to find yours
+
+Look in [[TWikiUsers]] - if your name is followed by a dash and a word, usually lowercase, this is what you log in with.
+
+e.g.
+
+- TWikiGuest - guest - 05 Sep 2004
+
+Would mean that TWikiGuest would log in using the login name 'guest'
+
+If, on the other hand, if your entry is like this:
+
+- TWikiGuest - 05 Sep 2004
+
+Then you would log in using your [[WikiName]], in this case 'TWikiGuest'
+
+**_Related Topics:_** [[UserDocumentationCategory]]
diff --git a/TWiki/MailerContrib.mdwn b/TWiki/MailerContrib.mdwn
new file mode 100644 (file)
index 0000000..40fd4a1
--- /dev/null
@@ -0,0 +1,144 @@
+This module is an add-on to the TWiki kernel that supports e-mail notification of changes.
+
+<div>
+  <ul>
+    <li><a href="#Summary of Contents"> Summary of Contents</a><ul>
+        <li><a href="#tools/mailnotify"> <code>tools/mailnotify</code></a></li>
+        <li><a href="#TWiki/Contrib/_MailerContrib cod"> <code>TWiki/Contrib/MailerContrib</code> code library</a></li>
+      </ul>
+    </li>
+    <li><a href="#Installation Instructions"> Installation Instructions</a></li>
+    <li><a href="#Setting up your cron job"> Setting up your cron job</a></li>
+    <li><a href="#Settings"> Settings</a></li>
+    <li><a href="#Contrib Info"> Contrib Info</a></li>
+  </ul>
+</div>
+
+# <a name="Summary of Contents"></a> Summary of Contents
+
+## <a name="tools/mailnotify"></a> `tools/mailnotify`
+
+The main part of the mailer module is a script, `tools/mailnotify`. This script is designed to be run from 'cron' (or an equivalent offline job scheduler), and processes the contents of the standard WebNotify topic. As well as providing the usual notification service, it also provides per-topic notification services. The script may be run from the command line or a cron job.
+
+Subscribers are listed in WebNotify following one of these bullet list formats:
+
+_three spaces_ \* [ _webname_ . ] _wikiName_ - _SMTP mail address_<br />_three spaces_ \* [ _webName_ . ] _wikiName_<br />_three spaces_ \* _SMTP mail address_<br />_three spaces_ \* _SMTP mail address_ : _topics_<br />_three spaces_ \* [ _webname_ . ] _wikiName_ : _topics_
+
+where _topics_ is a space-separated list of topic names.
+
+- Specify topics without a _Web._ prefix
+- Topics must exist in this web.
+- Topics may be specified using \* wildcards
+- Each topic may optionally be followed by an integer in parentheses, indicating the depth of the tree of children below that topic. Changes in all these children will be detected and reported along with changes to the topic itself. _Note_ This uses the TWiki "Topic parent" feature.
+- Each topic may optionally be preceded by a '+' or '-' sign. The '+' sign means "subscribe to this topic" (the same as not putting anything). The '-' sign means "don't send notifications regarding this topic". This allows users to elect to filter out changes to certain topics (and their children, to an arbitrary depth). Topic filters ('-') take precedence over topic includes ('+').
+
+For example:
+
+       * daisy@flowers.com
+       * daisy@flowers.com: Web*
+       * DaisyCutter: Petal* (1) WeedKillers (3) Red*Phlox
+       * StarTrekFan: * - *Wars - *sInTheirEyes - *shipTroopers
+
+A user may be listed many times in the WebNotify topic. Where a user has several lines in WebNotify that all match the same topic, they will only be notified of changes to that topic _once_.
+
+If a _TWiki group_ is listed for notification, the group will be recursively expanded to the e-mail addresses of all members.
+
+**_%T% Tip:_** List names in alphabetical order to make it easier to find the names.
+
+In the future it is intended that individual users will be able to control the frequency with which they are notified of topic changes, by changing a schedule specification in their home topic. However at present, the notification schedule is controlled by the frequency of activation of the `cron` job that runs the `mailnotify` script.
+
+%RED% **_Note_** `mailnotify` ignores permissions in webs. It is entirely possible for a user to get added to a WebNotify topic in a web, when they are not authorised to view the topics in that web. This could result in them having limited access to sensitive information (the topic summaries). %ENDCOLOR%
+
+## <a name="TWiki/Contrib/_MailerContrib cod"></a> `TWiki/Contrib/MailerContrib` code library
+
+The second part of the module is a code library that provides the services for other applications to modify WebNotify through a clean, well documented interface. This allows (for example) plugin developers to add a "Register me for notification" button to their pages. The main interface is the `WebNotify` package described below.
+
+# <a name="Installation Instructions"></a> Installation Instructions
+
+This Contrib is pre-installed as part of the TWiki release package, and should only have to be re-installed if an upgrade is required.
+
+- Download the ZIP file from the Plugin web (see below)
+- Unzip <code>**%TOPIC%.zip**</code> in your twiki installation directory.
+- Run the installer script `MailContrib_intaller.pl` or alternatively resolve all dependencies manually.
+- To make sure the installation was successful, run the `mailnotify` script from the command line, with no parameters. In this case it will print out what it would have done to STDOUT.
+
+# <a name="Setting up your cron job"></a> Setting up your cron job
+
+You need to set up a `cron` (or equivalent) job to run `mailnotify`.
+
+<code>Usage: perl -I  tools/mailnotify [-q] [ _web1 web2 ... webN_ ]</code>  is the path to the TWiki bin directory, so that the script can find the rest of TWiki.
+
+<table border="1" cellpadding="0" cellspacing="0">
+  <tr>
+    <td><code>-q</code></td>
+    <td> Don't print progress information </td>
+  </tr>
+  <tr>
+    <td><code><i>web1 web2 ... webN</i></code></td>
+    <td> List of webs to process, separated by spaces or commas. Default is to process all legal TWiki webs. Wildcards (*) are supported. </td>
+  </tr>
+</table>
+
+For example, `perl -I /usr/local/twiki/bin mailnotify -q Public Private` will generate notifications for the Public and Private webs.
+
+# <a name="Settings"></a> Settings
+
+- Name of the perl package
+  - Set STUB = TWiki::Contrib::Mailer
+
+# <a name="Contrib Info"></a> Contrib Info
+
+<table border="1" cellpadding="0" cellspacing="0">
+  <tr>
+    <td align="right"> Author: </td>
+    <td> TWiki:Main/CrawfordCurrie (<a href="http://c-dot.co.uk" target="_top">http://c-dot.co.uk</a>) </td>
+  </tr>
+  <tr>
+    <td align="right"> Copyright ©: </td>
+    <td> 2004, Wind River Systems </td>
+  </tr>
+  <tr>
+    <td align="right"> License: </td>
+    <td> GPL </td>
+  </tr>
+  <tr>
+    <td align="right"> Change History: </td>
+    <td>  </td>
+  </tr>
+  <tr>
+    <td align="right"> 4 March 2005 </td>
+    <td> 1.010 Dakar release ready. </td>
+  </tr>
+  <tr>
+    <td align="right"> 12 Oct 2004 </td>
+    <td> 1.004 Added support for anti-subscriptions. Doc fixes from TWiki:Main.PeterThoeny. Bug fixes to permissions code. Back-off and retry if the mailer can't be reached (should really be in Net::sendEmail) </td>
+  </tr>
+  <tr>
+    <td align="right"> 6 Oct 2004 </td>
+    <td> 1.003 Excluded _ webs from processing, added <code>bin/remove_obsolete_locks</code> for full reverse-compatibility </td>
+  </tr>
+  <tr>
+    <td align="right"> 1 Oct 2004 </td>
+    <td> 1.002 PeterThoeny provided additional documentation </td>
+  </tr>
+  <tr>
+    <td align="right"> 27 Sep 2004 </td>
+    <td> 1.001 runnable as CGI script, minor bugfixes, removed dependency on DBCacheContrib </td>
+  </tr>
+  <tr>
+    <td align="right"> 8 Sep 2004 </td>
+    <td> 1.000 Initial version </td>
+  </tr>
+  <tr>
+    <td align="right"> Home: </td>
+    <td> TWiki:Plugins/%TOPIC% </td>
+  </tr>
+  <tr>
+    <td align="right"> Feedback: </td>
+    <td> TWiki:Plugins/%TOPIC%Dev </td>
+  </tr>
+</table>
+
+**_Related Topics:_** [[TWikiPreferences]]
+
+-- TWiki:Main/CrawfordCurrie
index d9f9333..fbf5b56 100644 (file)
@@ -1,11 +1,11 @@
-**Main Features of TWiki**
+# <a name="Main Features of TWiki"></a> Main Features of TWiki
 
 - **Any web browser:** Edit existing pages or create new pages by using any web browser. There is no need to upload pages.
-- **Edit link:** To edit a page, simply click on the <code>**Edit**</code> link at the bottom of the page.
+- **Edit link:** To edit a page, simply click on the <code>**Edit**</code> link at the top or bottom of the page.
 - **Auto links:** Web pages are [[linked automatically|Main/WikiWord]]. You do not need to learn HTML commands to link pages.
 - **Text formatting:** Simple, powerful and easy-to-learn [[text formatting rules|Main/WikiSyntax]]. Basically you write text like you would write an e-mail.
 - **Webs:** Pages are grouped into [[TWiki webs|TWiki/SiteMap]] (or collections). This allows you to set up separate collaboration groups.
-- **Search:** [[Full text search|Main/WebSearch]] with/without regular expressions. See a sample [search result](http://www.dementia.org/twiki//search/TWiki/?scope=text&search=learn).
+- **Search:** [[Full text search|Main/WebSearch]] with/without regular expressions. See a sample [search result](http://www.dementia.org/twiki/search/TWiki/?scope=text&search=learn).
 - **E-mail notification:** Get [[automatically notified|Main/WebChangesAlert]] when something has changed in a TWiki web.
 - **Structured content:** Use [[TWikiForms]] to classify and categorize unstructured web pages and to create simple workflow systems.
 - **File attachments:** [[Upload|Main/FileAttachment]] and download any file as an attachment to a page by using your browser. This is similar to file attachments in an e-mail, but it happens on web pages.
@@ -18,5 +18,7 @@
 - **Managing users:** Web-based [[user registration|Main/TWikiRegistration]] and [[change of password|Main/ChangePassword]].
 - **Statistics:** Create statistics of TWiki webs. Find out most popular pages and top contributors.
 - **Preferences:** Three levels of preferences: [[TWikiPreferences]] for site-level, [[WebPreferences]] for each web, and user level preferences.
-- **Topic locking:** Users are warned if a page is being edited by another person. This is to prevent [[simultaneous page editing|Main/SimultaneousEdits]].
+- **[[simultaneous page editing|Main/SimultaneousEdits]]:**
 - **Referred-By:** Find the pages that contain links to a topic.
+
+**_Related Topics:_** [[UserDocumentationCategory]], [[AdminDocumentationCategory]]
index d455762..0f1b0c0 100644 (file)
@@ -64,7 +64,7 @@ You can use [[TWikiMetaData]] to place a command in the [[WebTopicViewTemplate]]
 
 ### <a name="How Referring Topics Are Found"></a> How Referring Topics Are Found
 
-Referring topics are found using the %SEARCH% variable - see the template <code>**searchrenameview.tmpl**</code>. First, matching topics in the current web are listed - matches are to <code>**topic**</code>. Next, all webs (including the current one) are listed that match <code>**web.topic**</code>. Because %SEARCH% is used, webs marked in [[WebPreferences]] as `NOSEARCHALL` will not show up in the search for references to the `topic` being changed.
+First, matching topics in the current web are listed - matches are to <code>**topic**</code>. Next, all webs (including the current one) are listed that match <code>**web.topic**</code>. _All_ webs will be searched during rename, even if `NOSEARCHALL` is defined on a web, though access permissions will of course be honoured.
 
 Changed references are kept are as short as possible, ex: `topic` is used in preference to `web.topic`.
 
@@ -94,4 +94,4 @@ The following shows some limitations of square bracket processing.
 >     [[old t opic]] => not changed
 >     [[OldTopic]]   => [[NewTopic]]
 
--- TWiki:Main.MikeMannix - 27 Dec 2001
+**_Related Topics:_** [[UserDocumentationCategory]], [[AdminDocumentationCategory]]
index 1abdd33..16d75a0 100644 (file)
@@ -21,24 +21,27 @@ _Register users on your TWiki site; change/reset/install passwords; remove user
 
 ## <a name="Register User"></a> Register User
 
+It is not necessary to have user home pages in the TWiki system for Authentication to work - see [[TWikiUserAuthentication]] for details.
+
 - [[TWikiRegistration]] is for users to fill out a form
-- [[NewUserTemplate]] can be changed to customize user home pages
+- [[NewUserTemplate]] can be changed to customize user home pages, it can optionally use the [[UserForm]] to define user fields as meta data
+- [[BulkRegistration]] is for administrators to use to set up one or more accounts: either from a table or from an external file
 
 ## <a name="Change, Reset and Install Passwo"></a> Change, Reset and Install Passwords
 
-- [[ChangePassword]] is for users who remember their password
-- [[ResetPassword]] is for users who do _not_ remember their password; they are asked to send a request to the site administrator to install a new password
-- [[InstallPassword]] is for the site administrator to install a password
+- [[ChangePassword]] is for users who can remember their password and want to change it
+- [[ResetPassword]] is for users who cannot remember their password; a system generated password is e-mailed to them
+- [[BulkResetPassword]] if for administrators who want to reset many passwords at once
 
 ## <a name="Removing User Accounts"></a> Removing User Accounts
 
-To remove a user account:
+To remove a user account (FredQuimby, who logs in as "fred"):
 
-1. Edit the `data/.htpasswd` file to delete their entry (only applies if you are using a .htpasswd file)
-2. Remove the `FredQuimby` line from the Main.TWikiUsers topic
-3. Remove user from all groups and from all the `ALLOWWEB/ALLOWTOPIC...` declarations, if any.%BR% **_Note:_** Otherwise this is a security hole as the first one to re-register with this name will be granted the permissions of the previous user.
-4. _[optional]_ Remove their topic files: `data/Main/FredQuimby.txt` and `data/Main/FredQuimby.txt,v`
+1. If you are using a `.htpasswd` file, edit the `.htpasswd` file to delete the line starting `fred:`
+2. Remove the `FredQuimby - fred` line from the Main.TWikiUsers topic
+3. Remove `FredQuimby` from all groups and from all the `ALLOWWEB/ALLOWTOPIC...` declarations, if any.%BR% **_Note:_** If you fail to do this you risk creating a security hole, as the next user to register with the wikiname FredQuimby will inherit the old FredQuimby's permissions.
+4. _[optional]_ Delete their user topic Main.FredQuimby.
 
-**_Note:_** Consider leaving the user topic file in place so their past signatures and revision author entries don't end up looking like [[AnUncreatedTopic]]. If you want to make it clear the user is inactive on your site (e.g. [[PeterThoeny]]) or has been banished add a note to that effect and write protect the page ([[TWikiAccessControl]]). The existance of the UserName topic prevent that user name from being re-used.
+**_Note:_** Consider leaving the user topic file in place so their past signatures and revision author entries don't end up looking like [[AnUncreatedTopic]]. If you want to make it clear the user is no longer with the organization or has been banished, replace the topic content with a note to that effect. The existance of the UserName topic should also prevent that user name from being re-used, sealing the potential security hole regarding inherited permissions..
 
--- TWiki:Main.MattWilkie - 21 Jul 2003 %BR% -- TWiki:Main.PeterThoeny - 15 Aug 2004
+**_Related Topics:_** [[AdminDocumentationCategory]]
index f46dfc6..ce43553 100644 (file)
@@ -5,7 +5,14 @@
         <li><a href="#Choose Web Template"> Choose Web Template</a></li>
         <li><a href="#Adding a New Web"> Adding a New Web</a></li>
         <li><a href="#Renaming or Deleting a Web"> Renaming or Deleting a Web</a><ul>
-            <li><a href="#Renaming the MAINWEB"> Renaming the MAINWEB</a></li>
+            <li><a href="#Permissions"> Permissions</a></li>
+            <li><a href="#Edit Conflicts"> Edit Conflicts</a></li>
+            <li><a href="#Renaming the webs in the distrib"> Renaming the webs in the distribution</a></li>
+          </ul>
+        </li>
+        <li><a href="#Hierarchical Webs"> Hierarchical Webs</a><ul>
+            <li><a href="#Subweb Preferences are Inherited"> Subweb Preferences are Inherited</a></li>
+            <li><a href="#Navigation"> Navigation</a></li>
           </ul>
         </li>
       </ul>
 
 # <a name="Managing Webs"></a> Managing Webs
 
-_Adding webs is a web based operation; renaming and deleting webs are manual operations done directly on the server_
+_Adding, renaming and deleting webs are all web-based operations._
 
 ## <a name="Overview"></a> Overview
 
-A [[TWikiSite]] is divided into webs; each one represents one subject, one area of collaboration. Administrators can add/rename/delete webs.
+A [[TWikiSite]] is divided into webs; each one represents one subject, one area of collaboration. Administrators (in the [[TWikiAdminGroup]]) can add/rename/delete webs.
 
 <a name="WebTemplate"></a>
 
 ## <a name="Choose Web Template"></a> Choose Web Template
 
-There are two methods used to create a new web. First you can use a specially designed [[TemplateWeb]]. This is an invisible web that begins with an underscore "\_" character. All topics in the \_default template web will be copied into your new web.
+There are two methods used to create a new web. First you can use a specially designed [[TemplateWeb]]. This is an invisible web that begins with an underscore "\_" character (for example `_default`). All topics in the template web will be copied into your new web.
 
 The second method is to use an existing web as a template web. This may be useful if you already have a web that you like to use as a starting point. Only topics that have names beginning with **Web...** (like "WebHome", "WebNotify", etc.) are copied.
 
@@ -35,11 +42,11 @@ In either case you will want to be sure to verify that your new web has all the
 
 ## <a name="Adding a New Web"></a> Adding a New Web
 
-<form action="http://www.dementia.org/twiki//manage/%WEB%/%TOPIC%" method="post" name="admin"> Create a new web by filling out this form. <strong><em>Note:</em></strong> It is not recommended to create a new web for each little project. You can organize content within a web using [[Main/TWikiForms]] and [[Main/FormattedSearch]]. Cross-linking topics and search is easier if there are only a few larger webs. <table border="1" cellpadding="0" cellspacing="0">
+<form action="http://www.dementia.org/twiki/manage/%WEB%/%TOPIC%" method="post" name="admin"> Create a new web by filling out this form.%BR% <strong><em>%X% Note:</em></strong> <strong>Keep the number of webs to a minimum!</strong> It is not recommended to create a new web for each little project. You can organize content within a web using categories, [[Main/TWikiForms]] and [[Main/FormattedSearch]]. Cross-linking topics and search is easier if there are only a few larger webs. <table border="1" cellpadding="0" cellspacing="0">
     <tr>
       <th align="right" bgcolor="#99CCCC"><strong> Name of new web: </strong></th>
       <td><input name="newweb" size="16" type="text" value="" /></td>
-      <td> Enter a short name of up to 10 characters. The name must start with an upper case letters, followed by optional upper or lower case letters or numbers </td>
+      <td> The name must start with an upper case letter, followed by upper or lower case letters or numbers. Specify a short name to avoid long URLs. </td>
     </tr>
     <tr>
       <th align="right" bgcolor="#99CCCC"><strong> Based on web: </strong></th>
@@ -65,7 +72,7 @@ In either case you will want to be sure to verify that your new web has all the
       <td> Specify if you want to exclude the web from a "search all webs" search. Note that the [[TWiki/SiteMap]] will not list the web if you select Yes. </td>
     </tr>
     <tr>
-      <td>   </td>
+      <th bgcolor="#99CCCC"><strong>   </strong></th>
       <td colspan="2"><input type="submit" value="Create new web" /></td>
     </tr>
   </table><input name="newtopic" type="hidden" value="" /> <input name="action" type="hidden" value="createweb" /></form>
@@ -73,25 +80,53 @@ In either case you will want to be sure to verify that your new web has all the
 **_Notes:_**
 
 - Attachments will NOT get copied over along with their topics
-- The manage script while creating the new web will update the following variables in the [[WebPreferences]]: `WEBBGCOLOR`, `SITEMAPLIST`, `SITEMAPWHAT`, `SITEMAPUSETO` and `NOSEARCHALL`. These variables are used to dynamically generate the [[SiteMap]]
-- This script does not edit the [[TWiki.TWikiPreferences|TWiki/TWikiPreferences]] file to update the `WIKIWEBLIST`. This must be done by hand
-- As of TWiki Release 01 Sep 2004, a web name can be a [[WikiWord]]. Prior to that it could be only `UPPER` or `UPPERlower`. A side effect of this is that if you do use a wiki name, `%WEB%` must be written as `<nop>%WEB%` or else it will try to link to a non-existing topic of that name
+- While creating the new web, TWiki will update the following variables in the [[WebPreferences]]: `WEBBGCOLOR`, `SITEMAPLIST`, `SITEMAPWHAT`, `SITEMAPUSETO` and `NOSEARCHALL`. These variables are used to dynamically generate the [[SiteMap]]
+- TWiki does not edit the [[TWiki.TWikiPreferences|TWiki/TWikiPreferences]] to update the `WIKIWEBLIST`. This must be done by hand
 
 ## <a name="Renaming or Deleting a Web"></a> Renaming or Deleting a Web
 
-Renaming or deleting a web requires direct access to the installation files on the host server. There are currently no browser-based equivalents of the Rename/move/delete topic tools for working with webs.
+Rename a web via the Tools section in each web's [[WebPreferences]] topic. You may delete a web by moving it into a Trash web.
+
+### <a name="Permissions"></a> Permissions
+
+You may only rename a web if you have permissions to rename all the topics within that web, including any topics in that web's subwebs. You will also need permissions to update any topics containing references to that web.
+
+### <a name="Edit Conflicts"></a> Edit Conflicts
+
+If anyone is editing a topic which requires updating, or which lives in the web being renamed, a second confirmation screen will come up which will indicate which topics are still locked for edit. You may continue to hit the refresh button until an edit lease is obtained for each topic which requires updating (the "Refresh" button will change to "Submit"), or hit "Cancel", which will cancel your edit lease on all affected topics.
+
+### <a name="Renaming the webs in the distrib"></a> Renaming the webs in the distribution
+
+If you plan to rename the Main web, remember that TWiki stores user and group topics in `%MAINWEB%`, which by default is `Main` (this is assigned in the site configuration). That means that every [[WikiName]] signature - `Main.SomeUserName` - points to it and would need updating (unless the variable, `%MAINWEB%.SomeUserName`, is used throughout). This potentially large change can be performed automatically with the renameweb function mentioned above, in the [[Main.WebPreferences|Main/WebPreferences]] topic.
+
+If you want to rename the TWiki web, remember it is referred to by `%TWIKIWEB%` which is also defined by a configuration setting.
+
+## <a name="Hierarchical Webs"></a> Hierarchical Webs
+
+Hierarchical web support is enabled by turning on the `{EnableHierarchicalWebs}` setting in `configure`. Without this setting, TWiki will only allow a single level of hierarchy (webs). If you set this, you can use multiple levels, like a directory tree, i.e. webs within webs.
+
+**_%T% Note:_** You might not need hierarchical webs. TWiki topics already have a parent/child relationship within a web, which is shown in the breadcrumb. Try to keep the number of webs to a minimum in order to keep search and cross-referencing simple.
+
+You can create hierarchical webs via the _Adding a New Web_ form above, by using a slash- or dot-separated path name which is based on an existing web name in the _Name of new web:_ field.
+
+**Example:**
+
+To create a subweb named `Bar` inside a web named `Foo`, use `Foo/Bar` or `Foo.Bar` as the new web name in the form above.
+
+### <a name="Subweb Preferences are Inherited"></a> Subweb Preferences are Inherited
+
+The preferences of a subweb are inherited from the parent web and overridden locally. Preferences are ultimately inherited from the [[TWiki.TWikiPreferences|TWiki/TWikiPreferences]] topic.
+
+**Example Preference Inheritance for `Sandbox/TestWeb/SubWeb.SubWebTopic` topic:**
 
-1. Prepare your site: Search each web for links to the target web, searching topic text for `Oldwebname.`, including the dot so you'll find references like `Oldwebname.SomeTopic`
-  - Make changes as required, to `Newwebname.SomeTopic` or better yet, to `%MAINWEB%.SomeTopic`
-2. Edit the [[TWikiPreferences]] topic: Rename or delete the web from the `WIKIWEBLIST` variable
-3. Login to the %WIKITOOLNAME% server, via Telnet or FTP
-4. Go to `twiki/data` and rename or remove the web directory
-5. Go to `twiki/templates` and rename or remove the web directory if present
-  - **_Note:_** See TWiki:Codev.RenameWebs for some complications
-6. Go to `twiki/pub` and rename or remove the web directory if present
+1. `TWiki.TWikiPreferences` site-wide preferences
+2. `Sandbox.WebPreferences` inherits from and overrides settings in `TWiki.TWikiPreferences`
+3. `Sandbox/TestWeb.WebPreferences` inherits from and overrides settings in `Sandbox.WebPreferences`
+4. `Sandbox/TestWeb/SubWeb.WebPreferences` inherits from and overrides settings in `Sandbox/TestWeb.WebPreferences`
+5. `Sandbox/TestWeb/SubWeb.SubWebTopic` inherits from and overrides settings in `Sandbox/TestWeb/SubWeb.WebPreferences`
 
-### <a name="Renaming the MAINWEB"></a> Renaming the MAINWEB
+### <a name="Navigation"></a> Navigation
 
-If you plan to rename the Main web, remember that TWiki stores user and group topics in `%MAINWEB%`, default named `Main`. That means, every [[WikiName]] signature - `Main.SomeUserName` - points to it and would need updating (unless the variable, `%MAINWEB%.SomeUserName`, is used throughout).
+The Pattern skin (default) indicates Subwebs by indenting them in the sidebar relative to their level in the hierarchy.
 
--- TWiki:Main.MikeMannix - 14 Sep 2001 %BR% -- TWiki:Main.PeterThoeny - 07 Apr 2002 %BR% -- TWiki:Main.GrantBow - 16 Jan 2003
+**_Related Topics:_** [[AdminDocumentationCategory]], [[AdminToolsCategory]]
index 4580acb..22660c3 100644 (file)
@@ -1 +1,3 @@
 [[ManagingTopics]] can be used to move a topic from one Web to another. One specialised use of this is [[DeleteWeb]].
+
+**_Related Topics:_** [[UserDocumentationCategory]]
index 7ea8759..5105832 100644 (file)
@@ -2,30 +2,74 @@
 
 - %KEY%: %VALUE%%SPLIT%
 
-**_My Links_**
+## <a name="My Links"></a> My Links
 
-- [[WelcomeGuest]] to learn TWiki
-- [[Sandbox|Sandbox/WebHome]] web to try out TWiki
-- Sandbox.%TOPIC%Sandbox just for me
+- [[ATasteOfTWiki]] - view a short introductory presentation on TWiki for beginners
+- [[WelcomeGuest]] - starting points on TWiki
+- [[TWikiUsersGuide]] - complete TWiki documentation, Quick Start to Reference
+- [[Sandbox|Sandbox/WebHome]] - try out TWiki on your own
+- Sandbox.%TOPIC%Sandbox - just for me
 -
 -
 
-**_Personal Preferences (details in [[TWikiVariables]])_**
+## <a name="Personal Preferences"></a> Personal Preferences
 
-- Show tool-tip topic info on mouse-over of [[WikiWord]] links, on or off: (see details in [[TWikiPreferences]])
-  - Set LINKTOOLTIPINFO = off
+Uncomment preferences variables to activate them (remove the #-sign). Help and details on preferences variables are available in [[TWikiPreferences]].
+
+- Show tool-tip topic info on mouse-over of [[WikiWord]] links, on or off:
+  - #Set LINKTOOLTIPINFO = off
+- Horizontal size of text edit box:
+  - #Set EDITBOXWIDTH = 70
+- Vertical size of text edit box:
+  - #Set EDITBOXHEIGHT = 22
+- Style of text edit box. `width: 99%` for full window width (default), `width: auto` to disable.
+  - #Set EDITBOXSTYLE = width: 99%
+- Write protect your home page: (set it to your [[WikiName]])
+  - #Set ALLOWTOPICCHANGE = Main.admin
+
+## <a name="Related Topics"></a> Related Topics
+
+- [[ChangePassword]] for changing your password
+- [[ChangeEmailAddress]] for changing your email address
+- [[TWikiUsers]] has a list of other TWiki users
+- [[UserDocumentationCategory]] is a list of TWiki user documentation
+- [[UserToolsCategory]] lists all TWiki user tools
+
+Note to TWiki Administrator:
+
+Above text is for English speaking users. If you have a multilingual wiki community you can replace the "My Links", "Personal Preferences" and "Related Topics" sections above with the localized text below. Text enclosed in %MAKETEXT will be shown in the language selected by the user. Please note that the %MAKETEXT can be quite intimidating to new users. Consider translating above text to your own language if your community uses a non-English language. (Remove all text from `%STARTSECTION{type="templateonly"}%` to `%ENDSECTION{type="templateonly"}%` when you are done)
+
+Text for multilingual wiki community, copy from here to %ENDSECTION\{type="templateonly"\}%
+
+## <a name="My Links"></a> My Links
+
+- [[ATasteOfTWiki]] - view a short introductory presentation on TWiki for beginners
+- [[WelcomeGuest]] - starting points on TWiki
+- [[TWikiUsersGuide]] - complete TWiki documentation, Quick Start to Reference
+- [[Sandbox|Sandbox/WebHome]] - try out TWiki on your own
+- Sandbox.%TOPIC%Sandbox - just for me
+-
+-
+
+## <a name="Personal Preferences"></a> Personal Preferences
+
+Uncomment preferences variables to activate them (remove the #-sign). Help and details on preferences variables are available in [[TWikiPreferences]].
+
+- Show tool-tip topic info on mouse-over of [[WikiWord]] links, on or off:
+  - #Set LINKTOOLTIPINFO = off
 - Horizontal size of text edit box:
-  - Set EDITBOXWIDTH = 70
+  - #Set EDITBOXWIDTH = 70
 - Vertical size of text edit box:
-  - Set EDITBOXHEIGHT = 22
+  - #Set EDITBOXHEIGHT = 22
 - Style of text edit box. `width: 99%` for full window width (default), `width: auto` to disable.
-  - Set EDITBOXSTYLE = width: 99%
-- Optionally write protect your home page: (set it to your [[WikiName]])
-  - Set ALLOWTOPICCHANGE =
+  - #Set EDITBOXSTYLE = width: 99%
+- Write protect your home page: (set it to your [[WikiName]])
+  - Set ALLOWTOPICCHANGE = Main.admin
 
-**_Related topics_**
+## <a name="Related Topics"></a> Related Topics
 
-- [[ChangePassword]]
-- [[TWikiPreferences]] has site-level preferences of %WIKITOOLNAME%.
-- [[WebPreferences]] has preferences of the %WIKITOOLNAME%.%WEB% web.
-- [[TWikiUsers]] has a list of other TWiki users.
+- [[ChangePassword]] for changing your password
+- [[ChangeEmailAddress]] for changing your email address
+- [[TWikiUsers]] has a list of other TWiki users
+- [[UserDocumentationCategory]] is a list of TWiki user documentation
+- [[UserToolsCategory]] lists all TWiki user tools
diff --git a/TWiki/ObjectMethod.mdwn b/TWiki/ObjectMethod.mdwn
new file mode 100644 (file)
index 0000000..f6d2d33
--- /dev/null
@@ -0,0 +1,18 @@
+An [[ObjectMethod]] is a method that must be called relative to a previous constructed object of the class type. For example:
+
+# <a name="package Telecoms"></a> package Telecoms
+
+## <a name="ClassMethod new()"></a> [[ClassMethod]] new()
+
+## <a name="ObjectMethod phone( $who )"></a> [[ObjectMethod]] phone( $who )
+
+must be called something like this
+
+    my $mobile = new Telecoms();
+    $mobile->phone( "home" );
+
+or you can pass the object in as a parameter if you need to:
+
+    Telecoms::phone( $mobile, "home" );
+
+**_Related Topics:_** [[ClassMethod]], [[StaticMethod]], [[DeveloperDocumentationCategory]]
index 2d47e9c..3d404d6 100644 (file)
@@ -9,14 +9,12 @@
       </ul>
     </li>
     <li><a href="#TWiki Installation Error">TWiki Installation Error</a><ul>
+        <li><a href="#Creating your own look"> Creating your own look</a></li>
         <li><a href="#Supported browsers"> Supported browsers</a></li>
         <li><a href="#Installation"> Installation</a><ul>
             <li><a href="#Troubleshooting"> Troubleshooting</a></li>
           </ul>
         </li>
-        <li><a href="#Creating your own look"> Creating your own look</a></li>
-        <li><a href="#Customization"> Customization</a></li>
-        <li><a href="#Further reading"> Further reading</a></li>
         <li><a href="#Skin Info"> Skin Info</a></li>
         <li><a href="#Related topics"> Related topics</a></li>
         <li><a href="#Feedback"> Feedback</a></li>
 
 ## <a name="Screen Shot"></a> Screen Shot
 
-[<img src="http://www.dementia.org/twiki//view/patternskin_screenshot.gif" width="600" height="130" alt="Click for full screen image" style="border: 1px solid #eee" />](http://www.dementia.org/twiki//view/patternskin_screenshot_full.gif)
+[<img src="http://www.dementia.org/twiki//view/patternskin_screenshot.jpg" width="600" height="130" alt="Click for full screen image" style="border: 1px solid #eee" />](http://www.dementia.org/twiki//view/patternskin_screenshot_full.png)
+
+## <a name="Creating your own look"></a> Creating your own look
+
+It is easy to tune the look and feel of PatternSkin by changing the color and space (margin, padding) settings in the Style Sheet files.
+
+You may also choose to radically change the look and create a PatternSkin-based new skin. This is easier than to create a skin by writing new template files; you can concentrate on how things should look instead of what elements should get displayed.
+
+- [[PatternSkinCustomization]] - how to configure page elements
+- [[PatternSkinCssCookbook]] - how to customize the default look of TWiki
+- [[PatternSkinCss]] - documentation of PatternSkin CSS classes
 
 ## <a name="Supported browsers"></a> Supported browsers
 
@@ -37,11 +45,8 @@ PatternSkin has been tested successfully on the following browsers:
   - Internet Explorer 6.0, 5.5 (note: Explorer 5.0 is **not** supported: will function but shows visual quirks)
   - Mozilla/Firefox
 - Mac OS X
-  - Safari 1.2
+  - Safari 2.0.3
   - Mozilla/Firefox
-
-Not tested, but will probably work (let me know):
-
 - \*nix
   - Mozilla/Firefox
 
@@ -53,7 +58,7 @@ Not tested, but will probably work (let me know):
 
 - Download the ZIP file from the Skin Home page (see below)
 - Unzip <code>**%TOPIC%.zip**</code> in your twiki installation directory
-- Test if installed: <http://www.dementia.org/twiki//view/%WEB%/%TOPIC%?skin=pattern>
+- Test if installed: [[http://www.dementia.org/twiki/view/%WEB%/%TOPIC%?skin=pattern|%WEB%/%TOPIC%?skin=pattern]]
 - For skin activation see [[TWikiSkins]]
 
 ### <a name="Troubleshooting"></a> Troubleshooting
@@ -64,52 +69,34 @@ Check these variables here:
 
 - TWIKILAYOUTURL = %TWIKILAYOUTURL%
 - TWIKISTYLEURL = %TWIKISTYLEURL%
+- TWIKICOLORSURL = %TWIKICOLORSURL%
 - SKIN = %SKIN%
 
 If TWIKILAYOUTURL or TWIKISTYLEURL don't give a value or point to non-existing files, check in [[TWikiPreferences]] that the following variables do exist and that they are set to on:
 
        * %TWIKIWEB%.PatternSkin settings:
-               * Set TWIKILAYOUTURL = %PUBURL%/%TWIKIWEB%/PatternSkin/layout.css
-               * Set TWIKISTYLEURL = %PUBURL%/%TWIKIWEB%/PatternSkin/style.css
+               * Set TWIKILAYOUTURL = %PUBURLPATH%/%TWIKIWEB%/PatternSkin/layout.css
+               * Set TWIKISTYLEURL = %PUBURLPATH%/%TWIKIWEB%/PatternSkin/style.css
+               * Set TWIKICOLORSURL = %PUBURLPATH%/%TWIKIWEB%/PatternSkin/colors.css
 
 If this still does not work, contact the administrator who installs skins.
 
-For further troubleshooting and feedback, go to TWiki:Plugins/PatternSkinDev.
-
-## <a name="Creating your own look"></a> Creating your own look
-
-It is easy to tune the look and feel of PatternSkin by changing the color and space (margin, padding) settings in the Style Sheet files.
-
-You may also choose to radically change the look and create a PatternSkin-based new skin. This is easier than to create a skin by writing new template files; you can concentrate on how things should look instead of what elements should get displayed.
-
-You can either:
-
-- Change the `layout.css` and `style.css` attachment files for this topic (upload updated versions)
-- In [[TWikiPreferences]], point the variables `TWIKILAYOUTURL` and `TWIKISTYLEURL` to other attachments, perhaps in another topic (your new skin topic?)
-
-See for practical details: [[PatternSkinCustomization]] %BR% The CSS classes that PatternSkin uses are documented in [[PatternSkinCss]].
-
-## <a name="Customization"></a> Customization
-
-See: [[PatternSkinCustomization]], [[PatternSkinPalette]]
-
-## <a name="Further reading"></a> Further reading
-
-- [[PatternSkinCustomization]] - Practical information on how to change the looks of PatternSkin
-- [[PatternSkinPalette]] - How to change the colors only
-- [[PatternSkinCss]] - A reference to used CSS classes
-- TWiki:Plugins/PatternSkinDev - Development page, bug reports, solutions from users
+For further troubleshooting and feedback, go to TWiki:Plugins/PatternSkinDev. Report bugs in the [[Support web|TWiki:Support/WebHome]].
 
 ## <a name="Skin Info"></a> Skin Info
 
 <table border="1" cellpadding="0" cellspacing="0">
   <tr>
     <td align="right"> Description: </td>
-    <td> Provides a CSS based default look and feel for TWiki - flexible and [[Main/W3C]]-compliant </td>
+    <td> TWiki's default skin; CSS based, flexible and [[Main/W3C]]-compliant </td>
   </tr>
   <tr>
     <td align="right"> Screenshot: </td>
-    <td><a href="http://www.dementia.org/twiki//view/patternskin_screenshot_full.gif"><img alt="Click for full screen image" height="130" src="http://www.dementia.org/twiki//view/patternskin_screenshot.gif" style="border: 1px solid #eee" width="600" /></a></td>
+    <td><a href="http://www.dementia.org/twiki//view/patternskin_screenshot_full.png"><img alt="Click for full screen image" height="130" src="http://www.dementia.org/twiki//view/patternskin_screenshot.jpg" style="border: 1px solid #eee" width="600" /></a></td>
+  </tr>
+  <tr>
+    <td align="right"> Preview: </td>
+    <td>[[%WEB%/%TOPIC%?skin=pattern]]</td>
   </tr>
   <tr>
     <td align="right"> Base Name: </td>
@@ -121,51 +108,19 @@ See: [[PatternSkinCustomization]], [[PatternSkinPalette]]
   </tr>
   <tr>
     <td align="right"> Skin Version: </td>
-    <td> 28 Aug 2004 (v1.0.9) </td>
+    <td> 31 Jan 2006 (v2.0.0) </td>
   </tr>
   <tr>
     <td align="right"> History: </td>
     <td>  </td>
   </tr>
   <tr>
-    <td align="right"> 28 Aug 2004: </td>
-    <td> v.1.0.9 - CAIRO RELEASE VERSION - Removed twikiTopic div from attach template </td>
-  </tr>
-  <tr>
-    <td align="right"> 24 Aug 2004: </td>
-    <td> v.1.0.8 - Fix for disabled TablePlugin; added plain.pattern.tmpl </td>
-  </tr>
-  <tr>
-    <td align="right"> 23 Aug 2004: </td>
-    <td> v.1.0.7 - Change to checkboxes in edit and preview screen; removed REVINFO at bottom; style changes </td>
-  </tr>
-  <tr>
-    <td align="right"> 22 Aug 2004: </td>
-    <td> v.1.0.6b - Removed files from zip that are now part of the TWiki distribution; removed .DS_Store files </td>
-  </tr>
-  <tr>
-    <td align="right"> 17 Aug 2004: </td>
-    <td> v.1.0.6 - Support for twikiMoved css class </td>
-  </tr>
-  <tr>
-    <td align="right"> 17 Aug 2004: </td>
-    <td> v.1.0.5 - Fix for not showing SEARCHSTRING </td>
-  </tr>
-  <tr>
-    <td align="right"> 16 Aug 2004: </td>
-    <td> v.1.0.4 - Fixes search results layout with noheader="on" </td>
-  </tr>
-  <tr>
-    <td align="right"> 14 Aug 2004: </td>
-    <td> v.1.0.3 - Update to attach template, css fix to edit template </td>
-  </tr>
-  <tr>
-    <td align="right"> 14 Aug 2004: </td>
-    <td> v.1.0.2 - Fixes print template, table paddings in topics, minor changes to style.css </td>
+    <td align="right"> 31 Jan 2006: </td>
+    <td> v.2.0.0 - DAKAR RELEASE VERSION </td>
   </tr>
   <tr>
-    <td align="right"> 13 Aug 2004: </td>
-    <td> v.1.0.1 - Updated /data/TWiki/WebLeftBarPersonalTemplate and style.css </td>
+    <td align="right"> 28 Aug 2004: </td>
+    <td> v.1.0.9 - CAIRO RELEASE VERSION </td>
   </tr>
   <tr>
     <td align="right"> 08 Aug 2004: </td>
@@ -173,7 +128,7 @@ See: [[PatternSkinCustomization]], [[PatternSkinPalette]]
   </tr>
   <tr>
     <td align="right"> Dependencies: </td>
-    <td>   </td>
+    <td> TWiki:Plugins/TwistyContrib (automatically supported by Dakar) </td>
   </tr>
   <tr>
     <td align="right"> Skin Home: </td>
@@ -192,14 +147,25 @@ See: [[PatternSkinCustomization]], [[PatternSkinPalette]]
 ## <a name="Related topics"></a> Related topics
 
 - [[TWikiCss]]
+- [[PatternSkinCss]]
+- [[PatternSkinCssCookbook]]
+- [[PatternSkinCssCookbookCenterPage]]
+- [[PatternSkinCssCookbookEditTableStyle]]
+- [[PatternSkinCssCookbookFonts]]
+- [[PatternSkinCssCookbookNoLeftBar]]
+- [[PatternSkinCssCookbookNoTopBar]]
+- [[PatternSkinCustomization]]
+- [[PatternSkinJavascripts]]
 - [[WebBottomBar]]
 - [[WebLeftBar]]
+- [[WebLeftBarCookbook]]
 - [[WebLeftBarExample]]
+- [[WebLeftBarLogin]]
 - [[WebLeftBarPersonalTemplate]]
-- [[WebLeftBarCookbook]]
+- [[WebLeftBarSearch]]
+- [[WebLeftBarWebsList]]
 - [[WebTopBar]]
-
-See also [[Further reading|Main/TOPIC#Further_reading]] on this page.
+- [[AdminDocumentationCategory]]
 
 Other skins:
 
@@ -209,5 +175,3 @@ Other skins:
 ## <a name="Feedback"></a> Feedback
 
 Leave remarks, suggestions and other feedback in TWiki:Plugins.PatternSkinDev.
-
--- TWiki:Main/ArthurClemens - 28 Aug 2004
index 3c7d2ba..255a572 100644 (file)
@@ -1,16 +1,15 @@
-# <a name="Css elements in _PatternSkin"></a><a name=" Css elements in _PatternSkin"></a> Css elements in PatternSkin
+# <a name="CSS elements in _PatternSkin"></a><a name=" CSS elements in _PatternSkin"></a> CSS elements in PatternSkin
 
 This page is a reference for all CSS classes used in [[PatternSkin]].
 
 <div><span>Page contents:</span><ul>
     <li><a href="#Naming conventions"> Naming conventions</a></li>
     <li><a href="#Namespaces"> Namespaces</a><ul>
-        <li><a href="#body class names"> body class names</a></li>
+        <li><a href="#Page type classes"> Page type classes</a></li>
       </ul>
     </li>
     <li><a href="#Layout classes"> Layout classes</a></li>
     <li><a href="#Style classes"> Style classes</a></li>
-    <li><a href="#CSS tags emitted from TWiki core"> CSS tags emitted from TWiki core code</a></li>
     <li><a href="#Layout per template"> Layout per template</a><ul>
         <li><a href="#View template"> View template</a></li>
       </ul>
@@ -18,158 +17,123 @@ This page is a reference for all CSS classes used in [[PatternSkin]].
   </ul>
 </div>
 
-The PatternSkin stylesheet is divided in two files:
+PatternSkin uses 4 stylesheets:
 
 - [layout.css](http://www.dementia.org/twiki//view/TWiki/PatternSkin/layout.css): positioning of block elements on the page
-- [style.css](http://www.dementia.org/twiki//view/TWiki/PatternSkin/style.css): appearance of blocks and all other page elements
+- [style.css](http://www.dementia.org/twiki//view/TWiki/PatternSkin/style.css): margins, paddings, borders, font sizes
+- [colors.css](http://www.dementia.org/twiki//view/TWiki/PatternSkin/colors.css): text colors, background colors, border colors
+- [print.css](http://www.dementia.org/twiki//view/TWiki/PatternSkin/print.css): optimalizations for printed page
 
 If you want to learn how to create your own look or skin based on PatternSkin, read further in [[PatternSkin]].
 
 ## <a name="Naming conventions"></a> Naming conventions
 
-PatternSkin follows the naming conventions used in TWiki core code: all TWiki class names have the prefix `twiki`: twikiEditPage, twikiTopicAction, etcetera. ID names are not used, only class names, to allow multipe class names. See also: [[TWikiCss]].
+- All PatternSkin specific classes have the prefix `pattern`: patternEditPage, patternTopicAction, etcetera.
+- TWiki specific classes (emitted by the TWiki engine) have the prefix `twiki`: twikiButton, twikiToc, etcetera. See for a complete list [[TWikiCss]].
 
 ## <a name="Namespaces"></a> Namespaces
 
 PatternSkin uses namespaces for templates, by adding one (sometimes two - multiple) class names to the template's body tag.
 
-- The body tag in view.pattern.tmpl for instance has the class name "twikiViewPage": `<body >`. All CSS elements specific to the view template thus can be defined as `.twikiViewPage .someClassName`.
-- All templates that are _not_ the view template have the body class name "twikiNoViewPage". That makes it easy to give all of these pages a different layout in one sweep (smaller or wider margins for instance). Template edit.pattern.tmpl uses `<body >`.
+- The body tag in view.pattern.tmpl for instance has the class name "patternViewPage": `<body >`. All CSS elements specific to the view template thus can be defined as `.patternViewPage .someClassName`.
+- All templates that are _not_ the view template have the body class name "patternNoViewPage". That makes it easy to give all of these pages a different layout in one sweep (smaller or wider margins for instance). Template edit.pattern.tmpl uses `<body >`.
 
-### <a name="body class names"></a> body class names
+### <a name="Page type classes"></a> Page type classes
 
-- .twikiViewPage
-- .twikiViewPage .twikiPrintPage
-- .twikiNoViewPage
-- .twikiNoViewPage .twikiEditPage
-- .twikiNoViewPage .twikiAttachPage
-- .twikiNoViewPage .twikiChangeFormPage
-- .twikiNoViewPage .twikiDiffPage
-- .twikiNoViewPage .twikiRenamePage
-- .twikiSearchResultsPage
+- .patternViewPage
+- .patternViewPage .patternPrintPage
+- .patternNoViewPage
+- .patternNoViewPage .patternEditPage
+- .patternNoViewPage .patternAttachPage
+- .patternNoViewPage .patternChangeFormPage
+- .patternNoViewPage .patternDiffPage
+- .patternNoViewPage .patternRenamePage
+- .patternSearchResultsPage
+- .patternPlainPage (view.plain.pattern.tmpl)
 
 ## <a name="Layout classes"></a> Layout classes
 
-- General
-  - .twikiLeft - a left floating element
-  - .twikiRight - a right floating element
-  - .twikiClear - to clean up either of these floats: put immediately after the containing block
-  - .twikiHidden - hidden element
-
-- TWiki block elements
-  - .twikiMiddleContainer - holder for twikiMain and twikiLeftbar
-  - .twikiLeftBar - left bar area
-  - .twikiLeftBarContents - used for left menu
-  - .twikiMain - holder of twikiToolbar, twikiTopic, twikiAttachments, etc.
-  - .twikiTopBar - top bar area
-  - .twikiBottomBar - bottom bar area
-
-- Layout adjustments on specific pages
-  - .twikiNoViewPage .twikiMain
-  - .twikiPrintPage .twikiMain
-  - .twikiPrintPage .twikiBottomBar
+- Main layout elements
+  - #patternScreen - holder of patternPageShadow and patternBottomBar
+  - #patternPageShadow - shadow border around patternPage; default not used
+  - #patternPage - html content container
+  - #patternColumnWrapper - holder for patternMain and patternLeftbar
+  - #patternMain - holder of patternMainContents
+  - #patternTopBar - top bar area
+  - .patternTopBarContents - table (for easy vertical alignment) for header art / logo; contains topic [[WebTopBar]]
+  - #patternLeftBar - left bar area
+  - .patternLeftBarContents - used for left menu
+  - #patternBottomBar - bottom bar area
+  - .patternBottomBarContents - copyright
 
 ## <a name="Style classes"></a> Style classes
 
-- .twikiMiddleContainer - holder for twikiMain and twikiLeftbar
-- .twikiMain - holder of twikiToolbar, twikiTopic, twikiAttachments, etc)
-- .twikiTopBar - top bar area
-- .twikiTopBarContents - logo, go box
-- .twikiLeftBar - left bar area
-- .twikiWebIndicator - shows current Web name; background of color %WEBBGCOLOR%
-- .twikiLeftBarContents - used for left menu (a bullet list)
-- .twikiLeftBarPersonal - block of personal links (included topic %MAINWEB%.%USERNAME%LeftBar)
-- .twikiBottomBar - bottom bar area
-- .twikiBottomBarContents - copyright
-- .twikiTopic
-- .twikiAttachments - attachment table; used in template attachtables.tmpl
-- .twikiForm - WebForm table; used in template attachtables.tmpl
-- .twikiTopicAction - actions buttons at bottom of page; holder of table with buttons
-- .twikiTopicActionSecondary - second layer above twikiTopicAction (for instance in Preview)
-- .twikiTopicActionHelp - help text row
-- .twikiCancelCol - table columns (td) for cancel button
-- .twikiSubmitCol - table columns (td) for submit button
-- .twikiAddCol - table columns (td) for additional button/link (for instance: "Move attachment")
-- .twikiSeparator - separator character
-- .twikiToc - topic contents (%TOC%)
-- .twikiTocTitle - title of TOC (%TOC\{title="Contents:"\}%)
-- .twikiTopicInfo - revision (%REVINFO%) and moved (%META\{"moved"\}%) info
-- .twikiRevInfo - revision info (top and bottom of page)
-- .twikiTopicFooter - used for breadcrumb (twikiHomePath)
-- .twikiHomePath - breadcrumb
-- .twikiToolBar - action buttons at top of topic (a bullet list), revision info
-- .twikiPageNav - links "end of topic" and "to top"
-- .twikiSearchBox - go box and current page in top bar
-- .twikiHelp - help text
-- .twikiBroadcastMessage - BROADCASTMESSAGE
-- .twikiAlert - red
-- .twikiGrayText - grayed out text, literally gray
-- .twikiSmall - styled "small"
-- .twikiNewLink - style of links to yet non-existent pages (not used)
-
-- Table class names (emitted from [[TablePlugin]])
-  - .twikiSortedAscendingCol - sortable table column header that is sorted ascending (uses [[TablePlugin]])
-  - .twikiSortedDescendingCol - ditto sorted descending
-  - .twikiFirstCol
-- Other table class names
-  - .twikiVersatileTable - table used in various places (Attach, Rename, Changeform)
-  - .twikiVersatileTable .twikiMainCol - table column that is the most important part of the table
-  - .twikiVersatileTable .twikiOldCol - table column with 'old' appearance, for instance the old attachment or the old topic name
-  - .twikiVersatileTable .twikiHelpCol - table column with help texts
-
-- Search
-  - .twikiNew - emitted from Search.pm and Changes.pm with the text NEW
-  - .twikiSummary - summary text with search results
-  - .twikiSearchResults - the big block of all results
-  - .twikiSearchResultsHeader - top of block, styled with %WEBBGCOLOR%
-  - .twikiSearchResults .twikiTopRow - top of one result, with link, author, revision
-  - .twikiSearchResults .twikiBottomRow - result summary
-  - .twikiSearchResults .twikiAlert - used with "locked" text
-  - .twikiSearchResultCount - result count
-  - .twikiBookViewList - the big block of all results with book view option
-
-- Form elements
-  - .twikiCheckbox - styled checkbox
-  - .twikiRadioButton
-  - .twikiSubmit - submit button (in twikiTopicAction this is the darkest button; in twikiTopic it has a lighter color)
-  - .twikiButton - general button (in Rename/Delete: clear/select all checkboxes)
-  - .twikiSecondary - button next to submit button (same appearance as twikiButton)
-  - .twikiTertiary - button at far right (blue color)
-  - .twikiCancel - cancel button
-  - .twikiEditPage .twikiFormHolder - constrains the width of the textarea
-  - .twikiChangeFormButton - emitted from Form.pm, button to change the WebForm - styled as link
-  - .twikiEditForm - emitted from Form.pm, editable WebForm table
-  - .twikiEditFormTextField - emitted from Form.pm, input textfield in twikiEditForm
-  - .twikiSig - signature copy field
-
-- Preview
-  - .twikiPreviewPage .twikiPreviewArea - holder of previewed topic text
-
-- Attach
-  - .twikiAttachPage .twikiNotes - holder of help text
-  - .twikiAttachPage .twikiPrevious - attachment table of previous versions
-
-- Diff
-  - .twikiDiffPage .twikiDiffTable - block of revisions; emitted from RDiff.pm (also all diff classes below)
-  - .twikiDiffPage .twikiDiffDeletedHeader
-  - .twikiDiffPage .twikiDiffDeletedMarker
-  - .twikiDiffPage .twikiDiffDeletedText
-  - .twikiDiffPage .twikiDiffAddedHeader
-  - .twikiDiffPage .twikiDiffAddedMarker
-  - .twikiDiffPage .twikiDiffAddedText
-  - .twikiDiffPage th.twikiDiffChangedHeader
-  - .twikiDiffPage .twikiDiffChangedText
-  - .twikiDiffPage .twikiDiffUnchangedText
-  - .twikiDiffPage .twikiDiffLineNumberHeader
-
-## <a name="CSS tags emitted from TWiki core"></a> CSS tags emitted from TWiki core code
-
-See: [[TWikiCss]]
+- View
+  - .patternMainContents - holder of patternTop, patternTopic, twikiForm, twikiAttachments, etc.
+  - .patternContent - container around .patternTopic in view.pattern.tmpl only; to be able to give .twikiAttachments and .twikiForm a different appearance when they are not enclosed by it, for example the personal data form on the user pages (where the user form is positioned outside, above the topic text)
+  - .patternTopBarLogo - logo position in patternTopBar (topic [[WebTopBar]])
+  - .patternTopBarOverlay - striped white image background
+  - .patternTopic - TWiki topic text
+  - .patternTop - area at top of topic text, with patternHomePath, revision and action buttons
+  - .patternTopicAction - container for .patternActionButtons
+  - .patternActionButtons - action buttons at bottom of page
+  - .patternMoved - topic moved info (only visible when the topic has changed name or web)
+  - .patternWebIndicator - not used
+  - .patternFormHolder - container around form to manage the size of form elements
+  - .patternLeftBarPersonal - block of personal links (included topic %MAINWEB%.%USERNAME%LeftBar)
+  - .patternVersatileTable - table used in various places (Attach, Rename, Changeform)
+    - .patternVersatileTable .patternMainCol - table column that is the most important part of the table
+    - .patternVersatileTable .patternOldCol - table column with 'old' appearance, for instance the old attachment or the old topic name
+    - .patternVersatileTable .patternHelpCol - table column with help texts
+  - .patternHomePath - breadcrumb at top
+  - .patternHomePathTitle - "You are here" text
+  - .patternRevInfo - revision info and author name
+  - .patternToolBar - holder for .patternToolBarButtons
+  - .patternToolBarButtons - action buttons at top of page
+  - .patternToolBarBottom - seperator
+  - .patternSimpleLogo - logo used on 'simple' pages like the login screen
+  - .patternFormFieldVerticalForm - input field in vertically formatted form
+
+- Edit
+  - .patternSig - signature copy box
+  - .patternSaveOptions - holder for .patternSaveOptionsContents
+  - .patternSaveOptionsContents - checkboxes that change the state of a topic save; for instance "Force revision" checkbox
+  - .patternAccessKeyInfo - info block with access key information
+
+- Preview page
+  - .patternPreviewArea - container around preview of .patternTopic
+
+- Attach page
+  - .patternPrevious - attachment table of previous versions
+  - .patternMoveAttachment - container for "Move or Delete attachment"
+
+- Rename (rename, move, delete)
+  - patternRenameOptionsList - list of topics that can be updated
+
+- More
+  - patternDiffOptions - row of revision options under "Compare revisions"
+
+- Search results
+  - .patternSearchResultsHeader
+  - .patternSearchString
+  - .patternSearchResults
+  - .patternSearchResultCount
+  - .patternSearchResultsBegin - for changes template with noheader="on"
+  - .patternBookViewList
+
+- Print
+  - .patternTopicFooter - revision and author info at bottom of printed topic
+
+- [[WebLeftBarSearch]]
+  - .patternFormSpacer - for layout purposes
+  - .patternFormField
+  - .patternFormButton
+  - .patternChangeLanguage - change language button
 
 ## <a name="Layout per template"></a> Layout per template
 
 ### <a name="View template"></a> View template
 
-<img src="http://www.dementia.org/twiki//view/CSS_element_layout_view.pattern.tmpl.png" width="576" height="735" alt="CSS layout in View template" style="border: 1px solid #ddd" />
+<img src="http://www.dementia.org/twiki//view/CSS_element_layout_view.pattern.tmpl.png" width="586" height="746" alt="CSS layout in View template" style="border: 1px solid #ddd" />
 
--- TWiki:Main.ArthurClemens - 08 Aug 2004
+**_Related Topics:_** [[TWikiSkins]], [[AdminDocumentationCategory]]
diff --git a/TWiki/PatternSkinCssCookbook.mdwn b/TWiki/PatternSkinCssCookbook.mdwn
new file mode 100644 (file)
index 0000000..0fa7a9f
--- /dev/null
@@ -0,0 +1,95 @@
+# <a name="TWiki._PatternSkin CSS Cookbook"></a><a name=" TWiki._PatternSkin CSS Cookbook"></a> [[PatternSkin]] CSS Cookbook
+
+**Questions and answers on how to customize the default look of TWiki for your own needs, using style sheets.** For configuring page elements, see [[PatternSkinCustomization]].
+
+<div>
+  <ul>
+    <li><a href="#Introduction"> Introduction</a><ul>
+        <li><a href="#When you need lots of graphic ch"> When you need lots of graphic changes: Rewriting CSS</a></li>
+        <li><a href="#When you need small adjustments:"> When you need small adjustments: Adding to existing CSS</a></li>
+      </ul>
+    </li>
+    <li><a href="#Recipes"> Recipes</a><ul>
+        <li><a href="#Hide the left bar"> Hide the left bar</a></li>
+        <li><a href="#Use different fonts"> Use different fonts</a></li>
+        <li><a href="#No top bar"> No top bar</a></li>
+        <li><a href="#Centered page"> Centered page</a></li>
+        <li><a href="#Centered page (with a border aro"> Centered page (with a border around the page)</a></li>
+        <li><a href="#Setting _EditTablePlugin styles"> Setting EditTablePlugin styles</a></li>
+      </ul>
+    </li>
+  </ul>
+</div>
+
+## <a name="Introduction"></a> Introduction
+
+PatternSkin uses 3 style sheets (attached to [[PatternSkin]]):
+
+- [layout.css](http://www.dementia.org/twiki//view/TWiki/PatternSkin/layout.css) - the positioning of main page elements (blocks), widths and heights
+- [stylestyle.css](http://www.dementia.org/twiki//view/TWiki/PatternSkin/style.css) - fonts, sizes, margins and paddings
+- [colors.css](http://www.dementia.org/twiki//view/TWiki/PatternSkin/colors.css) - border colors, text colors and background colors
+
+When customizing your TWiki installation, you can either choose to completely rewrite all css styles, or to selectively override some styles. The latter option is by far less time consuming, but all depends on your graphical wishes.
+
+### <a name="When you need lots of graphic ch"></a> When you need lots of graphic changes: Rewriting CSS
+
+- Create a new topic that will contain your new CSS files
+- Attach 3 new style sheets to the topic
+- Point the CSS variables in [[TWiki.TWikiPreferences|TWiki/TWikiPreferences]] to your new files:
+
+               * Set TWIKILAYOUTURL = %PUBURLPATH%/%TWIKIWEB%/YourNewTopic/layout.css
+               * Set TWIKISTYLEURL = %PUBURLPATH%/%TWIKIWEB%/YourNewTopic/style.css
+               * Set TWIKICOLORURL = %PUBURLPATH%/%TWIKIWEB%/YourNewTopic/colors.css
+
+### <a name="When you need small adjustments:"></a> When you need small adjustments: Adding to existing CSS
+
+With CSS you cannot remove already defined classes, you can only add to it, or overwrite existing styles. <br /> Overriding default CSS is done with 3 variables: `USERLAYOUTURL`, `USERSTYLEURL`, `USERCOLORSURL`.
+
+- Create a new topic that will contain your new CSS files
+- Attach 1, 2 or 3 new style sheets to the topic, dependent on your CSS setup (if you don't change much, you might as well put everything in one CSS file, layout, margins and colors)
+- Point the CSS variables in [[TWiki.TWikiPreferences|TWiki/TWikiPreferences]] to your new files (below the `TWIKIXXXURL` variables):
+
+               * Set USERLAYOUTURL = %PUBURLPATH%/%TWIKIWEB%/YourNewTopic/layout.css
+               * Set USERSTYLEURL = %PUBURLPATH%/%TWIKIWEB%/YourNewTopic/style.css
+               * Set USERCOLORSURL = %PUBURLPATH%/%TWIKIWEB%/YourNewTopic/colors.css
+
+- If you use only little CSS and you've only attached one file, write:
+
+               * Set USERSTYLEURL = %PUBURLPATH%/%TWIKIWEB%/YourNewTopic/style.css
+
+Instead of setting these variables in [[TWiki.TWikiPreferences|TWiki/TWikiPreferences]], you can set these in your home topic, or in any other topic. Setting style URL variables in:
+
+- [[TWiki.TWikiPreferences|TWiki/TWikiPreferences]]: the style is visible for all users, site-wide
+- [[WebPreferences]]: the style is visible for all users in one web
+- Home topic: the style is visible for that one user when viewing the site
+- Some other topic: the style is only visible in that one topic
+
+User styles are always loaded after TWiki styles.
+
+The rest of this topic shows examples of small CSS changes.
+
+## <a name="Recipes"></a> Recipes
+
+### <a name="Hide the left bar"></a> Hide the left bar
+
+See example at: [[PatternSkinCssCookbookNoLeftBar]]
+
+### <a name="Use different fonts"></a> Use different fonts
+
+See example at: [[PatternSkinCssCookbookFonts]]
+
+### <a name="No top bar"></a> No top bar
+
+See example at: [[PatternSkinCssCookbookNoTopBar]]
+
+### <a name="Centered page"></a> Centered page
+
+See example at: [[PatternSkinCssCookbookCenterPage]]
+
+### <a name="Centered page (with a border aro"></a> Centered page (with a border around the page)
+
+See example at: [[PatternSkinCssCookbookCenterPageBorder]]
+
+### <a name="Setting _EditTablePlugin styles"></a> Setting EditTablePlugin styles
+
+See example at: [[PatternSkinCssCookbookEditTableStyle]]
diff --git a/TWiki/PatternSkinCssCookbookCenterPage.mdwn b/TWiki/PatternSkinCssCookbookCenterPage.mdwn
new file mode 100644 (file)
index 0000000..ad85b6e
--- /dev/null
@@ -0,0 +1,7 @@
+# <a name="PatternSkinCssCookbook Recipe: C"></a><a name=" _PatternSkinCssCookbook Recipe:"></a> [[PatternSkinCssCookbook]] Recipe: Center the page
+
+**This recipe shows how center the page horizontally.**
+
+<div> This line loads the extra style definition: <pre>
+   * Set USERSTYLEURL = %ATTACHURL%/centerpage.css
+</pre> You can write this line in [[TWiki/TWikiPreferences]], in [[Main/WebPreferences]], in your user topic or on a single page. </div>
diff --git a/TWiki/PatternSkinCssCookbookCenterPageBorder.mdwn b/TWiki/PatternSkinCssCookbookCenterPageBorder.mdwn
new file mode 100644 (file)
index 0000000..6b761d6
--- /dev/null
@@ -0,0 +1,27 @@
+# <a name="PatternSkinCssCookbook Recipe: C"></a><a name=" _PatternSkinCssCookbook Recipe:"></a> [[PatternSkinCssCookbook]] Recipe: Center the page with a border
+
+**This recipe shows how to put a border around the page, while centering the page horizontally.** The example on this page uses a gradient image as background - on top of a gray base color. You can choose to set no image of course.
+
+<div> This line loads the extra style definition: <pre>
+   * Set USERSTYLEURL = %ATTACHURL%/centerpageborder.css
+</pre> You can write this line in [[TWiki/TWikiPreferences]], in [[Main/WebPreferences]], in your user topic or on a single page. </div>
+
+Add the dynamic variable link to the logo image to the topic text:
+
+    <style type="text/css" media="all">
+    html body {
+    background-image:url("%PUBURLPATH%/%TWIKIWEB%/PatternSkin/gradient_page.gif");
+    background-repeat:repeat-x;
+    }
+    #patternPageShadow {
+    background-image:url("%PUBURLPATH%/%TWIKIWEB%/PatternSkin/striped_pageshadow.gif");
+    }
+    </style>
+<div><img align="top" alt="info" border="0" height="16" src="http://www.dementia.org/twiki//view/Main/WebHome/info.gif" width="16" /> If you don't write this overloading style in a template and use an external <code>.css</code> file, you need to set the image to the absolute url: <pre>
+&lt;style type="text/css" media="all"&gt;
+html body {
+background-image:url("http://www.dementia.org/twiki//view/TWiki/PatternSkin/gradient_page.gif");
+background-repeat:repeat-x;
+}
+&lt;/style&gt;
+</pre> You can always write a <code>&lt;style&gt;</code> in a topic - all current browsers support this - but the page won't validate as valid XHTML. </div>
diff --git a/TWiki/PatternSkinCssCookbookEditTableStyle.mdwn b/TWiki/PatternSkinCssCookbookEditTableStyle.mdwn
new file mode 100644 (file)
index 0000000..eb7082d
--- /dev/null
@@ -0,0 +1,29 @@
+# <a name="PatternSkinCssCookbook Recipe:_E"></a><a name=" _PatternSkinCssCookbook Recipe:"></a> [[PatternSkinCssCookbook]] Recipe: [[EditTable|TWiki:Plugins/EditTablePlugin]] style
+
+**Cookbook example to illustrate control over EditTable edit styles.**
+
+1. EditTable uses a monospace font in edit mode to make the input text width correspond to the set width of the table columns. The attached example style makes the text more readable by changing the monospace font to a naturally spaced one.
+2. EditTable table cell content is vertically centered. The example style makes the content aligned at the top.
+3. The buttons at the bottom (in edit mode) are visually the same as other buttons on TWiki pages. The example style makes them more distinctive.
+4. The example style gives the input fields a background color so that they stand out more.
+
+Test table:
+
+<a name="edittable1"></a>
+
+<div>
+  <form action="http://www.dementia.org/twiki/viewauth#edittable1" method="post" name="edittable1"><input name="ettablenr" type="hidden" value="1" /> <input name="etedit" type="hidden" value="on" /><table border="1" cellpadding="0" cellspacing="0">
+      <tr>
+        <th bgcolor="#99CCCC"><strong> Head1 </strong></th>
+        <th bgcolor="#99CCCC"><strong> Head2 </strong></th>
+      </tr>
+      <tr>
+        <td><strong>Hamlet:</strong> So much for this, sir; now shall you see the other.<br />You do remember all the circumstance? </td>
+        <td><strong>Horatio:</strong> Remember it, my lord! </td>
+      </tr>
+    </table><input name="etrows" type="hidden" value="2" /> <input type="submit" value="Edit table" /></form>
+</div>
+
+<div> This line loads the extra style definition: <pre>
+   * Set USERSTYLEURL = %ATTACHURL%/edittable.css
+</pre> You can write this line in [[TWiki/TWikiPreferences]], in [[Main/WebPreferences]], in your user topic or on a single page. </div>
diff --git a/TWiki/PatternSkinCssCookbookFonts.mdwn b/TWiki/PatternSkinCssCookbookFonts.mdwn
new file mode 100644 (file)
index 0000000..de8e385
--- /dev/null
@@ -0,0 +1,7 @@
+# <a name="PatternSkinCssCookbook Recipe: F"></a><a name=" _PatternSkinCssCookbook Recipe:"></a> [[PatternSkinCssCookbook]] Recipe: Font variation
+
+**Cookbook example with other fonts and font colors.**
+
+<div> This line loads the extra style definition: <pre>
+   * Set USERSTYLEURL = %ATTACHURL%/fonts.css
+</pre> You can write this line in [[TWiki/TWikiPreferences]], in [[Main/WebPreferences]], in your user topic or on a single page. </div>
diff --git a/TWiki/PatternSkinCssCookbookNoLeftBar.mdwn b/TWiki/PatternSkinCssCookbookNoLeftBar.mdwn
new file mode 100644 (file)
index 0000000..d4432a9
--- /dev/null
@@ -0,0 +1,5 @@
+# <a name="PatternSkinCssCookbook Recipe: H"></a><a name=" _PatternSkinCssCookbook Recipe:"></a> [[PatternSkinCssCookbook]] Recipe: Hide the left bar
+
+<div> This line loads the extra style definition: <pre>
+   * Set USERSTYLEURL = %ATTACHURL%/hideleftbar_Dakar.css
+</pre> You can write this line in [[TWiki/TWikiPreferences]], in [[Main/WebPreferences]], in your user topic or on a single page. </div>
diff --git a/TWiki/PatternSkinCssCookbookNoTopBar.mdwn b/TWiki/PatternSkinCssCookbookNoTopBar.mdwn
new file mode 100644 (file)
index 0000000..db172d5
--- /dev/null
@@ -0,0 +1,18 @@
+# <a name="PatternSkinCssCookbook Recipe: H"></a><a name=" _PatternSkinCssCookbook Recipe:"></a> [[PatternSkinCssCookbook]] Recipe: Hide the top bar
+
+**This recipe shows how to hide the top bar and to put the logo in the left bar.**
+
+<div> This line loads the extra style definition: <pre>
+   * Set USERSTYLEURL=%ATTACHURL%/notopbar.css
+</pre> You can write this line in [[TWiki/TWikiPreferences]], in [[Main/WebPreferences]], in your user topic or on a single page. </div>
+
+Add the dynamic variable link to the logo image to the topic text:
+
+    <style type="text/css" media="all">
+    #patternLeftBar { background-image:url("%PUBURLPATH%/%WEB%/%WEBPREFSTOPIC%/logo.gif"); }
+    </style>
+<div><img align="top" alt="info" border="0" height="16" src="http://www.dementia.org/twiki//view/Main/WebHome/info.gif" width="16" /> If you don't write this overloading style in a template and use an external <code>.css</code> file, you need to set the image to the absolute url: <pre>
+&lt;style type="text/css" media="all"&gt;
+#patternLeftBar { background-image:url("http://www.dementia.org/twiki//view/%WEB%/WebPreferences/logo.gif"); }
+&lt;/style&gt;
+</pre> You can always write a <code>&lt;style&gt;</code> in a topic - all current browsers support this - but the page won't validate as valid XHTML. </div>
index 7834a76..e69de29 100644 (file)
@@ -1,242 +0,0 @@
-# <a name="Customization of _PatternSkin"></a><a name=" Customization of _PatternSkin"></a> Customization of PatternSkin
-
-This page describes ways to change the layout, fonts and colors of [[PatternSkin]].
-
-<div><span>Page contents:</span><ul>
-    <li><a href="#Your own TWiki look"> Your own TWiki look</a></li>
-    <li><a href="#Screen parts"> Screen parts</a><ul>
-        <li><a href="#Top bar"> Top bar</a></li>
-        <li><a href="#Left bar"> Left bar</a><ul>
-            <li><a href="#Putting the left bar at the righ"> Putting the left bar at the right</a></li>
-          </ul>
-        </li>
-        <li><a href="#Bottom bar"> Bottom bar</a></li>
-      </ul>
-    </li>
-    <li><a href="#Customizing the logo"> Customizing the logo</a></li>
-    <li><a href="#Fonts"> Fonts</a><ul>
-        <li><a href="#Font style"> Font style</a></li>
-        <li><a href="#Font size"> Font size</a></li>
-      </ul>
-    </li>
-    <li><a href="#Colors"> Colors</a></li>
-    <li><a href="#Tables"> Tables</a><ul>
-        <li><a href="#Tables in topic text"> Tables in topic text</a><ul>
-            <li><a href="#Topic text table example"> Topic text table example</a></li>
-          </ul>
-        </li>
-        <li><a href="#Attachment table, Form table"> Attachment table, Form table</a></li>
-        <li><a href="#Other templates"> Other templates</a></li>
-      </ul>
-    </li>
-  </ul>
-</div>
-
-## <a name="Your own TWiki look"></a> Your own TWiki look
-
-You can easily create your own TWiki look by attaching modified css files to your home page:
-
-- If you want to change the layout of the page, download layout.css from [[PatternSkin]]
-- If you want to change the spacing or colors, download style.css from [[PatternSkin]]
-- modify the CSS in either style sheet, using tips from this page
-- [attach](http://www.dementia.org/twiki//attach/Main/admin) your modified layout.css and/or style.css to your home page
-- as shown below, add the `USERLAYOUTURL` and `USERSTYLEURL` settings to [[your home page|Main/Admin]]
-
-       * Personal TWiki.PatternSkin CSS settings
-          * Set USERLAYOUTURL = %PUBURL%/%MAINWEB%/%WIKINAME%/layout.css
-          * Set USERSTYLEURL = %PUBURL%/%MAINWEB%/%WIKINAME%/style.css
-
-## <a name="Screen parts"></a> Screen parts
-
-The PatternSkin view template uses four screen parts:
-
-- The topic part - contains besides the topic content: action buttons, form table, attachment table, topic info
-- Top bar - used for a logo, contains Go box
-- Left bar - site and web navigation, contains a personal link block; may contain a Go box
-- Bottom bar - copyright, disclaimer
-
-These parts are dynamically included topics:
-
-- Top bar: [[WebTopBar]]
-- Left bar: included topic [[WebLeftBar]] (one WebLeftBar topic per web)
-  - Personal links block: Main.%USERNAME%LeftBar. Your own personal leftbar: Main.adminLeftBar
-- Bottom bar: included topic [[WebBottomBar]]
-
-### <a name="Top bar"></a> Top bar
-
-The top bar is mainly used as branding space. To change the screen room for the logo, see below, [[Customizing the logo|Main/TOPIC#Customizing_the_logo]].
-
-### <a name="Left bar"></a> Left bar
-
-The menu items are css-formatted bullet lists. So in [[WebLeftBar]] you write:
-
-       * *Group*
-       * [[SomeTopic][Link 1]]
-       * [[AnotherTopic][Link 2]]
-       * [[ThirdTopic][Link 3]]
-
-The left bar may contain a Go box instead of the top bar. Use:
-
-       * <input type="text" name="topic" size="16" />
-
-The personal left bar block is formatted like the rest of the left bar.
-
-#### <a name="Putting the left bar at the righ"></a> Putting the left bar at the right
-
-If you have a low screen resolution of say, 640 by 480 pixels, it can be useful to put the left bar "out of the way", at the right side of the page - at the cost of a horizontal scroll bar to access the left (now right) bar. This CSS does this:
-
-> Add this to layout.css:
->
->     .twikiMain {
->        margin-left:0px;
->     }
->     .twikiLeftBar {
->        margin-left:100%;
->     }
->     .twikiBottomBar {
->        margin-left:1em;
->        margin-right:0;
->        padding:0;
->     }
->
-> Add this to style.css:
->
->     .twikiMain {
->        padding-left:1em;
->        padding-right:1em;
->     }
->     .twikiBottomBarContents {
->        padding-left:0em;
->     }
-
-This CSS is also attached to this topic, [LowRes.css](http://www.dementia.org/twiki//view/LowRes.css). To use this style, add this to your home page:
-
-       * Personal TWiki.PatternSkin CSS settings
-          * Set USERLAYOUTURL = %PUBURL%/%SYSTEMWEB%/PatternSkinCustomization/LowRes.css
-
-### <a name="Bottom bar"></a> Bottom bar
-
-The bottom bar contains the copyright disclaimer, but may contain other information, perhaps a web list.
-
-## <a name="Customizing the logo"></a> Customizing the logo
-
-The top bar is 60 pixels high, and has a padding of 5 pixels on top, bottom and left, so the logo should be 50 pixels high. If your logo image has a different size, you can either alter the padding in `style.css` (.twikiTopBarContents) or change the top bar height in `layout.css` (look for the comment _setting the height of the top bar_).
-
-You can also choose to set a background image for the top bar. In `style.css`, add this to .twikiTopBar:
-
-       background-position:top left;
-       background-attachment:fixed;
-       background-repeat:no-repeat;
-       background-image:url(http://absolute_path_to_your_image);
-
-and set the correct image file path.
-
-## <a name="Fonts"></a> Fonts
-
-### <a name="Font style"></a> Font style
-
-Font styles are defined in `style.css` in these places:
-
-    html body {
-       font-family:"Lucida Grande", verdana, lucida, helvetica, sans-serif;
-    }
-    h1, h2, h3, h4, h5, h6 {
-       font-family:"Lucida Grande", helvetica, lucida, verdana, sans-serif;
-    }
-    textarea {
-       font-family:monospace;
-    }
-    input, select {
-       font-family:verdana,arial,sans-serif;
-    }
-    .twikiSeparator {
-       font-family:Arial,sans-serif;
-    }
-    .twikiEditPage .twikiSig input {
-       font-family:monospace;
-    }
-
-### <a name="Font size"></a> Font size
-
-Font sizes in PatternSkin are scalable. This means that even on Windows Explorer, the text in the browser can scale with the user settings (in contrast to many sites where texts have a fixes pixel size, these cannot be changed by the user).
-
-Scalable text is a big accessibility asset. If you notwithstanding want to have a fixed font, or if you want to set the default size smaller or bigger, the easiest way is to make a new entry for body, below the 2 other entries:
-
-    html body {
-       ... (keep)
-    }
-    html>body {
-       ... (keep)
-    }
-    html body {
-       font-size:11px;
-    }
-
-## <a name="Colors"></a> Colors
-
-<span> </span><span> </span><span> </span><span> </span><span> </span><span> </span><span> </span><span> </span><span> </span><span> </span><span> </span><span> </span><span> </span><span> </span><span> </span><span> </span><span> </span><span> </span><span> </span><span> </span><span> </span><span> </span><span> </span><span> </span><span> </span><span> </span><span> </span><span> </span><span> </span><span> </span><span> </span><span> </span><span> </span><span> </span><span> </span><span> </span><span> </span><span> </span><span> </span><span> </span><span> </span><span> </span><span> </span><span> </span><span> </span><span> </span><span> </span><span> </span>
-
-To create a customised palette of colors, see [[PatternSkinPalette]].
-
-## <a name="Tables"></a> Tables
-
-### <a name="Tables in topic text"></a> Tables in topic text
-
-If you have [[TablePlugin]] installed, tables in topics take on the properties from `TABLEATTRIBUTES`. Without [[TablePlugin]] (if not installed, or disabled in [[TWikiPreferences]] under `DISABLEDPLUGINS`), the tables have a default appearance that is hardcoded in Render.pm. Styles of topic text tables are not set in a style sheet. If you want to have control over the design of tables, for instance if you work with a style guide, you should add table styles under `.twikiTopic`. See for an example below.
-
-#### <a name="Topic text table example"></a> Topic text table example
-
-This is an example css to give tables in topic text a similar appearance. This will override settings in [[TablePlugin]]. This code should be added below the other `.twikiTopic` code in style.css:
-
-    .twikiTopic table {
-       border-collapse:collapse;
-       padding:0px;
-       border-spacing:0px;
-       empty-cells:show;
-       border:0px;
-    }
-    .twikiTopic table th {
-       background-color:#ccc;
-       padding:0.5em 1em;
-    }
-    .twikiTopic table td {
-       border:1px solid #eee;
-    }
-    /* override hardcoded font color */
-    .twikiTopic table font {
-       color:#1e5bbd;
-    }
-    .twikiTopic table th a:link,
-    .twikiTopic table th a:visited {
-       color:#1e5bbd;
-       text-decoration:none;
-    }
-    /* don't show hover background color because we have a table header background */
-    .twikiTopic table th a:hover {
-       background-color:transparent;
-       text-decoration:underline;
-       border-width:1px;
-    }
-    /* no underline if a sort indicator (line) is displayed */
-    .twikiTopic table th.twikiSortedDescendingCol a:hover,
-    .twikiTopic table th.twikiSortedAscendingCol a:hover {
-       text-decoration:none;
-    }
-    /* hide sort icons */
-    .twikiTopic table th img,
-    .twikiTopic table th a:link img,
-    .twikiTopic table th a:visited img {
-       display:none;
-    }
-
-### <a name="Attachment table, Form table"></a> Attachment table, Form table
-
-The appearance of the form table and the attachment table are set in style.css under `.twikiForm` and `.twikiAttachments`. Text in these tables is set to wrap, so often the dates are wrapped to two lines. If you prefer to have text on one line and are not disturbed by an extra wide attachment table (or when you screen resolution is big enough), add this code to `.twikiAttachments td, .twikiForm td {`:
-
-       white-space:nowrap;
-
-### <a name="Other templates"></a> Other templates
-
-Other templates than `view` use the style `.twikiVersatileTable` for, as the name says, tables with versatile functions. Versatile tables appear a little diffent in each template page (differences are created using multiple classes). Versatile tables are mostly used to format forms to highlight important parts and to dim less important parts. See `style.css` for specific settings for each template.
-
--- TWiki:Main.ArthurClemens - 28 Aug 2004
index 5aa960c..587370c 100644 (file)
@@ -1,3 +1,3 @@
-Peter Thoeny is the author of TWiki and therefore a TWiki:Codev/CoreTeam member and a [[TWikiContributor]].
+Peter Thoeny is the founder of TWiki and TWiki.org, is a [[Core Team|TWiki:Codev/CoreTeam]] member, and a [[TWikiContributor]].
 
-See home page at TWiki:Main/%TOPIC%
+See home page at TWiki:Main.PeterThoeny
index fc122f0..71afa55 100644 (file)
@@ -1,6 +1,6 @@
 # <a name="Plain Skin"></a> Plain Skin
 
-The plain skin can be used to get the rendered topic text without any page decoration.
+The plain skin is used to get the rendered topic text without any page decoration such as side, top or bottom bars. For example, TWiki uses this skin for pop-up help windows. It also can be used to display topic content inside an [IFRAME](http://www.htmlhelp.com/reference/html40/special/iframe.html).
 
 This skin is part of every TWiki distribution.
 
@@ -9,29 +9,37 @@ This skin is part of every TWiki distribution.
 <table border="1" cellpadding="0" cellspacing="0">
   <tr>
     <td align="right"> Description: </td>
-    <td> The plain skin can be used to get the rendered topic text without any page decoration </td>
+    <td> Shows rendered topic text without any page decoration </td>
   </tr>
   <tr>
     <td align="right"> Screenshot: </td>
     <td><a href="http://www.dementia.org/twiki//view/fullscreen.gif"><img alt="Click for full screen image" height="130" src="http://www.dementia.org/twiki//view/screenshot.gif" width="600" /></a></td>
   </tr>
   <tr>
+    <td align="right"> Preview: </td>
+    <td>[[%WEB%/%TOPIC%?skin=plain]]</td>
+  </tr>
+  <tr>
     <td align="right"> Base Name: </td>
     <td> plain </td>
   </tr>
   <tr>
     <td align="right"> Skin Author: </td>
-    <td> TWiki:Main/PeterThoeny </td>
+    <td> TWiki:Main.PeterThoeny, TWiki:Main.CrawfordCurrie </td>
   </tr>
   <tr>
     <td align="right"> Skin Version: </td>
-    <td> 27 Jul 2004 (v1.000) </td>
+    <td> 04 Jan 2006 (v8096) </td>
   </tr>
   <tr>
     <td align="right"> Change History: </td>
     <td>  </td>
   </tr>
   <tr>
+    <td align="right"> 04 Jan 2006: </td>
+    <td> Dakar update (v8096) </td>
+  </tr>
+  <tr>
     <td align="right"> 27 Jul 2004: </td>
     <td> Initial version (v1.000) </td>
   </tr>
@@ -47,10 +55,12 @@ This skin is part of every TWiki distribution.
     <td align="right"> Feedback: </td>
     <td><a href="http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev" target="_top">http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev</a></td>
   </tr>
+  <tr>
+    <td align="right"> Appraisal: </td>
+    <td><a href="http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Appraisal" target="_top">http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Appraisal</a></td>
+  </tr>
 </table>
 
 **_Note:_** The Description, Screenshot and Base Name rows are needed by the [[TWikiSkinBrowser]]
 
-**_Related topic:_** [[TWikiSkins]], [[TWikiSkinBrowser]]
-
--- TWiki:Main/PeterThoeny - 27 Jul 2004
+**_Related topic:_** [[TWikiSkins]], [[TWikiSkinBrowser]], [[UserDocumentationCategory]], [[AdminDocumentationCategory]]
diff --git a/TWiki/PreferencesPlugin.mdwn b/TWiki/PreferencesPlugin.mdwn
new file mode 100644 (file)
index 0000000..b12f39c
--- /dev/null
@@ -0,0 +1,157 @@
+<form action="http://www.dementia.org/twiki/viewauth/Main/WebHome" enctype="multipart/form-data" method="post" name="editpreferences">
+  <p>
+  </p>
+  <h1><a name="%TOPIC%"></a><a name=" %TOPIC%"></a> %TOPIC% </h1>
+  <p> Allows editing of preferences using fields predefined in a [[TWiki/TWikiForms]]. However, the edit fields are inlined in the text, similar to how tables are edited in TWiki:Plugins/EditTablePlugin. </p>
+  <p>
+  </p>
+  <div>
+    <ul>
+      <li><a href="#Syntax Rules"> Syntax Rules</a></li>
+      <li><a href="#Examples"> Examples</a></li>
+      <li><a href="#Plugin Settings"> Plugin Settings</a></li>
+      <li><a href="#Plugin Installation Instructions"> Plugin Installation Instructions</a></li>
+      <li><a href="#Plugin Info"> Plugin Info</a></li>
+    </ul>
+  </div>
+  <p> Insert the <code>%EDITPREFERENCES%</code> variable (see below) anywhere in your topic. It will be replaced by a button that allows editing each preference in its predefined input format (or a text box, when no format is defined for this preference). </p>
+  <p> In edit mode, the edit button is replaced by save and cancel buttons, with their obvious meanings. </p>
+  <p>
+  </p>
+  <h2><a name="Syntax Rules"></a> Syntax Rules </h2>
+  <p>
+  </p>
+  <ul>
+    <li><code>%EDITPREFERENCES{ "</code> <em>topic</em> <code>" }%</code><ul>
+        <li><em>topic</em> references a [[TWiki/TWikiForms]] defining the format of the edit fields for preferences. It may be prefixed by a web. </li>
+        <li> If a preference setting is not mentioned in the form referenced by <em>topic</em>, a text input box of the specified length is provided. </li>
+        <li> Otherwise, the input can be through textareas, select, radio, checkbox, date, or text, as provided by [[TWiki/TWikiForms]]. </li>
+      </ul>
+    </li>
+  </ul>
+  <p>
+  </p>
+  <h2><a name="Examples"></a> Examples </h2>
+  <p>
+  </p>
+  <ul>
+    <li><code>%EDITPREFERENCES{ "%TWIKIWEB%.TWikiPreferencesForm" }%</code></li>
+  </ul>
+  <p>
+  </p>
+  <h2><a name="Plugin Settings"></a> Plugin Settings </h2>
+  <p> Plugin settings are stored as preferences variables. To reference a plugin setting write <code><b>%&lt;plugin&gt;_&lt;setting&gt;%</b></code>, i.e. <code><b>%PREFERENCESPLUGIN_SHORTDESCRIPTION%</b></code></p>
+  <p>
+  </p>
+  <ul>
+    <li> One line description, is shown in the [[TWiki/TextFormattingRules]] topic: <ul>
+        <li> Set SHORTDESCRIPTION = Allows editing of preferences using fields predefined in a form </li>
+      </ul>
+    </li>
+  </ul>
+  <p>
+  </p>
+  <h2><a name="Plugin Installation Instructions"></a> Plugin Installation Instructions </h2>
+  <p><strong><em>Note:</em></strong> You do not need to install anything on the browser to use this plugin. The following instructions are for the administrator who installs the plugin on the server where TWiki is running. </p>
+  <p>
+  </p>
+  <ul>
+    <li> Download the ZIP file from the Plugin web (see below) </li>
+    <li> Unzip <code><b>%TOPIC%.zip</b></code> in your twiki installation directory. Content: <table border="1" cellpadding="0" cellspacing="0">
+        <tr>
+          <th bgcolor="#99CCCC"><strong> File: </strong></th>
+          <th bgcolor="#99CCCC"><strong> Description: </strong></th>
+        </tr>
+        <tr>
+          <td><code><b>data/TWiki/%TOPIC%.txt</b></code></td>
+          <td> Plugin topic </td>
+        </tr>
+        <tr>
+          <td><code><b>data/TWiki/%TOPIC%.txt,v</b></code></td>
+          <td> Plugin topic repository </td>
+        </tr>
+        <tr>
+          <td><code><b>lib/TWiki/Plugins/%TOPIC%.pm</b></code></td>
+          <td> Plugin Perl module </td>
+        </tr>
+        <tr>
+          <td><code><b>data/TWiki/TWikiPreferencesForm.txt</b></code></td>
+          <td> Example form </td>
+        </tr>
+      </table>
+    </li>
+    <li> (Dakar) Visit <code>configure</code> in your TWiki installation, and enable the plugin in the {Plugins} section. </li>
+    <li> If the installation was successful, an edit button should appear below: <input name="prefsaction" type="submit" value="Edit" /></li>
+  </ul>
+  <p>
+  </p>
+  <h2><a name="Plugin Info"></a> Plugin Info </h2>
+  <p>
+  </p>
+  <table border="1" cellpadding="0" cellspacing="0">
+    <tr>
+      <td align="right"> Plugin Author: </td>
+      <td> TWiki:Main.ThomasWeigert </td>
+    </tr>
+    <tr>
+      <td align="right"> Plugin Version: </td>
+      <td> 08 May 2005 </td>
+    </tr>
+    <tr>
+      <td align="right"> Change History: </td>
+      <td>  </td>
+    </tr>
+    <tr>
+      <td align="right"> 26 May 2005: </td>
+      <td> Crawford Currie recoded to use code from Form.pm to render form fields. </td>
+    </tr>
+    <tr>
+      <td align="right"> 08 May 2005: </td>
+      <td> Add plugin preference to define default input length </td>
+    </tr>
+    <tr>
+      <td align="right"> 07 May 2005: </td>
+      <td> Initial version </td>
+    </tr>
+    <tr>
+      <td align="right"> TWiki Dependency: </td>
+      <td> $TWiki::Plugins::VERSION 1.026 </td>
+    </tr>
+    <tr>
+      <td align="right"> CPAN Dependencies: </td>
+      <td> none </td>
+    </tr>
+    <tr>
+      <td align="right"> Other Dependencies: </td>
+      <td> none </td>
+    </tr>
+    <tr>
+      <td align="right"> Perl Version: </td>
+      <td> 5.005 </td>
+    </tr>
+    <tr>
+      <td align="right"> License: </td>
+      <td> GPL (<a href="http://www.gnu.org/copyleft/gpl.html" target="_top">GNU General Public License</a>) </td>
+    </tr>
+    <tr>
+      <td align="right"> TWiki:Plugins/Benchmark: </td>
+      <td>[[TWiki/GoodStyle]] nn%, [[TWiki/FormattedSearch]] nn%, %TOPIC% nn% </td>
+    </tr>
+    <tr>
+      <td align="right"> Plugin Home: </td>
+      <td><a href="http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%" target="_top">http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%</a></td>
+    </tr>
+    <tr>
+      <td align="right"> Feedback: </td>
+      <td><a href="http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev" target="_top">http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev</a></td>
+    </tr>
+    <tr>
+      <td align="right"> Appraisal: </td>
+      <td><a href="http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Appraisal" target="_top">http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Appraisal</a></td>
+    </tr>
+  </table>
+  <p><strong><em>Related Topics:</em></strong> [[TWiki/TWikiPreferences]], [[TWiki/TWikiForms]]</p>
+  <p> -- TWiki:Main.ThomasWeigert - 08 May 2005 </p>
+  <p>
+  </p>
+</form>
index c95b9b8..826b78b 100644 (file)
@@ -1,10 +1,10 @@
-**Background Image for Preview**
+# <a name="Background Image for Preview"></a> Background Image for Preview
 
-Preview looks like the real page, but the links leed to an oops dialog warning users of not yet saved topics. In addition, a background with a "PREVIEW" watermark is shown to have visual clue that you are previewing a topic. You can change the background image by specifying the name of an attached background image file in the PREVIEWBGIMAGE variable in the [[TWikiPreferences]].
+Preview looks like the real page, but the links lead to an oops dialog warning users of not-yet-saved topics. In addition, a background with a "PREVIEW" watermark is shown to have visual clue that you are previewing a topic. You can change the background image by specifying the name of an attached background image file in the PREVIEWBGIMAGE variable in the [[TWikiPreferences]].
 
 Remarks:
 
 - You also could attach a new image file to this topic.
 - You can override the PREVIEWBGIMAGE preference variable in your personal home page.
 
--- TWiki:Main.PeterThoeny - 02 Oct 2000
+**_Related Topics:_** [[UserDocumentationCategory]], [[AdminDocumentationCategory]]
index c94cadc..75cf87a 100644 (file)
@@ -1,6 +1,6 @@
 # <a name="Print Skin"></a> Print Skin
 
-The print skin, useful to print pages with a small header and footer.
+The print skin, useful to print pages with a small header and footer. Other skins, such as [[PatternSkin]], may introduce their own print skin.
 
 This skin is part of every TWiki distribution.
 
@@ -9,13 +9,17 @@ This skin is part of every TWiki distribution.
 <table border="1" cellpadding="0" cellspacing="0">
   <tr>
     <td align="right"> Description: </td>
-    <td> The print skin, useful to print pages with a small header and footer </td>
+    <td> Useful to print pages with a small header and footer </td>
   </tr>
   <tr>
     <td align="right"> Screenshot: </td>
     <td><a href="http://www.dementia.org/twiki//view/fullscreen.gif"><img alt="Click for full screen image" height="130" src="http://www.dementia.org/twiki//view/screenshot.gif" width="600" /></a></td>
   </tr>
   <tr>
+    <td align="right"> Preview: </td>
+    <td>[[%WEB%/%TOPIC%?skin=print]]</td>
+  </tr>
+  <tr>
     <td align="right"> Base Name: </td>
     <td> print </td>
   </tr>
@@ -25,13 +29,17 @@ This skin is part of every TWiki distribution.
   </tr>
   <tr>
     <td align="right"> Skin Version: </td>
-    <td> 27 Jul 2004 (v1.000) </td>
+    <td> 04 Jan 2006 (v8096) </td>
   </tr>
   <tr>
     <td align="right"> Change History: </td>
     <td>  </td>
   </tr>
   <tr>
+    <td align="right"> 04 Jan 2006: </td>
+    <td> Dakar update (v8096) </td>
+  </tr>
+  <tr>
     <td align="right"> 27 Jul 2004: </td>
     <td> Initial version (v1.000) </td>
   </tr>
@@ -47,10 +55,12 @@ This skin is part of every TWiki distribution.
     <td align="right"> Feedback: </td>
     <td><a href="http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev" target="_top">http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev</a></td>
   </tr>
+  <tr>
+    <td align="right"> Appraisal: </td>
+    <td><a href="http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Appraisal" target="_top">http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Appraisal</a></td>
+  </tr>
 </table>
 
 **_Note:_** The Description, Screenshot and Base Name rows are needed by the [[TWikiSkinBrowser]]
 
-**_Related topic:_** [[TWikiSkins]], [[TWikiSkinBrowser]]
-
--- TWiki:Main/PeterThoeny - 27 Jul 2004
+**_Related topic:_** [[TWikiSkins]], [[TWikiSkinBrowser]], [[UserDocumentationCategory]], [[AdminDocumentationCategory]]
index 2b4438f..7e98eb2 100644 (file)
@@ -1,3 +1,3 @@
-Like Save but does not email people on the [[WebNotify]] notification list - same effect as checking "Minor changes, don't notify".
+Like Save but does not e-mail people on the [[WebNotify]] notification list - same effect as checking "Minor changes, don't notify".
 
--- TWiki:Main.RandyKramer - 15 Aug 2004
+**_Related Topics:_** [[UserDocumentationCategory]]
diff --git a/TWiki/RegistrationApprovals.mdwn b/TWiki/RegistrationApprovals.mdwn
new file mode 100644 (file)
index 0000000..3be756b
--- /dev/null
@@ -0,0 +1,9 @@
+This topic is a placeholder for registrations not yet completed.
+
+Attachments are made when people first register, held pending until the registration is confirmed and approved, and are removed when registration is completed.
+
+- - - Set ALLOWTOPICVIEW = [[TWikiAdminGroup]]
+    - Set ALLOWTOPICRENAME = [[TWikiAdminGroup]]
+    - Set ALLOWTOPICCHANGE = [[TWikiAdminGroup]]
+
+**_Related Topics:_** [[AdminToolsCategory]]
index 024b004..1467e5e 100644 (file)
@@ -128,3 +128,5 @@ Here is stuff for our UNIX freaks: (copied from 'man egrep')
 > Repetition takes precedence over concatenation, which in turn takes precedence over alternation. A whole subexpression may be enclosed in parentheses to override these precedence rules.
 >
 > The backreference \\n, where n is a single digit, matches the substring previously matched by the nth parenthesized subexpression of the regular expression.
+
+**_Related Topics:_** [[UserDocumentationCategory]]
diff --git a/TWiki/RenameWeb.mdwn b/TWiki/RenameWeb.mdwn
new file mode 100644 (file)
index 0000000..93c1483
--- /dev/null
@@ -0,0 +1,2 @@
+- <img src="http://www.dementia.org/twiki//view/Main/WebHome/move.gif" width="16" height="16" alt="move" /> **Rename, move or delete this web:**
+  - **[Rename/move/delete web...](http://www.dementia.org/twiki/rename/Main/WebHome?action=renameweb)**, looking for references in _all public webs_ - See also: [[ManagingWebs]]
index 7ffcb84..bc0d7da 100644 (file)
@@ -480,15 +480,19 @@ Plugin settings are stored as preferences variables. To reference a plugin setti
   </tr>
   <tr>
     <td align="right"> Plugin Version: </td>
-    <td> 21 Mar 2004 (V1.031) </td>
+    <td> 21 Nov 2004 (V1.032) </td>
   </tr>
   <tr>
     <td align="right"> Change History: </td>
     <td>  </td>
   </tr>
   <tr>
+    <td align="right"> 21 Nov 2004: </td>
+    <td> Added benchmarks (no code changes) </td>
+  </tr>
+  <tr>
     <td align="right"> 21 Mar 2004: </td>
-    <td> Internal change: Fixed inofficial function call </td>
+    <td> Internal change: Fixed unofficial function call </td>
   </tr>
   <tr>
     <td align="right"> 01 Mar 2004: </td>
@@ -527,6 +531,10 @@ Plugin settings are stored as preferences variables. To reference a plugin setti
     <td> 5.005 </td>
   </tr>
   <tr>
+    <td align="right"> TWiki:Plugins/Benchmark: </td>
+    <td>[[TWiki/GoodStyle]] 97%, [[TWiki/FormattedSearch]] 98%, [[Main/RenderListPlugin]] 93% </td>
+  </tr>
+  <tr>
     <td align="right"> Plugin Home: </td>
     <td><a href="http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%" target="_top">http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%</a></td>
   </tr>
@@ -534,8 +542,12 @@ Plugin settings are stored as preferences variables. To reference a plugin setti
     <td align="right"> Feedback: </td>
     <td><a href="http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev" target="_top">http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev</a></td>
   </tr>
+  <tr>
+    <td align="right"> Appraisal: </td>
+    <td><a href="http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Appraisal" target="_top">http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Appraisal</a></td>
+  </tr>
 </table>
 
 **_Related Topics:_** [[TWikiPreferences]], [[TWikiPlugins]], TWiki:Plugins/TreePlugin
 
--- TWiki:Main/PeterThoeny - 21 Mar 2004
+-- TWiki:Main/PeterThoeny - 21 Nov 2004
index 2d021e3..0449acf 100644 (file)
@@ -1,30 +1,25 @@
-<font>Request for reset of password</font><br />
+# <a name="Reset Password"></a> Reset Password
 
-Please only use this **ResetPassword** form in case you really forgot your password. Otherwise just change it using [[ChangePassword]]. Thank you.
+If you didn't forget your password, use [[ChangePassword]] to change it to a new one. Otherwise, use this form to get a new one e-mailed to you. Your [[LoginName]] is listed on [[TWikiUsers]].
 
-<form action="http://www.dementia.org/twiki//passwd/Main/WebHome" method="post" name="passwd">
+%X% **_Note_**: you **must** have at least one valid registered e-mail to be able to reset your password. If none of your registered e-mail addresses is valid, and you have forgotten your password, contact .
+
+<form action="http://www.dementia.org/twiki/passwd/Main/WebHome" method="post" name="passwd">
   <table border="1" cellpadding="0" cellspacing="0">
     <tr>
-      <td align="right"> Your [[TWiki/WikiName]]: </td>
-      <td><input name="username" size="40" type="text" value="" /> <code><font color="red">**</font></code></td>
-    </tr>
-    <tr>
-      <td align="right"> New password: </td>
-      <td><input name="password" size="40" type="password" /> <code><font color="red">**</font></code></td>
-    </tr>
-    <tr>
-      <td align="right"> Retype new password: </td>
-      <td><input name="passwordA" size="40" type="password" /> <code><font color="red">**</font></code></td>
-    </tr>
-    <tr>
-      <td align="right">  <input name="TopicName" type="hidden" value="%TOPIC%" /> <input name="installPasswd" type="hidden" value="requestReset" /></td>
-      <td><input type="submit" value=" Request password reset " />    (Fields marked <code><font color="red">**</font></code> are required) </td>
+      <td align="right"> Your [[TWiki/LoginName]]: </td>
+      <td><input name="LoginName" size="40" type="text" value="" /> <code><font color="red">**</font></code></td>
     </tr>
-  </table>
-</form>
+  </table><input name="action" type="hidden" value="resetPassword" /> <input name="TopicName" type="hidden" value="%TOPIC%" /> <input type="submit" value=" Request password reset " /></form>
+
+After submitting this form, you will receive an e-mail with your new, **system-generated** password, and a link to a page where you can change it.
 
-After submitting this form you will see a page with your **new password** appearing **encrypted**.
+If you continue to have problems, please e-mail for help.
 
-You will have to e-mail this information to the Wiki webmaster, , who will set your account to use the new password.
+**_Related Topics:_** [[UserDocumentationCategory]], [[AdminDocumentationCategory]]
 
-**_Note to administrator:_** The reset password form applies only if TWiki uses Basic Authentication, e.g. a `.htpassword` file managed by TWiki. It does not apply if you are using external authentication, such as an IT managed password system. (remove this note if you are using Basic Authentication; replace this topic with a note describing how to reset the password in your organization)
+<table bgcolor="yellow">
+  <tr>
+    <td><strong><em>Note to administrator:</em></strong> This form applies only if TWiki uses a {PasswordManager} that supports changing passwords (e.g. TWiki::Users::HtPasswdUser). Otherwise replace this topic with a note describing how to change the password in your organization). See [[Main/TWikiUserAuthentication]] for more information. </td>
+  </tr>
+</table>
index facf0e9..4d2d007 100644 (file)
@@ -4,8 +4,8 @@ I've problems with the WebSearch. There is no Search Result on any inquiry. By c
 
 ## <a name="Answer:"></a> Answer:
 
-That is an indication that %WIKITOOLNAME% can't find the `egrep` and `fgrep` commands on your system. Check the `$egrepCmd` and `$fgrepCmd` variables in `twiki/lib/TWiki.cfg`.
+That is an indication that %WIKITOOLNAME% can't find the `egrep` and `fgrep` commands on your system. Check the `{RCS}EgrepCmd}` and `{RCS}{FgrepCmd}` settings in [configure](http://www.dementia.org/twiki/configure).
 
 **_Back to:_** [[TWikiFAQ]]
 
--- TWiki:Main.PeterThoeny - 26 Jan 2001 <br />
+**_Related Topics:_** [[AdminDocumentationCategory]]
index 4a2f138..82e8f5f 100644 (file)
@@ -2,22 +2,17 @@
 
 <div>
   <ul>
-    <li><a href="#Basic Search Form"> Basic Search Form</a></li>
-    <li><a href="#Advanced Search Form"> Advanced Search Form</a></li>
+    <li><a href="#Search Pages"> Search Pages</a></li>
     <li><a href="#Formatted Searches"> Formatted Searches</a></li>
     <li><a href="#Search Preferences"> Search Preferences</a></li>
   </ul>
 </div>
 
-## <a name="Basic Search Form"></a> Basic Search Form
+## <a name="Search Pages"></a> Search Pages
 
-The [[WebSearch]] form offers basic search features:
+There are two search pages; [[WebSearch]] offers basic search features, while [[WebSearchAdvanced]] offers more control over searches.
 
-- Search field: Enter one or more keywords
-- All webs flag: Check the flag if you want to search all public webs, not just the current web
-- Scope: Select if you want to search the topic title, text body or both
-
-The search is keyword based like in a typical search engine:
+By default searches are keyword based like in a typical search engine:
 
 - Specify word(s) you want to find
 - Multiple words form an **AND** search, `intranet web service` returns all pages that have the three words anywhere in the page
@@ -30,19 +25,9 @@ The search is keyword based like in a typical search engine:
   - If you want to search for a word in the stop word list, prefix the word with a plus sign
 - **Example:** To search for all topics that contain `"SOAP"`, `"WSDL"`, a literal `"web service"`, but not `"shampoo"`,%BR% enter this: `soap +wsdl "web service" -shampoo`
 
-## <a name="Advanced Search Form"></a> Advanced Search Form
-
-The [[WebSearchAdvanced]] form offers more control over search.
-
-TWiki supports three types of searches:
-
-- `keyword`: The basic search type
-- `literal`: Simple search where text is searched literally
-- `regex`: A [[RegularExpression]] search for power users
-
-TWiki's regex search is a set of regular expression patterns:
+Regular expression search searches for a set of regular expression patterns:
 
-- Patterns are delimited by a semicolon
+- Patterns are separated by semicolons
 - An AND search is performed for the list of patterns
 - An exclamation point preceeding a pattern indicates an AND NOT search; use it to exclude a pattern, like `!web service`
 - If you want to search for a semicolon or an exclamation point, escape them with a leading backslash, like `\!shampoo`
@@ -50,14 +35,17 @@ TWiki's regex search is a set of regular expression patterns:
 
 ## <a name="Formatted Searches"></a> Formatted Searches
 
-You can embed a nicely [[formatted search|Main/FormattedSearch]] in a topic by using the `%SEARCH{}%` variable described in [[TWikiVariables]].
+You can embed a nicely [[formatted search|Main/FormattedSearch]] in a topic by using the `%SEARCH{}%` variable described in [[TWikiVariables#VarSEARCH]].
 
 ## <a name="Search Preferences"></a> Search Preferences
 
-The [[TWikiPreferences]] has these settings:
+[[TWikiPreferences]] defines these search preferences:
 
 - `SEARCHDEFAULTTTYPE`: Default search type for search forms which calls the `search` script
+  - Currently `%SEARCHDEFAULTTTYPE%`
 - `SEARCHVARDEFAULTTYPE`: Default search type for `%SEARCH{}` variable
-- `SEARCHSTOPWORDS`: List of stop words
+  - Currenty `%SEARCHVARDEFAULTTYPE%`
+- `SEARCHSTOPWORDS`: List of stop words (common words and characters to exclude from a keyword search)
+  - Currently `%SEARCHSTOPWORDS%`
 
--- TWiki:Main.PeterThoeny - 18 Jan 2004
+**_Related Topics:_** [[UserDocumentationCategory]]
diff --git a/TWiki/SearchPatternCookbook.mdwn b/TWiki/SearchPatternCookbook.mdwn
new file mode 100644 (file)
index 0000000..f5e51fa
--- /dev/null
@@ -0,0 +1,353 @@
+# <a name="Search Pattern Cookbook"></a><a name=" Search Pattern Cookbook"></a> Search Pattern Cookbook
+
+The Search function in TWiki is very powerful. Especially searches using a [[RegularExpression]] play an important part of tapping TWiki's full potential. Unfortunately [[RegularExpressions]] can be incredibly obscure to the uninitiated.
+
+Most people not familiar (enough) with Regular Expressions mostly cut and paste (and maybe tweak) from existing examples. This page intends to collect lots of examples together.
+
+<div>
+  <ul>
+    <li>
+      <ul>
+        <li><a href="#Pattern 1: Extract values from a"> Pattern 1: Extract values from a table</a><ul>
+            <li><a href="#Problem definition"> Problem definition</a></li>
+            <li><a href="#Solution"> Solution</a></li>
+          </ul>
+        </li>
+      </ul>
+    </li>
+    <li><a href="#TWiki Installation Error">TWiki Installation Error</a><ul>
+        <li><a href="#Pattern 2: List generated from f"> Pattern 2: List generated from form classification</a><ul>
+            <li><a href="#Problem"> Problem</a></li>
+            <li><a href="#Test case"> Test case</a></li>
+            <li><a href="#Solution"> Solution</a></li>
+          </ul>
+        </li>
+        <li><a href="#Pattern 3a: listbox with all use"> Pattern 3a: listbox with all user names</a><ul>
+            <li><a href="#Problem"> Problem</a></li>
+            <li><a href="#Solution"> Solution</a></li>
+          </ul>
+        </li>
+      </ul>
+    </li>
+    <li><a href="#TWiki Installation Error">TWiki Installation Error</a><ul>
+        <li><a href="#Pattern 3b: listbox with all use"> Pattern 3b: listbox with all user names - select multiple names</a><ul>
+            <li><a href="#Problem"> Problem</a></li>
+            <li><a href="#Solution"> Solution</a></li>
+            <li><a href="#Test case"> Test case</a></li>
+          </ul>
+        </li>
+      </ul>
+    </li>
+    <li><a href="#TWiki Installation Error">TWiki Installation Error</a><ul>
+        <li><a href="#Pattern 4: Extract the parent of"> Pattern 4: Extract the parent of a given topic</a><ul>
+            <li><a href="#Problem"> Problem</a></li>
+            <li><a href="#Solution"> Solution</a></li>
+            <li><a href="#Test Case"> Test Case</a></li>
+          </ul>
+        </li>
+        <li><a href="#Pattern 5: Search and display th"> Pattern 5: Search and display the home topics of public webs in a list</a><ul>
+            <li><a href="#Problem"> Problem</a></li>
+            <li><a href="#Solution"> Solution</a></li>
+            <li><a href="#Test case"> Test case</a></li>
+          </ul>
+        </li>
+      </ul>
+    </li>
+    <li><a href="#TWiki Installation Error">TWiki Installation Error</a><ul>
+        <li>
+          <ul>
+            <li><a href="#Alternative solution"> Alternative solution</a></li>
+          </ul>
+        </li>
+        <li><a href="#Pattern 6: Extract a value from"> Pattern 6: Extract a value from a bullet list</a><ul>
+            <li><a href="#Problem"> Problem</a></li>
+            <li><a href="#Solution"> Solution</a></li>
+            <li><a href="#Test case"> Test case</a></li>
+          </ul>
+        </li>
+      </ul>
+    </li>
+    <li><a href="#TWiki Installation Error">TWiki Installation Error</a><ul>
+        <li><a href="#Pattern 7: Search for Form and M"> Pattern 7: Search for Form and Meta data: explained</a><ul>
+            <li><a href="#Problem"> Problem</a></li>
+            <li><a href="#Solution"> Solution</a></li>
+          </ul>
+        </li>
+        <li><a href="#Pattern 8: Search all topics tha"> Pattern 8: Search all topics that have been moved</a><ul>
+            <li><a href="#Problem"> Problem</a></li>
+            <li><a href="#Solution"> Solution</a></li>
+          </ul>
+        </li>
+        <li><a href="#Contributors"> Contributors</a></li>
+      </ul>
+    </li>
+  </ul>
+</div>
+
+## <a name="Pattern 1: Extract values from a"></a> Pattern 1: Extract values from a table
+
+### <a name="Problem definition"></a> Problem definition
+
+Suppose there is a topic with a table defining entries in a TWikiForm. I.e. they define select menu items in a form template. They are then formatted like:
+
+    | *Name* | *Type* | *Tooltip message* |
+    | option1 | option | |
+    | option2 | option | |
+    | option3 | option | |
+
+How to extract the 'name' values, i.e. 'option1', 'option2' and 'option3' and put them in a HTML form select input?
+
+### <a name="Solution"></a> Solution
+
+The following search pattern can be employed:
+
+    <form>
+    <select>
+    %SEARCH{ "^\|[^\|]*\| *option *\|" topic="%TOPIC%" regex="on" multiple="on" nosearch="on" nototal="on" format="<option>$pattern(^\| *(.*?) *\|.*)</option>" }%
+    </select>
+    </form>
+
+which is, in effect:
+
+<form><select><h1><a name="TWiki Installation Error"></a> TWiki Installation Error </h1>Incorrect format of searchformat template (missing sections? There should be 4 %SPLIT% tags) </select></form>
+
+%BR%
+
+## <a name="Pattern 2: List generated from f"></a> Pattern 2: List generated from form classification
+
+### <a name="Problem"></a> Problem
+
+Imagine a TWiki form-based topic classification, i.e. every page has a form with several fields. How to:
+
+1. create a search to display all topics where one form field is set to a certain value
+2. create a search to filter the list above based on the values of a second form field
+
+### <a name="Test case"></a> Test case
+
+In practice: %BR% Image a TWiki form with two fields:
+
+- TopicClassification = One, Two or Three
+- TopicStatus = Test or Final
+
+We will:
+
+1. List all topics where the TopicClassification field is set to 'Two'
+2. Enable the user to filter this list based on the values of TopicStatus
+
+### <a name="Solution"></a> Solution
+
+    %SEARCH{"[T]opicClassification.*value\=.*Two;[T]opicStatus.*value\=.*%URLPARAM{type}%"
+    regex="on" casesensitive="on" nosearch="on"
+    format="   * $topic - <font face=\"arial,helvetica\" size=\"1\">
+    _last modified by_ $wikiusername _on_ $date </font> %BR% &nbsp;&nbsp;&nbsp;
+    <font face=\"arial,helvetica\" size=\"1\"> $formfield(TopicStatus) </font>"
+    sort="topic"}%
+
+The filtering select dialogue is created as in Pattern 1:
+
+    %STARTSIDEBAR%
+    *Filter:* %BR%
+    <form name="selectType" action="%SCRIPTURLPATH{"view"}%/%WEB%/" >
+    <select name="type" size="1" onchange="document.location=this.value;">
+    %SEARCH{ "^\|[^\|]*\| *option *\|" topic="TopicClassification" web="%WEB%" regex="on"
+    multiple="on" nosearch="on" nototal="on" format="<option value=%INCLUDINGTOPIC%?type=$pattern(^\| *(.*?) *\|.*)>$pattern(^\| *(.*?) *\|.*)</option>" }%
+    <option value=%INCLUDINGTOPIC%>All pages</option> </select>
+    </form>
+    %STOPSIDEBAR%
+
+This will create similar functionality as TWiki:Plugins.TopicClassificationAddOn %BR%
+
+## <a name="Pattern 3a: listbox with all use"></a> Pattern 3a: listbox with all user names
+
+### <a name="Problem"></a> Problem
+
+How to populate a list box with all usernames of registered TWiki users
+
+### <a name="Solution"></a> Solution
+
+    <form name="testing" action="%SCRIPTURLPATH{"view"}%/%MAINWEB%" method="get">
+    <select name="topic">
+    <option>Select user...</option>
+    %SEARCH{ "Name:;Email:;Country:" web="%MAINWEB%" type="regex" nosearch="on" nototal="on" format="<option>$topic</option>" }%
+    </select>
+    <input type="submit" value="Go" />
+    </form>
+
+Which expands to this: (here limited to all Z\* users because TWiki.org has so many)
+
+<form action="http://www.dementia.org/twiki/view/Main" method="get" name="testing"><select name="topic"><option>Select user...</option>
+    <h1><a name="TWiki Installation Error"></a> TWiki Installation Error </h1>Incorrect format of searchformat template (missing sections? There should be 4 %SPLIT% tags) </select> <input type="submit" value="Go" /></form>
+
+This searches all topics in the Main web that contain "Name", "Email" and "Country" bullets. Alternatively, do a [[FormattedSearch]] with `multiple="on"` on the [[Main.TWikiUsers|Main/TWikiUsers]] topic.
+
+## <a name="Pattern 3b: listbox with all use"></a> Pattern 3b: listbox with all user names - select multiple names
+
+### <a name="Problem"></a> Problem
+
+Suppose you want to send mail from a form on topic page to a selected list of **_multiple_** [[TWikiUsers]]
+
+### <a name="Solution"></a> Solution
+
+The example of Pattern 3a produces the list box. Add a MULTIPLE to the _select_ statement, i.e.:
+
+    <select name="topic" size="2" MULTIPLE>
+
+Please note that the Search pattern is unchanged compared to Pattern 3a. The change is in the HTML form element.
+
+### <a name="Test case"></a> Test case
+
+The Search pattern 3a with the abovementioned modification is, in effect:
+
+<form action="http://www.dementia.org/twiki/view/Main" method="get" name="testing"><select multiple="MULTIPLE" name="topic" size="2"><option>Select user...</option>
+    <h1><a name="TWiki Installation Error"></a> TWiki Installation Error </h1>Incorrect format of searchformat template (missing sections? There should be 4 %SPLIT% tags) </select> <input type="submit" value="Go" /></form>
+
+## <a name="Pattern 4: Extract the parent of"></a> Pattern 4: Extract the parent of a given topic
+
+### <a name="Problem"></a> Problem
+
+How to get to the parent of the current topic to display on the page?
+
+### <a name="Solution"></a> Solution
+
+You might think that the following Search would do the trick:
+
+    %SEARCH{ "^%BASETOPIC%$" scope="topic" nosearch="on" type="regex" nototal="on" format="[[$parent][parent_link]]" }%
+
+However, the `[[$parent][parent_link]]` link fails if the topic has no parent set (`$parent` will be empty). You can use some [[SpreadSheetPlugin]] magic to conditionally link to the parent or to `WebHome`: `[[$percntCALC{$IF($EXACT($parent,), %HOMETOPIC%, $parent)}$percnt][parent_link]]`
+
+So the total Search query to find a topic's parent topic is:
+
+    %SEARCH{ "^%BASETOPIC%$" scope="topic" nosearch="on" type="regex" nototal="on" format="[<nop>[$percntCALC{$IF($EXACT($parent,), <nop>%HOMETOPIC%, $parent)}$percnt][parent_link]]" }%
+
+### <a name="Test Case"></a> Test Case
+
+The parent topic of this topic is:
+
+# TWiki Installation Error
+
+Incorrect format of searchformat template (missing sections? There should be 4 %SPLIT% tags)
+
+## <a name="Pattern 5: Search and display th"></a> Pattern 5: Search and display the home topics of public webs in a list
+
+### <a name="Problem"></a> Problem
+
+How to find and display public webs in a drop down list box.
+
+### <a name="Solution"></a> Solution
+
+_Thanks to TWiki:Main.PeterThoeny for these solutions._
+
+    <form>
+    <select name="topic">
+    <option value="%TOPIC%">Select...</option>
+    %SEARCH{ "%HOMETOPIC%" scope="topic" web="all" topic="%HOMETOPIC%" format="<option value=\"$web.$topic\">$web</option>" separator=" " }%
+    </select>
+    <input type="submit"  value="Go" />
+    </form>
+
+### <a name="Test case"></a> Test case
+
+Public webs of TWiki.
+
+<form><select name="topic"><option value="%TOPIC%">Select...</option>
+    <h1><a name="TWiki Installation Error"></a> TWiki Installation Error </h1>Incorrect format of searchformat template (missing sections? There should be 4 %SPLIT% tags) </select> <input type="submit" value="Go" /></form>
+
+%T% For private webs, or any other webs you wish to exclude from the display, use "on" for the `Exclude web from a web="all" search` setting in the relevant web's WebPreferences topic.
+
+### <a name="Alternative solution"></a> Alternative solution
+
+This result can also be accomplished with the %WEBLIST% variable.
+
+<form><select name="topic"><option value="%TOPIC%">Select...</option>
+    <p>
+    </p></select> <input type="submit" value="Go" /></form>
+
+## <a name="Pattern 6: Extract a value from"></a><a name="Pattern 6: Extract a value from "></a> Pattern 6: Extract a value from a bullet list
+
+### <a name="Problem"></a> Problem
+
+Display the user name in the user's topic title
+
+### <a name="Solution"></a> Solution
+
+Search for the `Name:` entry.
+
+    %SEARCH{"   * [N]ame: " topic="%TOPIC%" regex="on" casesensitive="on" nosummary="on" nosearch="on" noheader="on" nototal="on" format="---+!! $pattern(.*   \* Name: ([^\n]*).*)"}%
+
+### <a name="Test case"></a> Test case
+
+To create a test case, we will put a name entry here:
+
+- Name: John Doe
+
+Search result:
+
+# <a name="TWiki Installation Error"></a> TWiki Installation Error
+
+Incorrect format of searchformat template (missing sections? There should be 4 %SPLIT% tags)
+
+## <a name="Pattern 7: Search for Form and M"></a> Pattern 7: Search for Form and Meta data: explained
+
+### <a name="Problem"></a> Problem
+
+Below is an example of a search that searches form data. The questions are:
+
+- why is this searching the metadata, shouldn't it just search the text?
+- what is the meaning of the `td..td` in the search expression?
+
+    %SEARCH{ "[S]tatus.*(td..td|value\=).*[W]aiting" casesensitive="on" regex="on"
+    nosearch="on" nototal="on" format="| [[$topic]]<br /> ($date - $rev -
+    [[%SCRIPTURLPATH{rdiff}%/$web/$topic][Diffs]]) |"}%
+
+### <a name="Solution"></a> Solution
+
+%SEARCH depends on grep, and grep searches the whole file, including the meta data.
+
+An example meta data form field is:
+
+    %META:FIELD{name="OperatingSystem" title="OperatingSystem" value="OsWin"}%
+
+So a search for a form field could look like:
+
+    %SEARCH{ "[O]peratingSystem.*value\=.*[O]sWin" regex="on" ... }%
+
+- Using square brackets is a trick to avoid a hit on the topic doing the search.
+- The `.*` indicate that there can be any number of any character between `OperatingSystem` and `value` in the (whole) file
+
+Now the original file format of the category table (the predecessor of the TWiki forms) looks like this:
+
+    <td valign="top" align="right"> OperatingSystem:  </td><td>  OsWin </td>
+
+The following search finds topics in the old and new format:
+
+    %SEARCH{ "[O]peratingSystem.*(td..td|value\=).*[O]sWin" regex="on" ... }%
+
+The `td..td` matches `td<>td`; a simple search on `"[O]peratingSystem.*[O]sWin"` could find a hit in the topic text by coincidence.
+
+A simple `%SEARCH{ "[O]peratingSystem.*value\=.*[O]sWin" ...}%` search is sufficient if you do not have topics in the old format.
+
+## <a name="Pattern 8: Search all topics tha"></a> Pattern 8: Search all topics that have been moved
+
+### <a name="Problem"></a> Problem
+
+How would I go about listing all moved topics ?
+
+### <a name="Solution"></a> Solution
+
+Search for the META:TOPICMOVED meta data. Type this:
+
+`Moved topics: %SEARCH{ "%META\:TOPICMOVED" regex="on" format="$topic, " nosearch="on" noheader="on" nosummary="on" }%`
+
+to get this (limited to 10 results):
+
+Moved topics:
+
+# TWiki Installation Error
+
+Incorrect format of searchformat template (missing sections? There should be 4 %SPLIT% tags)
+
+## <a name="Contributors"></a> Contributors
+
+TWiki:Main.AntonAylward, TWiki:Main.ArthurClemens, TWiki:Main.JosMaccabiani, TWiki:Main.PeterThoeny, TWiki:Main.SueLocke
+
+**_Related Topics:_** [[UserDocumentationCategory]]
index d4a8d6c..89797f2 100644 (file)
@@ -4,8 +4,10 @@ What happens if two of us try to edit the same topic simultaneously?
 
 ## <a name="Answer:"></a> Answer:
 
-The second person gets a warning that the topic is currently being edited by another user. A topic gets locked automatically for some time (default is one hour) when you edit, preview or save the topic. If you get the lock warning you should wait until the lock is gone or contact the other person to ask if you can go ahead and break the lock. See also [[UnlockTopic]].
+TWiki allows multiple simultaneous edits of the same topic, and then merges the different changes automatically. You probably won't even notice this happening unless there is a conflict that cannot be merged automatically. In this case, you may see TWiki inserting "change marks" into the text to highlight conflicts between your edits and another person's. These change marks are only used if you edit the same part of a topic as someone else, and they indicate what the text used to look like, what the other person's edits were, and what your edits were.
+
+TWiki will warn if you attempt to edit a topic that someone else is editing. It will also warn if a merge was required during a save.
 
 **_Back to:_** [[TWikiFAQ]]
 
--- TWiki:Main.PeterThoeny - 27 Nov 2000
+**_Related Topics:_** [[UserDocumentationCategory]]
diff --git a/TWiki/SiteChanges.mdwn b/TWiki/SiteChanges.mdwn
new file mode 100644 (file)
index 0000000..f3a6bc6
--- /dev/null
@@ -0,0 +1,13 @@
+## <a name="25 most recent topic changes in"></a><a name="25 most recent topic changes in "></a> 25 most recent topic changes in all webs
+
+<table border="1" cellpadding="0" cellspacing="0" style="border-width: 1px">
+  <tr>
+    <th bgcolor="#6b7f93" maxcols="0" style=""><a href="http://localhost?sortcol=0;table=1;up=0#sorted_table" rel="nofollow" title="Sort by this column"><font color="#ffffff">Last Modified</font></a></th>
+    <th bgcolor="#6b7f93" maxcols="0" style=""><a href="http://localhost?sortcol=1;table=1;up=0#sorted_table" rel="nofollow" title="Sort by this column"><font color="#ffffff">Web.Topic</font></a></th>
+    <th bgcolor="#6b7f93" maxcols="0" style=""><a href="http://localhost?sortcol=2;table=1;up=0#sorted_table" rel="nofollow" title="Sort by this column"><font color="#ffffff">Last Editor</font></a></th>
+  </tr>
+</table>
+
+# <a name="TWiki Installation Error"></a> TWiki Installation Error
+
+Incorrect format of searchformat template (missing sections? There should be 4 %SPLIT% tags)
index 4a07ef5..d5ed475 100644 (file)
@@ -11,7 +11,7 @@
       <h1><a name="TWiki Installation Error"></a> TWiki Installation Error </h1>Incorrect format of searchformat template (missing sections? There should be 4 %SPLIT% tags) </td>
   </tr>
   <tr bgcolor="#ffffff">
-    <td colspan="3"><font size="-1">You can use color coding by web for identification and reference. This table is updated automatically based on WebPreferences settings of the individual webs. Contact if you need a separate collaboration web for your team. See also [[Main/AdminTools]]. </font></td>
+    <td colspan="3"><font size="-1">You can use color coding by web for identification and reference. This table is updated automatically based on WebPreferences settings of the individual webs. Contact if you need a separate collaboration web for your team. See also [[Main/AdminToolsCategory]]. </font></td>
   </tr>
 </table>
 <table border="0" cellpadding="3" cellspacing="2">
diff --git a/TWiki/SitePermissions.mdwn b/TWiki/SitePermissions.mdwn
new file mode 100644 (file)
index 0000000..8564758
--- /dev/null
@@ -0,0 +1,35 @@
+# <a name="Permissions settings of the webs"></a> Permissions settings of the webs on this TWiki site
+
+<table border="1" cellpadding="0" cellspacing="0">
+  <tr>
+    <th bgcolor="#99CCCC"><strong> Web </strong></th>
+    <th bgcolor="#99CCCC"><strong> Sitemap </strong></th>
+    <th bgcolor="#99CCCC" colspan="2"><strong> VIEW </strong></th>
+    <th bgcolor="#99CCCC" colspan="2"><strong> CHANGE </strong></th>
+    <th bgcolor="#99CCCC" colspan="2"><strong> RENAME </strong></th>
+  </tr>
+  <tr>
+    <td> ^ </td>
+    <th bgcolor="#99CCCC"><strong> Listed </strong></th>
+    <th bgcolor="#99CCCC"><strong> DENY </strong></th>
+    <th bgcolor="#99CCCC"><strong> ALLOW </strong></th>
+    <th bgcolor="#99CCCC"><strong> DENY </strong></th>
+    <th bgcolor="#99CCCC"><strong> ALLOW </strong></th>
+    <th bgcolor="#99CCCC"><strong> DENY </strong></th>
+    <th bgcolor="#99CCCC"><strong> ALLOW </strong></th>
+  </tr>
+</table>
+
+# <a name="TWiki Installation Error"></a> TWiki Installation Error
+
+Incorrect format of searchformat template (missing sections? There should be 4 %SPLIT% tags)
+
+See [[TWikiAccessControl]] for details
+
+**_Please Note:_**
+
+- A blank in the the above table may mean _either_ the corresponding control is absent or commented out _or_ that it has been set to a null value. The two conditions have dramatically different and possibly opposed semantics.
+- [[TWikiGuest]] is the guest account - used by unauthenticated users.
+- The TWiki web must not deny view to [[TWikiGuest]]; otherwise, people will not be able to register.
+
+**_Related Topics:_** [[SiteMap]], [[UserDocumentationCategory]], [[AdminDocumentationCategory]], [[AdminToolsCategory]]
index 20675d4..b1fde15 100644 (file)
@@ -69,6 +69,10 @@ To create your own template topic, copy the "Default Slide Template" section bel
     <td> The text of the slide </td>
   </tr>
   <tr>
+    <td><code>%SLIDECOMMENT%</code></td>
+    <td> The comment of the slide (optional; appended to slide of missing) </td>
+  </tr>
+  <tr>
     <td><code>%SLIDENUM%</code></td>
     <td> The current slide number </td>
   </tr>
@@ -215,6 +219,7 @@ The part between the rulers defines the default format of a slide:
     <td> Various button image files </td>
   </tr>
 </table>
+- (Dakar) Visit `configure` in your TWiki installation, and enable the plugin in the \{Plugins\} section.
 - Test above example if the installation was successful.
 
 ## <a name="Plugin Info"></a> Plugin Info
@@ -226,15 +231,23 @@ The part between the rulers defines the default format of a slide:
   </tr>
   <tr>
     <td align="right"> Plugin Version: </td>
-    <td> 21 Mar 2004 (V1.003) </td>
+    <td> 1.005 </td>
   </tr>
   <tr>
     <td align="right"> Change History: </td>
     <td>  </td>
   </tr>
   <tr>
+    <td align="right"> 16 Mar 2005: </td>
+    <td> 1.005 Crawford Currie prepped for Dakar, and fixed multiple evaluation bug </td>
+  </tr>
+  <tr>
+    <td align="right"> 21 Nov 2004: </td>
+    <td> 1.004 Added support for <code>%SLIDECOMMENT%</code> template keyword (TWiki:Main/ArthurClemens); added benchmarks </td>
+  </tr>
+  <tr>
     <td align="right"> 21 Mar 2004: </td>
-    <td> Internal change: Fixed inofficial function call </td>
+    <td> Internal change: Fixed unofficial function call </td>
   </tr>
   <tr>
     <td align="right"> 14 Dec 2002: </td>
@@ -265,6 +278,10 @@ The part between the rulers defines the default format of a slide:
     <td> 5.005 </td>
   </tr>
   <tr>
+    <td align="right"> TWiki:Plugins/Benchmark: </td>
+    <td>[[TWiki/GoodStyle]] 98%, [[TWiki/FormattedSearch]] 99%, [[Main/SlideShowPlugin]] 99% </td>
+  </tr>
+  <tr>
     <td align="right"> Plugin Home: </td>
     <td><a href="http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%" target="_top">http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%</a></td>
   </tr>
@@ -272,8 +289,10 @@ The part between the rulers defines the default format of a slide:
     <td align="right"> Feedback: </td>
     <td><a href="http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev" target="_top">http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev</a></td>
   </tr>
+  <tr>
+    <td align="right"> Appraisal: </td>
+    <td><a href="http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Appraisal" target="_top">http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Appraisal</a></td>
+  </tr>
 </table>
 
 **_Related Topics:_** [[TWikiPreferences]], [[TWikiPlugins]]
-
--- TWiki:Main.PeterThoeny - 21 Mar 2004
index 2f1263e..7551f8d 100644 (file)
@@ -146,9 +146,9 @@ Here is the list of smilies supported by this plugin. To add others, attach new
     <td> "in love" </td>
   </tr>
   <tr>
-    <td> :scull: </td>
-    <td><img alt="scull.gif" src="http://www.dementia.org/twiki//view/scull.gif" /></td>
-    <td> "scull" </td>
+    <td> :skull: </td>
+    <td><img alt="skull.gif" src="http://www.dementia.org/twiki//view/skull.gif" /></td>
+    <td> "skull" </td>
   </tr>
 </table>
 
@@ -157,20 +157,19 @@ Here is the list of smilies supported by this plugin. To add others, attach new
 Plugin settings are stored as preferences variables. To reference a plugin setting write <code>**%&lt;plugin&gt;\_&lt;setting&gt;%**</code>, for example, <code>**%INTERWIKIPLUGIN\_SHORTDESCRIPTION%**</code>
 
 - One line description, shown in the [[TextFormattingRules]] topic:
-  - Set SHORTDESCRIPTION = Render smilies as icons, like ` :-)` for :-) or ` :cool:` for :cool:
-
-- Set DEBUG to 1 to get debug messages in `data/debug.txt`. Default: `0`
-  - Set DEBUG = 0
+- Set SHORTDESCRIPTION = Render smilies as icons, like ` :-)` for :-) or ` :cool:` for :cool:
 
 - The name of the topic containig your Smilies. Default: <code>**%WEB%.SmiliesPlugin**</code>
-  - #Set TOPIC = [[SmiliesPlugin]]
+- #Set TOPIC = [[SmiliesPlugin]]
 
 - The way the _emoticon_ is displayed. You can use <code>**$emoticon**</code> (e.g. `:D`), <code>**$url**</code> (e.g. `%ATTACHURL%/biggrin.gif`) and <code>**$tooltip**</code> (e.g. `"big grin"`). Default: <code>**&lt;img src="$url" alt="$tooltip" title="$tooltip" border="0" /&gt;**</code>
 
-          * #Set FORMAT = <img src="$url" alt="$emoticon" title="$emoticon" border="0" />
+       * #Set FORMAT = <img src="$url" alt="$emoticon" title="$emoticon" border="0" />
 
 ## <a name="Plugin Installation Instructions"></a> Plugin Installation Instructions
 
+This plugin is installed by default with a TWiki release. You should not need to install the plugin unless it is for an upgrade.
+
 - Download the ZIP file from the Plugin web (see below)
 - Unzip <code>**%TOPIC%.zip**</code> in your twiki installation directory. Content: <table border="1" cellpadding="0" cellspacing="0">
   <tr>
@@ -194,8 +193,9 @@ Plugin settings are stored as preferences variables. To reference a plugin setti
     <td> Plugin icon files </td>
   </tr>
 </table>
+- (Dakar) Visit `configure` in your TWiki installation, and enable the plugin in the \{Plugins\} section.
 - Test if the plugin is correctly installed:
-  - You will see a series of icons on next line: <br /> :-) :) :cool: :( :o :D ;) :p :rolleyes: :mad: :eek: :confused: &gt;:-) &gt;;-) :-X :ok: :yes: :no: :love: :scull:
+- You will see a series of icons on next line: <br /> :-) :) :cool: :( :o :D ;) :p :rolleyes: :mad: :eek: :confused: &gt;:-) &gt;;-) :-X :ok: :yes: :no: :love: :skull:
 
 ## <a name="Plugin Info"></a> Plugin Info
 
@@ -206,15 +206,27 @@ Plugin settings are stored as preferences variables. To reference a plugin setti
   </tr>
   <tr>
     <td align="right"> Plugin Version: </td>
-    <td> 21 Aug 2004 (v1.003) </td>
+    <td> 1.004 </td>
   </tr>
   <tr>
     <td align="right"> Change History: </td>
     <td>  </td>
   </tr>
   <tr>
+    <td align="right"> 16 Mar 2005: </td>
+    <td> Fixed typo "scull" </td>
+  </tr>
+  <tr>
+    <td align="center"> 5 Mar 2005 </td>
+    <td> 1.004 Crawford Currie prepared for Dakar </td>
+  </tr>
+  <tr>
+    <td align="right"> 21 Nov 2004: </td>
+    <td> Added benchmarks (no code changes) </td>
+  </tr>
+  <tr>
     <td align="right"> 21 Aug 2004: </td>
-    <td> Fixed tooltip for Netscape; added "sealed lips", "thumbs up", "yes" "no", "in love", "scull" </td>
+    <td> Fixed tooltip for Netscape; added "sealed lips", "thumbs up", "yes" "no", "in love", "skull" </td>
   </tr>
   <tr>
     <td align="right"> 16 Feb 2004: </td>
@@ -257,6 +269,10 @@ Plugin settings are stored as preferences variables. To reference a plugin setti
     <td> 5.0 </td>
   </tr>
   <tr>
+    <td align="right"> TWiki:Plugins/Benchmark: </td>
+    <td>[[TWiki/GoodStyle]] 96%, [[TWiki/FormattedSearch]] 98%, [[Main/SmiliesPlugin]] 96% </td>
+  </tr>
+  <tr>
     <td align="right"> Plugin Home: </td>
     <td><a href="http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%" target="_top">http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%</a></td>
   </tr>
@@ -264,8 +280,10 @@ Plugin settings are stored as preferences variables. To reference a plugin setti
     <td align="right"> Feedback: </td>
     <td><a href="http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev" target="_top">http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev</a></td>
   </tr>
+  <tr>
+    <td align="right"> Appraisal: </td>
+    <td><a href="http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Appraisal" target="_top">http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Appraisal</a></td>
+  </tr>
 </table>
 
 **_Related Topics:_** [[TWikiPreferences]], [[TWikiPlugins]]
-
--- TWiki:Main.AndreaSterbini - 28 Dec 2000 <br /> -- TWiki:Main.PeterThoeny - 21 Aug 2004
diff --git a/TWiki/SourceCode.mdwn b/TWiki/SourceCode.mdwn
new file mode 100644 (file)
index 0000000..7780c32
--- /dev/null
@@ -0,0 +1,531 @@
+# <a name="TWiki Source Code Packages"></a><a name=" TWiki Source Code Packages"></a> TWiki Source Code Packages
+
+%X% This documentation is automatically generated from the `pod`, so it always matches the running code
+
+<div>
+  <ul>
+    <li><a href="#TWiki::_AccessControlException"> TWiki::AccessControlException </a></li>
+    <li><a href="#TWiki::Access"> TWiki::Access </a></li>
+    <li><a href="#TWiki::Attach"> TWiki::Attach </a></li>
+    <li><a href="#TWiki::Attrs"> TWiki::Attrs </a></li>
+    <li><a href="#TWiki::Client::_ApacheLogin"> TWiki::Client::ApacheLogin </a></li>
+    <li><a href="#TWiki::Client"> TWiki::Client </a></li>
+    <li><a href="#TWiki::Client::_TemplateLogin"> TWiki::Client::TemplateLogin </a></li>
+    <li><a href="#TWiki::Compatibility"> TWiki::Compatibility </a></li>
+    <li><a href="#TWiki"> TWiki </a></li>
+    <li><a href="#TWiki::Form"> TWiki::Form </a></li>
+    <li><a href="#TWiki::Func"> TWiki::Func </a></li>
+    <li><a href="#TWiki::_I18N"> TWiki::I18N </a></li>
+    <li><a href="#TWiki::_I18N::Extract"> TWiki::I18N::Extract </a></li>
+    <li><a href="#TWiki::If"> TWiki::If </a></li>
+    <li><a href="#TWiki::Merge"> TWiki::Merge </a></li>
+    <li><a href="#TWiki::Merge"> TWiki::Merge </a></li>
+    <li><a href="#TWiki::Meta"> TWiki::Meta </a></li>
+    <li><a href="#TWiki::Net"> TWiki::Net </a></li>
+    <li><a href="#TWiki::_OopsException"> TWiki::OopsException </a></li>
+    <li><a href="#"> </a></li>
+    <li><a href="#TWiki::Plugins"> TWiki::Plugins </a></li>
+    <li><a href="#TWiki::Plurals"> TWiki::Plurals </a></li>
+    <li><a href="#TWiki::Prefs"> TWiki::Prefs </a></li>
+    <li><a href="#TWiki::Prefs::Parser"> TWiki::Prefs::Parser </a></li>
+    <li><a href="#TWiki::Prefs::_PrefsCache"> TWiki::Prefs::PrefsCache </a></li>
+    <li><a href="#TWiki::Render"> TWiki::Render </a></li>
+    <li><a href="#TWiki::Sandbox"> TWiki::Sandbox </a></li>
+    <li><a href="#TWiki::Search"> TWiki::Search </a></li>
+    <li><a href="#TWiki::Store"> TWiki::Store </a></li>
+    <li><a href="#TWiki::Store::_RcsFile"> TWiki::Store::RcsFile </a></li>
+    <li><a href="#TWiki::Store::_RcsLite"> TWiki::Store::RcsLite </a></li>
+    <li><a href="#File format"> File format</a></li>
+    <li><a href="#TWiki::Store::_RcsWrap"> TWiki::Store::RcsWrap </a></li>
+    <li><a href="#TWiki::Templates"> TWiki::Templates </a></li>
+    <li><a href="#TWiki::Time"> TWiki::Time </a></li>
+    <li><a href="#TWiki::UI::_ChangeForm"> TWiki::UI::ChangeForm </a></li>
+    <li><a href="#TWiki::UI"> TWiki::UI </a></li>
+    <li><a href="#TWiki::UI::Edit"> TWiki::UI::Edit </a></li>
+    <li><a href="#TWiki::UI::Manage"> TWiki::UI::Manage </a></li>
+    <li><a href="#TWiki::UI::Oops"> TWiki::UI::Oops </a></li>
+    <li><a href="#TWiki::UI::RDiff"> TWiki::UI::RDiff </a></li>
+    <li><a href="#TWiki::UI::Register"> TWiki::UI::Register </a></li>
+    <li><a href="#TWiki::UI::Rest"> TWiki::UI::Rest </a></li>
+    <li><a href="#TWiki::UI::Save"> TWiki::UI::Save </a></li>
+    <li><a href="#TWiki::UI::Search"> TWiki::UI::Search </a></li>
+    <li><a href="#TWiki::UI::Statistics"> TWiki::UI::Statistics </a></li>
+    <li><a href="#TWiki::UI::Upload"> TWiki::UI::Upload </a></li>
+    <li><a href="#TWiki::UI::View"> TWiki::UI::View </a></li>
+    <li><a href="#TWiki::User"> TWiki::User </a></li>
+    <li><a href="#TWiki::Users::_ApacheHtpasswdUse"> TWiki::Users::ApacheHtpasswdUser </a></li>
+    <li><a href="#TWiki::Users"> TWiki::Users </a></li>
+    <li><a href="#TWiki::Users::Password"> TWiki::Users::Password </a></li>
+  </ul>
+</div>
+
+## <a name="TWiki::_AccessControlException"></a> [[TWiki::AccessControlException|Main/TWikiAccessControlExceptionDotPm]]
+
+Exception used raise an access control violation.
+
+This package doesn't smell
+
+## <a name="TWiki::Access"></a> [[TWiki::Access|Main/TWikiAccessDotPm]]
+
+A singleton object of this class manages the access control database.
+
+This package has smell factor of **1**
+
+## <a name="TWiki::Attach"></a> [[TWiki::Attach|Main/TWikiAttachDotPm]]
+
+A singleton object of this class is used to deal with attachments to topics.
+
+This package has smell factor of **2**
+
+## <a name="TWiki::Attrs"></a> [[TWiki::Attrs|Main/TWikiAttrsDotPm]]
+
+Class of attribute sets, designed for parsing and storing attribute values from a TWiki tag e.g. `%TAG{fred='bad' "sad" joe="mad"}%`
+
+An attribute set is a map containing an entry for each parameter. The default parameter (unnamed quoted string) is named `_DEFAULT` in the map.
+
+Attributes declared later in the string will override those of the same name defined earlier. The one exception to this is the \_DEFAULT key, where the _first_ instance of a setting is always taken.
+
+As well as standard TWiki syntax (parameter values double-quoted) it also parses single-quoted values, unquoted spaceless values, spaces around the =, and commas as well as spaces separating values, though none of these alternatives is advertised in documentation and the extended syntax can be turned off by passing the 'strict' parameter to `new`.
+
+This class replaces the old TWiki::extractNameValuePair and TWiki::extractParameters.
+
+This package doesn't smell
+
+## <a name="TWiki::Client::_ApacheLogin"></a> [[TWiki::Client::ApacheLogin|Main/TWikiClientApacheLoginDotPm]]
+
+This is login manager that you can specify in the security setup section of [configure](http://www.dementia.org/twiki//configure). It instructs TWiki to cooperate with your web server (typically Apache) to require authentication information (username &amp; password) from users. It requires that you configure your web server to demand authentication for scripts named "login" and anything ending in "auth". The latter should be symlinks to existing scripts; e.g., `viewauth -> view`, `editauth -> edit`, and so on.
+
+See also [[TWikiUserAuthentication]].
+
+Subclass of TWiki::Client; see that class for documentation of the methods of this class.
+
+This package doesn't smell
+
+## <a name="TWiki::Client"></a> [[TWiki::Client|Main/TWikiClientDotPm]]
+
+The package is also a Factory for login managers and also the base class for all login managers.
+
+On it's own, an object of this class is used when you specify 'none' in the security setup section of [configure](http://www.dementia.org/twiki//configure). When it is used, logins are not supported. If you want to authenticate users then you should consider [[TemplateLogin]] or [[ApacheLogin]], which are subclasses of this class.
+
+If you are building a new login manager, then you should write a new subclass of this class, implementing the methods marked as **VIRTUAL**. There are already examples in the `lib/TWiki/Client` directory.
+
+This package has smell factor of **3**
+
+## <a name="TWiki::Client::_TemplateLogin"></a> [[TWiki::Client::TemplateLogin|Main/TWikiClientTemplateLoginDotPm]]
+
+This is a login manager that you can specify in the security setup section of [configure](http://www.dementia.org/twiki//configure). It provides users with a template-based form to enter usernames and passwords, and works with the [[PasswordManager]] that you specify to verify those passwords.
+
+Subclass of TWiki::Client; see that class for documentation of the methods of this class.
+
+This package has smell factor of **2**
+
+## <a name="TWiki::Compatibility"></a> [[TWiki::Compatibility|Main/TWikiCompatibilityDotPm]]
+
+Support for compatibility with old TWiki versions. Packaged separately because 99.999999% of the time this won't be needed.
+
+=end
+
+sub \_upgradeCategoryItem \{ my ( $catitems, $ctext ) = @\_; my $catname = ''; my $scatname = ''; my $catmodifier = ''; my $catvalue = ''; my @cmd = split( /\\|/, $catitems ); my $src = ''; my $len = @cmd; if( $len &lt; '2' ) \{ # FIXME return ( $catname, $catmodifier, $catvalue ) \} my $svalue = '';
+
+my $i; my $itemsPerLine;
+
+# check for [[CategoryName]]=CategoryValue parameter my $paramCmd = ''; my $cvalue = ''; # was$query-&gt;param( $cmd[1] ); if( $cvalue ) \{ $src = "$cvalue"; \} elsif( $ctext ) \{ foreach( split( /\\r?\\n/, $ctext ) ) \{ if( /$cmd[1]/ ) \{ $src = $\_; last; \} \} \}
+
+if( $cmd[0] eq 'select' || $cmd[0] eq 'radio') \{ $catname = $cmd[1]; $scatname = $catname; #$scatname =~ s/[^a-zA-Z0-9]//g; my $size = $cmd[2]; for( $i = 3; $i &lt; $len; $i++ ) \{ my $value = $cmd[$i]; $svalue = $value; if( $src =~ /$value/ ) \{ $catvalue = $svalue; \} \}
+
+\} elsif( $cmd[0] eq 'checkbox' ) \{ $catname = $cmd[1]; $scatname = $catname; #$scatname =~ s/[^a-zA-Z0-9]//g; if( $cmd[2] eq 'true' || $cmd[2] eq '1' ) \{ $i = $len - 4; $catmodifier = 1; \} $itemsPerLine = $cmd[3]; for( $i = 4; $i &lt; $len; $i++ ) \{ my $value = $cmd[$i]; $svalue = $value; # [[I18N]]: FIXME - need to look at this, but since it's upgrading # old forms that probably didn't use [[I18N]], it's not a high # priority. if( $src =~ /$value[^a-zA-Z0-9\\.]/ ) \{ $catvalue .= ", " if( $catvalue ); $catvalue .= $svalue; \} \}
+
+\} elsif( $cmd[0] eq 'text' ) \{ $catname = $cmd[1]; $scatname = $catname; #$scatname =~ s/[^a-zA-Z0-9]//g; $src =~ /(.\*)/; if( $1 ) \{ $src = $1; \} else \{ $src = ''; \} $catvalue = $src; \}
+
+return ( $catname, $catmodifier, $catvalue ) \}
+
+This package has smell factor of **2**
+
+## <a name="TWiki"></a> [[TWiki|Main/TWikiDotPm]]
+
+TWiki operates by creating a singleton object (known as the Session object) that acts as a point of reference for all the different modules in the system. This package is the class for this singleton, and also contains the vast bulk of the basic constants and the per- site configuration mechanisms.
+
+Global variables are avoided wherever possible to avoid problems with CGI accelerators such as mod\_perl.
+
+This package has smell factor of **29**
+
+## <a name="TWiki::Form"></a> [[TWiki::Form|Main/TWikiFormDotPm]]
+
+Object representing a single form definition.
+
+This package has smell factor of **11**
+
+## <a name="TWiki::Func"></a> [[TWiki::Func|Main/TWikiFuncDotPm]]
+
+_Official list of stable TWiki functions for Plugin developers_
+
+This module defines official functions that [[Plugins|TWiki/TWikiPlugins]] can use to interact with the TWiki engine and content.
+
+Refer to [[EmptyPlugin]] and lib/TWiki/Plugins/EmptyPlugin.pm for a template Plugin and documentation on how to write a Plugin.
+
+Plugins should **only** use functions published in this module. If you use functions in other TWiki libraries you might create a security hole and you will probably need to change your Plugin when you upgrade TWiki.
+
+Deprecated functions will still work in older code, though they should _not_ be called in new Plugins and should be replaced in older Plugins as soon as possible.
+
+The version of the TWiki::Func module is defined by the VERSION number of the TWiki::Plugins module, currently 1.11. This can be shown by the `%PLUGINVERSION%` variable. The 'Since' field in the function documentation refers to the VERSION number and the date that the function was addded.
+
+**_Note:_** Beware! These methods should only ever be called from the context of a TWiki Plugin. They require a Plugins SESSION context to be established before they are called, and will not work if simply called from another TWiki module. For example,
+
+    use TWiki;
+    print TWiki::Func::getSkin(),"\n";
+
+will fail with `Can't call method "getSkin" on an undefined value at TWiki/Func.pm line 83`.
+
+If you want to call the methods outside the context of a plugin, you can create a Plugins SESSION object. For example, the script:
+
+    use TWiki:
+    $TWiki::Plugins::SESSION = new TWiki();
+    print TWiki::Func::getSkin(),"\n";
+
+will work happily.
+
+This package has smell factor of **1**
+
+## <a name="TWiki::_I18N"></a> [[TWiki::I18N|Main/TWikiI18NDotPm]]
+
+Support for strings translation and language detection.
+
+This package has smell factor of **1**
+
+## <a name="TWiki::_I18N::Extract"></a> [[TWiki::I18N::Extract|Main/TWikiI18NExtractDotPm]]
+
+Support translatable strings extraction from TWiki topics and templates. Depends on Locale::Maketext::Extract (part of CPAN::Locale::Maketext::Lexicon).
+
+This package has smell factor of **1**
+
+## <a name="TWiki::If"></a> [[TWiki::If|Main/TWikiIfDotPm]]
+
+Support for the conditions in %IF\{\} statements. Basically a simple stack-based parser for infix expressions that generates a parse tree that can subsequently be evaluated.
+
+This package doesn't smell
+
+## <a name="TWiki::Merge"></a> [[TWiki::Merge|Main/TWikiMerge3DotPm]]
+
+Support for 3-way merging of strings. Similar to Merge.pm, except that: a) it's considers the ancestor revision of the string, and b) it works. :-P
+
+This package doesn't smell
+
+## <a name="TWiki::Merge"></a> [[TWiki::Merge|Main/TWikiMergeDotPm]]
+
+Support for merging strings
+
+This package doesn't smell
+
+## <a name="TWiki::Meta"></a> [[TWiki::Meta|Main/TWikiMetaDotPm]]
+
+Meta-data handling.
+
+A meta-data object is a hash of different types of meta-data (keyed on the type, such as 'FIELD' and 'TOPICINFO').
+
+Each entry in the hash is an array, where each entry in the array contains another hash of the key=value pairs, corresponding to a single meta-datum.
+
+If there may be multiple entries of the same top-level type (i.e. for FIELD and FILEATTACHMENT) then the array hash multiple entries. These types are referred to as "keyed" types. The array entries are keyed with the attribute 'name' which must be in each entry in the array.
+
+For unkeyed types, the array has only one entry.
+
+The module knows nothing about how meta-data is stored. That is entirely the responsibility of the Store module.
+
+Meta-data objects are created by the Store engine when topics are read. They are populated using the `put` method.
+
+This package has smell factor of **6**
+
+## <a name="TWiki::Net"></a> [[TWiki::Net|Main/TWikiNetDotPm]]
+
+Object that brokers access to network resources.
+
+This package has smell factor of **2**
+
+## <a name="TWiki::_OopsException"></a> [[TWiki::OopsException|Main/TWikiOopsExceptionDotPm]]
+
+Exception used to raise a request to redirect to an Oops URL. An [[OopsException]] thrown anywhere in the code will redirect the browser to a url based on the `oops` script. `oops` requires a `template` parameter, that is the name of a template file from the `templates` directory. This file will be expanded and the parameter values passed to the exception instantiated. The result will be shown in the browser.
+
+This package doesn't smell
+
+## <> \[[TWikiPluginDotPm]\[]]
+
+This package has smell factor of **2**
+
+## <a name="TWiki::Plugins"></a> [[TWiki::Plugins|Main/TWikiPluginsDotPm]]
+
+This module defines the singleton object that handles Plugins loading, initialization and execution.
+
+This class uses Chain of Responsibility (GOF) pattern to dispatch handler calls to registered plugins.
+
+This package doesn't smell
+
+## <a name="TWiki::Plurals"></a> [[TWiki::Plurals|Main/TWikiPluralsDotPm]]
+
+Handle conversion of plural topic names to singular form.
+
+This package has smell factor of **3**
+
+## <a name="TWiki::Prefs"></a> [[TWiki::Prefs|Main/TWikiPrefsDotPm]]
+
+The Prefs class is a singleton that implements management of preferences. It uses a stack of TWiki::Prefs::PrefsCache objects to store the preferences for global, web, user and topic contexts, and provides the means to look up preferences in these.
+
+Preferences from different places stack on top of each other, so there are global preferences, then site, then web (and subweb and subsubweb), then topic, included topic and so on. Each level of the stack is tagged with a type identifier.
+
+The module also maintains a separate of the preferences found in every topic and web it reads. This supports the lookup of preferences for webs and topics that are not on the stack, and must not be chained in (you can't allow a user to override protections from their home topic!)
+
+This package has smell factor of **1**
+
+## <a name="TWiki::Prefs::Parser"></a> [[TWiki::Prefs::Parser|Main/TWikiPrefsParserDotPm]]
+
+This Prefs-internal class is used to parse \* Set and \* Local statements from arbitrary text, and extract settings from meta objects. It is used by [[TopicPrefs]] to parse preference settings from topics.
+
+This class does no validation or duplicate-checking on the settings; it simply returns the recognized settings in the order it sees them in.
+
+This package has smell factor of **1**
+
+## <a name="TWiki::Prefs::_PrefsCache"></a> [[TWiki::Prefs::PrefsCache|Main/TWikiPrefsPrefsCacheDotPm]]
+
+The [[PrefsCache]] package holds a cache of topics that have been read in, using the [[TopicPrefs]] class. These functions manage that cache.
+
+We maintain 2 hashes of values:
+
+- \{locals\} Contains all locals at this level. Locals are values that only apply when the current topic is the topic where the local is defined. The variable names are decorated with the locality where they apply.
+- \{values\} contains all sets, locals, and all values inherited from the parent level
+
+As each cache level is built, the values are copied down from the parent cache level. This sounds monstrously inefficient, but in fact perl does this a lot better than doing a multi-level lookup when a value is referenced. This is especially important when many prefs lookups may be done in a session, for example when searching.
+
+This package has smell factor of **1**
+
+## <a name="TWiki::Render"></a> [[TWiki::Render|Main/TWikiRenderDotPm]]
+
+This module provides most of the actual HTML rendering code in TWiki.
+
+This package has smell factor of **24**
+
+## <a name="TWiki::Sandbox"></a> [[TWiki::Sandbox|Main/TWikiSandboxDotPm]]
+
+This object provides an interface to the outside world. All calls to system functions, or handling of file names, should be brokered by this object.
+
+This package has smell factor of **3**
+
+## <a name="TWiki::Search"></a> [[TWiki::Search|Main/TWikiSearchDotPm]]
+
+This module implements all the search functionality.
+
+This package has smell factor of **22**
+
+## <a name="TWiki::Store"></a> [[TWiki::Store|Main/TWikiStoreDotPm]]
+
+This module hosts the generic storage backend. This module provides the interface layer between the "real" store provider - which is hidden behind a handler - and the rest of the system. it is responsible for checking for topic existance, access permissions, and all the other general admin tasks that are common to all store implementations.
+
+This module knows nothing about how the data is actually _stored_ - that knowledge is entirely encapsulated in the handlers.
+
+The general contract for methods in the class requires that errors are signalled using exceptions. TWiki::AccessControlException is used for access control exceptions, and Error::Simple for all other types of error.
+
+This package has smell factor of **17**
+
+## <a name="TWiki::Store::_RcsFile"></a> [[TWiki::Store::RcsFile|Main/TWikiStoreRcsFileDotPm]]
+
+This class is PACKAGE PRIVATE to Store, and should never be used from anywhere else. Base class of implementations of stores that manipulate RCS format files.
+
+The general contract of the methods on this class and its subclasses calls for errors to be signalled by Error::Simple exceptions.
+
+Refer to Store.pm for models of usage.
+
+This package has smell factor of **10**
+
+## <a name="TWiki::Store::_RcsLite"></a> [[TWiki::Store::RcsLite|Main/TWikiStoreRcsLiteDotPm]]
+
+This package does not publish any methods. It implements the virtual methods of the [[TWiki::Store::RcsFile|Main/TWikiStoreRcsFileDotPm]] superclass.
+
+Simple replacement for RCS. Doesn't support:
+
+- branches
+- locking
+
+Neither of which are used (or needed) by TWiki.
+
+This module doesn't know anything about the content of the topic
+
+There is one of these object for each file stored under RCSLite.
+
+This object is PACKAGE PRIVATE to Store, and should NEVER be used from anywhere else.
+
+FIXME:
+
+- need to tidy up dealing with \\n for differences
+- still have difficulty on line ending at end of sequences, consequence of doing a line based diff
+
+## <a name="File format"></a> File format
+
+    rcstext    ::=  admin {delta}* desc {deltatext}*
+    admin      ::=  head {num};
+                    { branch   {num}; }
+                    access {id}*;
+                    symbols {sym : num}*;
+                    locks {id : num}*;  {strict  ;}
+                    { comment  {string}; }
+                    { expand   {string}; }
+                    { newphrase }*
+    delta      ::=  num
+                    date num;
+                    author id;
+                    state {id};
+                    branches {num}*;
+                    next {num};
+                    { newphrase }*
+    desc       ::=  desc string
+    deltatext  ::=  num
+                    log string
+                    { newphrase }*
+                    text string
+    num        ::=  {digit | .}+
+    digit      ::=  0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9
+    id         ::=  {num} idchar {idchar | num }*
+    sym        ::=  {digit}* idchar {idchar | digit }*
+    idchar     ::=  any visible graphic character except special
+    special    ::=  $ | , | . | : | ; | @
+    string     ::=  @{any character, with @ doubled}*@
+    newphrase  ::=  id word* ;
+    word       ::=  id | num | string | :
+
+Identifiers are case sensitive. Keywords are in lower case only. The sets of keywords and identifiers can overlap. In most environments RCS uses the ISO 8859/1 encoding: visible graphic characters are codes 041-176 and 240-377, and white space characters are codes 010-015 and 040.
+
+Dates, which appear after the date keyword, are of the form Y.mm.dd.hh.mm.ss, where Y is the year, mm the month (01-12), dd the day (01-31), hh the hour (00-23), mm the minute (00-59), and ss the second (00-60). Y contains just the last two digits of the year for years from 1900 through 1999, and all the digits of years thereafter. Dates use the Gregorian calendar; times use UTC.
+
+The newphrase productions in the grammar are reserved for future extensions to the format of RCS files. No newphrase will begin with any keyword already in use.
+
+Revisions consist of a sequence of 'a' and 'd' edits that need to be applied to rev N+1 to get rev N. Each edit has an offset (number of lines from start) and length (number of lines). For 'a', the edit is followed by length lines (the lines to be inserted in the text). For example:
+
+d1 3 means "delete three lines starting with line 1 a4 2 means "insert two lines at line 4' xxxxxx is the new line 4 yyyyyy is the new line 5
+
+This package has smell factor of **2**
+
+## <a name="TWiki::Store::_RcsWrap"></a> [[TWiki::Store::RcsWrap|Main/TWikiStoreRcsWrapDotPm]]
+
+This package does not publish any methods. It implements the virtual methods of the [[TWiki::Store::RcsFile|Main/TWikiStoreRcsFileDotPm]] superclass.
+
+Wrapper around the RCS commands required by TWiki. There is one of these object for each file stored under RCS.
+
+This package has smell factor of **2**
+
+## <a name="TWiki::Templates"></a> [[TWiki::Templates|Main/TWikiTemplatesDotPm]]
+
+Support for the TWiki template language.
+
+This package has smell factor of **2**
+
+## <a name="TWiki::Time"></a> [[TWiki::Time|Main/TWikiTimeDotPm]]
+
+Time handling functions.
+
+This package has smell factor of **10**
+
+## <a name="TWiki::UI::_ChangeForm"></a> [[TWiki::UI::ChangeForm|Main/TWikiUIChangeFormDotPm]]
+
+Service functions used by the UI packages
+
+This package doesn't smell
+
+## <a name="TWiki::UI"></a> [[TWiki::UI|Main/TWikiUIDotPm]]
+
+Service functions used by the UI packages
+
+This package doesn't smell
+
+## <a name="TWiki::UI::Edit"></a> [[TWiki::UI::Edit|Main/TWikiUIEditDotPm]]
+
+Edit command handler
+
+This package has smell factor of **1**
+
+## <a name="TWiki::UI::Manage"></a> [[TWiki::UI::Manage|Main/TWikiUIManageDotPm]]
+
+UI functions for web, topic and user management
+
+This package has smell factor of **5**
+
+## <a name="TWiki::UI::Oops"></a> [[TWiki::UI::Oops|Main/TWikiUIOopsDotPm]]
+
+UI delegate for oops function
+
+This package has smell factor of **1**
+
+## <a name="TWiki::UI::RDiff"></a> [[TWiki::UI::RDiff|Main/TWikiUIRDiffDotPm]]
+
+UI functions for diffing.
+
+This package has smell factor of **12**
+
+## <a name="TWiki::UI::Register"></a> [[TWiki::UI::Register|Main/TWikiUIRegisterDotPm]]
+
+User registration handling.
+
+This package has smell factor of **28**
+
+## <a name="TWiki::UI::Rest"></a> [[TWiki::UI::Rest|Main/TWikiUIRestDotPm]]
+
+Rest delegate for view function
+
+This package doesn't smell
+
+## <a name="TWiki::UI::Save"></a> [[TWiki::UI::Save|Main/TWikiUISaveDotPm]]
+
+UI delegate for save function
+
+This package has smell factor of **1**
+
+## <a name="TWiki::UI::Search"></a> [[TWiki::UI::Search|Main/TWikiUISearchDotPm]]
+
+UI functions for searching.
+
+This package has smell factor of **3**
+
+## <a name="TWiki::UI::Statistics"></a> [[TWiki::UI::Statistics|Main/TWikiUIStatisticsDotPm]]
+
+Statistics extraction and presentation
+
+This package has smell factor of **4**
+
+## <a name="TWiki::UI::Upload"></a> [[TWiki::UI::Upload|Main/TWikiUIUploadDotPm]]
+
+UI delegate for attachment management functions
+
+This package has smell factor of **5**
+
+## <a name="TWiki::UI::View"></a> [[TWiki::UI::View|Main/TWikiUIViewDotPm]]
+
+UI delegate for view function
+
+This package has smell factor of **1**
+
+## <a name="TWiki::User"></a> [[TWiki::User|Main/TWikiUserDotPm]]
+
+A User object is an internal representation of a user in the real world. The object knows about users having login names, wiki names, personal topics, and email addresses.
+
+This package has smell factor of **5**
+
+## <a name="TWiki::Users::_ApacheHtpasswdUse"></a> [[TWiki::Users::ApacheHtpasswdUser|Main/TWikiUsersApacheHtpasswdUserDotPm]]
+
+Password manager that uses Apache::HtPasswd to manage users and passwords.
+
+Subclass of [[ TWiki::Users::Password |Main/TWikiUsersPasswordDotPm]]. See documentation of that class for descriptions of the methods of this class.
+
+Duplicates functionality of [[ =TWiki::Users::HtPasswdUser=|Main/TWikiUsersHtPasswdUserDotPm]]; provided mainly as an example of how to write a new password manager.
+
+This package doesn't smell
+
+## <a name="TWiki::Users"></a> [[TWiki::Users|Main/TWikiUsersDotPm]]
+
+Singleton object that handles mapping of users to wikinames and vice versa, and user authentication checking.
+
+This package has smell factor of **4**
+
+## <a name="TWiki::Users::Password"></a> [[TWiki::Users::Password|Main/TWikiUsersPasswordDotPm]]
+
+Base class of all password handlers. Default behaviour is no passwords, so anyone can be anyone they like.
+
+The methods of this class should be overridded by subclasses that want to implement other password handling methods.
+
+This package doesn't smell
+
+There were a total of **231** smells
index ceb9244..cae3d87 100644 (file)
@@ -1,6 +1,6 @@
 # <a name="TWiki Spreadsheet Plugin"></a><a name=" TWiki Spreadsheet Plugin"></a> TWiki Spreadsheet Plugin
 
-This Plugin adds speadsheet capabilities to %WIKITOOLNAME% topics. Formulae like <code>**%CALC\{"$INT(7/3)"\}%**</code> are evaluated at page view time. They can be placed in table cells and outside of tables. In other words, this Plugin provides general formula evaluation capability, not just classic spreadsheet functions.
+This Plugin adds spreadsheet capabilities to %WIKITOOLNAME% topics. Formulae like <code>**%CALC\{"$INT(7/3)"\}%**</code> are evaluated at page view time. They can be placed in table cells and outside of tables. In other words, this Plugin provides general formula evaluation capability, not just classic spreadsheet functions.
 
 <table>
   <tr>
@@ -66,8 +66,11 @@ This Plugin adds speadsheet capabilities to %WIKITOOLNAME% topics. Formulae like
         <li><a href="#COUNTITEMS( list ) -- count indi"> COUNTITEMS( list ) -- count individual items in a list</a></li>
         <li><a href="#COUNTSTR( list, str ) -- count t"> COUNTSTR( list, str ) -- count the number of cells in a list equal to a given string</a></li>
         <li><a href="#DEF( list ) -- find first non-em"> DEF( list ) -- find first non-empty list item or cell</a></li>
-        <li><a href="#EVAL( formula ) -- evaluate a si"> EVAL( formula ) -- evaluate a simple formula</a></li>