Extension: MD Dulee Noted. A non-editable note field type to add instructions to weblogs
Development and Programming
This really is pretty simple. I needed a way to get generic, per-weblog instructions in the control panel. So what this extension does is to create a non-editable note field type for adding general weblog instructions. The only thing required for this to really work is the jQuery JavaScript library. You can set the path for jQuery in the settings (see below). You ARE using jQuery, aren’t you?
Settings Upload the extension and language file. Set the path to your jQuery file and optionally change the styles of the instruction box (color, border, background image…whatever you need). You can add as many styles as you need, but there are a couple in there to get you started, including one to float images to the left. One you’re done with the settings, create a custom field (or fields), and you will see a new field type in the dropdown: “Dulee Noted”.
Make a Custom Field…or two. Or three. This field is applied to every entry in a weblog just like a regular custom field, but there is no textarea or text input - so it’s a way to get weblog specific instructions on your entries that really appear to be more a part of the Control Panel.
Have a super-long entry page? Segment your fields into areas, with some basic instructions for each area. Make a Custom Field, and select the “Dulee Noted” field type from the Field Type dropdown. Then put everything for the field in the Field Instructions. That’s it.
All I’ve done is basically kill any sort of input field on this field type, and gave the instructions a nice little call-out box through some styles. I also automatically send links made in the instruction box to a new window (unobtrusively), so you can still open those links in a new tab if you wish.
Once you’ve made your field(s), Use the Field Order link to put them where you need them.
Never Forget how the &%#$ you are doing something in a weblog Never again forget that entries in your weblog are sorted by date, or that you have to remember to make an entry ‘sticky’ for it to be featured on your homepage, put in a reminder to select a category…whatever you need to remind your clients about you can put in one of these fields. As anyone who has done some tricky EE work knows, sometimes it can be tough to remember what everything does as a whole!
More ideas: Put in a link to another site or to a reference file (like a PSD file for making particular images). Put a picture in there. You can already do this with a regular field, but this way the field can’t be altered, and it looks more like a part of the clients’ installation. It’s more integrated with the Control Panel.
Until EE 2.0 arrives (or even after it arrives, as not everyone will be updating every install immediately, I’m sure) this will serve as a nice replacement for the upcoming “Accessories” - which will serve the same purpose as this type of field, but in a much more robust way.
I decided to realase it, ‘cause what the heck. If it works for you, great. I know I’ll be using it on every build I have happening right now!
You can download Dulee Noted from this page: Dulee Noted at Masuga Design.
Clever idea!
Glad you posted this on Twitter as I probably wouldn’t have found it otherwise. This sounds really great! Can’t wait to give it a whirl.
Great thanks!
Ryan this looks absolutely fantastic. Will definitely be giving this a look in later today. Excellent work!! 😊
Best wishes,
Mark
Ryan it all works great although it didn’t work with links opening up in new windows. Not too sure what that is all about though. Checked in the rendered control panel source code and the link to the Javascript path is definitely correct but hovering over links shows that they are just going to open in the same tab at the moment. Not too sure why that is though?
Fantastic extension this one though so thanks. 😉
Best wishes,
Mark
I’ll put this to use in the project I’m currently working on - a perfect fit and a great idea, thanks.
geof
Glad you posted this on Twitter as I probably wouldn’t have found it otherwise. This sounds really great! Can’t wait to give it a whirl.
seconded.
Not to toot my own horn, but I am finding this enormously useful and am adding at least one instruction field on every weblog right now, and moving it right to the top, below the URL Title area. Entries now seem sort of naked without an instructions box there, even if it only has a few bullet points or sentences in there.
The only thing I’ve found is that if you have many weblogs sharing a field group, your instructions may have to be a little more generic than if those fields only applied to one weblog.
There are a few buggy things I’ve found since releasing it (i.e. the links not using the jQuery to open in new tab/window, and the css styles being added to the header twice (I think I know what’s happening in both cases)). I’ll get to those when I get a chance.
Any other suggestions are welcome, as maybe I can incorporate those too, if they’re not too crazy.
If I update, I’ll mention it here, and ping it on Twitter as well. If you’re interested, my Twitter(s) are: masuga (‘personal’) and masugadesign (‘business’).
A great idea Ryan!
Ive always wanted to be able to add instructions under the Title as you can with all other fields but this makes sense to me.
Uh oh. I just killed my client’s control panel after installing this. I didn’t have jquery installed yet (not sure if that caused it or not). My CP is blank now (nothing in the browser), so I can’t disable the extension.
Tried deleting the files via ftp, but then the CP gave me an error message that the extension file was missing.
Any idea how I can disable and/or delete this stuff via phpMyAdmin?
Thanks, and hopefully I hear back before my client tries to login this morning.
File browse to System -> Config.php
Then look for -
$conf['allow_extensions'] = "y";and change it to -
$conf['allow_extensions'] = "n";Point your internet to the admin panel and it should work.
What version/build of EE are you running?
jQuery is only involved with making the note field look good inside a blue box, more or less. The extension will still “work” without it, but the Dulee Noted field will look real weird. What other extensions do you have installed?
I would back up and delete the ext and lang file. Then you can hit your extensions table with phpMyAdmin and delete the three lines that should be in there for Dulee Noted.
Sorry for the meltdown, I know how those feel. I did test the extension pretty thoroughly and used best practices when making it. I would be curious to know what other extensions you might have installed as this is probably a conflict of some sort.
That was amazingly fast!
I’m working on your ideas above right now. In the meantime, the other extensions are ext.disable_news_feed.php and ext.fresh_variables.php.
I’m not sure what version of EE it is, because this is a new client for me, but I’m guessing it’s up to date. I’ll post back when I know for sure.
You happened to catch me at the right time and I couldn’t resist as I got caught out like that when I first started with EE.
Hope it works out for you!