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