friedkiwi/ibm-information-center
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
14ed2849c6
ibm-information-center/dist/eclipse/plugins/i5OS.ic.rzaie_5.4.0.1/rzaiemod_include.htm

232 lines
15 KiB
HTML
Raw Normal View History

Add readme and dist folders
2024-04-02 14:02:31 +00:00
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html lang="en-us" xml:lang="en-us">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="security" content="public" />
<meta name="Robots" content="index,follow" />
<meta http-equiv="PICS-Label" content='(PICS-1.1 "http://www.icra.org/ratingsv02.html" l gen true r (cz 1 lz 1 nz 1 oz 1 vz 1) "http://www.rsac.org/ratingsv01.html" l gen true r (n 0 s 0 v 0 l 0) "http://www.classify.org/safesurf/" l gen true r (SS~~000 1))' />
<meta name="DC.Type" content="topic" />
<meta name="DC.Title" content="Module mod_include" />
<meta name="copyright" content="(C) Copyright IBM Corporation 2002,2006" />
<meta name="DC.Rights.Owner" content="(C) Copyright IBM Corporation 2002,2006" />
<meta name="DC.Format" content="XHTML" />
<meta name="DC.Identifier" content="rzaiemod_include" />
<meta name="DC.Language" content="en-us" />
<!-- All rights reserved. Licensed Materials Property of IBM -->
<!-- US Government Users Restricted Rights -->
<!-- Use, duplication or disclosure restricted by -->
<!-- GSA ADP Schedule Contract with IBM Corp. -->
<link rel="stylesheet" type="text/css" href="./ibmdita.css" />
<link rel="stylesheet" type="text/css" href="./ic.css" />
<title>Module mod_include</title>
</head>
<body id="rzaiemod_include"><a name="rzaiemod_include"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<!--Java sync-link--><h1 class="topictitle1">Module mod_include</h1>
<div><div class="important"><span class="importanttitle">Important:</span> Information
for this topic supports the latest PTF levels for HTTP Server for i5/OS .
It is recommended that you install the latest PTFs to upgrade to the latest
level of the HTTP Server for i5/OS. Some of the topics documented here are
not available prior to this update. See <a href="http://www-03.ibm.com/servers/eserver/iseries/software/http/services/service.html" target="_blank">http://www.ibm.com/servers/eserver/iseries/software/http/services/service.htm</a> <img src="www.gif" alt="Link outside Information Center" /> for more information. </div>
<p><strong>Summary</strong></p>
<p>The module mod_include provides for server-parsed html documents. </p>
<div class="note"><span class="notetitle">Note:</span> A configuration change is required in order for mod_include to work
correctly. Previously, mod_include was a handler, and the config file had
a AddHandler server-parsed .htmls directive in order to define mod_include
as a handler for extensions of .htmls. mod_include is now a filter. Thus,
the AddHandler directive no longer applies. Directive AddOutputFilter must
be used and associated with a file extension, much like directive AddHandler.
For example:</div>
<pre class="block">AddOutputFilter INCLUDES .shtml</pre>
<p><strong>Enabling Server-Side Includes</strong></p>
<p>Server-Side Includes (SSI) are implemented by the INCLUDES filter. If documents
containing SSI directives are given the extension .shtml, the following directives
makes the HTTP Server parse and assign the resulting documents as MIME type
text/html. For example: </p>
<pre class="block">AddType text/html .shtml
AddOutputFilter INCLUDE .sthml</pre>
<p>The following directive must be given for the directories containing the
shtml files (typically in a &lt;Directory&gt; section, but this directive is
also valid .htaccess files if AllowOverride Options is set). For example:</p>
<pre class="block">Options +Includes</pre>
<p>See the <a href="rzaiemod_core.htm#options">Options</a> directive
for more information. </p>
<div class="note"><span class="notetitle">Note:</span> The iSeries™ system
does not support XBitHack to enable server-side includes. </div>
<p><strong>Directives</strong></p>
<ul><li><a href="#ssiendtag">SSIEndTag</a></li>
<li><a href="#ssierrormsg">SSIErrorMsg</a></li>
<li><a href="#ssistarttag">SSIStartTag</a></li>
<li><a href="#ssitimeformat">SSITimeFormat</a></li>
<li><a href="#ssiundefinedecho">SSIUndefinedEcho</a></li>
</ul>
</div>
<div class="hr" id="ssiendtag"><a name="ssiendtag"><!-- --></a><h2 class="topictitle2">SSIEndTag</h2>
<div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="void" border="0" rules="none"><tbody><tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Module">Module</a></strong>: mod_include </td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Syntax">Syntax</a></strong>: SSIEndTag <em>string</em></td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Default">Default</a></strong>: SSIEndTag "--&gt;"</td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Context">Context</a></strong>: <span id="ssiendtag__ssiendtag_context"><a name="ssiendtag__ssiendtag_context"><!-- --></a>server config,
virtual host</span></td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Override">Override</a></strong>: none </td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Origin">Origin</a></strong>: <span id="ssiendtag__ssiendtag_origin"><a name="ssiendtag__ssiendtag_origin"><!-- --></a>Apache </span></td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Example">Example</a></strong>: SSIEndTag "--&gt;"</td>
</tr>
</tbody>
</table>
</div>
<p>The SSIEndTag directive changes the string that mod_include looks for to
mark the end of a include command. </p>
<dl class="block"><dt class="dlterm"><strong>Parameter</strong>: <em>string </em></dt>
<dd><ul><li>The <em>string</em> parameter represents the string that mod_include looks
for to mark the end of a include command. </li>
</ul>
</dd>
</dl>
</div>
</div>
<div class="hr" id="ssierrormsg"><a name="ssierrormsg"><!-- --></a><h2 class="topictitle2">SSIErrorMsg</h2>
<div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="void" border="0" rules="none"><tbody><tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Module">Module</a></strong>: mod_include </td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Syntax">Syntax</a></strong>: SSIErrorMsg <em>string</em></td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Default">Default</a></strong>: SSIErrorMsg "[an error occurred while processing
this directive]"</td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Context">Context</a></strong>: <span id="ssierrormsg__ssierrormsg_context"><a name="ssierrormsg__ssierrormsg_context"><!-- --></a>server config,
virtual host, directory, .htaccess </span></td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Override">Override</a></strong>: none </td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Origin">Origin</a></strong>: <span id="ssierrormsg__ssierrormsg_origin"><a name="ssierrormsg__ssierrormsg_origin"><!-- --></a>Apache </span></td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Example">Example</a></strong>: SSIErrorMsg "This is the default error
message"</td>
</tr>
</tbody>
</table>
</div>
<p>This SSIErrorMsg directive defines the default error message that is used
when an error is encountered while processing SSI tags in a file. This configuration
directive can be used instead of the <strong>config errmsg</strong> SSI tag. </p>
<dl class="block"><dt class="dlterm"><strong>Parameter</strong>: <em>string </em></dt>
<dd><ul><li>The string parameter defines the default error message that is used when
an error is encountered while processing SSI tags in a file. For example:<pre class="block">SSIErrorMsg "This is the default error message"</pre>
</li>
</ul>
</dd>
</dl>
</div>
</div>
<div class="hr" id="ssistarttag"><a name="ssistarttag"><!-- --></a><h2 class="topictitle2">SSIStartTag</h2>
<div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="void" border="0" rules="none"><tbody><tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Module">Module</a></strong>: mod_include </td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Syntax">Syntax</a></strong>: SSIStartTag <em>string</em></td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Default">Default</a></strong>: SSIStartTab "&lt;!--#"</td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Context">Context</a></strong>: <span id="ssistarttag__ssistarttag_context"><a name="ssistarttag__ssistarttag_context"><!-- --></a>server config,
virtual host</span></td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Override">Override</a></strong>: none </td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Origin">Origin</a></strong>: <span id="ssistarttag__ssistarttag_origin"><a name="ssistarttag__ssistarttag_origin"><!-- --></a>Apache </span></td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Example">Example</a></strong>: SSIStartTab "&lt;!--#"</td>
</tr>
</tbody>
</table>
</div>
<p>The SSIEndTag directive changes the string that mod_include looks for to
mark an include element to process. You may want to use this option if have
2 servers parsing the output of a file (each processing different commands,
possibly at different times). </p>
<dl class="block"><dt class="dlterm"><strong>Parameter</strong>: <em>string </em></dt>
<dd><ul><li>The <em>string</em> parameter represents the string that mod_include looks
for to mark an include element to process. </li>
</ul>
</dd>
</dl>
</div>
</div>
<div class="hr" id="ssitimeformat"><a name="ssitimeformat"><!-- --></a><h2 class="topictitle2">SSITimeFormat</h2>
<div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="void" border="0" rules="none"><tbody><tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Module">Module</a></strong>: mod_include </td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Syntax">Syntax</a></strong>: SSITimeFormat <em>strftime string</em></td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Default">Default</a></strong>: SSITimeFormat "%A, %d-%b-%Y %H:%M:%S %Z" </td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Context">Context</a></strong>: <span id="ssitimeformat__ssitimeformat_context"><a name="ssitimeformat__ssitimeformat_context"><!-- --></a>server config,
virtual host, directory, .htaccess </span></td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Override">Override</a></strong>: none </td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Origin">Origin</a></strong>: <span id="ssitimeformat__ssitimeformat_origin"><a name="ssitimeformat__ssitimeformat_origin"><!-- --></a>Apache </span></td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Example">Example</a></strong>: SSITimeFormat "%H:%M:%S %m-%d-%y" </td>
</tr>
</tbody>
</table>
</div>
<p>The SSITimeFormat directive defines the default dates/times format that
are returned to the browser while processing SSI tags. This configuration
directive can be used instead of the config timefmt SSI tag. </p>
<dl class="block"><dt class="dlterm"><strong>Parameter</strong>: <em>strftime string </em></dt>
<dd><ul><li>The <em>strftime string</em> parameter defines the default dates/times format
that are returned to the browser while processing SSI tags. For example, <pre class="block">SSITimeFormat "%H:%M:%S %m-%d-%y"</pre>
</li>
</ul>
</dd>
</dl>
<p>See <a href="rzaiessicommands.htm">Server-side include commands for HTTP Server</a> for a list
of supported server-side include directives.</p>
<div class="note"><span class="notetitle">Note:</span> HTTP Server (powered by Apache) does not support the %Z (time zone)
format.</div>
</div>
</div>
<div class="hr" id="ssiundefinedecho"><a name="ssiundefinedecho"><!-- --></a><h2 class="topictitle2">SSIUndefinedEcho</h2>
<div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="void" border="0" rules="none"><tbody><tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Module">Module</a></strong>: mod_include </td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Syntax">Syntax</a></strong>: SSIUndefinedEcho <em>string</em></td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Default">Default</a></strong>: SSIUndefinedEcho "(none)" </td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Context">Context</a></strong>: <span id="ssiundefinedecho__ssiundefinedecho_context"><a name="ssiundefinedecho__ssiundefinedecho_context"><!-- --></a>server
config, virtual host</span></td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Override">Override</a></strong>: none </td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Origin">Origin</a></strong>: <span id="ssiundefinedecho__ssiundefinedecho_origin"><a name="ssiundefinedecho__ssiundefinedecho_origin"><!-- --></a>Apache </span></td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Example">Example</a></strong>: SSIUndefinedEcho "The value on an SSI Echo
request is not defined"</td>
</tr>
</tbody>
</table>
</div>
<p>The SSIUndefinedEcho directive is used to define the default message that
is used when an "echo" SSI tag is requesting a variable whose value has not
been set. </p>
<dl class="block"><dt class="dlterm"><strong>Parameter</strong>: <em>string </em></dt>
<dd><ul><li>The <em>string</em> parameter defines the default message that is used when
an "echo" SSI tag is requesting a variable whose value has not been set. </li>
</ul>
</dd>
</dl>
</div>
</div>
</body>
</html>
Reference in New Issue Copy Permalink