[docs] xmldocs - docelic modified 4 files

[docs at icdevgroup.org]

User:      docelic
Date:      2004-08-13 21:16:43 GMT
Added:     refs/env control description example example2
Log:
Document the [env] tag

Revision  Changes    Path
1.1                  xmldocs/refs/env/control


rev 1.1, prev_rev 1.0
Index: control
===================================================================
# The usual comments can be used here. 
# To override a field, supply a value
# To let it through unmodified, simply leave the fields empty

#  purpose: oneline description (MUST FILL IN)
purpose: provides read-only access to the HTTP environment variables
#  default value if applicable (make it short, just like: 0, none, ...)
default:
# Please take time to fill in the See Also line.
#  Just name the related symbols. The system will work everything out.
#  (Note that if you link some item from here, that item will auto-point
#  back here (under "indirect links" section))
see also: var

# If the autogenerated list of missing elements for an item is not
# enough (that is, you need more "personal touch" to describe the missing
# elements), use this field. You can also use "missing:" multiple times:
missing:

# Usually not needed to modify below

#  id: name of the output file (defaults to <name>)
id:
#  name: visible name in the pages
name:
#  specify person(s). Defaults to icdevgroup
author: Ed LaFrance
#  leave empty; GPL is the default
copyright:



1.1                  xmldocs/refs/env/description


rev 1.1, prev_rev 1.0
Index: description
===================================================================
The <tag>env</tag> tag provides read-only access to the HTTP evironment
variables. It can both display a specific variable as-is, or produce a 
complete list of variables and values in a simple HTML table.
</para> <para>
The list display is useful for simple debugging or diagnostics.



1.1                  xmldocs/refs/env/example


rev 1.1, prev_rev 1.0
Index: example
===================================================================
<example>

<title>
Display the client remote address and port
</title>

<para>
The client's remote address and port are kept in <envar>REMOTE_ADDR</envar>
and <envar>REMOTE_PORT</envar> variables.
</para>

<programlisting><![CDATA[
Client connection: [env REMOTE_ADDR]:[env name="REMOTE_PORT"]
]]></programlisting>

</example>



1.1                  xmldocs/refs/env/example2


rev 1.1, prev_rev 1.0
Index: example2
===================================================================
<example>

<title>
Display the simple HTML table with the complete HTTP environment
</title>

<programlisting><![CDATA[
HTTP environment: <br>
[env]
]]></programlisting>

</example>