Adding my JavaScript to all Flare topics in WebHelp output

GJT · Post by **GJT** » Tue May 19, 2009 4:55 pm

I have a JavaScript file--let's say foo.js--that I want inserted in all WebHelp HTML files output like so:

<head><title>Foo Class</title>
        <link href="help.css" rel="stylesheet" />
        <script src="SkinSupport/MadCapUtilities.js">
        </script>
        <script src="SkinSupport/MadCapBody.js">
        </script>
        <script src="SkinSupport/MadCapHighlighter.js">
        </script>

<script src="foo.js">
        </script>
</head>

However, I cannot seem to figure out how this bit of code is generated, particularly the MadCap*.js files. The only reference to these files is in MadCap's own resource directory.

How can I modify the output generation / skin to insert my code? Copying the file to the Recource/WebHelp/Content directory is not really an option, as multiple users have Flare installed, and this script should be available for all their output generation as well.

GregStenhouse · Post by **GregStenhouse** » Tue May 19, 2009 7:28 pm

Copy the javascript file to your content directory, then reference the script by editing your master-page. If you want the script referenced in the <head> section you'll need to open the master page in a text editor and manually code it. Otherwise you can use the Flare UI to reference scripts (Insert>Script, Script Link) This will put the script in the <body> wherever your cursor was

Note that this will only be for your project only. To give everyone access, they'll need to manually copy the js file and master page over, or use global project linking

Cheers
Greg

GJT · Post by **GJT** » Wed May 20, 2009 12:59 pm

Thank you very much for the suggestion. I am definitely closer than when I was before.

However, I've noticed that when I add a "src" attribute to the script tag in the master page, the tag does not display. The JavaScript file does exist in the content directory.

Am I missing something else? I can get as far as <script type="text/javascript"></script>

in each file. I would prefer not to paste the code, and encompass it in a file.

Post by **LTinker68** » Wed May 20, 2009 3:04 pm

GJT wrote:However, I've noticed that when I add a "src" attribute to the script tag in the master page, the tag does not display.

Doesn't display where? It won't appear in the normal view of the XML Editor because the script isn't running, and there are no icons in Flare to display JavaScript markers like Dreamweaver and similar programs have. If you mean you won't see the output of the JavaScript code, then again, you won't see it in the XML Editor because it's not actually processing (running) the script. It might work in the Preview window; if not then you'll have to build the output to test it (delete the output folder before building so that it doesn't load the masterpage that's in the cache).

Also, if you're not including the JavaScript in the masterpage but are instead referencing it, then you wouldn't use the script tag that you wrote. I think that's the one you use if you're going to include the JS code directly in the topic. Instead, you'd need to add a reference to the JavaScript file, similar to the way stylesheet files are referenced in a topic.

GJT · Post by **GJT** » Wed May 20, 2009 4:37 pm

Thanks everyone for your help. I got the issue sorted out.

Long story short, we're using MadCap in conjunction with ant. I wasn't copying the file over correctly in build.xml . Instead, I was getting blank references to Resources/MasterPages/foo.js

MadCap Software Forums

Adding my JavaScript to all Flare topics in WebHelp output

Adding my JavaScript to all Flare topics in WebHelp output

Re: Adding my JavaScript to all Flare topics in WebHelp output

Re: Adding my JavaScript to all Flare topics in WebHelp output

Re: Adding my JavaScript to all Flare topics in WebHelp output

Re: Adding my JavaScript to all Flare topics in WebHelp output