How to Add Tweet Button in WebHelp Classic OutputEdit online
It is possible to integrate Twitter into your WebHelp Classic output and the widget will appear in the footer section of your WebHelp page.
Using Oxygen XML Editor/Author
To add a Twitter™
Tweet widget to your WebHelp Classic output using a transformation scenario from
within Oxygen XML Editor/Author, follow this procedure:
- Go to the Tweet button generator page.
- Fill-in the displayed form. The Preview and code area displays the code that you will need.
- Copy the code snippet displayed in the Preview and code area
and paste it into a
divelement inside an XML file called tweet-button.xml. Make sure you follow these rules:- The file must be well-formed.
- The code for each
scriptelement must be included in an XML comment. - The start and end tags for the XML comment must be on a separate line.
<div id="twitter"> <a href="https://twitter.com/share" class="twitter-share-button">Tweet</a> <script> <!-- !function (d, s, id) { var js, fjs = d.getElementsByTagName(s)[0], p = /^http:/.test(d.location) ? 'http': 'https'; if (! d.getElementById(id)) { js = d.createElement(s); js.id = id; js.src = p + '://platform.twitter.com/widgets.js'; fjs.parentNode.insertBefore(js, fjs); } } (document, 'script', 'twitter-wjs'); --> </script> </div>
- In Oxygen XML Editor/Author, click the
Configure Transformation
Scenario(s) action from the toolbar. - Select an existing WebHelp Responsive transformation scenario (depending on your needs, it may be with or without feedback) and click the Duplicate button to open the Edit Scenario dialog box.
- Switch to the Parameters tab and edit the
webhelp.footer.fileparameter to reference the tweet-button.xml file that you created earlier. - Click Ok and run the transformation scenario.
Using a Script Outside of Oxygen XML Editor/Author
Important: Running WebHelp transformations from a script outside of Oxygen XML
Editor/Author requires an additional license and some additional setup:
- You must have a valid license for the Oxygen XML WebHelp Plugin (https://www.oxygenxml.com/buy_webhelp.html).
- The Oxygen XML WebHelp Plugin must be installed and integrated for the DITA Open Toolkit or a DocBook XSL Distribution.
To add a Twitter
Tweet widget to your WebHelp Classic output using a script outside of Oxygen
XML Editor/Author, follow this procedure:
- Go to the Tweet button generator page.
- Fill-in the displayed form. The Preview and code area displays the code that you will need.
- Copy the code snippet displayed in the Preview and code area
and paste it into a
divelement inside an XML file called tweet-button.xml. Make sure you follow these rules:- The file must be well-formed.
- The code for each
scriptelement must be included in an XML comment. - The start and end tags for the XML comment must be on a separate line.
<div id="twitter"> <a href="https://twitter.com/share" class="twitter-share-button">Tweet</a> <script> <!-- !function (d, s, id) { var js, fjs = d.getElementsByTagName(s)[0], p = /^http:/.test(d.location) ? 'http': 'https'; if (! d.getElementById(id)) { js = d.createElement(s); js.id = id; js.src = p + '://platform.twitter.com/widgets.js'; fjs.parentNode.insertBefore(js, fjs); } } (document, 'script', 'twitter-wjs'); --> </script> </div>
- Use the
webhelp.footer.fileparameter in your transformation script and set its value to reference the tweet-button.xml file that you created earlier. - Execute the transformation script.For example:
- Windows:
dita.bat -i c:\mySample.ditamap -f webhelp -Dwebhelp.footer.file=c:\tweet-button.xml - Mac OS X/ Linux:
dita -i /mySample.ditamap -f webhelp -Dwebhelp.footer.file=/tweet-button.xml
- Windows: