Support Forum

Template or Overlay?

BR Brandon
Brandon
Member

There hasn’t been a post here lately so how about this one. 🙂

It seems in the docs and forums sometimes the files in the theme’s overlays folder are called Overlays and sometimes called Templates.

Probably should use the same terminology as much as possible. Since the folder is named overlays I vote that the files inside it are called that. Or change the folder name but that could be troublesome at this point.

 

While on the topic of naming things. Is it confusing to people calling a SP plugin a Plugin? Does it make them think that it is a WP plugin? I have seen posts where people are trying to add SP plugins to the WP plugin folder. Maybe call them SP Add-ons?

 

Oh, and started on some codex theme info… Basic info, what comes in the SP core plugin, where they are located, how to get other supplied themes, etc.

http://codex.simple-press.com/codex/themes/using-themes/

It also would be nice to have a place that shows pics of the various overlay files for people to look at. I will volunteer to capture images of the different ones if you come up with a place to put them.

11 Answers

New Answer

YS Yellow Swordfish
Yellow Swordfish
Member

Terms:

There is a very strict difference.  A ‘template’ (in the themes ‘templates’ folder) is the code file that generates the forum display. This is akin to a wordpress theme template.

An ‘overlay’ (in the themes styles/overlays folder) is a CSS styling layer that sits on top of the themes main css (or in this case php/css) file.

We do need to keep these disparate terms separate and clear and use the right one at all times.

Plugins:

I am afraid I agree with you (sorry Steve). I think it does and will lead to a certain measure of confusion with the less savvy user. Not fond of ‘Add-ons’ myself I have to say. My own personal favourite would have been ‘modules’.

Codex/using Themes:

Apart from the confusion with the template/overlay term in the first sentence (oh and a spelling error!) then this looks like a grand start to me. Two things. Don’t mark this page as complete as it will need updating when we know the url of the download which, of course will not be the current beta location. And at the bottom I would just add that the overlay can be selected at any time not just when you activate a theme.

Other than that – looks good  to me – even with those Windows images laugh

Need to bring Steve in on this for consensus but on the Codex themes menu I would re-order the left hand column to be ‘Using Themes’, ‘Theme Structure’, ‘Creating a Theme’. And personally I would remove ‘Core Themes’ as I am not sure what benefit that gives us.

What I think we SHOULD mention on the ‘Using Themes’ page is the other menu items. Needs a paragraph on setting a Mobile Theme and just a one liner on using the theme editor. And then I would think it’s done.

Overlay Images:

This brings up another point as well and I will open a ticket for this. The main theme images are probably out of date and need re-capturing and I think we should state in the theme description which overlay was used for the screenshot.

I would like to have small thumbnails of each overlay. A small portion of each (same portion in all cases) just to show the main colouring. But I think this really needs to be in the theme admin section not in the codex. Maybe on  a popup or something. If you fancy creating the images I can do the coding. I would go for quite small ones though – say not bigger than 200px…. But if it doesn’t get done it is not the end of the world. Just a very nice to have.

What’s Next:

I can’t remember now if you said you still had the text for the Creating a Theme entry that you wrote before. If you have and there is any chance you could put that back in place that would be great. I was planning on doing the ‘Theme Structure’ myself as my next Codes foray but if you get there first they hey! I wont complain smile

BR Brandon
Brandon
Member

OK,

Terms: Got it. Someone should add to the Codex Glossary.smile

Plugins: Not sure about the term module. I think of a module as something that is needed like the theme template files, but can be changed if desired. A add-on is something that is not needed at all for the core program to work but gives you additional capabilities. I don’t like ‘Add-in’ or ‘extension’ either. wink

 

Codex/using Themes:

Spelling error and ‘template’ term removed from entry. It is marked as being worked on. I agree the themes menu needs a little work. I will add something about the mobile theme and theme editor. Or maybe the theme editor needs it’s own page?

 

Overlay Images:

It would be great to have them in the admin section but they should also be put some place where someone can look at them without having to install SP. Once created you can choose which one to show for the theme example also.

You thinking something like this with the overlay name under the image?

 

forum2-200x199.jpg

 

What’s Next:

No I don’t have the creating theme text. I will do that after I get done with ‘Using Themes’ page.

BR Brandon
Brandon
Member

BTW,

Hating on how, when saved, it puts the pic left and then adds text to right of it when a post is saved like it just did above.

YS Yellow Swordfish
Yellow Swordfish
Member

The only problem with putting them in the codex is keeping them updated… I have no objection in principle.

I guess for the admin theme panel I was thinking more of a ‘swatch’ type approach like this for the ‘berries and cream’ overlay:

swatch.pngHaving the text flow round the image looks so much more elegant though! Why leave all that empty space? All you have to do is cursor down and out of it…and it will start the text after the image.

BR Brandon
Brandon
Member

There should be much to keeping them updated in the codex.  I don’t know, but I wouldn’t think you will be creating many more overlays that you would supply in the theme files. 19-20 is enough isn’t it? The ones already there won’t change enough to be noticeable in a small image.

A swatch is fine but its just as easy for me to screen cap, ad a description, and reduce the image to whatever size you want. 

On the left pic.

BR Brandon
Brandon
Member
forum2-24x24.jpg

This text entered in editor below the image but is still added to the right of it when saved.

64x64px example

YS Yellow Swordfish
Yellow Swordfish
Member

Now it is too small to see the actual colours though – which is really what you need.

BR Brandon
Brandon
Member

No probs on the size. Pick a size you like or think will allow them all to fit and then lets throw up a few examples.

BR Brandon
Brandon
Member

Yellow Swordfish said

What I think we SHOULD mention on the ‘Using Themes’ page is the other menu items. Needs a paragraph on setting a Mobile Theme and just a one liner on using the theme editor. And then I would think it’s done.

I added info on mobile themes and the editor so take a look now. I didn’t get into how the mobile support page works but hit on it just a bit so they know about it.

I am surprised I even got that much done after spending hours on a how-to stream your TV from anywhere in the world to your TV using 2 Vulkano devices.

I had to convert a PDF and all it’s images and then repost for WP and a bunch of other things just to make it kinda make sense.

At least that one was for a paid site. wink


MP Mr Papa
Mr Papa
Member

wow. seemed to have missed this whole topic.  must have been when I missed two days on the forum and overflowed that count of 50.  sure would like to have that ticket that makes that number selectable.  should be able to go more than two days and not lose visibility to new posts…

but yes, good work Brandon. keep it up.