From 3f25760c651cc13f5c47060242ba24a2e0c0d7ff Mon Sep 17 00:00:00 2001 From: brian Date: Thu, 28 Nov 1996 04:08:38 +0000 Subject: [PATCH] Added text from Howard Fear on new functionality in 1.2's SSI. git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@77076 13f79535-47bb-0310-9956-ffa450edef68 --- docs/manual/mod/mod_include.html | 132 ++++++++++++++++++++++++++----- 1 file changed, 114 insertions(+), 18 deletions(-) diff --git a/docs/manual/mod/mod_include.html b/docs/manual/mod/mod_include.html index b01b8985da..f8466ed9e9 100644 --- a/docs/manual/mod/mod_include.html +++ b/docs/manual/mod/mod_include.html @@ -6,32 +6,37 @@ -

Module mod_include

This module is contained in the mod_include.c file, and -is compiled in by default. It provides for server-parsed html documents, -known as SPML documents. -Any document with mime type text/x-server-parsed-html or +is compiled in by default. It provides for server-parsed html +documents, known as SPML documents. Any document with mime type +text/x-server-parsed-html or text/x-server-parsed-html3 will be parsed by this module, with the resulting output given the mime type text/html. - - +Several directives beyond the original NCSA SPML definition have been +included in Apache 1.2 - these are flagged below with the phrase +"Apache 1.2 and above". Of particular significance are the new flow +control directives documented at the bottom. -

SPML -- Include file Format

Basic Elements

The document is parsed as an HTML document, with special commands embedded as SGML comments. A command has the syntax: +

+ The value will often be enclosed in double quotes; many commands only allow a single attribute-value pair.

The allowed elements are:

config

- This command controls various aspects of the parsing. The valid attributes are:

echo

- This command prints one of the include variables, defined below. If the variable is unset, it is printed as (none). Any dates printed are subject to the currently configured timefmt. @@ -61,14 +65,12 @@ Attributes:

exec

- The exec command executes a given shell command or CGI script. The IncludesNOEXEC Option disables this command completely. The valid attributes are:

cgi

- The value specifies a (%-encoded) URL relative path to the CGI script. If the path does not begin with a (/), then it is taken to be relative to the current document. The document referenced by this path is invoked @@ -76,8 +78,6 @@ as a CGI script, even if the server would not normally recognise it as such. However, the directory containing the script must be enabled for CGI scripts (with ScriptAlias or the ExecCGI Option).

- - The CGI script is given the PATH_INFO and query string (QUERY_STRING) of the original request from the client; these cannot be specified in the URL path. The include variables will be available to the script in addition to the @@ -93,7 +93,6 @@ The include variables are available to the command.

fsize

- This command prints the size of the specified file, subject to the sizefmt format specification. Attributes:

@@ -107,13 +106,13 @@ to the current document.

flastmod -

This command prints the last modification date of the specified file, subject to the timefmt format specification. The attributes are the same as for the fsize command.

include -

This command inserts the text of another document or file into the parsed file. Any included file is subject to the usual access control. If the directory containing the parsed file has the @@ -142,11 +141,31 @@ is taken to be relative to the current document. A URL is constructed from the attribute, and the output the server would return if the URL were accessed by the client is included in the parsed output. Thus included files can be nested. + +

printenv +

This prints out a listing of all existing variables and their values. + No attributes. +

For example:  +

Apache 1.2 and above. + +

set +

This sets the value of a variable. Attributes: +

var +: The name of the variable to set. +
value +: The value to give a variable. +

+For example: +  +

Apache 1.2 and above. +

Include variables

-These are available for the echo command, and to any program -invoked by the document. + +In addition to the variables in the standard CGI environment, these are available for the echo command, for if and elif, and to any program invoked by the document. +

DATE_GMT: The current date in Greenwich Mean Time. @@ -164,6 +183,83 @@ current document.

Flow Control Elements

+ +These are available in Apache 1.2 and above. The basic flow control +elements are: + +

+    <!--#if expr="test_condition" -->
+    <!--#elif expr="test_condition" -->
+    <!--#else -->
+    <!--#endif -->
+

+ +

The if element works like an + if statement in a programming language. The test condition + is evaluated and if the result is true, then the text until + the next elif, else. + or endif element is included in the + output stream. + +

The elif or else + statements are be used the put text into the output stream + if the original test_condition was false. These elements + are optional. + +

The endif element ends the + if element and is required. + +

test_condition is one of the following: + +

string: true if string is not empty + +
string1 = string2 + string1 != string2 + +: Compare string1 with string 2. If string2 has the form /string/ + than it is compared as a regular expression. + Regular expressions have the same syntax as those found in the + Unix egrep command. + +
( test_condition ): true if test_condition is true +
! test_condition: true if test_condition is false + test_condition1 and test_condition2 are true +
test_condition1 && test_condition2: true if both + test_condition1 and test_condition2 are true +
test_condition1 || test_condition2: true if either + test_condition1 or test_condition2 is true +

+ +

"=" and "!=" bind more tightly than "&&" and "||". + "!" binds most tightly. Thus, the following are equivalent: + +

+    <!--#if expr="$a = test1 && $b = test2" -->
+    <!--#if expr="($a = test1) && ($b = test2)" -->
+

+ +

Anything that's not recognized as a variable or an operator is + treated as a string. Strings can also be quoted: 'string'. + Unquoted strings can't contain whitespace (blanks and tabs) + because it is used to seperate tokens such as variables. If + multiple strings are found in a row, they are concatenated using + blanks. So, + +

+     string1    string2  results in string1 string2
+    'string1    string2' results in string1    string2
+

+ +

Variable substitution is done within quoted strings. You can put + a dollar sign into the string using backslash quoting: + +

+    <!--#if expr="$a = \$test" -->
+

Directives

-- 2.40.0