none
authorPeterThoeny <PeterThoeny>
Fri, 16 Mar 2001 09:32:42 +0000 (09:32 +0000)
committerPeterThoeny <PeterThoeny>
Fri, 16 Mar 2001 09:32:42 +0000 (09:32 +0000)
Main/WebHome.mdwn
TWiki/TWikiAccessControl.mdwn
TWiki/TWikiInstallationGuide.mdwn
TWiki/TWikiSkins.mdwn
TWiki/TWikiUserAuthentication.mdwn
TWiki/WebChangesAlert.mdwn
TWiki/WebHome.mdwn

index d12291a..33e3f30 100644 (file)
@@ -1,8 +1,8 @@
 <table>
   <tr>
-    <td>[[TWiki/WelcomeGuest]]: %WIKITOOLNAME% is a web-based collaboration tool, web authoring tool, document management tool and knowledge base tool. You can edit any %WIKITOOLNAME% page. </td>
+    <td><strong><font size="+1"> [[TWiki/WelcomeGuest]]: </font></strong> %WIKITOOLNAME% is a web-based collaboration tool, web authoring tool, document management tool and knowledge base tool. You can edit any %WIKITOOLNAME% page. </td>
     <td><a href="http://TWiki.org/"><img alt="Powered by TWiki" border="0" height="64" src="http://www.dementia.org/twiki//view/twikilogo3.gif" width="131" /></a></td>
-    <td><b>The TWiki home is <br /> at <a href="http://TWiki.org/" target="_top">http://TWiki.org/</a> </b></td>
+    <td><b>The TWiki <sup>TM</sup> home is <br /> at <a href="http://TWiki.org/" target="_top">http://TWiki.org/</a> </b></td>
   </tr>
 </table>
 
index 0484e7f..7a93ad1 100644 (file)
@@ -1,3 +1,5 @@
+## <a name="TWiki Access Control"></a> TWiki Access Control
+
 %WIKITOOLNAME% allows you to define restrictions of who is allowed to view a %WIKITOOLNAME% web, make changes to topics or attach files.
 
 **IMPORTANT NOTE:** Think twice before restricting read or write access to a web or a topic, because an open system where everybody can contribute is the essence of the [[WikiCulture]]. Experience shows that unrestricted write access works very well because:
@@ -6,7 +8,7 @@
 - Content does not get lost because topics are under revision control.
 - A topic revision can be undone by a member of the [[TWikiAdminGroup]] in case needed.
 
-**_Users and Groups_**
+### <a name="Users and Groups"></a> Users and Groups
 
 Access control is based on users and groups.
 
@@ -23,7 +25,7 @@ Access control is based on users and groups.
 - GROUP defines the members of the group; it is a comma delimited list of users and other groups. Example: <br />`    * Set GROUP = Main.SomeUser, Main.OtherUser, Main.SomeOtherGroup`
 - ALLOWTOPICCHANGE defines who is allowed to change the group topic; it is a comma delimited list of users and groups. You typically want to restrict that to the members of the group itself, so it should contain the name of the topic, i.e. <br />`    * Set ALLOWTOPICCHANGE = Main.TWikiAdminGroup`<br /> for the TWikiAdminGroup topic. (This is to prevent users not in the group from editing the topic and gaining unauthorized membership to the group.)
 
-**_Write Access Restriction for Individual Topics_**
+### <a name="Write Access Restriction for Ind"></a> Write Access Restriction for Individual Topics
 
 You can define restrictions of who is allowed to make changes to a topic or attach files to it.
 
@@ -38,7 +40,7 @@ ALLOWTOPICCHANGE defines users or groups that **are** allowed to make changes to
 
 DENYTOPICCHANGE is evaluated before ALLOWTOPICCHANGE. Access is denied if the authenticated person is in the DENYTOPICCHANGE list, or not in the ALLOWTOPICCHANGE list. Access is granted in case DENYTOPICCHANGE and ALLOWTOPICCHANGE is not defined.
 
-**_Write Access Restriction for a Whole %WIKITOOLNAME% Web_**
+### <a name="Write Access Restriction for a W"></a> Write Access Restriction for a Whole %WIKITOOLNAME% Web
 
 You can define restrictions of who is allowed to make changes to a %WIKITOOLNAME% web. This includes creating new topics, changing topics or attaching files.
 
@@ -52,7 +54,7 @@ The same rules apply like the one for Access Control for Individual Topics; with
 - DENYTOPICCHANGE (in topic) overrides DENYWEBCHANGE (in WebPreferences)
 - ALLOWTOPICCHANGE (in topic) overrides ALLOWWEBCHANGE (in WebPreferences)
 
-**_Read Access Restriction for a Whole %WIKITOOLNAME% Web_**
+### <a name="Read Access Restriction for a Wh"></a> Read Access Restriction for a Whole %WIKITOOLNAME% Web
 
 You can define restrictions of who is allowed to view a %WIKITOOLNAME% web.
 
@@ -78,4 +80,4 @@ _Notes for read access restriction:_
 
 **_Related topics:_** [[TWikiPreferences]], [[WebPreferences]] (in every web), [[TWikiAdminGroup]], [[TWikiGroups]]
 
--- [[PeterThoeny]] - 20 Jan 2001 <br />
+-- [[PeterThoeny]] - 16 Mar 2001 <br />
index 9300175..756605b 100644 (file)
@@ -1,3 +1,5 @@
+## <a name="TWiki Installation Notes"></a> TWiki Installation Notes
+
 These installation steps use the Apache web server on Linux as an example. TWiki should run on other web servers and Unix systems as well. (TWiki on Windows is possible, but has not been documented well. More on that at <http://TWiki.org/cgi-bin/view/Codev/TWikiOnWindows> )
 
 **_Note:_** Below installation steps assume user `nobody` for all files manupulated by the cgi scripts (executed by the web server), and user `twiki` for all other files. You need to replace user `nobody` with an other user in case the web server executes the script with a different user ( default for Debian is `www-data` ). Also, you can substitute user `twiki` with your own user name.
@@ -39,7 +41,7 @@ These installation steps use the Apache web server on Linux as an example. TWiki
 
 Read <http://TWiki.org/cgi-bin/view/Codev/SourceForgeHowTo> in case you want to install TWiki on SourceForge.
 
-Installation steps:
+### <a name="Installation steps"></a> Installation steps
 
 - Request the TWiki distribution (in Unix ZIP format) from <http://TWiki.org/download.html> .
 - Create directory `/home/httpd/twiki` and unzip the TWiki distribution into this directory.
@@ -78,7 +80,7 @@ Installation steps:
   - If you use `.htaccess`, edit the file and add the file extension to `edit`, `view`, `preview`, etc.
 - Note in case the cgi scripts are **_not_** running as user `nobody`: The `*,v` RCS repository files delivered with the installation package are locked by user `nobody` . In case the user is different (e.g. `www-data` ), it is not possible to check in files, this has the effect that the topic version number does not increase when saving a topic. In this case you need to unlock all repository files and lock them as user `www-data` (check the rcs man pages), or simply delete all the repository files. A simple way to switch the locker of the RCS files is to use sed: <br />`for f in *,v; do sed 's/nobody\:/www-data\:/' $f > x; mv x $f; done`
 - Security issue: Directories `twiki/data` , `twiki/templates` and all its subdirectories should be set so that they are **not** visible as a URL. (Alternatively, move the directries to a place where they are not visible, and change the variables in `twiki/bin/wikicfg.pm` accordingly)
-- Enable email notification of topic changes, [Notification of Changes](TWikiDocumentation#notification) has more. Using your browser, edit also the [[WebNotify]] topic in all webs and set the users you want to notify.
+- Enable email notification of topic changes, [[Notification of Changes|Main/TWikiDocumentation#TWiki_Notification_of_Changes]] has more. Using your browser, edit also the [[WebNotify]] topic in all webs and set the users you want to notify.
 - Add the [TWiki:Main.PoweredByTWikiLogo](http://TWiki.org/cgi-bin/view/Main/PoweredByTWikiLogo) to your [[WebHome]] topic.
 
 - Optional: You can add new rendering rules or new %VARIABLES%. To insure an easy upgrade of TWiki it is recommended to do this customization in `twiki/bin/wikicfg.pm` , not `twiki/bin/wiki.pm` .
@@ -115,6 +117,8 @@ Installation steps:
   - In case you want usage statistics for this web: Copy file `WebStatistics.txt` from the `twiki/data/Main` directory to the new data directory. Edit topic WebStatistics in the new web and delete old usage entries.
   - Note that user home topics are only located in the %WIKITOOLNAME%.Main web, so don't try to move them or create them in other webs. From any web you can refer to users located in the %WIKITOOLNAME%.Main web like `Main.UserName` or `%MAINWEB%.UserName`.
 
+### <a name="Contents of Directories"></a> Contents of Directories
+
 Here are contents of directories showing file permissions. Please note that this is for debugging reasons only and does not exactly reflect the distribution:
 
 Directory `twiki/bin` :
@@ -277,4 +281,4 @@ Directory `twiki/pub/icn/` :
     -rw-rw-r-- 1 twiki twiki    152 Mar  9  1999 xls.gif
     -rw-rw-r-- 1 twiki twiki    144 Mar  9  1999 zip.gif
 
--- [[PeterThoeny]] - 29 Dec 2000 <br />
+-- [[PeterThoeny]] - 16 Mar 2001 <br />
index 7ce0c0a..bfbef48 100644 (file)
@@ -1,6 +1,8 @@
+## <a name="TWiki Skins"></a> TWiki Skins
+
 Skins are customized template files. You can use skins to change the look of a %WIKITOOLNAME% topic, for example the layout of the header and footer. Note that the renderd text between header and footer does **_not_** change. You can use skins also to define an alternate view, i.e. a view optimized for printing.
 
-A skin file is located in the `twiki/template` directory and has a name like `<scriptname>.<skin>.tmpl` or `<scriptname>.<topicname>.<skin>.tmpl`. For example, the `print` skin for the `view` template is <code>view<font>.print</font>.tmpl</code> (red color added for clarification).
+A skin file is located in the <code>**twiki/template**</code> directory and has a name like <code>**&lt;scriptname&gt;.&lt;skin&gt;.tmpl**</code> or <code>**&lt;scriptname&gt;.&lt;topicname&gt;.&lt;skin&gt;.tmpl**</code>. For example, the <code>**print**</code> skin for the <code>**view**</code> template is <code>**view<font>.print</font>.tmpl**</code> (red color added for clarification).
 
 A skin can be activated in two ways:
 
@@ -10,6 +12,6 @@ A skin can be activated in two ways:
   - <http://www.dementia.org/twiki//view/%WEB%/%TOPIC%?skin=print> (for the print view skin)
   - <http://www.dementia.org/twiki//view/%WEB%/%TOPIC%?skin=plain> (for the plain view skin that has no header and footer)
 
-The `?skin=name` URL parameter overrides the SKIN preference value.
+The <code>**?skin=name**</code> URL parameter overrides the SKIN preference value.
 
--- [[PeterThoeny]] - 20 Jan 2001 <br />
+-- [[PeterThoeny]] - 16 Mar 2001 <br />
index dce7010..5159cdb 100644 (file)
@@ -1,15 +1,19 @@
-TWiki does not authenticate users internally, it depends on the `REMOTE_USER` environment variable. This variable is set when you enable basic authentication or authentication via SSL (https protocol)
+## <a name="TWiki Authentication"></a> TWiki Authentication
+
+TWiki does not authenticate users internally, it depends on the <code>**REMOTE\_USER**</code> environment variable. This variable is set when you enable basic authentication or authentication via SSL (https protocol)
 
 TWiki keeps track who made changes to topics at what time. This gives a complete audit trail of changes.
 
 No special installation steps need to be performed in case the server is already autenticated. If not you can opt for one of these:
 
 - Forget about authentication. All changes will be registered as [[TWikiGuest]] user, e.g. you can't tell who made changes.
-- Use basic authentication for the `edit` and `attach` scripts. [TWiki Installation](TWikiDocumentation#installation) tells you more about that.
+- Use basic authentication for the <code>**edit**</code> and <code>**attach**</code> scripts. [[TWiki Installation Notes|Main/TWikiDocumentation#TWiki_Installation_Notes]] tells you more about that.
 - Use SSL to authenticate and secure the whole server.
 
-The `REMOTE_USER` environment variable is only set for the scripts that are under authentication. If for example the `edit`, `save` and `preview` scripts are authenticated, but not `view`, you would get your [[WikiName]] in `preview` for the `%WIKIUSERNAME%` variable, but `view` will show `TWikiGuest` instead of your WikiName.
+The <code>**REMOTE\_USER**</code> environment variable is only set for the scripts that are under authentication. If for example the <code>**edit**</code>, <code>**save**</code> and <code>**preview**</code> scripts are authenticated, but not <code>**view**</code>, you would get your [[WikiName]] in <code>**preview**</code> for the <code>**%WIKIUSERNAME%**</code> variable, but <code>**view**</code> will show <code>**TWikiGuest**</code> instead of your WikiName.
+
+There is a way to tell TWiki to remember the user for the scripts that are not authenticated, e.g. for the case where the <code>**REMOTE\_USER**</code> environment variable is not set. TWiki can be configured to remember the IP address / username pair whenever an authentication happens (edit topic, attach file). Once remembered, the non authenticated scripts like <code>**view**</code> will show the correct username instead of <code>**TWikiGuest**</code>. You can enable this by setting the <code>**$doRememberRemoteUser**</code> flag in <code>**TWiki.cfg**</code>. TWiki persistently stores the IP address / username pairs in file <code>**$remoteUserFilename**</code>, which is <code>**"$dataDir/remoteusers.txt"**</code> by default. Please note that this can fail in case the IP address changes due to dynamically assigned IP addresses or proxy servers.
 
-There is a way to tell TWiki to remember the user for the scripts that are not authenticated, e.g. for the case where the `REMOTE_USER` environment variable is not set. TWiki can be configured to remember the IP address / username pair whenever an authentication happens (edit topic, attach file). Once remembered, the non authenticated scripts like `view` will show the correct username instead of `TWikiGuest`. You can enable this by setting the `$doRememberRemoteUser` flag in `wikicfg.pm`. TWiki persistently stores the IP address / username pairs in file `$remoteUserFilename`, which is `"$dataDir/remoteusers.txt"` by default. Please note that this can fail in case the IP address changes due to dynamically assigned IP addresses or proxy servers. Test: You are Main.admin.
+Test: You are Main.admin.
 
--- [[PeterThoeny]] - 02 Nov 2000 <br />
+-- [[PeterThoeny]] - 16 Mar 2001 <br />
index 02311f9..ef9f665 100644 (file)
@@ -1,3 +1,5 @@
+## <a name="TWiki Notification of Changes"></a> TWiki Notification of Changes
+
 Each %WIKITOOLNAME% web does an automatic email notification of recent changes. Users can subscribe / unsubscribe themselves in [[WebNotify]] of each TWiki web. The Perl script `mailnotify` is called by a deamon in regular intervals. The script is sending an automated email to subscribed users in case some topics changed in a web within this interval.
 
 Installation note for Unix platforms: Edit the cron table so that `mailnotify` is called in an interval of your choice. Please consult `man crontab` of how to modify the table that schedules program execution at certain intervals. Example:
@@ -7,4 +9,4 @@ Installation note for Unix platforms: Edit the cron table so that `mailnotify` i
 
 The above line will call mailnotify at 15 minutes and 45 minutes past every hour. The `-q` switch suppresses all normal output.
 
--- [[PeterThoeny]] - 20 Sep 2000 <br />
+-- [[PeterThoeny]] - 16 Mar 2001 <br />
index 9eaba1a..eda66df 100644 (file)
@@ -2,7 +2,7 @@
   <tr>
     <td> Welcome to %WIKITOOLNAME%, a web-based collaboration tool, document management tool, and knowledge base tool. This is the place to learn about the tool.</td>
     <td><a href="http://TWiki.org/"><img alt="Powered by TWiki" border="0" height="64" src="http://www.dementia.org/twiki//view/twikilogo3.gif" width="131" /></a></td>
-    <td><b>The TWiki home is <br /> at <a href="http://TWiki.org/" target="_top">http://TWiki.org/</a> </b></td>
+    <td><b>The TWiki <sup>TM</sup> home is <br /> at <a href="http://TWiki.org/" target="_top">http://TWiki.org/</a> </b></td>
   </tr>
 </table>
 
@@ -53,3 +53,4 @@
 
 - You are currently in the %WIKITOOLNAME%.%WEB% web. The color code for this web is a light orange background, so you know where you are.
 - If you are not familiar with the %WIKITOOLNAME% collaboration tool, please visit [[WelcomeGuest]] first.
+- TWiki <sup>TM</sup> is a trademark of [[PeterThoeny]]