data/TWiki/ManagingTopics.txt,v
changeset 0 414e01d06fd5
equal deleted inserted replaced
-1:000000000000 0:414e01d06fd5
       
     1 head	1.22;
       
     2 access;
       
     3 symbols;
       
     4 locks; strict;
       
     5 comment	@# @;
       
     6 
       
     7 
       
     8 1.22
       
     9 date	2008.01.22.03.21.36;	author TWikiContributor;	state Exp;
       
    10 branches;
       
    11 next	1.21;
       
    12 
       
    13 1.21
       
    14 date	2007.01.16.04.11.59;	author TWikiContributor;	state Exp;
       
    15 branches;
       
    16 next	1.20;
       
    17 
       
    18 1.20
       
    19 date	2006.04.01.05.55.08;	author TWikiContributor;	state Exp;
       
    20 branches;
       
    21 next	1.19;
       
    22 
       
    23 1.19
       
    24 date	2006.02.01.12.01.17;	author TWikiContributor;	state Exp;
       
    25 branches;
       
    26 next	1.18;
       
    27 
       
    28 1.18
       
    29 date	2004.08.15.07.55.02;	author PeterThoeny;	state Exp;
       
    30 branches;
       
    31 next	1.17;
       
    32 
       
    33 1.17
       
    34 date	2003.01.12.09.14.14;	author PeterThoeny;	state Exp;
       
    35 branches;
       
    36 next	1.16;
       
    37 
       
    38 1.16
       
    39 date	2001.12.28.00.48.00;	author MikeMannix;	state Exp;
       
    40 branches;
       
    41 next	1.15;
       
    42 
       
    43 1.15
       
    44 date	2001.12.27.12.49.00;	author MikeMannix;	state Exp;
       
    45 branches;
       
    46 next	1.14;
       
    47 
       
    48 1.14
       
    49 date	2001.12.17.08.44.11;	author PeterThoeny;	state Exp;
       
    50 branches;
       
    51 next	1.13;
       
    52 
       
    53 1.13
       
    54 date	2001.09.18.04.55.05;	author MikeMannix;	state Exp;
       
    55 branches;
       
    56 next	1.12;
       
    57 
       
    58 1.12
       
    59 date	2001.09.15.10.15.11;	author MikeMannix;	state Exp;
       
    60 branches;
       
    61 next	1.11;
       
    62 
       
    63 1.11
       
    64 date	2001.09.14.10.06.53;	author PeterThoeny;	state Exp;
       
    65 branches;
       
    66 next	1.10;
       
    67 
       
    68 1.10
       
    69 date	2001.09.12.21.08.14;	author MikeMannix;	state Exp;
       
    70 branches;
       
    71 next	1.9;
       
    72 
       
    73 1.9
       
    74 date	2001.09.12.07.04.41;	author MikeMannix;	state Exp;
       
    75 branches;
       
    76 next	1.8;
       
    77 
       
    78 1.8
       
    79 date	2001.09.07.10.14.21;	author MikeMannix;	state Exp;
       
    80 branches;
       
    81 next	1.7;
       
    82 
       
    83 1.7
       
    84 date	2001.09.06.22.18.19;	author MikeMannix;	state Exp;
       
    85 branches;
       
    86 next	1.6;
       
    87 
       
    88 1.6
       
    89 date	2001.09.01.07.37.12;	author MikeMannix;	state Exp;
       
    90 branches;
       
    91 next	1.5;
       
    92 
       
    93 1.5
       
    94 date	2001.08.31.22.36.39;	author MikeMannix;	state Exp;
       
    95 branches;
       
    96 next	1.4;
       
    97 
       
    98 1.4
       
    99 date	2001.08.30.13.28.52;	author MikeMannix;	state Exp;
       
   100 branches;
       
   101 next	1.3;
       
   102 
       
   103 1.3
       
   104 date	2001.08.29.17.10.02;	author JohnTalintyre;	state Exp;
       
   105 branches;
       
   106 next	1.2;
       
   107 
       
   108 1.2
       
   109 date	2001.08.08.16.56.57;	author JohnTalintyre;	state Exp;
       
   110 branches;
       
   111 next	1.1;
       
   112 
       
   113 1.1
       
   114 date	2001.08.07.15.33.55;	author JohnTalintyre;	state Exp;
       
   115 branches;
       
   116 next	;
       
   117 
       
   118 
       
   119 desc
       
   120 @none
       
   121 @
       
   122 
       
   123 
       
   124 1.22
       
   125 log
       
   126 @buildrelease
       
   127 @
       
   128 text
       
   129 @%META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="22"}%
       
   130 %META:TOPICPARENT{name="WebHome"}%
       
   131 %STARTINCLUDE%
       
   132 ---+ Managing Topics
       
   133 
       
   134 _Browser-based rename, move, and delete for individual topics_
       
   135 
       
   136 %TOC%
       
   137 
       
   138 ---++ Overview
       
   139 
       
   140 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.
       
   141 
       
   142 ---++ How to Rename/Move/Delete a Topic
       
   143 
       
   144    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:
       
   145    1. *Move/Delete:* Select the target web if other than the current web - choose =Trash= to [[#DeleteTopic][delete a topic]].
       
   146    1. *Rename:* Enter the new topic name - default is current name <br />
       
   147      %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.
       
   148    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).
       
   149    1. *Click* on ==[Rename/Move]==: the topic will be renamed and links to the topic updated as requested.
       
   150       * If any of the referring pages are locked then they will be listed: you can correct these later by again pressing ==[Rename/Move]==.
       
   151       * %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_.
       
   152 
       
   153 #DeleteTopic
       
   154 ---++ Deleted Topics: How to Clear the Trash
       
   155 
       
   156 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.
       
   157 
       
   158 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. 
       
   159 
       
   160    * %X% This can only be done from on the server, not through the browser. 
       
   161       * %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. 
       
   162 
       
   163 ---++ Redirecting from an Old Topic
       
   164 
       
   165 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:
       
   166 
       
   167 <blockquote>
       
   168 <verbatim>
       
   169 %<nop>METASEARCH{type="topicmoved" web="%WEB%" topic="%TOPIC%" 
       
   170 title="This topic used to exist and was moved to: "}%
       
   171 </verbatim>
       
   172 </blockquote>
       
   173 
       
   174 ---++ How Rename/Move Works
       
   175 
       
   176    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.
       
   177       * User can omit one or more topics from the update list by unchecking them.
       
   178       * =&lt;pre&gt;= and =&lt;verbatim&gt;= are honoured - no changes are made to text within these areas.
       
   179    2. The topic is moved (if locks allow).
       
   180    3. References are changed (locks and permissions permitting).
       
   181    4. Any referring topics that can't be changed due to locks are listed - user can take note and change them at another time.
       
   182 
       
   183 ---+++ How Referring Topics Are Found
       
   184 
       
   185 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.
       
   186 
       
   187 Changed references are kept are as short as possible, ex: =topic= is used in preference to =web.topic=.
       
   188 
       
   189 ---+++ Effect of User Access Settings
       
   190 
       
   191 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.
       
   192 
       
   193 ---++ Special Considerations
       
   194 
       
   195 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: 
       
   196    * 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.
       
   197    * 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.
       
   198 
       
   199 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.
       
   200 
       
   201 #RenameLimitations
       
   202 ---++ Known Issues
       
   203 
       
   204 *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.
       
   205 
       
   206 The following shows some limitations of square bracket processing.
       
   207 
       
   208 <blockquote>
       
   209 <verbatim>
       
   210 [[Old Topic]]  => [[NewTopic][Old Topic]]
       
   211 [[old topic]]  => [[NewTopic][old topic]]
       
   212 [[old t opic]] => not changed
       
   213 [[OldTopic]]   => [[NewTopic]]
       
   214 </verbatim>
       
   215 </blockquote>
       
   216 
       
   217 __Related Topics:__ UserDocumentationCategory, AdminDocumentationCategory
       
   218 @
       
   219 
       
   220 
       
   221 1.21
       
   222 log
       
   223 @buildrelease
       
   224 @
       
   225 text
       
   226 @d1 1
       
   227 a1 1
       
   228 %META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="21"}%
       
   229 a2 1
       
   230 %TOC%
       
   231 d4 1
       
   232 a4 1
       
   233 ---# Managing Topics
       
   234 d8 2
       
   235 d37 1
       
   236 a37 1
       
   237 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:
       
   238 d63 1
       
   239 a63 1
       
   240 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.
       
   241 @
       
   242 
       
   243 
       
   244 1.20
       
   245 log
       
   246 @buildrelease
       
   247 @
       
   248 text
       
   249 @d1 1
       
   250 a1 1
       
   251 %META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="20"}%
       
   252 d38 1
       
   253 a38 1
       
   254 <blockquote style="background-color:#f0f0f0">
       
   255 d62 1
       
   256 a62 1
       
   257 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.
       
   258 d79 1
       
   259 a79 1
       
   260 <blockquote style="background-color:#f0f0f0">
       
   261 @
       
   262 
       
   263 
       
   264 1.19
       
   265 log
       
   266 @buildrelease
       
   267 @
       
   268 text
       
   269 @d1 1
       
   270 a1 1
       
   271 %META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="19"}%
       
   272 d15 8
       
   273 a22 8
       
   274 	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:
       
   275 	1. *Move/Delete:* Select the target web if other than the current web - choose =Trash= to [[#DeleteTopic][delete a topic]].
       
   276 	1. *Rename:* Enter the new topic name - default is current name <br />
       
   277 	  %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.
       
   278 	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).
       
   279 	1. *Click* on ==[Rename/Move]==: the topic will be renamed and links to the topic updated as requested.
       
   280 		* If any of the referring pages are locked then they will be listed: you can correct these later by again pressing ==[Rename/Move]==.
       
   281 		* %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_.
       
   282 d31 2
       
   283 a32 2
       
   284 	* %X% This can only be done from on the server, not through the browser. 
       
   285 		* %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. 
       
   286 d47 6
       
   287 a52 6
       
   288 	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.
       
   289 		* User can omit one or more topics from the update list by unchecking them.
       
   290 		* =&lt;pre&gt;= and =&lt;verbatim&gt;= are honoured - no changes are made to text within these areas.
       
   291 	2. The topic is moved (if locks allow).
       
   292 	3. References are changed (locks and permissions permitting).
       
   293 	4. Any referring topics that can't be changed due to locks are listed - user can take note and change them at another time.
       
   294 d67 2
       
   295 a68 2
       
   296 	* 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.
       
   297 	* 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.
       
   298 d84 1
       
   299 a84 1
       
   300 [[OldTopic]]	=> [[NewTopic]]
       
   301 @
       
   302 
       
   303 
       
   304 1.18
       
   305 log
       
   306 @none
       
   307 @
       
   308 text
       
   309 @d1 1
       
   310 a1 1
       
   311 %META:TOPICINFO{author="PeterThoeny" date="1092556502" format="1.0" version="1.18"}%
       
   312 d56 1
       
   313 a56 1
       
   314 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.
       
   315 d88 1
       
   316 a88 3
       
   317 -- TWiki:Main.MikeMannix - 27 Dec 2001
       
   318 
       
   319 %META:TOPICMOVED{by="MikeMannix" date="999329908" from="TWiki.RenameTopic" to="TWiki.ManagingTopics"}%
       
   320 @
       
   321 
       
   322 
       
   323 1.17
       
   324 log
       
   325 @none
       
   326 @
       
   327 text
       
   328 @d1 1
       
   329 a1 1
       
   330 %META:TOPICINFO{author="PeterThoeny" date="1042362854" format="1.0" version="1.17"}%
       
   331 d3 87
       
   332 a89 86
       
   333 %TOC%
       
   334 %STARTINCLUDE%
       
   335 ---# Managing Topics
       
   336 
       
   337 _Browser-based rename, move, and delete for individual topics_
       
   338 
       
   339 ---++ Overview
       
   340 
       
   341 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.
       
   342 
       
   343 ---++ How to Rename/Move/Delete a Topic
       
   344 
       
   345 	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:
       
   346 	1. *Move/Delete:* Select the target web if other than the current web - choose =Trash= to [[#DeleteTopic][delete a topic]].
       
   347 	1. *Rename:* Enter the new topic name - default is current name <br />
       
   348 	  %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.
       
   349 	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).
       
   350 	1. *Click* on ==[Rename/Move]==: the topic will be renamed and links to the topic updated as requested.
       
   351 		* If any of the referring pages are locked then they will be listed: you can correct these later by again pressing ==[Rename/Move]==.
       
   352 		* %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_.
       
   353 
       
   354 #DeleteTopic
       
   355 ---++ Deleted Topics: How to Clear the Trash
       
   356 
       
   357 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.
       
   358 
       
   359 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. 
       
   360 
       
   361 	* %X% This can only be done from on the server, not through the browser. 
       
   362 		* %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. 
       
   363 
       
   364 ---++ Redirecting from an Old Topic
       
   365 
       
   366 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:
       
   367 
       
   368 <blockquote style="background-color:#f0f0f0">
       
   369 <verbatim>
       
   370 %<nop>METASEARCH{type="topicmoved" web="%WEB%" topic="%TOPIC%" 
       
   371 title="This topic used to exist and was moved to: "}%
       
   372 </verbatim>
       
   373 </blockquote>
       
   374 
       
   375 ---++ How Rename/Move Works
       
   376 
       
   377 	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.
       
   378 		* User can omit one or more topics from the update list by unchecking them.
       
   379 		* =&lt;pre&gt;= and =&lt;verbatim&gt;= are honoured - no changes are made to text within these areas.
       
   380 	2. The topic is moved (if locks allow).
       
   381 	3. References are changed (locks and permissions permitting).
       
   382 	4. Any referring topics that can't be changed due to locks are listed - user can take note and change them at another time.
       
   383 
       
   384 ---+++ How Referring Topics Are Found
       
   385 
       
   386 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.
       
   387 
       
   388 Changed references are kept are as short as possible, ex: =topic= is used in preference to =web.topic=.
       
   389 
       
   390 ---+++ Effect of User Access Settings
       
   391 
       
   392 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.
       
   393 
       
   394 ---++ Special Considerations
       
   395 
       
   396 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: 
       
   397 	* 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.
       
   398 	* 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.
       
   399 
       
   400 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.
       
   401 
       
   402 #RenameLimitations
       
   403 ---++ Known Issues
       
   404 
       
   405 *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.
       
   406 
       
   407 The following shows some limitations of square bracket processing.
       
   408 
       
   409 <blockquote style="background-color:#f0f0f0">
       
   410 <verbatim>
       
   411 [[Old Topic]]  => [[NewTopic][Old Topic]]
       
   412 [[old topic]]  => [[NewTopic][old topic]]
       
   413 [[old t opic]] => not changed
       
   414 [[OldTopic]]	=> [[NewTopic]]
       
   415 </verbatim>
       
   416 </blockquote>
       
   417 
       
   418 -- Main.MikeMannix - 27 Dec 2001
       
   419 @
       
   420 
       
   421 
       
   422 1.16
       
   423 log
       
   424 @none
       
   425 @
       
   426 text
       
   427 @d1 1
       
   428 a1 1
       
   429 %META:TOPICINFO{author="MikeMannix" date="1009500480" format="1.0" version="1.16"}%
       
   430 d11 1
       
   431 a11 1
       
   432 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.
       
   433 d68 1
       
   434 a68 1
       
   435 	* 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.
       
   436 d70 1
       
   437 a70 1
       
   438 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. 
       
   439 @
       
   440 
       
   441 
       
   442 1.15
       
   443 log
       
   444 @none
       
   445 @
       
   446 text
       
   447 @d1 1
       
   448 a1 1
       
   449 %META:TOPICINFO{author="MikeMannix" date="1009457340" format="1.0" version="1.15"}%
       
   450 d7 2
       
   451 d11 1
       
   452 a11 1
       
   453 _Browser-based rename, move, and delete for individual topics_
       
   454 a14 2
       
   455 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.
       
   456 
       
   457 d32 1
       
   458 a32 1
       
   459 		* %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. 
       
   460 d70 1
       
   461 a70 1
       
   462 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.
       
   463 d75 1
       
   464 a75 1
       
   465 *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.
       
   466 d88 1
       
   467 a88 1
       
   468 -- Main.MikeMannix - 27 Dec 2001
       
   469 @
       
   470 
       
   471 
       
   472 1.14
       
   473 log
       
   474 @none
       
   475 @
       
   476 text
       
   477 @d1 1
       
   478 a1 1
       
   479 %META:TOPICINFO{author="PeterThoeny" date="1008578651" format="1.0" version="1.14"}%
       
   480 a6 2
       
   481 _Browser-based rename, move, and delete for individual topics_
       
   482 
       
   483 d9 1
       
   484 a9 1
       
   485 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.
       
   486 d13 7
       
   487 a19 5
       
   488 	1. *Click* on ==[More]== (bottom right of page) on the topic to be changed, then, in the new screen, on ==[Rename/move]==.
       
   489 	1. *Select* target web if other than the current web - chose =Trash= to [[#DeleteTopic][delete a topic]]
       
   490 	1. *Enter* the new topic name - default is current name <br />
       
   491 	  __NOTE:__ You will be warned if there are locks or if there is a name conflict.
       
   492 	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).
       
   493 d21 2
       
   494 a22 8
       
   495 		* If any of the referring pages are locked then they will be listed.
       
   496 		* You can correct these later by again pressing ==[Rename/Move]==.
       
   497 
       
   498 ---+++ Referring Topics
       
   499 
       
   500 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.
       
   501 
       
   502 Changed references are kept are as short as possible, ex: _topic_ is used in preference to _web.topic_.
       
   503 d25 1
       
   504 a25 1
       
   505 ---+++ About Deleting a Topic
       
   506 d27 1
       
   507 a27 1
       
   508 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.
       
   509 d29 1
       
   510 a29 1
       
   511 ---++ Clearing the Trash
       
   512 d31 2
       
   513 a32 1
       
   514 The =Trash= web should be be cleared periodically, by archiving the contents if required (recommended), then deleting the files from the =Trash= directory.
       
   515 d36 1
       
   516 a36 1
       
   517 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:
       
   518 d45 1
       
   519 a45 5
       
   520 ---++ Effect of Access Settings
       
   521 
       
   522 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.
       
   523 
       
   524 ---++ How Rename/move Works
       
   525 d48 1
       
   526 a48 1
       
   527 		* User can omit one or more topics from the update list.
       
   528 d52 19
       
   529 a70 1
       
   530 	4. Any referring topics that can't be changed due to locks are listed - user can change them at another time.
       
   531 d72 2
       
   532 a73 1
       
   533 ---++ Known Limitations
       
   534 d75 1
       
   535 a75 1
       
   536 *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.
       
   537 d88 1
       
   538 a88 1
       
   539 -- MikeMannix - 15 Sep 2001 <br />	
       
   540 @
       
   541 
       
   542 
       
   543 1.13
       
   544 log
       
   545 @none
       
   546 @
       
   547 text
       
   548 @d1 1
       
   549 a1 1
       
   550 %META:TOPICINFO{author="MikeMannix" date="1000788905" format="1.0" version="1.13"}%
       
   551 d52 1
       
   552 a52 1
       
   553 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.
       
   554 @
       
   555 
       
   556 
       
   557 1.12
       
   558 log
       
   559 @none
       
   560 @
       
   561 text
       
   562 @d1 1
       
   563 a1 1
       
   564 %META:TOPICINFO{author="MikeMannix" date="1000548911" format="1.0" version="1.12"}%
       
   565 d11 1
       
   566 a11 1
       
   567 Using browser controls while viewing a topic, you change its name, move it to another TWiki web, or delete it:
       
   568 d13 4
       
   569 a16 1
       
   570 	1. *Select* target web if other than the current web - chose ==Trash== to [[#DeleteTopic][delete a topic]]
       
   571 d18 5
       
   572 a22 5
       
   573 	  __NOTE:__ You will be warned if there are locks or if there is a name conflict
       
   574 	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)
       
   575 	1. *Click* on *Rename/Move* to rename/remove topic will be renamed and links to the topic updated as requested.
       
   576 		* If any of the referring pages are locked then they will be listed
       
   577 		* You can correct these later by again pressing Rename/Move
       
   578 d28 1
       
   579 a28 1
       
   580 Changed references are kept are as short as possible, i.e. _topic_ is used in preference to _web.topic_.
       
   581 d31 1
       
   582 a31 1
       
   583 ---+++ Deleting a Topic
       
   584 d35 1
       
   585 a35 1
       
   586 ---++++ Clearing the Trash
       
   587 d37 1
       
   588 a37 1
       
   589 __NOTE:__ The =Trash= web should be be cleared periodically, by archiving the contents if required (recommended), then deleting the files from the =Trash= directory.
       
   590 d50 1
       
   591 a50 1
       
   592 ---++ Impact of Topic Access Settings
       
   593 d56 6
       
   594 a61 6
       
   595 	* %<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.
       
   596 		* User chooses which topics will be altered
       
   597 	* =&lt;pre&gt;= and =&lt;verbatim&gt;= are honoured - no changes are made to text within these areas
       
   598 	* Topic is moved (if locks allow)
       
   599 	* References are changed (locks and permissions permitting)
       
   600 	* Any referring topics that can't be changed due to locks are listed - user can change them at another time.
       
   601 d78 1
       
   602 a78 1
       
   603 -- MikeMannix - 15 Sep 2001 <br />	
       
   604 @
       
   605 
       
   606 
       
   607 1.11
       
   608 log
       
   609 @none
       
   610 @
       
   611 text
       
   612 @d1 1
       
   613 a1 1
       
   614 %META:TOPICINFO{author="PeterThoeny" date="1000462013" format="1.0" version="1.11"}%
       
   615 a2 2
       
   616 %INCLUDE{"UtilTempDocNote"}%
       
   617 
       
   618 d11 1
       
   619 a11 1
       
   620 Select *Rename/move* when viewing a topic to change its name, move it to another TWiki web, or delete it:
       
   621 d23 1
       
   622 a23 1
       
   623 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.
       
   624 d75 1
       
   625 @
       
   626 
       
   627 
       
   628 1.10
       
   629 log
       
   630 @none
       
   631 @
       
   632 text
       
   633 @d1 1
       
   634 a1 1
       
   635 %META:TOPICINFO{author="MikeMannix" date="1000328894" format="1.0" version="1.10"}%
       
   636 d16 1
       
   637 a16 1
       
   638 	1. *Enter* the new topic name - default is current name <br>
       
   639 d51 1
       
   640 a51 1
       
   641 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.
       
   642 d55 1
       
   643 a55 1
       
   644 	* %<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]]
       
   645 d57 1
       
   646 a57 1
       
   647 	* &lt;PRE&gt; and &lt;VERBATIM&gt; are honoured - no changes are made to text within these areas
       
   648 @
       
   649 
       
   650 
       
   651 1.9
       
   652 log
       
   653 @none
       
   654 @
       
   655 text
       
   656 @d1 1
       
   657 a1 1
       
   658 %META:TOPICINFO{author="MikeMannix" date="1000278281" format="1.0" version="1.9"}%
       
   659 d44 2
       
   660 a45 1
       
   661 %<nop>METASEARCH{type="topicmoved" web="%WEB%" topic="%TOPIC%" title="This topic used to exist and was moved to: "}%
       
   662 @
       
   663 
       
   664 
       
   665 1.8
       
   666 log
       
   667 @none
       
   668 @
       
   669 text
       
   670 @d1 1
       
   671 a1 1
       
   672 %META:TOPICINFO{author="MikeMannix" date="999857661" format="1.0" version="1.8"}%
       
   673 d3 2
       
   674 @
       
   675 
       
   676 
       
   677 1.7
       
   678 log
       
   679 @none
       
   680 @
       
   681 text
       
   682 @d1 1
       
   683 a1 1
       
   684 %META:TOPICINFO{author="MikeMannix" date="999814735" format="1.0" version="1.7"}%
       
   685 d5 1
       
   686 a5 1
       
   687 ---## Managing Topics
       
   688 d9 1
       
   689 a9 1
       
   690 ---+++ Overview
       
   691 d21 1
       
   692 a21 1
       
   693 ---++++ Referring Topics
       
   694 d28 1
       
   695 a28 1
       
   696 ---++++ Deleting a Topic
       
   697 d32 1
       
   698 a32 1
       
   699 ---+++++ Clearing the Trash
       
   700 d36 1
       
   701 a36 1
       
   702 ---+++ Redirecting from an Old Topic
       
   703 d46 1
       
   704 a46 1
       
   705 ---+++ Impact of Topic Access Settings
       
   706 d50 1
       
   707 a50 1
       
   708 ---+++ How Rename/move Works
       
   709 d59 1
       
   710 a59 1
       
   711 ---+++ Known Limitations
       
   712 @
       
   713 
       
   714 
       
   715 1.6
       
   716 log
       
   717 @none
       
   718 @
       
   719 text
       
   720 @d1 1
       
   721 a1 1
       
   722 %META:TOPICINFO{author="MikeMannix" date="999329908" format="1.0" version="1.6"}%
       
   723 d7 1
       
   724 a7 1
       
   725 Select [Rename/move] when viewing a topic to change its name, delete it or move it
       
   726 d9 9
       
   727 a17 5
       
   728 	1 Select target Web if other than existing Web
       
   729 	2 Fill in new name - defaults to current name
       
   730 	3 You will be warned if there are locks or if there is a name clash
       
   731 	4 A list of _links_ to the topic will be listed, by default these links will be updated, click checkbox to prevent this
       
   732 	5 Press the Rename/Move button, topic will be renamed and links to the topic updated as requested.
       
   733 d21 1
       
   734 a21 1
       
   735 ---+++ Referring Topics
       
   736 d27 2
       
   737 a28 1
       
   738 ---+++ Deleting a Topic
       
   739 d30 1
       
   740 a30 1
       
   741 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.
       
   742 d32 3
       
   743 a34 1
       
   744 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.
       
   745 d38 1
       
   746 a38 1
       
   747 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{...}%.
       
   748 d40 2
       
   749 a41 1
       
   750 <pre>
       
   751 d43 2
       
   752 a44 1
       
   753 </pre>
       
   754 d46 1
       
   755 a46 1
       
   756 ---+++ Permissions
       
   757 d48 1
       
   758 a48 1
       
   759 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.
       
   760 d50 1
       
   761 a50 1
       
   762 ---+++ Procedure
       
   763 d52 1
       
   764 a52 1
       
   765 	* %<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]]
       
   766 d54 1
       
   767 a54 1
       
   768 	* &lt;PRE&gt; and &lt;verbatim&gt; are honoured - no changes to text within these areas
       
   769 d56 2
       
   770 a57 2
       
   771 	* References are changed (locks and permissions allowing)
       
   772 	* Any refering topics that can't be changed due to locks are listed - user can try getting these references changed at any time.
       
   773 d61 1
       
   774 a61 1
       
   775 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.
       
   776 d72 2
       
   777 a73 2
       
   778 </blockquote>
       
   779 
       
   780 @
       
   781 
       
   782 
       
   783 1.5
       
   784 log
       
   785 @none
       
   786 @
       
   787 text
       
   788 @d1 1
       
   789 a1 1
       
   790 %META:TOPICINFO{author="MikeMannix" date="999297399" format="1.0" version="1.5"}%
       
   791 d5 1
       
   792 a5 1
       
   793 ---## Modifying Topics
       
   794 d7 1
       
   795 a7 1
       
   796 Select rename/move when viewing a topic to change its name, delete it or move it
       
   797 d17 1
       
   798 a17 1
       
   799 ---+++ Referring topics
       
   800 d23 1
       
   801 a23 1
       
   802 ---+++ Deleting a topic
       
   803 d29 1
       
   804 a29 1
       
   805 ---+++ Redirection from old topic
       
   806 d41 1
       
   807 a41 1
       
   808 ---+++ Approach
       
   809 d50 1
       
   810 a50 1
       
   811 ---+++ Limitations
       
   812 d56 1
       
   813 d63 3
       
   814 a65 4
       
   815 
       
   816 
       
   817 
       
   818 
       
   819 @
       
   820 
       
   821 
       
   822 1.4
       
   823 log
       
   824 @none
       
   825 @
       
   826 text
       
   827 @d1 1
       
   828 a1 1
       
   829 %META:TOPICINFO{author="MikeMannix" date="999178132" format="1.0" version="1.4"}%
       
   830 d5 1
       
   831 a5 1
       
   832 ---## Rename/move/delete a topic
       
   833 @
       
   834 
       
   835 
       
   836 1.3
       
   837 log
       
   838 @none
       
   839 @
       
   840 text
       
   841 @d1 1
       
   842 a1 1
       
   843 %META:TOPICINFO{author="JohnTalintyre" date="999105045" format="1.0" version="1.3"}%
       
   844 d3 2
       
   845 d7 1
       
   846 a7 1
       
   847 Select rename/move when viewing a topic to change its name, [[DeleteTopic][Delete it]] or [[MoveTopic][Move it]]
       
   848 @
       
   849 
       
   850 
       
   851 1.2
       
   852 log
       
   853 @none
       
   854 @
       
   855 text
       
   856 @d1 1
       
   857 a1 1
       
   858 %META:TOPICINFO{author="JohnTalintyre" date="997289816" format="1.0beta2" version="1.2"}%
       
   859 d5 1
       
   860 a5 1
       
   861 Select rename/move when viewing a topic to change its name, do DeleteTopic or MoveTopic.
       
   862 d17 1
       
   863 a17 1
       
   864 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.
       
   865 d23 1
       
   866 a23 1
       
   867 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.
       
   868 d32 1
       
   869 a32 1
       
   870 <h2>%METASEARCH{type="topicmoved" web="%WEB%" topic="%TOPIC%" title="This topic used to exist and was moved to: "}%</h2>
       
   871 d37 1
       
   872 a37 1
       
   873 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.
       
   874 d41 6
       
   875 a46 4
       
   876 	* %<nop>SEARCH% is used with a special template to show the text would be changed
       
   877 		* User chooses which topics
       
   878 	* &lt;PRE&gt; and &lt;verbatim&gt; are honoured
       
   879 	* FIXME - more needed
       
   880 d50 1
       
   881 a50 1
       
   882 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.
       
   883 @
       
   884 
       
   885 
       
   886 1.1
       
   887 log
       
   888 @none
       
   889 @
       
   890 text
       
   891 @d1 1
       
   892 a1 1
       
   893 %META:TOPICINFO{author="JohnTalintyre" date="997200531" format="1.0beta2" version="1.1"}%
       
   894 d3 1
       
   895 a3 1
       
   896 	+ Rename/move/delete a topic
       
   897 d15 1
       
   898 a15 1
       
   899 	++ Referring topics
       
   900 d21 1
       
   901 a21 1
       
   902 	++ Deleting a topic
       
   903 d27 1
       
   904 a27 1
       
   905 	++ Redirection from old topic
       
   906 d35 1
       
   907 a35 1
       
   908 	++ Permissions
       
   909 d38 22
       
   910 @