[interchange-docs] xmldocs - docelic modified 15 files
docs at icdevgroup.org
docs at icdevgroup.org
Sat Nov 10 13:28:15 EST 2007
User: docelic
Date: 2007-11-10 18:28:15 GMT
Modified: . TODO
Modified: refs BounceReferrals HouseKeeping HouseKeepingCron
Modified: widget.tag
Added: refs country_select.widget noyes.widget realvalue.widget
Added: state_select.widget text.widget textarea.widget
Added: time.widget value.widget yesno.widget
Removed: refs table-organize
Log:
* Small updates to existing pages
* Couple of widgets documented
Revision Changes Path
1.105 +2 -0 xmldocs/TODO
rev 1.105, prev_rev 1.104
Index: TODO
===================================================================
RCS file: /var/cvs/xmldocs/TODO,v
retrieving revision 1.104
retrieving revision 1.105
diff -u -r1.104 -r1.105
--- TODO 20 Aug 2007 18:37:37 -0000 1.104
+++ TODO 10 Nov 2007 18:28:14 -0000 1.105
@@ -1,4 +1,6 @@
Bugs:
+-textarea widget is hidden as it is found in text.widget file
+-check if really linking between widgets is not working
- search doc se nevidi jer je search neki actionmap
- on online docs, mention that obsolete examples are obsolete,
provide search box, provide static files for download,
1.2 +1 -1 xmldocs/refs/BounceReferrals
rev 1.2, prev_rev 1.1
Index: BounceReferrals
===================================================================
RCS file: /var/cvs/xmldocs/refs/BounceReferrals,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- BounceReferrals 7 Nov 2007 00:48:44 -0000 1.1
+++ BounceReferrals 10 Nov 2007 18:28:14 -0000 1.2
@@ -1,5 +1,5 @@
__NAME__ purpose
-specify whether information from both GET and POST method should be parsed when form is submitted using POST method
+remove visible affiliate code from URLs after first access
__END__
1.8 +8 -2 xmldocs/refs/HouseKeeping
rev 1.8, prev_rev 1.7
Index: HouseKeeping
===================================================================
RCS file: /var/cvs/xmldocs/refs/HouseKeeping,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- HouseKeeping 6 Nov 2006 18:41:20 -0000 1.7
+++ HouseKeeping 10 Nov 2007 18:28:14 -0000 1.8
@@ -17,9 +17,15 @@
__END__
-__NAME__ example: Adjusting the HouseKeeping interval
+__NAME__ example: Adjusting the HouseKeeping interval to 120 seconds
<programlisting>
-HouseKeeping 5
+HouseKeeping 2 minutes
+</programlisting>
+__END__
+
+__NAME__ example: Adjusting the HouseKeeping interval to 1 hour
+<programlisting>
+HouseKeeping 1 hour
</programlisting>
__END__
1.6 +21 -17 xmldocs/refs/HouseKeepingCron
rev 1.6, prev_rev 1.5
Index: HouseKeepingCron
===================================================================
RCS file: /var/cvs/xmldocs/refs/HouseKeepingCron,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- HouseKeepingCron 7 Nov 2007 10:58:40 -0000 1.5
+++ HouseKeepingCron 10 Nov 2007 18:28:14 -0000 1.6
@@ -65,26 +65,22 @@
</para><para>
In addition to the above, two special targets exist,
<literal>:reconfig</literal> and <literal>:jobs</literal>.
-They allow calling
-of the catalog reconfig routines and jobs routines respectively.
+They define the intervals at which
+catalog reconfiguration and job executions would run (if any
+requests for it were issued).
The <filename>etc/reconfig</filename> and
-<filename>etc/jobsqueue</filename> files will be ignored
-if &conf-__FILENAME__; is
-specified but these targets are not included. This will render
-reconfiguration and/or triggering batch jobs from the commandline
-useless.
-In that case, a warning will be issued at
-&IC; startup or crontab change, e.g.:
-<programlisting>
-WARNING: suggested cron entry ':reconfig' not present.
-</programlisting>
-</para><para>
+<filename>etc/jobsqueue</filename> files are ignored
+if &conf-__FILENAME__; is specified and these targets not included.
+In that case, a warning will be issued because, without the two
+entries, catalog reconfiguration or job execution requests are
+ignored — something you almost never want in regular operation.
__END__
-__NAME__ example: Running :restart and :jobs every 5 seconds
-The basic entry to implement <literal>HouseKeeping 5</literal> would be:
+__NAME__ example: Running :restart and :jobs every 5 minutes
+The basic entry to implement <literal>HouseKeeping 300</literal>
+would be:
<programlisting><![CDATA[
-HouseKeeping 1
+HouseKeeping 1 minute
HouseKeepingCron <<EOC
*/5 * * * * * :restart
@@ -104,6 +100,13 @@
]]></programlisting>
__END__
+__NAME__ example: Warning message when :reconfig entry is not present
+The warning message would look like this:
+<programlisting>
+WARNING: suggested cron entry ':reconfig' not present.
+</programlisting>
+__END__
+
__NAME__ see also
HouseKeeping, RunDir
__END__
@@ -112,6 +115,7 @@
__NAME__ missing
run_macro() also supports calling Interpolate::tag_profile if argument is \w+-\w+ but it's not documented ATM as I have no idea what to do with it
more about <>= in target specification
-Last example (batch jobs) needs to be fixed
+Last example (batch jobs) needs to be fixed (or clarified how it works?)
+Clarify what the first 6 fields mean and adjust synopsis/description
__END__
1.2 +43 -12 xmldocs/refs/widget.tag
rev 1.2, prev_rev 1.1
Index: widget.tag
===================================================================
RCS file: /var/cvs/xmldocs/refs/widget.tag,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- widget.tag 17 Feb 2005 23:25:39 -0000 1.1
+++ widget.tag 10 Nov 2007 18:28:15 -0000 1.2
@@ -2,6 +2,25 @@
<row>
<entry>
+ name
+ </entry>
+ <entry>
+ Yes
+ </entry>
+ <entry>
+ Yes
+ </entry>
+ <entry>
+ <!-- DFL -->
+ </entry>
+ <entry>
+ Name of the resulting &glos-HTML; element.
+ </entry>
+
+</row>
+<row>
+
+ <entry>
set
</entry>
<entry>
@@ -14,7 +33,7 @@
<!-- DFL -->
</entry>
<entry>
- <!-- DSC -->
+ Override current or default widget value with specific data.
</entry>
</row>
@@ -33,7 +52,9 @@
<!-- DFL -->
</entry>
<entry>
- <!-- DSC -->
+ Default value for a widget. The default is applied if there is
+ no corresponding value for the widget in the &glos-value;s
+ variable space.
</entry>
</row>
@@ -52,7 +73,8 @@
<!-- DFL -->
</entry>
<entry>
- <!-- DSC -->
+ Filter name or names (separated by spaces) to apply to the widget's
+ value prior to display.
</entry>
</row>
@@ -78,7 +100,10 @@
<row>
<entry>
- table
+ <group>
+ <arg choice='plain'>table</arg>
+ <arg choice='plain'>db</arg>
+ </group>
</entry>
<entry>
<!-- POS -->
@@ -97,7 +122,10 @@
<row>
<entry>
- field
+ <group>
+ <arg choice='plain'>field</arg>
+ <arg choice='plain'>column</arg>
+ </group>
</entry>
<entry>
<!-- POS -->
@@ -116,7 +144,10 @@
<row>
<entry>
- extra
+ <group>
+ <arg choice='plain'>key</arg>
+ <arg choice='plain'>outboard</arg>
+ </group>
</entry>
<entry>
<!-- POS -->
@@ -135,7 +166,7 @@
<row>
<entry>
- js
+ extra
</entry>
<entry>
<!-- POS -->
@@ -154,7 +185,7 @@
<row>
<entry>
- cols
+ js
</entry>
<entry>
<!-- POS -->
@@ -173,7 +204,7 @@
<row>
<entry>
- delimiter
+ cols
</entry>
<entry>
<!-- POS -->
@@ -192,7 +223,7 @@
<row>
<entry>
- rows
+ delimiter
</entry>
<entry>
<!-- POS -->
@@ -211,7 +242,7 @@
<row>
<entry>
- key
+ rows
</entry>
<entry>
<!-- POS -->
@@ -305,4 +336,4 @@
</row>
&ROW_INTERPOLATE_0;
&ROW_REPARSE_1;
-__END__
\ No newline at end of file
+__END__
1.1 xmldocs/refs/country_select.widget
rev 1.1, prev_rev 1.0
Index: country_select.widget
===================================================================
__NAME__ purpose
display country selector dropdown box
__END__
__NAME__ synopsis
__END__
__NAME__ description
The &widget-__FILENAME__; widget displays an elegantly-formatted
country selector dropdown box.
__END__
__NAME__ notes
__END__
__NAME__ online: Country selector
<programlisting>
[widget name=widget_countryselect type=country_select]
</programlisting>
__END__
__NAME__ missing
widget is considerably more complex that what is documented
__END__
__NAME__ see also
state_select
__END__
1.1 xmldocs/refs/noyes.widget
rev 1.1, prev_rev 1.0
Index: noyes.widget
===================================================================
__NAME__ purpose
display a no/yes option
__END__
__NAME__ synopsis
__END__
__NAME__ description
The &widget-__FILENAME__; widget creates a simple "Yes or No" option.
This widget is exactly the same as &widget-yesno; with the return
values for Yes and No inverted.
</para><para>
The actual widget titles, "<literal>Yes</literal>" and
"<literal>No</literal>", are &glos-locale;-aware so adding their
translated versions to the locale &glos-database; will be enough to
have them adjusted to visitors' language settings.
</para><para>
A negative answer will return value <literal>1</literal> (&glos-true;) to the application.<sbr/>
A positive answer will return a blank (&glos-false;) value to the application.
__END__
__NAME__ notes
See very similar widget &widget-yesno; for additional examples.
__END__
__NAME__ online: 'Yes or No' widget, rendered as a dropdown list
<programlisting>
[widget name=example type=noyes]
</programlisting>
__END__
__NAME__ see also
yesno
__END__
1.1 xmldocs/refs/realvalue.widget
rev 1.1, prev_rev 1.0
Index: realvalue.widget
===================================================================
__NAME__ purpose
display raw, unencoded value, providing no option to change it
__END__
__NAME__ synopsis
__END__
__NAME__ description
The &widget-__FILENAME__; widget simply displays &glos-variable;s
from the &glos-value;s space and does not create any &glos-HTML;
form element that would allow changing them.
</para><para>
It is similar to &widget-value;, but more dangerous. It does not
perform any encoding on the value before display, allowing for
possible untrusted data (including both &glos-HTML; and &glos-ITL;!)
to be injected into the &glos-HTML; stream.
</para><para>
Use this widget with caution and always only on data you absolutely
trust.
__END__
__NAME__ notes
The variable value is not encoded before display; to
enabled recommended processing before display,
use widget &widget-value;.
__END__
__NAME__ online: Basic value initialization and display
<programlisting>
[value name=widget_testrealvalue set="Test Widget Value" hide=1]
[widget name=widget_testrealvalue type=realvalue]
</programlisting>
__END__
__NAME__ online: Basic value initialization and display, showing arbitrary HTML and ITL code insertion
<programlisting>
[set widget_testrealvalue_input]
Test <i>Widget<i> <b>Value</b>. The time is: [time]
[/set]
[value name=widget_testrealvalue
set="[scratch widget_testrealvalue_input]"
hide=1]
[widget name=widget_testrealvalue type=realvalue]
</programlisting>
__END__
__NAME__ see also
text, textarea, value
__END__
1.1 xmldocs/refs/state_select.widget
rev 1.1, prev_rev 1.0
Index: state_select.widget
===================================================================
__NAME__ purpose
display state selector dropdown box
__END__
__NAME__ synopsis
__END__
__NAME__ description
The &widget-__FILENAME__; widget displays a
state selector dropdown box.
__END__
__NAME__ notes
__END__
__NAME__ online: State selector
<programlisting>
[widget name=widget_stateselect type=state_select]
</programlisting>
__END__
__NAME__ missing
widget is considerably more complex that what is documented
__END__
1.1 xmldocs/refs/text.widget
rev 1.1, prev_rev 1.0
Index: text.widget
===================================================================
__NAME__ purpose
display value, providing HTML input box change it
__END__
__NAME__ synopsis
__END__
__NAME__ description
The &widget-__FILENAME__; widget displays &glos-variable;s
from the &glos-value;s space in a &glos-HTML; text input box.
__END__
__NAME__ notes
__END__
__NAME__ online: Value initialization and display
<programlisting>
[value name=widget_testtext set="Test Widget Value" hide=1]
[widget name=widget_testtext type=text]
</programlisting>
__END__
1.1 xmldocs/refs/textarea.widget
rev 1.1, prev_rev 1.0
Index: textarea.widget
===================================================================
__NAME__ purpose
display value, providing HTML textarea box change it
__END__
__NAME__ synopsis
__END__
__NAME__ description
The &widget-__FILENAME__; widget displays &glos-variable;s
from the &glos-value;s space in a &glos-HTML; textarea box.
__END__
__NAME__ notes
__END__
__NAME__ online: Value initialization and display
<programlisting>
[value name=widget_testtextarea set="Test Widget Value" hide=1]
[widget name=widget_testtextarea type=textarea]
</programlisting>
__END__
__NAME__ see also
text
__END__
1.1 xmldocs/refs/time.widget
rev 1.1, prev_rev 1.0
Index: time.widget
===================================================================
__NAME__ purpose
display time selector dropdown box
__END__
__NAME__ synopsis
__END__
__NAME__ description
The &widget-__FILENAME__; widget displays a 24-hour time span in a day
as a series of 15-minute increments in a dropdown list.
__END__
__NAME__ notes
__END__
__NAME__ online: Basic time selector
<programlisting>
[widget name=widget_testtime type=time]
</programlisting>
__END__
__NAME__ missing
Time widget is considerably more complex that what is documented
__END__
1.1 xmldocs/refs/value.widget
rev 1.1, prev_rev 1.0
Index: value.widget
===================================================================
__NAME__ purpose
display value, providing no option to change it
__END__
__NAME__ synopsis
__END__
__NAME__ description
The &widget-__FILENAME__; widget simply displays &glos-variable;s
from the &glos-value;s space and does not create any &glos-HTML;
form element that would allow changing them.
__END__
__NAME__ notes
The variable value is automatically encoded before display; to
avoid any processing before display, use widget &widget-realvalue;.
__END__
__NAME__ online: Basic value initialization and display
<programlisting>
[value name=widget_testvalue set="Test Widget Value" hide=1]
[widget name=widget_testvalue type=value]
</programlisting>
__END__
__NAME__ see also
text, textarea, realvalue
__END__
1.1 xmldocs/refs/yesno.widget
rev 1.1, prev_rev 1.0
Index: yesno.widget
===================================================================
__NAME__ purpose
display a yes/no option
__END__
__NAME__ synopsis
__END__
__NAME__ description
The &widget-__FILENAME__; widget creates a simple "Yes or No" option.
</para><para>
The actual widget titles, "<literal>Yes</literal>" and
"<literal>No</literal>", are &glos-locale;-aware so adding their
translated versions to the locale &glos-database; will be enough to
have them adjusted to visitors' language settings.
</para><para>
A negative answer will return a blank (&glos-false;) value to the application.<sbr/>
A positive answer will return value <literal>1</literal> (&glos-true;) to the application.
__END__
__NAME__ notes
The widget is created by Interchange's <function>Vend::Form::yesno</function>
function. Passing attribute <literal>type="yesno radio"</literal> to it is
equivalent to passing attributes <literal>type=yesno variant=radio</literal>.
However, only method <literal>type="yesno radio"</literal> is available when the
&glos-widget; is invoked through the &tag-widget; tag and &glos-ITL;.
__END__
__NAME__ online: 'Yes or No' widget, rendered as a dropdown list
<programlisting>
[widget name=example type=yesno]
</programlisting>
__END__
__NAME__ online: 'Yes or No' widget, rendered as a "radio" button
<programlisting>
[widget name=example type='yesno radio']
</programlisting>
__END__
__NAME__ online: 'Yes or No' widget, created in an alternative way
A similar (eventually more flexible) "Yes or No" button can be created
using the general-purpose &tag-display; tag:
<programlisting>
[display name=example type=select passed="=No,1=Yes"]
</programlisting>
__END__
More information about the docs
mailing list