Actions

Difference between revisions of "Creating a basic index file"

From Joomla! Documentation

m (tt to code)
 
(5 intermediate revisions by 5 users not shown)
Line 1: Line 1:
The <tt>index.php</tt> file becomes the core of every page that Joomla! delivers. Essentially, you make a page (like any HTML page) but place [[PHP]] code where the content of your site should go. Here is the bare-bones code ready for you to cut and paste.
+
{{version/tutor|2.5,3.x}}
 +
The <code>index.php</code> file becomes the core of every page that Joomla! delivers. Essentially, you make a page (like any HTML page) but place [[PHP]] code where the content of your site should go. The template works by adding Joomla code into module positions and the component section in your template. Anything added to the template will appear on all pages unless it is added to one of these sections via the Joomla CMS (or customised code).
  
A Joomla 1.5 template begins with the following lines:
+
This page will show the bare-bones code ready for you to cut and paste into your own design.
 +
 
 +
===Begin===
 +
 
 +
A Joomla template begins with the following lines:
  
 
<source lang="php">
 
<source lang="php">
 
<?php defined( '_JEXEC' ) or die( 'Restricted access' );?>
 
<?php defined( '_JEXEC' ) or die( 'Restricted access' );?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+
<!DOCTYPE html>
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
 
<html xmlns="http://www.w3.org/1999/xhtml"  
 
<html xmlns="http://www.w3.org/1999/xhtml"  
 
   xml:lang="<?php echo $this->language; ?>" lang="<?php echo $this->language; ?>" >
 
   xml:lang="<?php echo $this->language; ?>" lang="<?php echo $this->language; ?>" >
Line 12: Line 16:
 
The first line stops naughty people looking at your coding and getting up to bad things.  
 
The first line stops naughty people looking at your coding and getting up to bad things.  
  
The second line is the doctype which tells the browser (and [[wikipedia:Web crawler|web crawlers]]) what sort of page it is. This doctype is xhtml 1.0 but you can also change this whole line to:
+
The second line is the [[wikipedia:Document Type Declaration|Document Type Declaration (DOCTYPE)]], which tells the browser (and [[wikipedia:Web crawler|web crawlers]]) which flavor of HTML the page is using. The doctype used above is [[wikipedia:HTML5|HTML5]], a newer version of HTML that is largely backwards compatible, but contains many new features. You should be aware that this will not work well in Internet Explorer 8 or earlier without a hack. You might want to investigate this situation and your clients' wishes before deciding on which doctype you want to use. However this is used in Joomla {{JVer|3.0}} and higher.
  
<source lang="php">
+
The third line begins our HTML document and describes what language the website is in. A html document is divided into two parts, head and body. The head will contain the information about the document and the body will contain the website code which controls the layout.
<!DOCTYPE HTML>
+
</source>
+
 
+
Which will make the page html5 instead of "xhtml 1.0 transitional" which will be a bit more up to date. It'll also ensure that you have access to a few new pieces of html code not featured in xhtml 1.0. You should be aware that this will not work in internet explorer 8 or earlier without a hack so unless you know how to add the hack you should leave it as xhtml 1.0.
+
 
+
The third line begins our html document and describes what language the website is in. A html document is divided into two parts, head and body. The head will contain the information about the document and the body will contain the website code which controls the layout.
+
 
+
==Head==
+
  
 +
===Head===
 
<source lang="php">
 
<source lang="php">
 
<head>
 
<head>
Line 34: Line 31:
  
 
The first line gets Joomla to put the correct header information in. This includes the page title, meta information as well as system JavaScript.  
 
The first line gets Joomla to put the correct header information in. This includes the page title, meta information as well as system JavaScript.  
The rest creates links to two system style sheets and to your own style sheet (if it's named <tt>template.css</tt> and is located in the <tt>''css''</tt> folder of your template directory. So if your temlate is in http://www.mysite.com/templates/my_template/ then the css files will go in http://www.mysite.com/templates/my_template/css/).
+
The rest creates links to two system style sheets and to your own style sheet (if it's named <code>template.css</code> and is located in the <code>''css''</code> folder of your template directory. So if your temlate is in http://www.mysite.com/templates/my_template/ then the css files will go in http://www.mysite.com/templates/my_template/css/).
  
==Body Section==
+
===Body Section===
  
 
<source lang="php">
 
<source lang="php">
Line 46: Line 43:
 
</source>
 
</source>
  
Amazingly, this will suffice! Yes, its a very basic layout, but it will do the job. Everything else will be done by Joomla!. Note: you will need to ensure your menu is set to go into the "top" [[Screen.modules.edit.15#Details|module position]].  
+
Amazingly, this will suffice! Yes, it's a very basic layout, but it will do the job. Everything else will be done by Joomla!. These lines, usually called [[jdoc statements]], tell Joomla to include output from certain parts of the Joomla system. Note: you will need to ensure your menu is set to go into the "top" module position.
  
==Module Positions==
+
====Module Positions====
  
Above the line which says name="top" adds a module position which is called top and allows Joomla to place modules into this section of the template. The type="component" line contains all articles and main content and is very important. It goes in the centre of the template.  
+
Above, the line which says <code>name="top"</code> adds a module position called ''top'' and allows Joomla to place modules into this section of the template. The <code>type="component"</code> line contains all articles and main content (actually, the [[component]]) and is very important. It goes in the centre of the template.  
  
Note: You can add your own module lines anywhere you want in the body but you have to add a corresponding line to the templateDetails.xml file which sits alongside the index.php of your template.
+
Note: You can add your own module lines anywhere you want in the body, but you have to add a corresponding line to the templateDetails.xml file which sits alongside the index.php of your template.
  
 +
=== End ===
 
Finish it off - one last bit:
 
Finish it off - one last bit:
 
<source lang="php">
 
<source lang="php">
 
</html>
 
</html>
 
</source>
 
</source>
<noinclude>View the [[Basic template index file|full source code]] of this template.</noinclude>
 
[[Category:Tutorials]][[Category:Template Development]]
 
  
==Custom Images==
+
===Custom Images===
  
 
If you want to add any images to the template you can do so like this:
 
If you want to add any images to the template you can do so like this:
 
<source lang="php">
 
<source lang="php">
<img src="<?php echo $thebaseurl; ?>/images/stories/myimage.png" alt="Custom image" class="customImage" />
+
<img src="<?php echo $this->baseurl; ?>/images/stories/myimage.png" alt="Custom image" class="customImage" />
 
</source>
 
</source>
  
Here the $baseurl variable will fill in the path to your template for you.
+
Here the baseurl variable will fill in the path to your template for you.
  
==Custom CSS==
+
===Custom CSS===
  
 
You can add custom css like this:
 
You can add custom css like this:
Line 79: Line 75:
  
 
Every file which is added must have a line in the templateDetails.xml file for the template.
 
Every file which is added must have a line in the templateDetails.xml file for the template.
 +
 +
[[Category:Tutorials]][[Category:Template Development]]

Latest revision as of 18:31, 17 September 2013

The index.php file becomes the core of every page that Joomla! delivers. Essentially, you make a page (like any HTML page) but place PHP code where the content of your site should go. The template works by adding Joomla code into module positions and the component section in your template. Anything added to the template will appear on all pages unless it is added to one of these sections via the Joomla CMS (or customised code).

This page will show the bare-bones code ready for you to cut and paste into your own design.

Contents

Begin

A Joomla template begins with the following lines:

<?php defined( '_JEXEC' ) or die( 'Restricted access' );?>
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" 
   xml:lang="<?php echo $this->language; ?>" lang="<?php echo $this->language; ?>" >

The first line stops naughty people looking at your coding and getting up to bad things.

The second line is the Document Type Declaration (DOCTYPE), which tells the browser (and web crawlers) which flavor of HTML the page is using. The doctype used above is HTML5, a newer version of HTML that is largely backwards compatible, but contains many new features. You should be aware that this will not work well in Internet Explorer 8 or earlier without a hack. You might want to investigate this situation and your clients' wishes before deciding on which doctype you want to use. However this is used in Joomla Joomla 3.0 and higher.

The third line begins our HTML document and describes what language the website is in. A html document is divided into two parts, head and body. The head will contain the information about the document and the body will contain the website code which controls the layout.

Head

<head>
<jdoc:include type="head" />
<link rel="stylesheet" href="<?php echo $this->baseurl ?>/templates/system/css/system.css" type="text/css" />
<link rel="stylesheet" href="<?php echo $this->baseurl ?>/templates/system/css/general.css" type="text/css" />
<link rel="stylesheet" href="<?php echo $this->baseurl ?>/templates/<?php echo $this->template; ?>/css/template.css" type="text/css" />
</head>

The first line gets Joomla to put the correct header information in. This includes the page title, meta information as well as system JavaScript. The rest creates links to two system style sheets and to your own style sheet (if it's named template.css and is located in the css folder of your template directory. So if your temlate is in http://www.mysite.com/templates/my_template/ then the css files will go in http://www.mysite.com/templates/my_template/css/).

Body Section

<body>
<jdoc:include type="modules" name="top" /> 
<jdoc:include type="component" />
<jdoc:include type="modules" name="bottom" />
</body>

Amazingly, this will suffice! Yes, it's a very basic layout, but it will do the job. Everything else will be done by Joomla!. These lines, usually called jdoc statements, tell Joomla to include output from certain parts of the Joomla system. Note: you will need to ensure your menu is set to go into the "top" module position.

Module Positions

Above, the line which says name="top" adds a module position called top and allows Joomla to place modules into this section of the template. The type="component" line contains all articles and main content (actually, the component) and is very important. It goes in the centre of the template.

Note: You can add your own module lines anywhere you want in the body, but you have to add a corresponding line to the templateDetails.xml file which sits alongside the index.php of your template.

End

Finish it off - one last bit:

</html>

Custom Images

If you want to add any images to the template you can do so like this:

<img src="<?php echo $this->baseurl; ?>/images/stories/myimage.png" alt="Custom image" class="customImage" />

Here the baseurl variable will fill in the path to your template for you.

Custom CSS

You can add custom css like this:

<link rel="stylesheet" href="<?php echo $this->baseurl ?>/templates/<?php echo $this->template;?>/css/styles.css" type="text/css" />

Every file which is added must have a line in the templateDetails.xml file for the template.