data/TWiki/ManagingWebs.txt
author Colas Nahaboo <colas@nahaboo.net>
Sat, 26 Jan 2008 15:50:53 +0100
changeset 0 414e01d06fd5
child 1 e2915a7cbdfa
permissions -rw-r--r--
RELEASE 4.2.0 freetown
colas@0
     1
%META:TOPICINFO{author="TWikiContributor" date="1153528583" format="1.1" version="31"}%
colas@0
     2
%STARTINCLUDE%
colas@0
     3
---+ Managing Webs
colas@0
     4
colas@0
     5
_Adding, renaming and deleting webs are all web-based operations._
colas@0
     6
colas@0
     7
%TOC%
colas@0
     8
colas@0
     9
---++ Overview
colas@0
    10
colas@0
    11
A TWikiSite is divided into webs; each one represents one subject, one area of collaboration. Administrators can add/rename/delete webs.
colas@0
    12
colas@0
    13
#WebTemplate
colas@0
    14
---++ Choose Web Template
colas@0
    15
colas@0
    16
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 &quot;_&quot; character (for example =_default=).  All topics in the template web will be copied into your new web.
colas@0
    17
colas@0
    18
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 "%HOMETOPIC%", "%NOTIFYTOPIC%", etc.) are copied.
colas@0
    19
colas@0
    20
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.
colas@0
    21
colas@0
    22
#CreateNewWeb
colas@0
    23
---++ Adding a New Web
colas@0
    24
colas@0
    25
<form name="admin" action="%SCRIPTURLPATH{manage}%/%WEB%/%TOPIC%" method="post">
colas@0
    26
Create a new web by filling out this form.%BR%
colas@0
    27
__%X% Note:__ *Keep the number of webs to a minimum!* 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.
colas@0
    28
|  *Name of new web:* | <input name="newweb" type="text" value="%URLPARAM{"newweb"}%" size="16" /> | 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. |
colas@0
    29
|  *Based on web:* | <select name="baseweb"> %WEBLIST{ "<option $marker>$name</option>" webs="webtemplate,public" selection="_default" separator=" "}% </select> | Select a TemplateWeb |
colas@0
    30
|  *Web color:* | <input name="WEBBGCOLOR" type="text" value="#D0D0D0" size="16" /> | Enter a StandardColors code for the web |
colas@0
    31
|  *Site Map:* | <input type="radio" name="SITEMAPLIST" value="on" checked="checked" /> Yes &nbsp; <input type="radio" name="SITEMAPLIST" value="" /> No | Include this web in the site map |
colas@0
    32
|  *Description:<br /> &nbsp;<br /> &nbsp;* | <input type="text" name="SITEMAPWHAT" value="" size="60" /><br /> Enter a short description of the web. Write =Web.TopicName= instead of just =TopicName= if you include links. This description will be used in the %SYSTEMWEB%.SiteMap ||
colas@0
    33
|  *Use to...<br /> &nbsp;* | <input type="text" name="SITEMAPUSETO" value="...collaborate on" size="60" /><br /> Continue the sentence describing the intended use. This is also for the %SYSTEMWEB%.SiteMap ||
colas@0
    34
|  *Hidden:* | <input type="radio" name="NOSEARCHALL" value="on" /> Yes &nbsp; <input type="radio" name="NOSEARCHALL" value="" checked="checked" /> No | Specify if you want to exclude the web from a "search all webs" search. *This will not prevent users accessing the web*. It will simply hide it from searches. |
colas@0
    35
| *&nbsp;* | <input type="submit" class="twikiSubmit" value="Create new web" /> ||
colas@0
    36
<input name="newtopic" type="hidden" value="%URLPARAM{"newtopic"}%" />
colas@0
    37
<input name="action" type="hidden" value="createweb" />
colas@0
    38
</form>
colas@0
    39
colas@0
    40
__Notes:__
colas@0
    41
   * You must have =ROOTCHANGE= access to create a top-level web (one with no parent)
colas@0
    42
   * Only the person who created it has permission to change the <nop>%WEBPREFSTOPIC% in the new web
colas@0
    43
colas@0
    44
---++ Hierarchical Webs
colas@0
    45
colas@0
    46
You can only create hierarchical webs (webs within webs) if the ={EnableHierarchicalWebs}= setting in [[%SCRIPTURLPATH{"configure"}%][configure]] is enabled. Hierarchical webs are currently %IF{"{EnableHierarchicalWebs}" then="enabled." else="disabled. Without this setting, TWiki will only allow a single level of hierarchy. With it, you can use multiple levels, like a directory tree, i.e. webs within webs."}%
colas@0
    47
colas@0
    48
__%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.
colas@0
    49
colas@0
    50
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.
colas@0
    51
colas@0
    52
*Example:*
colas@0
    53
colas@0
    54
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.
colas@0
    55
colas@0
    56
---+++ Subweb Preferences are Inherited
colas@0
    57
colas@0
    58
The preferences of a subweb are inherited from the parent web and overridden locally.  Preferences are ultimately inherited from the [[%SYSTEMWEB%.TWikiPreferences]] topic.
colas@0
    59
colas@0
    60
*Example Preference Inheritance for =Sandbox/TestWeb/SubWeb.SubWebTopic= topic:*
colas@0
    61
colas@0
    62
   1. =%SYSTEMWEB%.TWikiPreferences= site-wide preferences
colas@0
    63
   2. =Sandbox.%WEBPREFSTOPIC%= inherits from and overrides settings in =%SYSTEMWEB%.TWikiPreferences=
colas@0
    64
   3. =Sandbox/TestWeb.%WEBPREFSTOPIC%= inherits from and overrides settings in =Sandbox.%WEBPREFSTOPIC%=
colas@0
    65
   4. =Sandbox/TestWeb/SubWeb.%WEBPREFSTOPIC%= inherits from and overrides settings in =Sandbox/TestWeb.%WEBPREFSTOPIC%= 
colas@0
    66
   5. =Sandbox/TestWeb/SubWeb.SubWebTopic= inherits from and overrides settings in =Sandbox/TestWeb/SubWeb.%WEBPREFSTOPIC%= 
colas@0
    67
colas@0
    68
---+++ Navigation
colas@0
    69
colas@0
    70
The Pattern skin (default) indicates Subwebs by indenting them in the sidebar relative to their level in the hierarchy.
colas@0
    71
colas@0
    72
#RenameWeb
colas@0
    73
---++ Renaming or Deleting a Web
colas@0
    74
colas@0
    75
Rename a web via the Tools section in each %WEBPREFSTOPIC% topic.  You may delete a web by moving it into a Trash web.  
colas@0
    76
colas@0
    77
---+++ Permissions
colas@0
    78
colas@0
    79
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.
colas@0
    80
colas@0
    81
---+++ Edit Conflicts
colas@0
    82
colas@0
    83
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.
colas@0
    84
colas@0
    85
---+++ Renaming the webs in the distribution
colas@0
    86
colas@0
    87
It is possible, though not recommended, to change the names of the webs in the distribution.
colas@0
    88
colas@0
    89
If you plan to rename the %USERSWEB% web, remember that TWiki stores user topics in this web. That means that every WikiName signature - =%USERSWEB%.<nop>SomeUserName= - points to it and would need updating (unless the variable, =%<nop>USERSWEB%.<nop>SomeUserName=, is used throughout). This potentially large change can be performed automatically if you rename the web from the Tools section of %WEBPREFSTOPIC%, as described above.
colas@0
    90
colas@0
    91
%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 [[%SCRIPTURL{configure}%][configure]] interface.
colas@0
    92
colas@0
    93
%X% Renaming the webs in the distribution is not recommended because it makes upgrades much more complicated.
colas@0
    94
colas@0
    95
__Related Topics:__ AdminDocumentationCategory, AdminToolsCategory