27d4822a355c94adb0a922efbccb2192da9283ae
[openafs-wiki.git] / TWiki / ManagingTopics.mdwn
1 ## <a name="Rename/move/delete a topic"></a> Rename/move/delete a topic
2
3 Select rename/move when viewing a topic to change its name, do [[DeleteTopic]] or [[MoveTopic]].
4
5 1. Select target Web if other than existing Web
6 2. Fill in new name - defaults to current name
7 3. You will be warned if there are locks or if there is a name clash
8 4. A list of _links_ to the topic will be listed, by default these links will be updated, click checkbox to prevent this
9 5. Press the Rename/Move button, topic will be renamed and links to the topic updated as requested.
10   - If any of the referring pages are locked then they will be listed
11   - You can correct these later by again pressing Rename/Move
12
13 ### <a name="Referring topics"></a> Referring topics
14
15 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.
16
17 Changed references are kept are as short as possible, i.e. _topic_ is used in preference to _web.topic_.
18
19 ### <a name="Deleting a topic"></a> Deleting a topic
20
21 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.
22
23 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.
24
25 ### <a name="Redirection from old topic"></a> Redirection from old topic
26
27 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\{...\}%.
28
29 ## This topic used to exist and was moved to:
30
31 # TWiki Installation Error
32
33 Incorrect format of searchmeta template (missing sections? There should be 4 %SPLIT% tags)
34
35 ### <a name="Permissions"></a> Permissions
36
37 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.
38
39 ### <a name="Approach"></a> Approach
40
41 - %SEARCH% is used with a special template to show the text would be changed
42   - User chooses which topics
43 - &lt;PRE&gt; and &lt;verbatim&gt; are honoured
44 - FIXME - more needed
45
46 ### <a name="Limitations"></a> Limitations
47
48 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.
49
50 The following shows some limitations of square bracket processing.
51
52     [[Old Topic]]  => [[NewTopic][Old Topic]]
53     [[old topic]]  => [[NewTopic][old topic]]
54     [[old t opic]] => not changed
55     [[OldTopic]]   => [[NewTopic]]