[docs] xmldocs - docelic modified 3 files

docs at icdevgroup.org docs at icdevgroup.org
Sat Aug 20 15:27:26 EDT 2005


User:      docelic
Date:      2005-08-20 19:27:25 GMT
Modified:  glossary pragma ITL
Modified:  refs     no_default_reparse
Log:
- Distribute no_default_reparse docs to proper places:
  pragma and ITL glossary entries

- Remove example of catalog-wide pragma setting, because this is
  shown in pragma glossary entry

Revision  Changes    Path
1.5       +26 -10    xmldocs/glossary/pragma


rev 1.5, prev_rev 1.4
Index: pragma
===================================================================
RCS file: /var/cvs/xmldocs/glossary/pragma,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- pragma	15 Dec 2004 14:24:00 -0000	1.4
+++ pragma	20 Aug 2005 19:27:25 -0000	1.5
@@ -1,17 +1,33 @@
-Pragmas are used to control various aspects of page and data parsing and display. They are processed before an Interchange page goes to the normal processing
+Pragmas are used to control various aspects of page and data parsing and display. They are processed before an ⁣ page goes to the normal processing
 routine.
 </para><para>
-Pragma values can be defined catalog-wide, page-wide and ITL-block wide.
+Pragma values can be defined at any level; catalog-wide, page-wide or
+&glos-ITL;-block wide.
 To define a pragma catalog-wide, use the <option>Pragma</option> directive:
-<cmdsynopsis>Pragma NAME <group choice='req'><arg choice='plain'>0</arg><arg choice='plain'>1</arg><arg choice='plain'>=<replaceable>pragma-specific value</replaceable></arg></group>
-</cmdsynopsis>
+<programlisting>
+Pragma <replaceable>NAME</replaceable> <group choice='req'><arg choice='plain'>0</arg><arg choice='plain'>1</arg><arg choice='plain'>=<replaceable>pragma-specific value</replaceable></arg></group>
+</programlisting>
 </para><para>
-To define a pragma value for a particular page, use the <tag>pragma</tag> tag anywhere on a page: <code>[pragma NAME]</code> to enable, or
-<code>[pragma NAME 0]</code> to disable.
+To define a pragma for a particular page, use the &tag-pragma;
+tag anywhere on a page. For readability, however, we suggest to always 
+define pragmas at the top.
 </para><para>
-To define a pragma for a small ITL block inside the page, enclose the block in <code>[tag pragma NAME]1[/tag]...[tag pragma NAME]0[/tag]</code>.
+The following two lines, of which you would 
+usually use only one at a time, present pragma activation and deactivation:
+<programlisting>
+[pragma <replaceable>NAME</replaceable>]
+[pragma <replaceable>NAME</replaceable> 0]
+</programlisting>
 </para><para>
-Starting with Interchange 5.0, the <code>$::Pragma->{name}</code> syntax is used in the Interchange source instead of the old <code>$Vend::Cfg->{Pragma}{name}</code>.
+To define a pragma for a &glos-ITL; block inside the page, enclose the
+block in <code>[tag pragma ...]</code>:
+<programlisting>
+[tag pragma <replaceable>NAME</replaceable>]1[/tag]
+  ...
+[tag pragma <replaceable>NAME</replaceable>]0[/tag]
+</programlisting>
+</para><para>
+Starting with Interchange 5.0, the <code>$::Pragma->{name}</code> syntax
+is used in the &IC; source, instead of the old
+<code>$Vend::Cfg->{Pragma}{name}</code>.
 
-<!-- <glosssee otherterm="sgml"/>
-<glossseealso otherterm="globvar">Global variable</glossseealso> -->



1.12      +5 -0      xmldocs/glossary/ITL


rev 1.12, prev_rev 1.11
Index: ITL
===================================================================
RCS file: /var/cvs/xmldocs/glossary/ITL,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
--- ITL	15 Jun 2005 10:30:11 -0000	1.11
+++ ITL	20 Aug 2005 19:27:25 -0000	1.12
@@ -453,6 +453,11 @@
 [value name] was here
 </programlisting>
 
+</para><para>
+In &IC; 5.3.1, the &pragma-no_default_reparse; pragma was added, which 
+disables the default reparsing of container tags' output. It is therefore
+advisable to always specify the <literal>reparse=1</literal> attribute at
+places where you want reparsing to really occur.
 
 </para><para> <sbr/><sbr/>
 The third attribute, <arg choice='plain'>send</arg>, was deprecated long ago



1.3       +3 -19     xmldocs/refs/no_default_reparse


rev 1.3, prev_rev 1.2
Index: no_default_reparse
===================================================================
RCS file: /var/cvs/xmldocs/refs/no_default_reparse,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- no_default_reparse	20 Aug 2005 17:12:22 -0000	1.2
+++ no_default_reparse	20 Aug 2005 19:27:25 -0000	1.3
@@ -22,31 +22,15 @@
 </para><para>
 Reparsing can, of course, still be requested by the
 <literal>Reparse</literal> setting
-in individual &glos-ITL; tag definition, or by providing the
-<literal>reparse=1</literal> attribute to the tag.
-</para><para>
-Because this pragma exists, and can be set at the page- or even
-catalog-wide level, it is wise to always specify reparse=1 when you
-really need the output from a container tag to be reparsed, so it will
-work regardless of later changes to this pragma setting.
+in individual &glos-ITL; tag definitions, or by providing the
+universal <literal>reparse=1</literal> attribute to the tags.
 __END__
 
 
 __NAME__ example: Enable no_default_reparse pragma page-wide
-Put the following anywhere on your page (at the top, to be most polite
-to other developers):
+Put the following anywhere on your page:
 <programlisting>
 [pragma no_default_reparse]
 </programlisting>
-__END__
-
-
-__NAME__ example: Enable no_default_reparse pragma catalog-wide
-Put this directive in catalog.cfg (or any file included from it):
-<programlisting>
-Pragma no_default_reparse
-</programlisting>
-If you experience any unexpected reparse behavior, check catalog.cfg
-and any included files, to see if someone added or removed this pragma.
 __END__
 








More information about the docs mailing list