[docs] xmldocs - docelic modified 2 files

docs at icdevgroup.org docs at icdevgroup.org
Sun Sep 26 16:48:00 EDT 2004


User:      docelic
Date:      2004-09-26 20:48:00 GMT
Added:     refs     download
Removed:   refs     deliver
Log:
PEH! I was distracted and commited a mistake ;-)
Renaming deliver -> download.

** Preserving the commit message:
Ok, documented the 'download' pragma.

At this point we have all pragmas documented, including the most recent
one - no_html_comment_embed.

One small milestone reached ;-)

Revision  Changes    Path
1.1                  xmldocs/refs/download


rev 1.1, prev_rev 1.0
Index: download
===================================================================
__NAME__ purpose
Disable any output interpolation not to corrupt verbatim content download
__END__


__NAME__ synopsis
<group choice='req'>
	<arg choice='plain'>0</arg>
	<arg choice='plain'>1</arg>
</group>
__END__


__NAME__ default
0
__END__


__NAME__ description
The main function of this pragma is to prevent any interpolation of the output.
It helps to preserve the downloads intact if they 
happen to contain constructs similar to
<literal>__<replaceable>VAR</replaceable>__</literal> 
or <literal>[tag]</literal>.
</para><para>
In practice, this pragma is only used internally. If
you wanted to make Interchange a content-delivery engine only, you could
set it in <filename>catalog.cfg</filename>, and only undefine it for a few
pages where you want standard page processing.
</para><para>
You might take a look at the <tag>deliver</tag> tag which uses this
pragma.
__END__


__NAME__ example
<example>
	<title>Disable download pragma on a page</title>
	<para>
	Put the following anywhere on your specific page:
	</para>
	<programlisting>
[pragma download 0]
	</programlisting>
</example>
__END__









More information about the docs mailing list