RAM-CMS Configuration
======================

This documentation page is not finished. Please refer to config.pl and read 
the comments inside to configure RAM-CMS fully.

Basic Configuration
--------------------
Basic Configuration is required in order for RAM-CMS to work. Many of the 
defaults, however, will likely work as-is.

The Options (in the order they appear in config.pl):

$compress=1;
This option, when set, will use PHP to compress your page content, thus 
dramatically saving bandwidth. If you run RAM-CMS on a busy or heavily loaded 
server, you may want to turn this setting off to save CPU and RAM resources, 
like so:
$compress=0;

$pages_dir='./pages/';
This specifies the directory where the actual web pages are to be stored. 
The default location is the "pages" subdirectory of your RAM-CMS installation.
If you are parinoid about security you might want to change this, although 
in reality this isn't necessary since the files under "pages" all are .php 
files that simply set variables, or a plain text files that will passthru 
just as if they were called via RAM-CMS (basically information disclosure 
cannot happen since the RAM-CMS page format prevents this).

$def_page='home';
This specifies the default page to show then no ?page= is specified. It is 
much like the index.html (Default.htm on IIS) file on web servers. 'home' is 
a good setting for most.

$ext='.txt';
This specifies the default file extension for pages (these file live in 
$pages_dir). There shouldn't be any reason to change this.

$nocache=0;
This tells RAM-CMS whether to allow browsers to cache the pages. 
If you update your static site pages more than once an hour 
(this is how long clients can cache pages with this set to false) then you 
may want to turn this off. Note that only browsers are allowed to cache stuff 
with this false, no web proxies can cache any of this.
Please note that this does not apply to elements included in a page, like 
images, but only to the page itself. The web server defaults apply to external 
page elements.

$bbcode=0;
This tells RAM-CMS whether to parse page files for BBCode.
A complete list of supported BBCode tags and santax is in BBCODE.TXT
Note that it is possible to mix raw HTML and BBCode in page files.
This setting applies to both static pages and dynamic pages.

$strip_whitespace=1;
This tells RAM-CMS whether or not to strip whitespace to save bandwidth?
if your server is overloaded turning this off might help performance.

$site_name='My Site';
This sets the name of your site?
This should be set to the name of your organization, company, etc.
This text is represented by the [[site]] tag in the templates, 
in the title where the <title> is page_name - site_name and in the 
header area of the page. It is highly suggested that you change this!

$copyright='Copyright &copy; 2008 Name_Of_Copyright_Holder.';
Copyright message to show on site.
This appears in site templates at the [[copyright]] tag.
It is highly suggested that you change this!

$keywords='';
This sets the keywords that identify your site to search engines.
This appears in site templates like this: 
<meta name="keywords" content="[[keywords]]">
where [[keywords]] is whatever is in $keywords

$description='';
This sets the description that identifies your site to search engines.
This appears in site templates like this:
<meta name="description" content="[[description]]">
where [[description]] is whatever is in $description

### Optional Settings ###
none.

#####################
### Page Template ###
#####################

$theme_file='ramnet-theme.txt';
This specifies the page theme config information.
For page themes look in the "themes" directory.
The file specified here must exist in the "themes" directory.
