From 0958133f160a6308d1bb7fada757764b48ae2b34 Mon Sep 17 00:00:00 2001 From: thoeny Date: Fri, 16 Jul 1999 10:21:24 +0000 Subject: [PATCH] none --- TWiki/TWikiDocumentation.mdwn | 385 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 385 insertions(+) diff --git a/TWiki/TWikiDocumentation.mdwn b/TWiki/TWikiDocumentation.mdwn index e69de29..73b04fa 100644 --- a/TWiki/TWikiDocumentation.mdwn +++ b/TWiki/TWikiDocumentation.mdwn @@ -0,0 +1,385 @@ +

Documentation of the TWiki Implementation

+

+Related Topics: TWikiHistory, TWikiPlannedFeatures, TWikiEnhancementRequests. +

+ +

+(1) Login Username vs. Wiki Username +

+TWiki manages internally two usernames: Login username and Wiki username.

+

+Note: When you write a WikiName of a user (your own or somebody else's) be sure to specify the Main web in front of the Wiki user name, e.g. write it as Main.wikiUsername. This assures that the name will be linked automatically to the TWiki.Main web, even if the text is written in a different Wiki web. +

+TWiki can map the Intranet username to the Wiki username automatically, provided that the Login username and Wiki username pair has been entered in the TWikiUsers topic. +

+

+ +

+(2) Wiki Variables +

+%INCLUDE:"TWikiVariables.txt"% +

+

+ +

+(3) Notification of Changes by Email +

+Each TWiki 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 once every 60 minutes. For each Twiki web mailnotify is sending an automated email to subscribed users in case some topics changed within these 60 minutes. +

+Implementation note: Edit the cron table so that mailnotify is called every 60 minutes. Please consult man crontab of how to modify the table that schedules program execution at certain intervals. Example: +

+% crontab -e
+15,45 * * * * (cd ~twiki/public_html/bin; ./mailnotify)
+
+The above line will call mailnotify at 15 minutes and 45 minutes passed every hour. +

+ +

+(4) TWiki Category Table +

+It is possible to add a category table to a TWiki web. This permits storing and searching for more structured information. Editing a topic shows a HTML form with the usual text area and a table with selectors, checkboxes, radio buttons and text fields. The category table is shown at the end of a topic. The format of the category table can be defined per TWiki web. +

+If you want to use a Category Table in a TWiki web you need to have the following three files in the wiki/bin/templates/{Yourweb} directory:

+

+_Format of category definition template twikicatitems.tmpl_ +

+Valid lines: +

+select|{name}|{selSize}|{val1}|{val2}|{val3}...
+checkbox|{name}|{checkFlag}|{itemsPerLine}|{val1}|{val2}|{val3}...
+radio|{name}|{itemsPerLine}|{val1}|{val2}|{val3}...
+text|{name}|{charSize}
+# comments start with a # character
+
+

+Explanation: +

+  {name}				 name of tag
+  {selSize}			 vertical size of SELECT tag
+  {val1}|{val2}...	values
+  {checkFlag}		  set to true for [Set] [Clear] buttons, else set to false
+  {itemsPerLine}	  input items per line before wrap around, 0 if no wrap around
+  {charSize}			number of characters for text fields
+
+

+_Remark:_ Line radio|UseCategory|0|Yes|No has a special meaning. If present, it is possible to choose in "edit" if the category table is included in the topic or not +

+Example file: +

+radio|UseCategory|0|Yes|No, delete this category table
+select|TopicClassification|1|Select one...|NoDisclosure|PublicSupported|PublicFAQ
+checkbox|OperatingSystem|true|5|OsSolaris|OsSunOS|OsHPUX|OsWin
+text|OsVersion|16
+
+

+_Format of twikicatedit.tmpl and twikicatview.tmpl_ +

+Use the example below and customize if needed. twikicatedit.tmpl and twikicatview.tmpl can be identical, but they do not have to be. +

+_Attention:_ <!--TWikiCat--> is needed at the beginning and end as markers. Do not delete them! +

+Example: +

+<!--TWikiCat--> <h4> TWikiCategory </h4>
+<table border="2" cellspacing="1" cellpadding="1">
+%REPEAT%<tr>
+<td valign="top" align="right"> %CATNAME%:  <br>%CATMODIFIER%</td><td>  %CATVALUE% </td>
+</tr>%REPEAT%
+</table><!--TWikiCat-->
+
+

+Above template files will result in the following category table when _viewing_ a topic: +

+

TWikiCategory

+ + + + + + + + +
TopicClassification:
PublicFAQ
OperatingSystem:
OsSolaris
OsVersion:
2.5 
+

+Above template files will result in the following table when _editing_ a topic: +

+

+

TWikiCategory

+ + + + + + + + + + +
UseCategory +:
+ + + +
Yes   No, delete this category table   
+
TopicClassification +:
OperatingSystem +:
+  + 		 + + + + + +
OsSolaris   OsSunOS   OsHPUX   OsWin   
+
OsVersion +:
+
+

+ +

+(5) Implementation Notes +

+(under construction) +

+_Platform_ +

+TWiki is written in PERL, but it uses many shell command. The current implementation runs only on a Unix machine. RCS for revision control must be installed on the system. +

+_Files_ +

+

+.htaccess
+changes
+debug.txt
+edit
+error401.html
+mailnotify		automatic email notification, called by a cron job
+preview			preview topic, Perl script
+save
+search
+view
+wiki.pm
+wikicfg.pm
+
+

+

+ +

+(6) Installation Notes +

+These installation steps use Apache web server on Linux as an example. TWiki should run on other web servers and Unix systems as well. +

 +

+

+For debugging reasons, here are contents of directories with file permissions: +

+directory twiki/bin : +

+

+drwxr-xr-x	5 twiki	 t5				512 Nov 11 02:52 .
+drwxr-xr-x	5 twiki	 t5				512 Nov  6 02:57 ..
+drwxr-xr-x	6 twiki	 t5				512 Nov  6 03:13 data
+drwxr-xr-x	6 twiki	 t5				512 Nov  4 20:34 templates
+-rw-r--r--	1 twiki	 t5				430 Oct 21 18:51 .htaccess
+-rwxrwxrwx	1 twiki	 t5			  3752 Mar 27 02:21 attach
+-rwxr-xr-x	1 twiki	 t5			  2810 Oct 21 18:51 changes
+-rw-rw-rw-	1 twiki	 t5			  1091 Nov  6 04:15 debug.txt
+-rwxrwxrwx	1 twiki	 t5			  1244 Mar 27 02:21 delete
+-rw-r-xr-x	1 twiki	 t5			  2589 Nov  6 03:05 edit
+-rw-r--r--	1 twiki	 t5			  1097 Oct 21 18:51 error401.html
+-rwxr-xr-x	1 twiki	 t5			  4614 Oct 21 18:52 mailnotify
+-rw-r-xr-x	1 twiki	 t5			  1353 Oct 23 20:19 oops
+-rw-r-xr-x	1 twiki	 t5			  2043 Nov  6 03:05 preview
+-rw-r-xr-x	1 twiki	 t5			  6890 Nov 11 03:06 rdiff
+-rw-r-xr-x	1 twiki	 t5			  1819 Nov  6 03:06 save
+-rwxr-xr-x	1 twiki	 t5			  3174 Oct 21 18:51 search
+-rwxrwxrwx	1 twiki	 t5			  6696 Mar 27 02:22 upload
+-rw-r-xr-x	1 twiki	 t5			  3878 Nov 11 03:06 view
+-rwxrwxrwx	1 twiki	 t5			  1538 Mar 27 02:22 viewfile
+-rw-r-xr-x	1 twiki	 t5			 16169 Nov  7 01:43 wiki.pm
+-rw-r-xr-x	1 twiki	 t5			  3945 Jun 23 01:24 wikicfg.pm
+
+

+directory twiki/bin/templates/ : +

+

+drwxr-xr-x	6 twiki	 t5				512 Nov  4 20:34 .
+drwxr-xr-x	5 twiki	 t5				512 Nov 11 02:52 ..
+drwxr-xr-x	2 twiki	 t5				512 Oct 23 20:57 Know
+drwxr-xr-x	2 twiki	 t5				512 Nov  4 20:35 Main
+-rw-r--r--	1 twiki	 t5			  2232 Mar 27 02:03 attach.tmpl
+-rw-r--r--	1 twiki	 t5			  1200 Mar 27 02:03 attachtable.tmpl
+-rw-r--r--	1 twiki	 t5			  1751 Nov 11 02:41 changes.tmpl
+-rw-r--r--	1 twiki	 t5			  1711 Nov  6 03:01 edit.tmpl
+-rw-r--r--	1 twiki	 t5				896 Oct 21 18:51 mailnotify.tmpl
+-rw-r--r--	1 twiki	 t5				 25 Oct 21 18:51 notedited.tmpl
+-rw-r--r--	1 twiki	 t5				 21 Oct 21 18:51 notext.tmpl
+-rw-r--r--	1 twiki	 t5				157 Oct 23 21:05 notwiki.tmpl
+-rw-r--r--	1 twiki	 t5				218 Oct 23 20:06 noweb.tmpl
+-rw-r--r--	1 twiki	 t5				279 Oct 23 20:29 oops.tmpl
+-rw-r--r--	1 twiki	 t5				833 Mar 27 02:03 oopsdel.tmpl
+-rw-r--r--	1 twiki	 t5				868 Mar 27 02:03 oopsupload.tmpl
+-rw-r--r--	1 twiki	 t5			  2010 Nov  6 03:01 preview.tmpl
+-rw-r--r--	1 twiki	 t5			  1501 Nov 12 22:56 rdiff.tmpl
+-rw-r--r--	1 twiki	 t5			  1548 Oct 23 21:10 search.tmpl
+-rw-r--r--	1 twiki	 t5			  1541 Oct 26 21:07 view.tmpl
+
+

+directory twiki/bin/templates/Main : +

+

+drwxr-xr-x	2 twiki	 t5				512 Nov  4 20:35 .
+drwxr-xr-x	6 twiki	 t5				512 Nov  4 20:34 ..
+-rw-r--r--	1 twiki	 t5			  2328 Nov  6 03:03 edit.tmpl
+
+

+directory twiki/bin/templates/Know (has a TWiki Category Table) : +

+

+drwxr-xr-x	2 twiki	 t5				512 Nov  4 20:35 .
+drwxr-xr-x	6 twiki	 t5				512 Nov  4 20:34 ..
+-rw-r--r--	1 twiki	 t5				611 Dec  7 20:59 notedited.tmpl
+-rw-r--r--	1 twiki	 t5				210 Dec 24 23:22 twikicatedit.tmpl
+-rw-r--r--	1 twiki	 t5			  1887 Jan  6 20:54 twikicatitems.tmpl
+-rw-r--r--	1 twiki	 t5				245 Dec 24 23:27 twikicatview.tmpl
+
+

+directory twiki/bin/data/ : +

+

+drwxrwxrwx	6 twiki	 t5				512 Nov 19 01:01 .
+drwxr-xr-x	5 twiki	 t5				512 Nov 11 02:52 ..
+drwxrwxrwx	2 twiki	 t5			  9216 Nov 13 13:55 Know
+drwxrwxrwx	2 twiki	 t5			  4608 Nov 15 21:42 Main
+-rw-r--r--	1 nobody	65535		  4153 Nov 19 01:01 log199810.txt
+-rw-r--r--	1 nobody	65535		  7189 Nov 19 01:01 log199811.txt
+-rw-r--r--	1 twiki	 t5			  2356 Oct 22 00:56 webcopyright.inc
+-rw-r--r--	1 twiki	 t5				276 Oct 22 00:28 wikiwebs.inc
+-rw-r--r--	1 twiki	 t5			  1484 Oct 22 01:11 wikiwebtable.inc
+
+

+part of directory twiki/bin/data/Main : +

+

+drwxrwxrwx	2 twiki	 t5			  4608 Nov 19 00:56 .
+drwxrwxrwx	6 twiki	 t5				512 Nov 19 01:01 ..
+-rw-rw-rw-	1 twiki	 t5			  5974 Nov 15 21:42 .changes
+-rw-rw-rw-	1 twiki	 t5				  9 Nov 15 23:00 .mailnotify
+-rw-r--r--	1 nobody	65535		  1990 Nov  6 18:25 TWikiUsers.txt
+-r--r--r--	1 nobody	65535		  3045 Nov  6 18:25 TWikiUsers.txt,v
+-rw-r--r--	1 nobody	65535		  1181 Oct 29 20:54 WebHome.txt
+-r--r--r--	1 nobody	65535		  1537 Oct 29 20:54 WebHome.txt,v
+-rw-r--r--	1 nobody	65535			454 Oct 21 18:52 WebNotify.txt
+-r--r--r--	1 nobody	65535			638 Oct 27 02:45 WebNotify.txt,v
+-rw-r--r--	1 nobody	65535		  3653 Oct 21 18:52 WebSearch.txt
+-r--r--r--	1 nobody	65535		  3835 Oct 27 02:45 WebSearch.txt,v
+-rw-rw-rw-	1 twiki	 t5				  7 Oct 21 18:52 webcolor.inc
+-rw-rw-rw-	1 twiki	 t5				278 May 20 17:42 webcopyright.inc
+-rw-rw-rw-	1 twiki	 t5				402 Oct 26 07:45 weblist.inc
+
+

+directory twiki/pub/ : +

+

+drwxrwxrwx	4 twiki	 t5			  1024 Mar 27 02:58 .
+drwxr-xr-x	4 twiki	 t5			  1024 Mar 27 02:08 ..
+drwxrwxrwx	4 nobody	nobody		 1024 Mar 27 03:54 Main
+-rw-r--r--	1 twiki	 t5			  2877 Mar 27 02:27 wikiHome.gif
+drwxr-xr-x	2 twiki	 t5			  1024 Mar 27 03:17 icn
+
+

+directory twiki/pub/icn/ : +

+

+drwxr-xr-x	2 twiki	 t5			  1024 Mar 27 03:17 .
+drwxrwxrwx	4 twiki	 t5			  1024 Mar 27 02:58 ..
+-rw-r--r--	1 twiki	 t5				801 Mar 27 03:02 _filetypes.txt
+-rw-r--r--	1 twiki	 t5				143 Mar 27 03:16 bat.gif
+-rw-r--r--	1 twiki	 t5				926 Mar 27 03:16 bmp.gif
+-rw-r--r--	1 twiki	 t5				141 Mar 27 03:16 c.gif
+-rw-r--r--	1 twiki	 t5				144 Mar 27 03:16 dll.gif
+-rw-r--r--	1 twiki	 t5				152 Mar 27 03:16 doc.gif
+-rw-r--r--	1 twiki	 t5				130 Mar 27 03:16 else.gif
+-rw-r--r--	1 twiki	 t5				876 Mar 27 03:16 exe.gif
+-rw-r--r--	1 twiki	 t5				147 Mar 27 03:16 fon.gif
+-rw-r--r--	1 twiki	 t5				142 Mar 27 03:16 h.gif
+-rw-r--r--	1 twiki	 t5				156 Mar 27 03:16 hlp.gif
+-rw-r--r--	1 twiki	 t5				186 Mar 27 03:16 html.gif
+-rw-r--r--	1 twiki	 t5				144 Mar 27 03:16 java.gif
+-rw-r--r--	1 twiki	 t5				148 Mar 27 03:16 mov.gif
+-rw-r--r--	1 twiki	 t5				150 Mar 27 03:16 pdf.gif
+-rw-r--r--	1 twiki	 t5				146 Mar 27 03:16 pl.gif
+-rw-r--r--	1 twiki	 t5				150 Mar 27 03:16 ppt.gif
+-rw-r--r--	1 twiki	 t5				148 Mar 27 03:16 ps.gif
+-rw-r--r--	1 twiki	 t5				148 Mar 27 03:16 py.gif
+-rw-r--r--	1 twiki	 t5				130 Mar 27 03:17 ram.gif
+-rw-r--r--	1 twiki	 t5				154 Mar 27 03:17 reg.gif
+-rw-r--r--	1 twiki	 t5				147 Mar 27 03:17 sh.gif
+-rw-r--r--	1 twiki	 t5				155 Mar 27 03:17 sniff.gif
+-rw-r--r--	1 twiki	 t5				149 Mar 27 03:17 ttf.gif
+-rw-r--r--	1 twiki	 t5				134 Mar 27 03:17 txt.gif
+-rw-r--r--	1 twiki	 t5				154 Mar 27 03:17 wav.gif
+-rw-r--r--	1 twiki	 t5				152 Mar 27 03:17 wri.gif
+-rw-r--r--	1 twiki	 t5				152 Mar 27 03:17 xls.gif
+-rw-r--r--	1 twiki	 t5				144 Mar 27 03:17 zip.gif
+
+

+-- PeterThoeny - 22 Oct 1998
+-- PeterThoeny - 18 Nov 1998
+-- PeterThoeny - 11 Jan 1999
+-- PeterThoeny - 20 Jan 1999
+-- PeterThoeny - 06 Mar 1999
+-- PeterThoeny - 27 Mar 1999
+-- PeterThoeny - 02 Jun 1999
+-- PeterThoeny - 14 Jun 1999
+-- PeterThoeny - 23 Jun 1999
\ No newline at end of file -- 1.9.4