Location: PHPKode > projects > Runner > docs/index.html
<!--
 **********************************************************************
 *  Copyright 2008
 * 
 *  This file is part of Runner.
 * 
 *  Runner 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 3 of the License, or
 *  (at your option) any later version.
 * 
 *  Runner 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 Runner.  If not, see <http://www.gnu.org/licenses/>.
 *
 ********************************************************************** 
*/
-->

<html>
<head>
<title>Runner Documentation</title>


<style type="text/css">

@media all {
	body {
		font-family: Verdana, Arial, Helvetica, Garamond, sans-serif;
		text-align: left;
		background-color: #FFF;
		font-size: 90%;
		margin: 5px;
		padding: 10px 5px 10px 5px ; 
	}
	a:link {color: #993333; text-decoration: underline}
	a:visited {color: #993333; text-decoration: underline}//#006699;
	a:active {color: #FF3300; text-decoration: underline}
	a:hover {color: navy; text-decoration: underline}
	h1 { font-family: Comic, Lithograph, Arial; color:black; text-align: left; font-size: 180%; font-weight: 600; display: inline;}
	h2 { font-family: Comic, Lithograph, Arial; color:black; text-align: left; font-size: 160%; font-weight: bold}
	img, table {border-width: 0px}
	
	h3 {font-family: Comic, Lithograph, Arial; color:black; text-align: left; font-size: 120%}
	p, td {font-family: Verdana, Arial, Helvetica, Garamond, sans-serif; font-size: 90%; text-align: left; vertical-align: top;}
		
	th {
		font-family: Verdana, Arial, Lithograph, Helvetica, sans-serif;
		text-align: left;
		font-size: 90%;
		font-weight: bold;
		vertical-align:top;
	}
	
	code {
		font-family: "Courier New", Courier, mono;
		font-size: 100%;
		white-space: pre;
	}
	blockquote {
		width:800px;
		background-color:#DFDFDF;
		border:1px dashed #4D4D4D;
		padding:10px;
	}
table.sample {
	border-width: 1px 1px 1px 1px;
	border-spacing: 2px;
	border-style: solid solid solid solid;
	border-color: gray gray gray gray;
	border-collapse: separate;
	background-color: rgb(255, 245, 238);
}
table.sample th {
	border-width: 1px 1px 1px 1px;
	padding: 2px 2px 2px 2px;
	border-style: none none solid none;
	border-color: black black black black;
	background-color: rgb(250, 240, 230);
	-moz-border-radius: 0px 0px 0px 0px;
}
table.sample td {
	border-width: 1px 1px 1px 1px;
	padding: 2px 2px 2px 2px;
	border-style: none none none none;
	border-color: black black black black;
	background-color: rgb(250, 240, 230);
	-moz-border-radius: 0px 0px 0px 0px;
}	
}
</style>
</head>

<body>

<img src='images/runner_logo.png' width='35px' style='margin:0px;padding:00px;'><span style='float:left;'><h3>Runner v. 1.0</h3></span><br><br><span style='float:right;'>Copyright (c) 2008</span><br>
<br>
<hr>

<h1>Documentation</h1>

<blockquote style='background-color:EEE;'>
    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 3 of the License, or
    (at your option) any later version.
<br><br>
    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.
<br><br>
    You should have received a copy of the GNU General Public License
    along with this program.  If not, see 'http://www.gnu.org/licenses/'.
</blockquote>
<h2>Table of contents</h2>
<ul>
	<li><a href='#introduction'>Introduction</a></li>
	<li><a href='#setup'>Setup</a></li>
	<li><a href='page_maker.html'>Page Setup (PHP side)</a></li>
	<li><a href='template_maker.html'>Making Templates (Template side)</a></li>
</ul>

<h2><a name='introduction'></a>Introduction</h2>
<p>
Because of the complications redesigning a website creates, it
became necessary to create a template engine to efficiently create new 
designed and styles for the website. With Runner, it 
is now easier than ever to create an entirely different layout without 
having to worry about reworking all the technical stuff, but instead making the 
site look good. Runner allows you to create the content once, and redesign 
the look and layout many times.
</p>

<h2><a name='setup'></a>Setup</h2>
<p>
Setup for Runner is really simple. Copy the <code>runner_include</code>
directory into your site's root directory (or the directory you want 
to run the php out of). The basic system is now set up.
</p>
<p>To start using templates make sure you have a <code>templates</code>
directory with at least one template in it. 
</p>
<p>Edit <code>runner_include/config.php</code> to match your site. This 
file will set up many constants that are used by runner, as well as a 
few thay mey be usefull to you.
<p>
<p>
Runner is now set up. :)
</p>
Return current item: Runner