OwnersManual

Have a question or a suggestion about a 3rd party addon module or plugin?
Let us know here.
Wishbone
Power Poster
Power Poster
Posts: 1368
Joined: Tue Dec 23, 2008 8:39 pm

OwnersManual

Post by Wishbone »

My first published module!

OwnersManual is a back-end content editor where you as the web developer can leave site-specific instructions for the client showing them how to operate the web page. Pages (how to paste, paragraphs vs new-lines, etc), calendar, blogs, which news category controls which sidebar element, whatever.

We often show users how to operate the site, spend some time on the phone, emails back-and-forth.. Now capture notes on the back-end. Editable by admins, read-only by other users.

Currently it's extremely simple.. A single page, optional Smarty processing, and the ability to change the name of the module in the menu, in case "Site Owner's Manual" doesn't fit the application you are using it for.

I plan on developing it further with client notes, multiple pages, page hierarchy, permissions-based content, etc.

Wiki page

Let me know what you think! All comments/suggestions welcome.
Last edited by Wishbone on Sat Apr 21, 2012 4:14 am, edited 1 time in total.
uniqu3

Re: New Module: OwnersManual

Post by uniqu3 »

Great work Wishbone, going to try it out!
Reclus
Forum Members
Forum Members
Posts: 16
Joined: Fri Dec 01, 2006 11:42 pm

Re: New Module: OwnersManual

Post by Reclus »

Sounds like great idea, downloaded! Cheers!
Decain
Forum Members
Forum Members
Posts: 15
Joined: Sun Dec 20, 2009 6:11 pm

Re: New Module: OwnersManual

Post by Decain »

Great! I think about videotutorials for create content, add photos and many more. Now I can write in Owners Manual links to videotutorials and no one will say that he lost e-mail with it. Thanks.
Wishbone
Power Poster
Power Poster
Posts: 1368
Joined: Tue Dec 23, 2008 8:39 pm

Re: New Module: OwnersManual

Post by Wishbone »

Decain wrote:Now I can write in Owners Manual links to videotutorials and no one will say that he lost e-mail with it. Thanks.
If you have TinyMCE configured properly, you can embed the videos directly in the manual.
Decain
Forum Members
Forum Members
Posts: 15
Joined: Sun Dec 20, 2009 6:11 pm

Re: New Module: OwnersManual

Post by Decain »

I don't know how many videos I make, but I think Screenr is good tool to do this. Thanks for the idea.
Marijus

Re: New Module: OwnersManual

Post by Marijus »

Great module :)
Now I'll look forward to the next version 1.2
Thank you Wishbone
Marijus

Re: New Module: OwnersManual

Post by Marijus »

How can I insert images from ulpoads folder?
I look at source code and saw that base href is admin folder so I need to put images into admin folder.
Wishbone
Power Poster
Power Poster
Posts: 1368
Joined: Tue Dec 23, 2008 8:39 pm

Re: New Module: OwnersManual

Post by Wishbone »

Hmm.. That's interesting. The image looks good in TinyMCE, but when you view the resulting page, it's trying to find it local to the admin directory. I might have to post-process the output and do a string replace of all image references to your uploads directory with the full path. Thanks for the catch.. I'll see what I can do.
Wishbone
Power Poster
Power Poster
Posts: 1368
Joined: Tue Dec 23, 2008 8:39 pm

Re: New Module: OwnersManual

Post by Wishbone »

Fixed in SVN... regular expression replace of all relative paths with absolute paths in <img/> tags.
User avatar
jd447
Forum Members
Forum Members
Posts: 134
Joined: Wed Jun 20, 2007 7:06 am

Re: New Module: OwnersManual

Post by jd447 »

excellent!

but took me a while to localize it under the CMS menu. I'm not used to go over there! ;D

looking fwd for the next version!

cheers,
User avatar
frankmanl
Power Poster
Power Poster
Posts: 425
Joined: Sat Jul 12, 2008 3:50 am

Re: New Module: OwnersManual

Post by frankmanl »

Actually, I can't find it at all...
Please, where is it located?

[edit]
Oh, I found it:
Image
[end edit]

Frank
User avatar
M@rtijn
Power Poster
Power Poster
Posts: 706
Joined: Sat Nov 14, 2009 4:54 pm

Re: New Module: OwnersManual

Post by M@rtijn »

Fantastic little module!

Makes documentation so much easier ;D

One thing I found, though:
Out-of-the-box the Owners Manual is filled with the module help, but when you remove this to put your own information in, you'll have to leave the div intact.
Otherwise you can't edit the manual anymore.
Make your community a better place!
Wishbone
Power Poster
Power Poster
Posts: 1368
Joined: Tue Dec 23, 2008 8:39 pm

Re: New Module: OwnersManual

Post by Wishbone »

Hmm.. I didn't realize that I had a div in there.. But when I remove the div, I see no issues. Can you explain further?
User avatar
pixelita
Power Poster
Power Poster
Posts: 388
Joined: Sun Sep 16, 2007 3:07 am

Re: New Module: OwnersManual

Post by pixelita »

Sweet mother of god. This is a prayer answered for all my non-techie clients. (Which is to say, all of my clients!) :D Thanks! {{hugs}}
Submit your site to the We Love CMSMS showcase
Post Reply

Return to “Modules/Add-Ons”