TWiki/ManagingWebs.mdwn

   1 # <a name="Managing Webs"></a> Managing Webs
   2
   3 _Adding, renaming and deleting webs are all web-based operations._
   4
   5 <div>
   6   <ul>
   7     <li><a href="#Managing Webs"> Managing Webs</a><ul>
   8         <li><a href="#Overview"> Overview</a></li>
   9         <li><a href="#Choose Web Template"> Choose Web Template</a></li>
  10         <li><a href="#Adding a New Web"> Adding a New Web</a></li>
  11         <li><a href="#Hierarchical Webs"> Hierarchical Webs</a><ul>
  12             <li><a href="#Subweb Preferences are Inherited"> Subweb Preferences are Inherited</a></li>
  13             <li><a href="#Navigation"> Navigation</a></li>
  14           </ul>
  15         </li>
  16         <li><a href="#Renaming or Deleting a Web"> Renaming or Deleting a Web</a><ul>
  17             <li><a href="#Permissions"> Permissions</a></li>
  18             <li><a href="#Edit Conflicts"> Edit Conflicts</a></li>
  19             <li><a href="#Renaming the webs in the distrib"> Renaming the webs in the distribution</a></li>
  20           </ul>
  21         </li>
  22       </ul>
  23     </li>
  24   </ul>
  25 </div>
  26
  27 ## <a name="Overview"></a> Overview
  28
  29 A [[TWikiSite]] is divided into webs; each one represents one subject, one area of collaboration. Administrators can add/rename/delete webs.
  30
  31 <a name="WebTemplate"></a>
  32
  33 ## <a name="Choose Web Template"></a> Choose Web Template
  34
  35 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 (for example `_default`). All topics in the template web will be copied into your new web.
  36
  37 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 would like to use as a starting point. Only topics that have names beginning with **Web...** (like "WebHome", "WebNotify", etc.) are copied.
  38
  39 In either case you will want to be sure to verify that your new web has all the custom modifications that you desire. Any [[TWikiVariables]] defined in the form below will automatically be set in the WebPreferences of the new web.
  40
  41 <a name="CreateNewWeb"></a>
  42
  43 ## <a name="Adding a New Web"></a> Adding a New Web
  44
  45 <form action="http://www.dementia.org/twiki/manage/%WEB%/%TOPIC%" method="post" name="admin"> Create a new web by filling out this form.%BR% <strong><em>%X% Note:</em></strong> <strong>Keep the number of webs to a minimum!</strong> Don't create a new web for each little project. Cross-linking topics is easier, and searches are faster, if there are only a few larger webs. <table border="1" cellpadding="0" cellspacing="0">
  46     <tr>
  47       <th align="right" bgcolor="#99CCCC"><strong> Name of new web: </strong></th>
  48       <td><input name="newweb" size="16" type="text" value="" /></td>
  49       <td> The name must start with an upper case letter, followed by upper or lower case letters or numbers. Specify a short name to avoid long URLs. </td>
  50     </tr>
  51     <tr>
  52       <th align="right" bgcolor="#99CCCC"><strong> Based on web: </strong></th>
  53       <td><select name="baseweb"> </select></td>
  54       <td> Select a [[Main/TemplateWeb]]</td>
  55     </tr>
  56     <tr>
  57       <th align="right" bgcolor="#99CCCC"><strong> Web color: </strong></th>
  58       <td><input name="WEBBGCOLOR" size="16" type="text" value="#D0D0D0" /></td>
  59       <td> Enter a [[Main/StandardColors]] code for the web </td>
  60     </tr>
  61     <tr>
  62       <th align="right" bgcolor="#99CCCC"><strong> Site Map: </strong></th>
  63       <td><input checked name="SITEMAPLIST" type="radio" value="on" /> Yes   <input name="SITEMAPLIST" type="radio" value="" /> No </td>
  64       <td> Include this web in the site map </td>
  65     </tr>
  66     <tr>
  67       <th align="right" bgcolor="#99CCCC"><strong> Description:<br />  <br />   </strong></th>
  68       <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 description will be used in the %SYSTEMWEB%.SiteMap </td>
  69     </tr>
  70     <tr>
  71       <th align="right" bgcolor="#99CCCC"><strong> Use to...<br />   </strong></th>
  72       <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 %SYSTEMWEB%.SiteMap </td>
  73     </tr>
  74     <tr>
  75       <th align="right" bgcolor="#99CCCC"><strong> Hidden: </strong></th>
  76       <td><input name="NOSEARCHALL" type="radio" value="on" /> Yes   <input checked name="NOSEARCHALL" type="radio" value="" /> No </td>
  77       <td> Specify if you want to exclude the web from a "search all webs" search. <strong>This will not prevent users accessing the web</strong>. It will simply hide it from searches. </td>
  78     </tr>
  79     <tr>
  80       <th bgcolor="#99CCCC"><strong>   </strong></th>
  81       <td colspan="2"><input type="submit" value="Create new web" /></td>
  82     </tr>
  83   </table><input name="newtopic" type="hidden" value="" /> <input name="action" type="hidden" value="createweb" /></form>
  84
  85 **_Notes:_**
  86
  87 - You must have `ROOTCHANGE` access to create a top-level web (one with no parent)
  88 - Only the person who created it has permission to change the WebPreferences in the new web
  89
  90 ## <a name="Hierarchical Webs"></a> Hierarchical Webs
  91
  92 You can only create hierarchical webs (webs within webs) if the `{EnableHierarchicalWebs}` setting in [configure](http://www.dementia.org/twiki/configure) is enabled. Hierarchical webs are currently enabled.
  93
  94 **_%T% Note:_** You might not need hierarchical webs. TWiki topics already have a parent/child relationship within a web, which is shown in the breadcrumb. Try to keep the number of webs to a minimum in order to keep search and cross-referencing simple.
  95
  96 You can create hierarchical webs via the _Adding a New Web_ form above, by using a slash- or dot-separated path name which is based on an existing web name in the _Name of new web:_ field.
  97
  98 **Example:**
  99
 100 To create a subweb named `Bar` inside a web named `Foo`, use `Foo/Bar` or `Foo.Bar` as the new web name in the form above.
 101
 102 ### <a name="Subweb Preferences are Inherited"></a> Subweb Preferences are Inherited
 103
 104 The preferences of a subweb are inherited from the parent web and overridden locally. Preferences are ultimately inherited from the [[%SYSTEMWEB%.TWikiPreferences|SYSTEMWEB/TWikiPreferences]] topic.
 105
 106 **Example Preference Inheritance for `Sandbox/TestWeb/SubWeb.SubWebTopic` topic:**
 107
 108 1. `%SYSTEMWEB%.TWikiPreferences` site-wide preferences
 109 2. `Sandbox.WebPreferences` inherits from and overrides settings in `%SYSTEMWEB%.TWikiPreferences`
 110 3. `Sandbox/TestWeb.WebPreferences` inherits from and overrides settings in `Sandbox.WebPreferences`
 111 4. `Sandbox/TestWeb/SubWeb.WebPreferences` inherits from and overrides settings in `Sandbox/TestWeb.WebPreferences`
 112 5. `Sandbox/TestWeb/SubWeb.SubWebTopic` inherits from and overrides settings in `Sandbox/TestWeb/SubWeb.WebPreferences`
 113
 114 ### <a name="Navigation"></a> Navigation
 115
 116 The Pattern skin (default) indicates Subwebs by indenting them in the sidebar relative to their level in the hierarchy.
 117
 118 <a name="RenameWeb"></a>
 119
 120 ## <a name="Renaming or Deleting a Web"></a> Renaming or Deleting a Web
 121
 122 Rename a web via the Tools section in each [[WebPreferences]] topic. You may delete a web by moving it into a Trash web.
 123
 124 ### <a name="Permissions"></a> Permissions
 125
 126 You may only rename a web if you have the following permissions
 127
 128 - You must be allowed to rename and changes topics in the web you want to rename
 129 - You must be allowed to rename topics in the parent web of the web you want to rename
 130 - If the web is a root web (i.e. it has no parent web) then you must have permission to both create and rename root webs. These permissions are controlled by the ALLOWROOTCHANGE preference, which can be set in [[%USERSWEB%.TWikiPreferences|USERSWEB/TWikiPreferences]].
 131 - If you move the web to another parent web you must be allowed to create and change topics in the new parent web.
 132
 133 When you rename a web TWiki will try and update all links that refer to the old web. You should note that links only get updated in topics that you are allowed to edit. If you use access rights in the TWiki installation it is generally best to let an administrator rename webs to avoid too many broken links.
 134
 135 ### <a name="Edit Conflicts"></a> Edit Conflicts
 136
 137 If anyone is editing a topic which requires updating, or which lives in the web being renamed, a second confirmation screen will come up which will indicate which topics are still locked for edit. You may continue to hit the refresh button until an edit lease is obtained for each topic which requires updating (the "Refresh" button will change to "Submit"), or hit "Cancel", which will cancel your edit lease on all affected topics.
 138
 139 ### <a name="Renaming the webs in the distrib"></a> Renaming the webs in the distribution
 140
 141 It is possible, though not recommended, to change the names of the webs in the distribution.
 142
 143 If you plan to rename the %USERSWEB% web, remember that TWiki stores user topics in this web. That means that every [[WikiName]] signature - `%USERSWEB%.SomeUserName` - points to it and would need updating (unless the variable, `%USERSWEB%.SomeUserName`, is used throughout). This potentially large change can be performed automatically if you rename the web from the Tools section of [[WebPreferences]], as described above.
 144
 145 %X% If you want to rename the %SYSTEMWEB% or %USERSWEB% webs, remember they are referred to in the TWiki configuration. You will need to change the `{SystemWebName}`, `{UsersWebName}` and/or `{LocalSitePreferences}` settings in the configuration using the [configure](http://www.dementia.org/twiki/configure) interface.
 146
 147 %X% Renaming the webs in the distribution is not recommended because it makes upgrades much more complicated.
 148
 149 **_Related Topics:_** [[AdminDocumentationCategory]], [[AdminToolsCategory]]