summaryrefslogtreecommitdiff
path: root/TWiki/ManagingTopics.mdwn
diff options
context:
space:
mode:
Diffstat (limited to 'TWiki/ManagingTopics.mdwn')
-rw-r--r--TWiki/ManagingTopics.mdwn68
1 files changed, 68 insertions, 0 deletions
diff --git a/TWiki/ManagingTopics.mdwn b/TWiki/ManagingTopics.mdwn
new file mode 100644
index 00000000..dddab2ac
--- /dev/null
+++ b/TWiki/ManagingTopics.mdwn
@@ -0,0 +1,68 @@
+%TOC% %STARTINCLUDE%
+
+# <a name="Managing_Topics"> Managing Topics </a>
+
+_Browser-based rename, move, and delete for individual topics_
+
+## <a name="Overview"> Overview </a>
+
+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.
+
+## <a name="How_to_Rename_Move_Delete_a_Topi"> How to Rename/Move/Delete a Topic </a>
+
+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
+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>.
+
+### <a name="Referring_Topics"> Referring Topics </a>
+
+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_.
+
+<a name="DeleteTopic"></a>
+
+### <a name="About_Deleting_a_Topic"> About Deleting a Topic </a>
+
+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="Clearing_the_Trash"> Clearing the Trash </a>
+
+The `Trash` web should be be cleared periodically, by archiving the contents if required (recommended), then deleting the files from the `Trash` directory.
+
+## <a name="Redirecting_from_an_Old_Topic"> Redirecting from an Old Topic </a>
+
+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 %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"> Effect of Access Settings </a>
+
+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.
+
+## <a name="How_Rename_move_Works"> How Rename/move Works </a>
+
+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.
+ * `<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.
+
+## <a name="Known_Limitations"> Known Limitations </a>
+
+**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]]
+
+-- [[MikeMannix]] - 15 Sep 2001 <br />