bitlair/revbank
6
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Products.pm: Document #OPAQUE and read_products

Browse source
This commit is contained in:
Juerd Waalboer 2024-12-26 03:27:57 +01:00
parent 3c6ee11abd
commit 33f5cc1b21
2 changed files with 34 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
lib/RevBank/Products.pm
View file

@ -99,6 +99,7 @@ sub read_products($filename = "revbank.products", $default_contra = "+sales/prod
for my $id (@ids) { for my $id (@ids) {
warn "Product '$id' redefined at $filename line $linenr (original at line $products{$id}{line}).\n" if exists $products{$id}; warn "Product '$id' redefined at $filename line $linenr (original at line $products{$id}{line}).\n" if exists $products{$id};
# HERE (see .pod)
$products{$id} = { $products{$id} = {
id => $ids[0], id => $ids[0],
description => $desc, description => $desc,

37
lib/RevBank/Products.pod
View file

@ -8,8 +8,8 @@ RevBank::Products - Product list
# Empty lines are ignored. # Empty lines are ignored.
8710447032756 0.80 "Festini Peer" 8710447032756 0.80 "Festini Peer"
4029764001807,clubmate 1.40 "Club-Mate" +half +pf 4029764001807,clubmate 1.40 "Club-Mate" +pf +half
pf 0.15@+pfand "Pfand NRW-Flasche" pf 0.15@+pfand "Pfand NRW-Flasche" #OPAQUE
+half -50% "50% discount \\o/" +half -50% "50% discount \\o/"
123 0.42 "Hashtag example" #tag #tag2=42 123 0.42 "Hashtag example" #tag #tag2=42
@ -19,6 +19,14 @@ This module implements a products database, based on a text file. It supports
additional fees, discounts, compound products, and optional metadata that can additional fees, discounts, compound products, and optional metadata that can
be read by plugins. be read by plugins.
=head2 read_products
The only function of this module is exported by default. It returns a reference
to a hash of products (each represented as a hash), keyed by product id.
The available keys per product are currently not documented; refer to the
C<Products.pm> file after the line that is commented C<# HERE> for a list.
=head1 CONFIGURATION =head1 CONFIGURATION
The configuration for this plugin lives in a text file called The configuration for this plugin lives in a text file called
@ -143,8 +151,29 @@ value part.
ht2 0.42 "Two hashtags!" #tag #key=value ht2 0.42 "Two hashtags!" #tag #key=value
ht3 0.42 "Surprising syntax" "#x=spaces in value" ht3 0.42 "Surprising syntax" "#x=spaces in value"
Tags can be accessed by custom plugins, but are currently ignored by upstream Tags can be accessed by custom plugins.
RevBank and its plugins.
The following tags are used by RevBank itself:
=over 10
=item C<#OPAQUE>
When used on an addon, the price of the addon will be excluded when calculating
the tag price. The default is to use transparent pricing, i.e. that all
additional fees are included in the tag price. In specific cases, such as
container deposits, the addon price should not be considered part of the
product price, and C<#OPAQUE> can be used.
The tag price is not displayed in the RevBank user interface, but may be used
in generated price tags and price listings.
The sum of a product's opaque prices is available via the key C<hidden_fees>.
=back
By convention, tags that affect internal semantics get uppercase names. It is
suggested that tags used only by plugins get C<lowercase> names.
=head3 Other additional fields =head3 Other additional fields