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="#Permissions"> Permissions</a></li>
   9             <li><a href="#Edit Conflicts"> Edit Conflicts</a></li>
  10             <li><a href="#Renaming the webs in the distrib"> Renaming the webs in the distribution</a></li>
  11           </ul>
  12         </li>
  13         <li><a href="#Hierarchical Webs"> Hierarchical Webs</a><ul>
  14             <li><a href="#Subweb Preferences are Inherited"> Subweb Preferences are Inherited</a></li>
  15             <li><a href="#Navigation"> Navigation</a></li>
  16           </ul>
  17         </li>
  18       </ul>
  19     </li>
  20   </ul>
  21 </div>
  22
  23 # <a name="Managing Webs"></a> Managing Webs
  24
  25 _Adding, renaming and deleting webs are all web-based operations._
  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 (in the [[TWikiAdminGroup]]) 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 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.
  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> It is not recommended to create a new web for each little project. You can organize content within a web using categories, [[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">
  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> Description:<br />  <br />   </strong></th>
  63       <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>
  64     </tr>
  65     <tr>
  66       <th align="right" bgcolor="#99CCCC"><strong> Use to...<br />   </strong></th>
  67       <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>
  68     </tr>
  69     <tr>
  70       <th align="right" bgcolor="#99CCCC"><strong> Set NOSEARCHALL: </strong></th>
  71       <td><input checked name="nosearchall" type="radio" value="" /> No   <input name="nosearchall" type="radio" value="on" /> Yes </td>
  72       <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>
  73     </tr>
  74     <tr>
  75       <th bgcolor="#99CCCC"><strong>   </strong></th>
  76       <td colspan="2"><input type="submit" value="Create new web" /></td>
  77     </tr>
  78   </table><input name="newtopic" type="hidden" value="" /> <input name="action" type="hidden" value="createweb" /></form>
  79
  80 **_Notes:_**
  81
  82 - Attachments will NOT get copied over along with their topics
  83 - While creating the new web, TWiki will update the following variables in the [[WebPreferences]]: `WEBBGCOLOR`, `SITEMAPLIST`, `SITEMAPWHAT`, `SITEMAPUSETO` and `NOSEARCHALL`. These variables are used to dynamically generate the [[SiteMap]]
  84 - TWiki does not edit the [[TWiki.TWikiPreferences|TWiki/TWikiPreferences]] to update the `WIKIWEBLIST`. This must be done by hand
  85
  86 ## <a name="Renaming or Deleting a Web"></a> Renaming or Deleting a Web
  87
  88 Rename a web via the Tools section in each web's [[WebPreferences]] topic. You may delete a web by moving it into a Trash web.
  89
  90 ### <a name="Permissions"></a> Permissions
  91
  92 You may only rename a web if you have permissions to rename all the topics within that web, including any topics in that web's subwebs. You will also need permissions to update any topics containing references to that web.
  93
  94 ### <a name="Edit Conflicts"></a> Edit Conflicts
  95
  96 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.
  97
  98 ### <a name="Renaming the webs in the distrib"></a> Renaming the webs in the distribution
  99
 100 If you plan to rename the Main web, remember that TWiki stores user and group topics in `%MAINWEB%`, which by default is `Main` (this is assigned in the site configuration). That means that every [[WikiName]] signature - `Main.SomeUserName` - points to it and would need updating (unless the variable, `%MAINWEB%.SomeUserName`, is used throughout). This potentially large change can be performed automatically with the renameweb function mentioned above, in the [[Main.WebPreferences|Main/WebPreferences]] topic.
 101
 102 If you want to rename the TWiki web, remember it is referred to by `%TWIKIWEB%` which is also defined by a configuration setting.
 103
 104 ## <a name="Hierarchical Webs"></a> Hierarchical Webs
 105
 106 Hierarchical web support is enabled by turning on the `{EnableHierarchicalWebs}` setting in `configure`. Without this setting, TWiki will only allow a single level of hierarchy (webs). If you set this, you can use multiple levels, like a directory tree, i.e. webs within webs.
 107
 108 **_%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.
 109
 110 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.
 111
 112 **Example:**
 113
 114 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.
 115
 116 ### <a name="Subweb Preferences are Inherited"></a> Subweb Preferences are Inherited
 117
 118 The preferences of a subweb are inherited from the parent web and overridden locally. Preferences are ultimately inherited from the [[TWiki.TWikiPreferences|TWiki/TWikiPreferences]] topic.
 119
 120 **Example Preference Inheritance for `Sandbox/TestWeb/SubWeb.SubWebTopic` topic:**
 121
 122 1. `TWiki.TWikiPreferences` site-wide preferences
 123 2. `Sandbox.WebPreferences` inherits from and overrides settings in `TWiki.TWikiPreferences`
 124 3. `Sandbox/TestWeb.WebPreferences` inherits from and overrides settings in `Sandbox.WebPreferences`
 125 4. `Sandbox/TestWeb/SubWeb.WebPreferences` inherits from and overrides settings in `Sandbox/TestWeb.WebPreferences`
 126 5. `Sandbox/TestWeb/SubWeb.SubWebTopic` inherits from and overrides settings in `Sandbox/TestWeb/SubWeb.WebPreferences`
 127
 128 ### <a name="Navigation"></a> Navigation
 129
 130 The Pattern skin (default) indicates Subwebs by indenting them in the sidebar relative to their level in the hierarchy.
 131
 132 **_Related Topics:_** [[AdminDocumentationCategory]], [[AdminToolsCategory]]