ABC Internal Help Homepage

ABC Ignite Logo

Cell 3

Cell 1

Cell 2

Go Old School. Use GIFs to Spice It Up!

Remember when the iFrame was a dangerous "no-no" in communication and online documentation? Now, it's popular again. Even Microsoft embraces it in PowerBI. Almost everything users see in PowerBI is (Insights) is in an iFrame.

It's a similar situation with our old pal, GIF. It's incredibly useful as a quick, no audio, how-to clip that can really add some zest to software development release notes. :)

If you want to go all out, put GIFs in cards to razzle things a bit more! Who would've thought a simple GIF could bring a little ease, confidence, and enjoyment to users after all these years of also being a "simple-minded no-no."

Simple is better!

Tip! You can use Snagit to create them (record a video), Mimic and Capture, or Camtasia Studio. They all build GIFs out of video clips. No reference, but most applications alert you (or refuse to save) if the GIF is over 30 seconds. So, I try to keep mine less than that.

Here's an Insights example.

FAQs

GeneralExample3

Save Time With Flare Macros!

Revised: July 26, 2023

06:25:47 PM

You can create macros like the examples shown here. They sure can save some steps! We need to combine our macros (and the new ones we create) to complete some steps quicker.

macro example

If you would like, you can begin with my macros. I've saved the file in our network folder.

Reference: In an older version of Flare help (Notes section). https://help.madcapsoftware.com/flare2017r3/Content/Flare/Macros/About-Macros.htm

NOTE: Macros are saved to the AppData\Roaming\MadCap Software\Flare\Macros folder on your computer, so you can access them from any project you open on your computer.

If you want to share macros with other members of your team, you can send them the Macros file (in the Macros folder). If you have also added shortcuts that you want to share, you can send the Commands_3.mccmds file (in the AppData\Roaming\MadCap Software\Flare folder). They can add these files to their AppData folder to use your macros or shortcuts.

This is some content,

List of URLs

https://help.abcfitness.com/help/insights/inapp-insightshelptopics/dashboards/attritionanalysis.htm
https://help.abcfitness.com/help/insights/inapp-insightshelptopics/dashboards/revenueanalysisdashboard.htm
https://help.abcfitness.com/help/insights/inapp-insightshelptopics/dashboards/newjoins.htm
https://help.abcfitness.com/help/insights/inapp-insightshelptopics/dashboards/membercheckinanalysis.htm
https://help.abcfitness.com/help/insights/inapp-insightshelptopics/dashboards/classutilization.htm
https://help.abcfitness.com/help/insights/inapp-insightshelptopics/dashboards/posanalysis.htm
https://help.abcfitness.com/help/insights/inapp-insightshelptopics/dashboards/stateofbusiness.htm
https://help.abcfitness.com/help/insights/inapp-insightshelptopics/dashboards/dailysnapshot.htm
https://help.abcfitness.com/help/insights/inapp-insightshelptopics/dashboards/salespersons.htm
https://help.abcfitness.com/help/insights/inapp-insightshelptopics/dashboards/pastdueanalysis.htm
https://help.abcfitness.com/help/insights/inapp-insightshelptopics/dashboards/checkinalerts.htm

Cell 2 A little more .

Save Time With Flare Macros!

../../_introduction/macros-create.htm

How do I make a feedback mechanism?

Using Jira Issue Collectors in Flare Outputs

You can see this mechanism in action at the bottom of any topic page in this output.

Reference: MadCap Flare Blog. https://www.madcapsoftware.com/blog/feedback-mechanism-using-jira/

Using Jira Issue Collectors in Flare Outputs

../feedbackmechanism/userfeedbackmechanism-jira.htm

GeneralExample5

Let Users Resize Page Elements

Permitting users to resize objects on the page is easy. The examples below illustrate the CSS property, resize.

Don't forget, this is an example, and the JavaScript code is included in the source. You should remove it and include it as .js file for production use.

Below is a DIV example. Remember these tips:

The resize CSS property can be used on any HTML element.
Limit the resizing to horizontal, vertical, or both in the CSS. This example uses both.
Without using cookies or other type of local storage, the resize property is not persistent.

Try it! Resize Example

Use the Inside this div, you can include any content you'd like. Snippets, images, etc.

Copy

CSS for Resize Property

1
2
3
4
5
6
7
8
div.doct-resizeyourself
{
  resize: both;
  overflow: auto;
  border: solid 2px red;
  padding: 20px; 
  width: 300px;
}

References

Let Users Resize Page Elements

../iframesresizershotspots/resize-elements-ui.htm

What are Meta Tag Sets?

Generated Topic Description Meta Tag

A meta tag is a type of metadata that you can use in MadCap Flare files to make it easier to find, identify, and control information, whether it is in the source files or the output.

If you need or want to override the default description, you may. The default generated tag ensures that something is used as a value for the page description. This improves SEO.

The image below shows the meta tag value in Flare and how the transform looks in HTML output.

Remember, the DocTeam description meta tag is automatically applied to each topic associated to the target during the build process. Authors don't have to do anything!

meta data

References:

Generated Topic Description Meta Tag

../metatags/automaticmetadescription.htm

Can I add elements to Flare-generated elements?

Yes! Three places exist in Flare where you can add JavaScript or jQuery.

TemplatePage Files
Skin Files
Individual Topic Files

Reference:https://www.straygoat.co.uk/blog/using-javascript-and-jquery-scripts-in-madcap-flare

Does it matter where you add your script?

Yes, it does matter where you add scripts in Flare because the location of the script affects when the script runs.

If you add a script to a TemplatePage, it will run each time a new topic is loaded.
If you add a script to a topic file, it will run when the particular topic is loaded.
If you add a script to a skin file, it will run once, when the skin is first loaded.

Reference:https://www.straygoat.co.uk/blog/using-javascript-and-jquery-scripts-in-madcap-flare

GeneralExample1

Go Old School. Use GIFs to Spice It Up!

It's a similar situation with our old pal, GIF. It's incredibly useful as a quick, no audio, how-to clip that can really add some zest to software development release notes. :)

Simple is better!

Here's an Insights example.

Go Old School. Use GIFs to Spice It Up!

gifs.htm

How can I easily include videos in my help projects?

Videos

Videos are converted to static images in print-based output. Adobe says videos can be included in PDFs, but I've tried this and all attempts failed (as did the "inserting JavaScript" techniques" Adobe says works inside a PDF).

Tip! If you create a topic (or snippet) containing a video, you can specify the video (and additional content if needed) as micro content. Then you can set up a proxy similar to the FAQ or Promotion proxy.

Here is a sample video.

Videos

videos.htm

What is off canvas?

What is Off-Canvas?

Delete this text and replace it with your own content.

Off-canvas-wrap - Wraps entire page including what is hidden off-canvas. This prevents horizontal scroll bars.
Inner-wrap - Wraps your all you content and is animated when triggered. This wrapper allows the entire page to be moved over when the menu is revealed.
- Foundation
- Dot
- ZURB
- Com
- Slash
- Sites
Off-canvas-menu - This is where your menu contents go.
Exit-off-canvas - Allows body to be clicked to close the off canvas menu.

What is Off-Canvas?

../../besttips/togglespopupsoffcanvas/whatisoffcanvas.htm

Cell 1

asdf

Cell 3

ABC Ignite Icon

ABC Ignite Logo