Location: PHPKode > projects > PHP Flat File Guestbook > ffguestbook/docs/configure.htm
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>

<title> PHP Flat File Guestbook, from AdvanceByDesign </title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<link rel="stylesheet" type="text/css" href="styles.css">

</head>
<body>

<table border="0" cellpadding="0" cellspacing="0" width="500px">
<tr><td>
[ <a href="index.htm">Documentation index</a> --
<a href="../index.htm">Welcome page</a> ]

<!-- Begin page content -->

<h1>PHP Flat File Guestbook Documentation</h1>

<h2>Configurable Settings</h2>

<p>To change some of the Guestbook settings, open the file
'<i>ffgb_config.php</i>' from the 'www' folder in a plain-text
editor (for example Windows Notepad) and find the line that
begins <i>define("SETTING_NAME", ...</i> Where <i>SETTING_NAME</i>
is the Configurable Setting you wish to change, and change the
value between the comma ',' and the end bracket ')' for a
suitable value (see the list below).</p>

<ul>
	<li><b>ADMIN_USER</b>
		<p>The <i>username</i> to log in to the Administrative
		area.  The value provided should include only letters,
		numbers, spaces and underscores, and should be enclosed
		inside speach marks (for example: <code>define("ADMIN_USER", "MrAdmin");</code>
		would set the username for the Admin section to <i>MrAdmin</i>).</p></li>
	<li><b>ADMIN_PASS</b>
		<p>The <i>password</i> to log in to the Administrative
		area.  The value provided should include only letters,
		numbers, spaces and underscores, and should be enclosed
		inside speach marks (for example: <code>define("ADMIN_PASS", "qwerty");</code>
		would set the username for the Admin section to <i>qwerty</i>).</p></li>
	<li><b>COMMENTS_REQUIRE_VALIDATION</b>
		<p>Whether or not comments must be validated by the Guestbook
		owner before being displayed to visitors.  This can help prevent
		spam or abuse of the Guestbook, if needed.  (For example:
		<code>define("COMMENTS_REQUIRE_VALIDATION", true);</code>
		would mean all comments would have to be activated from within
		the Administration area to be viewable).</p></li>
	<li><b>COMMENTS_REQUIRE_EMAIL</b>
		<p>Whether or not comments require a valid email address in order
		to be accepted. If this is set to false the visitor can either post
		an email address or leave the field blank (For example:
		<code>define("COMMENTS_REQUIRE_EMAIL", true);</code>
		would mean all comments would need a valid email address to be
		supplied with them).</p></li>
	<li><b>COMMENTS_SHOW_EMAIL</b>
		<p>If a valid email address is supplied with a comment and this
		setting is true, the comment will have the email address shown with it,
		as well as a "mailto:" link.  If set to false, the email address will
		not be made public.</p></li>
	<li><b>COMMENTS_ACCEPT_URL</b>
		<p>If set to true, the visitor can also post a URL to their website
		with their comment.  If set to false, the URL is not asked for.</p></li>
	<li><b>COMMENTS_SHOW_URL</b>
		<p>If set to true and a comment has had a valid URL supplied with it,
		the visitors URL will be displayed with their comment.  If set to
		false, the URL will not be shown, even if present.</p></li>
	<li><b>COMMENT_MAX_LENGTH</b>
		<p>The maximum length (in characters) of the comment the visitor
		can post on your Guestbook.  Longer comments will not be accepted
		and the visitor will be shown an error message.  Minimum message
		length is 3 characters (for example:
		<code>define("COMMENT_MAX_LENGTH", 1000);</code>
		sets the maximum number of characters in a comment to 1000).</p></li>
	<li><b>SUBJECT_MAX_LENGTH</b>
		<p>The maximum length (in characters) of the subject the visitor
		can supply for their comment.  The visitor can choose not to supply
		any subject if they do not wish to.</p></li>
	<li><b>ACCEPT_NEW_COMMENTS</b>
		<p><i>true</i> or <i>false</i>; should the guestbook accept new
		comments from visitors?  You may wish the disable the posting of new
		comments for maintenance or if you will be unable to manage your
		website for a while, in which case you can set ACCEPT_NEW_COMMENTS
		to <i>false</i>.</p></li>
	<li><b>COMMENTS_PER_BOOK</b>
		<p>The maximum number of visitor comments stored in a Guestbook file.
		This is also the maximum number of comments that may be shown per page
		of your Guestbook to visitors.</p></li>
	<li><b>EMAIL_NEW_COMMENTS</b>
		<p><i>true</i> or <i>false</i>; if <i>true</i>, you will be automatically
		emailed at the configurable address EMAIL_TO every time a new user
		comment is posted on the Guestbook.</p></li>
	<li><b>EMAIL_TO</b>
		<p>The address on which you will be alerted of a new comment being posted
		if the configurable setting EMAIL_NEW_COMMENTS is set to <i>true</i>
		(for example:
		<code>define("EMAIL_TO", "hide@address.com");</code>
		will send an email notification to <i>hide@address.com</i> when
		a new comment is posted).</p></li>
</ul>

<!-- End Page Content -->
</td></tr>
</table>

</body>
</html>
Return current item: PHP Flat File Guestbook