none
[openafs-wiki.git] / TWiki / ManagingTopics.mdwn
index 27d4822..db78624 100644 (file)
@@ -1,55 +1,80 @@
-## <a name="Rename/move/delete a topic"></a> Rename/move/delete a topic
-
-Select rename/move when viewing a topic to change its name, do [[DeleteTopic]] or [[MoveTopic]].
-
-1. Select target Web if other than existing Web
-2. Fill in new name - defaults to current name
-3. You will be warned if there are locks or if there is a name clash
-4. A list of _links_ to the topic will be listed, by default these links will be updated, click checkbox to prevent this
-5. Press the Rename/Move button, topic will be renamed and links to the topic updated as requested.
+<div>
+  <ul>
+    <li><a href="#Managing Topics"> Managing Topics</a><ul>
+        <li><a href="#Overview"> Overview</a><ul>
+            <li><a href="#Referring Topics"> Referring Topics</a></li>
+            <li><a href="#Deleting a Topic"> Deleting a Topic</a><ul>
+                <li><a href="#Clearing the Trash"> Clearing the Trash</a></li>
+              </ul>
+            </li>
+          </ul>
+        </li>
+        <li><a href="#Redirecting from an Old Topic"> Redirecting from an Old Topic</a></li>
+        <li><a href="#Impact of Topic Access Settings"> Impact of Topic 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>
+      </ul>
+    </li>
+  </ul>
+</div>
+
+## <a name="Managing Topics"></a> Managing Topics
+
+_Browser-based rename, move, and delete for individual topics_
+
+### <a name="Overview"></a> Overview
+
+Select **Rename/move** when viewing a topic to change its name, move it to another TWiki web, or delete it:
+
+1. **Select** target web if other than the current web - chose <code>**Trash**</code> to [[delete a topic|Main/WebHome#DeleteTopic]]
+2. **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
+3. **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)
+4. **Click** on **Rename/Move** to rename/remove 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 Rename/Move
 
-### <a name="Referring topics"></a> Referring topics
+#### <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.
+Referring topics are found using the the %SEARCH% variable, see the template <code>**searchrenameview.tmpl**</code>. 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, i.e. _topic_ is used in preference to _web.topic_.
 
-### <a name="Deleting a topic"></a> Deleting a topic
+<a name="DeleteTopic"></a>
 
-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.
+#### <a name="Deleting a Topic"></a> Deleting a Topic
 
-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.
+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.
 
-### <a name="Redirection from old topic"></a> Redirection from old topic
+##### <a name="Clearing the Trash"></a> Clearing the Trash
 
-Something like the following can be put in [[WebTopicViewTemplate]] and [[WebTopicNonWikiTemplate]] to show if a topic has moved. It does this by searching for the tag %META:TOPICMOVED\{...\}%.
+**_NOTE:_** The `Trash` web should be be cleared periodically, by archiving the contents if required (recommended), then deleting the files from the `Trash` directory.
 
-## This topic used to exist and was moved to:
+### <a name="Redirecting from an Old Topic"></a> Redirecting from an Old Topic
 
-# TWiki Installation Error
+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:
 
-Incorrect format of searchmeta template (missing sections? There should be 4 %SPLIT% tags)
+> %<nop>METASEARCH{type="topicmoved" web="%WEB%" topic="%TOPIC%" title="This topic used to exist and was moved to: "}%
 
-### <a name="Permissions"></a> Permissions
+### <a name="Impact of Topic Access Settings"></a> Impact of Topic Access Settings
 
-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.
+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.
 
-### <a name="Approach"></a> Approach
+### <a name="How Rename/move Works"></a> How Rename/move Works
 
-- %SEARCH% is used with a special template to show the text would be changed
-  - User chooses which topics
-- &lt;PRE&gt; and &lt;verbatim&gt; are honoured
-- FIXME - more needed
+- %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 [[MetaData|Main/TWikiDocumentation#Meta_Data_Definition]]
+  - User chooses which topics will be altered
+- &lt;PRE&gt; and &lt;VERBATIM&gt; are honoured - no changes are made to text within these areas
+- Topic is moved (if locks allow)
+- References are changed (locks and permissions permitting)
+- Any referring topics that can't be changed due to locks are listed - user can change them at another time.
 
-### <a name="Limitations"></a> Limitations
+### <a name="Known Limitations"></a> Known Limitations
 
-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, %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.
+**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.
 
 The following shows some limitations of square bracket processing.
 
-    [[Old Topic]]  => [[NewTopic][Old Topic]]
-    [[old topic]]  => [[NewTopic][old topic]]
-    [[old t opic]] => not changed
-    [[OldTopic]]   => [[NewTopic]]
+> [[Old Topic]]  => [[NewTopic][Old Topic]]
+>     [[old topic]]  => [[NewTopic][old topic]]
+>     [[old t opic]] => not changed
+>     [[OldTopic]]   => [[NewTopic]]