[interchange-cvs] interchange - racke modified 12 files
interchange-core@icdevgroup.org
interchange-core@icdevgroup.org
Wed Oct 30 15:44:00 2002
User: racke
Date: 2002-10-30 20:43:05 GMT
Modified: code/SystemTag image.tag
Modified: code/UI_Tag jsq.coretag jsqn.coretag tabbed_display.coretag
Modified: write_page.coretag write_relative_file.coretag
Modified: code/UserTag button.tag email_raw.tag formel.tag fortune.tag
Modified: get_url.tag table_organize.tag
Log:
improved inline documentation in order to be able to view
it with pod2... tools and allow automatic processing
fixed some errors
Revision Changes Path
1.2 +4 -2 interchange/code/SystemTag/image.tag
rev 1.2, prev_rev 1.1
Index: image.tag
===================================================================
RCS file: /var/cvs/interchange/code/SystemTag/image.tag,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- image.tag 5 Aug 2002 04:05:40 -0000 1.1
+++ image.tag 30 Oct 2002 20:43:04 -0000 1.2
@@ -5,7 +5,7 @@
=head2 image
-This is a general-purpose tag for inserting HTML <img> tags based on
+This is a general-purpose tag for inserting HTML C<< <img> >> tags based on
various settings, with the ability to test whether an image exists,
predetermine its pixel dimensions, retrieve the image name from the
product database field B<image> for that sku, automatically pull product
@@ -50,7 +50,7 @@
=item alt
-Text to use for the <img alt="..."> attribute. By default, this will
+Text to use for the C<< <img alt="..."> >> attribute. By default, this will
be filled with the B<description> from the product database if a sku (not
a filename) is provided.
@@ -135,6 +135,8 @@
catalog image prefixes from ImageDir and ImageDirSecure.
=back
+
+=cut
EOD
1.3 +3 -1 interchange/code/UI_Tag/jsq.coretag
rev 1.3, prev_rev 1.2
Index: jsq.coretag
===================================================================
RCS file: /var/cvs/interchange/code/UI_Tag/jsq.coretag,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- jsq.coretag 15 Aug 2002 16:30:33 -0000 1.2
+++ jsq.coretag 30 Oct 2002 20:43:05 -0000 1.3
@@ -20,7 +20,8 @@
EOR
UserTag jsq Documentation <<EOD
-=head1 jsqn
+
+=head1 jsq
Returns a string quoted for JavaScript, with variable substitution.
@@ -42,5 +43,6 @@
Used in the UI dynamic HTML.
+=cut
EOD
1.2 +3 -0 interchange/code/UI_Tag/jsqn.coretag
rev 1.2, prev_rev 1.1
Index: jsqn.coretag
===================================================================
RCS file: /var/cvs/interchange/code/UI_Tag/jsqn.coretag,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- jsqn.coretag 15 Aug 2002 16:30:33 -0000 1.1
+++ jsqn.coretag 30 Oct 2002 20:43:05 -0000 1.2
@@ -1,4 +1,5 @@
UserTag jsqn Documentation <<EOD
+
=head1 jsqn
Returns a string quoted for JavaScript, with no variable substitution.
@@ -16,6 +17,8 @@
</script>
Used in the UI dynamic HTML.
+
+=cut
EOD
1.2 +3 -3 interchange/code/UI_Tag/tabbed_display.coretag
rev 1.2, prev_rev 1.1
Index: tabbed_display.coretag
===================================================================
RCS file: /var/cvs/interchange/code/UI_Tag/tabbed_display.coretag,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- tabbed_display.coretag 19 Sep 2002 17:52:34 -0000 1.1
+++ tabbed_display.coretag 30 Oct 2002 20:43:05 -0000 1.2
@@ -31,7 +31,7 @@
=over 4
-=item tab_bgcolor_template}
+=item tab_bgcolor_template
Default #xxxxxx. A template where each "x" will be broken into
descending-brightness colors. The default value will cause
@@ -109,8 +109,6 @@
be sent as content. This is the value used in Interchange's
table editor.
-=back
-
=item contents
If you have an array set with the value of each panel's content,
@@ -130,6 +128,8 @@
If the title for a panel is set in the array, the title found in the
body text of the tag is ignored.
+
+=back
=head2 Use in embedded Perl
1.3 +5 -3 interchange/code/UI_Tag/write_page.coretag
rev 1.3, prev_rev 1.2
Index: write_page.coretag
===================================================================
RCS file: /var/cvs/interchange/code/UI_Tag/write_page.coretag,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- write_page.coretag 5 Feb 2002 20:57:03 -0000 1.2
+++ write_page.coretag 30 Oct 2002 20:43:05 -0000 1.3
@@ -2,10 +2,12 @@
=head2 write-page
-usage: [write-page file=name]content[/write-page]
+ [write-page file=name]content[/write-page]
-Writes a file C<name> in the catalog directory. Name must be relative; it will
-return undef if the file name is absolute or contains C<..>.
+Writes a file C<name> in the catalog directory. C<name> must be relative;
+it will return undef if the file name is absolute or contains C<..>.
+
+=cut
EOD
1.2 +5 -3 interchange/code/UI_Tag/write_relative_file.coretag
rev 1.2, prev_rev 1.1
Index: write_relative_file.coretag
===================================================================
RCS file: /var/cvs/interchange/code/UI_Tag/write_relative_file.coretag,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- write_relative_file.coretag 29 Jan 2002 05:52:40 -0000 1.1
+++ write_relative_file.coretag 30 Oct 2002 20:43:05 -0000 1.2
@@ -2,10 +2,12 @@
=head2 write-relative-file
-usage: [write-relative-file file=name]content[/write-relative-file]
+ [write-relative-file file=name]content[/write-relative-file]
-Writes a file C<name> in the catalog directory. Name must be relative; it will
-return undef if the file name is absolute or contains C<..>.
+Writes a file C<name> in the catalog directory. C<name> must be relative;
+it will return undef if the file name is absolute or contains C<..>.
+
+=cut
EOD
1.5 +55 -28 interchange/code/UserTag/button.tag
rev 1.5, prev_rev 1.4
Index: button.tag
===================================================================
RCS file: /var/cvs/interchange/code/UserTag/button.tag,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- button.tag 27 Oct 2002 04:54:29 -0000 1.4
+++ button.tag 30 Oct 2002 20:43:05 -0000 1.5
@@ -2,46 +2,72 @@
UserTag button addAttr
UserTag button attrAlias value text
UserTag button hasEndTag
-UserTag button Version $Id: button.tag,v 1.4 2002/10/27 04:54:29 mheins Exp $
+UserTag button Version $Id: button.tag,v 1.5 2002/10/30 20:43:05 racke Exp $
UserTag button Documentation <<EOD
-This tag creates an mv_click button either as a <INPUT TYPE=submit ...>
-or a JavaScript-linked <A HREF=....><img src=...> combination.
-[button text="Delete item" confirm="Are you sure?" src="delete.gif"]
- [comment]
- This is the action, same as [set Delete item] action [/set]
- [/comment]
- [mvtag] Use any Interchange tag here, i.e. ....[/mvtag]
- [perl] # code to delete item [/perl]
-[/button]
+=pod
-Parameters:
+This tag creates an mv_click button either as a C<< <INPUT TYPE=submit ..> >>
+or a JavaScript-linked C<< <A HREF=....><img src=...> >> combination.
- name Name of the variable, by default mv_click.
-
- src Image source file. If it is a relative image, the existence
- of the file is checked for
-
- text The text of the button, also the name of the scratch action
- (VALUE is an alias for TEXT.)
+ [button text="Delete item" confirm="Are you sure?" src="delete.gif"]
+ [comment]
+ This is the action, same as [set Delete item] action [/set]
+ [/comment]
+ [mvtag] Use any Interchange tag here, i.e. ....[/mvtag]
+ [perl] # code to delete item [/perl]
+ [/button]
- border, height, width, vspace, hspace, AND
- align The image alignment parameters. Border defaults to 0.
-
- form The name of the form, defaults to document.forms[0] -- be careful!
+Parameters for this tag are:
+
+=over 4
+
+=item name
+
+Name of the variable, by default mv_click.
+
+=item src
- confirm The text to use for a JavaScript confirm, if any.
+Image source file. If it is a relative image, the existence
+of the file is checked for.
+
+=item text
+
+The text of the button, also the name of the scratch action
+(VALUE is an alias for TEXT.)
+
+=item border, height, width, vspace, hspace, align
+
+The image alignment parameters. Border defaults to 0.
+
+=item form
+
+The name of the form, defaults to document.forms[0] -- be careful!
+
+=item confirm
+
+The text to use for a JavaScript confirm, if any.
- getsize If true, tries to use Image::Size to add height=Y width=X.
+=item getsize
+
+If true, tries to use Image::Size to add height=Y width=X.
- alt The alt text to be displayed in window.status and balloons.
- Defaults to the same as TEXT.
+=item alt
+
+The alt text to be displayed in window.status and balloons.
+Defaults to the same as TEXT.
- anchor Set to the anchor text value, defaults to TEXT
+=item anchor
+
+Set to the anchor text value, defaults to TEXT
- hidetext Set true if you don't want the anchor displayed
+=item hidetext
+Set true if you don't want the anchor displayed
+=back
+
+=cut
EOD
UserTag button Routine <<EOR
@@ -233,4 +259,5 @@
return $out;
}
+
EOR
1.2 +13 -9 interchange/code/UserTag/email_raw.tag
rev 1.2, prev_rev 1.1
Index: email_raw.tag
===================================================================
RCS file: /var/cvs/interchange/code/UserTag/email_raw.tag,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- email_raw.tag 29 Jan 2002 05:52:42 -0000 1.1
+++ email_raw.tag 30 Oct 2002 20:43:05 -0000 1.2
@@ -1,18 +1,22 @@
UserTag email_raw Documentation <<EOD
-This tag takes a raw email message, *including headers*, and
-users the SendmailProgram with -t option. Example:
+=head1 email-raw
-[email-raw]
-From: foo@bar.com
-To: bar@foo.com
-Subject: baz
+This tag takes a raw email message, I<including headers>, and
+uses the SendmailProgram with B<-t> option. Example:
-The text of the message.
-[/email-raw]
+ [email-raw]
+ From: foo@bar.com
+ To: bar@foo.com
+ Subject: baz
+
+ The text of the message.
+ [/email-raw]
The headers must be at the beginning of the line, and the header
-must have a valid To: or it will not be delivered.
+must have a valid C<To:> or it will not be delivered.
+
+=cut
EOD
1.6 +6 -7 interchange/code/UserTag/formel.tag
rev 1.6, prev_rev 1.5
Index: formel.tag
===================================================================
RCS file: /var/cvs/interchange/code/UserTag/formel.tag,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- formel.tag 22 Oct 2002 10:44:53 -0000 1.5
+++ formel.tag 30 Oct 2002 20:43:05 -0000 1.6
@@ -258,12 +258,9 @@
You can set defaults for cause, format, order, reset, signal and size with the
corresponding mv_formel_... form variable values, e.g.:
- [value name="mv_formel_cause" set=" (<I>%s</I>)" hide=1]
-
- [value name="mv_formel_format" set="<TR><TD>%s</TD><TD>%s</TD></TR>" hide=1]
-
- [value name="mv_formel_order" set=1 hide=1]
-
+ [value name="mv_formel_cause" set=" (<I>%s</I>)" hide=1]
+ [value name="mv_formel_format" set="<TR><TD>%s</TD><TD>%s</TD></TR>" hide=1]
+ [value name="mv_formel_order" set=1 hide=1]
[value name="mv_formel_signal" set="<BLINK>%s</BLINK>" hide=1]
To display the label and the form element seperately call C<formel> twice:
@@ -272,7 +269,9 @@
[formel name=login order=1 format="%s"]
You may add a help text for the form element.
-
+
[formel label=Username: name=login help="alphanumeric (5-10 characters)"]
+
+=cut
EOD
1.2 +5 -0 interchange/code/UserTag/fortune.tag
rev 1.2, prev_rev 1.1
Index: fortune.tag
===================================================================
RCS file: /var/cvs/interchange/code/UserTag/fortune.tag,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- fortune.tag 29 Jan 2002 05:52:42 -0000 1.1
+++ fortune.tag 30 Oct 2002 20:43:05 -0000 1.2
@@ -1,6 +1,9 @@
UserTag fortune Order short
UserTag fortune addAttr
UserTag fortune Documentation <<EOF
+
+=pod
+
This tag uses the fortune(1) command to display a randome saying.
Options:
@@ -13,6 +16,8 @@
Example:
[fortune short=yes]
+
+=cut
EOF
1.3 +7 -3 interchange/code/UserTag/get_url.tag
rev 1.3, prev_rev 1.2
Index: get_url.tag
===================================================================
RCS file: /var/cvs/interchange/code/UserTag/get_url.tag,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- get_url.tag 2 Aug 2002 03:42:24 -0000 1.2
+++ get_url.tag 30 Oct 2002 20:43:05 -0000 1.3
@@ -2,11 +2,15 @@
UserTag get-url AddAttr
UserTag get-url Documentation <<EOD
-usage: [get-url url="valid_url" strip=1*]
+=pod
+
+ [get-url url="valid_url" strip=1*]
Uses the LWP libraries to fetch a URL and return the contents.
-If the strip option is set, strips everything up to <body> and
-everything after </body>
+If the C<strip> option is set, strips everything up to C<< <body> >> and
+everything after C<< </body> >>.
+
+=cut
EOD
1.3 +22 -20 interchange/code/UserTag/table_organize.tag
rev 1.3, prev_rev 1.2
Index: table_organize.tag
===================================================================
RCS file: /var/cvs/interchange/code/UserTag/table_organize.tag,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- table_organize.tag 6 Aug 2002 23:10:44 -0000 1.2
+++ table_organize.tag 30 Oct 2002 20:43:05 -0000 1.3
@@ -5,11 +5,11 @@
UserTag table-organize hasEndTag
UserTag table-organize Documentation <<EOD
-=head2 table-organize
+=head1 table-organize
-usage: [table-organize <options>]
- [loop ....] <td> [loop-tags] </td> [/loop]
- [/table-organize]
+ [table-organize <options>]
+ [loop ....] <td> [loop-tags] </td> [/loop]
+ [/table-organize]
Takes an unorganized set of table cells and organizes them into
rows based on the number of columns; it will also break them into
@@ -137,25 +137,27 @@
<td align=left> </td>
</tr>
- If the attribute columnize=1 is present, the result will look like:
+If the attribute columnize=1 is present, the result will look like:
- <tr bgcolor="#EEEEEE">
- <td align=right>1</td>
- <td align=center>1a</td>
- <td align=left>1b</td>
- </tr>
- <tr bgcolor="#FFFFFF">
- <td align=right>2</td>
- <td align=center>2a</td>
- <td align=left> </td>
- </tr>
- <tr bgcolor="#EEEEEE">
- <td align=right>3</td>
- <td align=center>3a</td>
- <td align=left> </td>
- </tr>
+ <tr bgcolor="#EEEEEE">
+ <td align=right>1</td>
+ <td align=center>1a</td>
+ <td align=left>1b</td>
+ </tr>
+ <tr bgcolor="#FFFFFF">
+ <td align=right>2</td>
+ <td align=center>2a</td>
+ <td align=left> </td>
+ </tr>
+ <tr bgcolor="#EEEEEE">
+ <td align=right>3</td>
+ <td align=center>3a</td>
+ <td align=left> </td>
+ </tr>
See the source for more ideas on how to extend this tag.
+
+=cut
EOD
UserTag table-organize Routine <<EOR