
Explore three javascripts that extend MadCap Flare with add-ins, enabling formatted programming code, a copy-to-clipboard button, and live filtering for multi-version documentation across desktop, web, iOS, and Android.
Follow the course's three independent lessons in Udemy order, apply code formatting before copying to clipboard, read slide texts and callouts, and create a sample project using Links.docx.
Set clear expectations for advanced MadCap Flare users, outlining features like code formatting, copy to clipboard button, and live filtering that apply to the HTML5 target and standard skins.
Apply code formatting across code fragments with just a few mouse clicks, after configuring the language name. Deliver professional, fast, free documentation with excellent user experience for users.
Download prism.js and prism.css to enable code formatting with prism.js. Choose a theme, select the languages you need (JavaScript, Python, or all), and review the previewers and copy-to-clipboard plugins.
Create a 'JavaScripts' folder in the default Resources folder under Content and copy prism.js into it. Move prism.css to the Stylesheets folder under Resources and save changes.
Bind prism js and prism css to your MadCap Flare project by linking them through the master page and Styles.css. Enable local stylesheets on the HTML target.
Create templates guides you to configure language-specific templates using snippets for each programming language, like CSS, by embedding code in two Prism tags to group rows and define the language.
Apply code formatting by using Code-CSS snippets, convert to text, and edit in the text editor before saving.
Adjust the code formatting view by editing prism.css using an internal text editor, searching for border and shadow properties, and commenting changes to safely customize styles.
Apply Prism JS by defining the theme, uploading files to the project, and integrating them in master pages, main stylesheet, and HTML targets; create snippets for readable code.
Discover how the copy to clipboard feature saves readers time, and learn to add a copy to clipboard button in a MadCap Flare project.
Download the clipboard solution from zenorocha folder on github, extract the zip, and use clipboard.min.js for copy to clipboard. Then add the script to the madcap flare project under resources.
Bind prism.js on the master page (or in topics) to connect your Flare project to the javascript, then bind ClipboardJS to the btn class and save the changes.
Learn to add a copy to clipboard button in a MadCap Flare project by creating and using snippets, wiring the bottom element to a data clipboard action, and defining targets.
Explore how to define text to copy in a MadCap Flare project by grouping content with div selectors and target IDs, then prepare a copy button for easy reuse.
Learn to optimize content creation in MadCap Flare by recording macros, setting targets, and inserting markers to automate repetitive steps across projects, while configuring components once and importing projects.
Adjust the button view by resizing and styling borders and background color, and learn how to replace a regular button with an image, including uploading, resizing, and applying font settings.
Repeat steps to configure copied to clipboard functionality, download and upload a javascript file to your project, and introduce it into the monster page; then create snippets and tags.
Learn to implement live filtering in MadCap Flare with global and topic filters to tailor a guide or a single topic, and place controls on toolbars for interactive documentation.
Create a common guide for desktop and web applications, accounting for browser limitations that change features and user interface text, and implement two buttons desktop and web to display modification.
Create and customize two custom toolbar buttons, rename one as desktop, move them to the right pane, adjust size and tooltips, and insert JavaScript to bind desktop and web events.
Upload the JavaScript file to your MadCap Flare project, enabling download-to-desktop workflows and seamless uploading to external sites, and prepare for more sophisticated actions.
Adjust javascript to your MadCap Flare project by implementing a desktop and web switch, using local storage to remember the latest choice, and toggling content and button styles.
Create javascript classes to differentiate desktop and web documentation, defining them in the cfs file and applying conditions to tags; add selectors desktop and web for head, images, and lists.
Connect files by linking a separate life filtering style sheet to the main style sheet, reset target, and specify the path in the general tab to select local style sheets.
Learn to mark content in topics with classes and apply same tag to multiple text elements. Use a deep tag for broad coverage; apply the class to all selected tags.
Learn to configure a topic-like filter with JavaScript to hide or show graphs, using a GitHub solution and a topic toolbar proxy for interactive filtering.
Replace button text with icons by preparing size-appropriate images, expand background in the style tab, and select the image with accompanying JavaScript adjustments in MadCap Flare.
Create a new skill with custom buttons and a JavaScript file, define classes in style sheet, mark text with relevant classes, and connect key and target files to finalize documentation.
Expresses gratitude for watching and subscribing, invites questions via direct messages, and shares knowledge for easy implementation and amazing results in technical writing for your MadCap Flare project.
UPD: Please note that starting with MadCap Flare 2022 you can
insert code snippets, and
copy the code
by using the built-in MadCap Flare functionality. Read the "Code Snippets" article in the MadCap Flare's Online Help.
________________________________________
In the first lesson, I’ll show you how to create the formatting for the programming code. I have optimized this procedure as much as possible so that after the configuration, you’ll need to do only a few mouse clicks to apply the desired style to the programming code in your documentation.
In the second lesson, we’ll learn how to add a Copy to the clipboard button. Again, it will take just a few mouse clicks from you at the end to add the button. Usually, this feature is used to copy to clipboard excerpts of programming code, but I’ll show you the universal solution where users can copy to clipboard texts, images, and even tables.
I am most proud of the third lesson — the Live filtering feature. There I’ll show you a unique way to apply multiple modifications of the documentation to a MadCap Flare project. For example, modifications may refer to different versions of your company's product. To choose a needed modification, users just need to click a button, and they will see the relevant documentation. This functionality is really unique and you won’t find it anywhere else because this javascript was written by my husband and my colleague.
The names are registered trademarks of MadCap Software.