Location: PHPKode > projects > PHP Flat File Guestbook > ffguestbook/docs/pages.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>List of files and their uses</h2>

<p>Below is a list of files that are needed for this
script to function, and what each one does.</p>

<ul>
	<li>Files found in the '<i>www</i>' folder:
		<ul>
			<li><b>ffgb_config.php</b>
				<p>This file is used to store the <a href="configure.htm">
				Configurable Settings</a> for the Guestbook.</p></li>
			<li><b>ffgb_replace.php</b>
				<p>This file allows you to add or edit the smilies (and other
				replaceable words) the Guestbook can recognise.  For example,
				you can use this page to add a bad-word filter.</p></li>
			<li><b>ffgb_count.php</b>
				<p>This file stores the current number of Guestbook files.
				Once a Guestbook file has been filled, a new one is created.</p></li>
			<li><b>ffgb_admin.php</b>
				<p>This file is used to allow the Guestbook owner to manage
				comments.</p></li>
			<li><b>guestbook.php</b>
				<p>The Guestbook file itself.  You will want to point your
				visitors to this page to read existing comments and post new
				Guestbook entries.</p></li>
			<li>Folder: <b>ffgb_comments</b>
				<p>This folder stores Guestbook files.  Once a Guestbook file
				is filled with comments, a new Guestbook file is created.</p></li>
			<li><b>ffgb_comments/ffgb_1.php</b>
				<p>The first Guestbook entries file.  New ones will be created
				when necessary, and will receive the same name but with the
				number increased by 1 each time.</p></li>
		</ul></li>
</ul>

<ul>
	<li><a href="#guestbook">The main Guestbook page</a></li>
	<li><a href="#login">The Administration area login form</a></li>
	<li><a href="#admin">The Administration and Management Area</a></li>
</ul>

<hr>
<a name="guestbook"></a>
<center><img src="imgs/ex_guestbook.jpg" width="450px" alt="Guestbook"></center>
<h3>The Guestbook's main page</h3>
<p>The main page of the Guestbook is the page your visitors will see
and reply on.</p>
<ol>
	<li>The <i>Pagelist</i>.
		<p>If your Guestbook has more than one page,
		links to each of the pages will be shown here, as well as a basic
		"Forward"/"Back" navigation link.</p></li>
	<li>A <i>visitor comment</i>.
		<p>Active comments that have not been
		disabled or removed will be shown like this.  They will have the
		subject at the top (if one has been provided); the date and time
		the comment was posted below; the visitors URL if one has been
		provided and they have been set to be displayed; A block of text
		which is the visitors comment itself, and then the visitors name
		and (optionally) email address at the bottom right of the comment.
		If email addresses are shown and the visitor has provided one, the
		visitors name can be clicked on to send them an email.</p></li>
	<li>The <i>new comment form</i>.
		<p>If your website accepts new comments, a visitor can fill out this
		form and click "Post Comment" to add a new visitor comment to your
		website.</p></li>
	<li>The <i>Manage this Guestbook</i> link.
		<p>This link takes you to the <a href="#login">Login form</a>
		for the <a href="#admin">Administration area</a>.</p></li>
</ol>

<hr>
<a name="login"></a>
<center><img src="imgs/ex_login.jpg" alt="Login"></center>
<h3>The Administration area login form</h3>

<p>The Login form to access to Administration Area.  This can be accessed
by providing the <i>username</i> and <i>password</i> provided via the
<i>ffgb_config.php</i> file (see: <a href="configure.htm">Configurable Settings</a>).</p>

<hr>
<a name="admin"></a>
<center><img src="imgs/ex_admin.jpg" width="450px" alt="Administration"></center>
<h3>The Administration and Management Area</h3>

<p>The main Administration Area lets you manage posts on your Guestbook.
Posts can be Activated or Deactivated, Removed or Un-removed.</p>

<ol>
	<li>The <i>Logout link</i>
		<p>This link simply removes you from the Administration area and
		removes the saved authentication information from your computer
		(important if accessing the website from a public or shared PC).</p></li>
	<li>View comments By Book
		<p>Select the book from the drop down list, and click the "View Book"
		button to show all comments in the selected Guestbook.</p></li>
	<li>Searching for Comments
		<p>You can search for comments by IP address, Subject, name or
		email address.  For each of these, wildcards '*' can be used.  For
		example, search where the "Email Address" is "*@hotmail.*" would
		find <i>all</i> comments where the visitor provided a <i>hotmail</i>
		email address.</p></li>
	<li>The matched comments
		<p>The comments matching the search criteria or in the book you
		are viewing.  Inactive comments are marked in grey, and removed
		comments are marked in red.  Checking the boxes for the desired
		comments allows you to modify their status.</p></li>
	<li>Modify selected comments
		<p>Comments that have had their checkboxes ticked can now be modified.
		you can select the Activate / Accept comments (make them visible),
		Deactivate (make comments invisible), Remove (Count comments as refused),
		or Un-remove (undo the refusal of comments). Deactivated or Removed
		comments are not shown to visitors.</p></li>
</ol>
<!-- End Page Content -->
</td></tr>
</table>

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