Skip to content

Commit de05272

Browse files
authored
Merge pull request #1827 from petterreinholdtsen/docs-relative-links
Use relative links to sibling documents in all adoc files
2 parents 9c74bf1 + 915538e commit de05272

3 files changed

Lines changed: 21 additions & 21 deletions

File tree

docs/src/gui/qtvcp-widgets.adoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1879,20 +1879,20 @@ Enter any of these case sensitive commands to load the respective
18791879
program or access the feature:
18801880

18811881
* `HALMETER` - Starts LinuxCNC utility
1882-
link:http://linuxcnc.org/docs/devel/html/hal/tools.html#_halmeter[`halmeter`]
1882+
link:../hal/tools.html#sec:halmeter[`halmeter`]
18831883
* `HALSHOW` - Starts LinuxCNC utility
1884-
link:http://linuxcnc.org/docs/devel/html/hal/halshow.html#cha:halshow[`halshow`]
1884+
link:../hal/halshow.html#cha:halshow[`halshow`]
18851885
* `HALSCOPE` - Starts LinuxCNC utility
1886-
link:http://linuxcnc.org/docs/devel/html/hal/tutorial.html#sec:tutorial-halscope[`halscope`]
1886+
link:../hal/tutorial.html#sec:tutorial-halscope[`halscope`]
18871887
* `STATUS` - Starts LinuxCNC utility
1888-
link:https://linuxcnc.org/docs//html/man/man1/linuxcnctop.1.html[`status`]
1888+
link:../man/man1/linuxcnctop.1.html[`status`]
18891889
* `CALIBRATION` - Starts LinuxCNC utility
1890-
link:http://linuxcnc.org/docs/devel/html/getting-started/updating-linuxcnc.html#_calibration_emccalib_tcl[`calibration`]
1890+
link:../getting-started/updating-linuxcnc.html#_calibration_emccalib_tcl[`calibration`]
18911891
* `CLASSICLADDER` - Starts the
1892-
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
1892+
link:../ladder/classic-ladder.html[ClassicLadder GUI] if the ClassicLadder realtime HAL component was loaded by the machine's config files
18931893
* `PREFERENCE` - Loads the preference file onto the gcodeEditor
18941894
* `CLEAR HISTORY` - Clears the MDI History
1895-
* `net` - See link:http://linuxcnc.org/docs/devel/html/man/man1/halcmd.1.html#COMMANDS[halcmd net COMMAND].
1895+
* `net` - See link:../man/man1/halcmd.1.html#COMMANDS[halcmd net COMMAND].
18961896
An error will result if the command is unsuccessful.
18971897
** _Syntax_: `net <signal name> <pin name>`
18981898
** __Example__: `net plasmac:jog-inhibit motion.jog-stop`

docs/src/integrator/wiring.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -271,7 +271,7 @@ pin and a single output pin. Its job is to monitor the input and to send an outp
271271
for a programmed delay period. More information can be found for the debounce component by visiting the following
272272
page:
273273

274-
http://linuxcnc.org/docs/html/man/man9/debounce.9.html
274+
link:../man/man9/debounce.9.html
275275

276276
== Documentation
277277

docs/src/plasma/qtplasmac.adoc

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ QtPlasmaC and all of its related software are released under GPLv2.
2020

2121
== Introduction
2222

23-
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.
23+
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.
2424

2525
The QtPlasmaC GUI supports up to five axes and uses the QtVCP infrastructure provided with LinuxCNC.
2626

@@ -55,7 +55,7 @@ It is possible to install and run LinuxCNC on a variety of Linux distributions h
5555

5656
=== If The User Does Not Have Linux Installed
5757

58-
Installation instructions are available at: http://linuxcnc.org/docs/devel/html/getting-started/getting-linuxcnc.html
58+
Installation instructions are available at: link:../getting-started/getting-linuxcnc.html
5959

6060
Following these instructions will yield a machine with the current stable branch (v2.8) of LinuxCNC on Debian Buster.
6161

@@ -72,7 +72,7 @@ deb-src http://buildbot.linuxcnc.org/ buster master-rtpreempt
7272

7373
=== Run In Place Installation If The User Has Linux with LinuxCNC v2.8
7474

75-
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
75+
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
7676

7777
Following these instructions will install the latest master branch (v2.9) of LinuxCNC.
7878

@@ -485,9 +485,9 @@ Each increment of delay adds one servo thread cycle to the debounce time. For ex
485485

486486
For the Float and Ohmic switches this equates to a 0.001mm (0.00004") increase in the probed height result.
487487

488-
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.
488+
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.
489489

490-
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.
490+
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.
491491

492492
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.
493493

@@ -721,7 +721,7 @@ DISPLAY = qtvcp qtplasmac (use 16:9 resolution)
721721
----
722722

723723
There are multiple QtVCP options that are described here:
724-
link:http://linuxcnc.org/docs/devel/html/gui/qtvcp.html#_ini_settings[QtVCP INI Settings]
724+
link:../gui/qtvcp.html#_ini_settings[QtVCP INI Settings]
725725

726726
For example the following would start a 16:9 resolution QtPlasmaC screen in full screen mode:
727727

@@ -1250,11 +1250,11 @@ To return any of the color changes to their default values, see the <<qt_default
12501250

12511251
Some standard LinuxCNC utilities are provided as an aid in the diagnosis of issues that may arise:
12521252

1253-
- link:http://linuxcnc.org/docs/devel/html/hal/halshow.html#cha:halshow[Halshow]
1254-
- link:http://linuxcnc.org/docs/devel/html/hal/tutorial.html#sec:tutorial-halscope[Halscope]
1255-
- link:http://linuxcnc.org/docs/devel/html/hal/tutorial.html#sec:tutorial-halmeter[Halmeter]
1256-
- link:http://linuxcnc.org/docs/devel/html/getting-started/updating-linuxcnc.html#_calibration_emccalib_tcl[Calibration]
1257-
- link:https://linuxcnc.org/docs//html/man/man1/linuxcnctop.1.html[Status]
1253+
- link:../hal/halshow.html#cha:halshow[Halshow]
1254+
- link:../hal/tutorial.html#sec:tutorial-halscope[Halscope]
1255+
- link:../hal/tutorial.html#sec:tutorial-halmeter[Halmeter]
1256+
- link:../getting-started/updating-linuxcnc.html#_calibration_emccalib_tcl[Calibration]
1257+
- link:../man/man1/linuxcnctop.1.html[Status]
12581258

12591259
In addition the following two QtPlasmaC specific utilities are provided:
12601260

@@ -1318,7 +1318,7 @@ Imperial:
13181318
G20 G40 G49 G64p0.004 G80 G90 G92.1 G94 G97
13191319
----
13201320

1321-
A detailed explanation of each G-Code can be found in the docs link:http://linuxcnc.org/docs/html/gcode/g-code.html[here].
1321+
A detailed explanation of each G-Code can be found in the docs link:../gcode/g-code.html[here].
13221322

13231323
Note that throughout this user guide there are several additional recommendations for codes that are prudent to add to both the preamble and postamble depending on the features the user wishes to utilize.
13241324

@@ -2493,7 +2493,7 @@ In order to utilize them, *KB Shortcuts* must be enabled in the *GUI SETTINGS* s
24932493
[[qt_mdi]]
24942494
=== MDI
24952495

2496-
In addition to the typical G and M codes that are allowed by LinuxCNC in MDI mode, the MDI in QtPlasmaC can be used to access several other handy features. The following link outlines the features and their use: link:http://linuxcnc.org/docs/devel/html/gui/qtvcp_widgets.html#_mdiline_widget[MDILine Widget]
2496+
In addition to the typical G and M codes that are allowed by LinuxCNC in MDI mode, the MDI in QtPlasmaC can be used to access several other handy features. The following link outlines the features and their use: link:../gui/qtvcp-widgets.html#_mdiline_widget[MDILine Widget]
24972497

24982498
[NOTE]
24992499
M3, M4, and M5 are not allowed in the QtPlasmaC MDI.

0 commit comments

Comments
 (0)