Author Topic: simple guide for templates (Read 9837 times)

babis1 · « **on:** September 25, 2012, 20:19:30 »

can we have a very simple guide for the elxis 4 templates, i would like to know the chages in xml and index.php files i keep that
in xml file the elxis 4 use package and dependencies, but there are no files and filenames
in index.php we have to use for modules <?php $eDoc->modules('something', 'none'); ?> but in p.e Delta have

<?php
defined('_ELXIS_') or die ('Direct access to this location is not allowed');

$eLang = eFactory::getLang();
$eDoc = eFactory::getDocument();
$elxis = eFactory::getElxis();

elxisloader::loadFile('templates/delta/includes/delta.class.php');
$delta = new templateDelta();

echo $eDoc->getDocType()."\n";
?>
<html<?php echo $eDoc->htmlAttributes(); ?>>
<head>
<?php $eDoc->showHead(); ?>
<link rel="stylesheet" href="<?php echo $elxis->secureBase(); ?>/templates/delta/css/template<?php echo $eLang->getinfo('RTLSFX'); ?>.css" type="text/css" />
<?php $delta->addHead(); ?>
</head>

we need all those ?

also how we call the <?php mosMainBody(); ?>

........thanks

datahell · « **Reply #1 on:** September 25, 2012, 22:53:20 »

A detailed guide will be available soon. I will now only post some quick info on the code you wrote (taken from default template delta).

First, everything referring to $delta is specific only to this template. It is not required your template to have classes and external php files. The Delta template has an extended functionality which is controlled by the $delta instance. So ignore $delta for basic or hardcoded functionality.

eFactory: Elxis loads most important library instances via a factory class.
For example language object is loaded like this: $eLang = eFactory::getLang();

$eDoc is the instance of the elxisDocument class. elxisDocument controls subjects related to the document contents (headers, loading css/js files, styling, etc).
Examples:
add a css file into the page headers:
$eDoc->addStyleLink('http://www.example.com/xxx/yyy.css');
add a javascript file into the page headers:
$eDoc->addScriptLink('http://www.example.com/xxx/zzz.js');
add raw css into the page headers:
$eDoc->addStyle('.test { margin:0; }');
load jquery:
$eDoc->addJQuery();
etc....

eDoc->getDocType(); returns the document type (<!DOCTYPE html> in case of html5)

$eDoc->htmlAttributes(); returns a portion string for the <html> tag (the document namespace - if any- and language declaration)

$eDoc->showHead(); generates and echo's the document html head data (meta tags, css/js links, etc)

$eDoc->component(); display the component's output as saved into buffer (quite equivalent to mosMainBody() of 2009.x)

$eDoc->pathway(); displays the pathway - $eDoc->pathway(true); with "you are here", $eDoc->pathway(false); without "you are here"

$eLang->getinfo('RTLSFX') returns -rtl on RTL languages (like farsi) and an empty string on LTR.

$elxis is the instance of the elxisFramework class, the inner elxis core. Something like the $mainframe on Elxis 2009.x
$elxis = eFactory::getElxis();
$elxis->secureBase(); returns the secure (SSL/TLS) base url of the web site if SSL is enabled, else returns the non ssl one.

Load modules of position xxx:
$eDoc->modules('xxx', 'none');
Load modules of position left:
$eDoc->modules('left');
Styles (2nd parameters above): none, round, empty string (default) - recommendation: dont use "round" it is old fashioned

Count modules assigned in position xxx:
$eDoc->countModules('xxx');

Template files:
templates/xxx/index.php (required - the main template file/layout)
templates/xxx/xxx.xml (required - template details and parameters, for backwards compatibility templateDetails.xml is also supported)
templates/xxx/install.php (optional - install/update/uninstal actions)
templates/xxx/xxx.png (optional - small template preview)
templates/xxx/inner.php (optional - template for inner.php pages like popup windows, print page, etc)
templates/xxx/403.php (optional - error 403 - forbidden- page)
templates/xxx/403.mobile.php (optional - error 403 - forbidden- page for mobile devices)
templates/xxx/404.php (optional - error 404 - page not found)
templates/xxx/404.mobile.php (optional - error 404 - page not found for mobile devices)
templates/xxx/alogin.php (optional - admin login page - for backend templates)
templates/xxx/alogin.mobile.php (optional - admin login page for mobile devices - for backend templates)
templates/xxx/error.php (optional - generic error page)
templates/xxx/error.mobile.php (optional - generic error page for mobile devices)
templates/xxx/offline.php (optional - site offline page)
templates/xxx/offline.mobile.php (optional - site offline page for mobile devices)
templates/xxx/security.php (optional - elxis defender warning page)
templates/xxx/security.mobile.php (optional - elxis defender warning page for mobile devices)
templates/xxx/fatal.php (optional - fatal error page)
templates/xxx/fatal.mobile.php (optional - fatal error page for mobile devices)

All other files are optional.

Here is a sample/idea on how you can provide a mobile version of a template to mobile devices.
in index.php:

Code: [Select]

$browser = $elxis->obj('browser')->getBrowser();
if ($browser['mobile'] == true) {
    //include the mobile layout
} else {
    //include the standard layout
}

Elxis Nautilus does NOT requires you to declare the extension's files in installation XML file!
Just zip your extension and it is ready to be installed via the Elxis installer!

If you think the elxis 4.x coding is hard and difficult, just wait for the official documentation.
You will see that it is much easier than 2009.x and, off course, much more powerful.
If you understand some things about elxis 4.x core structure you will get quickly into Elxis 4.x spirit!

babis1 · « **Reply #2 on:** September 25, 2012, 23:11:28 »

awesome ! thank you for your time

babis1 · « **Reply #3 on:** September 25, 2012, 23:47:46 »

something dont working for me can you give me an example for the simlpe xml without extension's files in installation XML file p.e.

<?xml version="1.0"?>
<package type="template" section="frontend">
   <name>ba</name>
   <title>ba</title>
   <created>2011-12-26 19:40:00</created>
   <author>me</author>
   <authoremail>info@me.gr</authoremail>
   <authorurl>http://www.me.com</authorurl>
   <copyright>(C) 2009-2012 me. All rights reserved</copyright>
<link></link>
   <version>1.0</version>
   <description><![CDATA[me]]></description>
</package>

---------------my index.php-----------(simple)
<?php

defined( '_VALID_MOS' ) or die( 'Direct Access to this location is not allowed.' );

$eLang = eFactory::getLang();
$eDoc = eFactory::getDocument();
$elxis = eFactory::getElxis();

echo $eDoc->getDocType()."\n";
?>
<html<?php echo $eDoc->htmlAttributes(); ?>>
<head>
   <?php $eDoc->showHead(); ?>
   <link rel="stylesheet" href="http://www.mysite.gr/templates/ba/css/main.css" type="text/css" />

</head>
<body id="body">

<div id="wrapper">

        <div class="navigation"> <?php $eDoc->modules('top', 'none'); ?>


       </div> <div id="header"> <?php $eDoc->modules('header', 'none'); ?> </div>

       <div id="faux">


        <div id="leftmiddle">

     <?php $eDoc->component(); ?>
        </div>


<div class="clear"></div>

</div>

<div id="footer">

<?php $eDoc->modules('footer', 'none'); ?>

</div>


</div>

</body>
</html>

Tank · « **Reply #4 on:** September 26, 2012, 05:34:09 »

Hi babis1,

I'd like to help. Your code looks fine to me, what exactly is not working?
Elxis 4. you need to insert a new row to DB through installation, I think it goes to elx_templates table. After that's added, everything is auto detect and works nicely.

babis1 · « **Reply #5 on:** September 26, 2012, 09:42:32 »

the db is ok there is a table elx_templates, i use for my tests yesterday the xml file from iris admin template (because is simlpe),

Code: [Select]

<?xml version="1.0"?>
<package type="template" section="backend">
	<name>ba</name>
	<title>Ba</title>
	<created>2012-04-06 19:39:00</created>
	<author>Elxis Team</author>
	<authoremail>info@elxis.org</authoremail>
	<authorurl>https://www.elxis.org</authorurl>
	<copyright>(C) 2006-2012 Elxis.org. All rights reserved</copyright>
	<license>Elxis Public License</license>
	<licenseurl>https://www.elxis.org/elxis-public-license.html</licenseurl>
	<link></link>
	<version>1.0</version>
	<description><![CDATA[Iris is a pre-installed template for Elxis 4.x administration area.]]></description>
	<dependencies>
		<package type="core" version="4.x">elxis</package>
	</dependencies>
	<params />
</package>

but i have the same results
Installation XML file was not found. Invalid Elxis package!

datahell · « **Reply #6 on:** September 26, 2012, 10:32:08 »

<package type="template" section="backend">
This is for an administration template.
For the public area you should write:
<package type="template" section="frontend">

Use proper name/title, author, license, etc, in xml.

As you haven't install the template via the elxis installer you have to do this manually. As Tank said, add manually an entry in elx_templates db table for your new template.

babis1 · « **Reply #7 on:** September 26, 2012, 10:56:39 »

ok i replace with frontend section in xml file, the point is that i try to install via elxis installer the zip that i create and gives me the same result
Installation XML file was not found. Invalid Elxis package!

datahell · « **Reply #8 on:** September 26, 2012, 11:30:21 »

Use a proper name. The <name> in XML should be the same as the extension's name and the same with the xml file. <title> can be anything.

For example:

<name>sample</sample>

sample.xml

tpl_sample_1.0.zip

babis1 · « **Reply #9 on:** September 26, 2012, 11:42:33 »

nothing ! i will send you my zip file, because i cant publish here the template, and if you have time tell me what going wrong..
thanks

babis1 · « **Reply #10 on:** September 26, 2012, 11:48:39 »

ok its working.my fault was that i zip the folder

also i had a wrong code at the start of index.php i had the old one

<?php
defined( '_VALID_MOS' ) or die( 'Direct Access to this location is not allowed.' );

i change it with

<?php
defined('_ELXIS_') or die ('Direct access to this location is not allowed');

and finally i can see my template

..thanks

datahell · « **Reply #11 on:** September 26, 2012, 13:02:39 »

Good, your first Elxis 4.x template!

_VALID_MOS is dead! Long live _ELXIS_ !

babis1 · « **Reply #12 on:** September 26, 2012, 13:19:33 »

sorry for the chaos but for my job is very important the templates, is the only way to fight with thousand joomla templates !!!

Author Topic: simple guide for templates (Read 9837 times)

babis1

simple guide for templates

datahell

Re: simple guide for templates

babis1

Re: simple guide for templates

babis1

Re: simple guide for templates

Tank

Re: simple guide for templates

babis1

Re: simple guide for templates

datahell

Re: simple guide for templates

babis1

Re: simple guide for templates

datahell

Re: simple guide for templates

babis1

Re: simple guide for templates

babis1

Re: simple guide for templates

datahell

Re: simple guide for templates

babis1

Re: simple guide for templates