Templates Basics

Microweber templates are a set of files that determines the overall look of a website. These files are used to generate the site layout and the html code.

You can use PHP and HTML to make your template as flexible as you need it to be.

Template basics

All templates are located into userfiles/templates directory. Each template is contained within its own folder and you need to create a new folder when creating a new template. Usually, the name of the folder is given the name of your new template.

Template folders must be in lower-case and must not contain spaces or special characters.

Here is the most basic template structure

userfiles
 /templates
    /my_template
     config.php
     header.php
     index.php
     footer.php
     clean.php

###Basic files and their purpose

Filename

Description

config.php

holds the information for your template, like name, version

index.php

homepage default layout

header.php

site header

footer.php

site footer

clean.php

default layout for page

inner.php

default layout for post

config.php

Here is example config file you must create in your template folder

 userfiles/templates/my_template/config.php

####Set template name, author and version

The config.php file must contain a $config array with the following information.

<?php
$config = array();
$config['name'] = "My template";
$config['author'] = "Your name";
$config['version'] = 0.1;
$config['url'] = "http://example.com/";

The config file defines the name of your template as it will appear in the "Template selection" menu and in the "Settings" area.

The version parameter is optional and its used if you want to offer updates.

Adding CSS and Javascript

In the common case every template have a lot of files, those may be images, css files, javascripts and what not. You can put those files in the template folder and load them in your layout file

To add some basic styling, please create a css/ folder inside your theme folder and add some CSS in css/theme.css

<!DOCTYPE html>
<html>
    <head>
    <meta charset="utf-8">
    
    <link rel="stylesheet" href="<?php print template_url(); ?>style.css">
    <script type="text/javascript" src="<?php print template_url(); ?>scripts.js"></script>
      
    </head>
    <body>
       ...
    </body>
</html>

Adding modules in your template

You can add a module in your template if you want to show dynamic content or work with some custom functionality

The modules are added with <module type="name_of_your_module" />

Template functions and constants

Function

Value

template_url()

http://example.com/userfiles/templates/my_template/

template_dir()

/home/user/public_html/userfiles/templates/my_template/

Template variables

Variable

Value

$content

Array of the current content item, it can be page or post

$page

Array with the data for the current page

$post

Array with the data for the current post

Editable regions

The editable regions are the places where the users can drag and drop modules and edit content in real time.

You can define as few or as many regions that you like

Every layout can have many editable regions.

How to make editable regions

You can define editable regions in your template where the user will be able to type text and Drag and Drop modules The content of this region will be dynamic and will be editable on every layout that includes it.

Here is how it looks like:

<div class="edit"  field="your_region_name" rel="content">      
	<p>Edit your content</p>
</div>

Disable & enable drop for specific elements

The classes nodrop and allow-drop give you more control over which elements can or can not accept new elements. The nodrop class remove the ability to insert element and allow-drop enables it again. For example:

<div class="edit"  field="your_region_name" rel="content">      
    <div>
        <p>Edit your content</p>
    </div>
    <div class="nodrop">
        <p>Dropping is disabled here</p>
    </div>
    <div class="nodrop">
        <p>Dropping is disabled here</p>
        <div class="allow-drop">
            <p>Dropping is Enabled here</p>
        </div>
    </div>
</div>

Editing modes

Microweber provides 2 types of editing logics - regular mode and safe mode. Regular mode is the default editing case in which you can add format or delete elements. Safe mode is more strict way of editing. It adds various restrictions that prevent user from breaking the deasign of selected section. The class *safe-mode * activates safe mode or an element and it's children, and regular-mode restres the regular mode.

<div class="edit"  field="your_region_name" rel="content">      
 
    <div class="safe-mode">
        <p>Protected UI</p>
        <div class="regular-mode">
            <p>Regular editing</p>
        </div>
    </div>
</div>

PreviousUsing options NextCreating Templates

Last updated 2 years ago