Technical writing: JavaScripts for your MadCap Flare project
Requirements
- It is recommended to watch the course on your laptop or PC. Some of the UI elements can be too small to easily see them on a phone or on a tablet.
Description
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.
Who this course is for:
- MadCap Flare users
Instructor
Yaroslava has been working as a tech writer for 5 years while her total professional experience in writing is over 13 years. She is a co-founder of the tech writing community in Ukraine, organizer of workshops, lecturer, and author of digests and articles on technical writing. Yaroslava works for a Danish company with a strong team of tech writers who had been working for Microsoft, Nokia, and other leading companies. Yaroslava took master's degrees in computer engineering (Kyiv, Ukraine) and social sciences (Tartu, Estonia).