git.imager.perl.org - bse.git/blame_incremental

... / ...

Commit	Line	Data
	1	=head1 NAME
	2
	3	config.pod - documents BSE configuration file options
	4
	5	=head1 DESCRIPTION
	6
	7	BSE historically used Constants.pm to keep most configuration
	8	information. The plan is to make sure any new configuration is kept
	9	in bse.cfg, and to slowly move most configuration information into
	10	bse.cfg.
	11
	12	Keeping configuration information in Constants.pm makes it difficult
	13	to perform upgrades and makes it impossible to use tools such as
	14	mod_perl, at least if you want more than one site on the machine.
	15
	16	=head1 CONFIGURATION ENTRIES
	17
	18	=head2 [paths]
	19
	20	Contains various file system paths.
	21
	22	=over
	23
	24	=item downloads
	25
	26	This is where the files uploads with the file wizard are stored. It
	27	must be writable by the web server user.
	28
	29	=item admin_templates
	30
	31	Directory containing administrative templates. Note: this is not
	32	completely implemented for now, so assume the default. Default: admin
	33	directory under $TMPLDIR.
	34
	35	=item templates
	36
	37	Directory base for most templates. Note: this is not completely
	38	implemented for now, so assume the default. Default: $TMPLDIR.
	39
	40	=back
	41
	42	=head2 [extensions]
	43
	44	This section is used by the file wizard to map uploaded file
	45	extensions to MIME content types. This can be used to extend
	46	BSE::FileEditor's internal extension map. It cannot override that
	47	map.
	48
	49	The key for each entry is the extension, without the leading '.'.
	50
	51	eg.
	52
	53	xls = application/msexcel
	54
	55	=head2 [templates]
	56
	57	Used for translating symbolic template names into full names under the
	58	template directory.
	59
	60	In each case the default is the name with a C<.tmpl> extension.
	61
	62	=over
	63
	64	=item user/logon
	65
	66	user logon page
	67
	68	=item user/register
	69
	70	user registration page
	71
	72	=back
	73
	74	=head2 [admin templates]
	75
	76	Used for translating the names of administration templates into filenames.
	77
	78	In each case the default is the name with a C<.tmpl> extension.
	79
	80	=over
	81
	82	=item filelist
	83
	84	article file wizard
	85
	86	=back
	87
	88	=head2 [html]
	89
	90	Minor html items.
	91
	92	=over
	93
	94	=item charset
	95
	96	The value of the charset keyword when outputting HTML from a script.
	97	Set to the empty string to suppress the charset keyword. Default:
	98	iso-8859-1.
	99
	100	=back
	101
	102	=head2 [basic]
	103
	104	=over
	105
	106	=item cookie_lifetime
	107
	108	The expiry time for cookies. This should be in the form supported by
	109	CGI.pm for the -expires parameter. Typically you want a plus ('+'), a
	110	number, and a time character (s - seconds, m - minutes, h - hours, d -
	111	days, M - months). Default: +3h
	112
	113	=item minpassword
	114
	115	Minimum password length in characters. Default: 4.
	116
	117	=back
	118
	119	=head2 [messages]
	120
	121	This can be used to control translation of error messages. Each key
	122	has a prefix identifying the module that uses the error, followed by
	123	'/' followed by a specific identifier for the message.
	124
	125	Message parameters, expressed as $I<digit>, are replaced with the
	126	parameters passed to the message. C<$$> is replaced with C<$>.
	127
	128	Each message identifier below is documented with the id, when it
	129	occurs, the default message, and any parameters.
	130
	131	=over
	132
	133	=item user/needlogon
	134
	135	the user attempted to logon without entering a logon name. Default:
	136	"Please enter a logon name". No parameters.
	137
	138	=item user/needpass
	139
	140	the user attempted to logon without entering a password. Default:
	141	"Please enter your password." No parameters.
	142
	143	=item user/baduserpass
	144
	145	the user's logon name or password was not found or did not match.
	146	Default: "Invalid user or password". No parameters.
	147
	148	=item user/notloggedon
	149
	150	the user attempted to logoff while not logged on. Default: "You
	151	aren't logged on". No parameters.
	152
	153	=item user/optsoldpass
	154
	155	the user entered a new password on the options page without entering
	156	their old password. Default: "You need to enter your old password to
	157	change your password". No parameters.
	158
	159	=back
	160
	161	=head1 AUTHOR
	162
	163	Tony Cook <tony@develop-help.com>
	164
	165	=cut