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
Kanban Lean Productivity Technical communication Uncategorized

Keep it Lean – Become more productive and motivated

Posted on Author msander

This article was originally published in ISTC Communicator, Summer 2016. Lean started in the automotive industry with Toyota’s Production System, but the ideas and principles are universal, and can be applied to any industry. The idea of Lean is to maximize customer value while minimizing waste, thus creating more value for customers with fewer resources. […]
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 […]
Technical communication

The benefits of working with small batches

Posted on Author msander

I just read The Lean Startup by Eric Reis, and found that the Build – Measure – Learn cycle can easily be adopted in technical writing. The idea is to build (design, and write), then measure (SME reviews, editor comments), and learn from the data from the reviewers to build better topics in the next […]

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 *