Managing Topics

Referring Topics

Deleting a Topic

Redirecting from an Old Topic

Procedure

Known Limitations

Modifying Topics

• %SEARCH% is used with a special template to show text in topics that requires alteration to point to the new topic name. This includes relavent meta data
  • User chooses which topics will be altered
• <PRE> and <verbatim> are honoured - no changes to text within these areas
• Topic is moved (if locks allow)
• References are changed (locks and permissions allowing)
• Any refering topics that can't be changed due to locks are listed - user can try getting these references changed at any time.

Rename/move/delete a topic

Referring topics

Deleting a topic

Redirection from old topic

Permissions

Approach

• %SEARCH% is used with a special template to show the text would be changed
  • User chooses which topics
• <PRE> and <verbatim> are honoured
• FIXME - more needed

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.

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

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.
   • 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

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.

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.

++ Redirection from old topic

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{...}%.

This topic used to exist and was moved to: 

++ Permissions

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.