Actions

Difference between revisions of "Changing the site favicon"

From Joomla! Documentation

m
 
 
(21 intermediate revisions by 10 users not shown)
Line 1: Line 1:
===Changing the site favicon===
+
[[Image:Favicon.png|450px|right]]
----
+
 
This chunk has yet to be written, but here are some useful references:-
+
Changing your website's favicon is a relatively easy task.
* http://en.wikipedia.org/wiki/Favicon
+
 
* http://www.winterdrache.de/freeware/png2ico/favicon.html
+
# '''Create a 16x16 pixel image.'''  You may use graphic software such as [[wikipedia:Photoshop|Photoshop]], [[wikipedia:Gimp|Gimp]], [[wikipedia:Paint.net|Paint.net]] or [[wikipedia:Windows_Paint|Windows Paint]]. Alternatively, you can also use an online tool such as http://antifavicon.com/
----
+
# '''Convert to ico format''' using free online sites such as:
[[Category:Templates]]
+
#* http://converticon.com/
 +
#* http://www.favicongenerator.com/
 +
#* http://www.htmlkit.com/services/favicon/
 +
#* http://tools.dynamicdrive.com/favicon/
 +
#* http://www.favicon.cc/
 +
# The file you created in this way will have the extension .ico. '''Copy the file''' to the <code>/joomla/templates/<your template></code> directory and '''name it''' <code>favicon.ico</code>.
 +
# Open a browser. Do you see your new icon? If so, congratulations. If not, that doesn't necessarily mean you did anything wrong. Browsers are designed to minimize data traffic, so they don't refresh the favicon every time they show a page. Even refreshing the page (F5) won't help. So you need to refresh more thoroughly:
 +
#* ''Mozilla / Firefox / Safari'': hold down Shift while clicking Reload, or press Ctrl-Shift-R (Cmd-Shift-R on Apple Mac);
 +
#* ''IE'': hold Ctrl while clicking Refresh, or press Ctrl-F5;
 +
#* ''Konqueror'': simply click the Reload button, or press F5;
 +
#* ''Opera'' users may need to completely clear their cache in Tools→Preferences.
 +
#* ''Chrome'': Shift-F5
 +
#* If this doesn't work you will need to delete the temporary internet files and the history and then open your page again.
 +
 
 +
===My favicon is in another location===
 +
Some templates contain code that redirects the browser to another directory or another icon file. To determine where your new favicon should be, examine http://yoursite.com/templates/your_template/index.php and look for code that contains the text <link rel="shortcut icon". There you will find the directory and the name of the icon file. Copy your icon to that place and give it the the name that link is pointing to (you might want to backup the old file). Make sure you set the security correctly such that you webserver has access to that file. Look at the example below. <source lang="html4strict"><link rel="shortcut icon" href="http://yoursite.com/templates/your_template/icon/favicon.ico" /></source>
 +
 
 +
If you don't want to just change the '''favicon.ico''' file in its respective template directory you can find the reference to the '''favicon.ico''' file in the '''html.php''' document. The path is '''"........\libraries\joomla\document\html\html.php"'''. This should prevent the icon from toggling if you use
 +
<source lang="html4strict"><link rel="shortcut icon" href="http://yoursite.com/templates/your_template/icon/youricon.ico" /></source>
 +
in the template html and you don't remove the favicon.ico file. (why call the icon twice?)
 +
 
 +
From the html.php
 +
<source lang="php">
 +
// Try to find a favicon by checking the template and root folder
 +
$path = $directory . DS;
 +
$dirs = array( $path, JPATH_BASE . DS );
 +
foreach ($dirs as $dir )
 +
{
 +
$icon =  $dir . 'favicon.ico';
 +
if (file_exists( $icon ))
 +
{
 +
$path = str_replace( JPATH_BASE . DS, '', $dir );
 +
$path = str_replace( '\\', '/', $path );
 +
$this->addFavicon( JURI::base(true).'/'.$path . 'favicon.ico' );
 +
break;''
 +
 +
</source>
 +
<noinclude> [[Category:Tutorials]]
 +
[[Category:Template Development]]
 +
[[Category:Template Reference]]
 +
[[Category:Template Management]]
 +
</noinclude>

Latest revision as of 20:45, 25 June 2013

Favicon.png

Changing your website's favicon is a relatively easy task.

  1. Create a 16x16 pixel image. You may use graphic software such as Photoshop, Gimp, Paint.net or Windows Paint. Alternatively, you can also use an online tool such as http://antifavicon.com/
  2. Convert to ico format using free online sites such as:
  3. The file you created in this way will have the extension .ico. Copy the file to the /joomla/templates/<your template> directory and name it favicon.ico.
  4. Open a browser. Do you see your new icon? If so, congratulations. If not, that doesn't necessarily mean you did anything wrong. Browsers are designed to minimize data traffic, so they don't refresh the favicon every time they show a page. Even refreshing the page (F5) won't help. So you need to refresh more thoroughly:
    • Mozilla / Firefox / Safari: hold down Shift while clicking Reload, or press Ctrl-Shift-R (Cmd-Shift-R on Apple Mac);
    • IE: hold Ctrl while clicking Refresh, or press Ctrl-F5;
    • Konqueror: simply click the Reload button, or press F5;
    • Opera users may need to completely clear their cache in Tools→Preferences.
    • Chrome: Shift-F5
    • If this doesn't work you will need to delete the temporary internet files and the history and then open your page again.

My favicon is in another location

Some templates contain code that redirects the browser to another directory or another icon file. To determine where your new favicon should be, examine http://yoursite.com/templates/your_template/index.php and look for code that contains the text <link rel="shortcut icon". There you will find the directory and the name of the icon file. Copy your icon to that place and give it the the name that link is pointing to (you might want to backup the old file). Make sure you set the security correctly such that you webserver has access to that file. Look at the example below.
<link rel="shortcut icon" href="http://yoursite.com/templates/your_template/icon/favicon.ico" />

If you don't want to just change the favicon.ico file in its respective template directory you can find the reference to the favicon.ico file in the html.php document. The path is "........\libraries\joomla\document\html\html.php". This should prevent the icon from toggling if you use

<link rel="shortcut icon" href="http://yoursite.com/templates/your_template/icon/youricon.ico" />

in the template html and you don't remove the favicon.ico file. (why call the icon twice?)

From the html.php

// Try to find a favicon by checking the template and root folder
                $path = $directory . DS;
                $dirs = array( $path, JPATH_BASE . DS );
                foreach ($dirs as $dir )
                {
                        $icon =   $dir . 'favicon.ico';
                        if (file_exists( $icon ))
                        {
                                $path = str_replace( JPATH_BASE . DS, '', $dir );
                                $path = str_replace( '\\', '/', $path );
                                $this->addFavicon( JURI::base(true).'/'.$path . 'favicon.ico' );
                                break;''