Page 1 of 2
OwnersManual
Posted: Sat Apr 02, 2011 6:41 am
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.
Re: New Module: OwnersManual
Posted: Sat Apr 02, 2011 8:09 am
by uniqu3
Great work Wishbone, going to try it out!
Re: New Module: OwnersManual
Posted: Sat Apr 02, 2011 9:59 am
by Reclus
Sounds like great idea, downloaded! Cheers!
Re: New Module: OwnersManual
Posted: Sat Apr 02, 2011 10:17 am
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.
Re: New Module: OwnersManual
Posted: Sat Apr 02, 2011 3:16 pm
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.
Re: New Module: OwnersManual
Posted: Sat Apr 02, 2011 3:20 pm
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.
Re: New Module: OwnersManual
Posted: Mon Apr 04, 2011 9:02 am
by Marijus
Great module 
Now I'll look forward to the next version 1.2
Thank you Wishbone
Re: New Module: OwnersManual
Posted: Mon Apr 04, 2011 11:04 am
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.
Re: New Module: OwnersManual
Posted: Mon Apr 04, 2011 2:33 pm
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.
Re: New Module: OwnersManual
Posted: Tue Apr 05, 2011 6:23 am
by Wishbone
Fixed in SVN... regular expression replace of all relative paths with absolute paths in <img/> tags.
Re: New Module: OwnersManual
Posted: Tue Apr 05, 2011 1:55 pm
by jd447
excellent!
but took me a while to localize it under the CMS menu. I'm not used to go over there!
looking fwd for the next version!
cheers,
Re: New Module: OwnersManual
Posted: Sun Apr 17, 2011 2:49 am
by frankmanl
Actually, I can't find it at all...
Please, where is it located?
[edit]
Oh, I found it:

[end edit]
Frank
Re: New Module: OwnersManual
Posted: Sun Apr 17, 2011 10:27 am
by M@rtijn
Fantastic little module!
Makes documentation so much easier
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.
Re: New Module: OwnersManual
Posted: Sun Apr 17, 2011 2:23 pm
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?
Re: New Module: OwnersManual
Posted: Tue Apr 19, 2011 3:54 am
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!)

Thanks! {{hugs}}