summaryrefslogtreecommitdiff
path: root/TWiki/TWikiImplementationNotes.mdwn
blob: 1c6ed07490fc019b62b7d02979eca844e01c0f00 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
**_Platform_**

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

**_Directories_**

<table border="1" cellpadding="1" cellspacing="0">
  <tr>
    <th bgcolor="#99CCCC"><strong>Directory:</strong></th>
    <th bgcolor="#99CCCC"><strong>Used for:</strong></th>
  </tr>
  <tr>
    <td> twiki/bin </td>
    <td> TWiki PERL scripts </td>
  </tr>
  <tr>
    <td> twiki/pub </td>
    <td> Public files (<span style="background:"><font color="">File Attachments</font></span><a href="http://LOCATION/FileAttachments">?</a>, images) </td>
  </tr>
  <tr>
    <td> twiki/data </td>
    <td> source text </td>
  </tr>
  <tr>
    <td> twiki/templates </td>
    <td> HTML templates, used by TWiki scripts </td>
  </tr>
</table>

**_Files in twiki/bin_**

<table border="1" cellpadding="1" cellspacing="0">
  <tr>
    <th bgcolor="#99CCCC"><strong>File:</strong></th>
    <th bgcolor="#99CCCC"><strong>Used for:</strong></th>
  </tr>
  <tr>
    <td> .htaccess.txt </td>
    <td> Authentication. Rename to .htaccess and customize if used </td>
  </tr>
  <tr>
    <td> attach </td>
    <td> Script that shows the attach file page (<span style="background:"><font color="">File Attachment</font></span><a href="http://LOCATION/FileAttachment">?</a>) </td>
  </tr>
  <tr>
    <td> changes </td>
    <td> Script that shows recent changes </td>
  </tr>
  <tr>
    <td> delete </td>
    <td> (not used yet) </td>
  </tr>
  <tr>
    <td> edit </td>
    <td> Script to edit a topic </td>
  </tr>
  <tr>
    <td> geturl </td>
    <td> Script to fetch URL data </td>
  </tr>
  <tr>
    <td> mailnotify </td>
    <td> Script called by cron job to notify users of changes </td>
  </tr>
  <tr>
    <td> oops </td>
    <td> Script that shows a OK or oops dialog </td>
  </tr>
  <tr>
    <td> preview </td>
    <td> Script to preview topic after edit </td>
  </tr>
  <tr>
    <td> rdiff </td>
    <td> Script to see differences of topics </td>
  </tr>
  <tr>
    <td> register </td>
    <td> Script to register new users </td>
  </tr>
  <tr>
    <td> save </td>
    <td> Script that saves a topic, called by preview </td>
  </tr>
  <tr>
    <td> search </td>
    <td> Script that displays search results </td>
  </tr>
  <tr>
    <td> statistics </td>
    <td> Script to create statistics topic </td>
  </tr>
  <tr>
    <td> testenv </td>
    <td> Script to test CGI environment variables </td>
  </tr>
  <tr>
    <td> upload </td>
    <td> Script that does file upload (<span style="background:"><font color="">File Attachment</font></span><a href="http://LOCATION/FileAttachment">?</a>) </td>
  </tr>
  <tr>
    <td> view </td>
    <td> Script to view a topic ( <strong>the</strong> script ) </td>
  </tr>
  <tr>
    <td> viewfile </td>
    <td> Script to view an file attachment </td>
  </tr>
  <tr>
    <td> wiki.pm </td>
    <td> main TWiki library </td>
  </tr>
  <tr>
    <td> wikicfg.pm </td>
    <td> for initialization and configuration, used by wiki.pm </td>
  </tr>
  <tr>
    <td> wikisearch.pm </td>
    <td> search engine, used by wiki.pm </td>
  </tr>
</table>

-- [[Main/PeterThoeny]] - 21 Apr 2000 <br />