data/TWiki/ManagingTopics.txt,v
changeset 0 414e01d06fd5
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/data/TWiki/ManagingTopics.txt,v	Sat Jan 26 15:50:53 2008 +0100
     1.3 @@ -0,0 +1,910 @@
     1.4 +head	1.22;
     1.5 +access;
     1.6 +symbols;
     1.7 +locks; strict;
     1.8 +comment	@# @;
     1.9 +
    1.10 +
    1.11 +1.22
    1.12 +date	2008.01.22.03.21.36;	author TWikiContributor;	state Exp;
    1.13 +branches;
    1.14 +next	1.21;
    1.15 +
    1.16 +1.21
    1.17 +date	2007.01.16.04.11.59;	author TWikiContributor;	state Exp;
    1.18 +branches;
    1.19 +next	1.20;
    1.20 +
    1.21 +1.20
    1.22 +date	2006.04.01.05.55.08;	author TWikiContributor;	state Exp;
    1.23 +branches;
    1.24 +next	1.19;
    1.25 +
    1.26 +1.19
    1.27 +date	2006.02.01.12.01.17;	author TWikiContributor;	state Exp;
    1.28 +branches;
    1.29 +next	1.18;
    1.30 +
    1.31 +1.18
    1.32 +date	2004.08.15.07.55.02;	author PeterThoeny;	state Exp;
    1.33 +branches;
    1.34 +next	1.17;
    1.35 +
    1.36 +1.17
    1.37 +date	2003.01.12.09.14.14;	author PeterThoeny;	state Exp;
    1.38 +branches;
    1.39 +next	1.16;
    1.40 +
    1.41 +1.16
    1.42 +date	2001.12.28.00.48.00;	author MikeMannix;	state Exp;
    1.43 +branches;
    1.44 +next	1.15;
    1.45 +
    1.46 +1.15
    1.47 +date	2001.12.27.12.49.00;	author MikeMannix;	state Exp;
    1.48 +branches;
    1.49 +next	1.14;
    1.50 +
    1.51 +1.14
    1.52 +date	2001.12.17.08.44.11;	author PeterThoeny;	state Exp;
    1.53 +branches;
    1.54 +next	1.13;
    1.55 +
    1.56 +1.13
    1.57 +date	2001.09.18.04.55.05;	author MikeMannix;	state Exp;
    1.58 +branches;
    1.59 +next	1.12;
    1.60 +
    1.61 +1.12
    1.62 +date	2001.09.15.10.15.11;	author MikeMannix;	state Exp;
    1.63 +branches;
    1.64 +next	1.11;
    1.65 +
    1.66 +1.11
    1.67 +date	2001.09.14.10.06.53;	author PeterThoeny;	state Exp;
    1.68 +branches;
    1.69 +next	1.10;
    1.70 +
    1.71 +1.10
    1.72 +date	2001.09.12.21.08.14;	author MikeMannix;	state Exp;
    1.73 +branches;
    1.74 +next	1.9;
    1.75 +
    1.76 +1.9
    1.77 +date	2001.09.12.07.04.41;	author MikeMannix;	state Exp;
    1.78 +branches;
    1.79 +next	1.8;
    1.80 +
    1.81 +1.8
    1.82 +date	2001.09.07.10.14.21;	author MikeMannix;	state Exp;
    1.83 +branches;
    1.84 +next	1.7;
    1.85 +
    1.86 +1.7
    1.87 +date	2001.09.06.22.18.19;	author MikeMannix;	state Exp;
    1.88 +branches;
    1.89 +next	1.6;
    1.90 +
    1.91 +1.6
    1.92 +date	2001.09.01.07.37.12;	author MikeMannix;	state Exp;
    1.93 +branches;
    1.94 +next	1.5;
    1.95 +
    1.96 +1.5
    1.97 +date	2001.08.31.22.36.39;	author MikeMannix;	state Exp;
    1.98 +branches;
    1.99 +next	1.4;
   1.100 +
   1.101 +1.4
   1.102 +date	2001.08.30.13.28.52;	author MikeMannix;	state Exp;
   1.103 +branches;
   1.104 +next	1.3;
   1.105 +
   1.106 +1.3
   1.107 +date	2001.08.29.17.10.02;	author JohnTalintyre;	state Exp;
   1.108 +branches;
   1.109 +next	1.2;
   1.110 +
   1.111 +1.2
   1.112 +date	2001.08.08.16.56.57;	author JohnTalintyre;	state Exp;
   1.113 +branches;
   1.114 +next	1.1;
   1.115 +
   1.116 +1.1
   1.117 +date	2001.08.07.15.33.55;	author JohnTalintyre;	state Exp;
   1.118 +branches;
   1.119 +next	;
   1.120 +
   1.121 +
   1.122 +desc
   1.123 +@none
   1.124 +@
   1.125 +
   1.126 +
   1.127 +1.22
   1.128 +log
   1.129 +@buildrelease
   1.130 +@
   1.131 +text
   1.132 +@%META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="22"}%
   1.133 +%META:TOPICPARENT{name="WebHome"}%
   1.134 +%STARTINCLUDE%
   1.135 +---+ Managing Topics
   1.136 +
   1.137 +_Browser-based rename, move, and delete for individual topics_
   1.138 +
   1.139 +%TOC%
   1.140 +
   1.141 +---++ Overview
   1.142 +
   1.143 +You can use browser-based controls to change a topic's name, move it to another TWiki web, or delete it to a hidden =Trash= web.
   1.144 +
   1.145 +---++ How to Rename/Move/Delete a Topic
   1.146 +
   1.147 +   1. *Click* on ==[More]== (bottom right of page) on the topic to be changed, then, in the new screen, on ==[Rename/move]==. You can now rename and/or move/delete in one operation:
   1.148 +   1. *Move/Delete:* Select the target web if other than the current web - choose =Trash= to [[#DeleteTopic][delete a topic]].
   1.149 +   1. *Rename:* Enter the new topic name - default is current name <br />
   1.150 +     %X% *NOTE:* You'll be warned if any of the topics to be affected are locked (being edited), or if there is a name conflict.
   1.151 +   1. *Prevent updates* by unchecking individual items on the list of referring links - these topics will NOT to be updated with the new name (by default, all referring links will be updated).
   1.152 +   1. *Click* on ==[Rename/Move]==: the topic will be renamed and links to the topic updated as requested.
   1.153 +      * If any of the referring pages are locked then they will be listed: you can correct these later by again pressing ==[Rename/Move]==.
   1.154 +      * %H% There is a __Put back__ feature that allows you to undo a ==Rename/Move/Delete== - an instruction line and undo link will appear at the bottom of the modified topic. This allows you to revert from the _last modification only_.
   1.155 +
   1.156 +#DeleteTopic
   1.157 +---++ Deleted Topics: How to Clear the Trash
   1.158 +
   1.159 +Deleted topics are moved to a special ==Trash== web - they are NOT physically erased from the server. All webs share =Trash= - in case of a name conflict with a topic already =Trash=, the user is alerted and asked to choose a new name.
   1.160 +
   1.161 +The =Trash= web should be be cleared periodically, by archiving (saving) the text and RCS files if required (recommended), then deleting them from the =Trash= directory. 
   1.162 +
   1.163 +   * %X% This can only be done from on the server, not through the browser. 
   1.164 +      * %T% Since simple FTP access to the ==Trash== directory is all that's required for maintenance, it's possible to grant =Trash= admin privileges to multiple users, while strictly limiting server access. 
   1.165 +
   1.166 +---++ Redirecting from an Old Topic
   1.167 +
   1.168 +You can use TWikiMetaData to place a command in the %SYSTEMWEB%.WebTopicViewTemplate and %SYSTEMWEB%.WebTopicNonWikiTemplate that will indicate that a topic has been moved by searching for the tag %<nop>META:TOPICMOVED{...}%. Customize something like this:
   1.169 +
   1.170 +<blockquote>
   1.171 +<verbatim>
   1.172 +%<nop>METASEARCH{type="topicmoved" web="%WEB%" topic="%TOPIC%" 
   1.173 +title="This topic used to exist and was moved to: "}%
   1.174 +</verbatim>
   1.175 +</blockquote>
   1.176 +
   1.177 +---++ How Rename/Move Works
   1.178 +
   1.179 +   1. %<nop>SEARCH%, with a special template, finds and displays all occurrences of the topic name in other topics, site-wide. These referring links are by default automatically changed to the new topic and/or web name. This includes relevant TWikiMetaData definitions.
   1.180 +      * User can omit one or more topics from the update list by unchecking them.
   1.181 +      * =&lt;pre&gt;= and =&lt;verbatim&gt;= are honoured - no changes are made to text within these areas.
   1.182 +   2. The topic is moved (if locks allow).
   1.183 +   3. References are changed (locks and permissions permitting).
   1.184 +   4. Any referring topics that can't be changed due to locks are listed - user can take note and change them at another time.
   1.185 +
   1.186 +---+++ How Referring Topics Are Found
   1.187 +
   1.188 +First, matching topics in the current web are listed - matches are to ==topic==.  Next, all webs (including the current one) are listed that match ==web.topic==. _All_ webs will be searched during rename, even if =NOSEARCHALL= is defined on a web, though access permissions will of course be honoured.
   1.189 +
   1.190 +Changed references are kept are as short as possible, ex: =topic= is used in preference to =web.topic=.
   1.191 +
   1.192 +---+++ Effect of User Access Settings
   1.193 +
   1.194 +User permissions affect the 'rename' functions in various ways. To rename a topic, you need all of ==VIEW==, ==CHANGE== and ==RENAME== access to that topic. To alter referring topics, you need ==CHANGE== access. See TWikiAccessControl for information on setting up access permissions.
   1.195 +
   1.196 +---++ Special Considerations
   1.197 +
   1.198 +Consider carefully whether to make browser-based *Rename/Move/Delete* widely available, or to restrict it to an administrator/moderator group. Allowing all users to easily manipulate topics can be extremely useful in refactoring a busy web or site. However, there are at least two significant potential drawbacks to take into account: 
   1.199 +   * When referring links are updated, the modified topics appear in WebChanges, creating the impression that editorial changes were made. This can undermine the usefulness of WebChanges.
   1.200 +   * Due to [[#RenameLimitations][current limitations]], fairly heavy use of Rename/Move/Delete functions can lead to an accumulation of minor technical problems (ex: broken links) and usability issues (ex: user confusion). If Rename... is used heavily, these negatives will obviously increase, in number and effect.
   1.201 +
   1.202 +Ultimately, the size, objectives, and policies of your TWiki site, the real-world behavior of your user group, and most importantly, the initial TWiki site management leadership, will determine the most effective implementation of this feature, and the success of the site overall.
   1.203 +
   1.204 +#RenameLimitations
   1.205 +---++ Known Issues
   1.206 +
   1.207 +*Rename/Move* is fairly complicated due to the dynamic generation of links. Ideally, it would be possible to run the required part of rendering in a way that would allow identification of the text to be changed. Unfortunately, these hooks don't exist in TWiki at present.  Instead, %<nop>SEARCH% is used with a special template to show the text to be changed, and the selected topics are then altered. One drawback is that =search= can show matches that will not be updated due to case differences. Other mismatches with actual rendered output are also possible as the approaches are so different.
   1.208 +
   1.209 +The following shows some limitations of square bracket processing.
   1.210 +
   1.211 +<blockquote>
   1.212 +<verbatim>
   1.213 +[[Old Topic]]  => [[NewTopic][Old Topic]]
   1.214 +[[old topic]]  => [[NewTopic][old topic]]
   1.215 +[[old t opic]] => not changed
   1.216 +[[OldTopic]]   => [[NewTopic]]
   1.217 +</verbatim>
   1.218 +</blockquote>
   1.219 +
   1.220 +__Related Topics:__ UserDocumentationCategory, AdminDocumentationCategory
   1.221 +@
   1.222 +
   1.223 +
   1.224 +1.21
   1.225 +log
   1.226 +@buildrelease
   1.227 +@
   1.228 +text
   1.229 +@d1 1
   1.230 +a1 1
   1.231 +%META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="21"}%
   1.232 +a2 1
   1.233 +%TOC%
   1.234 +d4 1
   1.235 +a4 1
   1.236 +---# Managing Topics
   1.237 +d8 2
   1.238 +d37 1
   1.239 +a37 1
   1.240 +You can use TWikiMetaData to place a command in the %TWIKIWEB%.WebTopicViewTemplate and %TWIKIWEB%.WebTopicNonWikiTemplate that will indicate that a topic has been moved by searching for the tag %<nop>META:TOPICMOVED{...}%. Customize something like this:
   1.241 +d63 1
   1.242 +a63 1
   1.243 +User permissions affect the Rename function in various ways. To rename a topic, you need both ==ALLOWTOPICVIEW== and ==ALLOWTOPICCHANGE== permission for that topic. To alter referring topics, you need change permission. See TWikiAccessControl for information on setting up access permissions.
   1.244 +@
   1.245 +
   1.246 +
   1.247 +1.20
   1.248 +log
   1.249 +@buildrelease
   1.250 +@
   1.251 +text
   1.252 +@d1 1
   1.253 +a1 1
   1.254 +%META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="20"}%
   1.255 +d38 1
   1.256 +a38 1
   1.257 +<blockquote style="background-color:#f0f0f0">
   1.258 +d62 1
   1.259 +a62 1
   1.260 +User permissions affect the Rename function in various ways. To rename a topic, you need both ==ALLOWTOPICCHANGE== and ==ALLOWTOPICRENAME== permission for that topic. To alter referring topics, you need change permission. See TWikiAccessControl for information on setting up access permissions.
   1.261 +d79 1
   1.262 +a79 1
   1.263 +<blockquote style="background-color:#f0f0f0">
   1.264 +@
   1.265 +
   1.266 +
   1.267 +1.19
   1.268 +log
   1.269 +@buildrelease
   1.270 +@
   1.271 +text
   1.272 +@d1 1
   1.273 +a1 1
   1.274 +%META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="19"}%
   1.275 +d15 8
   1.276 +a22 8
   1.277 +	1. *Click* on ==[More]== (bottom right of page) on the topic to be changed, then, in the new screen, on ==[Rename/move]==. You can now rename and/or move/delete in one operation:
   1.278 +	1. *Move/Delete:* Select the target web if other than the current web - choose =Trash= to [[#DeleteTopic][delete a topic]].
   1.279 +	1. *Rename:* Enter the new topic name - default is current name <br />
   1.280 +	  %X% *NOTE:* You'll be warned if any of the topics to be affected are locked (being edited), or if there is a name conflict.
   1.281 +	1. *Prevent updates* by unchecking individual items on the list of referring links - these topics will NOT to be updated with the new name (by default, all referring links will be updated).
   1.282 +	1. *Click* on ==[Rename/Move]==: the topic will be renamed and links to the topic updated as requested.
   1.283 +		* If any of the referring pages are locked then they will be listed: you can correct these later by again pressing ==[Rename/Move]==.
   1.284 +		* %H% There is a __Put back__ feature that allows you to undo a ==Rename/Move/Delete== - an instruction line and undo link will appear at the bottom of the modified topic. This allows you to revert from the _last modification only_.
   1.285 +d31 2
   1.286 +a32 2
   1.287 +	* %X% This can only be done from on the server, not through the browser. 
   1.288 +		* %T% Since simple FTP access to the ==Trash== directory is all that's required for maintenance, it's possible to grant =Trash= admin privileges to multiple users, while strictly limiting server access. 
   1.289 +d47 6
   1.290 +a52 6
   1.291 +	1. %<nop>SEARCH%, with a special template, finds and displays all occurrences of the topic name in other topics, site-wide. These referring links are by default automatically changed to the new topic and/or web name. This includes relevant TWikiMetaData definitions.
   1.292 +		* User can omit one or more topics from the update list by unchecking them.
   1.293 +		* =&lt;pre&gt;= and =&lt;verbatim&gt;= are honoured - no changes are made to text within these areas.
   1.294 +	2. The topic is moved (if locks allow).
   1.295 +	3. References are changed (locks and permissions permitting).
   1.296 +	4. Any referring topics that can't be changed due to locks are listed - user can take note and change them at another time.
   1.297 +d67 2
   1.298 +a68 2
   1.299 +	* When referring links are updated, the modified topics appear in WebChanges, creating the impression that editorial changes were made. This can undermine the usefulness of WebChanges.
   1.300 +	* Due to [[#RenameLimitations][current limitations]], fairly heavy use of Rename/Move/Delete functions can lead to an accumulation of minor technical problems (ex: broken links) and usability issues (ex: user confusion). If Rename... is used heavily, these negatives will obviously increase, in number and effect.
   1.301 +d84 1
   1.302 +a84 1
   1.303 +[[OldTopic]]	=> [[NewTopic]]
   1.304 +@
   1.305 +
   1.306 +
   1.307 +1.18
   1.308 +log
   1.309 +@none
   1.310 +@
   1.311 +text
   1.312 +@d1 1
   1.313 +a1 1
   1.314 +%META:TOPICINFO{author="PeterThoeny" date="1092556502" format="1.0" version="1.18"}%
   1.315 +d56 1
   1.316 +a56 1
   1.317 +Referring topics are found using the %<nop>SEARCH% variable - see the template ==searchrenameview.tmpl==. First, matching topics in the current web are listed - matches are to ==topic==.  Next, all webs (including the current one) are listed that match ==web.topic==. Because %<nop>SEARCH% is used, webs marked in WebPreferences as =NOSEARCHALL= will not show up in the search for references to the =topic= being changed.
   1.318 +d88 1
   1.319 +a88 3
   1.320 +-- TWiki:Main.MikeMannix - 27 Dec 2001
   1.321 +
   1.322 +%META:TOPICMOVED{by="MikeMannix" date="999329908" from="TWiki.RenameTopic" to="TWiki.ManagingTopics"}%
   1.323 +@
   1.324 +
   1.325 +
   1.326 +1.17
   1.327 +log
   1.328 +@none
   1.329 +@
   1.330 +text
   1.331 +@d1 1
   1.332 +a1 1
   1.333 +%META:TOPICINFO{author="PeterThoeny" date="1042362854" format="1.0" version="1.17"}%
   1.334 +d3 87
   1.335 +a89 86
   1.336 +%TOC%
   1.337 +%STARTINCLUDE%
   1.338 +---# Managing Topics
   1.339 +
   1.340 +_Browser-based rename, move, and delete for individual topics_
   1.341 +
   1.342 +---++ Overview
   1.343 +
   1.344 +You can use browser-based controls to change a topic's name, move it to another TWiki web, or delete it to a hidden =Trash= web.
   1.345 +
   1.346 +---++ How to Rename/Move/Delete a Topic
   1.347 +
   1.348 +	1. *Click* on ==[More]== (bottom right of page) on the topic to be changed, then, in the new screen, on ==[Rename/move]==. You can now rename and/or move/delete in one operation:
   1.349 +	1. *Move/Delete:* Select the target web if other than the current web - choose =Trash= to [[#DeleteTopic][delete a topic]].
   1.350 +	1. *Rename:* Enter the new topic name - default is current name <br />
   1.351 +	  %X% *NOTE:* You'll be warned if any of the topics to be affected are locked (being edited), or if there is a name conflict.
   1.352 +	1. *Prevent updates* by unchecking individual items on the list of referring links - these topics will NOT to be updated with the new name (by default, all referring links will be updated).
   1.353 +	1. *Click* on ==[Rename/Move]==: the topic will be renamed and links to the topic updated as requested.
   1.354 +		* If any of the referring pages are locked then they will be listed: you can correct these later by again pressing ==[Rename/Move]==.
   1.355 +		* %H% There is a __Put back__ feature that allows you to undo a ==Rename/Move/Delete== - an instruction line and undo link will appear at the bottom of the modified topic. This allows you to revert from the _last modification only_.
   1.356 +
   1.357 +#DeleteTopic
   1.358 +---++ Deleted Topics: How to Clear the Trash
   1.359 +
   1.360 +Deleted topics are moved to a special ==Trash== web - they are NOT physically erased from the server. All webs share =Trash= - in case of a name conflict with a topic already =Trash=, the user is alerted and asked to choose a new name.
   1.361 +
   1.362 +The =Trash= web should be be cleared periodically, by archiving (saving) the text and RCS files if required (recommended), then deleting them from the =Trash= directory. 
   1.363 +
   1.364 +	* %X% This can only be done from on the server, not through the browser. 
   1.365 +		* %T% Since simple FTP access to the ==Trash== directory is all that's required for maintenance, it's possible to grant =Trash= admin privileges to multiple users, while strictly limiting server access. 
   1.366 +
   1.367 +---++ Redirecting from an Old Topic
   1.368 +
   1.369 +You can use TWikiMetaData to place a command in the %TWIKIWEB%.WebTopicViewTemplate and %TWIKIWEB%.WebTopicNonWikiTemplate that will indicate that a topic has been moved by searching for the tag %<nop>META:TOPICMOVED{...}%. Customize something like this:
   1.370 +
   1.371 +<blockquote style="background-color:#f0f0f0">
   1.372 +<verbatim>
   1.373 +%<nop>METASEARCH{type="topicmoved" web="%WEB%" topic="%TOPIC%" 
   1.374 +title="This topic used to exist and was moved to: "}%
   1.375 +</verbatim>
   1.376 +</blockquote>
   1.377 +
   1.378 +---++ How Rename/Move Works
   1.379 +
   1.380 +	1. %<nop>SEARCH%, with a special template, finds and displays all occurrences of the topic name in other topics, site-wide. These referring links are by default automatically changed to the new topic and/or web name. This includes relevant TWikiMetaData definitions.
   1.381 +		* User can omit one or more topics from the update list by unchecking them.
   1.382 +		* =&lt;pre&gt;= and =&lt;verbatim&gt;= are honoured - no changes are made to text within these areas.
   1.383 +	2. The topic is moved (if locks allow).
   1.384 +	3. References are changed (locks and permissions permitting).
   1.385 +	4. Any referring topics that can't be changed due to locks are listed - user can take note and change them at another time.
   1.386 +
   1.387 +---+++ How Referring Topics Are Found
   1.388 +
   1.389 +Referring topics are found using the %<nop>SEARCH% variable - see the template ==searchrenameview.tmpl==. First, matching topics in the current web are listed - matches are to ==topic==.  Next, all webs (including the current one) are listed that match ==web.topic==. Because %<nop>SEARCH% is used, webs marked in WebPreferences as =NOSEARCHALL= will not show up in the search for references to the =topic= being changed.
   1.390 +
   1.391 +Changed references are kept are as short as possible, ex: =topic= is used in preference to =web.topic=.
   1.392 +
   1.393 +---+++ Effect of User Access Settings
   1.394 +
   1.395 +User permissions affect the Rename function in various ways. To rename a topic, you need both ==ALLOWTOPICCHANGE== and ==ALLOWTOPICRENAME== permission for that topic. To alter referring topics, you need change permission. See TWikiAccessControl for information on setting up access permissions.
   1.396 +
   1.397 +---++ Special Considerations
   1.398 +
   1.399 +Consider carefully whether to make browser-based *Rename/Move/Delete* widely available, or to restrict it to an administrator/moderator group. Allowing all users to easily manipulate topics can be extremely useful in refactoring a busy web or site. However, there are at least two significant potential drawbacks to take into account: 
   1.400 +	* When referring links are updated, the modified topics appear in WebChanges, creating the impression that editorial changes were made. This can undermine the usefulness of WebChanges.
   1.401 +	* Due to [[#RenameLimitations][current limitations]], fairly heavy use of Rename/Move/Delete functions can lead to an accumulation of minor technical problems (ex: broken links) and usability issues (ex: user confusion). If Rename... is used heavily, these negatives will obviously increase, in number and effect.
   1.402 +
   1.403 +Ultimately, the size, objectives, and policies of your TWiki site, the real-world behavior of your user group, and most importantly, the initial TWiki site management leadership, will determine the most effective implementation of this feature, and the success of the site overall.
   1.404 +
   1.405 +#RenameLimitations
   1.406 +---++ Known Issues
   1.407 +
   1.408 +*Rename/Move* is fairly complicated due to the dynamic generation of links. Ideally, it would be possible to run the required part of rendering in a way that would allow identification of the text to be changed. Unfortunately, these hooks don't exist in TWiki at present.  Instead, %<nop>SEARCH% is used with a special template to show the text to be changed, and the selected topics are then altered. One drawback is that =search= can show matches that will not be updated due to case differences. Other mismatches with actual rendered output are also possible as the approaches are so different.
   1.409 +
   1.410 +The following shows some limitations of square bracket processing.
   1.411 +
   1.412 +<blockquote style="background-color:#f0f0f0">
   1.413 +<verbatim>
   1.414 +[[Old Topic]]  => [[NewTopic][Old Topic]]
   1.415 +[[old topic]]  => [[NewTopic][old topic]]
   1.416 +[[old t opic]] => not changed
   1.417 +[[OldTopic]]	=> [[NewTopic]]
   1.418 +</verbatim>
   1.419 +</blockquote>
   1.420 +
   1.421 +-- Main.MikeMannix - 27 Dec 2001
   1.422 +@
   1.423 +
   1.424 +
   1.425 +1.16
   1.426 +log
   1.427 +@none
   1.428 +@
   1.429 +text
   1.430 +@d1 1
   1.431 +a1 1
   1.432 +%META:TOPICINFO{author="MikeMannix" date="1009500480" format="1.0" version="1.16"}%
   1.433 +d11 1
   1.434 +a11 1
   1.435 +While view a special topic, you can use browser-based controls to change its name, move it to another TWiki web, or delete it to a hidden =Trash= web.
   1.436 +d68 1
   1.437 +a68 1
   1.438 +	* Due to [[#RenameLimitations][current limitations]], fairly heavy use of rename/move/delete functions can lead to an accumulation of minor technical problems (ex: broken links) and usability issues (ex: user confusion). If Rename is used heavily, these types of negatives will obviously increase.
   1.439 +d70 1
   1.440 +a70 1
   1.441 +Ultimately, the size, objectives, and policies of your TWiki site, the real-world behavior of your user group, and most importantly, the initial TWiki site management leadership, will determine the most effective implementation of this feature, and the success of the site overall. 
   1.442 +@
   1.443 +
   1.444 +
   1.445 +1.15
   1.446 +log
   1.447 +@none
   1.448 +@
   1.449 +text
   1.450 +@d1 1
   1.451 +a1 1
   1.452 +%META:TOPICINFO{author="MikeMannix" date="1009457340" format="1.0" version="1.15"}%
   1.453 +d7 2
   1.454 +d11 1
   1.455 +a11 1
   1.456 +_Browser-based rename, move, and delete for individual topics_
   1.457 +a14 2
   1.458 +While view a special topic, you can use browser-based controls to change its name, move it to another TWiki web, or delete it to a hidden =Trash= web.
   1.459 +
   1.460 +d32 1
   1.461 +a32 1
   1.462 +		* %T% Since simple FTP access to the =Trash= directory is all that's required to maintain =Trash=, it's possible grant users =Trash= admin privileges while limiting server access. 
   1.463 +d70 1
   1.464 +a70 1
   1.465 +Ultimately, the size, objectives, and policies of your TWiki site, and the real-world behavior of your user group, will determine the most effective implementation of this feature.
   1.466 +d75 1
   1.467 +a75 1
   1.468 +*Rename/Move* is fairly complicated due to the dynamic generation of links. Ideally, it would be possible to run the required part of rendering in a way that would allow identification of the text to be changed. Unfortunately, these hooks don't exist in TWiki at present.  Instead, %<nop>SEARCH% is used with a special template to show the text to be changed, and the selected topics are then altered. One drawback is that =search= can show matches that will not be updated because of case differences. Other mismatches to actual rendered output are also possible as the approaches are so different.
   1.469 +d88 1
   1.470 +a88 1
   1.471 +-- Main.MikeMannix - 27 Dec 2001
   1.472 +@
   1.473 +
   1.474 +
   1.475 +1.14
   1.476 +log
   1.477 +@none
   1.478 +@
   1.479 +text
   1.480 +@d1 1
   1.481 +a1 1
   1.482 +%META:TOPICINFO{author="PeterThoeny" date="1008578651" format="1.0" version="1.14"}%
   1.483 +a6 2
   1.484 +_Browser-based rename, move, and delete for individual topics_
   1.485 +
   1.486 +d9 1
   1.487 +a9 1
   1.488 +Use browser controls while viewing a topic, to change its name, move it to another TWiki web, or delete it to a hidden =Trash= web.
   1.489 +d13 7
   1.490 +a19 5
   1.491 +	1. *Click* on ==[More]== (bottom right of page) on the topic to be changed, then, in the new screen, on ==[Rename/move]==.
   1.492 +	1. *Select* target web if other than the current web - chose =Trash= to [[#DeleteTopic][delete a topic]]
   1.493 +	1. *Enter* the new topic name - default is current name <br />
   1.494 +	  __NOTE:__ You will be warned if there are locks or if there is a name conflict.
   1.495 +	1. *Select* from the list of referring links any topics NOT to be updated with the new name (by default, all referring links will be updated).
   1.496 +d21 2
   1.497 +a22 8
   1.498 +		* If any of the referring pages are locked then they will be listed.
   1.499 +		* You can correct these later by again pressing ==[Rename/Move]==.
   1.500 +
   1.501 +---+++ Referring Topics
   1.502 +
   1.503 +Referring topics are found using the the %<nop>SEARCH% variable, see the template =searchrenameview.tmpl=.  First, matching topics in the current Web are listed - matches are to _topic_.  Next, all Webs (including the current one) are listed that match _web.topic_.  Because %<nop>SEARCH% is used, Webs marked in WebPreferences as NOSEARCHALL will not show up in the search for refernces to the _topic_ being changed.
   1.504 +
   1.505 +Changed references are kept are as short as possible, ex: _topic_ is used in preference to _web.topic_.
   1.506 +d25 1
   1.507 +a25 1
   1.508 +---+++ About Deleting a Topic
   1.509 +d27 1
   1.510 +a27 1
   1.511 +Deleted topics are moved to the =Trash= web - NOT physically erased from the server.  All webs share =Trash= - in case of a name conflict with a topic already =Trash=, the user is alerted and asked to choose a new name.
   1.512 +d29 1
   1.513 +a29 1
   1.514 +---++ Clearing the Trash
   1.515 +d31 2
   1.516 +a32 1
   1.517 +The =Trash= web should be be cleared periodically, by archiving the contents if required (recommended), then deleting the files from the =Trash= directory.
   1.518 +d36 1
   1.519 +a36 1
   1.520 +You can use TWikiMetaData to place a command in %TWIKIWEB%.WebTopicViewTemplate and %TWIKIWEB%.WebTopicNonWikiTemplate that will show if a topic has moved by searching for the tag %<nop>META:TOPICMOVED{...}%. Customize something like this:
   1.521 +d45 1
   1.522 +a45 5
   1.523 +---++ Effect of Access Settings
   1.524 +
   1.525 +Permissions affect the rename function in various ways.  To rename a topic, you need both change and rename permissions.  To alter referring topics, you need change permission.  See TWikiAccessControl for information on setting up access permissions.
   1.526 +
   1.527 +---++ How Rename/move Works
   1.528 +d48 1
   1.529 +a48 1
   1.530 +		* User can omit one or more topics from the update list.
   1.531 +d52 19
   1.532 +a70 1
   1.533 +	4. Any referring topics that can't be changed due to locks are listed - user can change them at another time.
   1.534 +d72 2
   1.535 +a73 1
   1.536 +---++ Known Limitations
   1.537 +d75 1
   1.538 +a75 1
   1.539 +*Rename/move* in is fairly complicated due to the dynamic generation of links. Ideally, it would be possible to run the required part of rendering in a way that would allow identification of the text to be changed. Unfortunately, these hooks don't exist in TWiki at present.  Instead, %<nop>SEARCH% is used with a special template to show the text to be changed, and the selected topics are then altered. One drawback is that =search= can show matches that will not be updated because of case differences. Other mismatches to actual rendered output are also possible as the approaches are so different.
   1.540 +d88 1
   1.541 +a88 1
   1.542 +-- MikeMannix - 15 Sep 2001 <br />	
   1.543 +@
   1.544 +
   1.545 +
   1.546 +1.13
   1.547 +log
   1.548 +@none
   1.549 +@
   1.550 +text
   1.551 +@d1 1
   1.552 +a1 1
   1.553 +%META:TOPICINFO{author="MikeMannix" date="1000788905" format="1.0" version="1.13"}%
   1.554 +d52 1
   1.555 +a52 1
   1.556 +Permissions affect the rename function in various ways.  To rename a topic, you need both change and rename permissions.  To alter refer4ing topics, you need change permission.  See TWikiAccessControl for information on setting up access permissions.
   1.557 +@
   1.558 +
   1.559 +
   1.560 +1.12
   1.561 +log
   1.562 +@none
   1.563 +@
   1.564 +text
   1.565 +@d1 1
   1.566 +a1 1
   1.567 +%META:TOPICINFO{author="MikeMannix" date="1000548911" format="1.0" version="1.12"}%
   1.568 +d11 1
   1.569 +a11 1
   1.570 +Using browser controls while viewing a topic, you change its name, move it to another TWiki web, or delete it:
   1.571 +d13 4
   1.572 +a16 1
   1.573 +	1. *Select* target web if other than the current web - chose ==Trash== to [[#DeleteTopic][delete a topic]]
   1.574 +d18 5
   1.575 +a22 5
   1.576 +	  __NOTE:__ You will be warned if there are locks or if there is a name conflict
   1.577 +	1. *Select* from the list of links to the topic that will be changed those to OMIT from changes (by default, all referring links will be updated)
   1.578 +	1. *Click* on *Rename/Move* to rename/remove topic will be renamed and links to the topic updated as requested.
   1.579 +		* If any of the referring pages are locked then they will be listed
   1.580 +		* You can correct these later by again pressing Rename/Move
   1.581 +d28 1
   1.582 +a28 1
   1.583 +Changed references are kept are as short as possible, i.e. _topic_ is used in preference to _web.topic_.
   1.584 +d31 1
   1.585 +a31 1
   1.586 +---+++ Deleting a Topic
   1.587 +d35 1
   1.588 +a35 1
   1.589 +---++++ Clearing the Trash
   1.590 +d37 1
   1.591 +a37 1
   1.592 +__NOTE:__ The =Trash= web should be be cleared periodically, by archiving the contents if required (recommended), then deleting the files from the =Trash= directory.
   1.593 +d50 1
   1.594 +a50 1
   1.595 +---++ Impact of Topic Access Settings
   1.596 +d56 6
   1.597 +a61 6
   1.598 +	* %<nop>SEARCH% is used with a special template to show text in topics that requires updating to point to the new topic and/or web name.  This includes relevent TWikiMetaData definition.
   1.599 +		* User chooses which topics will be altered
   1.600 +	* =&lt;pre&gt;= and =&lt;verbatim&gt;= are honoured - no changes are made to text within these areas
   1.601 +	* Topic is moved (if locks allow)
   1.602 +	* References are changed (locks and permissions permitting)
   1.603 +	* Any referring topics that can't be changed due to locks are listed - user can change them at another time.
   1.604 +d78 1
   1.605 +a78 1
   1.606 +-- MikeMannix - 15 Sep 2001 <br />	
   1.607 +@
   1.608 +
   1.609 +
   1.610 +1.11
   1.611 +log
   1.612 +@none
   1.613 +@
   1.614 +text
   1.615 +@d1 1
   1.616 +a1 1
   1.617 +%META:TOPICINFO{author="PeterThoeny" date="1000462013" format="1.0" version="1.11"}%
   1.618 +a2 2
   1.619 +%INCLUDE{"UtilTempDocNote"}%
   1.620 +
   1.621 +d11 1
   1.622 +a11 1
   1.623 +Select *Rename/move* when viewing a topic to change its name, move it to another TWiki web, or delete it:
   1.624 +d23 1
   1.625 +a23 1
   1.626 +Referring topics are found using the the %<nop>SEARCH% variable, see the template ==searchrenameview.tmpl==.  First, matching topics in the current Web are listed - matches are to _topic_.  Next, all Webs (including the current one) are listed that match _web.topic_.  Because %<nop>SEARCH% is used, Webs marked in WebPreferences as NOSEARCHALL will not show up in the search for refernces to the _topic_ being changed.
   1.627 +d75 1
   1.628 +@
   1.629 +
   1.630 +
   1.631 +1.10
   1.632 +log
   1.633 +@none
   1.634 +@
   1.635 +text
   1.636 +@d1 1
   1.637 +a1 1
   1.638 +%META:TOPICINFO{author="MikeMannix" date="1000328894" format="1.0" version="1.10"}%
   1.639 +d16 1
   1.640 +a16 1
   1.641 +	1. *Enter* the new topic name - default is current name <br>
   1.642 +d51 1
   1.643 +a51 1
   1.644 +Permissions affect the rename function in various ways.  To rename a topic, you need both change and rename permissions.  To alter refer4ing topics, you need change permission.  See [[TWikiDocumentation#TWiki_Access_Control]] for information on setting up access permissions.
   1.645 +d55 1
   1.646 +a55 1
   1.647 +	* %<nop>SEARCH% is used with a special template to show text in topics that requires updating to point to the new topic and/or web name.  This includes relevent [[TWikiDocumentation#Meta_Data_Definition][<nop>MetaData]]
   1.648 +d57 1
   1.649 +a57 1
   1.650 +	* &lt;PRE&gt; and &lt;VERBATIM&gt; are honoured - no changes are made to text within these areas
   1.651 +@
   1.652 +
   1.653 +
   1.654 +1.9
   1.655 +log
   1.656 +@none
   1.657 +@
   1.658 +text
   1.659 +@d1 1
   1.660 +a1 1
   1.661 +%META:TOPICINFO{author="MikeMannix" date="1000278281" format="1.0" version="1.9"}%
   1.662 +d44 2
   1.663 +a45 1
   1.664 +%<nop>METASEARCH{type="topicmoved" web="%WEB%" topic="%TOPIC%" title="This topic used to exist and was moved to: "}%
   1.665 +@
   1.666 +
   1.667 +
   1.668 +1.8
   1.669 +log
   1.670 +@none
   1.671 +@
   1.672 +text
   1.673 +@d1 1
   1.674 +a1 1
   1.675 +%META:TOPICINFO{author="MikeMannix" date="999857661" format="1.0" version="1.8"}%
   1.676 +d3 2
   1.677 +@
   1.678 +
   1.679 +
   1.680 +1.7
   1.681 +log
   1.682 +@none
   1.683 +@
   1.684 +text
   1.685 +@d1 1
   1.686 +a1 1
   1.687 +%META:TOPICINFO{author="MikeMannix" date="999814735" format="1.0" version="1.7"}%
   1.688 +d5 1
   1.689 +a5 1
   1.690 +---## Managing Topics
   1.691 +d9 1
   1.692 +a9 1
   1.693 +---+++ Overview
   1.694 +d21 1
   1.695 +a21 1
   1.696 +---++++ Referring Topics
   1.697 +d28 1
   1.698 +a28 1
   1.699 +---++++ Deleting a Topic
   1.700 +d32 1
   1.701 +a32 1
   1.702 +---+++++ Clearing the Trash
   1.703 +d36 1
   1.704 +a36 1
   1.705 +---+++ Redirecting from an Old Topic
   1.706 +d46 1
   1.707 +a46 1
   1.708 +---+++ Impact of Topic Access Settings
   1.709 +d50 1
   1.710 +a50 1
   1.711 +---+++ How Rename/move Works
   1.712 +d59 1
   1.713 +a59 1
   1.714 +---+++ Known Limitations
   1.715 +@
   1.716 +
   1.717 +
   1.718 +1.6
   1.719 +log
   1.720 +@none
   1.721 +@
   1.722 +text
   1.723 +@d1 1
   1.724 +a1 1
   1.725 +%META:TOPICINFO{author="MikeMannix" date="999329908" format="1.0" version="1.6"}%
   1.726 +d7 1
   1.727 +a7 1
   1.728 +Select [Rename/move] when viewing a topic to change its name, delete it or move it
   1.729 +d9 9
   1.730 +a17 5
   1.731 +	1 Select target Web if other than existing Web
   1.732 +	2 Fill in new name - defaults to current name
   1.733 +	3 You will be warned if there are locks or if there is a name clash
   1.734 +	4 A list of _links_ to the topic will be listed, by default these links will be updated, click checkbox to prevent this
   1.735 +	5 Press the Rename/Move button, topic will be renamed and links to the topic updated as requested.
   1.736 +d21 1
   1.737 +a21 1
   1.738 +---+++ Referring Topics
   1.739 +d27 2
   1.740 +a28 1
   1.741 +---+++ Deleting a Topic
   1.742 +d30 1
   1.743 +a30 1
   1.744 +Topics can be _deleted_ by moving them to the ==Trash Web==.  Note that topics from all Webs go into this, so there could be name clashes, the user is warned of this and asked to choose a new name.  When TWiki support sub-webs, these could be created on demand in the Trash Web, which would avoid this name clash problem.
   1.745 +d32 3
   1.746 +a34 1
   1.747 +It is up to the administrator of a TWiki installation to clean the Trash Web periodically e.g. by archiving to tape of CDROM entries older than 6 months.
   1.748 +d38 1
   1.749 +a38 1
   1.750 +Something like the following can be put in %TWIKIWEB%.WebTopicViewTemplate and %TWIKIWEB%.WebTopicNonWikiTemplate to show if a topic has moved.  It does this by searching for the tag %<nop>META:TOPICMOVED{...}%.
   1.751 +d40 2
   1.752 +a41 1
   1.753 +<pre>
   1.754 +d43 2
   1.755 +a44 1
   1.756 +</pre>
   1.757 +d46 1
   1.758 +a46 1
   1.759 +---+++ Permissions
   1.760 +d48 1
   1.761 +a48 1
   1.762 +Permissions affect rename in various ways.  To rename a topic you need both change and rename permissions.  To alter refering topics, you need change permission.  See [[TWikiDocumentation#TWiki_Access_Control]] for information on setting up permissions.
   1.763 +d50 1
   1.764 +a50 1
   1.765 +---+++ Procedure
   1.766 +d52 1
   1.767 +a52 1
   1.768 +	* %<nop>SEARCH% is used with a special template to show text in topics that requires alteration to point to the new topic name.  This includes relavent [[TWikiDocumentation#Meta_Data_Definition][meta data]]
   1.769 +d54 1
   1.770 +a54 1
   1.771 +	* &lt;PRE&gt; and &lt;verbatim&gt; are honoured - no changes to text within these areas
   1.772 +d56 2
   1.773 +a57 2
   1.774 +	* References are changed (locks and permissions allowing)
   1.775 +	* Any refering topics that can't be changed due to locks are listed - user can try getting these references changed at any time.
   1.776 +d61 1
   1.777 +a61 1
   1.778 +Rename in TWiki is fairly complicated due to the dynamic generation of links.  Ideally it would be possible to run the required part of rendering in a way that would allow identification of the text to be changed.  Unfortunately, these hooks don't exist in TWiki at present.  Instead, %<nop>SEARCH% is used with a special template to show the text to be changed.  And the selected topics and then altered.  Search can show matches that will not be updated e.g. because of case differences.  Other mis-matches to actual rendered output are also possible as the approaches are so different.
   1.779 +d72 2
   1.780 +a73 2
   1.781 +</blockquote>
   1.782 +
   1.783 +@
   1.784 +
   1.785 +
   1.786 +1.5
   1.787 +log
   1.788 +@none
   1.789 +@
   1.790 +text
   1.791 +@d1 1
   1.792 +a1 1
   1.793 +%META:TOPICINFO{author="MikeMannix" date="999297399" format="1.0" version="1.5"}%
   1.794 +d5 1
   1.795 +a5 1
   1.796 +---## Modifying Topics
   1.797 +d7 1
   1.798 +a7 1
   1.799 +Select rename/move when viewing a topic to change its name, delete it or move it
   1.800 +d17 1
   1.801 +a17 1
   1.802 +---+++ Referring topics
   1.803 +d23 1
   1.804 +a23 1
   1.805 +---+++ Deleting a topic
   1.806 +d29 1
   1.807 +a29 1
   1.808 +---+++ Redirection from old topic
   1.809 +d41 1
   1.810 +a41 1
   1.811 +---+++ Approach
   1.812 +d50 1
   1.813 +a50 1
   1.814 +---+++ Limitations
   1.815 +d56 1
   1.816 +d63 3
   1.817 +a65 4
   1.818 +
   1.819 +
   1.820 +
   1.821 +
   1.822 +@
   1.823 +
   1.824 +
   1.825 +1.4
   1.826 +log
   1.827 +@none
   1.828 +@
   1.829 +text
   1.830 +@d1 1
   1.831 +a1 1
   1.832 +%META:TOPICINFO{author="MikeMannix" date="999178132" format="1.0" version="1.4"}%
   1.833 +d5 1
   1.834 +a5 1
   1.835 +---## Rename/move/delete a topic
   1.836 +@
   1.837 +
   1.838 +
   1.839 +1.3
   1.840 +log
   1.841 +@none
   1.842 +@
   1.843 +text
   1.844 +@d1 1
   1.845 +a1 1
   1.846 +%META:TOPICINFO{author="JohnTalintyre" date="999105045" format="1.0" version="1.3"}%
   1.847 +d3 2
   1.848 +d7 1
   1.849 +a7 1
   1.850 +Select rename/move when viewing a topic to change its name, [[DeleteTopic][Delete it]] or [[MoveTopic][Move it]]
   1.851 +@
   1.852 +
   1.853 +
   1.854 +1.2
   1.855 +log
   1.856 +@none
   1.857 +@
   1.858 +text
   1.859 +@d1 1
   1.860 +a1 1
   1.861 +%META:TOPICINFO{author="JohnTalintyre" date="997289816" format="1.0beta2" version="1.2"}%
   1.862 +d5 1
   1.863 +a5 1
   1.864 +Select rename/move when viewing a topic to change its name, do DeleteTopic or MoveTopic.
   1.865 +d17 1
   1.866 +a17 1
   1.867 +Referring topics are found using the the %<nop>SEARCH% variable, see the template searchrenameview.tmpl.  First, matching topics in the current Web are listed - matches are to _topic_.  Next, all Webs (including the current one) are listed that match _web.topic_.  Because %<nop>SEARCH% is used, Webs marked in WebPreferences as NOSEARCHALL will not show up in the search for refernces to the _topic_ being changed.
   1.868 +d23 1
   1.869 +a23 1
   1.870 +Topics can be _deleted_ by moving them to the Trash Web (this should be added to the default distribution).  Note that topics from all Webs go into this, so there could be name clashes, the user is warned of this and asked to choose a new name.  When TWiki support sub-webs, these could be created on demand in the Trash Web, which would avoid this name clash problem.
   1.871 +d32 1
   1.872 +a32 1
   1.873 +<h2>%METASEARCH{type="topicmoved" web="%WEB%" topic="%TOPIC%" title="This topic used to exist and was moved to: "}%</h2>
   1.874 +d37 1
   1.875 +a37 1
   1.876 +Permissions affect rename in various ways.  To rename a topic you need both change and rename permissions.  To alter refering topics, you need change permission.  See TWikiAccessControl for information on setting up permissions.
   1.877 +d41 6
   1.878 +a46 4
   1.879 +	* %<nop>SEARCH% is used with a special template to show the text would be changed
   1.880 +		* User chooses which topics
   1.881 +	* &lt;PRE&gt; and &lt;verbatim&gt; are honoured
   1.882 +	* FIXME - more needed
   1.883 +d50 1
   1.884 +a50 1
   1.885 +Rename in a Wiki is fairly complicated, due to the dynamic generation of links.  Ideally it would be possible to run the required part of rendering in a way that would allow identification of the text to be changed.  Unfortunately, these hooks don't exist in TWiki at present.  Instead, %<nop>SEARCH% is used with a special template to show the text to be changed.  And the selected topics and then altered.  Search can show matches that will not be updated e.g. because of case differences.  Other mis-matches to actual rendered output are also possible as the approaches are so different.
   1.886 +@
   1.887 +
   1.888 +
   1.889 +1.1
   1.890 +log
   1.891 +@none
   1.892 +@
   1.893 +text
   1.894 +@d1 1
   1.895 +a1 1
   1.896 +%META:TOPICINFO{author="JohnTalintyre" date="997200531" format="1.0beta2" version="1.1"}%
   1.897 +d3 1
   1.898 +a3 1
   1.899 +	+ Rename/move/delete a topic
   1.900 +d15 1
   1.901 +a15 1
   1.902 +	++ Referring topics
   1.903 +d21 1
   1.904 +a21 1
   1.905 +	++ Deleting a topic
   1.906 +d27 1
   1.907 +a27 1
   1.908 +	++ Redirection from old topic
   1.909 +d35 1
   1.910 +a35 1
   1.911 +	++ Permissions
   1.912 +d38 22
   1.913 +@