~kosova/+junk/tuxfamily-twiki

« back to all changes in this revision

Viewing changes to foswiki/data/System/ManagingWebs.txt

  • Committer: James Michael DuPont
  • Date: 2009-07-18 19:58:49 UTC
  • Revision ID: jamesmikedupont@gmail.com-20090718195849-vgbmaht2ys791uo2
added foswiki

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
%META:TOPICINFO{author="ProjectContributor" date="1231502400" format="1.1" version="1"}%
 
2
%STARTINCLUDE%
 
3
---+ Managing Webs
 
4
 
 
5
_Adding, renaming and deleting webs are all web-based operations._
 
6
 
 
7
%TOC%
 
8
 
 
9
---++ Overview
 
10
 
 
11
A site is divided into webs; each one represents one subject, one area of collaboration. Administrators can add/rename/delete webs.
 
12
 
 
13
#WebTemplate
 
14
---++ Choose Web Template
 
15
 
 
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 "_" character (for example =_default=).  All topics in the template web will be copied into your new web.
 
17
 
 
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.
 
19
 
 
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 [[macros]] defined in the form below will automatically be set in the !WebPreferences of the new web.
 
21
 
 
22
#CreateNewWeb
 
23
---++ Adding a New Web
 
24
 
 
25
<form name="admin" action="%SCRIPTURLPATH{manage}%/%WEB%/%TOPIC%" method="post">
 
26
Create a new web by filling out this form.%BR%
 
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.
 
28
|  *Name of new web:* | <input name="newweb" class="foswikiInputField" 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. |
 
29
|  *Based on web:* | <select name="baseweb" class="foswikiSelect"> %WEBLIST{ "<option $marker>$name</option>" webs="webtemplate,public" selection="_default" separator=" "}% </select> | Select a TemplateWeb |
 
30
|  *Web color:* | <input name="WEBBGCOLOR" class="foswikiInputField" type="text" value="#D0D0D0" size="16" /> | Enter a StandardColors code for the web |
 
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 |
 
32
|  *Description:<br /> &nbsp;<br /> &nbsp;* | <input type="text" class="foswikiInputField" 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 ||
 
33
|  *Use to...<br /> &nbsp;* | <input type="text" class="foswikiInputField" name="SITEMAPUSETO" value="...collaborate on" size="60" /><br /> Continue the sentence describing the intended use. This is also for the %SYSTEMWEB%.SiteMap ||
 
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. |
 
35
| *&nbsp;* | <input type="submit" class="foswikiSubmit" value="Create new web" /> ||
 
36
<input name="newtopic" type="hidden" value="%URLPARAM{"newtopic"}%" />
 
37
<input name="action" type="hidden" value="createweb" />
 
38
</form>
 
39
 
 
40
*Notes:*
 
41
   * You must have =ROOTCHANGE= access to create a top-level web (one with no parent)
 
42
   * A new web created using the =_default= or =_empty= template webs must have their access controls set before public use
 
43
   * Only the person who created it has permission to change the <nop>%WEBPREFSTOPIC% in the new web
 
44
 
 
45
---++ Hierarchical Webs
 
46
 
 
47
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, Foswiki will only allow a single level of hierarchy. With it, you can use multiple levels, like a directory tree, i.e. webs within webs."}%
 
48
 
 
49
*%T% Note:* You might not need hierarchical webs. Foswiki 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.
 
50
 
 
51
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.
 
52
 
 
53
*Example:*
 
54
 
 
55
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.
 
56
 
 
57
---+++ Subweb Preferences are Inherited
 
58
 
 
59
The [[preference settings]] of a subweb are inherited from the parent web and overridden locally.  Preferences are ultimately inherited from the [[%SYSTEMWEB%.DefaultPreferences]] topic.
 
60
 
 
61
*Example Preference Inheritance for =Sandbox/TestWeb/SubWeb.SubWebTopic= topic:*
 
62
 
 
63
   1 =%SYSTEMWEB%.DefaultPreferences= default settings
 
64
   1 =%USERSWEB%.SitePreferences= site-wide settings inherits from and overrides settings in =%SYSTEMWEB%.DefaultPreferences=
 
65
   1 =Sandbox.%WEBPREFSTOPIC%= inherits from and overrides settings in =%USERSWEB%.SitePreferences=
 
66
   1 =Sandbox/TestWeb.%WEBPREFSTOPIC%= inherits from and overrides settings in =Sandbox.%WEBPREFSTOPIC%=
 
67
   1 =Sandbox/TestWeb/SubWeb.%WEBPREFSTOPIC%= inherits from and overrides settings in =Sandbox/TestWeb.%WEBPREFSTOPIC%= 
 
68
   1 =Sandbox/TestWeb/SubWeb.SubWebTopic= inherits from and overrides settings in =Sandbox/TestWeb/SubWeb.%WEBPREFSTOPIC%= 
 
69
 
 
70
---+++ Navigation
 
71
 
 
72
The Pattern skin (default) indicates Subwebs by indenting them in the sidebar relative to their level in the hierarchy.
 
73
 
 
74
#RenameWeb
 
75
---++ Renaming or Deleting a Web
 
76
 
 
77
Rename a web via the Tools section in each %WEBPREFSTOPIC% topic.  You may delete a web by moving it into a Trash web.  
 
78
 
 
79
---+++ Permissions
 
80
 
 
81
You may only rename a web if you have the following permissions
 
82
   * You must be allowed to rename and changes topics in the web you want to rename
 
83
   * You must be allowed to rename topics in the parent web of the web you want to rename
 
84
   * 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%.SitePreferences]].
 
85
   * If you move the web to another parent web you must be allowed to create and change topics in the new parent web.
 
86
   
 
87
When you rename a web Foswiki 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 Foswiki installation it is generally best to let an administrator rename webs to avoid too many broken links. 
 
88
 
 
89
---+++ Edit Conflicts
 
90
 
 
91
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.
 
92
 
 
93
---+++ Renaming the webs in the distribution
 
94
 
 
95
It is possible, though not recommended, to change the names of the webs in the distribution.
 
96
 
 
97
If you plan to rename the %USERSWEB% web, remember that Foswiki stores user topics in this web. That means that every WikiName signature - =%USERSWEB%.<nop>SomeUserName= - points to it and would need updating (unless the macro style =%<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.
 
98
 
 
99
%X% If you want to rename the %SYSTEMWEB% or %USERSWEB% webs, remember they are referred to in the Foswiki configuration. You will need to change the ={SystemWebName}=, ={UsersWebName}= and/or ={LocalSitePreferences}= settings in the configuration using the [[%SCRIPTURL{configure}%][configure]] interface.
 
100
 
 
101
%X% Renaming the webs in the distribution is not recommended because it makes upgrades much more complicated.
 
102
 
 
103
---
 
104
*Related Topics:* AdminDocumentationCategory, AdminToolsCategory