Menu
▾
▴
Tree [r3] / History
| File | Date | Author | Commit |
|---|---|---|---|
| index.php | 2009-05-02 | patterson55 | [r3] Update to 0.1.4: Updated control panel, new set... |
| install.php | 2009-05-02 | patterson55 | [r3] Update to 0.1.4: Updated control panel, new set... |
| leap.php | 2009-05-02 | patterson55 | [r3] Update to 0.1.4: Updated control panel, new set... |
| readme.html | 2009-05-02 | patterson55 | [r3] Update to 0.1.4: Updated control panel, new set... |
| style.css | 2008-09-16 | patterson55 | [r2] Update to 0.1.3a, changes made to the control p... |
Read Me
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>Leap 0.1.4 Readme</title>
<style type="text/css">
@media screen
{
body { font: .9em "Trebuchet MS", Arial, Sans-Serif; margin: 0px; }
h1,h2 { margin: 0 0 2px 0; font-size: 2em; }
h1 sup { font-size: .6em; }
hr { display: none; }
a { color: #036DA7; background: inherit; }
code { font: 1em "Courier New", Arial; padding: 0.5em; background-color: #ddd; margin: 1px; display: block; }
em {text-decoration: underline;}
#wrap { width: 90%; margin: 30px auto; }
.readme { background: #E2FFD9; padding: 15px; border: 2px solid #69CB4B; margin: 10px 15px 0 15px; color: #1E4B00; }
.header { background: #E8F0FF; padding: 15px; border: 2px solid #4C6199; margin: 10px 15px 0 15px; color: #4C6199; overflow:hidden; cursor:pointer; }
.content{ background: #fff; margin: 0 20px 0 20px; color: #4B4000; border-bottom: 1px solid #A5D5E7; border-left: 1px solid #A5D5E7; border-right: 1px solid #A5D5E7; overflow:hidden; position:relative; padding:10px 5px 5px 5px; }
}
@media print
{
.content{ display: block !important; margin: 0 20px 40px 20px; }
a { color: #036DA7; background: inherit; }
}
</style>
<script type="text/javascript">
function toggle(div) {
if (document.getElementById(div).style.display=='') {
document.getElementById(div).style.display = 'none';
return
} document.getElementById(div).style.display = '';
}
</script>
</head>
<body onload="toggle('toc');toggle('d1');toggle('d2');toggle('d3');toggle('d4');toggle('d5');toggle('d6');toggle('d7');">
<div class="readme">
<h1>Leap<sup>0.1.4</sup> Readme</h1>
<p>Welcome to <a href="http://leap.gowondesigns.com/">Leap</a> - a single file, template independant, <a href="http://www.php.net/">PHP</a> and <a href="http://www.mysql.com/">MySQL</a> powered, standards valid <a href="http://en.wikipedia.org/wiki/Content_management_system">Content Management System</a>.</p>
<p><b>Before installing please check minimum system requirements:</b></p>
<p><a href="http://www.apache.org/">Apache</a> Server<br />
<a href="http://www.php.net/">PHP</a>: Hypertext Preprocessor version 4.x or greater<br />
<a href="http://www.mysql.com/">MySQL</a> database version 3.23 or greater</p>
<p>These applications are freely available, and can be installed both on Windows and Linux OS (detailed info can be obtained at their websites).</p>
<p>To view directions for each step, click on the headers. <b>Please review every section.</b></p>
</div>
<div id="toc">
<div class="header" title="Table of Contents"><h1>Table of Contents</h1></div>
<div class="content">
<ul>
<li><a href="#1">Uploading Files and Installation</a></li>
<li><a href="#2">Working With Templates</a></li>
<li><a href="#3">Using The Admin Panel</a></li>
<li><a href="#4">Managing Users</a></li>
<li><a href="#5">Using Menus</a></li>
<li><a href="#6">Customizing Articles</a></li>
<li><a href="#7">Additional Info</a></li>
</ul>
</div>
</div>
<div class="header" title="Putting Leap onto your server" onclick="toggle('d1')"><h1><a name="1">Uploading Files and Installation</a></h1></div>
<div class="content" id="d1">
<ol>
<li><b>Copy all the files</b> from the Leap package to your server and CHMOD 775 the Leap.php and index.php files.<br />
If you cannot CHMOD the files, you may have to do a manual installation.</li>
<li><b>Run install.php</b>.</li>
<li><b>Complete the steps</b> in the install.php file; it will guide you through an automatic and manual installation.</li>
<li><b>Delete install.php</b> after the script has been installed successfully to be safe.</li>
</ol>
<p>Multiple instances of Leap can be ran on the same server, but they must be located in different folders and have different database table prefixes in order to run properly.</p>
</div>
<div class="header" title="Creating, modifying, and changing templates" onclick="toggle('d2')"><h1><a name="2">Working With Templates</a></h1></div>
<div class="content" id="d2">
<h2>Creating Templates</h2>
It's very easy to create your own Leap templates, and it is really simple to turn nearly any pre-existing template into a Leap-ready template.
<p>All templates consist of an <b>index.php</b> file that may link to other external files (StyleSheets, images, etc.). If you are modifying a pre-existing template and it uses an <b>index.html</b> file, just rename it.</p>
<ol>
<li>First, you <b>need</b> to include this line on the <b>FIRST LINE</b> of your template:
<code><? session_start(); include("leap.php"); ?></code>
This line includes Leap into your template and allows you to use the Leap functions in your template.
</li>
<li>To display content generated by Leap, you must include: <code><? content(); ?></code> into your template. This should be placed where you want the main content to go, but it can be placed anywhere in your script.</li>
<li>You can retrieve values from your System Settings by using the <b>value();</b> function. This can be used in your template to display various things in your template:
<code><? value('version'); ?><br />
<? value('title'); ?><br />
<? value('slogan'); ?><br />
<? value('site_email'); ?><br />
</code>
You can call any setting by using it's name (eg. <b>value('list_format');</b> ), but that data isn't very readable.</li>
<li>Similar to the <b>value();</b> function, the <b>db();</b> function can be used to retrieve core values.<b>NOTE: it is only recommended to use this for the 'website' value.</b> All other values obtained by the <b>db();</b> function are VERY CRUCIAL and could be dangerous to the securit of your site if exposed.</li>
<li>The <b>login();</b> function is a dynamic link to the Admin Panel. The text of the link will display "Login", until the user logs in and it will change to "Admin".</li>
<li>The <b>search();</b> function creates the search bar. The display of the search bar can be completely manipulated through CSS.</li>
</ol>
<p>For quick reference, the most commonly used Leap commands are:
<code><? value('version'); ?><br />
<? value('slogan'); ?><br />
<? value('site_email'); ?><br />
<? db('website'); ?><br />
<? title(); ?><br />
<? login(); ?><br />
<? search(); ?><br />
<? content(); ?><br />
</code>
These can all be used multiple times within your template with no problems, though the <b>content();</b> function should only need to be used once.
</p>
<h2>Changing Templates</h2>
To change your template, all you need to do is <b>replace</b> your current index.php file with the index.php file of the new template you wish to use.
<p>All of the content generated by Leap is intended for <a href="http://www.w3.org/MarkUp/#xhtml1"><b>XHTML Strict</b></a> and <a href="http://www.w3.org/MarkUp/#xhtml1"><b>Transitional</b></a> designs. <b>When selecting and creating templates, it is always a good idea to have Standards Valid designs.</b></p>
</div>
<div class="header" title="Learning the ins and outs of the Admin Panel" onclick="toggle('d3')"><h1><a name="3">Using The Admin Panel</a></h1></div>
<div class="content" id="d3">
<h2>Usage</h2>
You can get to the access panel by typing <b>?admin</b>. If your website is <b>http://www.mywebsite.com/</b>, then the admin panel would be located at <b>http://www.mywebsite.com/?admin</b>. You can only access the the portions of the admin panel that you have permission to (See <a href="#4"><em>Managing Users</em></a>).
<h2>Customizing</h2>
Everything in the date setting is parsed like the <a href="http://us3.php.net/manual/en/function.date.php">PHP date function</a>. Visit the <a href="http://us3.php.net/manual/en/function.date.php">PHP Manual</a> for help on what letters to use to get the correct format.
</div>
<div class="header" title="Setting up other users to use your site" onclick="toggle('d4')"><h1><a name="4">Managing Users</a></h1></div>
<div class="content" id="d4">
<p>As the default administrator, you have the power to create new users and control what pieces of the interface that they have access to. You can limit any users you create to these parameters:</p>
<ul>
<li>Manage System</li>
<li>Manage Users</li>
<li>Manage Extensions</li>
<li>Manage Categories</li>
<li>Manage Pages</li>
<li>Manage Articles</li>
<li>Manage Others' Articles</li>
<li>Manage Comments</li>
</ul>
</div>
<div class="header" title="Learn to create and customize your menus" onclick="toggle('d5')"><h1><a name="5">Using Menus</a></h1></div>
<div class="content" id="d5">
Leap can create dynamic menus that give you extra options in organizing and displaying information on your site. Instead of hard-coding your own menu into your template, all it takes is one tag to include a navigational (or other purpose) menu for your site.
<h2>Creating Menus</h2>
When you create a menu, you must first give it a <b>name</b> and a <b>title</b>. The menu's name will be used to when calling the menu in your template. The title will be used in the menu for everyone to see (eg. the default menu's name is <b>main</b>, while it's title is <b>Navigation</b>, which is shown at the top of the menu).
<p>Next, You add and fill in the fields to create menu items. Every columns has two fields. The first field is the <b>name</b> of the menu item, and the second field is the <b>URL</b> of the item. </p>
<h2>Adding Menus to Your Template</h2>
<p>To use a dynamic menu in your template, simply include this PHP tag:</p>
<code><? menu('####'); ?></code>
<p>Simply replace '####' with the name of the menu you want to include. The default Leap menu is <strong>main</strong>, and in the default template the code is:</p>
<code><? menu('main'); ?></code><br />
<h2>Customizing Menus</h2>
<p>All of the dynamic menus utilize unordered lists and are customizable through css. The name of the menu is turned into a CSS, and can be customized in your stylsheet. You can edit the <strong>main</strong> menu using the following names:</p>
<code>ul.main<br />
ul.main #menutitle<br />
ul.main #active<br />
ul.main #last<br />
ul.main #edit</code>
<p>To customize other menus, just change "main" to the name of the menu you want to use.</p>
</div>
<div class="header" title="Formatting the way your content looks" onclick="toggle('d6')"><h1><a name="6">Customizing Articles</a></h1></div>
<div class="content" id="d6">
<b>This section is under construction.</b>
</div>
<div class="header" title="Solving the common issues that come up during installation and setup" onclick="toggle('d7')"><h1><a name="7">Troubleshooting Common Problems</a></h1></div>
<div class="content" id="d7">
<p>Until enough feedback is gathered to determine the common stumbling blocks among installation and first-time use, the most useful resource is the <a href="http://leap.gowondesigns.com/community/">Leap Community Forum</a>.</p>
</div>
<div class="header" title="Additional Info" onclick="toggle('footer')"><h1><a name="7">Additional Info</a></h1></div>
<div class="content" id="footer">
Bug reports, suggestions, comments, questions:<br /><a href="http://leap.gowondesigns.com/community/">Leap Community</a>
<p><a href="http://leap.gowondesigns.com/">Leap</a> is licensed under the <a href="http://www.opensource.org/licenses/osl-3.0.php">Open Software License 3.0</a>.<br />
Copyright © 2006-09, <a href="http://www.gowondesigns.com/">Gowon Designs</a></p>
</div>
<div class="spacer"> </div>
</body>
</html>
