From 915538e5ce89d3c0ea6c7e69b859a86e18582cce Mon Sep 17 00:00:00 2001 From: Petter Reinholdtsen Date: Tue, 12 Jul 2022 14:59:17 +0200 Subject: [PATCH] Use relative links to sibling adoc documents in all adoc files Bring files gui/qtvcp-widgets.adoc, integrator/wiring.adoc and docs/src/plasma/qtplasmac.adoc in line with the other .adoc links to sibling documents. Also fix incorrect references in qtvcp-widgets.html and qtplasmac.adoc, which were not checked when the links were to http(s) addresses. --- docs/src/gui/qtvcp-widgets.adoc | 14 +++++++------- docs/src/integrator/wiring.adoc | 2 +- docs/src/plasma/qtplasmac.adoc | 26 +++++++++++++------------- 3 files changed, 21 insertions(+), 21 deletions(-) diff --git a/docs/src/gui/qtvcp-widgets.adoc b/docs/src/gui/qtvcp-widgets.adoc index 36b505fe702..3aaf1c24577 100644 --- a/docs/src/gui/qtvcp-widgets.adoc +++ b/docs/src/gui/qtvcp-widgets.adoc @@ -1879,20 +1879,20 @@ Enter any of these case sensitive commands to load the respective program or access the feature: * `HALMETER` - Starts LinuxCNC utility - link:http://linuxcnc.org/docs/devel/html/hal/tools.html#_halmeter[`halmeter`] + link:../hal/tools.html#sec:halmeter[`halmeter`] * `HALSHOW` - Starts LinuxCNC utility - link:http://linuxcnc.org/docs/devel/html/hal/halshow.html#cha:halshow[`halshow`] + link:../hal/halshow.html#cha:halshow[`halshow`] * `HALSCOPE` - Starts LinuxCNC utility - link:http://linuxcnc.org/docs/devel/html/hal/tutorial.html#sec:tutorial-halscope[`halscope`] + link:../hal/tutorial.html#sec:tutorial-halscope[`halscope`] * `STATUS` - Starts LinuxCNC utility - link:https://linuxcnc.org/docs//html/man/man1/linuxcnctop.1.html[`status`] + link:../man/man1/linuxcnctop.1.html[`status`] * `CALIBRATION` - Starts LinuxCNC utility - link:http://linuxcnc.org/docs/devel/html/getting-started/updating-linuxcnc.html#_calibration_emccalib_tcl[`calibration`] + link:../getting-started/updating-linuxcnc.html#_calibration_emccalib_tcl[`calibration`] * `CLASSICLADDER` - Starts the - link:http://linuxcnc.org/docs/devel/html/ladder/classic-ladder.html[ClassicLadder GUI] if the ClassicLadder realtime HAL component was loaded by the machine's config files + link:../ladder/classic-ladder.html[ClassicLadder GUI] if the ClassicLadder realtime HAL component was loaded by the machine's config files * `PREFERENCE` - Loads the preference file onto the gcodeEditor * `CLEAR HISTORY` - Clears the MDI History -* `net` - See link:http://linuxcnc.org/docs/devel/html/man/man1/halcmd.1.html#COMMANDS[halcmd net COMMAND]. +* `net` - See link:../man/man1/halcmd.1.html#COMMANDS[halcmd net COMMAND]. An error will result if the command is unsuccessful. ** _Syntax_: `net ` ** __Example__: `net plasmac:jog-inhibit motion.jog-stop` diff --git a/docs/src/integrator/wiring.adoc b/docs/src/integrator/wiring.adoc index 60b39c184bb..83b3818f453 100644 --- a/docs/src/integrator/wiring.adoc +++ b/docs/src/integrator/wiring.adoc @@ -271,7 +271,7 @@ pin and a single output pin. Its job is to monitor the input and to send an outp for a programmed delay period. More information can be found for the debounce component by visiting the following page: -http://linuxcnc.org/docs/html/man/man9/debounce.9.html +link:../man/man9/debounce.9.html == Documentation diff --git a/docs/src/plasma/qtplasmac.adoc b/docs/src/plasma/qtplasmac.adoc index c2719524e91..262f02cb938 100644 --- a/docs/src/plasma/qtplasmac.adoc +++ b/docs/src/plasma/qtplasmac.adoc @@ -20,7 +20,7 @@ QtPlasmaC and all of its related software are released under GPLv2. == Introduction -QtPlasmaC is a GUI for plasma cutting which utilises the link:http://linuxcnc.org/docs/devel/html/man/man9/plasmac.9.html[plasmac component] for controlling a plasma table from LinuxCNC v2.9 or later using the Debian Buster or similar distribution. +QtPlasmaC is a GUI for plasma cutting which utilises the link:../man/man9/plasmac.9.html[plasmac component] for controlling a plasma table from LinuxCNC v2.9 or later using the Debian Buster or similar distribution. The QtPlasmaC GUI supports up to five axes and uses the QtVCP infrastructure provided with LinuxCNC. @@ -55,7 +55,7 @@ It is possible to install and run LinuxCNC on a variety of Linux distributions h === If The User Does Not Have Linux Installed -Installation instructions are available at: http://linuxcnc.org/docs/devel/html/getting-started/getting-linuxcnc.html +Installation instructions are available at: link:../getting-started/getting-linuxcnc.html Following these instructions will yield a machine with the current stable branch (v2.8) of LinuxCNC on Debian Buster. @@ -72,7 +72,7 @@ deb-src http://buildbot.linuxcnc.org/ buster master-rtpreempt === Run In Place Installation If The User Has Linux with LinuxCNC v2.8 -A run in place installation runs LinuxCNC from a locally compiled version usually located at ~/linuxcnc-dev, instructions for building a run in place installation are available at: http://linuxcnc.org/docs/master/html/code/building-linuxcnc.html +A run in place installation runs LinuxCNC from a locally compiled version usually located at ~/linuxcnc-dev, instructions for building a run in place installation are available at: link:../code/building-linuxcnc.html Following these instructions will install the latest master branch (v2.9) of LinuxCNC. @@ -485,9 +485,9 @@ Each increment of delay adds one servo thread cycle to the debounce time. For ex For the Float and Ohmic switches this equates to a 0.001mm (0.00004") increase in the probed height result. -It is recommended to keep the debounce values as low as possible while still achieving consistent results. Using link:http://linuxcnc.org/docs/2.8/html/hal/tutorial.html#_halscope[Halscope] to plot the inputs is a good way to establish the correct value. +It is recommended to keep the debounce values as low as possible while still achieving consistent results. Using link:../hal/tutorial.html#sec:tutorial-halscope[Halscope] to plot the inputs is a good way to establish the correct value. -For QtPlasmaC installations, debounce is achieved by using the HAL link:http://linuxcnc.org/docs/2.8/html/man/man9/dbounce.9.html[dbounce component] which is a later alternative to the original debounce component. This new version allows for the loading and naming of individual debounce instances and is compatible with Twopass HAL file processing. +For QtPlasmaC installations, debounce is achieved by using the HAL link:../man/man9/dbounce.9.html[dbounce component] which is a later alternative to the original debounce component. This new version allows for the loading and naming of individual debounce instances and is compatible with Twopass HAL file processing. All four signals above have an individual debounce component so the debounce periods can be catered individually to each input. Any changes made to these values in the custom.hal file will not be overwritten by later updates of QtPlasmaC. @@ -721,7 +721,7 @@ DISPLAY = qtvcp qtplasmac (use 16:9 resolution) ---- There are multiple QtVCP options that are described here: -link:http://linuxcnc.org/docs/devel/html/gui/qtvcp.html#_ini_settings[QtVCP INI Settings] +link:../gui/qtvcp.html#_ini_settings[QtVCP INI Settings] For example the following would start a 16:9 resolution QtPlasmaC screen in full screen mode: @@ -1250,11 +1250,11 @@ To return any of the color changes to their default values, see the <