0.15_16 commit
[bse.git] / site / docs / config.pod
CommitLineData
61551101
TC
1=head1 NAME
2
3config.pod - documents BSE configuration file options
4
5=head1 DESCRIPTION
6
7BSE historically used Constants.pm to keep most configuration
8information. The plan is to make sure any new configuration is kept
9in bse.cfg, and to slowly move most configuration information into
10bse.cfg.
11
12Keeping configuration information in Constants.pm makes it difficult
13to perform upgrades and makes it impossible to use tools such as
14mod_perl, at least if you want more than one site on the machine.
15
16=head1 CONFIGURATION ENTRIES
17
41f10371
TC
18=head2 [site]
19
20Contains URL configuration for the site.
21
22=over
23
24=item url
25
26The normal URL for the non-secure parts of the site.
27
28=item secureurl
29
30The secure URL for the shop, products and other portions of the site
31that should use SSL. This isn't checked to make sure it is https.
32
33=item name
34
35Used as the site "name" in a few places.
36
37=item adminurl
38
39If set, this is used as the base URL for accessing the administrative
40functions of your site.
41
42=item secureadmin
43
44Ignored if C<adminurl> is set.
45
46If this is true then C<secureurl> is used as the base URL for
47accessing the administrative functions of your site, otherwise C<url>
48is used as the base URL. Default: false (C<url>'s value is used)
49
50=back
51
61551101
TC
52=head2 [paths]
53
54Contains various file system paths.
55
56=over
57
58=item downloads
59
60This is where the files uploads with the file wizard are stored. It
61must be writable by the web server user.
62
63=item admin_templates
64
65Directory containing administrative templates. Note: this is not
66completely implemented for now, so assume the default. Default: admin
67directory under $TMPLDIR.
68
69=item templates
70
aefcabcb
TC
71Directory base for most templates.
72
73=item local_templates
74
75Local Directory base for templates. This is searched before the
76templates directory.
61551101 77
ca9aa2bf
TC
78=item images
79
80Where uploaded images are stored. This is not yet completely
81implemented. Default: $IMAGEDIR.
82
331fd099
TC
83=item libraries
84
85Local search path for BSE::Custom, or the class configured by
86C<custom_class> in [basic].
87
3c32512d
TC
88=item siteuser_images
89
90Where uploaded siteuser images are stored. This must be set in the
91config file. The default bse.cfg include an entry to use the current
92values of [paths].downloads
93
61551101
TC
94=back
95
96=head2 [extensions]
97
98This section is used by the file wizard to map uploaded file
99extensions to MIME content types. This can be used to extend
100BSE::FileEditor's internal extension map. It cannot override that
101map.
102
103The key for each entry is the extension, without the leading '.'.
104
105eg.
106
107 xls = application/msexcel
108
109=head2 [templates]
110
111Used for translating symbolic template names into full names under the
112template directory.
113
114In each case the default is the name with a C<.tmpl> extension.
115
116=over
117
118=item user/logon
119
120user logon page
121
122=item user/register
123
124user registration page
125
126=back
127
128=head2 [admin templates]
129
130Used for translating the names of administration templates into filenames.
131
132In each case the default is the name with a C<.tmpl> extension.
133
134=over
135
136=item filelist
137
138article file wizard
139
d2730773
TC
140=item catalog
141
142Catalog editor page. Default admin/edit_catalog.tmpl
143
144=item 1
145
146=item 2
147
148=item 3
149
150=item 4
151
152=item 5
153
154Article edit pages. Default admin/edit_<number>.tmpl
155
156=item steps
157
158Step child/parent management page. Default admin/edit_steps.tmpl
159
61551101
TC
160=back
161
162=head2 [html]
163
164Minor html items.
165
166=over
167
168=item charset
169
170The value of the charset keyword when outputting HTML from a script.
171Set to the empty string to suppress the charset keyword. Default:
172iso-8859-1.
173
174=back
175
176=head2 [basic]
177
178=over
179
180=item cookie_lifetime
181
182The expiry time for cookies. This should be in the form supported by
183CGI.pm for the -expires parameter. Typically you want a plus ('+'), a
184number, and a time character (s - seconds, m - minutes, h - hours, d -
185days, M - months). Default: +3h
186
187=item minpassword
188
189Minimum password length in characters. Default: 4.
190
b19047a6
TC
191=item randomdata
192
193Device to read random data from. This device should not block when it
194runs out of entropy.
195
6e3d2da5
TC
196=item sign
197
198If this is true then the encrypted messages containing the customer's
199credit card number are sent to the shop owner signed. To avoid
200keeping a passphrase and signing key on the server you can set this to
201false (0). This has the effect that anyone could send you an unsigned
202message encrypted with your public key, though this may not be a
203security threat. Default: True.
204
ca9aa2bf
TC
205=item link_titles
206
207If this is true then the links to your articles within BSE will be
208followed by a / and then by a simplified version of the article title.
209The aim is to include at least some title information in the URL
210without modifying the name of the HTML file. Default: False.
211
9168c88c
TC
212=item access_control
213
214If this is true then the user/group/permissions database is used to
215control access to the system. Default: False.
216
d49f56a6
TC
217=item server_auth
218
219Set this to non-zero to enable authentication via server
220authentication (usually Basic Authentication.) You should normally
221set this if you set htusers below. Default: 0 (disabled)
222
9168c88c
TC
223=item htusers
224
225This should be the path to a file to be updated with the list of users
226and crypt() versions of their passwords. If this is set then the
227security system will check for a user set by the browser before
228attempting a form based logon. Default: None.
229
331fd099
TC
230=item custom_class
231
232The name of the custom class for your site. This is currently only
233used for article editing customizations. This class should derive
234from BSE::CustomBase. Default: BSE::Custom.
235
b19047a6
TC
236=back
237
238=head2 [mail]
239
35c0719f 240This section controls how BSE sends email.
b19047a6
TC
241
242=over
243
244=item smtp_server
245
246The host or IP address of your mail server. If this is not set
247C<sendmail> will be used instead. If this is set you must also set
248I<helo>.
249
250=item helo
251
252The name that BSE uses to identify itself when sending mail via SMTP.
253Required if I<smtp_server> is set.
254
255=item sendmail
256
257The path to the C<sendmail> binary. Default: /usr/lib/sendmail
258
259=item sendmail_opts
260
261The options supplied to sendmail. Default: -t -oi
262
263You may want to add the -odq option to this if you want mail queued
264rather than sent immediately.
265
61551101
TC
266=back
267
ca9aa2bf 268=head2 [children of I<id>]
721cd24c
TC
269
270Where I<id> is the identifier for an article.
271
272=over
273
274=item template
275
276the name of the default template for children of the given parent
277
278=item template_dirs
279
280a comma-separated list of extra directories under $TMPLDIR to search
281for templates that can be used for children of the given parent article.
282
283=back
284
ca9aa2bf
TC
285=head2 [article I<id>]
286
287Where I<id> is the identifier of an article.
288
289=over
290
291=item template_dirs
292
293A comma-separated list of extra directories under $TMPLDIR to search
294for templates that can be used for children of the given parent
295article.
296
297=item extra_templates
298
299A comma-separated list of extra templates under $TMPLDIR that can be
300used for the given article.
301
302=back
303
caa7299c
TC
304=head2 [level I<level>]
305
306=over
307
308=item template
309
310The default template for this level of article, assuming it hasn't
311been set in the [children of I<article id>] section.
312
313=item template_dirs
314
315A comma-separated list of extra directories under $TMPLDIR to search
316for templates that can be used for articles at the given I<level>.
317
318=back
319
320=head2 [catalogs]
321
322=over
323
324=item template
325
326The default template for catalogs.
327
328=back
329
330=head2 [products]
331
332=over
333
334=item template
335
336The default template for products.
337
d64413ee
TC
338=item extra_templates
339
340A comma separated list of extra templates that can be used for
341products.
342
caa7299c
TC
343=back
344
61551101
TC
345=head2 [messages]
346
347This can be used to control translation of error messages. Each key
348has a prefix identifying the module that uses the error, followed by
349'/' followed by a specific identifier for the message.
350
351Message parameters, expressed as $I<digit>, are replaced with the
352parameters passed to the message. C<$$> is replaced with C<$>.
353
354Each message identifier below is documented with the id, when it
355occurs, the default message, and any parameters.
356
357=over
358
359=item user/needlogon
360
361the user attempted to logon without entering a logon name. Default:
362"Please enter a logon name". No parameters.
363
364=item user/needpass
365
366the user attempted to logon without entering a password. Default:
367"Please enter your password." No parameters.
368
369=item user/baduserpass
370
371the user's logon name or password was not found or did not match.
372Default: "Invalid user or password". No parameters.
373
374=item user/notloggedon
375
376the user attempted to logoff while not logged on. Default: "You
377aren't logged on". No parameters.
378
379=item user/optsoldpass
380
381the user entered a new password on the options page without entering
382their old password. Default: "You need to enter your old password to
383change your password". No parameters.
384
385=back
386
2404a911
TC
387=head2 [downloads]
388
389=over
390
391=item must_be_paid
392
393if non-zero, the order must be marked as paid for before the file can
394be downloaded.
395
396=item must_be_filled
397
398if non-zero the order must be marked as filled before the files can be
399downloaded.
400
4afdbb1b
TC
401=item require_logon
402
403if non-zero the user must be registered/logged on to download I<any>
404file.
405
2404a911
TC
406=back
407
b19047a6
TC
408=head2 [confirmations]
409
410Control over confirmation emails.
411
412=over
413
414=item subject
415
416The subject of email confirmation emails. Default: Subcription
417Confirmation.
418
419=item from
420
421The from field for the email. Default: $SHOP_FROM
422
423=back
424
531fb3bc
TC
425=head2 [subscriptions]
426
427Control over subscription messages.
428
429=over
430
431=item from
432
433The from field for the email. Default: $SHOP_FROM.
434
d09682dd
TC
435=item testname
436
437Default for the "Test Name" field for sending test subscription
438messages.
439
440=item testemail
441
442Default for the "Test Email" field for sending test subscription
443messages.
444
445=item testtextonly
446
447Set to 1 if you want the "Test Text Only" box checked by default for
448sending test subscription messages.
449
450=item testing
451
452Set to 0 to disable display of the test subscription messages portions
453of the subscriptions send form.
454
99b7cef0
TC
455=item text_link_inline
456
457Set to format links as they appear in the text version of emails.
458C<$1> is replaced with the title, C<$2> with the URL and C<$3> with
459the index. C<$$> is replaced with '$'. Default: C<$1 [$3]>
460
461=item text_link_list
462
463Set to format links as they appear at the footer of the body text. If
464this is set to the empty string then no list appears. C<$1>, C<$2>,
465C<$3>, C<$$> are replaced as for I<text_link_inline> and $n is
466replaced with newline. Default: C<[$3] $2>
467
468=item text_link_list_prefix
469
470A line of text produced above the list of URLs if there is one.
471Default: C<----->. $n in this is replaced with newlines.
472
531fb3bc
TC
473=back
474
99b7cef0
TC
475For example, if the configuration is:
476
477 text_link_inline="$1" ($3)
478 text_link_list_prefix=$n$n-------
479 text_link_list=($3) "$1"$n => $2
480
481and the body text is:
482
483 doclink[3]
484 link[http://www.example.com/|Example]
485
486the result will be:
487
488 "The Shop" (1)
489 "Example" (2)
490
491
492 -------
493 (1) "The Shop"
494 => http://www.yoursite.com/shop/index.html
495 (2) "Example"
496 => http://www.example.com/
497
6e3d2da5
TC
498=head2 [search]
499
500=over
501
502=item highlight_partial
503
504If this is true then partial matches will be highlight in search
505result excerpts. Default: True
506
507=back
508
509=head2 [shop]
510
511=over
512
7b81711b
TC
513=item enabled
514
515Used by some templates to check if the shop is enabled. Set this to 1
516to enable the shop, or 0 to disable it.
517
6e3d2da5
TC
518=item register_if_files
519
520If true the customer is required to register before checkout if there
521are any for sale files attached to products in the cart. Default: True
522
523=item require_logon
524
525If true the customer is required to be logged on before checkout,
526whether or not for sale files are attached to products in the cart.
527Default: False.
528
08123550
TC
529=item payment_types
530
531A comma-separated list of acceptable payment types. Default: 0
532
533The possible payment types are:
534
535=over
536
537=item *
538
5390 - the user enters a credit card number, name and expiry date
540
541=item *
542
5431 - the customer will send a cheque
544
545=item *
546
5472 - contact customer for details
548
549=back
550
81f3292d
TC
551Other types can be added by adding entries to the [payment type names]
552and [payment type descs] sections.
553
08123550
TC
554=item address1
555
556=item address2
557
558=item address3
559
560These are used by various shop templates to present an address that a
561cheque payment should be sent to.
562
331fd099
TC
563=item from
564
565From email address for emails sent by the shop. Overides $SHOP_FROM
566in Constants.pm
567
568=item to_name
569
570To name for emailed orders sent by the shop. Overrides $SHOP_TO_NAME
571in Constants.pm
572
573=item to_email
574
575To email for emailed orders sent by the shop. Overrides $SHOP_TO_EMAIL
576in Constants.pm
577
d09682dd
TC
578=item noencrypt
579
580If this is true then orders sent to you by the shop will not be
581encrypted. Enabling this disabled acceptance of credit card orders,
582and the default for C<payment_types> will become C<1> instead or C<0>.
583
584Please realize that other potentially commercially sensitive
585information is being sent in the clear to a central location,
586unencrypted.
587
588=item email_order
589
590If true, then the order is email to to_email, possibly with credit
591card information included. Default: $SHOP_EMAIL_ORDER.
592
d49f56a6
TC
593=item display_I<field>
594
595Used to translate the stored order field name into a presentation name
596suitable for error messages.
597
41e7c841
TC
598=item cardprocessor
599
600The name of a class to load to process credit card transactions online.
601
602Currently this can be either DevHelp::Payments::Test or
603DevHelp::Payments::Inpho.
604
6e3d2da5
TC
605=back
606
41e7c841
TC
607=head2 [Shop Order Validation]
608
609This section can contain extra order validation information, including
610specifying required fields, display names and extra validation rules.
611
6e3d2da5
TC
612=head2 [fields]
613
614=over
615
616=item title_size
617
618The maximum length of the article title field. Default: 255. Should
619not be set higher than this unless you change the database schema.
620
621=back
622
ee6577c3
TC
623=head2 [interest]
624
625Controls the interest.pl script.
626
627=over
628
629=item notify
630
631Email address that is notified of the interest. Defaults to $SHOP_FROM.
632
ca9aa2bf 633=back
ee6577c3 634
6e3d2da5
TC
635=head2 [debug]
636
637Used for debugging.
638
639=over
640
641=item logon_cookies
642
643When a user logs on, and the site url is different to the secure url
644BSE attempts to refresh to the other "side" of the site to set the
645same cookie.
646
647BSE does some simple comparisons to attempt to determine whether the
648logon form was triggered on the secure side of the site (possibly from
649the shop) or on the insecure side. Since CGI doesn't necessarily give
650us all the information required, it's possible it will guess wrong.
651
d2730773
TC
652Setting this option to 1 will enable debugging information sent to
653standard error, which will be sent to the error log on Apache. This
654probably isn't useful on IIS.
655
656=item file_unlink
657
658Reports errors to STDERR (hence to the error log on Apache) if there
659is a problem deleting the actual file when an attached file is
660removed.
661
662=item mail_encryption
663
664Reports debugging information to standard error while encrypting your
665mail.
6e3d2da5 666
2d873eb6
TC
667=item cookies
668
669Reports cookies received from the browser and sent to the browser to
670STDERR (hence to the error log on Apache.)
671
4175638b
TC
672=item dump_session
673
674If nonzero the session hash is dumped to STDERR after it is retrived
675from the database.
676
af74f0b4
TC
677=item subscription_expiry
678
679If non-zero then subscription expiry date calculations are dumped to
680STDERR.
681
ca9aa2bf
TC
682=back
683
684=head2 [uri]
685
686Contains various URIs.
687
688This is underused, so don't rely on it yet.
689
690=over
691
692=item cgi
693
694The URI to the CGI directory. Default: /cgi-bin
695
696=item images
697
698The URI where images are kept. Default: /images
699
700=item shop
701
702=item articles
703
9168c88c 704=back
ca9aa2bf 705
9168c88c 706=head2 [articles]
ca9aa2bf 707
9168c88c
TC
708This will provide translations from symbolic names to article ids.
709
710Currently this is used for converting article ids in the access
711control code, and for looking up the id of the shop.
6e3d2da5 712
0b406a07
TC
713=head2 [printable type]
714
715If the user supplies a template name to printable.pl then you can use
716a different content type by adding an entry to this section. The key
717is the template name, and the value is the full content type.
718
918735d1
TC
719=head2 [search index scores]
720
721This section is used when generating the search index to override the
722default scores for each field in the articles.
723
724The default scores are:
725
726 Field Score
727 ----- -----
728 title 5
729 body 3
730 keyword 4
731
732A special key C<file_description> can be used here to set the score
733for indexing downloadable file descriptions, which aren't indexed by
734default. A good value is probably 2 or 1.
735
736=head2 [article flags]
737
738=head2 [product flags]
739
740=head2 [catalog flags]
741
742Flags that can be set for articles, products and catalogs
743respectively. Note that flags for articles are also visible in
744products and catalogs.
745
746All flag Ids are single letters or digits. Uppercase letters are
747reserved for use by BSE internally, leaving lower-case letters and
748digits for your own use.
749
750Use the id of the flag as the key, and a description of the flag as
751it's value.
752
95989433
TC
753=head2 [article uris]
754
755Each key is an article id, the values are base URIs to store the HTML
756form of those articles and their children under.
757
758=head2 [protect link]
759
760The keys are ids of articles that shouldn't have their link field
761overwritten. The value should be a true value, but is otherwise
762ignored.
763
d09682dd
TC
764=head2 [datadump]
765
766=over
767
768=item to
769
770The recipient for the data dump email sent by datadump.pl. Default:
771$DATA_EMAIL.
772
773=item from
774
775the From for the data dump email sent by datadump.pl. Default:
776$SHOP_FROM.
777
778=back
779
2a295ea9
TC
780=head2 [site users]
781
782Configuration for site users.
783
784=over
785
786=item nopassword
787
788If this is set to true then no passwords are required during
789registration, a confirmation email is sent immediately upon
790registration and that confirmation email contains a link the user can
791use to manage their details.
792
793This option has some security concerns since it can leave links to the
794user's information in the browser history. This option is not
795recommended.
796
797You cannot use this to control access to the shop.
798
799=item require_name1
800
801=item require_name2
802
803=item require_address
804
805=item require_city
806
807=item require_state
808
809=item require_postcode
810
811=item require_telephone
812
813=item require_facsimile
814
815=item require_country
816
817=item require_title
818
819=item require_organization
820
821Set these to true to require the corresponding field during
822registration, and to keep it required after modification. Default:
823false.
824
825If you enable any of these, you should enable C<info_on_register> as
826well, or modify the registration template to include the given fields.
827
828=item display_I<field name>
829
830Controls how the given field is displayed in error messages. If you
831change the field names on the registration and/or options forms you
832should probably change them here too. Default: internal field name
833with the first character converted to upper-case.
834
835=item info_on_register
836
837If this is set then the user info is prompted for during user
838registration. The information still isn't required unless the
839appropriate require_I<field> option is set. Default: false.
840
841=item register_refresh
842
843The default URL to refresh to on completing registration if no r
844parameter is supplied.
845
846=item subscribe_all
847
848If this is set then the subcription checkboxes are all checked on
849registration by default. Default: false.
850
851The user will only receive the subscriptions if they leave them checked
852and follow the link in the confirmation email.
853
854=item subscribe_I<id>
855
856Where I<id> is the number identifying a subscription. If this is set
857then the subscription checkbox for that subscription will be checked
858by default on the registration form. Default: false.
859
860The user will only receive the subscriptions if they leave it checked
861and follow the link in the confirmation email.
862
863You can get the I<id> of a subcription by looking at the Edit link on the
864subscriptions management page, the number after "id=" is the id.
865
9063386f
TC
866=item billing_on_main_opts
867
868If set to zero then user billing options will be managed on a separate
869page. This is controlled by the user/options_base.tmpl template.
870
871=item user_register
872
873If set to zero then users cannot register themselves. Default: true,
874allowing users to register themselves.
875
2a295ea9
TC
876=back
877
81f3292d
TC
878=head2 [payment type names]
879
880This section and [payment type descs] are used to configure new
881paymeny type ids.
882
883The key is the integer representing the payment type. The value is
884the name used in tags for checking the payment type.
885
886You can also add a description (currently unused) to [payment type
887descs].
888
889You should use numbers starting from 10 to avoid conflicts with future
890BSE payment types.
891
892=head2 [payment type descs]
893
894See [payment type names].
895
896=head2 [payment type required]
897
898Set the key given by the payment type id to a value of a
899comma-separated list of fields required for that payment type.
900
3ae524f3
TC
901=head2 [help style I<style-name>]
902
903This type of configuration section is used to set values for a style
904of help icon. Only the C<template> and C<prefix> values are used
905directly by the code, the others are used by the default helpicon
906templates.
907
908=over
909
910=item prefix
911
912The URI to the help files for this style. Default: /help/ in style
913"user", /admin/help/ in style "admin".
914
915=item template
916
917The template used to produce the icon. Default: helpicon in style
918user, admin/helpicon in style "admin".
919
920=item icon
921
922URI to the help icon image. Default: /images/admin/help.gif
923
924=item iconwidth
925
926The width of the help icon image. Default: 16
927
928=item iconheight
929
930The height of the help icon image. Default: 16
931
932=back
933
934If you just want to change the help icon image for user help icons you
935might do:
936
937 [help style user]
938 icon=/images/help.gif
939
4175638b
TC
940=head2 [affiliate]
941
942=over
943
944=item allowed_referer
945
946A semi-colon (;) separated list of referer domains that are allowed to
947link to the C<a_set> target of L<affiliate.pl>.
948
949If the user's browser supplies a referer header then it will be
950checked against this list.
951
952=item require_referer
953
954If this is set then the C<a_set> target of L<affiliate.pl> will
955require that the user's browser supply a Referer header.
956
957=item default_refresh
958
959If no C<r> parameter is supplied to the C<a_set> target of
960L<affiliate.pl> then this is used as the default refresh.
961
962Default: the site base url.
963
829c9ed9
TC
964=item subscription_required
965
966This is either the numeric or text of a subscription for which the
967affiliate must have an active subscription.
968
fdc2b7a2
TC
969=item flag_required
970
971A single letter flag which the site administrator must set for the
972affiliate page to be displayed for the given member.
973
ea646070
TC
974=item set_cookie
975
976If this is set then affiliate.pl will set the named cookie to the
977affiliate id.
978
979=item linkbaseurl
980
981Used as the link base URL for the afflink.tmpl side bar template when
982an affiliate id is set. Default: example.com
983
984=item linkbasedesc
985
986Used at the text of the link for the afflink.tmpl side bar template
987when an affiliate id is set. Default: Your Site.
988
989=item linkdefurl
990
991Used as the link URL for the afflink.tmpl side bar template when an
992affiliate id is not set. Default: example.com
993
994=item linkdefdesc
995
996Used as the text of the link for the afflink.tmpl side bar template
997when an affiliate id is not set. Default: Our site
998
4175638b
TC
999=back
1000
3c32512d
TC
1001=head2 [BSE Siteuser Images]
1002
1003Each key is the id of a member image, with a corresponding [BSE
1004Siteuser Image I<image_id>] section. The values are ignored.
1005
1006=head2 [BSE Siteuser Image I<image_id>]
1007
1008Provides information about a single member image "template".
1009
1010=over
1011
1012=item description
1013
1014Short description on the image, like "Logo". Used in error messages.
1015
1016=item help
1017
1018Longer description of the image. Accessible with the member_image tag.
1019
1020=item minwidth
1021
1022=item minheight
1023
1024=item maxwidth
1025
1026=item maxheight
1027
1028The minimum and maximum dimensions of the image.
1029
1030=item widthsmallerror
1031
1032=item heightsmallerror
1033
1034=item widthlargeerror
1035
1036=item heightlargeerror
1037
1038Error messages displayed in the when the image is outside the
1039configured dimensions.
1040
1041=item largeerror
1042
1043=item smallerror
1044
1045Default error messages for the above.
1046
1047=item maxspace
1048
1049Maximum storage the image can use in bytes. Default: 1000000.
1050
1051=item spaceerror
1052
1053Error message displayed if the image uses too much storage.
1054
1055=back
1056
ab2cd916
TC
1057=head2 [editor]
1058
1059Various editor settings.
1060
1061=over
1062
1063=item allow_thumb
1064
1065If this is non-zero the system will attempt to load the configured
1066thumbnail class, and put thumbnail images on the image manager page
1067rather than full-size images. Default: off
1068
1069=item thumbs_class
1070
1071The name of a perl class that implement's BSE's thumbnail API. At
1072this point the only class that implements that is BSE::Thumb::Imager,
1073supplied with BSE. Default: None
1074
1075=item default_thumbnail
1076
1077URI to the default thumbnail image. This is presented when the
1078runtime production of a thumbnail image fails.
1079
1080=item default_thumbnail_width
1081
1082=item default_thumbnail_height
1083
1084Dimensions of the default thumbnail image.
1085
1086=item default_thumbnail_alt
1087
1088Alt text for the default thumbnail image.
1089
1090=back
1091
1092=head2 [thumbnails]
1093
1094=over
1095
1096=item max_width
1097
1098=item max_height
1099
1100=item max_pixels
1101
1102Default values for the thumbimage tag.
1103
1104=back
1105
829c9ed9
TC
1106=head2 [includes]
1107
1108Each value is used as the relative or absolute name of a file or
1109directory to load more configuration data from.
1110
1111The keywords must remain unique.
1112
1113Only the [includes] section from bse.cfg itself is used to locate more
1114configuration data.
1115
1116If the value references a directory, all files with an extension of
1117C<.cfg> are read for configuration data.
1118
1119The order the files are read (which later files overriding older
1120files) is:
1121
1122=over
1123
1124=item 1.
1125
1126bse.cfg is read
1127
1128=item 2.
1129
1130the entries in [includes] are sorted alphabetically (or rather
1131asciily), so an entry with key "A" is read before one with key "B",
1132one with key "01" is read before "02", but key "10" would be read
1133I<before> key "2".
1134
1135=item *
1136
1137if an entry is a file then that is read and the values merged.
1138
1139=item *
1140
1141if an entry is a directory, then that is scanned and the files found
1142read alphabetically as above.
1143
1144=back
1145
6a8a6ac5
TC
1146=head2 [error_img]
1147
1148This is used to configure the error icon displayed next to fields that
1149fail validation.
1150
1151=over
1152
1153=item image
1154
1155URI to the image file.
1156
1157=item width
1158
1159=item height
1160
1161The width and height of the error icon image.
1162
1163=back
1164
fdc2b7a2
TC
1165=head2 [site user flags]
1166
1167Flags that can be set for site users.
1168
1169All flag Ids are single letters or digits. Uppercase letters are
1170reserved for use by BSE internally, leaving lower-case letters and
1171digits for your own use.
1172
1173Use the id of the flag as the key, and a description of the flag as
1174it's value.
1175
deae2a52
TC
1176=head2 [article defaults]
1177
1178=head2 [catalog defaults]
1179
1180=head2 [product defaults]
1181
1182These sections contain defaults values for the corresponding article
1183types.
1184
1185Each key is the name of a column for the article type.
1186
1187If an entry is not found in [catalog defaults] then [article defaults]
1188is also checked.
1189
1190If an entry is not found in [product defaults] then [article defaults]
1191is also checked.
1192
1193These sections are checked B<after> the C<[children of >I<id>C<]> and
1194C<[level >I<level>C<]> sections.
1195
1196These defaults are used when creating an article where no value is
1197supplied, they can also be accessed via the <:default I<name>:> tag.
1198
41e7c841
TC
1199=head2 [inpho]
1200
1201This is used to configure the DevHelp::Payments::Inpho module.
1202
1203=over
1204
1205=item test
1206
1207If this is set then the test parameters are used instead of the
1208product values.
1209
1210=item url
1211
1212The URL to process requests through.
1213
1214Default: https://extranet.inpho.com.au/cc_ssl/process
1215
1216=item user
1217
1218Inpho supplied user name.
1219
1220=item password
1221
1222Inpho supplied password.
1223
1224=item test_url
1225
1226The URL to process test requests through.
1227
1228=item test_user
1229
1230The user to supply to test requests.
1231
1232=item test_password
1233
1234The password to supply to test requests.
1235
1236=back
1237
61551101
TC
1238=head1 AUTHOR
1239
1240Tony Cook <tony@develop-help.com>
1241
1242=cut