Skip to content

Getting Started Guide

Ryan Mills edited this page Apr 1, 2014 · 1 revision

Below you will find the basic instructions for installing Temporal. Temporal is designed for PHP developers and as such requires you to know at least basic PHP syntax. Writing modules and custom pages will require a good grasp of OOP based PHP. Please read hosting requirements to make sure your host supports Temporal.

Step 1: Install Files

It's recommended to install Temporal via "git clone" via shell. Doing this is beyond the scope of this tutorial. You may also ftp files into the WWW root of your site.

Step 2: Create Site folder

Once you have your files on the server you need to create a "site" folder. Temporal will check for this folder for your config and auto-load templates, modules, and pages. It should be created in the root of your site. A sample folder structure would look like.

  • /site/ <-- your new folder
  • /system/
  • .htaccess
  • index.php
  • robots.txt

Step 3: Create your site folders and config.

Temporal's default theme is just for testing and it should not be edited. No files in the "/system/" folder should ever be edited. Those changes will be lost on upgrades. First, we need to create our basic site folders so we can create our own theme. Inside the "/site/" folder you created in the last step you need to create some basic folders. First, we need a blank "/site/config.inc.php". Then, we need a "/site/layout/layout1/" folder where "layout1" is the name of your first layout. Temporal supports changing layouts via the config.inc.php. For now, just start with "layout1". Then, you need to create at least one template "default.html". Temporal templates use plain html (html5 is used for all admin pages) and simple tags. Your template should have at a bare minimum the {css},{scripts},{content},{footer} tags. You can read more about tags and where to put them in the Tag Reference Guide

Your folder structure should now look something like:

  • /site/layout/layout1/
  • /site/config.inc.php
  • /system/
  • .htaccess
  • index.php
  • robots.txt

Step 4: Editing your config.inc.php

Temporal uses PHP Constants to set all global options. These are stored and auto-loaded from "/site/config.inc.php". Temporal will not create this file by default and you will need to add it. A complete list of constants can be found at Config Reference Guide