data/TWiki/ManagingTopics.txt
changeset 0 414e01d06fd5
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/data/TWiki/ManagingTopics.txt	Sat Jan 26 15:50:53 2008 +0100
     1.3 @@ -0,0 +1,89 @@
     1.4 +%META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="22"}%
     1.5 +%META:TOPICPARENT{name="WebHome"}%
     1.6 +%STARTINCLUDE%
     1.7 +---+ Managing Topics
     1.8 +
     1.9 +_Browser-based rename, move, and delete for individual topics_
    1.10 +
    1.11 +%TOC%
    1.12 +
    1.13 +---++ Overview
    1.14 +
    1.15 +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.16 +
    1.17 +---++ How to Rename/Move/Delete a Topic
    1.18 +
    1.19 +   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.20 +   1. *Move/Delete:* Select the target web if other than the current web - choose =Trash= to [[#DeleteTopic][delete a topic]].
    1.21 +   1. *Rename:* Enter the new topic name - default is current name <br />
    1.22 +     %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.23 +   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.24 +   1. *Click* on ==[Rename/Move]==: the topic will be renamed and links to the topic updated as requested.
    1.25 +      * If any of the referring pages are locked then they will be listed: you can correct these later by again pressing ==[Rename/Move]==.
    1.26 +      * %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.27 +
    1.28 +#DeleteTopic
    1.29 +---++ Deleted Topics: How to Clear the Trash
    1.30 +
    1.31 +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.32 +
    1.33 +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.34 +
    1.35 +   * %X% This can only be done from on the server, not through the browser. 
    1.36 +      * %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.37 +
    1.38 +---++ Redirecting from an Old Topic
    1.39 +
    1.40 +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.41 +
    1.42 +<blockquote>
    1.43 +<verbatim>
    1.44 +%<nop>METASEARCH{type="topicmoved" web="%WEB%" topic="%TOPIC%" 
    1.45 +title="This topic used to exist and was moved to: "}%
    1.46 +</verbatim>
    1.47 +</blockquote>
    1.48 +
    1.49 +---++ How Rename/Move Works
    1.50 +
    1.51 +   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.52 +      * User can omit one or more topics from the update list by unchecking them.
    1.53 +      * =&lt;pre&gt;= and =&lt;verbatim&gt;= are honoured - no changes are made to text within these areas.
    1.54 +   2. The topic is moved (if locks allow).
    1.55 +   3. References are changed (locks and permissions permitting).
    1.56 +   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.57 +
    1.58 +---+++ How Referring Topics Are Found
    1.59 +
    1.60 +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.61 +
    1.62 +Changed references are kept are as short as possible, ex: =topic= is used in preference to =web.topic=.
    1.63 +
    1.64 +---+++ Effect of User Access Settings
    1.65 +
    1.66 +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.67 +
    1.68 +---++ Special Considerations
    1.69 +
    1.70 +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.71 +   * 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.72 +   * 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.73 +
    1.74 +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.75 +
    1.76 +#RenameLimitations
    1.77 +---++ Known Issues
    1.78 +
    1.79 +*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.80 +
    1.81 +The following shows some limitations of square bracket processing.
    1.82 +
    1.83 +<blockquote>
    1.84 +<verbatim>
    1.85 +[[Old Topic]]  => [[NewTopic][Old Topic]]
    1.86 +[[old topic]]  => [[NewTopic][old topic]]
    1.87 +[[old t opic]] => not changed
    1.88 +[[OldTopic]]   => [[NewTopic]]
    1.89 +</verbatim>
    1.90 +</blockquote>
    1.91 +
    1.92 +__Related Topics:__ UserDocumentationCategory, AdminDocumentationCategory