Automation MadCap Flare Technical communication

Automated QA: Checking for broken links in your Flare output – now also for HTTP links

Posted on Author msander Comments(5)

The CheckLinks tool now also finds broken http and https links in addition to finding broken local relative links.

The syntax for running the tool is, for example:

C:\> Checklinks2 "C:\OutputFolder" "C:\LogFolder"

For info about the existing tool, see http://techwritingengineer.com/automated-qa-checking-for-broken-links-in-your-flare-output/

msander

Related Articles
Excel MadCap Flare

Generate a MadCap Flare TOC from Excel using VBA

Posted on Author msander

When you are crafting a content specification table of contents, you might want to first  “brainstorm” a TOC using Excel, and then simply export the structure to Flare once you’re done. You can write a short VBA function that does the trick. The animated GIF shows how it works and here’s a spreadsheet for you to […]
Kanban Lean MadCap Flare Uncategorized

How to get started with Lean Thinking in Techcomm

Posted on Author msander

Do you want to know more about lean ideas, and how you can start implementing them using your favorite authoring tool? Keep reading! Lean principles These are some of the main principles in lean thinking: Define value from your customers’ perspective Map the value stream for each product that provides that value, and challenge all non-value-adding […]
Automation MadCap Flare Technical communication

Automated QA: Checking for broken links in your Flare output

Posted on Author msander

Do you use relative hyperlinks (<a href=”../../folder/folder/file.htm”>File</a>) in your Flare projects? Would you like to verify that they work in the output without checking manually? Keep reading! I’ve made a tool that scans all .htm files in the output and tests the relative links. The result is a .txt report that gives you a list of all […]

5 Replies to “Automated QA: Checking for broken links in your Flare output – now also for HTTP links”

  1. This sounds good. But when I run it nothing happens: no error message but no text file either.

    Any ideas what the problem might be?

    Reply

    1. Great, thanks. That works fine. It doesn’t like it if you leave trailing backslashes in the paths though. I get:

      Unhandled Exception: System.ArgumentException: Illegal characters in path.
      at System.IO.Path.CheckInvalidPathChars(String path, Boolean checkAdditional)
      at System.IO.Path.GetFileName(String path)
      at System.IO.StreamWriter.CreateFile(String path, Boolean append, Boolean checkHost)
      at System.IO.StreamWriter..ctor(String path, Boolean append, Encoding encoding, Int32 bufferSize, Boolean checkHost)
      at System.IO.File.InternalWriteAllText(String path, String contents, Encoding encoding, Boolean checkHost)
      at System.IO.File.WriteAllText(String path, String contents)
      at HREF_CHECKER.Module1.WriteLogFile(String logText, String logPath)
      at HREF_CHECKER.Module1.Main()

      Feature request: print some output on the command line – e.g.
      “x broken links found. See log file ”

      Thanks again. That’s a really useful little tool.

      Reply

      1. In my previous comment I used angle-bracketed text which disappeared on submit.
        After “See log file” add the path/name of the log file.

        Reply

Leave a Reply

Your email address will not be published. Required fields are marked *