Merge pull request #1334 from awwright/docs

docs: remove "file:" scheme from links

resources/docs/createpdf.sh

@@ -3,11 +3,22 @@
 # https://wkhtmltopdf.org/downloads.html
 #
 
+set -e
+
 WKHTMLTOPDF=$(which wkhtmltopdf)
 
-cd $1
+test -d "$1"
+cd "$1"
+test -f "index_pdf.html"
 
-$WKHTMLTOPDF --footer-center "Page [page]" --image-quality 100 --javascript-delay 1000 \
+$WKHTMLTOPDF \
+  --footer-center "Page [page]" \
+  --image-quality 100 \
+  --enable-external-links \
+  --enable-javascript \
+  --javascript-delay 1000 \
+  --enable-local-file-access \
+  --allow . \
   pdf_cover.html \
   index_pdf.html \
   concept.html \

resources/docs/html_en_EN/addeditfixtures.html

@@ -10,17 +10,17 @@
 <H1>Add/Edit Fixtures</H1>
 <P>
 The same dialog (with slight differences) is used for both adding new and
-editing the properties of existing <A HREF="file:concept.html#Fixtures">Fixtures</A>.
+editing the properties of existing <A HREF="concept.html#Fixtures">Fixtures</A>.
 </P>
 <P>
 <B>NOTE:</B> When editing an existing fixture, you can always choose a completely different
 fixture type to replace the previous one, but if their channels don't match
-each other exactly, any <A HREF="file:concept.html#Scene">Scene</A> functions you
+each other exactly, any <A HREF="concept.html#Scene">Scene</A> functions you
 may have created, will very probably do things that you don't want. Also, if
 the channel counts don't match, you might end up having fixtures with overlapping
 channels, which results also to unwanted behaviour.
-<A HREF="file:concept.html#RGBMatrix">RGB Matrix</A>, <A HREF="file:concept.html#EFX">EFX</A>,
-<A HREF="file:concept.html#Chaser">Chaser</A> and <A HREF="file:concept.html#Collection">Collection</A>
+<A HREF="concept.html#RGBMatrix">RGB Matrix</A>, <A HREF="concept.html#EFX">EFX</A>,
+<A HREF="concept.html#Chaser">Chaser</A> and <A HREF="concept.html#Collection">Collection</A>
 functions remain unaffected since they don't directly address specific channels, but are more
 dynamic in nature.
 </P>
@@ -47,7 +47,7 @@ <H3>Controls</H3>
   <TD>
    <UL>
     <LI>Name: The friendly name you wish to assign to the fixture</LI>
-    <LI>Mode: The <A HREF="file:concept.html#FixtureMode">mode</A> you have configured to the fixture</LI>
+    <LI>Mode: The <A HREF="concept.html#FixtureMode">mode</A> you have configured to the fixture</LI>
     <LI>Universe: The DMX universe where the newly-added fixture(s) are connected to</LI>
     <LI>Address: The address of the (first) fixture you are adding. If you are
     adding multiple fixtures, each consecutive fixture will be assigned an

resources/docs/html_en_EN/addrgbpanel.html

@@ -25,7 +25,7 @@ <H2>Panel creation</H2>
 displacement</li>
 </ul>
 Once a RGB panel is created, it is straight forward to go to the <a href="functionmanager.html">Function Manager</A>,
-create a new <A HREF="file:concept.html#RGBMatrix">RGB Matrix</A> and start using the panel
+create a new <A HREF="concept.html#RGBMatrix">RGB Matrix</A> and start using the panel
 very quickly.
 <br><br>
 Let's have a look at every option in this panel:

resources/docs/html_en_EN/addvcbuttonmatrix.html

@@ -10,8 +10,8 @@
 <H1>Add Button Matrix</H1>
 <P>
 When you want to create many buttons at the same time on the
-<A HREF="file:virtualconsole.html">Virtual Console</A>, you may do this by creating a
-<A HREF="file:vcbuttonmatrix.html">Button Matrix</A>, using the Add Button Matrix
+<A HREF="virtualconsole.html">Virtual Console</A>, you may do this by creating a
+<A HREF="vcbuttonmatrix.html">Button Matrix</A>, using the Add Button Matrix
 dialog.
 </P>
 
@@ -30,7 +30,7 @@ <H1>Add Button Matrix</H1>
    <IMG SRC="qrc:/edit_add.png">
   </TD>
   <TD>
-   Add <A HREF="file:concept.html#Function">Functions</A> to the list.
+   Add <A HREF="concept.html#Function">Functions</A> to the list.
   </TD>
  </TR>
  <TR>
@@ -64,8 +64,8 @@ <H1>Add Button Matrix</H1>
   </TD>
   <TD>
    <UL>
-    <LI>Normal: Place the buttons inside a <A HREF="file:vcframe.html">Normal Frame</A></LI>
-    <LI>Solo: Place the buttons inside a <A HREF="file:vcsoloframe.html">Solo Frame</A></LI>
+    <LI>Normal: Place the buttons inside a <A HREF="vcframe.html">Normal Frame</A></LI>
+    <LI>Solo: Place the buttons inside a <A HREF="vcsoloframe.html">Solo Frame</A></LI>
    </UL>
   </TD>
  </TR>

resources/docs/html_en_EN/audio-input-output.html

@@ -28,8 +28,8 @@ <H1>Audio Input/Output device selection</H1>
 to music or to record audio with a microphone.<br><br>
 If in your system there are additional audio cards (PCI or USB), it is possible
 to select them in this panel as the preferred QLC+ input or output device.<br>
-Basically an input device is used by <A HREF="file:audiotriggers.html">Virtual Console Audio Triggers</A>
-while an output device is used by <A HREF="file:concept.html#audio">audio functions</A>.<br><br>
+Basically an input device is used by <A HREF="audiotriggers.html">Virtual Console Audio Triggers</A>
+while an output device is used by <A HREF="concept.html#audio">audio functions</A>.<br><br>
 The selection of an audio input/output line should take immediate effect in QLC+. If not
 you are invited to restart QLC+ to allow a complete initialization of the internal audio engine.
 </P>

resources/docs/html_en_EN/audioeditor.html

@@ -10,7 +10,7 @@
 <H1>Audio Editor</H1>
 <P>
 The audio editor, as its name suggests, is used to edit
-<IMG SRC="qrc:/audio.png" align="absmiddle"> <A HREF="file:concept.html#Audio">Audio</A> functions.<br>
+<IMG SRC="qrc:/audio.png" align="absmiddle"> <A HREF="concept.html#Audio">Audio</A> functions.<br>
 It offers basic controls and shows information about the attached audio file.
 </P>
 
@@ -114,7 +114,7 @@ <H2>Controls</H2>
   </TD>
   <TD>
     Select a specific audio output device to be used to play the attached audio file.
-    This list is the same you can find in the <A HREF="file:audio-input-output.html">Audio Input/Output panel</A>
+    This list is the same you can find in the <A HREF="audio-input-output.html">Audio Input/Output panel</A>
   </TD>
  </TR>
 </TABLE>

resources/docs/html_en_EN/channelproperties.html

@@ -29,8 +29,8 @@ <H2>Channels properties</H2>
  </TR>
  <TR>
   <TD><B>Behaviour</B></TD>
-  <TD>Force the channel behaviour according to the <A HREF="file:concept.html#HTP">HTP</A> and
-      <A HREF="file:concept.html#LTP">LTP</A> rules. When changing the behaviour of a channel,
+  <TD>Force the channel behaviour according to the <A HREF="concept.html#HTP">HTP</A> and
+      <A HREF="concept.html#LTP">LTP</A> rules. When changing the behaviour of a channel,
       the dropdown list will highlight in red, showing evidence that the channels has been modified.<br>
       <b>Note: Use this functionality only if you know what you're doing and fully understand
       how HTP and LTP work</b>
@@ -40,7 +40,7 @@ <H2>Channels properties</H2>
   <TD><B>Modifier</B></TD>
   <TD>Channels modifiers are a powerful tool to modify the behaviour of a channel
       by acting at the end of the DMX value calculation, right before the
-      <A HREF="file:concept.html#GrandMaster">Grand Master</A> modification.<br>
+      <A HREF="concept.html#GrandMaster">Grand Master</A> modification.<br>
       By default all the channels will follow a linear rule, meaning that the original
       DMX value will be equal to the output DMX value. (0-0, 1-1, ... , 255-255)<br>
       When clicking on this button, the Channel Modifier Editor panel (described below) will be displayed.
@@ -59,7 +59,7 @@ <H2>Channel Modifier Editor</H2>
 
 <P>
 The channel modifier editor is presented like this:<br>
-<img src="file:../images/channelmodifier.png"></img>
+<img src="../images/channelmodifier.png"></img>
 <br><br>
 On the right side of the window, a list of available modifier templates is displayed.<br>
 Clicking on a template in the list, will show the curve preview on the left side of
@@ -80,7 +80,7 @@ <H2>Channel Modifier Editor</H2>
 as needed with the <IMG SRC="qrc:/edit_add.png"> and <IMG SRC="qrc:/edit_remove.png"> buttons.<br>
 When done, just click the <IMG SRC="qrc:/filesave.png"> button and your template will be saved
 in your user templates folder. Please refer to the
-<A HREF="file:questionsandanswers.html">Questions and Answers</A> page to locate this folder.
+<A HREF="questionsandanswers.html">Questions and Answers</A> page to locate this folder.
 </P>
 
 <H2>Channel Modifier Templates</H2>

resources/docs/html_en_EN/channelsgroupeditor.html

@@ -11,7 +11,7 @@ <H1>Channel Groups Editor</H1>
 
 <P>
 The Channel Groups editor it activated by clicking on the "Channels Groups" tab in
-the <A HREF="file:fixturemanager.html">Fixture Manager</A> panel.<br>
+the <A HREF="fixturemanager.html">Fixture Manager</A> panel.<br>
 With this functionality (introduced in QLC+ version 4.0.0), it is possible to create
 groups of channels with the same functionality.<br>
 For example, if you have 20 PARs you might want to control the RED channel of all

resources/docs/html_en_EN/chasereditor.html

@@ -10,7 +10,7 @@
 <H1>Chaser Editor</H1>
 <P>
 The chaser editor, as its name suggests, is used to edit
-<IMG SRC="qrc:/chaser.png" align="absmiddle"> <A HREF="file:concept.html#Chaser">Chaser</A> functions.<br>
+<IMG SRC="qrc:/chaser.png" align="absmiddle"> <A HREF="concept.html#Chaser">Chaser</A> functions.<br>
 A Chaser is composed by steps and each step is represented by
 <ul>
  <li>A progressive number</li>
@@ -75,8 +75,8 @@ <H3>Controls</H3>
  <TR>
   <TD><IMG SRC="qrc:/edit_add.png"></TD>
   <TD>
-   Add an existing <A HREF="file:concept.html#Functions">Function</A> to the chaser,
-   using the <A HREF="file:selectfunction.html">Select Function</A> dialog. The
+   Add an existing <A HREF="concept.html#Functions">Function</A> to the chaser,
+   using the <A HREF="selectfunction.html">Select Function</A> dialog. The
    function are inserted after the currently selected step.
   </TD>
  </TR>

resources/docs/html_en_EN/collectioneditor.html

@@ -10,7 +10,7 @@
 <H1>Collection Editor</H1>
 <P>
 The collection editor, as its name suggests, is used to edit
-<IMG SRC="qrc:/collection.png" align="absmiddle"> <A HREF="file:concept.html#Collection">Collection</A> functions.<br>
+<IMG SRC="qrc:/collection.png" align="absmiddle"> <A HREF="concept.html#Collection">Collection</A> functions.<br>
 Collections are very helpful in a workflow where you create QLC+ functions dedicated to specific areas of
 your show. For example, you can create a number of Scenes to control only colors, some other Scenes to
 control only positions and so on. Then you can create a number of Chasers and EFX for automations.<br>
@@ -48,8 +48,8 @@ <H3>Controls</H3>
    <IMG SRC="qrc:/edit_add.png">
   </TD>
   <TD>
-   Add an existing <A HREF="file:concept.html#Functions">Function</A> to the
-   collection, using the <A HREF="file:selectfunction.html">Select Function</A>
+   Add an existing <A HREF="concept.html#Functions">Function</A> to the
+   collection, using the <A HREF="selectfunction.html">Select Function</A>
    dialog. The order of the functions has no significance.
   </TD>
  </TR>

resources/docs/html_en_EN/commandlineparameters.html

@@ -23,7 +23,7 @@ <H1>Command-Line Parameters</H1>
   like "C:\QLC+\qlcplus.exe". There you can add command line parameters. When done click OK.<BR>
   <BR>
   Example: Setting Czech locale:<BR>
-  <IMG SRC="file:../images/locale.png">
+  <IMG SRC="../images/locale.png">
  </LI>
  <LI><B>OSX</B>: This is the most difficult case since QLC+ on OSX is bundled into a
   DMG package. You need to open a terminal and "cd" into the QLC+ DMG like this:<BR>
@@ -120,7 +120,7 @@ <H2>-g or --log</H2>
 
    <P>
     <B>Examples:</B><BR>
-    Enable debug messages and store them to log file:<BR>
+    Enable debug messages and store them to log <BR>
     qlcplus -d 0 -g<BR>
     qlcplus --debug 0 --log<BR>
    </P>
@@ -151,7 +151,7 @@ <H2>-h or --help</H2>
   <TD STYLE="background-color: #ffffff;">
    <H2>-k or --kiosk</H2>
    <P>
-    <B>Description:</B> Enable kiosk-mode (only <A HREF="file:virtualconsole.html">virtual console</A> is visible and the application is locked in <A HREF="file:concept.html#Modes">operate mode</A>)
+    <B>Description:</B> Enable kiosk-mode (only <A HREF="virtualconsole.html">virtual console</A> is visible and the application is locked in <A HREF="concept.html#Modes">operate mode</A>)
    </P>
 
    <P>
@@ -252,7 +252,7 @@ <H2>-o or --open</H2>
   <TD STYLE="background-color: #eeeeee;">
    <H2>-p or --operate</H2>
    <P>
-    <B>Description:</B> Start the application in <A HREF="file:concept.html#Modes">Operate</A> mode.
+    <B>Description:</B> Start the application in <A HREF="concept.html#Modes">Operate</A> mode.
    </P>
 
    <P>

resources/docs/html_en_EN/concept.html

@@ -28,7 +28,7 @@ <H3 id="Audio"><IMG SRC="qrc:/audio.png"> Audio</H3>
 QLC+ supports the most common audio formats like Wave, MP3, M4A, Ogg and Flac. It supports
 mono or stereo channels and several sample rates like 44.1KHz, 48KHz, etc...<br>
 Audio functions can be placed in <A HREF="#Chaser">Chaser</A> or in a <A HREF="#Show">Show</A> at the desired time,
-using the <A HREF="file:showmanager.html">Show Manager</A> panel.<br>
+using the <A HREF="showmanager.html">Show Manager</A> panel.<br>
 Like most of the QLC+ functions, Audio supports fade in and fade out times.<br>
 </P>
 
@@ -60,8 +60,8 @@ <H3 id="Capabilities">Capabilities</H3>
 
 <H3 id="Channelgroups">Channel Groups</H3>
 <P>
-Channel groups can be added and defined in the <A HREF="file:fixturemanager.html">Fixture Manager</A>
-panel by using the <A HREF="file:channelsgroupeditor.html">Channel groups editor</A>.<br>
+Channel groups can be added and defined in the <A HREF="fixturemanager.html">Fixture Manager</A>
+panel by using the <A HREF="channelsgroupeditor.html">Channel groups editor</A>.<br>
 Channel groups can have a user defined name and can group together any user defined channels
 selected from an existing Fixtures list.
 </P>
@@ -92,7 +92,7 @@ <H3 id="Chaser"><IMG SRC="qrc:/chaser.png"> Chaser</H3>
 </P>
 
 <P>
-Copies of chaser functions can be created with the <A HREF="file:functionmanager.html">
+Copies of chaser functions can be created with the <A HREF="functionmanager.html">
 Function Manager</A>. The scenes inside a chaser are not duplicated when a chaser
 is copied. Only the order and direction are copied to the new one.
 </P>
@@ -126,7 +126,7 @@ <H3 id="Collection"><IMG SRC="qrc:/collection.png"> Collection</H3>
 </P>
 
 <P>
-Copies of collection functions can be created with the <A HREF="file:functionmanager.html">
+Copies of collection functions can be created with the <A HREF="functionmanager.html">
 Function Manager</A>. The functions contained in a collection are not duplicated; only the
 list of functions is copied.
 </P>
@@ -344,8 +344,8 @@ <H3 id="InputOutputPlugins"><IMG SRC="qrc:/input_output.png"> Input/Output plugi
 <P>
 QLC+ supports a variety of plugins to send and receive data from/to the external world.<br>
 A plugin can be an interface to physical devices (such as DMX adapters or MIDI controllers) or
-to a network protocol (such as <A HREF="file:artnetplugin.html">ArtNet</A>,
-<A HREF="file:oscplugin.html">OSC</A> or <A HREF="file:e131plugin.html">E1.31</A>).<br>
+to a network protocol (such as <A HREF="artnetplugin.html">ArtNet</A>,
+<A HREF="oscplugin.html">OSC</A> or <A HREF="e131plugin.html">E1.31</A>).<br>
 Plugins support input, output or feedback capabilities depending on the device or the protocol they're
 controlling.<BR>
 </P>
@@ -439,7 +439,7 @@ <H3 id="RGBScript"><IMG SRC="qrc:/rgbmatrix.png"> RGB Script</H3>
 <P>
 A RGB script is a program written in <A HREF="https://en.wikipedia.org/wiki/ECMAScript">ECMAScript</A>
 (also known as JavaScript) that produces the necessary image data for <A HREF="#RGBMatrix">RGB Matrix</A>
-functions. Learn more from the <A HREF="file:rgbscriptapi.html">RGB Script API</A> page.
+functions. Learn more from the <A HREF="rgbscriptapi.html">RGB Script API</A> page.
 </P>
 
 <H3 id="Scene"><IMG SRC="qrc:/scene.png"> Scene</H3>
@@ -457,7 +457,7 @@ <H3 id="Scene"><IMG SRC="qrc:/scene.png"> Scene</H3>
 </P>
 
 <P>
-Copies of scene functions can be created with the <A HREF="file:functionmanager.html">
+Copies of scene functions can be created with the <A HREF="functionmanager.html">
 Function Manager</A>. All of the scene's contents are copied to the duplicate.
 </P>
 
@@ -469,23 +469,23 @@ <H3 id="Sequence"><IMG SRC="qrc:/sequence.png"> Sequence</H3>
 Sequence can only control the enabled channels of that Scene.<br>
 When creating new steps in a Sequence, no Function selection pop-up will appear, since a Sequence
 step cannot include other Functions, unlike a Chaser step.<br>
-When a Sequence is created, a special sequence icon will appear in the <A HREF="file:functionmanager.html">Function Manager</A>
+When a Sequence is created, a special sequence icon will appear in the <A HREF="functionmanager.html">Function Manager</A>
 as a child of the Scene to which it is bound.<br>
 To understand the difference between a Sequence and a Chaser, you are invited to read the second paragraph
-of the <A HREF="file:showmanager.html">Show Manager</A> documentation.
+of the <A HREF="showmanager.html">Show Manager</A> documentation.
 </P>
 
 <H3 id="Script"><IMG SRC="qrc:/script.png"> Script</H3>
 <P>
 The Script <A HREF="#Functions">function</A> works on a simple yet powerful scripting language to automate
-QLC+ functionalities in a sequential order. A Script can be modified with the  <A HREF="file:scripteditor.html">Script Editor</A>.
+QLC+ functionalities in a sequential order. A Script can be modified with the  <A HREF="scripteditor.html">Script Editor</A>.
 </P>
 
 <H3 id="Show"><IMG SRC="qrc:/show.png"> Show</H3>
 <P>
 A Show is an advanced <A HREF="#Functions">function</A> which encapsulates most of the QLC+ Functions to create
-a time driven light show. A Show can be created only with the <A HREF="file:showmanager.html">Show Manager</A> and can be inspected and renamed with the
-<A HREF="file:showeditor.html">Show Editor</A>.
+a time driven light show. A Show can be created only with the <A HREF="showmanager.html">Show Manager</A> and can be inspected and renamed with the
+<A HREF="showeditor.html">Show Editor</A>.
 </P>
 
 <H3 id="Video"><IMG SRC="qrc:/video.png"> Video</H3>
@@ -495,7 +495,7 @@ <H3 id="Video"><IMG SRC="qrc:/video.png"> Video</H3>
 The supported video formats depends on your Operating System. For example Mac OSX is limited to MOV/MP4 files and
 not much more.<br>
 Video functions can be placed in <A HREF="#Chaser">Chaser</A> or in a <A HREF="#Show">Show</A> at the desired time,
-using the <A HREF="file:showmanager.html">Show Manager</A> panel.<br>
+using the <A HREF="showmanager.html">Show Manager</A> panel.<br>
 </P>
 
 </BODY>

resources/docs/html_en_EN/dmxdump.html

@@ -12,10 +12,10 @@ <H1><img src="qrc:/add_dump.png" width=32> DMX Dump</H1>
 <P>
 The DMX Dump functionality allows you to save the current DMX values that are being sent to the output universes
 at a particular moment. Basically it takes a "snapshot" of DMX channels and saves them for a later use.<br>
-DMX Dump can save values to a new <A HREF="file:concept.html#Scene">Scene</A> or overwite the values of an existing
+DMX Dump can save values to a new <A HREF="concept.html#Scene">Scene</A> or overwite the values of an existing
 Scene. The "dumped" Scene can also be added to an existing
-<A HREF="file:concept.html#Chaser">Chaser</A>, Virtual Console <A HREF="file:vcbutton.html">button</A>
-or <A HREF="file:vcslider.html">slider</A><br><br>
+<A HREF="concept.html#Chaser">Chaser</A>, Virtual Console <A HREF="vcbutton.html">button</A>
+or <A HREF="vcslider.html">slider</A><br><br>
 
 Please note that:
 <ul>
@@ -74,8 +74,8 @@ <H1><img src="qrc:/add_dump.png" width=32> DMX Dump</H1>
    <UL>
     <LI><B>Chaser</B>: The list contains all the chasers present when DMX Dump window is opened. Each Chaser
      has a checkbox that, if checked, will tell QLC+ to add the newly created Scene to the selected chasers.<br>
-     This feature is very useful when using <A HREF="file:vccuelist.html">Cue Lists</A> in the
-     <A HREF="file:virtualconsole.html">Virtual Console</A> panel, because the newly created Scene will appear
+     This feature is very useful when using <A HREF="vccuelist.html">Cue Lists</A> in the
+     <A HREF="virtualconsole.html">Virtual Console</A> panel, because the newly created Scene will appear
      in the Cue List for immediate use during a live performance.
     </LI>
     <br>