Note: Included topic UtilTempDocNote? does not exist yet

Managing Topics

Browser-based rename, move, and delete for individual topics

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 Trash to delete a topic
2. Enter the new topic name - default is current name
   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

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, i.e. topic is used in preference to web.topic.

Deleting a Topic

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.

Clearing the Trash

NOTE: The Trash web should be be cleared periodically, by archiving the contents if required (recommended), then deleting the files from the Trash directory.

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:

%<nop>METASEARCH{type="topicmoved" web="%WEB%" topic="%TOPIC%" 
title="This topic used to exist and was moved to: "}%

Impact of Topic Access Settings

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.

How Rename/move Works

• %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.
  • User chooses which topics will be altered
• <pre> and <verbatim> 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.

Known Limitations

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]]