Location: PHPKode > scripts > Dawgclan Network downloader > dawgclan-network-downloader/readme.htm
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>Dawgclan Network Downloader :: Readme</title>
<link rel="stylesheet" type="text/css" href="http://www.dawgclan.net/style.css" />
</head>
<body>
<table border="1" width="98%" align="center" class="content">
  <tr>
    <td>
<div align="center"><img src="http://www.dawgclan.net/img/logo.gif" border="0" alt="Dawgclan Network" /></div><br />
<p>Thank you for downloading Dawgclan Network Downloader. This README will guide you through the basics of installation and operation. Please ensure you read this document fully before proceeding with the installation.</p>
<ol>
<li><a href="#introduction">Introduction</a></li>
<li><a href="#features">Current features</a></li>
<li><a href="#checklist">File checklist</a></li>
<li><a href="#install">Installing the downloader</a></li>
<li><a href="#customizing">Customizing the script</a></li>
<ol type="i">
<li><a href="#cellspacing">Changing the cellspacing</a></li>
<li><a href="#style">Personalizing your downloader</a></li>
<li><a href="#modify">Adding downloads</a></li>
<li><a href="#source">Modifying the sourcecode</a></li>
</ol>
<li><a href="#help">Getting help</a></li>
<ol type="i">
<li><a href="#docs">Online documents</a></li>
<li><a href="#forums">Community forums</a></li>
<li><a href="#irc">IRC (Internet Relay Chat)</a></li>
</ol>
<li><a href="#status">Whats new (version history)</a></li>
<li><a href="#bugs">Reporting bugs/suggesting ideas</a></li>
<li><a href="#currentbugs">List of current bugs</a></li>
<li><a href="#contacts">Contacts</a></li>
<li><a href="#disclaimer">Disclaimer</a></li>
</ol>

<a class="bold rmheader" name="introduction">1. Introduction</a>
<p>Dawgclan Network Downloader is a script written in PHP. It is a download
counter-logger that keeps track of file downloads and hides download
source. The script also includes a statistic page.</p>

<a class="bold rmheader" name="features">2. Current features</a>
<p><ul>
<li>Keep track of file hits.</li>
<li>No MySQL database needed, all stats are viewed and logged via a textfile.</li>
<li>Web-based statistics page available.</li>
<li>No multiple txt files for logging, all done through one simple file.</li>
<li>Optional author website and e-mail available.</li>
</ul></p>

<a class="bold rmheader" name="checklist">3. File checklist</a>
<p>Dawgclan Network Downloader contains the following files:<br />
<ol>
<li>readme.htm - this file</li>
<li>index.php - main script</li>
<li>style.css - Design stylesheet</li>
<li>stats.txt - example log/info file</li>
</ol>
</p>
<p>If the above files are not all in this package, it may be fake. If this is the case, 
visit <a href="http://www.dawgclan.net" target="_parent">http://www.dawgclan.net</a> to ensure the original copy.</p>

<a class="bold rmheader" name="install">4. Installing the downloader</a>
<p><ol>
<li>Make sure PHP is enabled on your server.</li>
<ol type="i">
<li>Upload the above files to your files folder e.g files\</li>
<li>Chmod all files to 644, except stats.txt which needs chmod 646.</li>
</ol>
<li>We will explain how to change the display <a href="#style">later in the readme</a>.</li>
<li>Modify the "index.php" and change the files directory to your own.</li>
<li>Include the script into your files page, via the code:</li>
</ol>
NOTE: Must be executed before the header of the page &lt;html&gt;<br />
Example: For my page I used:
<br />
<br />
&lt;?php include $DOCUMENT_ROOT . "/files/index.php"; ?&gt;
<br />
<br />
The above code includes the script in any page I place it, regardless of directory (files is my directory, you would change it to yours).<br />
I put this code at the top of "index.php" (the main page not script)<br />
Keep this in mind.
<br />
<br />
Otherwise use the following:
<br />
<br />
&lt;?php include "path/index.php"; ?&gt;
<br />
<br />
You now have access to all the functions, and since the script is above the header, the downloads can be sent.<br />
If you would like to include the script after the header, you can use output buffering.<br />
Example: &lt;?php ob_start(); PHP code ?&gt; HTML &lt;?php include script; ?&gt; HTML &lt;?php ob_end_flush(); ?&gt;<br />
Read <a href="http://www.php.net/manual/en/function.ob-start.php" target="_blank">more information on PHP.net</a>
<br />
<br />
&lt;?php RetrieveDownloads(); ?&gt;
<br />
<br />
The above function will determine what it should call. It is also the function that outputs the download table.</p>
<p>If the script won't work for any reason you can:<br />
<ul>
<li>Visit the support forum</li>
<li>Go to the <a href="#help">help section</a> contained in this file</li>
<li>Contact one of the administrators for assistance.</li>
</ul></p>

<a class="bold rmheader" name="customizing">5. Customizing the script</a>
<p>We attempted to make modifying your style as easy as possible, therefore instead of modifying the actual code we created a css stylesheet.</p>

<a class="rmheader" name="cellspacing">5.i Changing the cellspacing</a>
<p>Cellspacing is not possible via the css stylesheet, therefore to change the cellspacing modify "index.php" and edit the cellspacing manually in the tables.</p>

<a class="rmheader" name="style">5.ii Personalizing your downloader</a>
<p>To personalize the look of your downloader a css stylesheet was created that includes the basic css options. Using this you can change all your options within "style.css", if you need more help visit <a href="http://www.w3schools.com" target="_blank">w3schools</a>.</p>

<a class="rmheader" name="modify">5.iii Adding downloads</a>
<p>Adding a download to the script is made easy via this script. Follow the steps below:
<ol>
<li>Open the "stats.txt" file for editing.</li>
<li>If this is your first time delete all current text.</li>
<li>Otherwise move down to the next line and add your entry.</li>
</ol>
NOTE: All information must be seperated by a bar character "|"<br />
Download number|Release Date|URL to description (optional)|Description|Filename|Author E-mail (optional)|Author|Downloads<br />
Recap:<br />
Download Number - Should be incrementing by one downward, so line one is 1, line two is 2 etc.<br />
Release Date - Date you added the file, whatever format you wish to add it as.<br />
URL to Description - This is an optional field. Insert link to description, or authorpage here.<br />
Description - Brief description of the file your adding.<br />
Filename - Should be the filename you uploaded to your file directory.<br />
Author E-mail - Another optional field. Insert authors e-mail here.<br />
Author - Author of the file your adding.<br />
Downloads - Automatically managed, but you can choose your start statistics.
<br/>
<br />
Examples:<br />
1|July 20th 2003|http://www.dawgclan.net|Test File|test.zip|hide@address.com|Rothgar|0<br />
2|july 20th 2003||Test File|test.zip||Rothgar|0<br />
Recap syntax: FILEID|DATE|DESCRIPTION PAGE|DESCRIPTION|FILENAME|AUTHOR E-MAIL|AUTHOR|DOWNLOADS<br />
</p>

<a class="rmheader" name="source">5.iv Modifying the sourcecode</a>
<p>Although the source should not be modified, some users may continue to modify it discarding warnings against this. We will provide minimal support for source modifications, if you would like to suggest an option do so below. If you modify our source Dawgclan Network must be credited and the copyright notices maintained.</p>

<a class="bold rmheader" name="help">6. Getting help</a>
<p>PHP can be daunting to new users, particularly when attempting to install the script. This readme has been conducted to help answer your questions. If you need additional help there are several places you can look:</p>

<a class="rmheader" name="docs">6.i Online documents</a>
<p>An up-to-date version of this readme can be found at the following location:<br />
<a href="http://www.dawgclan.net/docs/downloader/readme.htm" target="_blank">http://www.dawgclan.net/docs/downloader/readme.htm</a></p>

<a class="rmheader" name="forums">6.ii Community forums</a>
<p>Forums can be found at <a href="http://forums.dawgclan.net" target="_blank">http://forums.dawgclan.net</a>.<br />
If you do seek help via our forums please be sure to do a Search before posting.</p>

<a class="rmheader" name="irc">6.iii IRC (Internet Relay Chat)</a>
<p>Additional assistance is available through our IRC channel. This operates on a few IRC networks, such as <a href="irc://irc.us.gamesnet.net/dawgclan">irc.us.gamesnet.net</a>. Support can be found in the channel #Dawgclan which is accessible to any good IRC client such as <a href="http://www.mirc.com" target="_blank">mIRC</a> or any other IRC programs.</p>

<a class="bold rmheader" name="status">7. Whats new (version history)</a>
<p>1.03 <2003/04/22>
<ul>
<li>Initial release.</li>
<li>Contains many quality features.</li>
</ul></p>

<a class="bold rmheader" name="bugs">8. Reporting bugs/suggesting ideas</a>
<p>We appreciate receiving bug reports and are open to ideas on script advancements. You can contact us via the forum, e-mail or ICQ.<br />
If you can, please include the following information when reporting bugs:
<ul>
<li>Determine if your bug is reproduceable, If something cannot be reproduced it may turn out to have been your hosting provider working on something, user error, etc. This will help us narrow down the bug.</li>
<li>Next please read or search through the existing bug reports (please remember to check open AND closed reports) to see if your bug (or one very similar to it) is already listed. If it is please add to that existing bug rather than creating a new duplicate entry.</li>
<li>Check the forums (using search) to see if other users and administrators have previously found anything similar to your bug.</li>
<li>If your bug has not previously been reported then please feel free to add it.</li>
<li>If your bug is found in the manual, we will respond with RTFM.</li>
</ul>
In order for us to fix bugs we need the following information to compare to our tests:
<ul>
<li>Your server type/version, eg. Apache 1.2.22, IIS 4, Sambar, etc.</li>
<li>PHP version and mode of operation, eg. PHP 4.1.1 as a module, PHP 4.0.1 running as CGI, etc.</li>
</ul>
</p>
<p>
Please be detailed in your report, if possible list the steps required to duplicate the problem. Please do not include fixes in the report.<br />
<br />
Once a bug has been submitted you will be emailed any follow up comments. Please, if you are requested to supply additional information, do so.</p>

<a class="bold rmheader" name="currentbugs">9. List of current bugs</a>
<p>In order to keep up-to-date, we store the <a href="http://www.dawgclan.net/docs/downloader/bugs.txt" target="_blank">current bugs online</a>.</p>

<a class="bold rmheader" name="contacts">10. Contacts</a>
<p><ul>
<li>E-mail: <a href="mailto:hide@address.com">hide@address.com</a></li>
<li>ICQ: <a href="http://wwp.icq.com/scripts/contact.dll?msgto=48569749">48569749</a></li>
<li>Forums: <a href="http://www.dawgclan.net/forums/viewforum.php?f=18" target="_blank">Dawgclan Network Forums</a></li>
</ul></p>

<a class="bold rmheader" name="disclaimer">11. Disclaimer</a>
<p>This application is opensource software released under the <a href="http://www.gnu.org/licenses/gpl.html" target="_blank">GPL</a>. This package and its contents are Copyright © 2003-2004 <a href="http://www.dawgclan.net" target="_blank">Dawgclan Network</a>, All Rights Reserved.</p>
    </td>
  </tr>
</table>
</body>
</html>
Return current item: Dawgclan Network downloader