[drupal-devel] [feature] favicon patch for themes

[nysus]

Issue status update for http://drupal.org/node/20809

 Project:      Drupal
 Version:      cvs
 Component:    theme system
 Category:     feature requests
 Priority:     normal
 Assigned to:  nysus
 Reported by:  nysus
 Updated by:   nysus
 Status:       patch
 Attachment:   http://drupal.org/files/issues/favicon3.patch (6.59 KB)

Here is a revision to the patch that incorporates some suggestions that
have been made here.  It also fixes a bug in the previous version of
the patch.




nysus



Previous comments:
------------------------------------------------------------------------

April 18, 2005 - 19:42 : nysus

Attachment: http://drupal.org/files/issues/favicon.patch (4.57 KB)

Here is a patch that allows a user to manually set the path to the
"favicon.ico" file.  It makes a single change to the user interface: it
adds a text field to the "Logo image setting" section of the
"themes/settings" page.


This is especially useful for sites sharing a single code base as you
no longer need to create a new theme just so you can have a distinct
favicon.ico.




------------------------------------------------------------------------

April 23, 2005 - 00:28 : Steven

There is a lot of mailing list discussion about this patch.


One more note though: the <link /> tags are missing the trailing slash
for XHTML.




------------------------------------------------------------------------

April 23, 2005 - 11:06 : nysus

Attachment: http://drupal.org/files/issues/favicon2.patch (6.01 KB)

Here is a revision to the patch based on the feedback received on the
discussion list.  You can now override the default favicon the same you
way you can override the default site logo.  There is one difference: 
When a logo is uploaded, it is checked to determine whether it is a
valid image file using PHP's getimagesize function.  Since this
function does not work with .ico files, no validation of the uploaded
file is performed.  Advice on how (or if) validation needs to be
done---or any other suggestions and corrections---is welcome.




------------------------------------------------------------------------

April 23, 2005 - 13:45 : Steven

There is still a slash missing in bluemarine.


This patch appears to have per-theme favicons, but the setting to
control this is in fact defined by the theme engine, not the template
(through the list of support theme features). I was more thinking of
simply checking for the presence of a favicon.ico in the theme's own
directory. But I'm not sure if we really need this: it does make it
very obvious to people editing a theme that there is an icon file they
can change. On the other hand, few people will use a theme's default
favicon. It's more useful as a customization, and the UI option is good
enough for that.


Some text suggestions: "favorite icon" is not clear. I think the phrase
"shortcut icon" is better (that's the standard name) if we accompany it
with more text. Something like:


"Check this box to use the default shortcut icon or 'favicon'. This
icon is displayed in the address bar and bookmarks in most browsers."


"The path to the icon file you would like to use as your custom
shortcut icon."
(note: i replaced "image file" with "icon file" because for IE,
favicons need to be .ico files)


'Shortcut icon settings'




------------------------------------------------------------------------

April 23, 2005 - 14:07 : nysus

> I was more thinking of simply checking for the presence of a
favicon.ico in the theme's own directory.


This wouldn't work very well for sites sharing the same code base. 
Using your suggestion, you would have to create a custom theme just to
have a customized favorite icon.


> But I'm not sure if we really need this...


Can you please clarify to what "this" refers to?  It's unclear to me
what your suggestion is.


I'll incorporate your other suggestions and corrections into the next
revision.




------------------------------------------------------------------------

April 23, 2005 - 14:23 : kbahey

The patch as it stands is only for xtemplate. What about phptemplate?
Will it work with phptemplate?


+1 on the concept though. I like a more generic solution, like what you
proposed, that allows the favico to be added from an admin interface
just like the logo.


As for the comment:


>> I was more thinking of simply checking for the presence of a
>> favicon.ico in the theme's own directory.
>
> This wouldn't work very well for sites sharing the same code base.
> Using your suggestion, you would have to create a custom theme
> just to have a customized favorite icon.


If the theme is installed under sites/sitename/themes then its favico
will only show for the given site.




------------------------------------------------------------------------

April 23, 2005 - 14:41 : Steven

What I meant was to have the favicon default to
themes/themename/favicon.ico if it exists, and use favicon.ico
otherwise. I would still allow you to override the favicon regardless
over the admin interface. But I'm not sure if default per-theme icons
are useful anymore (that's what I meant with 'this').




------------------------------------------------------------------------

April 23, 2005 - 14:52 : nysus

> The patch as it stands is only for xtemplate. What about phptemplate?
Will it work with phptemplate?


xtemplate is the only templating engine in the Drupal core.  This patch
will not work with phptemplate until the maintainer of phptemplate
engine incorporates favicon functionality into the phptemplate engine.


> If the theme is installed under sites/sitename/themes then its favico
will only show for the given site.


Yes, I understand this, but it's a real hassle to have to create a new
theme directory just to facilitate the creation of a favicon.  I feel
strongly that a customized favicon is a common enough task that it
should be built into the Drupal user interface and should be made as
easy as possible.