[docs] xmldocs - docelic modified 16 files
docs at icdevgroup.org
docs at icdevgroup.org
Sat Oct 16 14:13:48 EDT 2004
User: docelic
Date: 2004-10-16 18:13:48 GMT
Modified: . TODO
Modified: docbook literals.ent
Modified: refs banner bar-button button capture_page css
Modified: delete_cart download history-scan image
Modified: no_html_comment_embed no_locale_parse var
Modified: refs/safe_data control description
Log:
- docbook/literals.ent:
- The trick with adding entities for often-repeated tag attributes
is very nice in practice. I added some more.
- refs/*, refs/*/*:
- Adjusted files to use new entities. Also minor wording/style/formatting
fixes where appropriate.
- TODO: items
Revision Changes Path
1.36 +1 -1 xmldocs/TODO
rev 1.36, prev_rev 1.35
Index: TODO
===================================================================
RCS file: /var/cvs/xmldocs/TODO,v
retrieving revision 1.35
retrieving revision 1.36
diff -u -r1.35 -r1.36
--- TODO 15 Oct 2004 20:54:56 -0000 1.35
+++ TODO 16 Oct 2004 18:13:47 -0000 1.36
@@ -8,7 +8,7 @@
multiple times within +- of first occurence, we treat it like one context.
but the header says 'displaying 2/2 contexts', it doesn't remove
'duplicates'. fix that.
-- Parameter is positional, others are attributes
+- Parameter is positional, all else are attributes [fix everywhere]
- ./files/ directory is not properly referenced from chunked documents.
Either use entities or XML catalog to solve that.
1.4 +85 -2 xmldocs/docbook/literals.ent
rev 1.4, prev_rev 1.3
Index: literals.ent
===================================================================
RCS file: /var/cvs/xmldocs/docbook/literals.ent,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- literals.ent 16 Oct 2004 13:23:10 -0000 1.3
+++ literals.ent 16 Oct 2004 18:13:47 -0000 1.4
@@ -60,6 +60,7 @@
<!ENTITY MIME "<ulink url='http://www.mhonarc.org/~ehood/MIME/'>MIME</ulink>">
<!ENTITY ITL "<glossterm linkend='ITL'>ITL</glossterm>">
<!ENTITY SMTP "<ulink url='http://cr.yp.to/smtp.html'>SMTP</ulink> (<classname>Net::SMTP</classname> Perl module)">
+<!ENTITY interpolate "<glossterm linkend='interpolate'>interpolate</glossterm>">
<!-- ENTITIES TO EASIER CONSTRUCT TAG PARAMETERS LIST -->
@@ -74,7 +75,7 @@
</entry>
<entry></entry><entry></entry>
<entry>0</entry>
- <entry>Interpolate (reparse) for other Interchange tags?</entry>
+ <entry><glossterm linkend='interpolate'>Interpolate</glossterm> input?</entry>
</row>
">
<!ENTITY ROW_INTERPOLATE_1 "
@@ -87,7 +88,7 @@
</entry>
<entry></entry><entry></entry>
<entry>1</entry>
- <entry>Interpolate (reparse) for other Interchange tags?</entry>
+ <entry><glossterm linkend='interpolate'>Interpolate</glossterm> input?</entry>
</row>
">
<!ENTITY ROW_HIDE_0 "
@@ -120,6 +121,88 @@
<entry>
<glossterm linkend='filter'>Interchange filter</glossterm> to apply.
</entry>
+</row>
+">
+<!ENTITY ROW_EXTRA_none "
+<row>
+ <entry><arg choice='plain'>extra</arg></entry>
+ <entry></entry><entry></entry>
+ <entry>None.</entry>
+ <entry>
+ Extra &HTML; attributes. Passed verbatim.
+ </entry>
+</row>
+">
+<!ENTITY ROW_HTML_std "
+<row>
+ <entry>
+ <group choice='plain'>
+ <arg choice='plain'>border</arg>
+ <arg choice='plain'>height</arg>
+ <arg choice='plain'>width</arg>
+ <arg choice='plain'>hspace</arg>
+ <arg choice='plain'>vspace</arg>
+ <arg choice='plain'>align</arg>
+ </group>
+ </entry>
+ <entry></entry><entry></entry>
+ <entry></entry>
+ <entry>The usual &HTML; attributes.</entry>
+</row>
+">
+<!ENTITY ROW_HTML_ext "
+<row>
+ <entry>
+ <group choice='plain'>
+ <arg choice='plain'>border</arg>
+ <arg choice='plain'>height</arg>
+ <arg choice='plain'>width</arg>
+ <arg choice='plain'>hspace</arg>
+ <arg choice='plain'>vspace</arg>
+ <arg choice='plain'>align</arg>
+ <arg choice='plain'>title</arg>
+ <arg choice='plain'>alt</arg>
+ </group>
+ </entry>
+ <entry></entry><entry></entry>
+ <entry></entry>
+ <entry>The usual &HTML; attributes.</entry>
+</row>
+">
+<!ENTITY ROW_CSS_std "
+<row>
+ <entry>
+ <group choice='plain'>
+ <arg choice='plain'>id</arg>
+ <arg choice='plain'>class</arg>
+ <arg choice='plain'>style</arg>
+ </group>
+ </entry>
+ <entry></entry><entry></entry>
+ <entry></entry>
+ <entry>The usual &CSS; attributes.</entry>
+</row>
+">
+<!ENTITY ROW_UMASK_none "
+<row>
+ <entry>
+ <arg choice='plain'>umask</arg>
+ </entry>
+ <entry></entry><entry></entry>
+ <entry></entry>
+ <entry>File creation <glossterm linkend='umask'>umask</glossterm>.</entry>
+</row>
+">
+<!ENTITY ROW_MODE_0644 "
+<row>
+ <entry>
+ <arg choice='plain'>mode</arg>
+ </entry>
+ <entry></entry><entry></entry>
+ <entry><literal>0644</literal></entry>
+ <entry>
+ File creation <glossterm linkend='mode'>mode</glossterm>.
+ </entry>
</row>
">
1.3 +27 -33 xmldocs/refs/banner
rev 1.3, prev_rev 1.2
Index: banner
===================================================================
RCS file: /var/cvs/xmldocs/refs/banner,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- banner 16 Oct 2004 12:26:52 -0000 1.2
+++ banner 16 Oct 2004 18:13:47 -0000 1.3
@@ -57,6 +57,28 @@
</row>
<row>
<entry>
+ <arg choice='plain'>c_field</arg>
+ </entry>
+ <entry></entry><entry></entry>
+ <entry><literal>category</literal></entry>
+ <entry>
+ Specify the column containing banner category.
+ This is only used with weighted ads.
+ </entry>
+</row>
+<row>
+ <entry>
+ <arg choice='plain'>w_field</arg>
+ </entry>
+ <entry></entry><entry></entry>
+ <entry><literal>weight</literal></entry>
+ <entry>
+ Specify the table column containing banner weights.
+ This is only used with weighted ads.
+ </entry>
+</row>
+<row>
+ <entry>
<arg choice='plain'>separator</arg>
</entry>
<entry></entry><entry></entry>
@@ -86,7 +108,9 @@
<entry></entry><entry></entry>
<entry>0</entry>
<entry>
- Use weighted banner system? In a weighted system, the database is expected
+ Use
+ <glossterm linkend="weighted_system">weighted</glossterm>
+ banner system? In a weighted system, the database is expected
to contain multiple entries with the same
<database class='field'>category</database>, and then the banners are
selected in regard to their relative weight (more weight = more
@@ -105,42 +129,12 @@
This is only used with weighted ads.
</entry>
</row>
-<row>
- <entry>
- <arg choice='plain'>c_field</arg>
- </entry>
- <entry></entry><entry></entry>
- <entry><literal>category</literal></entry>
- <entry>
- Specify the column containing banner category.
- This is only used with weighted ads.
- </entry>
-</row>
-<row>
- <entry>
- <arg choice='plain'>w_field</arg>
- </entry>
- <entry></entry><entry></entry>
- <entry><literal>weight</literal></entry>
- <entry>
- Specify the table column containing banner weights.
- This is only used with weighted ads.
- </entry>
-</row>
-<row>
- <entry>
- <arg choice='plain'>interpolate</arg>
- <arg choice='plain'>reparse</arg>
- </entry>
- <entry></entry><entry></entry>
- <entry>0</entry>
- <entry>.</entry>
-</row>
+&ROW_INTERPOLATE_0;
__END__
__NAME__ see also
-implement_banners
+implementbanners
__END__
1.3 +3 -2 xmldocs/refs/bar-button
rev 1.3, prev_rev 1.2
Index: bar-button
===================================================================
RCS file: /var/cvs/xmldocs/refs/bar-button,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- bar-button 6 Oct 2004 20:50:16 -0000 1.2
+++ bar-button 16 Oct 2004 18:13:47 -0000 1.3
@@ -28,8 +28,9 @@
__NAME__ description
-This tag can display content based on the (current) page name. It is most
-directly useful for creating menu bars, but can be used for other purposes.
+This tag can display content depending on current (or provided) page name.
+It is most directly useful for creating menu bars (although other uses are
+not excluded).
</para><para>
The content between the <tag>selected</tag><tag>/selected</tag> tags will be
displayed <emphasis role='bold'>if</emphasis> the name of the current
1.3 +4 -40 xmldocs/refs/button
rev 1.3, prev_rev 1.2
Index: button
===================================================================
RCS file: /var/cvs/xmldocs/refs/button,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- button 6 Oct 2004 20:50:16 -0000 1.2
+++ button 16 Oct 2004 18:13:47 -0000 1.3
@@ -89,45 +89,9 @@
<entry>0</entry>
<entry>Hide button text?</entry>
</row>
-<row>
- <entry><arg choice='plain'>extra</arg></entry>
- <entry></entry><entry></entry>
- <entry></entry>
- <entry>
- Extra &HTML; parameters. Passed verbatim. Note that the &CSS; attributes
- <arg choice='plain'>id</arg>, <arg choice='plain'>class</arg> and
- <arg choice='plain'>style</arg>
- <emphasis role='bold'>are</emphasis>
- available separately. Use this only for custom purposes.
- </entry>
-</row>
-<row>
- <entry>
- <group choice='plain'>
- <arg choice='plain'>border</arg>
- <arg choice='plain'>height</arg>
- <arg choice='plain'>width</arg>
- <arg choice='plain'>hspace</arg>
- <arg choice='plain'>vspace</arg>
- <arg choice='plain'>align</arg>
- </group>
- </entry>
- <entry></entry><entry></entry>
- <entry></entry>
- <entry>Standard &img; &HTML; tag properties.</entry>
-</row>
-<row>
- <entry>
- <group choice='plain'>
- <arg choice='plain'>id</arg>
- <arg choice='plain'>class</arg>
- <arg choice='plain'>style</arg>
- </group>
- </entry>
- <entry></entry><entry></entry>
- <entry></entry>
- <entry>&CSS; parameters.</entry>
-</row>
+&ROW_EXTRA_none;
+&ROW_HTML_std;
+&ROW_CSS_std;
__END__
@@ -137,7 +101,7 @@
__NAME__ description
-This tag creates a <mv>mv_click</mv> form submit button.
+This tag creates a <mv>mv_click</mv> HTML form submit button.
</para><para>
Standard, text-only submit button is output in the form of
<![CDATA[<input type='submit' ...>]]>.
1.4 +1 -8 xmldocs/refs/capture_page
rev 1.4, prev_rev 1.3
Index: capture_page
===================================================================
RCS file: /var/cvs/xmldocs/refs/capture_page,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- capture_page 16 Oct 2004 13:23:10 -0000 1.3
+++ capture_page 16 Oct 2004 18:13:47 -0000 1.4
@@ -60,14 +60,7 @@
<entry>0</entry>
<entry>If the file is expired, touch it?</entry>
</row>
-<row>
- <entry>
- <arg choice='plain'>umask</arg>
- </entry>
- <entry></entry><entry></entry>
- <entry></entry>
- <entry>File creation <glossterm linkend='umask'>umask</glossterm>.</entry>
-</row>
+&ROW_UMASK_none;
&ROW_HIDE_0;
__END__
1.3 +1 -11 xmldocs/refs/css
rev 1.3, prev_rev 1.2
Index: css
===================================================================
RCS file: /var/cvs/xmldocs/refs/css,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- css 6 Oct 2004 20:50:16 -0000 1.2
+++ css 16 Oct 2004 18:13:47 -0000 1.3
@@ -76,17 +76,7 @@
For example, <literal>PRINT</literal>.
</entry>
</row>
-<row>
- <entry>
- <arg choice='plain'>mode</arg>
- </entry>
- <entry></entry><entry></entry>
- <entry><literal>0644</literal></entry>
- <entry>
- File creation <glossterm linkend="mode">mode</glossterm>
- (say, <literal>0755</literal>).
- </entry>
-</row>
+&ROW_MODE_0644;
<row>
<entry>
<arg choice='plain'>output_dir</arg>
1.3 +6 -1 xmldocs/refs/delete_cart
rev 1.3, prev_rev 1.2
Index: delete_cart
===================================================================
RCS file: /var/cvs/xmldocs/refs/delete_cart,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- delete_cart 6 Oct 2004 20:50:16 -0000 1.2
+++ delete_cart 16 Oct 2004 18:13:47 -0000 1.3
@@ -8,7 +8,12 @@
__NAME__ synopsis
<row>
- <entry><arg choice='plain'>nickname</arg></entry>
+ <entry>
+ <group choice='opt'>
+ <arg choice='plain'>nickname</arg>
+ <arg choice='plain'>name</arg>
+ <group>
+ </entry>
<entry>Yes</entry><entry>Yes</entry>
<entry></entry>
<entry>Cart name to delete.</entry>
1.4 +2 -2 xmldocs/refs/download
rev 1.4, prev_rev 1.3
Index: download
===================================================================
RCS file: /var/cvs/xmldocs/refs/download,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- download 8 Oct 2004 21:07:16 -0000 1.3
+++ download 16 Oct 2004 18:13:47 -0000 1.4
@@ -18,14 +18,14 @@
__NAME__ description
The main function of this &pragma; is to prevent any
-interpolation of the output.
+&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
+you wanted to make &IC; 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>
1.3 +1 -1 xmldocs/refs/history-scan
rev 1.3, prev_rev 1.2
Index: history-scan
===================================================================
RCS file: /var/cvs/xmldocs/refs/history-scan,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- history-scan 6 Oct 2004 20:50:16 -0000 1.2
+++ history-scan 16 Oct 2004 18:13:47 -0000 1.3
@@ -132,7 +132,7 @@
text="Continue shopping"
src="__THEME_IMG_DIR__/continueshopping.gif"
hidetext=1
- extra="class=maincontent"
+ extra="class='maincontent'"
form=basket
]
[bounce href='[history-scan exclude="^/ord|^/multi/|^/process|^/login"
1.3 +2 -30 xmldocs/refs/image
rev 1.3, prev_rev 1.2
Index: image
===================================================================
RCS file: /var/cvs/xmldocs/refs/image,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- image 6 Oct 2004 20:50:16 -0000 1.2
+++ image 16 Oct 2004 18:13:47 -0000 1.3
@@ -191,36 +191,8 @@
directives. This option does honor locale settings.
</entry>
</row>
-<row>
- <entry>
- <group choice='plain'>
- <arg choice='plain'>width</arg>
- <arg choice='plain'>height</arg>
- <arg choice='plain'>alt</arg>
- <arg choice='plain'>title</arg>
- <arg choice='plain'>border</arg>
- <arg choice='plain'>hspace</arg>
- <arg choice='plain'>vspace</arg>
- </group>
- </entry>
- <entry></entry><entry></entry>
- <entry>
- </entry>
- <entry>
- Standard <img> HTML tag attributes to pass on.
- </entry>
-</row>
-<row>
- <entry>
- extra
- </entry>
- <entry></entry><entry></entry>
- <entry>
- </entry>
- <entry>
- Literal, arbitrary text to add to the generated <img> tag.
- </entry>
-</row>
+&ROW_HTML_ext;
+&ROW_EXTRA_none;
__END__
__NAME__ description
1.3 +2 -1 xmldocs/refs/no_html_comment_embed
rev 1.3, prev_rev 1.2
Index: no_html_comment_embed
===================================================================
RCS file: /var/cvs/xmldocs/refs/no_html_comment_embed,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- no_html_comment_embed 6 Oct 2004 20:50:16 -0000 1.2
+++ no_html_comment_embed 16 Oct 2004 18:13:47 -0000 1.3
@@ -38,7 +38,8 @@
]]>
</programlisting>
<para>
-Setting the <pragma>no_html_comment_embed</pragma> instructs Interchange
+Setting the <pragma>no_html_comment_embed</pragma> &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.
1.3 +1 -1 xmldocs/refs/no_locale_parse
rev 1.3, prev_rev 1.2
Index: no_locale_parse
===================================================================
RCS file: /var/cvs/xmldocs/refs/no_locale_parse,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- no_locale_parse 6 Oct 2004 20:50:16 -0000 1.2
+++ no_locale_parse 16 Oct 2004 18:13:47 -0000 1.3
@@ -17,7 +17,7 @@
__NAME__ description
-This pragma disables parsing of <tag>L</tag> and <tag>LC</tag> tags.
+This &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
1.5 +2 -2 xmldocs/refs/var
rev 1.5, prev_rev 1.4
Index: var
===================================================================
RCS file: /var/cvs/xmldocs/refs/var,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- var 16 Oct 2004 13:23:10 -0000 1.4
+++ var 16 Oct 2004 18:13:47 -0000 1.5
@@ -59,8 +59,8 @@
Note that the following two lines are identical in effect:
</para>
<programlisting>
-[image src="[var IMAGE_DIR]/items/[cgi item_id]" extra="border=0 id=item_img"]
-[image src="__IMAGE_DIR__/items/[cgi item_id]" extra="border=0 id=item_img"]
+[image src="[var IMAGE_DIR]/items/[cgi item_id]" border=0 extra="id='item_img'"]
+[image src="__IMAGE_DIR__/items/[cgi item_id]" border=0 extra="id='item_img'"]
</programlisting>
</example>
__END__
1.5 +1 -1 xmldocs/refs/safe_data/control
rev 1.5, prev_rev 1.4
Index: control
===================================================================
RCS file: /var/cvs/xmldocs/refs/safe_data/control,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- control 22 Sep 2004 21:13:08 -0000 1.4
+++ control 16 Oct 2004 18:13:47 -0000 1.5
@@ -1,3 +1,3 @@
-purpose: allow reparsing of database values in search for Interchange tags
+purpose: allow interpolation of database values in search for Interchange tags
default: <literal>0</literal>
see also: restrict
1.7 +2 -2 xmldocs/refs/safe_data/description
rev 1.7, prev_rev 1.6
Index: description
===================================================================
RCS file: /var/cvs/xmldocs/refs/safe_data/description,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- description 6 Oct 2004 20:50:18 -0000 1.6
+++ description 16 Oct 2004 18:13:47 -0000 1.7
@@ -1,4 +1,4 @@
-By default, Interchange does not allow data returned from the databases to be reparsed for Interchange tags (all the [s are converted to an &HTML; entity (&#91;) and displayed literally). Setting this pragma eliminates the restriction and passes [s through for interpolation).
+By default, Interchange does not allow data returned from the databases to be interpolated (all the [s are converted to an &HTML; entity (&#91;) and displayed literally). Setting this pragma eliminates the restriction and passes [s through for interpolation).
</para><para>
If you want to have tags in your database and display them in Interchange pages (to say, display <tag>page</tag> links for internal hyperlinks in your product descriptions), you need to enable this pragma.
Some things to consider, though:
@@ -12,7 +12,7 @@
<itemizedlist>
<listitem><para>
- Will it always be possible to reparse for tags?
+ Will it always be possible to interpolate?
</para></listitem>
<listitem><para>
What about e-mailed plain-text receipts? Will literal "<tag>page </tag>" tags show up in product descriptions on the receipt?
More information about the docs
mailing list