I described the process I went through to have a different osCmax home page template from the rest of the site in another post.

When I finished I realised that the method had a few issues and in particular it meant that the changes impacted the whole site not just that template.

So my goal here is to provide an alternative method that moves some of the changes into the template to minimise the impact on the core files and to make the template switching option work even with these changes.

The change I want to make is to move the decision process around the use of more than one main_page.tpl.php type file.

Start in main_page.tpl.php lines 11 to 15:

require(DIR_WS_INCLUDES . ‘meta_tags.php’);
//require(DIR_WS_INCLUDES . ‘counter.php’);

$bts_php_array = bts_read_php();
$bts_html_array = bts_read_html($bts_php_array);

Change lines 14 & 15:

require(DIR_WS_INCLUDES . ‘meta_tags.php’);
//require(DIR_WS_INCLUDES . ‘counter.php’);

$bts_php_array = bts_read_php($php_template);
$bts_html_array = bts_read_html($bts_php_array, $html_template);

Add in this section before line 14 so it looks like this:

// if there is an alternate file and if this is called from index.php
if ((file_exists(‘main_index_page.code.php’)) ||
(substr($_SERVER[‘PHP_SELF’], -9) == ‘index.php’)) {
$php_template = ‘main_index_page.code.php’;
$html_template = ‘main_index_page.html’;
} else {
$php_template = ‘main_page.code.php’;
$html_template = ‘main_page.html’;
}

Then move down to what should now be line 41

function bts_read_php($php_template = ‘main_page.code.php’) {

Change this to

function bts_read_php($php_template) {

Next change the other function at line 60

function bts_read_html($php_code_array, $html_template = ‘main_page.html’) {

Change this to

function bts_read_html($php_code_array, $html_template) {

Close that file.

Ok, so if we had done the earlier method then we need to undo the change to /index.php

Go back to the index.php file and change around line 335 is

include (bts_select(‘main_index’)); // BTSv1.5

Change this back to

include (bts_select(‘main’)); // BTSv1.5

Close index.php as this is finished with.

Finally, create the main_index_page.code.php and main_index_page.html. Note that a main_index_page.tpl.php is not required in this method.

So what does this do? This allows us to add multiple main_page options (just add more if file_exists type options) and it means that the template switching option will still operate.

The osCmax 2.5RC1 includes some folders in the templates directory. The folders provide the following:

(BTS = Basic Template System)

compromise: this is a template with the updated BTS & html tagging
CSS-fluid-1: another sample template
fallback: this is the default or fallback template. Do not edit any of these files.
fallback-html: this is a sample template with BTS & html tagging
help: used for the Help files
help-text: used for the Help files
new: a sample template using the standard BTS and only providing one main_page file – shows that the fallback process works.
pgm: another sample template using the original BTS

When using the template switching option, once it is set all pages default to that new template. It overrides the settings in the admin console until the session ends or another template switch command is issued.

Copy any of the sample templates to modify as a new template just by copying the entire directory to a new directory and rename to something appropriate. Preferably use the fallback-html or the compromise templates as the base as both of these feature the new HTML tagging feature.

Depending on which posts you read in the osCmax forums you get a different lot of questions around handling having a different main or index page from the rest of the site.

The forum article on BTS templates has what I needed to make these changes, but it’s buried down the page. Open the forum article and search in the page for ‘main2’ and you’ll find the relevant information. So why write this up? Because I find some of the instructions ambiguous.

In the catalog or / directory of the osCmax site each of the .php files that controls a page includes a control link to the main_page.tpl.php

[php]include (bts_select(‘main’)); // BTSv1.5
[/php]

is found in the code (generally near the end of the file) and the activity / actions of the file push the results off to the template for display.

In this case I want to modify the /index.php file  and rather than using main2, I’ll name it as main_index.

Open the /index.php and at the very end of the file around line 335 is

include (bts_select(‘main’)); // BTSv1.5

Change this to

include (bts_select(‘main_index’)); // BTSv1.5

Close index.php as this is finished with.

Open /includes/configure_bts.php at line 19 copy the existing line

define(‘TEMPLATENAME_MAIN_PAGE’, ‘main_page.tpl.php’);

and paste it again and edit as the second line for the new page template

define(‘TEMPLATENAME_MAIN_PAGE’, ‘main_page.tpl.php’);
define(‘TEMPLATENAME_MAIN_INDEX_PAGE’, ‘main_index_page.tpl.php’);

Then find at around line 43

case ‘main’:
// default or main_page
if(is_file(DIR_WS_TEMPLATES . TEMPLATENAME_MAIN_PAGE)) {
$path = (DIR_WS_TEMPLATES . TEMPLATENAME_MAIN_PAGE);
} else {
$path = (DIR_WS_TEMPLATES_FALLBACK . TEMPLATENAME_MAIN_PAGE);
}
break;

and copy and paste this as a second block immediately below the first and edit it as shown

case ‘main’:
// default or main_page
if(is_file(DIR_WS_TEMPLATES . TEMPLATENAME_MAIN_PAGE)) {
$path = (DIR_WS_TEMPLATES . TEMPLATENAME_MAIN_PAGE);
} else {
$path = (DIR_WS_TEMPLATES_FALLBACK . TEMPLATENAME_MAIN_PAGE);
}
break;

case ‘main_index’:
// default or main_page
if(is_file(DIR_WS_TEMPLATES . TEMPLATENAME_MAIN_INDEX_PAGE)) {
$path = (DIR_WS_TEMPLATES . TEMPLATENAME_MAIN_INDEX_PAGE);
} else {
$path = (DIR_WS_TEMPLATES_FALLBACK . TEMPLATENAME_MAIN_INDEX_PAGE);
}
break;

Close the configure_bts.php file as this is finished with.

Next in the template directory that you are using (I cover that bit elsewhere) copy the

main_page.tpl.php
main_page.html
main_page.code.php

as new files:

main_index_page.tpl.php
main_index_page.html
main_index_page.code.php

If you use a text editor like EditPlus then opening the files and using Save As is another option.

The final step is to edit the main_index_page.tpl.php file

There are two lines that reference the other files:
Line 33:

function bts_read_php($php_template = ‘main_page.code.php’) {

change to

function bts_read_php($php_template = ‘main_index_page.code.php’) {

and line 52:

function bts_read_html($php_code_array, $html_template = ‘main_page.html’) {

change to

function bts_read_html($php_code_array, $html_template = ‘main_index_page.html’) {

Close this file as it is ready.

Make some changes in the main_index.html page so that you can see a difference and test your new template main page and another page to see that you have it all working. Once this is done, editing the two separate file pairs of .html and .code.php will allow for the setup of two types of layouts.

Of course, this can then be applied for a third or many multiples of layouts within the same site or template.

Now, this is the suggested process gleaned from various forum posts. I think there is a better way as I’d prefer to minimise the modifying of the core application files and this breaks the template switching process.

 

 

In osCmax 2.5 templates how do all the files relate to each other?

From the various sources that I have found (see my osCmax templates documentation listing) the following relationships exist.

The templates directory contains a master template called fallback. As the name implies this is the template that the system will ‘fall back to’ if there is no specific template instruction. It is not just the default template. As you will find, if you make your own custom template, and in that template for a particular page you do not specify a design then the system will check your custom template, find nothing, and will fall back to using any design controls for that page from the fallback template.

So if your template is called yoursite and it wants to use a content template called your_page it will look first for:
[php]
/templates/yoursite/content/your_page.tpl.php
[/php]
and if it is not found it will look next in the fallback template for the same file
[php]
/templates/fallback/content/your_page.tpl.php
[/php]
The assumption is that your_page is a standard page in osCmax and that for each page a content template exists. In your own template area, you only need to have a content template for the pages that you want to modify to be different from the default fallback template. The osCmax Wiki has some similar & related information on this topic.
So what is fallback vs fallback_html in the templates directory? Searched for hours and cannot see how fallback-html is used. The fallback template directory is fallback, not fallback-html. There is no reference to the fallback-html file in any file in osCmax and there is no reference to indicate that there is code to append -html to an existing fallback value.

So why does fallback-html exist and how is it meant to be used?  No idea at this time. Perhaps it is just an html tagged version of the fallback template. But that implies that for it to be effective, you have to link to it?

I raised it in the osCmax forums and it is, as I suggested above, a tagged version of the fallback template. A more appropriate title appears to be ‘sample-html-tagging’ and apparently 2.5RC1 includes files in the content directory that should be removed. You only want control files in the content directory for the pages that you want to modify from the default (fallback) settings.