1
0
mirror of https://github.com/e107inc/e107.git synced 2025-08-11 17:14:42 +02:00

new module creation

This commit is contained in:
mcfly
2006-12-02 04:36:16 +00:00
commit e149b35fcc
2196 changed files with 182987 additions and 0 deletions

210
e107_docs/README.html Normal file
View File

@@ -0,0 +1,210 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<!-- Version Info:
$Source: /cvs_backup/e107_0.8/e107_docs/README.html,v $
$Revision: 1.1.1.1 $
$Date: 2006-12-02 04:33:35 $
$Author: mcfly_e107 $
-->
<title>e107 Readme</title>
<link rel="stylesheet" href="style.css" type="text/css" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="content-style-type" content="text/css" />
</head>
<body>
<div id='mainbox'> <a href="http://e107.org"><img src="../e107_images/logo.png" alt="Logo" style="border:0" /></a> <br />
<br />
<span class="smalltext">© Steve Dunstan 2002. See gpl.txt for license details.</span><br />
<br />
<br />
<a href="#requirements">Requirements</a> | <a href="#installing">Installing</a> | <a href="#upgrading">Upgrading</a> | <a href="#security">Security</a> | <a href="#backup">Backing Up and Restoring Your Database</a> | <a href="#problems">Common Problems</a> | <a href="#support">Support</a> | <a href="#development">Development</a> | <a href="#thankyou">Thank You</a> | <a href="#disclaimer">Disclaimer</a><br />
<br />
<br />
<a id='requirements'></a><span class="headertext">Requirements</span>
<ul>
<li>e107 requires a webserver that has PHP 4.3 (or newer) and MySQL 3.22 (or newer), contact your host if you're not sure if you have these installed.</li>
<li>If you host your own site you can download <a href="http://php.net">PHP</a> and <a href="http://mysql.com">MySQL</a> and install them yourself, both are free.</li>
<li>You will need your MySQL username and password, and a database for content storage. Don't worry if you only have one database, e107 is happy to share it's database with other applications.</li>
<li>A complete e107 install requires approximately 9MB of disk space on your server, although this should be reduced dramatically for most users by removing the plugins and themes they won't be using, simply by removing the relevant folder.</li>
</ul>
<br />
<a id='installing'></a><span class="headertext">Installing</span>
<ul>
<li>After downloading and unzipping the package, you need to upload the files to your server using an FTP client. e107 will happily run in your webserver root or in a sub-directory ... <br />
<ul>
<li>Open your FTP client and connect to your webserver</li>
<li>Move into the folder on your webserver where web pages are stored, generally it's 'public_html', 'www' or 'html'</li>
<li>Copy all the files from the unzipped e107 package onto your webserver - this could take a while, time for a cup of coffee!<br />
</li>
</ul>
</li>
<li>If you have the correct permissions on your server you can use an alternative (and much quicker) method to upload the files ... <br />
<ul>
<li>Download e107 in tar.gz format from <a href='http://e107.org'>e107.org</a></li>
<li>Using your FTP client, upload the tar.gz to your webserver without unzipping it first</li>
<li>Now open a shell prompt, and navigate to the folder where you uploaded the e107 tar.gz</li>
<li>type tar xvzf file.tar.gz to unpack the archive</li>
</ul>
</li>
</ul>
<ul>
<li>You now need to set the file permissions of some files for e107 to access them correctly. Set the file permissions to 0777 (readable writable by the server), if a series of checkboxes appear tick every box. Here is a list of the files you need to ensure the server can read / write to...<br /><br />
<ul>
<li>e107_config.php</li>
<li>e107_files/public/</li>
<li>e107_files/cache/</li>
<li>e107_files/public/avatars/</li>
<li>e107_plugins/</li>
<li>e107_themes/</li>
</ul>
</li>
</ul>
<ul>
<li>Now open your web browser and navigate to install.php, for example <i>http://yourwebspace.com/install.php</i> or <i>http://yourwebspace.com/e107/install.php</i><br />
<ul>
<li>If all the files have been uploaded successfully, you will see the first page of the install script. Choose the language you wish to use during the procedure and click the button to continue</li>
<li>e107 will now carry out a series of tests to see if requirements are met and all files that need permissions set are ok to be written to. If you get a warning about MySQL don't worry too much, some versions of MySQL don't return the correct version, or return nothing at all. Click on the button to continue if all criteria have been met, or else repair the problem and retest. </li>
<li>Next you have to enter your MySQL details. Enter your server name (generally 'localhost'), username and password. If you don't know your username and/or password contact your webhosts. Now enter the name of the database you want e107 to use. If you have the correct permissions you can create the database directly from the install script should you want to</li>
<li>If all is well e107 should now connect to your MySQL database, if any error messages are shown return to the previous page and make sure you entered your details correctly</li>
<li>Now you have to enter your main admin details. Enter your username, password and email address, you can change your email address and password at a later stage but your username cannot be changed, so make sure you enter it correctly
</li>
<li>e107 will now create the MySQL database tables and populate them with settings etc</li>
<li>If all is well, the last button will take you to your new website. There, all done, that wasn't too bad was it?!</li>
</ul>
</li>
</ul>
<ul>
<li>You must now set the file permissions of the main config file back to 0644 ...<br />
<ul>
<li>Using your FTP client, select the e107_config.php file</li>
<li>Set its file permission (using the method explained above) to 0644</li>
</ul>
</li>
<li><b>Now delete the install.php file from your server, if you do not it could pose a potential security risk to your site</b></li>
</ul>
<br />
<br />
<a id='upgrading'></a><span class="headertext">Upgrading</span><br />
<br />
<a href='README_UPGRADE.html'>Please click here for instructions on upgrading your 0.6175 website to 0.7.</a>
<br /><br /><br />
<a id='backup'></a><span class="headertext">Using phpMyAdmin to backup your database</span><br />
<br />
<ul>
<li>First, navigate to your phpMyAdmin page and log in</li>
<li>From the dropdown box on the left (or the text link) click on your e107 database</li>
<li>In the main page, click on the 'Export' tab</li>
<li>In the right box, make sure 'Add drop table', 'Add AUTO_INCREMENT value' and 'Enclose table and field names with backquotes' are ticked</li>
<li>Make sure the main 'Structure' and 'Data' boxes are ticked</li>
<li>Tick 'Save as file'</li>
<li>If you want the backup file compressed, tick either 'zipped' or 'gzipped'</li>
<li>Click 'Go'</li>
</ul>
<ul>
<li>To restore a backup, Click on the 'SQL' tab at the top and browse to your backup, you may need to empty your existing database before you can restore the backup</li>
</ul>
<br />
<a id='security'></a><span class="headertext">Security</span><br />
<br />
Security has been a primary concern since the first released versions of e107, and for this reason there are some very easy measures you can take to make your site more secure ...
<ul>
<li>Rename your e107_admin directory: this will make it less obvious to other e107 users where your admin files are.<br /><br /></li>
<li><strong>The procedure to change your directory names has changed. The definitions have been moved to e107_config.php.</strong><br /><br /></li>
<li>If you are <span style="text-decoration: underline;"><b>UPGRADING</b></span> from a very old version of e107 (e.g. less than v.615), you will need to open class2.php and find the following lines.<br /><br />
<div class='indent'> // If you need to change the names of any of your directories, change the value here then rename the respective folder on your server ...<br />
$ADMIN_DIRECTORY = "e107_admin/";<br />
$FILES_DIRECTORY = "e107_files/";<br />
$IMAGES_DIRECTORY = "e107_images/";<br />
$THEMES_DIRECTORY = "e107_themes/";<br />
$PLUGINS_DIRECTORY = "e107_plugins/";<br />
$HANDLERS_DIRECTORY = "e107_handlers/";<br />
$LANGUAGES_DIRECTORY = "e107_languages/";<br />
$HELP_DIRECTORY = "e107_docs/help/";<br />
$DOWNLOADS_DIRECTORY = "e107_files/downloads/";</div><br />
</li>
<li>Cut these lines from <span style="text-decoration: underline;">class2.php</span> and paste them into <span style="text-decoration: underline;">e107_config.php</span>. Now you can change the folder names from here.<br /><br /></li>
<li>If this is a <span style="text-decoration: underline;"><b>NEW INSTALL</b></span> the folder names are already in e107_config.php. They have been left in class2.php for backwards compatibility. They will be removed from there in the future.<br /><br /></li>
<li>This procedure depends on you completing the steps above and making sure the file paths are located in e107_config.php now.</li>
<li>To rename your e107_admin directory (or any of your other directories), first rename the folder in the usual manner using your FTP client. Then open e107_config.php from the root directory of your e107 installation in a text editor, and find the following line near the top of the file ...<br />
<i>$ADMIN_DIRECTORY = "e107_admin/";</i><br />
... and change <i>e107_admin/</i> to the name you've renamed it on your server </li>
<li>You can change the name of all your e107 directories using this method</li>
<li>There are some security settings that you can change from your admin area. Go to the preferences page and you'll see a section marked Security</li>
</ul>
<br />
<a id='problems'></a><span class="headertext">Common Problems</span><br />
<br />
<ul>
<li>If for any reason you get a critical error message concerning your core settings, you can easily reset them to default using the resetcore utility. You can find this in your e107_files folder, use your web browser to navigate to http://yoursite.com/e107_files/resetcore/resetcore.php and follow the instructions. This will not affect any content on your site; it will merely reset your core settings, so your site theme etc will revert to default. You can make a backup of your core at any time and restore this from the resetcore utility, to backup your core go to your admin section, click on Database ten click on Backup Core</li>
<li>If after installing e107 you get a blank page, check your error_reporting level in your php.ini file. This is generally caused by an error on your site not being reported because your error reporting is set too low, or turned off completely. If you don't have access to your php.ini contact your web host</li>
<li>If you are seeing Undefined Variable or Notice errors on your site, your error_reporting is set too high. Make sure it's set to E_ERROR | E_WARNING | E_PARSE in your php.ini, again if you don't have access contact your web hosts and ask them to change it</li>
</ul>
<br />
<a id='support'></a><span class="headertext">Support</span><br />
<br />
All these places are very friendly, please don't hesitate to use them even if you think your question is trivial, you'll get a polite reply.
<ul>
<li><b>e107 forums</b><br />
<a href='http://e107.org/forum.php'>http://e107.org/forum.php</a></li>
<li><b>e107 faq</b><br />
<a href='http://e107faq.bkwon.net'>http://e107faq.bkwon.net</a></li>
<li><b>IRC channel</b><br />
#e107 on <a href='irc://freenode.net'>irc.freenode.net</a><br /></li>
<li><b>Third party plugin support: e107coders</b><br />
<a href='http://e107coders.org'>http://e107coders.org/</a><br /></li>
<li><b>Third party theme support: e107themes</b><br />
<a href='http://e107themes.org'>http://e107themes.org/</a></li>
</ul>
<p><br />
<a id='development'></a><span class="headertext">Development</span><br />
<br />
e107 has been tested, and developed on Apache 1 and 2, IIS, and PHP 4.3+ (Including 5.0).<br />
It is developed by the e107 dev team (Jalist, McFly, Cameron, Streaky, SweetAs, Asperon, Que, Lolo, Chavo, Lisa, MrPete).<br />
<br />
If you have made changes to the core you think might benefit others please let us know about them in the forums at e107.org :)<br />
<br />
<br />
<a id='thankyou'></a><span class="headertext">Thank you</span><br />
<br />
Thanks first to jalist for starting this whole thing out and sticking with it for so long. </p>
<ul>
<li>Thanks mainly to Terrence, Damon, que, nalenb, Dawn, HeX0R, JuhaH, bkwon, Knight, Aldrin for their unstinting support.</li>
<li>Also to everyone else who has assisted and submitted translations/fixes etc</li>
<li>Thanks to CraHan, NeXTer, Kuhndog, wols, [steev], rootrider, Claymore, demigod, maaneeack, Schmots, dreamer, galois and the others in [#ls.g] for their friendship.</li>
<li>Thanks to Jérôme C. Meijers and Craig Bramscher</li>
<li>e107.net for donated hosting</li>
<li>Thanks to all of you who have taken the time to create plugins/themes/hacks, answer questions in the forums and IRC channel etc. We have a wonderful community here and it's because of people like you.</li>
<li>And thanks to you for trying e107, I hope you like it and it fits your website needs. If it doesn't try <a href='http://opensourcecms.com'>OpenSourceCMS</a> for a full list of alternative systems.</li>
<li>A couple of third-party scripts have been integrated into e107 to make your life easier, so thank you to ...<br />
<ul>
<li>MagpieRSS (<a href='http://magpierss.sourceforge.net'>http://magpierss.sourceforge.net</a>) MagpieRSS provides an XML-based (expat) RSS parser in PHP.</li>
<li>PCLZip (<a href='http://www.phpconcept.net/pclzip/'>http://www.phpconcept.net/pclzip/</a>) PclZip library offers compression and extraction functions for Zip formatted archives (WinZip, PKZIP).</li>
<li>PCLTar (<a href='http://www.phpconcept.net/pcltar/'>http://www.phpconcept.net/pcltar/</a>) PclTar offer the ability to archive a list of files or directories with or without compression. The archives created by PclTar are readable by most of gzip/tar applications and by the Windows WinZip application.</li>
<li>TinyMCE (<a href='http://tinymce.moxiecode.com'>http://tinymce.moxiecode.com</a>) TinyMCE is a platform independent web based Javascript HTML WYSIWYG editor control released as Open Source under LGPL by Moxiecode Systems AB. It has the ability to convert HTML TEXTAREA fields or other HTML elements to editor instances.</li>
<li>Nuvolo Icons (<a href='http://www.icon-king.com'>http://www.icon-king.com</a>) Icons used in e107</li>
<li>PHPMailer (<a href='http://phpmailer.sourceforge.net'>http://phpmailer.sourceforge.net</a>) Full featured email transfer class for PHP</li>
<li>Brainjar DHTML Menu (<a href='http://www.brainjar.com/dhtml/menubar/'>http://www.brainjar.com/dhtml/menubar/</a>) Menu system used in several themes</li>
<li>DHTML / JavaScript Calendar (<a href='http://www.dynarch.com/projects/'>http://www.dynarch.com/projects/</a>) Popup calendar widget</li>
<li>FPDF (<a href='http://www.fpdf.org'>http://www.fpdf.org</a>) PDF support</li>
<li>UFPDF (<a href='http://www.acko.net/node/56'>http://www.acko.net/node/56</a>) UTF-8 PDF support</li>
</ul>
<br />
Both these scripts are released under the GPL license and as stated the copyright information has been left intact in the scripts themselves, if you want to use these scripts in your own code you must abide by the GPL license.</li>
</ul>
<br />
<a id='disclaimer'></a><span class="headertext">Disclaimer</span><br />
<br />
This software is free and as such comes without warranty as stated in the GNU GPL License (included in this package). Any problems encountered due to deficiencies in this software are not the responsibility of the author. <br />
</div>
</body>
</html>

View File

@@ -0,0 +1,150 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<!-- Version Info:
$Source: /cvs_backup/e107_0.8/e107_docs/README_UPGRADE.html,v $
$Revision: 1.1.1.1 $
$Date: 2006-12-02 04:33:35 $
$Author: mcfly_e107 $
-->
<title>e107 Readme</title>
<link rel="stylesheet" href="style.css" type="text/css" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="content-style-type" content="text/css" />
</head>
<body>
<div id='mainbox'> <a href="http://e107.org"><img src="../e107_images/logo.png" alt="Logo" style="border:0" /></a> <br />
<br />
<span class="smalltext">© Steve Dunstan 2002. See gpl.txt for license details.</span><br />
<br />
<br />
<a id='upgrading'></a><span class="headertext">Upgrading</span><br />
<br />
0.6175 -> .7 Upgrade Guide
<pre>
e107 has undergone a lot of changes from .617 to .7 and bkwon has compiled a comprehensive list of these over
at click to open link in new window .
Essential Points
* If you are upgrading an English site from .617 you will need the separate English iso-8859-1 language pack, as the
default core English language pack is now in the UTF character set. If you do not do this some characters in your
database content will display corrupted.
* If your .617 site is non English you will need to make sure the .7 lan pack in your language is both available and in the same
character set as your current .617 language pack. If it is not in the same character set as your original,
some characters in your content, if not all, will display corrupted.
* The plugins you currently use on your .617 site may not work with .7 so you must check this before upgrading your site.
* .7 is almost a complete rewrite of .617 and so there are many database changes. For this reason it is essential
that you make a backup of your site using PhpMyAdmin or another third party SQL backup - do not use the e107 core
database backup system in e107 as this does not work. I know everyone always says you should backup - but for once this
time it's really meant as we will not be able to help you if you lose content or it gets corrupted and with such
heavy database changes this could be possible.
Warning!
There are files related to htmlArea, the WYSIWYG system in the 0.6xx branch of e107 that are known to be exploitable. These must be
removed immediately. Please delete the following directories and all their contents from your server:
e107_handlers/htmlarea/
e107_admin/htmlarea/
Upgrade process
1. Download the .7 core zip and your required .7 language pack (English iso-8859-1 for English sites).
2. Login to your site and go to the admin area and set your maintenance flag to true (Admin => Maintenance).
This will close your site off to visitors whilst you perform the upgrade.
3. Check your database validity by using the tool located at Admin => Database => Check Database Validity. If you have
any errors do not continue with the upgrade process as these must be fixed first.
4. Go back to your admin area frontpage.
5. Extract the contents of the core zip and upload the files to your server - overwriting the existing .617 files.
6. Extract the contents of the language pack (in this release its just one file - English.php) and upload the file(s) to
your server - overwriting the existing one(s).
7. Refresh your admin front page in your browser and you will see an update available button appear.
Click this to take to you to the update page (Alternatively you can reach the update page through Admin =>Database =>
Check For Updates).
8. Click the .617 to .7 core update button. This will run the first step in the upgrade process.
When it finishes you will see several new buttons appear for the upgrade routines for forum, content
and statistics. Even if you do not use these e107 features, run each update anyway.
9. Once all updates have been processed you should no longer have buttons on the updates page and you have completed
the upgrade process.
10. Go back to the database validity tool and check once again that everything passes ok.
You may notice some e107 elements have gone missing - forum, chatbox, content, links, etc... well don't worry
they haven't really! A large part of the e107 core has been 'pluginfied' and you will find all these elements are
now stand alone plugins and can be located under Admin => Plugins. A point to note with links is that your existing
links page links have been separated from the main 'site links' and the upgrade routine has moved them to the new
links page plugin.
Reviews, articles and content have also been pluginfied and incorporated into one plugin called 'Content Management'.
If you used any of these features in 0.6xx or want to use this new plugin for new content, you will need to
change some additional directory permissions for the new plugin. Please see the relevant entry regards this under
'Permissions'.
Version .7 comes with a new theme, Jayya, which has been designed for the admin area of the site and is intended to
make administration more user friendly, implementing several new features for this job. If you would like to try it
out, go to Admin => Theme Manager and change the admin area theme to 'Jayya'.
Because of the huge number of changes in .7 and on the basis it's an almost total rewrite, there may be some
problems when you upgrade. If you find a specific bug please post this in the bugtracker here on e107.org so that
we may fix the issue in the next release of the system. Thanks.
Permissions: Core
The following permissions should be set for using e107 core (most of these will have already been set this way
from your previous 0.6xx install):
chmod 777: e107_themes/
chmod 777: e107_plugins/
chmod 777: e107_files/public/
chmod 777: e107_files/public/avatars/
chmod 777: e107_files/cache/
Permissions: Plugins
The following permissions will need to be set if you were using statistics in your 0.6xx site or wish to use the new
Statistic Logging plugin at some point in the future:
chmod 777: e107_plugins/log/logs/
The following permissions will need to be set if you were using the links page in your 0.6xx site or wish to use the new
links page plugin at some point in the future:
chmod 777: e107_plugins/links_page/cat_images/
chmod 777: e107_plugins/links_page/link_images/
The following permissions will need to be set if you were using Reviews / Articles or Content in your 0.6xx site or
wish to use the new Content Management plugin at some point in the future:
chmod 777: e107_plugins/content/images/cat/
chmod 777: e107_plugins/content/images/cat/16/
chmod 777: e107_plugins/content/images/cat/48/
chmod 777: e107_plugins/content/images/file/
chmod 777: e107_plugins/content/images/file/tmp/
chmod 777: e107_plugins/content/images/icon/
chmod 777: e107_plugins/content/images/icon/tmp/
chmod 777: e107_plugins/content/images/image/
chmod 777: e107_plugins/content/images/image/tmp/
chmod 777: e107_plugins/content/menus/
Troubleshooting
If you have any problems with the upgrade such as being locked out of your site please clear your cache by deleting
the php files in e107_files/cache/.
CVS Users
If you have upgraded your 0.6xx install to 0.7 using a CVS nightly build or downloading directly from the CVS
repository, you need to check what character set you are currently using. You will find this information displayed
on your admin area front page under the 'Site Info' menu where it says 'Charset'. If under Charset it says you are
using 'utf-8' then you need only download the main core zip and upgrade with that. Your charset is the default that
0.7 runs with and so is included in the main zip. However, if the Charset says iso-8859-1 and you run an English site
then you must download the separate English iso-8858-1 language pack alongside the main core zip and overwrite the
language files in the core zip with those you find in the iso-8858-1 zip. For non English sites make sure to get your
language in the same Charset as is listed on the admin area frontpage under Site Info.
</pre>
<a id='disclaimer'></a><span class="headertext">Disclaimer</span><br />
<br />
This software is free and as such comes without warranty as stated in the GNU GPL License (included in this package). Any problems encountered due to deficiencies in this software are not the responsibility of the author. <br />
</div>
</body>
</html>

342
e107_docs/gpl.txt Normal file
View File

@@ -0,0 +1,342 @@
GNU GENERAL PUBLIC LICENSE
Version 2, June 1991
Copyright (C) 1989, 1991 Free Software Foundation, Inc.
59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The licenses for most software are designed to take away your
freedom to share and change it. By contrast, the GNU General Public
License is intended to guarantee your freedom to share and change free
software--to make sure the software is free for all its users. This
General Public License applies to most of the Free Software
Foundation's software and to any other program whose authors commit to
using it. (Some other Free Software Foundation software is covered by
the GNU Library General Public License instead.) You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
this service if you wish), that you receive source code or can get it
if you want it, that you can change the software or use pieces of it
in new free programs; and that you know you can do these things.
To protect your rights, we need to make restrictions that forbid
anyone to deny you these rights or to ask you to surrender the rights.
These restrictions translate to certain responsibilities for you if you
distribute copies of the software, or if you modify it.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must give the recipients all the rights that
you have. You must make sure that they, too, receive or can get the
source code. And you must show them these terms so they know their
rights.
We protect your rights with two steps: (1) copyright the software, and
(2) offer you this license which gives you legal permission to copy,
distribute and/or modify the software.
Also, for each author's protection and ours, we want to make certain
that everyone understands that there is no warranty for this free
software. If the software is modified by someone else and passed on, we
want its recipients to know that what they have is not the original, so
that any problems introduced by others will not reflect on the original
authors' reputations.
Finally, any free program is threatened constantly by software
patents. We wish to avoid the danger that redistributors of a free
program will individually obtain patent licenses, in effect making the
program proprietary. To prevent this, we have made it clear that any
patent must be licensed for everyone's free use or not licensed at all.
The precise terms and conditions for copying, distribution and
modification follow.
GNU GENERAL PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. This License applies to any program or other work which contains
a notice placed by the copyright holder saying it may be distributed
under the terms of this General Public License. The "Program", below,
refers to any such program or work, and a "work based on the Program"
means either the Program or any derivative work under copyright law:
that is to say, a work containing the Program or a portion of it,
either verbatim or with modifications and/or translated into another
language. (Hereinafter, translation is included without limitation in
the term "modification".) Each licensee is addressed as "you".
Activities other than copying, distribution and modification are not
covered by this License; they are outside its scope. The act of
running the Program is not restricted, and the output from the Program
is covered only if its contents constitute a work based on the
Program (independent of having been made by running the Program).
Whether that is true depends on what the Program does.
1. You may copy and distribute verbatim copies of the Program's
source code as you receive it, in any medium, provided that you
conspicuously and appropriately publish on each copy an appropriate
copyright notice and disclaimer of warranty; keep intact all the
notices that refer to this License and to the absence of any warranty;
and give any other recipients of the Program a copy of this License
along with the Program.
You may charge a fee for the physical act of transferring a copy, and
you may at your option offer warranty protection in exchange for a fee.
2. You may modify your copy or copies of the Program or any portion
of it, thus forming a work based on the Program, and copy and
distribute such modifications or work under the terms of Section 1
above, provided that you also meet all of these conditions:
a) You must cause the modified files to carry prominent notices
stating that you changed the files and the date of any change.
b) You must cause any work that you distribute or publish, that in
whole or in part contains or is derived from the Program or any
part thereof, to be licensed as a whole at no charge to all third
parties under the terms of this License.
c) If the modified program normally reads commands interactively
when run, you must cause it, when started running for such
interactive use in the most ordinary way, to print or display an
announcement including an appropriate copyright notice and a
notice that there is no warranty (or else, saying that you provide
a warranty) and that users may redistribute the program under
these conditions, and telling the user how to view a copy of this
License. (Exception: if the Program itself is interactive but
does not normally print such an announcement, your work based on
the Program is not required to print an announcement.)
These requirements apply to the modified work as a whole. If
identifiable sections of that work are not derived from the Program,
and can be reasonably considered independent and separate works in
themselves, then this License, and its terms, do not apply to those
sections when you distribute them as separate works. But when you
distribute the same sections as part of a whole which is a work based
on the Program, the distribution of the whole must be on the terms of
this License, whose permissions for other licensees extend to the
entire whole, and thus to each and every part regardless of who wrote it.
Thus, it is not the intent of this section to claim rights or contest
your rights to work written entirely by you; rather, the intent is to
exercise the right to control the distribution of derivative or
collective works based on the Program.
In addition, mere aggregation of another work not based on the Program
with the Program (or with a work based on the Program) on a volume of
a storage or distribution medium does not bring the other work under
the scope of this License.
3. You may copy and distribute the Program (or a work based on it,
under Section 2) in object code or executable form under the terms of
Sections 1 and 2 above provided that you also do one of the following:
a) Accompany it with the complete corresponding machine-readable
source code, which must be distributed under the terms of Sections
1 and 2 above on a medium customarily used for software interchange; or,
b) Accompany it with a written offer, valid for at least three
years, to give any third party, for a charge no more than your
cost of physically performing source distribution, a complete
machine-readable copy of the corresponding source code, to be
distributed under the terms of Sections 1 and 2 above on a medium
customarily used for software interchange; or,
c) Accompany it with the information you received as to the offer
to distribute corresponding source code. (This alternative is
allowed only for noncommercial distribution and only if you
received the program in object code or executable form with such
an offer, in accord with Subsection b above.)
The source code for a work means the preferred form of the work for
making modifications to it. For an executable work, complete source
code means all the source code for all modules it contains, plus any
associated interface definition files, plus the scripts used to
control compilation and installation of the executable. However, as a
special exception, the source code distributed need not include
anything that is normally distributed (in either source or binary
form) with the major components (compiler, kernel, and so on) of the
operating system on which the executable runs, unless that component
itself accompanies the executable.
If distribution of executable or object code is made by offering
access to copy from a designated place, then offering equivalent
access to copy the source code from the same place counts as
distribution of the source code, even though third parties are not
compelled to copy the source along with the object code.
4. You may not copy, modify, sublicense, or distribute the Program
except as expressly provided under this License. Any attempt
otherwise to copy, modify, sublicense or distribute the Program is
void, and will automatically terminate your rights under this License.
However, parties who have received copies, or rights, from you under
this License will not have their licenses terminated so long as such
parties remain in full compliance.
5. You are not required to accept this License, since you have not
signed it. However, nothing else grants you permission to modify or
distribute the Program or its derivative works. These actions are
prohibited by law if you do not accept this License. Therefore, by
modifying or distributing the Program (or any work based on the
Program), you indicate your acceptance of this License to do so, and
all its terms and conditions for copying, distributing or modifying
the Program or works based on it.
6. Each time you redistribute the Program (or any work based on the
Program), the recipient automatically receives a license from the
original licensor to copy, distribute or modify the Program subject to
these terms and conditions. You may not impose any further
restrictions on the recipients' exercise of the rights granted herein.
You are not responsible for enforcing compliance by third parties to
this License.
7. If, as a consequence of a court judgment or allegation of patent
infringement or for any other reason (not limited to patent issues),
conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot
distribute so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you
may not distribute the Program at all. For example, if a patent
license would not permit royalty-free redistribution of the Program by
all those who receive copies directly or indirectly through you, then
the only way you could satisfy both it and this License would be to
refrain entirely from distribution of the Program.
If any portion of this section is held invalid or unenforceable under
any particular circumstance, the balance of the section is intended to
apply and the section as a whole is intended to apply in other
circumstances.
It is not the purpose of this section to induce you to infringe any
patents or other property right claims or to contest validity of any
such claims; this section has the sole purpose of protecting the
integrity of the free software distribution system, which is
implemented by public license practices. Many people have made
generous contributions to the wide range of software distributed
through that system in reliance on consistent application of that
system; it is up to the author/donor to decide if he or she is willing
to distribute software through any other system and a licensee cannot
impose that choice.
This section is intended to make thoroughly clear what is believed to
be a consequence of the rest of this License.
8. If the distribution and/or use of the Program is restricted in
certain countries either by patents or by copyrighted interfaces, the
original copyright holder who places the Program under this License
may add an explicit geographical distribution limitation excluding
those countries, so that distribution is permitted only in or among
countries not thus excluded. In such case, this License incorporates
the limitation as if written in the body of this License.
9. The Free Software Foundation may publish revised and/or new versions
of the General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the Program
specifies a version number of this License which applies to it and "any
later version", you have the option of following the terms and conditions
either of that version or of any later version published by the Free
Software Foundation. If the Program does not specify a version number of
this License, you may choose any version ever published by the Free Software
Foundation.
10. If you wish to incorporate parts of the Program into other free
programs whose distribution conditions are different, write to the author
to ask for permission. For software which is copyrighted by the Free
Software Foundation, write to the Free Software Foundation; we sometimes
make exceptions for this. Our decision will be guided by the two goals
of preserving the free status of all derivatives of our free software and
of promoting the sharing and reuse of software generally.
NO WARRANTY
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
REPAIR OR CORRECTION.
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
convey the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
Also add information on how to contact you by electronic and paper mail.
If the program is interactive, make it output a short notice like this
when it starts in an interactive mode:
Gnomovision version 69, Copyright (C) year name of author
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, the commands you use may
be called something other than `show w' and `show c'; they could even be
mouse-clicks or menu items--whatever suits your program.
You should also get your employer (if you work as a programmer) or your
school, if any, to sign a "copyright disclaimer" for the program, if
necessary. Here is a sample; alter the names:
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
`Gnomovision' (which makes passes at compilers) written by James Hacker.
<signature of Ty Coon>, 1 April 1989
Ty Coon, President of Vice
This General Public License does not permit incorporating your program into
proprietary programs. If your program is a subroutine library, you may
consider it more useful to permit linking proprietary applications with the
library. If this is what you want to do, use the GNU Library General
Public License instead of this License.

View File

@@ -0,0 +1,6 @@
Q> What are permissions?
A> These allow you to give administrators different access levels to the admin section. For example you might only want to let a certain admin post news items; using permissions you can do this. There are some admin functions that are only accessible to the main site admin, this is for security reasons.
Q> I want to make an existing registered member into an administrator - how?
A> Click on Users in your admin section and search for the registered member, then click on Make Admin. You should then go immediately to the Administrators section and set his permissions. You can also remove admin status from someone in this way.

View File

@@ -0,0 +1,12 @@
Q> What's BBCode?
A> A BBCode is a shortcut to an HTML tag, for example entering &#91;b] I am bold text! &#91;/b] in any of your admin textboxes will make the text inside the &#91;b] and &#91;/b] appear in bold text, so [b]I am bold text![/b] would appear on the screen.
Q> But what's it for?
A> It saves you time when entering HTML tags. You can use normal HTML tags in your text entry boxes but using BBCode will really speed up your text entry.
Q> When I click one of the BBCode buttons to enter the code, it enters it at the end of my text, not where the cursor is - why?
A> There is a bug in Internet Explorer that can cause it to crash if e107 tries to enter the code at the cursor position, so in the interests of compatibility the code is entered at the end of your text.
Q> What BBCodes can I use?
A> Hover your mouse pointer above any of the bbcode boxes; you'll see a small explanation appear just above the buttons. There are also codes for links &#91;url] &#91;/url] and email &#91;email] &#91;/email], although again using normal HTML tags is ok. All web addresses and email addresses entered are automatically made into clickable hyperlinks.

View File

@@ -0,0 +1,6 @@
Q> What's this section for?
A> This page allows you to ban visitors to your site, either by their IP address and/or email address.
Q> Why do I have to give a reason?
A> You don't, that textbox is there so that other administrators can see the reason for the ban, or they might remove it by mistake.

View File

@@ -0,0 +1,18 @@
Q> I defined a new banner from the admin area but it's not showing up - why?
A> The theme you're using needs to know to display a banner. Open the theme.php of the theme and make sure you have {BANNER} or {BANNER=yourcampaignname} in the $HEADER section.
Q> I want to one set of banners in one area and a different set in another area - how?
A> You can group your banners under 'campaigns', and then set up your theme to show banners from certain campaigns. For example, if you had two campaigns, called cam_1 and cam_2, putting {BANNER=cam1} in one area of your $HEADER section in the theme.php will show only cam_1 banners, and putting {BANNER=cam_2} in another area will only show cam_2 banners. Putting {BANNER} (no campaign name) in your theme.php will show random banners from all campaigns.
Q> What's the client login and client password for?
A> You can define a login and password for your banner clients, they can then use these to access information about how their banners are performing by going to http://yoursite.com/banner.php and entering the name and pass.
Q> How can I have a 'tower' type banner in a menu item?
A> First you need to define the campaign for the tower type banners (this will keep them separate from bar type banners) ...
1. Go to your admin area and click on banners.
2. Enter your tower-type banner(s), make sure you use a new campaign name, for example 'towers'.
3. Now go to your Menus area, and activate the Banner_menu into one of your menu areas.
4. Click on the 'Configure' link in the menu item.
5. Enter the caption title (by default it's 'Advertisement'), and enter the campaign name you defined before.
6. Leave your admin area and you'll see your tower-type banner(s) in the area you assigned them to.

View File

@@ -0,0 +1,9 @@
Q> What's this section for?
A> Setting Cache Status to on will save certain areas of your site in your database. This reduces calls to MySQL, and vastly speeds up your site.
Q> I made some alterations to the theme I'm using but it hasn't changed - is it because it's cached.
A> Most probably. When you change themes the cache is cleared but altering code in your theme.php won't clear the cache. Set Cache Status to off until you're finished.
Q> Can I save the cache to files on the hard drive?
A> Yes. Just make sure that your e107_files/cache directory is writable (chmod 777). And then click the option on the cache page.

View File

@@ -0,0 +1,9 @@
Q> What is the Replace Links section for?
A> You can convert any links entered in your chatbox to other text, or an image. This keeps your chatbox from overflowing with long website addresses. To use an image, tick Replace Links, and in the box below enter &lt;img src='path_to_your_image' alt='' />, now any links entered will be converted to the image you entered.
Q> What's Wordwrap for?
A> If someone entered a very long word in your chatbox it could disrupt the layout of your site. If you were to enter 40 in the Wordwrap box, any works longer than 40 characters would be wrapped so the column wouldn't be extended. You may have to change this value corresponding to the theme you are using, and the width of the column your chatbox is in.
Q> My site is for all ages yet someone keeps swearing in the chatbox - how can I stop this?
A> Go to the Preferences screen in your admin section, and find the Protection of minors options. You can add a list of words here that will be replaced by a word or sentence of your choice, for example CENSORED! Now anytime that work is encountered on your site it will be replaced with the text you entered.

View File

@@ -0,0 +1,5 @@
Q> What are these user-classes I keep seeing? What are they for?
A> User classes restrict access to certain areas or functions of your site. If you define a class and then add certain users to it, you can choose to make things visible to only the users in that class.
For example, there is a class already created by default when you install e107 called PRIVATEFORUM. Adding users to this class then creating a forum under that class will make only the users in that class able to access that forum. You can restrict other areas and functions by class, like news items, links, downloads, etc.

View File

@@ -0,0 +1,6 @@
Q> What's a download parent?
A> This allows you to group your downloads into different categories.
Q> I want to add a download but the file doesn't appear in the list - why?
A> Only files in the e107_files/downloads folder appear in the dropdown list. Copy the file into this folder and it will appear. The same applies to images; they must be in the e107_files/downloadimages folder.

View File

@@ -0,0 +1,6 @@
Q> What are emoticons?
A> Emoticons are the smiley images you see on other websites. If you enable emoticons on your site, any time someone enters a smiley, for example &#58;), it will be replaced by the image equivalent :)
Q> Can I enter new emoticon codes?
A> Yes, from the emoticon screen you can enter new, edit existing or delete emoticons.

View File

@@ -0,0 +1,3 @@
Q> I'm getting some errors on a certain page, what do I do about it?
A> Browse the Problems forum at e107.org and see if anyone else is getting the same problem. If you think it's a bug please post the error on the bugtracker at e107.org.

View File

@@ -0,0 +1,15 @@
Q> What are forum parents?
A> A parent is a heading to group other forums under, this makes it easier to navigate your forums.
Q> I want to make a certain administrator a forum moderator but his name isn't in the list - why?
A> Administrators will only be listed if they have the correct permission set to be a forum moderator. Go to the Administrators section and edit the admin in question, and make sure 'Moderate forums' is ticked.
Q> What's tracking?
A> If you have this enabled, it allows users to track a forum thread; they will receive an email when someone replies to the thread.
Q> What's pruning?
A> This allows you to remove old threads that haven't received a reply in a certain time. Please be careful with this function, once threads are deleted they cannot be retrieved.
Q> What are reported posts?
A> Users can report posts that they find to contain objectionable material. You can open the reported thread and moderate as you wish.

View File

@@ -0,0 +1,6 @@
Q> What's this section for?
A> This screen allows you to set what appears on the front page of your site, by default it's set to news.
Q> What other pages can I display?
A> Any. You can either tick the preset ones (forum, downloads, etc.) or enter the address to the page you want to use.

View File

@@ -0,0 +1,9 @@
Q> I made some changes to my site and now I'm getting MySQL errors and my site doesn't appear.
A> It could be that your core has become corrupt. The core is the core settings and variables of e107. To reset your core, go to http://yoursite.com/e107_files/resetcore/resetcore.php. Always back up your core (from the Database screen) before you apply changes, you can then restore the core backup if something goes wrong (again from resetcore.php).
Q> I forgot my main admin password and now I can't access my admin area.
A> For very good security reasons it's impossible to reset your password unless you're logged in. If you haven't written your password down in a safe place please do so now, then this scenario will never happen. If it does, you will have to reset your password manually using phpMyAdmin or another similar MySQL manager. Go to the users table, the main admin should be user number 1. Click on the edit button and change the password to 4cb9c8a8048fd02294477fcb1a41191a, this will change your password to changeme. Now log in and [b]update your password immediately[/b].
Q> I installed a theme/plugin etc. and now my site is unreachable, what can I do?
A> Use resetcore.php (see above).

View File

@@ -0,0 +1,6 @@
Q> How can I enter a link so that it appears in my main navigation menu?
A> Any links in the Main category will appear in your main nav menu. All other categories appear on the Links page.
Q> What's the link button text box for?
A> This allows you to display the button for the link on the Links page. If you leave it blank a blank button will be displayed.

View File

@@ -0,0 +1,6 @@
Q> What's this section for?
A> This screen allows you to make your site inaccessible to visitors, use it when you are upgrading your site or need to take it down for any reason. Only the main site administrator can access the site when in maintenance mode, you'll know this as a message is displayed on every page.
Q> Help! I set the Maintenance Flag and accidentally logged out, how do I get back in to my admin section to put the site back up?
A> Go to http://yoursite.com/e107_admin/admin.php and log in from there.

View File

@@ -0,0 +1,12 @@
Q> What are menus?
A> They are items that appear in the menu areas (or columns) of your site. These can contain text, links, anything.
Q> How do I activate a menu item?
A> Go to your admin area and click on Menus. You'll see the main layout of your site with a list of the menus in their respective areas. The menu items in the center of the page are inactive; you can move them into an active area by clicking on Activate this menu. You can also move the area the menu is in or move it up and down the column once it's activated.
Q> I need to put some text inside a menu item, how can I do this?
A> Go to the admin area and click on Custom Menus. From here you can enter any text you like to a menu and it will be saved and available like any other menu.
Q> How can I change the options for a menu item?
A> If a config panel is available you will see a link to it (called 'Configure') in the menu box once activated.

View File

@@ -0,0 +1,12 @@
Q> What are news categories for?
A> You can group your news items under different categories, and they will be displayed with a different icon etc if defined. This makes it easier for your visitors to navigate your site and read only the items that interest them.
Q> What is the Extended box for?
A> You may have noticed the way news items are reported on some sites, they have a small intro with a link to the whole article, you can do this by entering the intro in the Body text box and the rest of the article in the Extended box.
Q> What are the activation boxes for?
A> You can set up a news item to only appear between certain dates by using the activation boxes. If you leave them blank the news you post will appear immediately.
Q> I entered a news item and it says 'News saved in database' - does that mean it will show on my news page?
A> It means the text you entered has been saved. If the news item you entered is set to active, then yes it will appear on your news page.

View File

@@ -0,0 +1,15 @@
Q> How do I change themes?
A> There is a section in your Preferences page that allows you to change your site theme. Please preview the theme first as some older themes are no longer compatible and could render your site unusable if applied.
Q> What's COPPA?
A> The Children's Online Privacy Protection Act of 1998. It's a universally used rule that protects minors aged 13 and under. It ensures that no information on minors will be used by the 'Operator' (i.e., you) for purposes other than maintaining the website. For more information please see http://www.cdt.org/legislation/105th/privacy/coppa.html.
Q> What's flood protection?
A> It prevents your site being flooded by HTTP calls, which can render your site unreachable.
Q> Should I use Cookies or Sessions for tracking my users?
A> It's your choice, if your site is working ok with cookies (the default) then leave it like that. If you prefer to use PHP sessions, then use that (a custom session handler is used by e107 to store and handle sessions).
Q> Why should I run my site in standards mode?
A> If your developing a theme and having trouble getting it to render correctly in Firefox/Mozilla and IE, try ticking this box. IE will then be run in standards mode and use the correct box model.

View File

@@ -0,0 +1,6 @@
Q> I'd like to let people upload files to my site but I'm worried about security...
A> There are a couple of things to do to improve security. First, use Binary storage, the uploaded files will then be stored in the MySQL database and won't be accessible to anyone apart from to download. Also, set the list of allowed file types, if anyone tries to upload a filetype other than the types you have defined it will be deleted immediately from your server.
Q> I've had some files uploaded, what do I do now?
A> You have the option to copy the file to your Download Manager, to allow others to download it, and to copy the upload information to your newspost section, to make a news item announcement about it.

View File

@@ -0,0 +1,3 @@
Q> What's the Extended Field section for?
A> This allows you to add more sections to the Users page. For example, if you were running a clan, you could add a field for clan nickname, or average number of flags :) The new field will appear in the User Settings page, and also the Members list.

View File

@@ -0,0 +1,3 @@
Q> What's this section for?
A> You can enter some text here that will always be displayed above your news items on the front page. You can enter a different message for Guests, Members and Administrators.

0
e107_docs/index.html Normal file
View File

40
e107_docs/style.css Normal file
View File

@@ -0,0 +1,40 @@
body {
color: #000;
font: 12px tahoma, arial, sans-serif;
background-color: #767E8F;
padding: 8px 8px 8px 8px;
margin: 0px 0px 0px 0px;
}
a {
color: #035479;
text-decoration: none;
}
a:hover {
color: #DC6504;
text-decoration: none;
}
#mainbox {
border: 2px solid #000000;
background-color: #fff;
color: #000;
padding: 30px;
}
.smalltext {
color: #000;
font: 12px verdana, tahoma, arial, sans-serif;
}
.headertext {
color: #DC6504;
font: 16px verdana, tahoma, arial, sans-serif;
font-weight: bold;
}
.indent {
border: 1px solid #D1CFCF;
background-color: #efefef;
color: #000;
padding: 10px;
}