In-line Editing in Web Help?

Please post all questions and comments regarding Help & Manual 7 here.

Moderators: Alexander Halser, Tim Green

In-line Editing in Web Help?

Unread postby Lindsay Colahan » Tue Nov 14, 2017 12:27 am

Hello,

Has anyone been able to get in-line editing to work with Help & Manual web help output, either using code in a project file or a skin? I am just having a fantasy right now that involves me being able to publish a separate version of my web help for my SMEs to edit and review....
Lindsay Colahan
 
Posts: 3
Joined: Thu Aug 07, 2014 9:54 pm

Re: In-line Editing in Web Help?

Unread postby Martin Wynne » Tue Nov 14, 2017 1:08 am

Lindsay Colahan wrote:Has anyone been able to get in-line editing to work with Help & Manual web help output, either using code in a project file or a skin? I am just having a fantasy right now that involves me being able to publish a separate version of my web help for my SMEs to edit and review....

Hi Lindsay,

They would need a copy of H&M, or access to one, in order edit your project directly.

However, if you add an additional div wrapper to your HTML page template like this:

Code: Select all
<div contenteditable="true">
<%TOPIC_TEXT%>
</div>

they would be able to edit the Webhelp pages directly in their browser.

You could agree a marker such as "###" to indicate where they have modified the content, or made notes. They would then do File > Save As... to save the page as an HTML file and return it to you. You then search for the ### markers, and update your project accordingly.

Alternatively you could use a diff tool such as WinMerge (free) to find their changes. This avoids any problems if they forget to add the marker and you don't notice their change.

Remember to remove the div lines before publishing the final version.

If you want to go to town, you could add some additional scripting to capture say CTRL+B keys, and add say style bold to the currently selected content. Or whatever you want. In some browsers you can use

Code: Select all
document.designMode = "on";

to provide more editing options. I can post some sample code if you wish.

regards,

Martin.
User avatar
Martin Wynne
 
Posts: 2232
Joined: Mon May 12, 2003 3:21 pm
Location: West of the Severn, UK

Re: In-line Editing in Web Help?

Unread postby Lindsay Colahan » Tue Nov 14, 2017 6:17 am

Hello Martin,

If you could provide some more sample code for some of the things your mentioning, that would be amazing. We are a small organization and only have a limited number of H & M licenses. However, we have a huge number of SMEs, so there are often issues with this.

Would I add the div wrapper to the skin? Or is it another html page template that you are referring to?

Lindsay
Lindsay Colahan
 
Posts: 3
Joined: Thu Aug 07, 2014 9:54 pm

Re: In-line Editing in Web Help?

Unread postby Martin Wynne » Tue Nov 14, 2017 7:48 am

Lindsay Colahan wrote:Would I add the div wrapper to the skin? Or is it another html page template that you are referring to?

Hi Lindsay,

That goes in the skin if you are using one. I will post some more code examples later today.

regards,

Martin.
User avatar
Martin Wynne
 
Posts: 2232
Joined: Mon May 12, 2003 3:21 pm
Location: West of the Severn, UK


Return to Help & Manual 7 Forum

Who is online

Users browsing this forum: No registered users and 1 guest