TWiki's TWiki web

TWiki's TWiki web http://www.dementia.org/twiki/bin/view/TWiki The Documentation Web of TWiki. TWiki is a Web-Based Collaboration Platform for the Corporate World. en-us Copyright 2008 by contributing authors TWiki Administrator [shadow@dementia.org] TWiki Administrator [shadow@dementia.org] TWiki TWiki.TWiki Powered by TWiki.TWiki http://www.dementia.org/twiki/bin/view/TWiki http://www.dementia.org/twiki/pub/TWiki/TWikiLogos/T-logo-140x40-t.gif TWikiPreferences http://www.dementia.org/twiki/bin/view/TWiki/TWikiPreferences?t=2005-12-04T23:04Z <form method="post" action="http://www.dementia.org/twiki/bin/viewauth/TWiki/WebRss" enctype="multipart/form-data" name="editpreferences"> <nop><h1><a name="WIKITOOLNAME_Site_Level_Preferen"></a><a name="_WIKITOOLNAME_Site_Level_Prefere"></a> <nop>%WIKITOOLNAME% Site-Level Preferences </h1> <p /> This topic defines <strong><em>site-level</em></strong> settings that apply to all users and webs on this <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/TWiki/TWikiSite">TWikiSite</a>. This topic should be regarded as read-only, so that upgrades can safely overwrite it without risk to your customaisations. <p /> Preference settings local to your site should be set in %LOCALSITEPREFS% (this topic is pointed to by {LocalSitePreferences}, which is set by the admin in the <code>configure</code> interface). Settings in %LOCALSITEPREFS% will override settings in this topic, and should be used for defining custom settings and variables. <p /> See <a class="twikiAnchorLink" href="http://www.dementia.org/twiki/bin/view/TWiki/TWikiVariables#PreferencesVariables">here</a> for more information on how to set Preferences Variables. <p /> <input type="submit" tabindex="1" name="prefsaction" value="Edit" /> <em>(Click for form-based editing of existing preferences.)</em> %TOC% <p /> <nop><h2><a name="Default_Web_Preferences"></a> Default Web Preferences </h2> <p /> %X% <strong>NOTE:</strong> They are typically redefined in individual <nop>WebPreferences topics <p /><ul><li> List of selected topics in a web - the second line of the upper toolbar (usually overwritten in individual %WEBPREFSTOPIC%):<ul><li> Set WEBTOPICLIST = <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/TWiki/WebChanges">Changes</a> %SEP% <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/TWiki/WebIndex">Index</a> %SEP% <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/TWiki/WebSearch">Search</a> %SEP% Go <input type="text" name="topic" size="16" /></li></ul></li></ul> <p /><ul><li> Web-specific background color: (is overwritten by web preferences)<ul><li> Set WEBBGCOLOR = #FFD8AA</li></ul></li></ul> <p /><ul><li> Image, URL and alternate tooltip text of web's logo. Note: don't add your own local logos to the <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/TWiki/TWikiLogos">TWikiLogos</a> topic; create your own logos topic instead.<ul><li> Set WEBLOGONAME = logo.gif</li><li> Set WEBLOGOIMG = %PUBURL%/%BASEWEB%/%WEBPREFSTOPIC%/%WEBLOGONAME%</li><li> Set WEBLOGOURL = %SCRIPTURL%/view%SCRIPTSUFFIX%/%BASEWEB%/%HOMETOPIC%</li><li> Set WEBLOGOALT = Home</li></ul></li></ul> <p /><ul><li> <a href="http://favicon.org" target="_top">favicon</a>: Attach a <code>favicon.ico</code> to a web's <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/TWiki/WebPreferences">WebPreferences</a> or add a <code>FAVICON</code> setting to <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/TWiki/WebPreferences">WebPreferences</a><ul><li> Set FAVICON = %PUBURL%/%BASEWEB%/%WEBPREFSTOPIC%/favicon.ico</li></ul></li></ul> <p /><ul><li> Copyright notice:<ul><li> Set WEBCOPYRIGHT = <span class="twikiRight"> <a href="http://twiki.org/"><img src="%PUBURL%/%TWIKIWEB%/TWikiLogos/T-logo-80x15.gif" alt="This site is powered by the TWiki collaboration platform" title="This site is powered by the TWiki collaboration platform" border="0" /></a></span>%MAKETEXT{"Copyright [_1] by the contributing authors. All material on this collaboration platform is the property of the contributing authors." args="© 1999-%GMTIME{$year}%"}% <br /> %MAKETEXT{"Ideas, requests, problems regarding [_1]? <a href='[_2]'>Send feedback</a>" args="<nop>%WIKITOOLNAME%,mailto:%WIKIWEBMASTER%?subject=%WIKITOOLNAME% Feedback on %BASEWEB%.%BASETOPIC%"}%</li></ul></li></ul> <p /> <p /> <p /><ul><li> Simplified Copyright notice for the <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/TWiki/WebRss">WebRss</a> feed (don't use any special characters, xml tags or <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/TWiki/WikiWord">WikiWords</a>)<ul><li> Set WEBRSSCOPYRIGHT = Copyright %GMTIME{"$year"}% by contributing authors</li></ul></li></ul> <p /><ul><li> Exclude web from a <code>web="all"</code> search: (Set to <code>on</code> for hidden webs; is overwritten by web preferences)<ul><li> Set NOSEARCHALL =</li></ul></li></ul> <p /><ul><li> Prevent automatic linking of <span class="twikiNewLink">WikiWords<a href="http://www.dementia.org/twiki/bin/edit/TWiki/TWIKIWEBWikiWords?topicparent=TWiki.WebRss" rel="nofollow" title="Create this topic"><sup>?</sup></a></span> and acronyms (if set to <code>on</code>); link <nop>WikiWords (if empty); can be overwritten by web preferences:<ul><li> Set NOAUTOLINK = </li><li> <strong><em>Note:</em></strong> Use the <code>[<nop>[...][...]]</code> syntax to link topics in case you disabled <nop>WikiWord linking. The <code><noautolink> ... </noautolink></code> syntax can be used to prevents links within a block of text.</li></ul></li></ul> <p /><ul><li> Warn if <code>%<nop>INCLUDE{}%</code> of topic fails: Fail silently if empty or <code>off</code>. Output warning message (defined in templates/oopsalerts.tmpl) if set to <code>on</code>. Otherwise output specific text (use <code>$topic</code> for topic). You can override this in web preferences, or by using a <code>warn="..."</code> parameter with <code>%<nop>INCLUDE{}%</code> :<ul><li> Set INCLUDEWARNING = on</li></ul></li></ul> <p /> <p /> <nop><h2><a name="Default_User_Settings"></a> Default User Settings </h2> <p /> %X% <strong>NOTE:</strong> They are typically redefined in topics of individual %MAINWEB%.TWikiUsers <p /><ul><li> Show tool-tip topic info on mouse-over of <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/TWiki/WikiWord">WikiWord</a> links. Setting can be on, off, or customized. An empty setting or off setting disables the tool-tips (for better performance). The setting can contain $summary to show the topic summary, $date for the last change date, $rev for the revision, $username for the login name of the last editor, $wikiname for the <nop>WikiName, $wikiusername for <nop>%MAINWEB%.WikiName, $topic for the topic name, and $web for the web name<ul><li> Set LINKTOOLTIPINFO = off</li><li> #Set LINKTOOLTIPINFO = $username - $date - $rev: $summary</li></ul></li></ul> <p /><ul><li> Horizontal size of text edit box: (can be overwritten by user preferences)<ul><li> Set EDITBOXWIDTH = 70</li></ul></li></ul> <p /><ul><li> Vertical size of text edit box: (can be overwritten by user preferences)<ul><li> Set EDITBOXHEIGHT = 15</li></ul></li></ul> <p /><ul><li> Style of text edit box. Set to <code>width: 99%</code> for full window width (default; this will overwrite the EDITBOXWIDTH setting), or <code>width: auto</code> to disable. This setting works for IE and some other recent browsers. (can be overwritten by user preferences)<ul><li> Set EDITBOXSTYLE = width: 99%</li></ul></li></ul> <p /><ul><li> Default state of the <strong><em>Force New Revision</em></strong> (<a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/TWiki/ForceNewRevision">ForceNewRevision</a>) check box in preview. Check box is initially checked if <code>Set FORCENEWREVISIONCHECKBOX = checked="checked"</code>, or unchecked if empty: (can be overwritten by user preferences)<ul><li> Set FORCENEWREVISIONCHECKBOX = </li></ul></li></ul> <p /><ul><li> Default state of the <strong><em>Minor Changes, Don't Notify</em></strong> (<a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/TWiki/DontNotify">DontNotify</a>) check box in preview. Check box is initially checked if <code>Set DONTNOTIFYCHECKBOX = checked="checked"</code>, or unchecked if empty: (can be overwritten by user preferences)<ul><li> Set DONTNOTIFYCHECKBOX = </li></ul></li></ul> <p /><ul><li> Default state of the <strong><em>link</em></strong> check box in the attach file page. Checkbox is initially checked if <code>Set ATTACHLINKBOX = checked="checked"</code>, or unchecked if empty (<code>Set ATTACHLINKBOX =</code>). If checked, a link is created to the attached file at the end of the topic: (can be overwritten by user preferences)<ul><li> Set ATTACHLINKBOX = </li></ul></li></ul> <p /><ul><li> Format of file link when the <strong><em>link</em></strong> check box is checked: (can be overwritten by user preferences)<ul><li> %H% <strong>NOTE:</strong> Keyword <code><b>$name</b></code> gets expanded to filename; <code><b>$comment</b></code> to comment; <code><b>\t</b></code> to tab (3 spaces for bullets).</li><li> Set ATTACHEDFILELINKFORMAT = \t* <span class="twikiNewLink">$name<a href="http://www.dementia.org/twiki/bin/edit/TWiki/ATTACHURLname?topicparent=TWiki.WebRss" rel="nofollow" title="Create this topic"><sup>?</sup></a></span>: $comment</li></ul></li></ul> <p /><ul><li> Format of images when the <strong><em>link</em></strong> check box is checked: (can be overwritten by user preferences)<ul><li> %H% <strong>NOTE:</strong> Keyword <code><b>$name</b></code> gets expanded to filename; <code><b>$comment</b></code> to comment; <code><b>$size</b></code> to <code><b>width="..." height="..."</b></code> attribute of <code><b>img</b></code> tag; <code><b>\t</b></code> to tab (3 spaces for bullets).</li></ul></li></ul> <pre> * Set ATTACHEDIMAGEFORMAT = \t* $comment: <br /> <img src="%ATTACHURLPATH%/$name" alt="$name" $size /> </pre> <p /> <p /> <nop><h2><a name="TWiki_Platform_Settings"></a> TWiki Platform Settings </h2> <p /><ul><li> TWiki site name:<ul><li> Set WIKITOOLNAME = TWiki</li></ul></li></ul> <p /><ul><li> Image, URL and alternate tooltip text of the logo <strong>for this installation</strong>: you should change these settings for your site, or they can be overwridden in <nop>WebPreferences for individual webs by defining these variables there.<ul><li> Set WIKILOGOIMG = %PUBURL%/%TWIKIWEB%/TWikiLogos/T-logo-140x40-t.gif</li><li> Set WIKILOGOURL = <a href="http://TWiki.org/" target="_top">http://TWiki.org/</a></li><li> Set WIKILOGOALT = Powered by <nop>%WIKITOOLNAME%</li></ul></li></ul> <p /><ul><li> List of <nop>%WIKITOOLNAME% webs - on the first line of the upper toolbar (to add a new web, see <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/TWiki/ManagingWebs">ManagingWebs</a> and %TWIKIWEB%.SiteMap):<ul><li> Set WIKIWEBLIST = <span class="twikiNewLink">%MAINWEB%<a href="http://www.dementia.org/twiki/bin/edit/TWiki/MAINWEBHOMETOPIC?topicparent=TWiki.WebRss" rel="nofollow" title="Create this topic"><sup>?</sup></a></span> %SEP% <span class="twikiNewLink">%TWIKIWEB%<a href="http://www.dementia.org/twiki/bin/edit/TWiki/TWIKIWEBHOMETOPIC?topicparent=TWiki.WebRss" rel="nofollow" title="Create this topic"><sup>?</sup></a></span> %SEP% <span class="twikiNewLink">Sandbox<a href="http://www.dementia.org/twiki/bin/edit/Sandbox/HOMETOPIC?topicparent=TWiki.WebRss" rel="nofollow" title="Create this topic"><sup>?</sup></a></span> %SEP% <span class="twikiNewLink">Layout<a href="http://www.dementia.org/twiki/bin/edit/Layout/HOMETOPIC?topicparent=TWiki.WebRss" rel="nofollow" title="Create this topic"><sup>?</sup></a></span></li><li> %T% <strong>NOTE:</strong> To automatically list all non-hidden webs in alphabetical order, use the <code>%<nop>WEBLIST{}%</code> variable instead: <br /> %WEBLIST{"<span class="twikiNewLink">$name<a href="http://www.dementia.org/twiki/bin/edit/TWiki/NameHOMETOPIC?topicparent=TWiki.WebRss" rel="nofollow" title="Create this topic"><sup>?</sup></a></span>" separator=" %SEP% "}%</li></ul></li></ul> <p /><ul><li> Maximum size of %TWIKIWEB%.FileAttachments in KB, 0 for no limit:<ul><li> Set ATTACHFILESIZELIMIT = 10000</li></ul></li></ul> <p /><ul><li> Broadcast message for skins supporting a %<nop>BROADCASTMESSAGE% at the top of the page: (IMPORTANT: Set to empty message if not used; #Comment out unused messages)<ul><li> Set BROADCASTMESSAGE = </li><li> #Set BROADCASTMESSAGE = <table border="0" cellpadding="3" cellspacing="0" width="100%"><tr><td bgcolor="yellow"><font color="red"><strong>NOTE:</strong></font><font size="-1"> Edit and Attach will be disabled today between 05:00 PM and 06:00 PM PDT (00:00 to 01:00 GMT) for a scheduled <nop>%WIKITOOLNAME% maintenance. </font></td></tr></table></li><li> If you use <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/TWiki/PatternSkin">PatternSkin</a>:</li><li> #Set BROADCASTMESSAGE = <div class="twikiBroadcastMessage"> <strong>NOTE:</strong> Edit and Attach will be disabled today between 05:00 PM and 06:00 PM PDT (00:00 to 01:00 GMT) for a scheduled %WIKITOOLNAME% maintenance.</div></li></ul></li></ul> <p /> <nop><h3><a name="Search_Settings"></a> Search Settings </h3> <p /><ul><li> Default type for search, one of: keyword (for search engine like syntax), regex (for <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/TWiki/RegularExpression">RegularExpression</a> search), or literal (for verbatim search)<ul><li> Set SEARCHDEFAULTTTYPE = keyword</li></ul></li><li> Default for <code>%<nop>SEARCH{}%</code> variable, one of: keyword, regex, or literal<ul><li> Set SEARCHVARDEFAULTTYPE = literal</li></ul></li><li> Stop words, e.g., common words and characters to exclude from a keyword search:<ul><li> Set SEARCHSTOPWORDS = a, all, am, an, and, any, as, at, b, be, by, c, d, e, for, from, g, h, how, i, i'm, i.e., in, is, isn't, it, it's, its, j, k, l, m, n, o, of, on, or, p, q, r, s, t, that, that's, the, this, to, u, v, w, was, wasn't, what, what's, when, where, who, who's, will, with, x, y, z</li></ul></li></ul> <p /> <nop><h3><a name="Email_and_Proxy_Server_Settings"></a> Email and Proxy Server Settings </h3> <p /><ul><li> TWiki webmaster email address:<ul><li> Set WIKIWEBMASTER = <a href="mailto:shadow@dementia.org">shadow@dementia.org</a></li></ul></li></ul> <p /><ul><li> TWiki webmaster name (first name and last name, e.g. <code>Fred Smith</code>):<ul><li> Set WIKIWEBMASTERNAME = TWiki Administrator</li></ul></li></ul> <p /> <p /> <nop><h3><a name="Email_Link_Settings"></a> Email Link Settings </h3> <p /><ul><li> 'Mail this topic' mailto: link - can be included in topics, templates or skins<ul><li> Set MAILTHISTOPIC = <a href="mailto:?subject=%BASETOPIC%&amp;body=%TOPICURL%">%MAILTHISTOPICTEXT%</a></li></ul></li></ul> <p /><ul><li> 'Mail this topic' link text<ul><li> Set MAILTHISTOPICTEXT = Send a link to this page</li></ul></li></ul> <p /><ul><li> URL for current topic<ul><li> Set TOPICURL = %SCRIPTURL%/view%SCRIPTSUFFIX%/TWiki/%BASETOPIC%</li></ul></li></ul> <p /> <p /> <nop><h3><a name="HTTP_EQUIV_Settings"></a> HTTP-<nop>EQUIV Settings </h3> <p /><ul><li> %T% <strong>NOTE:</strong> Changing cache behaviour with these settings should not be necessary and may cause cache-related problems (e.g. <a href="http://twiki.org/cgi-bin/view/Codev/BackFromPreviewLosesText" title="'Codev/BackFromPreviewLosesText' on TWiki.org">TWiki:Codev/BackFromPreviewLosesText</a> or <a href="http://twiki.org/cgi-bin/view/Codev/RefreshEditPage" title="'Codev/RefreshEditPage' on TWiki.org">TWiki:Codev/RefreshEditPage</a>). These settings do not affect proxy caches.</li></ul> <p /><ul><li> <code><b>http-equiv</b></code> meta tags for <code><b>view</b></code>, <code><b>rdiff</b></code>, <code><b>attach</b></code>, <code><b>search*</b></code> scripts:</li></ul> <pre> * #Set HTTP_EQUIV_ON_VIEW = * Set HTTP_EQUIV_ON_VIEW = <link rel="alternate" type="application/rss+xml" title="RSS Feed" href="%SCRIPTURL%/view%SCRIPTSUFFIX%/TWiki/WebRss" /> </pre> <p /><ul><li> <code><b>http-equiv</b></code> meta tags for <code><b>edit</b></code> script:</li></ul> <pre> * Set HTTP_EQUIV_ON_EDIT = </pre> <p /><ul><li> <code><b>http-equiv</b></code> meta tags for <code><b>preview</b></code> script:</li></ul> <pre> * Set HTTP_EQUIV_ON_PREVIEW = </pre> <p /> <p /> <nop><h2><a name="Skin_Settings"></a> Skin Settings </h2> <p /><ul><li> Skin overriding the default TWiki templates: (can be overwritten by <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/TWiki/WebPreferences">WebPreferences</a> and user preferences) <ul><li> Set SKIN = pattern</li></ul></li></ul> <p /><ul><li> <strong><em>Note:</em></strong> See <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/TWiki/TWikiSkinBrowser">TWikiSkinBrowser</a> for currently installed skins</li></ul> <p /> <nop><h3><a name="PatternSkin"></a> <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/TWiki/PatternSkin">PatternSkin</a> </h3> <p /><ul><li> Default TWiki styles <ul><li> Set TWIKILAYOUTURL = %PUBURL%/%TWIKIWEB%/PatternSkin/layout.css</li><li> Set TWIKISTYLEURL = %PUBURL%/%TWIKIWEB%/PatternSkin/style.css</li><li> Set TWIKICOLORSURL = %PUBURL%/%TWIKIWEB%/PatternSkin/colors.css</li></ul></li><li> Custom overriding styles<ul><li> Set USERLAYOUTURL = %PUBURL%/%TWIKIWEB%/PatternSkin/empty.css</li><li> Set USERSTYLEURL = %PUBURL%/%TWIKIWEB%/PatternSkin/empty.css</li><li> Set USERCOLORSURL = %PUBURL%/%TWIKIWEB%/PatternSkin/empty.css</li></ul></li></ul> <p /> <nop><h3><a name="Skin_icons"></a> Skin icons </h3> <p /><ul><li> The topic from which graphics and icons are fetched with <code>%<nop>ICON{}%</code> syntax and in attachment tables. See %TWIKIWEB%.IconSets and %TWIKIWEB%.TWikiDocGraphics.<ul><li> Set ICONTOPIC = %TWIKIWEB%.TWikiDocGraphics</li></ul></li></ul> <p /> <nop><h3><a name="Legacy_support"></a> Legacy support </h3><ul><li> Support for legacy "EDITTOPIC", used to be hard-coded, now replaced by TMPL:P conditional instantiation<ul><li> Set EDITURL = %SCRIPTURL%/edit%SCRIPTSUFFIX%/TWiki/TWikiPreferences?t=%GMTIME{"$epoch"}%</li><li> Set EDITTOPIC = <a href="%EDITURL%" title="Edit Topic - deprecated usage - please see release notes">Edit</a></li></ul></li></ul> <p /> <nop><h2><a name="Plugins_Settings"></a> Plugins Settings </h2> <p /> Currently activated plugins: %ACTIVATEDPLUGINS% <p /> You can enable/disable plugins using the <span class="twikiNewLink">configure<a href="http://www.dementia.org/twiki/bin/edit/TWiki/SCRIPTURLconfigureSCRIPTSUFFIX?topicparent=TWiki.WebRss" rel="nofollow" title="Create this topic"><sup>?</sup></a></span> interface.<ul><li> Set DISABLEDPLUGINS = This variable is no longer supported</li><li> Set INSTALLEDPLUGINS = This variable is no longer supported. You can set the plugins execution order using the <span class="twikiNewLink">configure<a href="http://www.dementia.org/twiki/bin/edit/TWiki/SCRIPTURLconfigureSCRIPTSUFFIX?topicparent=TWiki.WebRss" rel="nofollow" title="Create this topic"><sup>?</sup></a></span> interface.</li><li> %T% <strong>NOTE:</strong> You can enable/disable plugins by passing a comma-separated list of plugin names in the <code>debugenableplugins</code> url parameter; for example, %SCRIPTURL%/view%SCRIPTSUFFIX%/TWiki/TWikiPreferences?debugenableplugins=DefaultPlugin will display this topic with all plugins disabled except the <span class="twikiNewLink">DefaultPlugin<a href="http://www.dementia.org/twiki/bin/edit/TWiki/DefaultPlugin?topicparent=TWiki.WebRss" rel="nofollow" title="Create this topic"><sup>?</sup></a></span>.</li><li> detailed diagnostics can be found in <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/TWiki/InstalledPlugins">InstalledPlugins</a></li></ul> <p /> <p /> <nop><h2><a name="Miscellaneous_Settings"></a> Miscellaneous Settings </h2> <p /><ul><li> Line break:<ul><li> Set BR = <br /></li></ul></li></ul> <p /><ul><li> Bullet sign:<ul><li> Set BULLET = •</li></ul></li></ul> <p /><ul><li> Line break and bullet with different levels of indentation:<ul><li> Set BB = <br />•</li><li> Set BB2 = <br />  •</li><li> Set BB3 = <br />    •</li><li> Set BB4 = <br />      •</li></ul></li></ul> <p /><ul><li> Colored text: (see more <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/TWiki/StandardColors">StandardColors</a>) <nop> <nop> <table class="twikiTable" cellspacing="1" cellpadding="1" border="0"> <tr><td bgcolor="#eaeaea" class="twikiFirstCol"> You type: </td><td bgcolor="#eaeaea"> <code>%<nop>RED% red text %<nop>ENDCOLOR% and %<nop>GREEN% green text %<nop>ENDCOLOR%</code> </td></tr> <tr><td bgcolor="#ffffff" class="twikiFirstCol"> You get: </td><td bgcolor="#ffffff"> %RED% red text %ENDCOLOR% and %GREEN% green text %ENDCOLOR% </td></tr> </table><ul><li> <strong><em>Note:</em></strong> <code>%<color>%</code> text must end with <code>%<nop>ENDCOLOR%</code>. If you want to switch from one color to another one you first need to end the active color with <code>%<nop>ENDCOLOR%</code>, e.g. write <code>%<nop>RED% some text %<nop>ENDCOLOR% %<nop>GREEN% more text %<nop>ENDCOLOR%</code>. </li><li> %YELLOW% <strong>Set YELLOW = looks like this</strong> %ENDCOLOR%</li><li> %ORANGE% <strong>Set ORANGE = looks like this</strong> %ENDCOLOR%</li><li> %RED% <strong>Set RED = looks like this</strong> %ENDCOLOR%</li><li> %PINK% <strong>Set PINK = looks like this</strong> %ENDCOLOR%</li><li> %PURPLE% <strong>Set PURPLE = looks like this</strong> %ENDCOLOR%</li><li> %TEAL% <strong>Set TEAL = looks like this</strong> %ENDCOLOR%</li><li> %NAVY% <strong>Set NAVY = looks like this</strong> %ENDCOLOR%</li><li> %BLUE% <strong>Set BLUE = looks like this</strong> %ENDCOLOR%</li><li> %AQUA% <strong>Set AQUA = looks like this</strong> %ENDCOLOR%</li><li> %LIME% <strong>Set LIME = looks like this</strong> %ENDCOLOR%</li><li> %GREEN% <strong>Set GREEN = looks like this</strong> %ENDCOLOR%</li><li> %OLIVE% <strong>Set OLIVE = looks like this</strong> %ENDCOLOR%</li><li> %MAROON% <strong>Set MAROON = looks like this</strong> %ENDCOLOR%</li><li> %BROWN% <strong>Set BROWN = looks like this</strong> %ENDCOLOR%</li><li> %BLACK% <strong>Set BLACK = looks like this</strong> %ENDCOLOR%</li><li> %GRAY% <strong>Set GRAY = looks like this</strong> %ENDCOLOR%</li><li> %SILVER% <strong>Set SILVER = looks like this</strong> %ENDCOLOR%</li><li> <span style='background : #808080;'>%WHITE% <strong>Set WHITE = looks like this (with gray background)</strong> %ENDCOLOR%</span></li><li> The following color settings are enclosed in verbatim tags to avoid incorrect nesting of XHTML tags:</li></ul></li></ul> <pre> * Set YELLOW = <font color="#ffff00"> * Set ORANGE = <font color="#ff6600"> * Set RED = <font color="#ff0000"> * Set PINK = <font color="#ff00ff"> * Set PURPLE = <font color="#800080"> * Set TEAL = <font color="#008080"> * Set NAVY = <font color="#000080"> * Set BLUE = <font color="#0000ff"> * Set AQUA = <font color="#00ffff"> * Set LIME = <font color="#00ff00"> * Set GREEN = <font color="#008000"> * Set OLIVE = <font color="#808000"> * Set MAROON = <font color="#800000"> * Set BROWN = <font color="#996633"> * Set BLACK = <font color="#000000"> * Set GRAY = <font color="#808080"> * Set SILVER = <font color="#c0c0c0"> * Set WHITE = <font color="#ffffff"> * Set ENDCOLOR = </font> </pre> <p /> <a name="DocGraphics"></a><ul><li> Graphics used in TWiki documentation - view all images in %ICONTOPIC%. <em>(There are various ways to set up common icons as text variables. This is simply one quick approach.)</em>:<ul><li> Set H = %ICON{"help"}%</li><li> Set I = %ICON{"tip"}%</li><li> Set M = %ICON{"arrowright"}%</li><li> Set N = %ICON{"new"}%</li><li> Set P = %ICON{"pencil"}%</li><li> Set Q = %ICON{"help"}%</li><li> Set S = %ICON{"starred"}%</li><li> Set T = %ICON{"tip"}%</li><li> Set U = %ICON{"updated"}%</li><li> Set X = %ICON{"warning"}%</li><li> Set Y = %ICON{"choice-yes"}%</li></ul></li></ul> <p /><ul><li> Background color of non existing topic: ( default <code>cornsilk</code> or <code>#FFFFCE</code> )<ul><li> Set NEWTOPICBGCOLOR = #FFFFCE</li></ul></li></ul> <p /><ul><li> Font color of non existing topic: ( default <code>#0000FF</code> )<ul><li> Set NEWTOPICFONTCOLOR = #0000FF</li></ul></li></ul> <p /><ul><li> %TWIKIWEB%.PreviewBackground image:<ul><li> Set PREVIEWBGIMAGE = %PUBURLPATH%/%TWIKIWEB%/PreviewBackground/preview2bg.gif</li></ul></li></ul> <p /> <p /> <nop><h2><a name="Access_Control_Settings"></a> Access Control Settings </h2> <p /><ul><li> Users or groups allowed to <span class="twikiNewLink">create new webs<a href="http://www.dementia.org/twiki/bin/edit/TWiki/TWIKIWEBManagingWebs?topicparent=TWiki.WebRss" rel="nofollow" title="Create this topic"><sup>?</sup></a></span>: (ex: %MAINWEB%.TWikiAdminGroup)<ul><li> #Set ALLOWWEBMANAGE = %MAINWEB%.TWikiAdminGroup</li></ul></li></ul> <p /> <nop><h2><a name="Creating_New_Preference_Variable"></a> Creating New Preference Variables </h2> <p /> You can introduce new VARIABLES and use them in your topics and templates. There is no need to change the TWiki engine (Perl scripts).<ul><li> A preference is defined in a <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/TWiki/TWikiShorthand">TWikiShorthand</a> bullet item: <code><b>[3 spaces] * [space] Set NAME = value</b></code> <br /> Example (as a nested bullet item, indented 6 spaces):<ul><li> S<nop>et WEBBGCOLOR = #FFFFC0</li></ul></li><li> Preferences are used as %TWIKIWEB%.TWikiVariables by enclosing the name in percent signs: <code><b>%</b></code>. Example:<ul><li> When you write variable <code><b>%WEB<nop>BGCOLOR%</b></code>, it gets expanded to <code>%WEBBGCOLOR%</code> .</li></ul></li></ul> <p /><ul><li> %X% The sequential order of the preference settings is significant. Define preferences that use other preferences FIRST. For example, set <code><b><nop>WEBCOPYRIGHT</b></code> before <code><b><nop>WIKIWEBMASTER</b></code> since the copyright notice uses the webmaster email address.</li><li> %X% In order to protect your custom variables from being overwritten when upgrading the <span class="twikiNewLink">%TWIKIWEB%.TWikiPreferences<a href="http://www.dementia.org/twiki/bin/edit/TWiki/TWIKIWEBTWikiPreferences?topicparent=TWiki.WebRss" rel="nofollow" title="Create this topic"><sup>?</sup></a></span> topic, it is recommended that custom variables are defined in <span class="twikiNewLink">%MAINWEB%.TWikiPreferences<a href="http://www.dementia.org/twiki/bin/edit/TWiki/MAINWEBTWikiPreferences?topicparent=TWiki.WebRss" rel="nofollow" title="Create this topic"><sup>?</sup></a></span>.</li></ul> <p /> <p /> <nop><h2><a name="Related_Topics"></a> Related Topics </h2> <p /><ul><li> %WEBPREFSTOPIC% has preferences of the <nop>TWiki web.</li><li> %MAINWEB%.%WIKIUSERSTOPIC% has a list of user topics. User topics can have optional user preferences.</li><li> %TWIKIWEB%.TWikiVariables has a list of common <code>%<nop>VARIABLES%</code>.</li><li> %TWIKIWEB%.TWikiAccessControl explains how to restrict access by users or groups.</li><li> <a href="http://twiki.org/cgi-bin/view/Plugins/PreferencesPlugin" title="'Plugins/PreferencesPlugin' on TWiki.org">TWiki:Plugins/PreferencesPlugin</a> makes editing preferences a snap.</li></ul> <p /> <strong><em>Note</em></strong>: Can't edit? <span class="twikiNewLink">View raw topic<a href="http://www.dementia.org/twiki/bin/edit/TWiki/SCRIPTURLviewSCRIPTSUFFIXTWikiTWikiPreferencesrawon?topicparent=TWiki.WebRss" rel="nofollow" title="Create this topic"><sup>?</sup></a></span>  <p /><ul><li> Set ALLOWTOPICCHANGE = <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/Main/TWikiAdminGroup">TWikiAdminGroup</a></li></ul> <nop> <p /> <div></div> </form> (last changed by DerrickBrashear) 2005-12-04T23:04Z DerrickBrashear 75 updated major http://www.dementia.org/twiki/bin/rdiff/TWiki/TWikiPreferences http://www.dementia.org/twiki/bin/rdiff/TWiki/TWikiPreferences TWikiNetDotPm http://www.dementia.org/twiki/bin/view/TWiki/TWikiNetDotPm?t=2005-11-06T13:56Z <nop><h1><a name="Package_TWiki_Net"></a><a name="Package_TWiki_Net_"></a> Package <code>TWiki::Net</code> </h1> <p /> Object that brokers access to network resources. <p /> <p /> %TOC% <p /> <nop><h2><a name="ObjectMethod_getUrl_theHost_theP"></a> <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/TWiki/ObjectMethod">ObjectMethod</a> <strong>getUrl</strong> <tt>($theHost,$thePort,$theUrl,$theUser,$thePass,$theHeader) -> $text</tt> </h2> <p /> Get the text at the other end of a URL <p /> <p /> <p /> <nop><h2><a name="set_MailHandler_fn"></a><a name="set_MailHandler_fn_"></a> setMailHandler( \&fn ) </h2><ul><li> <code>\&fn</code> - reference to a function($) (see _sendEmailBySendmail for proto)</li></ul> Install a handler function to take over mail sending from the default SMTP or sendmail methods. This is provided mainly for tests that need to be told when a mail is sent, without actually sending it. It may also be useful in the event that someone needs to plug in an alternative mail handling method. <p /> <p /> <nop><h2><a name="ObjectMethod_sendEmail_theText_r"></a> <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/TWiki/ObjectMethod">ObjectMethod</a> <strong>sendEmail</strong> <tt>($theText,$retries) -> $error</tt> </h2><ul><li> <code>$theText</code> - text of the mail, including MIME headers</li><li> <code>$retries</code> - number of times to retry the send (default 1)</li></ul> <p /> Send an email specified as MIME format content. Date: ...\nFrom: ...\nTo: ...\nCC: ...\nSubject: ...\n\nMailBody... <p /> (last changed by TWikiContributor) 2005-11-06T13:56Z TWikiContributor 1 updated major http://www.dementia.org/twiki/bin/rdiff/TWiki/TWikiNetDotPm http://www.dementia.org/twiki/bin/rdiff/TWiki/TWikiNetDotPm TWikiTemplatesDotPm http://www.dementia.org/twiki/bin/view/TWiki/TWikiTemplatesDotPm?t=2005-11-06T13:56Z <nop><h1><a name="Package_TWiki_Templates"></a><a name="Package_TWiki_Templates_"></a> Package <code>TWiki::Templates</code> </h1> <p /> Support for the TWiki template language. <p /> <p /> %TOC% <p /> The following tokens are supported by this language: <p /> <nop> <nop> <nop> <nop> <nop> <table class="twikiTable" cellspacing="1" cellpadding="1" border="0"><tr><td bgcolor="#eaeaea" class="twikiFirstCol"> %<nop>TMPL:P% </td><td bgcolor="#eaeaea"> Instantiates a previously defined template </td></tr> <tr><td bgcolor="#ffffff" class="twikiFirstCol"> %<nop>TMPL:DEF% </td><td bgcolor="#ffffff"> Opens a template definition </td></tr> <tr><td bgcolor="#eaeaea" class="twikiFirstCol"> %<nop>TMPL:END% </td><td bgcolor="#eaeaea"> Closes a template definition </td></tr> <tr><td bgcolor="#ffffff" class="twikiFirstCol"> %<nop>TMPL:INCLUDE% </td><td bgcolor="#ffffff"> Includes another file of templates </td></tr> <tr><td bgcolor="#eaeaea" class="twikiFirstCol"> %<nop>TMPL:MAKETEXT% </td><td bgcolor="#eaeaea"> Translates text into the user's language </td></tr> </table> <p /> Note; the template cache does not get reset during initialisation, so the haveTemplate test will return true if a template was loaded during a previous run when used with mod_perl or speedycgi. Frustrating for the template author, but they just have to switch off the accelerators during development. <p /> This is to all intents and purposes a singleton object. It could easily be coverted into a true singleton (template manager). <p /> <p /> <nop><h2><a name="ClassMethod_new_session"></a><a name="ClassMethod_new_session_"></a> <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/TWiki/ClassMethod">ClassMethod</a> <strong>new</strong> <tt>($session)</tt> </h2> <p /> Constructor. Creates a new template database object.<ul><li> $session - session (TWiki) object</li></ul> <p /> <p /> <p /> <nop><h2><a name="ObjectMethod_haveTemplate_name_b"></a> <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/TWiki/ObjectMethod">ObjectMethod</a> <strong>haveTemplate</strong> <tt>($name) -> $boolean</tt> </h2> <p /> Return true if the template exists and is loaded into the cache <p /> <p /> <p /> <nop><h2><a name="ObjectMethod_expandTemplate_para"></a> <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/TWiki/ObjectMethod">ObjectMethod</a> <strong>expandTemplate</strong> <tt>($params) -> $string</tt> </h2> <p /> Expand the template specified in the parameter string using <code>tmplP</code>. <p /> Examples: <pre> $tmpls->expandTemplate('"blah"); $tmpls->expandTemplate('context="view" then="sigh" else="humph"'); ---++ ObjectMethod *tmplP* <tt>($attrs) -> $string</tt> Return value expanded text of the template, as found from looking in the register of template definitions. The attrs can contain a template name in _DEFAULT, and / or =context=, =then= and =else= values. Recursively expands any contained TMPL:P tags. Note that it would be trivial to add template parameters to this, simply by iterating over the other parameters (other than _DEFAULT, context, then and else) and doing a s/// in the template for that parameter value. This would add considerably to the power of templates. There is already code to do this in the MacrosPlugin. --++ ObjectMethod _expandMaketext( $params ) -> $translation Translates a string to the current language. Supports the following formats: * =%<nop>TMPL:MAKETEXT{ ... }%= * =%_{ ... }%= Inside the { ... }, there should be a comma-separated list of double-quoted strings, like: <code>"Translate this [_1] for [_2]", "parameter one", "parameter two".</code> Return value: (eventually) translated text ---++ ObjectMethod *readTemplate* <tt>($name,$skins,$web) -> $text</tt> Return value: expanded template text Reads a template, constructing a candidate name for the template thus 0 looks for file =$name.$skin.tmpl= (for each skin) 0 in =templates/$web= 0 in =templates=, look for 0 looks for file =$name.tmpl= 0 in =templates/$web= 0 in =templates=, look for 0 if a template is not found, tries in this order 0 parse =$name= into a web name (default to $web) and a topic name and looks for this topic 0 looks for topic =${skin}Skin${name}Template= 0 in $web (for each skin) 0 in =TWiki::cfg{SystemWebName}= (for each skin) 0 looks for topic =${name}Template= 0 in $web (for each skin) 0 in =TWiki::cfg{SystemWebName}= (for each skin) In the event that the read fails (template not found, access permissions fail) returns the empty string ''. =$skin=, =$web= and =$name= are forced to an upper-case first character when composing user topic names. If template text is found, extracts include statements and fully expands them. Also extracts template definitions and adds them to the list of loaded templates, overwriting any previous definition. <nop> </pre> (last changed by TWikiContributor) 2005-11-06T13:56Z TWikiContributor 1 updated major http://www.dementia.org/twiki/bin/rdiff/TWiki/TWikiTemplatesDotPm http://www.dementia.org/twiki/bin/rdiff/TWiki/TWikiTemplatesDotPm TWikiPrefsParserDotPm http://www.dementia.org/twiki/bin/view/TWiki/TWikiPrefsParserDotPm?t=2005-11-06T13:56Z <nop><h1><a name="Package_TWiki_Prefs_Parser"></a><a name="Package_TWiki_Prefs_Parser_"></a> Package <code>TWiki::Prefs::Parser</code> </h1> <p /> 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 <span class="twikiNewLink">TopicPrefs<a href="http://www.dementia.org/twiki/bin/edit/TWiki/TopicPrefs?topicparent=TWiki.WebRss" rel="nofollow" title="Create this topic"><sup>?</sup></a></span> to parse preference settings from topics. <p /> This class does no validation or duplicate-checking on the settings; it simply returns the recognized settings in the order it sees them in. <p /> <p /> %TOC% <p /> <nop><h2><a name="ClassMethod_new_topicparserobjec"></a> <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/TWiki/ClassMethod">ClassMethod</a> <strong>new</strong> <tt>() -> topicparserobject</tt> </h2> <p /> Construct a new parser object. <p /> <p /> <p /> <nop><h2><a name="ObjectMethod_parseText_text_pref"></a> <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/TWiki/ObjectMethod">ObjectMethod</a> <strong>parseText</strong> <tt>($text,$prefs)</tt> </h2> <p /> Parse settings from text and add them to the preferences in $prefs <p /> <p /> <p /> <nop><h2><a name="ObjectMethod_parseMeta_metaObjec"></a> <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/TWiki/ObjectMethod">ObjectMethod</a> <strong>parseMeta</strong> <tt>($metaObject,$prefs)</tt> </h2> <p /> Traverses through all PREFERENCE attributes of the meta object, creating one setting named with $settingPrefPrefix . 'title' for each. It also creates an entry named with the field 'name', which is a cleaned-up, space-removed version of the title. <p /> Settings are added to the $prefs passed. <p /> (last changed by TWikiContributor) 2005-11-06T13:56Z TWikiContributor 1 updated major http://www.dementia.org/twiki/bin/rdiff/TWiki/TWikiPrefsParserDotPm http://www.dementia.org/twiki/bin/rdiff/TWiki/TWikiPrefsParserDotPm DakarReleaseNotes http://www.dementia.org/twiki/bin/view/TWiki/DakarReleaseNotes?t=2005-11-06T13:56Z <nop><h1><a name="TWiki_Dakar_Release"></a><a name="_TWiki_Dakar_Release"></a> TWiki 'Dakar' Release </h1> 'Dakar' is the first major release of the TWiki collaboration environment in over a year. The focus of this release has been on refactoring the code in the interests of <strong>security</strong>, <strong>efficiency</strong> and <strong>maintainability</strong>, though a range of powerful new features are also included. The refactoring work has included tightening up the specification of certain key TWiki behaviours, which has resulted in some specification changes. The impact on end users has been minimised as far as possible. <p /> Key new features:<ul><li> Much simpler install and configuration</li><li> Integrated session support</li><li> Security sandbox blocks all possible routes for remote command excution on the server</li><li> New editing model allows freer collaboration, without fear of overwriting other people's changes</li><li> Multilingual UI</li><li> Email confirmations for registration</li><li> Hierarchical sub-webs</li></ul> <p /> Most of the redesign, refactoring and documentation work in Dakar release was done by <a href="http://twiki.org/cgi-bin/view/Main.CrawfordCurrie" target="_top">Crawford <nop>Currie</a> (<a href="http://c-dot.co.uk" target="_top">http://c-dot.co.uk</a>). Other major code contributions were made by:<ul><li> <a href="http://twiki.org/cgi-bin/view/Main.AntonioTerceiro" target="_top">Antonio <nop>Terceiro</a> - internationalization framework</li><li> <a href="http://twiki.org/cgi-bin/view/Main.ArthurClemens" target="_top">Arthur <nop>Clemens</a> - templates</li><li> <a href="http://twiki.org/cgi-bin/view/Main.FlorianWeimer" target="_top">Florian <nop>Weimer</a> - security sandbox</li><li> <a href="http://twiki.org/cgi-bin/view/Main.GregAbbas" target="_top">Greg <nop>Abbas</a> - integration of <nop>SessionPlugin</li><li> <a href="http://twiki.org/cgi-bin/view/Main.MartinCleaver" target="_top">Martin <nop>Cleaver</a> - registration process, and automatic attachments</li><li> <a href="http://twiki.org/cgi-bin/view/Main.PeterNixon" target="_top">Peter <nop>Nixon</a> - hierarchical subwebs support</li><li> <a href="http://twiki.org/cgi-bin/view/Main.ThomasWeigert" target="_top">Thomas <nop>Weigert</a> - preferences editing</li></ul> Other people who gave significant amounts of their time and patience to less sexy aspects of the work, or were pivotal in the design process, are:<ul><li> <a href="http://twiki.org/cgi-bin/view/Main.AntonAylward" target="_top">Anton <nop>Aylward</a></li><li> <a href="http://twiki.org/cgi-bin/view/Main.LynnwoodBrown" target="_top">Lynnwood <nop>Brown</a></li><li> <a href="http://twiki.org/cgi-bin/view/Main.MichaelDaum" target="_top">Michael <nop>Daum</a></li><li> <a href="http://kamaelia.org/Michael.html" target="_top">Michael <nop>Sparks</a></li><li> <a href="http://twiki.org/cgi-bin/view/Main.SvenDowideit" target="_top">Sven <nop>Dowideit</a></li><li> <a href="http://twiki.org/cgi-bin/view/Main.WillNorris" target="_top">Will <nop>Norris</a></li></ul> There were many other contributors; for a full list, visit %MAINWEB%.TWikiContributor. <p /> Note: In what follows, {This} (words in curly braces) refers to settings in the new 'configure' interface. <p /> %TOC% <p /> <nop><h2><a name="Notes_for_end_users"></a> Notes for end users </h2> <p /> <nop><h3><a name="Editing_at_the_same_time_as_othe"></a> Editing at the same time as other people </h3> <p /> Dakar release introduces a brand-new strategy for handling simultaneous changes to a topic by several people. Instead of one person locking the topic, and other having to wait until they are finished, Dakar allows multiple simultaneous edits of the same topic, and then <em>merges</em> the different changes. <p /> You probably won't even notice this happening unless you are changing existing text in the file at the same time as someone else. In this case, you may see TWiki inserting "change marks" into the text to highlight conflicts between your edits and another persons. 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. For example, let's say you have a topic that contains this text: <table> <tr bgcolor="lightgrey"><th>You edit</th><th>You see</th></tr> <tr bgcolor="lightgrey"><td> <pre> Casablanca is Humphrey Bogart's finest film. Of all the gin joints in all the world, you had to walk into mine. </pre> </td><td> Casablanca is Humphrey Bogart's finest film. Of all the gin joints in all the world, you had to walk into mine. </td></tr> <tr><td colspan=2>and you start editing this text before going for coffee. Meanwhile, a colleague also starts editng the same topic and changes the text to:</td></tr> <tr bgcolor="lightgrey"><td> <pre> <b>The Maltese Falcon</b> is Humphrey Bogart's finest film. Of all the gin joints in all the world, you had to walk into mine. </pre> </td><td> The Maltese Falcon is Humphrey Bogart's finest film. Of all the gin joints in all the world, you had to walk into mine. </td></tr> <tr><td colspan=2>When you get back from coffee, you finish your edit, changing the text to</td></tr> <tr bgcolor="lightgrey"><td> <pre> <b>To Have or Have Not</b> is Humphrey Bogart's finest film. <b>You know how to whistle, don't you Steve? You just put your lips together and blow.</b> </pre> </td><td> To Have or Have Not is Humphrey Bogart's finest film. You know how to whistle, don't you Steve? You just put your lips together and blow. </td></tr> <tr><td colspan=2>and saving it. The topic will now look like this when you display it:</td></tr> <tr bgcolor="lightgrey"><td> <pre> <div class="twikiConflict"><b>CONFLICT</b> original 5:</div> Casablanca is <div class="twikiConflict"><b>CONFLICT</b> version 6:</div> The Maltese Falcon is <div class="twikiConflict"><b>CONFLICT</b> version 7:</div> To Have or Have Not is <div class="twikiConflict"><b>CONFLICT</b> end</div> Humphrey Bogart's finest film. You know how to whistle, don't you Steve? You just put your lips together and blow. </pre> </td><td> <div class="twikiConflict"><b>CONFLICT</b> original 5:</div> Casablanca is <div class="twikiConflict"><b>CONFLICT</b> version 6:</div> The Maltese Falcon is <div class="twikiConflict"><b>CONFLICT</b> version 7:</div> To Have or Have Not is <div class="twikiConflict"><b>CONFLICT</b> end</div> Humphrey Bogart's finest film. You know how to whistle, don't you Steve? You just put your lips together and blow. </td></tr> </table> As you can see, your changes have been merged with your colleagues. The merge is done on a line-by-line basis, and if your changes do not overlap, then change marks will not be used (as is the case for the last line of the example). <p /> Merging only applies to text fields. When there are conflicts in field data in forms such as checkboxes, radio buttons and selects, the most recent change (usually your change) always wins, even if someone else has changed the form since you started editing. All changes are of course available from the topic history. <p /> Because there are cases where you actually want to avoid overlapping edits altogether (e.g. if you are changing forms data) TWiki will <strong>warn</strong> if you attempt to edit a topic that someone else is editing. It will also warn if a merge was required during a save. <p /> <nop><h3><a name="User_Interface_Internationalisat"></a> User Interface Internationalisation </h3> <p /> TWiki will now pick up the language you are using in your browser, and try to present system messages in that language, if it is available. If your preferred language is not available, TWiki will revert to English. You'll also have an option to choose a language different from that used in your browser. <p /> User Interface Internationalisation support is optional and enabled by the {UseInternationalisation} setting. <p /> The translation is performed by the Perl standard internationalization framework. If you want to contribute a new language, it would be most welcome: See <a href="http://twiki.org/cgi-bin/view/Codev.UserInterfaceLocalisation" title="'Codev.UserInterfaceLocalisation' on TWiki.org">TWiki:Codev.UserInterfaceLocalisation</a> for instructions on how to help. <p /> <nop><h3><a name="New_options_on_the_editing_scree"></a> New options on the editing screen </h3> <p /> You will notice a couple of changes to the editing screen; first, there is no switch for releasing the edit lock any more (if locks are enabled, they are always released when an edit finishes). You will also notice a new "force new revision" checkbox. TWiki normally doesn't add a new revision if the same user re-edits a topic within a certain time period; this checkbox allows you to <em>force</em> TWiki to add a revision for every change, regardless of how small it is. <p /> <nop><h3><a name="Change_notification"></a> Change notification </h3> <p /> You now have much more control over <em>which</em> topics in a web you are interested in changes to. You can choose to receive notifications about topics selected by name, or by their parent relationship. See %TWIKIWEB%.MailerContrib for more details. <p /> <nop><h3><a name="Parameterised_Includes"></a> Parameterised Includes </h3> <code>%<nop>INCLUDE</code> tags have a predefined set of parameters. In the past, any parameters not in this set were simply ignored. With Dakar, these parameters are now defined as <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/TWiki/TWikiVariables">TWikiVariables</a> within the included topic - for example, <pre> %INCLUDE{ "BugList" FAVOURITE="Damsel Flies" }% </pre> will define <code>%FAVOURITE%</code> as <code>Damsel Flies</code> in the included topic, so if <code>BugList</code> contained the line <pre> My favourite bugs are %FAVOURITE% </pre> it will be expanded to <pre> My favourite bugs are Damsel Flies </pre> <p /> <nop><h3><a name="Named_Section_Include"></a> Named Section Include </h3> <p /> <code>%<nop>INCLUDE</code> tag allows to include only a named section of the included topic. These sections are defined in the included topic using the <code>%<nop>SECTION%</code> and <code>%<nop>ENDSECTION%</code> tags. For example, if the included topic has: <p /> <pre> ---+ News ---++ IT News All news related to IT. %SECTION{"itnews"}% * 2005-10-02 Final deployment of Dakar * 2005-10-01 Moving platform to Dakar %ENDSECTION{"itnews"}% </pre> <p /> Using <code>%<nop>INCLUDE{ "AllNews" section="itnews" }%</code> will produce: <pre> * 2005-10-02 Final deployment of Dakar * 2005-10-01 Moving platform to Dakar </pre> <p /> This syntax also allows for nested sections. For example, given the following topic: <pre> %SECTION{"outer"}% * Top Outer Text %SECTION{"inner"}% * Inner Text %ENDSECTION{"inner"}% * Top Outer Text %ENDSECTION{"outer"}% </pre> <p /> Using <code>%<nop>INCLUDE{"SampleTopic" section="outer"}%</code> will produce: <pre> * Top Outer Text * Inner Text * Top Outer Text </pre> <p /> And <code>%<nop>INCLUDE{"SampleTopic" section="inner"}%</code> will produce: <pre> * Inner Text </pre> <p /> In the same line, overlapped sections are allowed. <p /> <nop><h2><a name="Notes_for_TWikiAdmins_and_WikiMa"></a> Notes for <nop>TWikiAdmins and <nop>WikiMasters </h2> <p /> <nop><h3><a name="Upgrading"></a> Upgrading </h3> See <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/TWiki/TWikiUpgradeGuide">TWikiUpgradeGuide</a> for help in upgrading an existing Cairo (Sep 2004) installation. <p /> <nop><h3><a name="Security"></a> Security </h3> <p /> Dakar Release introduces the use of 'safe pipes' to prevent any malicious request from executing code on the server. This strategy stops any of the known attacks dead in its tracks. The Dakar codebase has not been impacted by any of the recent security advisories in any way. Several public sites have been running Dakar code for some months now, and to the best of our knowledge none has been hacked. <p /> <nop><h3><a name="CPAN_Requirements"></a> CPAN Requirements </h3> <p /> <a href="http://search.cpan.org/perldoc?Text::Diff" title="CPAN perl repository">CPAN:Text::Diff</a> is a prerequisite for the <span class="twikiNewLink">UpgradeTWiki<a href="http://www.dementia.org/twiki/bin/edit/TWiki/UpgradeTWiki?topicparent=TWiki.WebRss" rel="nofollow" title="Create this topic"><sup>?</sup></a></span> script only. <a href="http://search.cpan.org/perldoc?URI" title="CPAN perl repository">CPAN:URI</a> is a prerequisite for <code>configure</code>. Other new prerequisites are <a href="http://search.cpan.org/perldoc?CGI::Session" title="CPAN perl repository">CPAN:CGI::Session</a> and <a href="http://search.cpan.org/perldoc?CGI::Cookie" title="CPAN perl repository">CPAN:CGI::Cookie</a>, if you want to take advantage of the new session support. <p /> If you want user interface internationalization support, <a href="http://search.cpan.org/perldoc?Locale::Maketext::Lexicon" title="CPAN perl repository">CPAN:Locale::Maketext::Lexicon</a> and <a href="http://search.cpan.org/perldoc?Encode" title="CPAN perl repository">CPAN:Encode</a> (in perl 5.8's core) are required, as well as perl 5.8 or higher. See <a href="http://twiki.org/cgi-bin/view/Codev.UserInterfaceLocalisation" title="'Codev.UserInterfaceLocalisation' on TWiki.org">TWiki:Codev.UserInterfaceLocalisation</a> for details on TWiki internationalization support. <p /> <nop><h3><a name="Installation_and_configuration"></a> Installation and configuration </h3> <p /> The installation and configuration processes has been significantly simplified. <p /> <nop><h4><a name="setlib_cfg"></a> setlib.cfg </h4> The installer should now provide a file called <code>LocalLib.cfg</code> that contains local path settings. <code>setlib.cfg</code> contains documentation of what has to be done. Old <code>setlib.cfg</code> files <strong>will not work</strong> with Dakar. <p /> <nop><h4><a name="TWiki_cfg"></a> TWiki.cfg </h4> <code>TWiki.cfg</code> now contains all the default configuration settings, and the installer should provide a file called <code>LocalSite.cfg</code> that contains just those settings that are different to the defaults. The syntax of the settings in the file has also changed. Old <code>TWiki.cfg</code> files <strong>will not work</strong> with Dakar. The <nop>UpgradeTWiki script can be used to automate most of the necessary changes. <p /> <nop><h4><a name="testenv_configure"></a><a name="_testenv_configure_"></a> <code>testenv</code> / <code>configure</code> </h4> <code>testenv</code> has been removed, and replaced with the new <code>configure</code> interface. This interface performs all the checking functions of the old <code>testenv</code>, adds several new ones (including permissions checks) and also acts as a browser interface allowing you to do <strong>all</strong> TWiki configuration from the browser. <code>configure</code> is now the main installation interface for TWiki. <p /> The <code>configure</code> script can be used like the old <code>testenv</code> for public review of the configuration of the site. Saving from the interface is password-protected, using a password set in the configuration files, so to ordinary users <code>configure</code> just looks like a posh version of <code>testenv</code>. If you want to hide your configuration from public view, you can restrict access to the script webserver access controls (Apache users see the Apache documentation on the 'require' directive for more infomation on how to do this). <p /> <nop><h4><a name="configure_optional_features"></a><a name="_configure_optional_features"></a> <code>configure</code> optional features </h4> <p /> New optional features include {AutoAttachPubFiles} and {EnableHierarchicalWebs}. Both are switched off by default but can be enabled in <code>configure</code>. <p /> <nop><h3><a name="Preferences"></a> Preferences </h3> <p /> There have been some significant changes to the handling of preferences, aimed at making them more logical, consistent and easy to use. <p /> Preferences are now evaluated in the following order:<ol><li> Topic</li><li> Web</li><li> Session</li><li> User</li><li> Local Site (as set in {LocalSitePreferences})</li><li> Default (as set in {SitePrefsTopic})</li></ol> this is a change from previous versions, where the User preferences were evaluated between the topic and the web. <p /> Note that a user can still dictate preference values that can't be overridden, but they will now need to set those preferences as FINALPREFERENCES. <p /> Permissions controls are not affected by this change. <p /> <nop><h4><a name="Changes_to_the_evaluation_order"></a> Changes to the evaluation order </h4> The rules for preference evaluation (whether the user setting overrides the topic setting etc) have always been a bit confused. <p /> <nop><h4><a name="Preferences_Plugin"></a> Preferences Plugin </h4> <a href="http://twiki.org/cgi-bin/view/Plugins.PreferencesPlugin" title="'Plugins.PreferencesPlugin' on TWiki.org">TWiki:Plugins.PreferencesPlugin</a> has been included to allow more convenient editing of preferences. This plugin provides input controls, such as menus, radio buttons, and checkboxes to select preference settings. <p /> The following standard preferences have been removed: <span class="twikiNewLink">MAILTHISTOPIC<a href="http://www.dementia.org/twiki/bin/edit/TWiki/SCRIPTURLsearchSCRIPTSUFFIXscopetextweballordertopicsearch25MAILTHISTOPIC25casesensitiveonlimitall?topicparent=TWiki.WebRss" rel="nofollow" title="Create this topic"><sup>?</sup></a></span>, <span class="twikiNewLink">MAILTHISTOPICTEXT<a href="http://www.dementia.org/twiki/bin/edit/TWiki/SCRIPTURLsearchSCRIPTSUFFIXscopetextweballordertopicsearch25MAILTHISTOPICTEXT25casesensitiveonlimitall?topicparent=TWiki.WebRss" rel="nofollow" title="Create this topic"><sup>?</sup></a></span>, <span class="twikiNewLink">TOPICURL<a href="http://www.dementia.org/twiki/bin/edit/TWiki/SCRIPTURLsearchSCRIPTSUFFIXscopetextweballordertopicsearch25TOPICURL25casesensitiveonlimitall?topicparent=TWiki.WebRss" rel="nofollow" title="Create this topic"><sup>?</sup></a></span>, <span class="twikiNewLink">READTOPICPREFS<a href="http://www.dementia.org/twiki/bin/edit/TWiki/SCRIPTURLsearchSCRIPTSUFFIXscopetextweballordertopicsearch25READTOPICPREFS25casesensitiveonlimitall?topicparent=TWiki.WebRss" rel="nofollow" title="Create this topic"><sup>?</sup></a></span>, <span class="twikiNewLink">TOPICOVERRIDESUSER<a href="http://www.dementia.org/twiki/bin/edit/TWiki/SCRIPTURLsearchSCRIPTSUFFIXscopetextweballordertopicsearch25TOPICOVERRIDESUSER25casesensitiveonlimitall?topicparent=TWiki.WebRss" rel="nofollow" title="Create this topic"><sup>?</sup></a></span> (click on the name to search for occurrences on this site). If they are in use on your site, you can restore them to their Cairo settings by simply cutting and pasting the old definitions. <p /> <nop><h4><a name="SitePrefsTopicName_was_MAINWEB_T"></a><a name="_SitePrefsTopicName_was_MAINWEB_"></a> {SitePrefsTopicName} (was <nop>%MAINWEB%.TWikiPreferences) </h4> <p /> Customized site preferences can now be saved in the {LocalSitePreferences} topic which will override settings in {SitePrefsTopicName}. This simplifies upgrades as you can overwrite the {SitePrefsTopicName} topic and gain any new or updated preference settings without losing your local customizations. <p /> <nop><h4><a name="FAVICON"></a><a name="_FAVICON_"></a> <code>FAVICON</code> </h4> <p /> <code>favicon.ico</code> is a small graphic that <em>can</em> appear in a variety of places in the browser: the titlebar, the taskbar, the address bar, bookmarks/favourites, and tabs. Each web browser has a unique user interface, and as a result uses the Favicon in different ways. <em>Most</em> browsers display it in <em>most</em> of the locations listed. <p /> Out of the box, TWiki is configured to easily customise the <code>favicon.ico</code> for each web. To switch to a new <code>favicon.ico</code>, upload it to the desired web's <nop>WebPreferences.<ul><li><ul><li> <nop>Set FAVICON = %PUBURL%/TWiki/WebPreferences/favicon.ico</li></ul></li></ul> <p /> To provide a single, site-wide <code>favicon.ico</code>, hardcode a specific web, for example:<ul><li><ul><li> <nop>Set FAVICON = %PUBURL%/%TWIKIWEB%/WebPreferences/favicon.ico</li></ul></li></ul> <p /> <nop><h4><a name="FORCENEWREVISIONCHECKBOX"></a><a name="_FORCENEWREVISIONCHECKBOX_"></a> <code>FORCENEWREVISIONCHECKBOX</code> </h4> <p /> Normally, if you make another edit within a one hour period (was <code>$editLockTime=in =lib/TWiki.cfg</code>, now <code>{ReplaceIfEditedAgainWithin}</code>), TWiki will fold together your changes. This is often the "right thing to do", as it can reduce the visual clutter of diffs. <p /> The "Force New Revision" checkbox is a way to force it to create a separate revision each time you save. <p /> The <span class="twikiNewLink">%TWIKIWEB%.TWikiPreferences<a href="http://www.dementia.org/twiki/bin/edit/TWiki/TWIKIWEBTWikiPreferences?topicparent=TWiki.WebRss" rel="nofollow" title="Create this topic"><sup>?</sup></a></span> variable <code>FORCENEWREVISIONCHECKBOX</code> controls whether this is checked by default or not. <p /> On a related note, you can force <strong><em>every</em></strong> save to be a new revision number by editing <code>lib/TWiki.cfg</code> and setting <code><b>{ReplaceIfEditedAgainWithin}</b></code> to 0. <p /> NOTE: Although this feature is being introduced in this release, it is also being deprecated at the same time. <a href="http://twiki.org/cgi-bin/view/Codev.EdinburghRelease" title="'Codev.EdinburghRelease' on TWiki.org">TWiki:Codev.EdinburghRelease</a> is planned to provide the ability to elide revisions at the GUI level, rather than the Store level, thus obviating the need for this stopgap measure. <p /> <nop><h4><a name="WEBLOGONAME_WEBLOGOIMG_WEBLOGOUR"></a><a name="_WEBLOGONAME_WEBLOGOIMG_WEBLOGOU"></a> <code>WEBLOGONAME</code>, <code>WEBLOGOIMG</code>, <code>WEBLOGOURL</code>, <code>WEBLOGOALT</code> </h4> <p /> Each web can have its own customised logo. The simplest way is to upload a <code>logo.gif</code> to a web's <nop>WebPreferences, and it will appear in the top-left corner. <p /> To change the logo's filename, set the <code>WEBLOGONAME</code> variable. You'll especially need to do this if you use a different logo file format:<ul><li><ul><li> <nop>Set WEBLOGONAME = <span class="twikiNewLink">MyLogo<a href="http://www.dementia.org/twiki/bin/edit/TWiki/MyLogo?topicparent=TWiki.WebRss" rel="nofollow" title="Create this topic"><sup>?</sup></a></span>.jpg</li></ul></li></ul> <p /> RSS feeds have also been enhanced to use the web-specific logo. <p /> If you don't want to have custom logos on a per-web basic, but instead want to use a single, site-wide logo, hardcode a specific web in the <code>WEBLOGOURL</code> variable. For example:<ul><li><ul><li> <nop>Set WEBLOGOURL = %PUBURL%/%MAINWEB%/WebPreferences/logo.png</li></ul></li></ul> <p /> <nop><h4><a name="WIKILOGOIMG_WIKILOGOURL_WIKILOGO"></a><a name="_WIKILOGOIMG_WIKILOGOURL_WIKILOG"></a> <code>WIKILOGOIMG</code>, <code>WIKILOGOURL</code>, <code>WIKILOGOALT</code> </h4> <p /> These variables are now more closely associated with <code>WIKITOOLNAME</code>. If you change <code>WIKITOOLNAME</code>, you'll probably want to change these variables, too. <code>WIKILOGOIMG</code>, <code>WIKILOGOURL</code>, <code>WIKILOGOALT</code>, and <code>WIKITOOLNAME</code> are now used more consistently together. <p /> <nop><h3><a name="Final_Preferences"></a> Final Preferences </h3> <p /> The <code>FINALPREFERENCES</code> setting prevents particular preference settings from being over-ridden at a lower level. The hierarchy of how <code>FINALPREFERENCES</code> settings are applied has been clarified/formalized as reflected in the following chart: <nop> <nop> <nop> <nop> <nop> <nop> <table class="twikiTable" cellspacing="1" cellpadding="1" border="0"><tr><th bgcolor="#e6e6e6" class="twikiFirstCol"> <a href="http://www.dementia.org/twiki/bin/view/TWiki/WebRss?sortcol=0;table=3;up=0#sorted_table" rel="nofollow" title="Sort by this column"><font color="#000000">Level</font></a> </th><th bgcolor="#e6e6e6"> <a href="http://www.dementia.org/twiki/bin/view/TWiki/WebRss?sortcol=1;table=3;up=0#sorted_table" rel="nofollow" title="Sort by this column"><font color="#000000">Set By</font></a> </th><th bgcolor="#e6e6e6"> <a href="http://www.dementia.org/twiki/bin/view/TWiki/WebRss?sortcol=2;table=3;up=0#sorted_table" rel="nofollow" title="Sort by this column"><font color="#000000">Local site examples</font></a> </th></tr> <tr><td bgcolor="#ffffff" class="twikiFirstCol"> default site </td><td bgcolor="#ffffff"> <nop>TWiki.TWikiPreferences or !%WIKIPREFSTOPIC% </td><td bgcolor="#ffffff"> %TWIKIWEB%.%WIKIPREFSTOPIC% </td></tr> <tr><td bgcolor="#eaeaea" class="twikiFirstCol"> local site </td><td bgcolor="#eaeaea"> !%MAINWEB%.TWikiPreferences or !%LOCALSITEPREFS% </td><td bgcolor="#eaeaea"> %LOCALSITEPREFS% </td></tr> <tr><td bgcolor="#ffffff" class="twikiFirstCol"> web </td><td bgcolor="#ffffff"> <nop>WebPreferences </td><td bgcolor="#ffffff"> TWiki.%WEBPREFSTOPIC% </td></tr> <tr><td bgcolor="#eaeaea" class="twikiFirstCol"> user </td><td bgcolor="#eaeaea"> In one's user topic </td><td bgcolor="#eaeaea"> %WIKIUSERNAME% </td></tr> <tr><td bgcolor="#ffffff" class="twikiFirstCol"> topic </td><td bgcolor="#ffffff"> "Edit topic preferences settings" under "More topic actions" </td><td bgcolor="#ffffff"> <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/TWiki/DakarReleaseNotes">DakarReleaseNotes</a> </td></tr> </table> <p /> By default, the site level <code>FINALPREFERENCES</code> are set in !%MAINWEB%.TWikiPreferences so as not to conflict with preference settings in that topic. <p /> <nop><h3><a name="mod_perl_support_improvements"></a><a name="_mod_perl_support_improvements"></a> <code>mod_perl</code> support improvements </h3> TWiki no longer uses global variables other than for constants. Each CGI script creates a new "session object" that holds all session-specific information. <p /> There is still an issue with the <code>@INC</code> path in <code>mod_perl</code>, that mainly impacts plugins that lazy-load modules. You should use the <code>PerlSetEnv</code> directive that <code>mod_perl</code> provides to make sure that your TWiki <code>lib</code> directory is permanently on the path, if you are using <code>mod_perl</code>. <p /> <nop><h3><a name="Plugins"></a> Plugins </h3> Plugins are no longer searched for every time a TWiki script is run. Instead they are automatically discovered in <code>configure</code>. To enable and disable plugins, use the <code>configure</code> interface. The entire @INC path is searched for plugins, so you can easily point at plugins outside the installation. However only the first instance of a plugin on the @INC path will be found (it is a path, after all). <p /> <code>%<nop>INSTALLEDPLUGINS%</code> and <code>%<nop>DISABLEDPLUGINS%</code> are no longer supported in <nop>TWikiPreferences. If you have set <code>%<nop>INSTALLEDPLUGINS%</code> in <nop>TWikiPreferences, you need to move that setting into the <code>{PluginsOrder}</code> configuration key, using the <code>configure</code> interface. To disable plugins, uncheck them in the <code>configure</code> interface, and save the changes. <p /> <nop><h3><a name="Logins_Logouts_Sessions_and_Pass"></a> Logins, Logouts, Sessions and Passwords </h3> <p /> <a href="http://twiki.org/cgi-bin/view/Plugins.SessionPlugin" title="'Plugins.SessionPlugin' on TWiki.org">TWiki:Plugins.SessionPlugin</a> and <a href="http://twiki.org/cgi-bin/view/Plugins.AuthPagePlugin" title="'Plugins.AuthPagePlugin' on TWiki.org">TWiki:Plugins.AuthPagePlugin</a> have been integrated into the core. TWiki now supports cookied sessions, in the context of a much improved authentication architecture. The setup for authentication is now much simpler, and for most sites can be done entirely from the <code>configure</code> interface. There are some incompatibilities with TWiki::Plugins.SessionPlugin, with resepect to the in-line variables. See <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/TWiki/TWikiUserAuthentication">TWikiUserAuthentication</a> in the release for full details of how authentication works now. TWiki also now supports the concept of pluggable password managers, making the integration of corporate authentication services much simpler. <p /> Administrators, especially of public sites, need to be aware of the security implications of cookied sessions, and the potential risks of cross-site scripting attacks that may be used to steal user sessions. See <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/TWiki/TWikiUserAuthentication">TWikiUserAuthentication</a> for more details. <p /> <nop><h3><a name="Protections"></a> Protections </h3> <p /> The evaluation of protections has been re-worked to make it more naturally understandable, and also fill a number of holes in the protection scheme, These holes meant that it was relatively easy to <em>deny</em> access to a topic, but rather difficult to subsequently <em>restore</em> access without either compromising other topics, or compromising old revisions. <p /> When deciding whether to grant access, TWiki now evaluates the following rules in order (read from the top of the list; if the logic arrives at <strong>PERMITTED</strong> or <strong>DENIED</strong> that applies immediately and no more rules are applied). You need to read the rules bearing in mind that VIEW, CHANGE and RENAME access may be granted/denied separately.<ol><li> If the user is a <a class="twikiAnchorLink" href="http://www.dementia.org/twiki/bin/view/TWiki/DakarReleaseNotes#SuperAdminGroup">super-user</a><ul><li> access is <strong>PERMITTED</strong>.</li></ul></li><li> If DENYTOPIC is set to a list of wikinames<ul><li> people in the list will be <strong>DENIED</strong>.</li></ul></li><li> If DENYTOPIC is set to <em>empty</em> ( i.e. <tt>Set DENYTOPIC =</tt> )<ul><li> access is <strong>PERMITTED</strong> <em>i.e.</em> no-one is denied access to this topic</li></ul></li><li> If ALLOWTOPIC is set<ol><li> people in the list are <strong>PERMITTED</strong></li><li> everyone else is <strong>DENIED</strong></li></ol></li><li> If DENYWEB is set to a list of wikiname<ul><li> people in the list are <strong>DENIED</strong> access</li></ul></li><li> If ALLOWWEB is set to a list of wikinames<ul><li> people in the list will be <strong>PERMITTED</strong></li><li> everyone else will be <strong>DENIED</strong></li></ul></li><li> If you got this far, access is <strong>PERMITTED</strong></li></ol> In addition, permissions set on a specific revision of a topic now <em>always</em> apply to that revision, even if access to the topic is relaxed in a later revision. This change was necessary to prevent accidentally permitting access to sensitive data in old revisions. <p /> The major impact of this change is that <nop>WebPreferences topics shipped with earlier releases of TWiki will have excessively restrictive controls, as the default settings were:<ul><li> <nop>Set DENYWEBVIEW = </li><li> <nop>Set ALLOWWEBVIEW = <ul><li> This will now <em>deny</em> view access to everyone <em>not</em> in the list (i.e. everyone except admins)</li></ul></li><li> <nop>Set DENYWEBCHANGE = </li><li> <nop>Set ALLOWWEBCHANGE = <ul><li> This will now <em>deny</em> change access to everyone <em>not</em> in the list (i.e. everyone except admins)</li></ul></li><li> <nop>Set DENYWEBRENAME = </li><li> <nop>Set ALLOWWEBRENAME = <ul><li> This will now <em>deny</em> rename access to everyone <em>not</em> in the list (i.e. everyone except admins)</li></ul></li><li> <nop>Set ALLOWTOPICCHANGE = <ul><li> This will now <em>deny</em> change access to everyone <em>not</em> in the list (i.e. everyone except admins)</li></ul></li><li> <nop>Set ALLOWTOPICRENAME = %MAINWEB%.<nop>TWikiAdminGroup</li></ul> <p /> The standard webs shipped with this release have these settings disabled. However you are likely to have inherited the old default settings in your user webs. The easiest way to deal with this is to simply insert a # sign in these settings; for example:<ul><li> #Set DENYWEBVIEW = </li><li> #Set ALLOWWEBVIEW = </li><li> <em>etc</em></li></ul> <p /> %RED%Note:%ENDCOLOR% For security reasons, the<a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/Trash/WebHome">Trash</a> web is shipped with <code>ALLOWWEBVIEW</code> set to %MAINWEB%.TWikiAdminGroup. <p /> <nop><h4><a name="TWiki_SitePermissions"></a> <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/TWiki/SitePermissions">SitePermissions</a> </h4> <p /> This topic gives you a quick view of the permissions on each web - i.e. it aggregates ALLOWWEB* etc. into a handy table. It is also installed on TWiki.org as <a href="http://twiki.org/cgi-bin/view/TWiki.SitePermissions" title="'TWiki.SitePermissions' on TWiki.org">TWiki:TWiki.SitePermissions</a> but is not in Cairo. <p /> <nop><h3><a name="Frustrating_Robots"></a> Frustrating Robots </h3> To help contain the growth of wiki spam, TWiki now incorporates some features to prevent robots from following links. You can constain links using the <code>rel='nofollow'</code> feature on links, which is honoured by the major search engines, to prevent spammers from gaining any ranking benefit from vandalising your site. See the <strong>Anti-spam measures</strong> section in <code>configure</code> for full details. <p /> <nop><h3><a name="New_User_Registration"></a> New User Registration </h3> <p /> The new user registration process has been extensively reworked to improve usability and security of the registration process.<ol><li> <nop>FirstName and <nop>LastName are taken separately and tabulated. See %MAINWEB%.UserListByLocation</li><li> Sends a email that the user has to respond to; registration data is staged until this is done</li><li> Populates a form in the user topic, if there is one in the <nop>NewUserTemplate. If there is no form, then bullets are used, as in pre-Dakar TWiki.</li><li> Sends different emails to the WIKIWEBMASTER and the USER, with the user's containing the password unless {HidePasswdInRegistration} is set.</li><li> The <code>templates/view.pattern.tmpl</code> template is rearranged to show the form on the top LHS, any pictures on the top RHS (uses <a href="http://twiki.org/cgi-bin/view/Plugins.ImageGalleryPlugin" title="'Plugins.ImageGalleryPlugin' on TWiki.org">TWiki:Plugins.ImageGalleryPlugin</a> if installed), and any fields not in the form (e.g. comment) in the content in the topic. </li><li> There is now a mechanism for bulk registration, with callbacks for augmentation (e.g. from other sources).</li></ol> <p /><ol><li> Absorbed <span class="twikiNewLink">ResetPasswordByEmail<a href="http://www.dementia.org/twiki/bin/edit/TWiki/ResetPasswordByEmail?topicparent=TWiki.WebRss" rel="nofollow" title="Create this topic"><sup>?</sup></a></span>.</li><li> Obsoleted <span class="twikiNewLink">InstallPassword<a href="http://www.dementia.org/twiki/bin/edit/TWiki/InstallPassword?topicparent=TWiki.WebRss" rel="nofollow" title="Create this topic"><sup>?</sup></a></span></li></ol> <p /> <nop><h3><a name="Change_notification_support"></a> Change notification support </h3> The old <code>mailnotify</code> script has been retired in favour of the <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/TWiki/MailerContrib">MailerContrib</a>. See <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/TWiki/MailerContrib">MailerContrib</a> for information about functional changes. <p /> <nop><h3><a name="TWiki_SiteChanges"></a> <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/TWiki/SiteChanges">SiteChanges</a> </h3> <p /> This topic mimics TWiki.org's <a href="http://twiki.org/cgi-bin/view/Codev:WebChangesForAllWebs" title="'Codev:WebChangesForAllWebs' on TWiki.org">TWiki:Codev:WebChangesForAllWebs</a> - i.e. it shows a <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/TWiki/WebChanges">WebChanges</a> view across a whole site. It's name was chosen to parallel <nop>TWiki.SiteMap; at some point you can expect the arrival of <nop>TWiki.SiteStatistics too. <p /> <nop><h3><a name="What_s_a_Web"></a> What's a Web </h3> Old versions of TWiki would consider all subdirectories of the TWiki data directory to be webs. This behaviour has changed; now only subdirectories that contain a web home topic (as identified by the <code>HomeTopicName</code>) will be considered to be webs. This may result in directories that used to return search matches no longer doing so. <p /> <nop><h3><a name="Disable_script_tags"></a> Disable <script> tags </h3> In recognition of security concerns around <script> tags, the administrator has the choice whether to allow users to add script to topics or not. See the <code>{AllowInlineScript}</code> setting in the <strong>Security</strong> section of <code><span class="twikiNewLink">configure<a href="http://www.dementia.org/twiki/bin/edit/TWiki/SCRIPTURLconfigureSCRIPTSUFFIX?topicparent=TWiki.WebRss" rel="nofollow" title="Create this topic"><sup>?</sup></a></span></code>. <p /> <nop><h2><a name="Notes_for_TWikiApplication_Devel"></a> Notes for <nop>TWikiApplication Developers </h2> <p /> <nop><h3><a name="Space_Tab_conversion"></a> Space/Tab conversion </h3> <p /> Previous TWiki versions would automatically convert three spaces at the start of lines to a tab when the topic was saved. This meant that the saved topic was <em>not</em> the same as the edited topic, which could result in considerable confusion. This conversion has been disabled, and the saved topic is now exactly what you see in the editor. One impact of this change is that any add-on scripts you may have developed that rely on bulleted list lines starting with a tab will no longer work. They must be adapted to treat groups of three spaces and single tabs as equivalent. <p /> <nop><h3><a name="Evaluation_order_of_TWikiVariabl"></a> Evaluation order of <nop>TWikiVariables </h3> <p /> In previous TWiki versions the evaluation order of %TAG%s depended on where they were expanded in the code. The parser was somewhat crude, and could easily be confused when embedded variables (variables embedded in the parameters of other variables) were used. <p /> The parser has been replaced in Dakar with a deterministic variable parser with predictable behaviour. Specifically, variables are now always evaluated left to right and inside out. For example, consider %TAG2{ "%TAG1{ "%TAG0{ "params" }%" }%" }% %TAG3%. Previously, the expansion order would have depended on the order of expressions in the code, so the expansion may have proceeded TAG3 - TAG0 - TAG2 - TAG1. If you were lucky, this was the intended order. In Dakar, the order is now guranteed to be TAG0 - TAG1 - TAG2 - TAG3 (i.e. inside out and left to right). <p /> The main impact of this is that some <span class="twikiNewLink">TWikiApplications<a href="http://www.dementia.org/twiki/bin/edit/TWiki/TWikiApplications?topicparent=TWiki.WebRss" rel="nofollow" title="Create this topic"><sup>?</sup></a></span> may cease to work if they have been written to take advantage of the old chaotic order. There is no way to predict which will work and which will fail, so you will have to deal with this on a case-by-case basis. In most cases <nop>TWikiApplication authors will have worked hard to do the "sensible thing" so instances of this problem should be rare. <p /> Note that because the TWiki spec allows double quotes within double-quoted strings in certain variable parameters it has been impossible to make the parser 100% deterministic. There may still be pathological cases where the parser may fail. In these cases, consider how open and close curly brackets are matched up. <p /> <nop><h3><a name="Encoding_of_form_field_values"></a> Encoding of form-field values </h3> The encoding used to escape characters in form-field values has had to change. The old encoding could very easily be confused by text strings in data values. Existing topics with the old encoding will still be loaded into TWiki as before, but if edited they will be saved with the new encoding. This should not affect you unless you have searches that look for the old encodings; specifically, the %<nop%_G_ , %<nop>_Q_%, and %<nop>_P_% character sequences. Any such searches will not work any more, and need to be converted to search for the new encoding. Assuming they are <code>regex</code> type searches, you can use =(%<nop%_G_ |%0A)= to match encoded newlines in field data in both old and new format topics, <code>(%<nop>_Q_%|%22)</code> to match quotes, and <code>(%<nop>_P_%|25)</code> for percent signs. <p /> <nop><h3><a name="script_tags_in_topics"></a> <script> tags in topics </h3> Previous releases of TWiki would attempt to interpret the content of <script> tags in topics as <span class="twikiNewLink">TWikiML<a href="http://www.dementia.org/twiki/bin/edit/TWiki/TWikiML?topicparent=TWiki.WebRss" rel="nofollow" title="Create this topic"><sup>?</sup></a></span>, often resulting in non-functional scripts. This release protects script sections from expansion by TWiki. Note that this means that <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/TWiki/TWikiVariables">TWikiVariables</a> will <strong>not</strong> be expanded in script tags - they are passed through <em>verbatim</em>. <p /> In recognition of security concerns around <script> tags, the administrator has the choice whether to allow users to add script to topics or not. Check the setting of <code>{AllowInlineScript}</code> in <code><span class="twikiNewLink">configure<a href="http://www.dementia.org/twiki/bin/edit/TWiki/SCRIPTURLconfigureSCRIPTSUFFIX?topicparent=TWiki.WebRss" rel="nofollow" title="Create this topic"><sup>?</sup></a></span></code> to see if it is allowed on your site. If not, script sections will simply disappear from topics. <p /> <nop><h3><a name="verbatim_tags_in_topics"></a> <verbatim> tags in topics </h3> Previous releases required <code>verbatim</code> tags to be on their own line. Twiki can now deal with inline verbatim blocks such as <p /> <pre> blah<verbatim>inside</verbatim>after </pre> results in <p /> blah<pre>inside</pre>after <p /> <strong>NOTE:</strong> VARIABLES are still Set within verbatim tags (this is a historical peculiarity) <p /> <nop><h3><a name="ALL_VARIABLES"></a><a name="_ALL_VARIABLES_"></a> <code>ALL_VARIABLES</code> </h3> <p /> You can use <code>%<nop>ALL_VARIABLES%</code> in a topic to get a dump of all variables set in that context. Invaluable for debugging those tricksy <nop>TWikiApplications! <p /> <nop><h3><a name="IF"></a><a name="_IF_"></a> <code>IF</code> </h3> <p /> The new <code>%<nop>IF()%</code> variable defines simple conditional statements that are evaluated at view time. This allows you to include content conditionally based on environmental factors. See <span class="twikiNewLink">ViewDEVELOP<a href="http://www.dementia.org/twiki/bin/edit/TWiki/ViewDEVELOP?topicparent=TWiki.WebRss" rel="nofollow" title="Create this topic"><sup>?</sup></a></span>:TWiki.IfStatements for more information on usage. <p /> <p /> <nop><h3><a name="New_count_reg_exp_variable_in_TW"></a> New <code>$count(reg-exp)</code> variable in <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/TWiki/FormattedSearch">FormattedSearch</a> </h3> This new variable for <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/TWiki/FormattedSearch">FormattedSearch</a> returns the number of instances a specified <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/TWiki/RegularExpression">RegularExpression</a> occur in a topic. This is useful for such things as counting the number of comments on a page (assuming they are marked my a unique heading level). <p /> <nop><h2><a name="Notes_for_Skin_Developers"></a> Notes for Skin Developers </h2> <p /> <nop><h3><a name="Skin_search_path"></a> Skin search path </h3> Earlier releases of TWiki only allowed for a single skin, so customising a single template in a skin meant deriving a whole new skin. Dakar introduces the concept of a skin search path, which lets you combine skins additively. For example, you can customise just the view template by defining a new <code>view.mylocalskin.tmpl</code> and then setting<ul><li> <code>Set SKIN = mylocalskin,pattern</code></li></ul> Since you have defined a view template for <code>mylocalskin</code>, it will be picked up when you view a topic because <code>mylocalskin</code> is first on the search path. But you didn't define <code>edit.mylocalskin.tmpl</code>, so when you edit the next skin on the search path will be used instead (in this case <code>edit.pattern.tmpl</code>). You can put as many skins on the search path as you like. <p /> As with older releases, setting SKIN (or the <code>skin</code> parameter in the URL) replaces the existing skin path setting. Dakar supports <em>extension</em> of the path as well, using <em>covers</em>. <p /><ul><li> <code>Set COVER = mylocalskin</code></li></ul> <p /> pushes a different skin to the front of the skin search path. There is also an equivalent <code>cover</code> URL parameter. For example, %SCRIPTURL%/view%SCRIPTSUFFIX%/TWiki/WhatIsWikiWiki?cover=print.pattern. This gives you an extra level of flexibility when defining skins. <p /> See <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/TWiki/TWikiSkins">TWikiSkins</a> for more information. <p /> <nop><h3><a name="Supporting_web_names_that_are_Wi"></a> Supporting web names that are <nop>WikiWords </h3> Although web names have been <span class="twikiNewLink">permitted to be <nop>WikiWords<a href="http://www.dementia.org/twiki/bin/edit/TWiki/WebNameAsWikiName?topicparent=TWiki.WebRss" rel="nofollow" title="Create this topic"><sup>?</sup></a></span> since the <span class="twikiNewLink">CairoRelease<a href="http://www.dementia.org/twiki/bin/edit/TWiki/CairoRelease?topicparent=TWiki.WebRss" rel="nofollow" title="Create this topic"><sup>?</sup></a></span>, the base templates have been <span class="twikiNewLink">fixed<a href="http://www.dementia.org/twiki/bin/edit/TWiki/DefaultTemplatesSupportWebNameAsWikiWord?topicparent=TWiki.WebRss" rel="nofollow" title="Create this topic"><sup>?</sup></a></span> for Dakar. <p /> Skins should be upgraded if they have standalone <code>%<nop>WEB%</code> variables; only standalone <code>%<nop>WEB%</code> text that potentially could be turned into a link (because of a <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/TWiki/WikiWord">WikiWord</a>) needs to be escaped. Same for <code>%<nop>MAINWEB%</code> and <code>%<nop>TWIKIWEB%</code>. <p /> Examples: <p /><ul><li> <code>%<nop>WEB%</code> -- needs to be escaped with <code><nop>%<nop>WEB%</code></li><li> <code>(%<nop>WEB%)</code> -- needs to be escaped because of parenthesis</li><li> <code>"%<nop>WEB%"</code> -- no need to escape, does not get linked</li><li> <code><b>%<nop>WEB%</b></code> -- no need to escape, does not get linked</li><li> <code>%<nop>WEB%.%<nop>TOPIC%</code> -- no need, is a <code>Web.TopicName</code></li><li> <code>(%<nop>WEB%.%<nop>TOPIC%)</code> -- no need, is a <code>Web.TopicName</code></li></ul> <p /> Basically, any prefix other then space and parenthesis needs to be looked at. <code>%<nop>WEB%</code> in a <code>%<nop>SEARCH%</code> should not be escaped. <p /> <nop><h3><a name="Deprecation_of_EDITTOPIC"></a><a name="Deprecation_of_EDITTOPIC_"></a> Deprecation of %<nop>EDITTOPIC% </h3> In Cairo release (and earlier) the only way to have an edit link that changed with the context was to use %<nop>EDITTOPIC%. This was only available in view templates, and had no flexibility in formatting. it was also impossible to disable other active links, such as Attach. <p /> Dakar release includes new support for "context if" parameters to the %<nop>TMPL:P construct. See <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/TWiki/TWikiTemplates">TWikiTemplates</a> for details. The default templates shipped with Dakar have been modified to use this support. %<nop>EDITTOPIC has been deprecated, though it is still available as a simple edit link, defined in <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/TWiki/TWikiPreferences">TWikiPreferences</a>. Skin authors are strongly recommended to replace this link with context-if conditionals. <p /> <nop><h3><a name="Template_Parameters"></a> Template Parameters </h3> %<nop>TMPL:P% now accepts parameters. Values passed in these parameters will be expanded when the %TMPL:DEF is instantiated. See <a href="http://develop.twiki.org/~develop/cgi-bin/view/TWiki/TWikiTemplates" target="_top">http://develop.twiki.org/~develop/cgi-bin/view/TWiki/TWikiTemplates</a> for full details. (Remember, this happens at template expansion time, which is usually very early in the rendering process.) <p /> <nop><h3><a name="HTTP_and_HTTPS"></a> HTTP and HTTPS </h3> These two new <nop>TWikiVariables give access to the HTTP headers sent by your browser. For example, your browser says your browser is %HTTP:{"User-Agent"}% (this will be filled in if you are running Dakar). <p /> <nop><h3><a name="QUERYSTRING"></a> QUERYSTRING </h3> This new <nop>TWikiVariable gives access to the full query string from the URL sent to your browser. For example, for the URL <code>%SCRIPTURL%/view%SCRIPTSUFFIX%/TWiki/DakarReleaseNotes?make=Reliant&model=Robin</code>, the query string is <code>?make=Reliant;model=Robin</code> (yes, the semicolon is correct!) <p /> <nop><h2><a name="Notes_for_Plugin_Developers"></a> Notes for Plugin Developers </h2> <p /> <nop><h3><a name="Changes_to_variable_parsing"></a> Changes to variable parsing </h3> In earlier TWiki versions there was considerable confusion over the syntax and semantics of Preferences, TWiki Variables, and Plugin variables. The documentation suggested that all %VARIABLES% were equal, but in fact some were more equal than others. <p /> The syntax and semantics of preferences and <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/TWiki/TWikiVariables">TWikiVariables</a> has been made consistent. %<nop>VARIABLE% has been made semantically identical to %<nop>VARIABLE()%, so if you set a preference named %<nop>VARIABLE% it will automatically be instantiated in place of %<nop>VARIABLE{}%. This is an elegant solution in several ways: first, it allows an administrator to electively disable <nop>TWikiVariables, simply by defining an overriding preference. Second, it rationalises the semantics in line with the common syntax. Third, it allows a single parser to do all the work, allowing localised optimisation. Fourth, it prevents a plugin from accidentally kidnapping system <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/TWiki/TWikiVariables">TWikiVariables</a> (while this can still be done by registering a tag handler, it's a much more explicit process). Fifth, the ground rules are set for a possible future extension to support parameterised <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/TWiki/TWikiVariables">TWikiVariables</a> e.g.<ul><li> Set CAR{make model accessory} = I drive %make% %model% with %accessory% in my dreams</li></ul> %CAR{make="an Aston Martin" model="DB9" accessory="a gorgeous blonde"}% <p /> <nop><h3><a name="Internals"></a> Internals </h3> <p /> A lot of the TWiki internals have changed. As a result, plugins that bypass the <code>TWiki::Func</code> API and call core functions directly are unlikely to work. <p /> The restructuring of the code internals is such that there are no 1:1 equivalents for the old core functions. Only the TWiki::Func API is guaranteed to work. <p /> You should convert your plugins to call the <code>TWiki::Func</code> API. If you have called unpublished functions that have no equivalent in <code>TWiki::Func</code>, then you may still be able to call the function via the TWiki "session" object, <code>$TWiki::Plugins::SESSION</code>. See the implementation of the <code>TWiki::Func</code> module for ideas on how to do this. However calling internals is <strong>not</strong> recommended, even using this new mechanism, as they are liable to change without prior notice. <p /> <nop><h3><a name="Extensions_to_the_Func_API"></a> Extensions to the Func API </h3> <p /><ul><li> The <code>TWiki::Func</code> API has been extended to expose a number of new core functions. Review <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/TWiki/TWikiFuncDotPm">TWikiFuncDotPm</a> for details.</li><li> The <code>TWiki::Meta</code> API, which was previously for internal core use only, has now been exposed and may be used in plugins. See <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/TWiki/TWikiMetaDotPm">TWikiMetaDotPm</a> for full details.</li><li> Plugins which observed the existing published API (TWiki::Func) should continue to work.</li></ul> <p /> <nop><h2><a name="Public_contributions_tested_o