Replace Board Title With Image

[dougiefresh]

Link to Mod

REPLACE BOARD TITLE WITH IMAGE v1.4
By Dougiefresh -> Link to Mod

Introduction
The idea for this mod came from a topic titled A Neat Way To Enhance A Board!, which wrote about a way to use an image in place of the board title.  This mod attempts to accomplish this objective with a minimum of changes to the forum software.

Please note that at this time, there is no automated way to upload images to the server.  You must upload them to a location underneath the forum folder and refer to them as relative paths.  In other words, if you upload it to /forum/Themes/default/images/duh.png, then you would type Themes/default/images/duh.png into the board image field.

Admin Settings
In Admin => Forum => Boards, there is a new field when modifying the boards:
o Replacement Board Title image

Compatibility Notes
This mod was tested on SMF 2.0.14 and SMF 2.1 Beta 3, but should work on SMF 2.0 and up.  SMF 1.x is not and will not be supported.

This mod does not require the SVG As Image Attachment mod to be installed prior or after this mod.  Rather, if the mod has been installed, it will try to use the functions from that mod (as opposed to the built-in getimagesize function).

Related Discussions
o A Neat Way To Enhance A Board!
o Will it wreak havoc to use an image here?

Changelog
The changelog can be viewed at XPtsp.com.

License
Copyright (c) 2017 - 2018, Douglas Orend
All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

[-Rock Lee-]

The idea seems very good but it resonates to me. What happens when you have many forums would not cause a problem when loading the images? I also leave the translation in Spanish


Regards!

[dougiefresh]

Uploaded v1.1 - November 29th, 2017
o Added support for SMF 2.1 Beta 3.
o Added support for the SVG As Image Attachment mod.
o Added Spanish Latin translation, courtsey of Rock Lee!
o Added file exists check so that missing images won't cause boards to become inaccessable.




@Rock Lee:  Thank you for the translation!  It's been included in this version!

What happens when you have many forums would not cause a problem when loading the images?

I've read both discussions that I've linked to in the first post.  I can't foresee any issues that might arise from using this mod....  If you run into any problems running this mod, please share them with me so that I can try to fix the issue....

[-Rock Lee-]

I've read both discussions that I've linked to in the first post.  I can't foresee any issues that might arise from using this mod....  If you run into any problems running this mod, please share them with me so that I can try to fix the issue....

Great @dougiefresh will be testing to what this or that problem


Regards!

[Aleksi "Lex" Kilpinen]

Tested this out with a fresh 2.1 beta 3

PHP message:
PHP Parse error: syntax error, unexpected ',', expecting ')' in /Sources/Subs-Boards.php on line 1329

Also, the reason I wanted to test was, to see if this bit actually works:

Code Select Expand


if (file_exists($sourcedir . '/Subs-SVG.php'))
$img_dim = @getimagesize($boarddir . '/' . $boardOptions['board_image']);
else
$img_dim = @svg_getimagesize($boarddir . '/' . $boardOptions['board_image']);


In my mind, that's backwards. Is it not?

[dougiefresh]

Uploaded v1.2 - December 29th, 2017
o Fixed coding error that fails to properly get image sizes.
o SMF 2.1: Fixed syntax error in Sources/Subs-Boards.php.



@Aleksi "Lex" Kilpinen:  Thank you for reporting this bug!  It's been fixed in this version!

[Aleksi "Lex" Kilpinen]

You are welcome

[pepa]

Tried installing this and received the warning message not to proceed unless you really know what you are doing ... so obviously some incompatibilities somewhere?

SMF 2.0.14
Mods: Board-color-and-icons 1.1, reCAPTCHA for SMF 1.0.0, Responsive Curve 1.0.0, PayPal Donate 1.0, Global Topics 2.2

[dougiefresh]

I'll take a look and see what I can do about the incompatibility/incompatibilities...

[dougiefresh]

Uploaded v1.3 - January 2nd, 2018
o Resolved incompatability with Board color and icons mod.



@pepa:  Thank you for the report!  Hopefully, this solves this issue you were experiencing!

[pepa]

Yes thank you dougiefresh, that did the trick : )

[dougiefresh]

Uploaded v1.4 - October 23rd, 2018
o No functionality change.
o Updated documentation to point to new website.

[landyvlad]

Can I suggest some 'before and after' images as examples on the mod page so people can see what it actually can look like?

[shadav]

I installed this on 2.0.15
it works but.... it doesn't size with the image size
each image is 300 x 200 px
so shouldn't the boards all be the same spacing? why are some more and others less and one is really bad :p

thank you for this though but how can I fix this?

well removing the images and then adding them again seemed to have fixed this... so it's ok now not sure what happened.....

[shadav]

just noticed today that it doesn't work on child boards....

the image is fine, as I use it for another board

but this is the first time I'm trying to use it on a child board

how to fix this? it acts like it's wanting to work but the image isn't there....

[edit] forgot to say it's for a 2.0.17 thank you

[shadav]

just noticed today that it doesn't work on child boards....

the image is fine, as I use it for another board

but this is the first time I'm trying to use it on a child board

how to fix this? it acts like it's wanting to work but the image isn't there....

[edit] forgot to say it's for a 2.0.17 thank you

figured it out

normally I'd just type in
foldername/filename

but for subcategories you have to type in
/foldername/filename

for it to work correctly
otherwise it's trying to pull the image from url/subcategory/foldername/filename, which obviously doesn't exist....

[lather]

I successfully installed this mod on my 2.0.15 forum but am  have not been able to make it work. I have uploaded a test image to Themes/default/images and enter that url but nothing happens. No error message but nothing changes on the board.

[sam666]

If it's any help, here is the url I put for one of my boards which works fine.
/Themes/default/images/android.png
image size used is 32x32

[lather]

If it's any help, here is the url I put for one of my boards which works fine.
/Themes/default/images/android.png
image size used is 32x32

Thanks for the reply. That is exactly the url I used (ecept for image nmae). I used a much larger image. Will try with a smaller one.

Nope that did not help!

[shadav]

I successfully installed this mod on my 2.0.15 forum but am  have not been able to make it work. I have uploaded a test image to Themes/default/images and enter that url but nothing happens. No error message but nothing changes on the board.

When you installed the mod was there any errors on the install page?
are you using a custom theme? if you switch to default theme does it work?
this shouldn't really be an issue with this mod but can't hurt....

make sure that the image was uploaded....go to the images url and make sure that it is there and viewable....

are you using cache? clear your cache then reload the page.....clear your browsers cache and reload the page....

use the parse on the mod page and make sure that all edits were made

[lather]

I successfully installed this mod on my 2.0.15 forum but am  have not been able to make it work. I have uploaded a test image to Themes/default/images and enter that url but nothing happens. No error message but nothing changes on the board.

When you installed the mod was there any errors on the install page?
are you using a custom theme? if you switch to default theme does it work?
this shouldn't really be an issue with this mod but can't hurt....

make sure that the image was uploaded....go to the images url and make sure that it is there and viewable....
are you using cache? clear your cache then reload the page.....clear your browsers cache and reload the page....

use the parse on the mod page and make sure that all edits were made

Thanks for your reply. There were no errors on install of the mod. The current theme is SMF Default Theme - Curve
I uploaded the image with ftp to /public_html/mstaforums/Themes/default/images and can view it with FTP client.
I have not cleared caches I will try that.  I will also check the edits. Thanks again.

[lather]

I have cleared caches fro the forum and my browser, no luck.
I verified the edits to all these files:
./Themes/default/ManageBoards.template.php
./Themes/default/languages/ManageBoards.english.php
/Sources/Subs-Boards.php
./Sources/Subs-BoardIndex.php
./Sources/ManageBoards.php
The only missing is
ManageBoards.spanish_latin.php we do noy have that file but should not make any difference

I looked at the SMF_boards table in the database and the  3 image fields are there but img _name is blank and width and height are 0

[lather]

I still can't get this to work, I must be missing something obvious. Any more suggestions?

[shadav]

does it replace the board title but just with a blank space or is the board title still there?

[lather]

The board title is still there. When I return to the mod and try again the title field is blank.
In other words the path and image file name I previously enter is not there.

[Tonyvic]

You are scrolling down and selecting the 'Modify' button after entering the url?

[lather]

Yes.

[shadav]

did you use the package manager to install this mod or did you manually install it?
if manually, did you upload the file db_install.php to your site and the run it by going to yoursite url/db_install.php

[lather]

I did use the package Manager..

[shadav]

if you want to pm me the url, access to ftp and an admin account
I'll try to take a look and see if I can find anything....

[lather]

Thank you for that kind offer. I will need to get our club president approval.

[lather]

I finally got the mod to work. I had been  selecting default theme since when I look at current theme in admin is shows: SMF Default Theme - Curve
This time I tried "core" and it worked. Thanks again for all your help.

[shadav]

not sure I understand, you uploaded the file to the core theme instead of the default theme?

Anyways glad you got it sorted it

what I did was created a new folder in the main forum's folder (where the Settings.php file is)
I'm lazy at names so I just named this new folder, replaceboardname
that way the images aren't theme dependent
and then just call the image as
/replaceboardname/IMAGENAME.EXTENTION

[lather]

not sure I understand, you uploaded the file to the core theme instead of the default theme?

Anyways glad you got it sorted it

what I did was created a new folder in the main forum's folder (where the Settings.php file is)
I'm lazy at names so I just named this new folder, replaceboardname
that way the images aren't theme dependent
and then just call the image as
/replaceboardname/IMAGENAME.EXTENTION

This is what about drove me crazy (admittedly a short trip) To get it to work the image had to be in /public_html/mstaforums/Themes/default/images but when modifying the board I had to select core theme from the pull down. I think the previous admin who set up the forum messed up our themes some way, I don't know... see attachment.  Anyway your solution sounds much better, thanks!

[shadav]

yeah that's not right....something some where's off

also don't forget to add the / in front
if you try to use it in a sub board it won't work unless you put the / before
/Themes/default/images/IMAGENAME

otherwise it tries to pull the image from forum/sub-board/themes/default/images/IMAGENAME

[Dave J]

Is there any chance of this being updated to SMF2.1.1 please?

[lather]

Please.

[Grammy]

I got this to work in 2.1.2 by manually installing it, after seeing that it failed emulation.

In Sources/Subs-BoardIndex.php, I had to find

Code Select Expand

        'b.name AS board_name',
        'b.description',  and add after

Code Select Expand

        'b.img_name',
        'b.img_width',
        'b.img_height',
and in Sources/Subs-Boards.php I had to find

Code Select Expand

global $cat_tree, $boards, $smcFunc  and add after

Code Select Expand

, $boarddir, $sourcedir,
(I had to add $sourcedir, because otherwise, it threw an Unknown Variable: $sourcedir error for that file.)

All the other file edits in the manual installation for 2.1 were fine, only Sources/Subs-BoardIndex.php and Sources/Subs-Boards.php were problematic.  (And I had to remember to add the language file edits.)

The db_install.php file worked with no issue and the image appears just as it should, with no log errors...  for me, anyway.

(I'm only posting this because someone asked and since I kick tires and test things, I tried it and it works fine, no errors, and the images appears as it should. 

[Grammy]

Well....  okay, all good except for an error I didn't discover until I tried to create a new board: 

Code Select Expand

Undefined index: image
That's coming from ManageBoards.template.php, line 347:

Code Select Expand

   
<input type="text" name="board_image" value="', $context['board']['image']['name'], '" size="30" class="input_text" />
Does this require an "isset" statement?  (Like I even know what I'm asking...) 


 

[Grammy]

Well....  okay, all good except for an error I didn't discover until I tried to create a new board: 

Code Select Expand

Undefined index: image
That's coming from ManageBoards.template.php, line 347:

Code Select Expand

   
<input type="text" name="board_image" value="', $context['board']['image']['name'], '" size="30" class="input_text" />
Does this require an "isset" statement?  (Like I even know what I'm asking...) 


 

Never mind, I sorted it. 

Code Select Expand

   
<input type="text" name="board_image" value="', $context['board']['image']['name'], '" size="30" class="input_text" />
is now this:

Code Select Expand

    <input type="text" name="board_image" value="' . $verify_context = &$context['board']['image']['name'], '" size="30" class="input_text" />
An old SMF friend of mine used to call this "Duct Tape". 

[Dave J]

Thanks but I had a problem with it, so I'd still like a correct version that will install from the Package manager please

[Doug Heffernan]

Thanks but I had a problem with it, so I'd still like a correct version that will install from the Package manager please

By the looks of it the mod author has not been active for quite some time. Their last post was 3 years ago.

[Dave J]

Thanks but I had a problem with it, so I'd still like a correct version that will install from the Package manager please

By the looks of it the mod author has not been active for quite some time. Their last post was 3 years ago.

We can but ask Doug 

[Grammy]

Thanks but I had a problem with it, so I'd still like a correct version that will install from the Package manager please

Mine is working really well now, 2.1.2, default, but I did have to go in and make that 2nd edit I mentioned on page 2.  (But I don't have any other mods, so that may be why I'm in the clear.)   

[Dave J]

Thanks but I had a problem with it, so I'd still like a correct version that will install from the Package manager please

Mine is working really well now, 2.1.2, default, but I did have to go in and make that 2nd edit I mentioned on page 2.  (But I don't have any other mods, so that may be why I'm in the clear.)   

Yes I have 18 mods installed and as you say this might be the issue