Checking local links

This article presents how to use the acceptLocalLinks property. This property can be set through the configuration file or on the command-line.

Overview

The acceptLocalLinks property specifies which kinds of local links which are defined outside the wiki are allowed:

• "none "or "false": specifies that all local links outside of the wiki are not allowed
• "relative": specifies that only relative local links outside of the wiki are allowed. Relative links will be considered relative to the output directory
• "all" or "true": specifies that all local links outside of the wiki are allowed

Example

For example, if you have the following structure:

      -- > myRef.html      
      wiki
      -- > index.html
      ---- > articles
      -------- > article1.html

and you have the following article:

   <article desc="article1">
   The <a href="myRef.html">reference</a>.
   </article>

The link is a relative link which point to the myRef.html file.

• By default, or if the acceptLocalLinks property is set to "none "or "false", the tool will emit an error
• If the acceptLocalLinks property is set to "relative": no error will be emitted
• If the acceptLocalLinks property is set to "all" or "true":: no error will be emitted