From: MikeMannix Date: Wed, 29 Aug 2001 00:47:55 +0000 (+0000) Subject: none X-Git-Url: https://git.openafs.org/?p=openafs-wiki.git;a=commitdiff_plain;h=305c8b3deeb0307266639f4f50b4d8417919221b none --- diff --git a/TWiki/TWikiSystemRequirements.mdwn b/TWiki/TWikiSystemRequirements.mdwn index e8155f0..65d3e03 100644 --- a/TWiki/TWikiSystemRequirements.mdwn +++ b/TWiki/TWikiSystemRequirements.mdwn @@ -1,16 +1,36 @@ +
+ +
+ ## TWiki Implementation Notes -### Platform +### Platforms and System Requirements -TWiki is written in Perl 5 and also uses some shell commands. The current implementation runs best on a Unix machine, but it is also possible on Microsoft Windows. RCS (for revision control) must be installed on the system. +TWiki is written in **Perl 5** and also uses some **shell commands**. The current implementation runs best on a Unix machine, but it is also possible on Microsoft Windows. **RCS** (for revision control) must be installed on the system. [ **_MM: Locate elsewhere and/or include one-liner and link for RCS..._** ] - - + + @@ -26,7 +46,7 @@ TWiki is written in Perl 5 and also uses some shell commands. The current implem - + @@ -43,42 +63,76 @@ TWiki is written in Perl 5 and also uses some shell commands. The current implem + + + + +
Required Environment by Platform
Package(s): Unix: Packages: Linux/Unix: Windows:
Optional Perl modules Net::SMTP (or sendmail) Net::SMTPNet::SMTP
RCS Apache Apache, IIS
OS versionsLinux, Unix...every last Win?!
### Directory Structure +You can easily rename the root TWiki directory - **twiki** - to whatever you like by changing a configuration file value. For the simplest installation and future upgrades, you should leave the subdirectory structure exactly as is: + + + + + + + - + + + + + + + - + + - + + - + + - + + +
Directory: Files: Used for:
twiki[[Main/WebHome#TWikiFiles]] Start-up info
twiki/bin TWiki Perl scripts [[Main/WebHome#BinFiles]] Perl scripts
twiki/lib[[Main/WebHome#LibFiles]] Configuration file & main library
twiki/lib/TWiki TWiki Perl modules [[Main/WebHome#LibTWiki]] Perl modules
twiki/lib/TWiki/Plugins Plugins modules [[Main/WebHome#libtwikiplugins]][[Main/TWikiPlugins]] Perl modules
twiki/pub Public files ([[Main/FileAttachments]], images), plus RCS histories [[Main/WebHome#PubFiles]] Public support files (ex: [[Main/FileAttachments]], images) and RCS histories)
twiki/data source (topic) text, including RCS histories [[Main/WebHome#DataFiles]] Topic text (page content) and RCS histories;
twiki/templates[[Main/WebHome#TemplatesFiles]] HTML templates, used by TWiki scripts
-#### Files in twiki/bin +**_Note: about the additional directories in data, elsewhere_** + + + +#### Files in `twiki` + +**_to follow_** + + + +#### Files in `twiki/bin` @@ -159,7 +213,9 @@ TWiki is written in Perl 5 and also uses some shell commands. The current implem
-#### Files in twiki/lib + + +#### Files in `twiki/lib` @@ -172,11 +228,13 @@ TWiki is written in Perl 5 and also uses some shell commands. The current implem - +
TWiki.cfg For initialization and configuration, used by TWiki.pm For configuration, used by TWiki.pm
-#### Files in twiki/lib/TWiki + + +#### Files in `twiki/lib/TWiki` @@ -217,7 +275,9 @@ TWiki is written in Perl 5 and also uses some shell commands. The current implem
-#### Files in twiki/lib/TWiki/Plugins + + +#### Files in `twiki/lib/TWiki/Plugins` @@ -238,4 +298,22 @@ TWiki is written in Perl 5 and also uses some shell commands. The current implem
--- [[MikeMannix]] - 26 Aug 2001 + + +#### Files in `twiki/pub` + +**_to follow_** + + + +#### Files in `twiki/data` + +**_to follow_** + + + +#### Files in `twiki/templates` + +**_to follow_** + +-- [[MikeMannix]] - 28 Aug 2001 diff --git a/TWiki/TWikiVariables.mdwn b/TWiki/TWikiVariables.mdwn index 7ff34fd..d04bd6f 100644 --- a/TWiki/TWikiVariables.mdwn +++ b/TWiki/TWikiVariables.mdwn @@ -1,8 +1,10 @@
@@ -10,6 +12,10 @@ ## TWiki Variables +### About Variables + +**_Include/write if not found elsewhere._** + ### Predefined Variables %WIKITOOLNAME% expands the following variables enclosed in % percent signs: @@ -252,7 +258,7 @@ 2 digit year 99 - Variables can be shortened to 3 characters. Example:
%GMTIME{"$day $month, $year - $hour:$min:$sec"}% is
29 Jun, 2010 - 15:27:28 + Variables can be shortened to 3 characters. Example:
%GMTIME{"$day $month, $year - $hour:$min:$sec"}% is
29 Jun, 2010 - 15:27:35 %SERVERTIME% @@ -568,11 +574,11 @@ Additional variables are defined in the preferences ( site-level ( **_SL_** ) in -**_Notes:_** +### Setting and Creating New Preferences -- Preferences variables ( on site-level, web-level and user level ) are defined by bullet lines with this syntax: - - `Set VARIABLENAME = value` -- Additional preferences variables can be defined on all three level as needed. Example: - - `Set MYLOGO = %PUBURLPATH%/%MAINWEB%/LogoTopic/logo.gif` +- The syntax for Preferences variables is the same anywhere in TWiki. In Edit mode, from the start of a new line:
[6 spaces] \* [space] Set [space] VARIABLENAME [space] = [value]
**_Example:_** + - **Set VARIABLENAME = value** +- You can add your own preference variables for an entire site, a single web, or a single topic, using the standard syntax. Whatever you include in your variable will be expanded on display, and treated exactly as if it had been written out. So you can place formatted text, page links, images.
**_Example:_** To place a logo anywhere in a web by typing **%MYLOGO%**, define the variable in the web's [[WebPreferences]] topic, like this (in this case, you also have to upload **logo.gif** to the same directory): + - **Set MYLOGO = %PUBURLPATH%/%MAINWEB%/LogoTopic/logo.gif** --- [[PeterThoeny]] - 23 Jul 2001
-- [[MikeMannix]] - 26 Aug 2001
+-- [[MikeMannix]] - 26 Aug 2001