Documentation Menu

1.5 Template Project

The Joomla! Documentation Working Group is running a project to develop detailed reference and tutorial material on Joomla! 1.5 templates.  There is a project page on the documentation wiki where you can see the work in progress and help us by contributing your knowledge.

Who's Online

We have 7 guests online

Help Site License

The Joomla! Help Site content is copyright © 2005 - 2008 by the individual contributors and can be used in accordance with the Creative Commons License, Attribution NonCommercial ShareAlike 2.5. Some parts of this website may be subject to other licenses.
Home arrow Manual arrow 11. API Reference arrow [REVIEW] mosShowHead

[REVIEW] mosShowHead PDF Print E-mail

Last reviewed: 16 December 2005
phpDocumentor

mosShowHead

Assembles the head tags for the document. This function is called by the template to display the head block of the document.

The function sets up the following meta tags:

  • description (based on the $mosConfig_MetaDesc configuration variable.
  • keywords (based on the $mosConfig_MetaKeys configuration variable.
  • Generator (this displays the product name and copyright information)
  • robots (robots are set to index and follow)

The function then displays the head tags, displays a base href tag for search engine friendly operation, displays the live bookmark information for site syndication and displays a link tag to refer to the site icon.

Search Engine Friendly information is enabled and disabled via the $mosConfig_sef configuration variable.

Live bookmarks are enabled and disabled via the live_bookmark parameter.

The site icon is specified in the $mosConfig_favicon configuration variable and should be located in the <path-to-Joomla>/images directory. By default this is called 'favicon.ico'.

If the page was requested by a logged in user ($my->id is not 0), then code is displayed to include the /includes/js/joomla.javascript.js file.

Syntax

void mosShowHead ( )

Defined in

includes/template.php
(includes/frontend.php prior to Joomla 1.1)

Examples

Example: Display the contents of the page header

mosShowHead();

might produce:

<title>Joomla Stable Site - Home</title>
<meta name="description" content="Joomla - 
                      the dynamic portal engine and content management system" />
<meta name="keywords" content="Joomla, joomla" />
<meta name="Generator" content="Joomla! - 
                      Copyright (C) 2005 Open Source Matters. All rights reserved." />
<meta name="robots" content="index, follow" />
<link rel="shortcut icon" href="http://127.0.0.1/stable/images/favicon.ico" />

Please report any errors on this page to the Developer Documentation Forum.

Last Updated ( Monday, 25 December 2006 )
 
< Prev   Next >