none
[openafs-wiki.git] / TWiki / ManagingTopics.mdwn
1 <div>
2   <ul>
3     <li><a href="#Managing Topics"> Managing Topics</a><ul>
4         <li><a href="#Overview"> Overview</a><ul>
5             <li><a href="#Referring Topics"> Referring Topics</a></li>
6             <li><a href="#Deleting a Topic"> Deleting a Topic</a><ul>
7                 <li><a href="#Clearing the Trash"> Clearing the Trash</a></li>
8               </ul>
9             </li>
10           </ul>
11         </li>
12         <li><a href="#Redirecting from an Old Topic"> Redirecting from an Old Topic</a></li>
13         <li><a href="#Impact of Topic Access Settings"> Impact of Topic Access Settings</a></li>
14         <li><a href="#How Rename/move Works"> How Rename/move Works</a></li>
15         <li><a href="#Known Limitations"> Known Limitations</a></li>
16       </ul>
17     </li>
18   </ul>
19 </div>
20
21 # <a name="Managing Topics"></a> Managing Topics
22
23 _Browser-based rename, move, and delete for individual topics_
24
25 ## <a name="Overview"></a> Overview
26
27 Select **Rename/move** when viewing a topic to change its name, move it to another TWiki web, or delete it:
28
29 1. **Select** target web if other than the current web - chose <code>**Trash**</code> to [[delete a topic|Main/WebHome#DeleteTopic]]
30 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
31 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)
32 4. **Click** on **Rename/Move** to rename/remove topic will be renamed and links to the topic updated as requested.
33   - If any of the referring pages are locked then they will be listed
34   - You can correct these later by again pressing Rename/Move
35
36 ### <a name="Referring Topics"></a> Referring Topics
37
38 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.
39
40 Changed references are kept are as short as possible, i.e. _topic_ is used in preference to _web.topic_.
41
42 <a name="DeleteTopic"></a>
43
44 ### <a name="Deleting a Topic"></a> Deleting a Topic
45
46 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.
47
48 #### <a name="Clearing the Trash"></a> Clearing the Trash
49
50 **_NOTE:_** The `Trash` web should be be cleared periodically, by archiving the contents if required (recommended), then deleting the files from the `Trash` directory.
51
52 ## <a name="Redirecting from an Old Topic"></a> Redirecting from an Old Topic
53
54 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:
55
56 > %<nop>METASEARCH{type="topicmoved" web="%WEB%" topic="%TOPIC%" title="This topic used to exist and was moved to: "}%
57
58 ## <a name="Impact of Topic Access Settings"></a> Impact of Topic Access Settings
59
60 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.
61
62 ## <a name="How Rename/move Works"></a> How Rename/move Works
63
64 - %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]]
65   - User chooses which topics will be altered
66 - &lt;PRE&gt; and &lt;VERBATIM&gt; are honoured - no changes are made to text within these areas
67 - Topic is moved (if locks allow)
68 - References are changed (locks and permissions permitting)
69 - Any referring topics that can't be changed due to locks are listed - user can change them at another time.
70
71 ## <a name="Known Limitations"></a> Known Limitations
72
73 **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.
74
75 The following shows some limitations of square bracket processing.
76
77 > [[Old Topic]]  => [[NewTopic][Old Topic]]
78 >     [[old topic]]  => [[NewTopic][old topic]]
79 >     [[old t opic]] => not changed
80 >     [[OldTopic]]   => [[NewTopic]]