none
[openafs-wiki.git] / TWiki / ManagingTopics.mdwn
index 7a33bc1..656c081 100644 (file)
@@ -2,16 +2,16 @@
   <ul>
     <li><a href="#Managing Topics"> Managing Topics</a><ul>
         <li><a href="#Overview"> Overview</a></li>
-        <li><a href="#How to Rename/Move/Delete a Topi"> How to Rename/Move/Delete a Topic</a><ul>
-            <li><a href="#Referring Topics"> Referring Topics</a></li>
-            <li><a href="#About Deleting a Topic"> About Deleting a Topic</a></li>
+        <li><a href="#How to Rename/Move/Delete a Topi"> How to Rename/Move/Delete a Topic</a></li>
+        <li><a href="#Deleted Topics: How to Clear the"> Deleted Topics: How to Clear the Trash</a></li>
+        <li><a href="#Redirecting from an Old Topic"> Redirecting from an Old Topic</a></li>
+        <li><a href="#How Rename/Move Works"> How Rename/Move Works</a><ul>
+            <li><a href="#How Referring Topics Are Found"> How Referring Topics Are Found</a></li>
+            <li><a href="#Effect of User Access Settings"> Effect of User Access Settings</a></li>
           </ul>
         </li>
-        <li><a href="#Clearing the Trash"> Clearing the Trash</a></li>
-        <li><a href="#Redirecting from an Old Topic"> Redirecting from an Old Topic</a></li>
-        <li><a href="#Effect of Access Settings"> Effect of Access Settings</a></li>
-        <li><a href="#How Rename/move Works"> How Rename/move Works</a></li>
-        <li><a href="#Known Limitations"> Known Limitations</a></li>
+        <li><a href="#Special Considerations"> Special Considerations</a></li>
+        <li><a href="#Known Issues"> Known Issues</a></li>
       </ul>
     </li>
   </ul>
 
 # <a name="Managing Topics"></a> Managing Topics
 
-_Browser-based rename, move, and delete for individual topics_
-
 ## <a name="Overview"></a> Overview
 
-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.
+_Browser-based rename, move, and delete for individual topics_
 
 ## <a name="How to Rename/Move/Delete a Topi"></a> How to Rename/Move/Delete a Topic
 
-1. **Click** on <code>**[More]**</code> (bottom right of page) on the topic to be changed, then, in the new screen, on <code>**[Rename/move]**</code>.
-2. **Select** target web if other than the current web - chose `Trash` to [[delete a topic|Main/WebHome#DeleteTopic]]
-3. **Enter** the new topic name - default is current name <br />**_NOTE:_** You will be warned if there are locks or if there is a name conflict.
-4. **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).
-5. **Click** on <code>**[Rename/Move]**</code>: the topic will be renamed and links to the topic updated as requested.
-  - If any of the referring pages are locked then they will be listed.
-  - You can correct these later by again pressing <code>**[Rename/Move]**</code>.
+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.
 
-### <a name="Referring Topics"></a> Referring Topics
-
-Referring topics are found using the the %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 %SEARCH% is used, Webs marked in [[WebPreferences]] as NOSEARCHALL will not show up in the search for refernces to the _topic_ being changed.
-
-Changed references are kept are as short as possible, ex: _topic_ is used in preference to _web.topic_.
+1. **Click** on <code>**[More]**</code> (bottom right of page) on the topic to be changed, then, in the new screen, on <code>**[Rename/move]**</code>. You can now rename and/or move/delete in one operation:
+2. **Move/Delete:** Select the target web if other than the current web - choose `Trash` to [[delete a topic|Main/WebHome#DeleteTopic]].
+3. **Rename:** Enter the new topic name - default is current name <br /> %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.
+4. **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).
+5. **Click** on <code>**[Rename/Move]**</code>: the topic will be renamed and links to the topic updated as requested.
+  - If any of the referring pages are locked then they will be listed: you can correct these later by again pressing <code>**[Rename/Move]**</code>.
+  - %H% There is a **_Put back_** feature that allows you to undo a <code>**Rename/Move/Delete**</code> - 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_.
 
 <a name="DeleteTopic"></a>
 
-### <a name="About Deleting a Topic"></a> About Deleting a Topic
+## <a name="Deleted Topics: How to Clear the"></a> Deleted Topics: How to Clear the Trash
 
-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.
+Deleted topics are moved to a special <code>**Trash**</code> 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.
 
-## <a name="Clearing the Trash"></a> Clearing the Trash
+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.
 
-The `Trash` web should be be cleared periodically, by archiving the contents if required (recommended), then deleting the files from the `Trash` directory.
+- %X% This can only be done from on the server, not through the browser.
+  - %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.
 
 ## <a name="Redirecting from an Old Topic"></a> Redirecting from an Old Topic
 
-You can use [[TWikiMetaData]] to place a command in [[WebTopicViewTemplate]] and [[WebTopicNonWikiTemplate]] that will show if a topic has moved by searching for the tag %META:TOPICMOVED\{...\}%. Customize something like this:
+You can use [[TWikiMetaData]] to place a command in the [[WebTopicViewTemplate]] and [[WebTopicNonWikiTemplate]] that will indicate that a topic has been moved by searching for the tag %META:TOPICMOVED\{...\}%. Customize something like this:
 
 > %<nop>METASEARCH{type="topicmoved" web="%WEB%" topic="%TOPIC%"
 >     title="This topic used to exist and was moved to: "}%
 
-## <a name="Effect of Access Settings"></a> Effect of Access Settings
-
-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.
-
-## <a name="How Rename/move Works"></a> How Rename/move Works
+## <a name="How Rename/Move Works"></a> How Rename/Move Works
 
 1. %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.
-  - User can omit one or more topics from the update list.
+  - User can omit one or more topics from the update list by unchecking them.
   - `<pre>` and `<verbatim>` are honoured - no changes are made to text within these areas.
 2. The topic is moved (if locks allow).
 3. References are changed (locks and permissions permitting).
-4. Any referring topics that can't be changed due to locks are listed - user can change them at another time.
+4. Any referring topics that can't be changed due to locks are listed - user can take note and change them at another time.
+
+### <a name="How Referring Topics Are Found"></a> How Referring Topics Are Found
+
+Referring topics are found using the %SEARCH% variable - see the template <code>**searchrenameview.tmpl**</code>. First, matching topics in the current web are listed - matches are to <code>**topic**</code>. Next, all webs (including the current one) are listed that match <code>**web.topic**</code>. Because %SEARCH% is used, webs marked in [[WebPreferences]] as `NOSEARCHALL` will not show up in the search for references to the `topic` being changed.
+
+Changed references are kept are as short as possible, ex: `topic` is used in preference to `web.topic`.
+
+### <a name="Effect of User Access Settings"></a> Effect of User Access Settings
+
+User permissions affect the Rename function in various ways. To rename a topic, you need both <code>**ALLOWTOPICCHANGE**</code> and <code>**ALLOWTOPICRENAME**</code> permission for that topic. To alter referring topics, you need change permission. See [[TWikiAccessControl]] for information on setting up access permissions.
+
+## <a name="Special Considerations"></a> Special Considerations
+
+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:
+
+- 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]].
+- Due to [[current limitations|Main/WebHome#RenameLimitations]], 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.
+
+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.
+
+<a name="RenameLimitations"></a>
 
-## <a name="Known Limitations"></a> Known Limitations
+## <a name="Known Issues"></a> Known Issues
 
-**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, %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.
+**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, %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.
 
 The following shows some limitations of square bracket processing.
 
@@ -82,4 +94,4 @@ The following shows some limitations of square bracket processing.
 >     [[old t opic]] => not changed
 >     [[OldTopic]]   => [[NewTopic]]
 
--- [[MikeMannix]] - 15 Sep 2001 <br />
+-- [[MikeMannix]] - 27 Dec 2001