[interchange-docs] xmldocs - docelic modified 19 files

docs at icdevgroup.org docs at icdevgroup.org
Mon Nov 6 17:34:45 EST 2006


User:      docelic
Date:      2006-11-06 22:34:45 GMT
Modified:  glossary pragma
Modified:  refs     compatible_5_2 download dynamic_variables
Modified:           dynamic_variables_file_only
Modified:           interpolate_itl_references no_default_reparse
Modified:           no_html_comment_embed no_locale_parse
Modified:           perl_warnings_in_page
Modified:  refs/init_page synopsis
Modified:  refs/no_html_parse synopsis
Modified:  refs/no_image_rewrite synopsis
Modified:  refs/post_page synopsis
Modified:  refs/pre_page synopsis
Modified:  refs/safe_data notes synopsis
Modified:  refs/strip_white synopsis
Modified:  refs/substitute_table_image synopsis
Log:
* Remove { } brackets around synopsis for IC pragmas, and make minimal
  content updates/fixes spotted along the way

Revision  Changes    Path
1.7       +4 -5      xmldocs/glossary/pragma


rev 1.7, prev_rev 1.6
Index: pragma
===================================================================
RCS file: /var/cvs/xmldocs/glossary/pragma,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- pragma	12 Aug 2006 22:43:11 -0000	1.6
+++ pragma	6 Nov 2006 22:34:44 -0000	1.7
@@ -8,7 +8,7 @@
 <note><para>
 Catalog-wide pragmas are equivalent to inserting <code>[pragma ...]</code>
 on every page. However, setting the &conf-Pragma; catalog directive (instead of
-using &tag-pragma; tag all the time) has the benefit of initializing at 
+using the &tag-pragma; tag all the time) has the benefit of initializing at 
 catalog startup time (so, only once),  which avoids extra hash key lookups.
 Namely, there is some crossover point at about 4 &PERL; references where it
 saves processor power to assign a scalar instead of looking it up every time.
@@ -24,7 +24,6 @@
 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>
 The following two lines, of which you would 
 usually use only one at a time, present pragma activation and deactivation:
 <programlisting>
@@ -32,7 +31,7 @@
 [pragma <replaceable>NAME</replaceable> 0]
 </programlisting>
 </para><para>
-To define a pragma for a &glos-ITL; block inside the page, enclose the
+To define a pragma for an &glos-ITL; block inside the page, enclose the
 block in <code>[tag pragma ...]</code>:
 <programlisting>
 [tag pragma <replaceable>NAME</replaceable>]1[/tag]
@@ -40,8 +39,8 @@
 [tag pragma <replaceable>NAME</replaceable>]0[/tag]
 </programlisting>
 </para><para>
-Starting with Interchange 5.0, the <code>$::Pragma->{name}</code> syntax
+Starting with Interchange 5.0, the <code>$::Pragma->{<replaceable>NAME</replaceable>}</code> syntax
 is used in the &IC; source, instead of the old
-<code>$Vend::Cfg->{Pragma}{name}</code>.
+<code>$Vend::Cfg->{Pragma}{<replaceable>NAME</replaceable>}</code>.
 </para><para>
 See the list of available pragmas in <olink targetdoc='pragmas'/>.



1.3       +1 -1      xmldocs/refs/compatible_5_2


rev 1.3, prev_rev 1.2
Index: compatible_5_2
===================================================================
RCS file: /var/cvs/xmldocs/refs/compatible_5_2,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- compatible_5_2	21 Mar 2006 12:38:56 -0000	1.2
+++ compatible_5_2	6 Nov 2006 22:34:44 -0000	1.3
@@ -4,7 +4,7 @@
 
 
 __NAME__ synopsis
-<group choice='req'>
+<group choice='plain'>
 	<arg choice='plain'>0</arg>
 	<arg choice='plain'>1</arg>
 </group>



1.8       +1 -1      xmldocs/refs/download


rev 1.8, prev_rev 1.7
Index: download
===================================================================
RCS file: /var/cvs/xmldocs/refs/download,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- download	13 Dec 2004 00:04:41 -0000	1.7
+++ download	6 Nov 2006 22:34:44 -0000	1.8
@@ -4,7 +4,7 @@
 
 
 __NAME__ synopsis
-<group choice='req'>
+<group choice='plain'>
 	<arg choice='plain'>0</arg>
 	<arg choice='plain'>1</arg>
 </group>



1.5       +2 -2      xmldocs/refs/dynamic_variables


rev 1.5, prev_rev 1.4
Index: dynamic_variables
===================================================================
RCS file: /var/cvs/xmldocs/refs/dynamic_variables,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- dynamic_variables	13 Dec 2004 00:04:41 -0000	1.4
+++ dynamic_variables	6 Nov 2006 22:34:44 -0000	1.5
@@ -1,10 +1,10 @@
 __NAME__ purpose
-dynamically update the directives from files and databases
+dynamically update configuration directives from files and databases
 __END__
 
 
 __NAME__ synopsis
-<group choice='req'>
+<group choice='plain'>
 	<arg choice='plain'>0</arg>
 	<arg choice='plain'>1</arg>
 </group>



1.6       +2 -2      xmldocs/refs/dynamic_variables_file_only


rev 1.6, prev_rev 1.5
Index: dynamic_variables_file_only
===================================================================
RCS file: /var/cvs/xmldocs/refs/dynamic_variables_file_only,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- dynamic_variables_file_only	28 Nov 2005 14:27:38 -0000	1.5
+++ dynamic_variables_file_only	6 Nov 2006 22:34:44 -0000	1.6
@@ -1,10 +1,10 @@
 __NAME__ purpose
-dynamically update the directives from files only
+dynamically update the configuration directives from files only
 __END__
 
 
 __NAME__ synopsis
-<group choice='req'>
+<group choice='plain'>
 	<arg choice='plain'>0</arg>
 	<arg choice='plain'>1</arg>
 </group>



1.3       +1 -1      xmldocs/refs/interpolate_itl_references


rev 1.3, prev_rev 1.2
Index: interpolate_itl_references
===================================================================
RCS file: /var/cvs/xmldocs/refs/interpolate_itl_references,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- interpolate_itl_references	2 Nov 2006 11:22:02 -0000	1.2
+++ interpolate_itl_references	6 Nov 2006 22:34:44 -0000	1.3
@@ -4,7 +4,7 @@
 
 
 __NAME__ synopsis
-<group choice='req'>
+<group choice='plain'>
 	<arg choice='plain'>0</arg>
 	<arg choice='plain'>1</arg>
 </group>



1.4       +4 -4      xmldocs/refs/no_default_reparse


rev 1.4, prev_rev 1.3
Index: no_default_reparse
===================================================================
RCS file: /var/cvs/xmldocs/refs/no_default_reparse,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- no_default_reparse	20 Aug 2005 19:27:25 -0000	1.3
+++ no_default_reparse	6 Nov 2006 22:34:44 -0000	1.4
@@ -4,7 +4,7 @@
 
 
 __NAME__ synopsis
-<group choice='req'>
+<group choice='plain'>
 	<arg choice='plain'>0</arg>
 	<arg choice='plain'>1</arg>
 </group>
@@ -20,10 +20,10 @@
 This &glos-pragma; disables default &glos-reparse; of Interchange output
 from container tags.
 </para><para>
-Reparsing can, of course, still be requested by the
+Reparsing can, of course, still be requested using the
 <literal>Reparse</literal> setting
-in individual &glos-ITL; tag definitions, or by providing the
-universal <literal>reparse=1</literal> attribute to the tags.
+in individual &glos-ITL; tag definition, or by providing the
+universal <literal>reparse=1</literal> attribute to any container tag.
 __END__
 
 



1.8       +4 -4      xmldocs/refs/no_html_comment_embed


rev 1.8, prev_rev 1.7
Index: no_html_comment_embed
===================================================================
RCS file: /var/cvs/xmldocs/refs/no_html_comment_embed,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- no_html_comment_embed	19 Nov 2005 22:37:41 -0000	1.7
+++ no_html_comment_embed	6 Nov 2006 22:34:44 -0000	1.8
@@ -4,7 +4,7 @@
 
 
 __NAME__ synopsis
-<group choice='req'>
+<group choice='plain'>
 	<arg choice='plain'>0</arg>
 	<arg choice='plain'>1</arg>
 </group>
@@ -42,8 +42,8 @@
 Setting the <pragma>no_html_comment_embed</pragma> &glos-pragma; instructs
 Interchange
 <emphasis role='bold'>not</emphasis> to parse and interpolate any HTML
-comments. With this pragma enabled, the above example would not display
-the current time.
+comments. With this pragma <emphasis role='bold'>enabled</emphasis>,
+the above example would not display the current time.
 __END__
 
 
@@ -58,6 +58,6 @@
 __NAME__ notes
 Although this feature existed in Interchange for a very long time, the
 pragma to control its behavior was added in September 2004, after someone
-stumbled on it by accident and wanted to remove it.
+stumbled on it by accident.
 __END__
 



1.7       +2 -2      xmldocs/refs/no_locale_parse


rev 1.7, prev_rev 1.6
Index: no_locale_parse
===================================================================
RCS file: /var/cvs/xmldocs/refs/no_locale_parse,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- no_locale_parse	13 Dec 2004 00:04:41 -0000	1.6
+++ no_locale_parse	6 Nov 2006 22:34:44 -0000	1.7
@@ -4,7 +4,7 @@
 
 
 __NAME__ synopsis
-<group choice='req'>
+<group choice='plain'>
 	<arg choice='plain'>0</arg>
 	<arg choice='plain'>1</arg>
 </group>
@@ -20,7 +20,7 @@
 This &glos-pragma; disables parsing of <tag>L</tag> and <tag>LC</tag> tags.
 </para><para>
 This is only used in the Admin UI and is not of interest to the general public.
-It could also have some side effects in Interchange &glos-ic-run-mode;
+It could also have some side effects in PreFork &glos-ic-run-mode;
 If you have enough traffic that you want to run in PreFork mode, you will
 be wanting to move the Admin UI away from the customer-facing side anyway,
 so this will not be a problem.



1.3       +1 -1      xmldocs/refs/perl_warnings_in_page


rev 1.3, prev_rev 1.2
Index: perl_warnings_in_page
===================================================================
RCS file: /var/cvs/xmldocs/refs/perl_warnings_in_page,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- perl_warnings_in_page	29 May 2005 11:19:33 -0000	1.2
+++ perl_warnings_in_page	6 Nov 2006 22:34:44 -0000	1.3
@@ -4,7 +4,7 @@
 
 
 __NAME__ synopsis
-<group choice='req'>
+<group choice='plain'>
 	<arg choice='plain'>0</arg>
 	<arg choice='plain'>1</arg>
 </group>



1.6       +1 -1      xmldocs/refs/init_page/synopsis


rev 1.6, prev_rev 1.5
Index: synopsis
===================================================================
RCS file: /var/cvs/xmldocs/refs/init_page/synopsis,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- synopsis	27 Jul 2005 17:19:13 -0000	1.5
+++ synopsis	6 Nov 2006 22:34:45 -0000	1.6
@@ -1 +1 @@
-  <arg choice='req'><replaceable>subroutine_name</replaceable></arg>
+<arg choice='plain'><replaceable>subroutine_name</replaceable></arg>



1.6       +1 -1      xmldocs/refs/no_html_parse/synopsis


rev 1.6, prev_rev 1.5
Index: synopsis
===================================================================
RCS file: /var/cvs/xmldocs/refs/no_html_parse/synopsis,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- synopsis	24 Sep 2004 21:01:02 -0000	1.5
+++ synopsis	6 Nov 2006 22:34:45 -0000	1.6
@@ -1,4 +1,4 @@
-  <group choice='req'>
+  <group choice='plain'>
     <arg choice='plain'>0</arg>
     <arg choice='plain'>1</arg>
   </group>



1.6       +1 -1      xmldocs/refs/no_image_rewrite/synopsis


rev 1.6, prev_rev 1.5
Index: synopsis
===================================================================
RCS file: /var/cvs/xmldocs/refs/no_image_rewrite/synopsis,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- synopsis	24 Sep 2004 21:01:02 -0000	1.5
+++ synopsis	6 Nov 2006 22:34:45 -0000	1.6
@@ -1,4 +1,4 @@
-  <group choice='req'>
+  <group choice='plain'>
     <arg choice='plain'>0</arg>
     <arg choice='plain'>1</arg>
   </group>



1.6       +1 -1      xmldocs/refs/post_page/synopsis


rev 1.6, prev_rev 1.5
Index: synopsis
===================================================================
RCS file: /var/cvs/xmldocs/refs/post_page/synopsis,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- synopsis	27 Jul 2005 17:19:13 -0000	1.5
+++ synopsis	6 Nov 2006 22:34:45 -0000	1.6
@@ -1 +1 @@
-  <arg choice='req'><replaceable>subroutine_name</replaceable></arg>
+<arg choice='plain'><replaceable>subroutine_name</replaceable></arg>



1.6       +1 -1      xmldocs/refs/pre_page/synopsis


rev 1.6, prev_rev 1.5
Index: synopsis
===================================================================
RCS file: /var/cvs/xmldocs/refs/pre_page/synopsis,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- synopsis	27 Jul 2005 17:19:13 -0000	1.5
+++ synopsis	6 Nov 2006 22:34:45 -0000	1.6
@@ -1 +1 @@
-  <arg choice='req'><replaceable>subroutine_name</replaceable></arg>
+  <arg choice='plain'><replaceable>subroutine_name</replaceable></arg>



1.4       +1 -1      xmldocs/refs/safe_data/notes


rev 1.4, prev_rev 1.3
Index: notes
===================================================================
RCS file: /var/cvs/xmldocs/refs/safe_data/notes,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- notes	23 Aug 2004 17:38:42 -0000	1.3
+++ notes	6 Nov 2006 22:34:45 -0000	1.4
@@ -1 +1 @@
-Watch out for parse order with <tag>tag pragma</tag> or <tag>restrict</tag> when used with lists that retrieve data from the database (such as <tag>PREFIX-*</tag>, <tag>loop</tag>, or the flypage). Loops parse before regular tags like <tag>tag</tag>, and are thus not affected by them (so you must include the whole loop code in the "critical section").
+Watch out for parse order with <code>tag pragma</code> or &tag-restrict; when used with lists that retrieve data from the database (such as <tag>PREFIX-*</tag>, <tag>loop</tag>, or the flypage). Loops parse before regular tags like <tag>tag</tag>, and are thus not affected by them (so you must include the whole loop code in the "critical section").



1.6       +1 -1      xmldocs/refs/safe_data/synopsis


rev 1.6, prev_rev 1.5
Index: synopsis
===================================================================
RCS file: /var/cvs/xmldocs/refs/safe_data/synopsis,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- synopsis	24 Sep 2004 21:01:02 -0000	1.5
+++ synopsis	6 Nov 2006 22:34:45 -0000	1.6
@@ -1,4 +1,4 @@
-  <group choice='req'>
+  <group choice='plain'>
     <arg choice='plain'>0</arg>
     <arg choice='plain'>1</arg>
   </group>



1.6       +1 -1      xmldocs/refs/strip_white/synopsis


rev 1.6, prev_rev 1.5
Index: synopsis
===================================================================
RCS file: /var/cvs/xmldocs/refs/strip_white/synopsis,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- synopsis	24 Sep 2004 21:01:02 -0000	1.5
+++ synopsis	6 Nov 2006 22:34:45 -0000	1.6
@@ -1,4 +1,4 @@
-  <group choice='req'>
+  <group choice='plain'>
     <arg choice='plain'>0</arg>
     <arg choice='plain'>1</arg>
   </group>



1.6       +1 -1      xmldocs/refs/substitute_table_image/synopsis


rev 1.6, prev_rev 1.5
Index: synopsis
===================================================================
RCS file: /var/cvs/xmldocs/refs/substitute_table_image/synopsis,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- synopsis	24 Sep 2004 21:01:02 -0000	1.5
+++ synopsis	6 Nov 2006 22:34:45 -0000	1.6
@@ -1,4 +1,4 @@
-  <group choice='req'>
+  <group choice='plain'>
     <arg choice='plain'>0</arg>
     <arg choice='plain'>1</arg>
   </group>








More information about the docs mailing list