none
[openafs-wiki.git] / TWiki / ManagingWebs.mdwn
1 <div>
2   <ul>
3     <li><a href="#Managing Webs"> Managing Webs</a><ul>
4         <li><a href="#Overview"> Overview</a></li>
5         <li><a href="#Choose Web Template"> Choose Web Template</a></li>
6         <li><a href="#Adding a New Web"> Adding a New Web</a></li>
7         <li><a href="#Renaming or Deleting a Web"> Renaming or Deleting a Web</a><ul>
8             <li><a href="#Renaming the MAINWEB"> Renaming the MAINWEB</a></li>
9           </ul>
10         </li>
11       </ul>
12     </li>
13   </ul>
14 </div>
15
16 # <a name="Managing Webs"></a> Managing Webs
17
18 _Adding webs is a web based operation; renaming and deleting webs are manual operations done directly on the server_
19
20 ## <a name="Overview"></a> Overview
21
22 A [[TWikiSite]] is divided into webs; each one represents one subject, one area of collaboration. Administrators can add/rename/delete webs.
23
24 <a name="WebTemplate"></a>
25
26 ## <a name="Choose Web Template"></a> Choose Web Template
27
28 There are two methods used to create a new web. First you can use a specially designed [[TemplateWeb]]. This is an invisible web that begins with an underscore "\_" character. All topics in the \_default template web will be copied into your new web.
29
30 The second method is to use an existing web as a template web. This may be useful if you already have a web that you like to use as a starting point. Only topics that have names beginning with **Web...** (like "WebHome", "WebNotify", etc.) are copied.
31
32 In either case you will want to be sure to verify that your new web has all the custom modifications that you desire.
33
34 <a name="CreateNewWeb"></a>
35
36 ## <a name="Adding a New Web"></a> Adding a New Web
37
38 <form action="http://www.dementia.org/twiki//manage/%WEB%/%TOPIC%" method="post" name="admin"> Create a new web by filling out this form. <strong><em>Note:</em></strong> It is not recommended to create a new web for each little project. You can organize content within a web using [[Main/TWikiForms]] and [[Main/FormattedSearch]]. Cross-linking topics and search is easier if there are only a few larger webs. <table border="1" cellpadding="0" cellspacing="0">
39     <tr>
40       <th align="right" bgcolor="#99CCCC"><strong> Name of new web: </strong></th>
41       <td><input name="newweb" size="16" type="text" value="" /></td>
42       <td> Enter a short name of up to 10 characters. The name must start with an upper case letters, followed by optional upper or lower case letters or numbers </td>
43     </tr>
44     <tr>
45       <th align="right" bgcolor="#99CCCC"><strong> Based on web: </strong></th>
46       <td><select name="baseweb"> </select></td>
47       <td> Select a [[Main/TemplateWeb]]</td>
48     </tr>
49     <tr>
50       <th align="right" bgcolor="#99CCCC"><strong> Web color: </strong></th>
51       <td><input name="webbgcolor" size="16" type="text" value="#D0D0D0" /></td>
52       <td> Enter a [[Main/StandardColors]] code for the web </td>
53     </tr>
54     <tr>
55       <th align="right" bgcolor="#99CCCC"><strong> Description:<br />  <br />   </strong></th>
56       <td colspan="2"><input name="sitemapwhat" size="60" type="text" value="" /><br /> Enter a short description of the web. Write <code>Web.TopicName</code> instead of just <code>TopicName</code> if you include links. This will list the web in the [[TWiki/SiteMap]] (leave field empty if you prefer not to update the directory.) </td>
57     </tr>
58     <tr>
59       <th align="right" bgcolor="#99CCCC"><strong> Use to...<br />   </strong></th>
60       <td colspan="2"><input name="sitemapuseto" size="60" type="text" value="...collaborate on" /><br /> Continue the sentence describing the intended use. This is also for the [[TWiki/SiteMap]]</td>
61     </tr>
62     <tr>
63       <th align="right" bgcolor="#99CCCC"><strong> Exclude web from "search all": </strong></th>
64       <td><input checked name="nosearchall" type="radio" value="" /> No   <input name="nosearchall" type="radio" value="on" /> Yes </td>
65       <td> Specify if you want to exclude the web from a "search all webs" search. Note that the [[TWiki/SiteMap]] will not list the web if you select Yes. </td>
66     </tr>
67     <tr>
68       <td>   </td>
69       <td colspan="2"><input type="submit" value="Create new web" /></td>
70     </tr>
71   </table><input name="newtopic" type="hidden" value="" /> <input name="action" type="hidden" value="createweb" /></form>
72
73 **_Notes:_**
74
75 - Attachments will NOT get copied over along with their topics
76 - The manage script while creating the new web will update the following variables in the [[WebPreferences]]: `WEBBGCOLOR`, `SITEMAPLIST`, `SITEMAPWHAT`, `SITEMAPUSETO` and `NOSEARCHALL`. These variables are used to dynamically generate the [[SiteMap]]
77 - This script does not edit the [[TWiki.TWikiPreferences|TWiki/TWikiPreferences]] file to update the `WIKIWEBLIST`. This must be done by hand
78 - As of TWiki Release 01 Sep 2004, a web name can be a [[WikiWord]]. Prior to that it could be only `UPPER` or `UPPERlower`. A side effect of this is that if you do use a wiki name, `%WEB%` must be written as `<nop>%WEB%` or else it will try to link to a non-existing topic of that name
79
80 ## <a name="Renaming or Deleting a Web"></a> Renaming or Deleting a Web
81
82 Renaming or deleting a web requires direct access to the installation files on the host server. There are currently no browser-based equivalents of the Rename/move/delete topic tools for working with webs.
83
84 ### <a name="Renaming the MAINWEB"></a> Renaming the MAINWEB
85
86 If you plan to rename the Main web, remember that TWiki stores user and group topics in `%MAINWEB%`, default named `Main`. That means, every [[WikiName]] signature - `Main.SomeUserName` - points to it and would need updating (unless the variable, `%MAINWEB%.SomeUserName`, is used throughout).
87
88 1. Prepare your site: Search each web for links to the target web, searching topic text for `Oldwebname.`, including the dot so you'll find references like `Oldwebname.SomeTopic`
89   - Make changes as required, to `Newwebname.SomeTopic` or better yet, to `%MAINWEB%.SomeTopic`
90 2. Edit the [[TWikiPreferences]] topic: Rename or delete the web from the `WIKIWEBLIST` variable
91 3. Login to the %WIKITOOLNAME% server, via Telnet or FTP
92 4. Go to `twiki/data` and rename or remove the web directory
93 5. Go to `twiki/templates` and rename or remove the web directory if present
94   - **_Note:_** See TWiki:Codev.RenameWebs for some complications
95 6. Go to `twiki/pub` and rename or remove the web directory if present
96
97 -- TWiki:Main.MikeMannix - 14 Sep 2001 %BR% -- TWiki:Main.PeterThoeny - 07 Apr 2002 %BR% -- TWiki:Main.GrantBow - 16 Jan 2003