Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/src/Master_Developer.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

== Introduction

image::common/images/emc2-intro.png[]
image::common/images/emc2-intro.png[pdfwidth=25%]

include::common/overleaf.adoc[]

Expand Down
2 changes: 1 addition & 1 deletion docs/src/Master_Getting_Started.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The LinuxCNC Team

:leveloffset: 1

image::common/images/emc2-intro.png[]
image::common/images/emc2-intro.png[pdfwidth=25%]

include::common/overleaf.adoc[]

Expand Down
3 changes: 2 additions & 1 deletion docs/src/Submakefile
Original file line number Diff line number Diff line change
Expand Up @@ -766,7 +766,8 @@ objects/LinuxCNC_Manual_Pages.adoc: objects/var-PDF_MAN_ORDER $(MAN_SRCS) $(DOC_
echo ":doctype: book"; \
echo ":source-highlighter: rouge"; \
echo ":toc:"; \
echo ":numbered:"; \
echo ":outlinelevels: 1"; \
Comment thread
hansu marked this conversation as resolved.
echo ":toclevels: 1"; \
echo; \
for M in $(PDF_MAN_ORDER); do \
if [ -r "$(DOC_SRCDIR)/man/$$M.adoc" ]; then \
Expand Down
14 changes: 7 additions & 7 deletions docs/src/code/code-notes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ document, both from the design point of view and from the developers
point of view (where to find needed data, how to easily extend/modify
things, etc.).

image::LinuxCNC-block-diagram-small.png[align="center"]
image::LinuxCNC-block-diagram-small.png[align="center",pdfwidth=100%]

=== LinuxCNC software architecture

Expand Down Expand Up @@ -151,7 +151,7 @@ or command line options. Custom modules must implement all
functions used by the default modules. The halcompile utility
can be used to create a custom module.

image::LinuxCNC-motion-controller-small.png[align="center"]
image::LinuxCNC-motion-controller-small.png[align="center",pdfwidth=100%]

== Block diagrams and Data Flow

Expand All @@ -164,7 +164,7 @@ visible in the block diagram, such as coarse_pos, pos_cmd, and
motor_pos_fb.

.Joint Controller Block Diagram
image::emc2-motion-joint-controller-block-diag.png[align="center"]
image::emc2-motion-joint-controller-block-diag.png[align="center",pdfwidth=100%]

The above figure shows five of the
seven sets of position information that form the main data flow through
Expand Down Expand Up @@ -218,11 +218,11 @@ the motion controller. The seven forms of position data are as follows:

=== Homing state diagram

image::homing.svg[align="center"]
image::homing.svg[align="center",pdfwidth=100%]

=== Another homing diagram

image::hss.svg[align="center"]
image::hss.svg[align="center",pdfwidth=60%]

== Commands

Expand Down Expand Up @@ -749,7 +749,7 @@ FIXME Backlash and Screw Error Compensation
Task has three possible internal states: *E-stop*, *E-stop Reset*,
and *Machine On*.

image::task-state-transitions.svg[align="center"]
image::task-state-transitions.svg[align="center",pdfwidth=45%]

== IO controller (EMCIO)

Expand Down Expand Up @@ -859,7 +859,7 @@ use and allow for the message to be encoded if this option is chosen
(encoded data will be covered later). The following figure is an
internal view of the buffer space.

image::CMS_buffer.png[align="center"]
image::CMS_buffer.png[align="center",pdfwidth=35%]

.CMS buffer
The CMS base class is primarily responsible for creating the
Expand Down
9 changes: 9 additions & 0 deletions docs/src/extensions/image_resolver.rb
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,7 @@ def rewrite(node)
if abs
node.set_attr('target', pdf ? abs : swapped)
apply_default_width(node) if pdf
apply_default_alignment(node) if pdf
return
end
end
Expand All @@ -112,6 +113,7 @@ def rewrite(node)
return unless abs
node.set_attr('target', abs)
apply_default_width(node)
apply_default_alignment(node) if pdf
end

# Rewrite an `*_en.<ext>` filename to `*_<lang>.<ext>`. The check
Expand Down Expand Up @@ -207,6 +209,13 @@ def apply_default_width(node)
return if node.attr('width')
node.set_attr('pdfwidth', '75%')
end

# center images by default if no alignmen is given
def apply_default_alignment(node)
return if node.context == :inline_image
return if node.attr('align')
node.set_attr('align', 'center')
end

def resolve_extension(path)
return path if File.file?(path)
Expand Down
2 changes: 1 addition & 1 deletion docs/src/getting-started/about-linuxcnc.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ LinuxCNC expects G-code that if not entered manually is provided by another soft
== Architecture - Context diagram

.Roles of operators, integrators, developers and hardware
image::images/LCNC_Architecture_C1.drawio.svg["LinuxCNC Architecture - Context diagram",align="center"]
image::images/LCNC_Architecture_C1.drawio.svg["LinuxCNC Architecture - Context diagram",align="center",pdfwidth=100%]

The diagram presents the components and players of the LinuxCNC ecosystem and how they interact. It is not intended to help you understand the functionality of LinuxCNC. Please refer to the following chapters for this.

Expand Down
32 changes: 16 additions & 16 deletions docs/src/index.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@

<h3>Getting Started &amp; Configuration</h3>

<details open="open">
<details>
<summary>Getting Started with LinuxCNC</summary>
<div class="details-list">
<ul>
Expand All @@ -59,7 +59,7 @@
</div>
</details>

<details open="open">
<details>
<summary>General User Information</summary>
<div class="details-list">
<ul>
Expand All @@ -74,7 +74,7 @@
</div>
</details>

<details open="open">
<details>
<summary>Configuration Wizards</summary>
<div class="details-list">
<ul>
Expand All @@ -84,7 +84,7 @@
</div>
</details>

<details open="open">
<details>
<summary>Configuration</summary>
<div class="details-list">
<ul>
Expand All @@ -102,7 +102,7 @@
</div>
</details>

<details open="open">
<details>
<summary>HAL (Hardware Abstraction Layer)</summary>
<div class="details-list">
<ul>
Expand All @@ -125,7 +125,7 @@
</div>
</details>

<details open="open">
<details>
<summary>Hardware Drivers</summary>
<div class="details-list">
<ul>
Expand All @@ -151,7 +151,7 @@
</div>
</details>

<details open="open">
<details>
<summary>Hardware Examples</summary>
<div class="details-list">
<ul>
Expand All @@ -163,7 +163,7 @@
</div>
</details>

<details open="open">
<details>
<summary>ClassicLadder</summary>
<div class="details-list">

Expand All @@ -176,7 +176,7 @@
</div>
</details>

<details open="open">
<details>
<summary>Advanced Topics</summary>
<div class="details-list">
<ul>
Expand All @@ -194,7 +194,7 @@
</div>
</details>

<details open="open">
<details>
<summary>Integrator Information</summary>
<div class="details-list">
<ul>
Expand All @@ -207,7 +207,7 @@

<h3>Usage</h3>

<details open="open">
<details>
<summary>User Interfaces</summary>
<div class="details-list">
<ul>
Expand All @@ -224,7 +224,7 @@
</div>
</details>

<details open="open">
<details>
<summary>G-code Programming</summary>
<div class="details-list">
<ul>
Expand All @@ -245,7 +245,7 @@

<h3>Customization &amp; Development</h3>

<details open="open">
<details>
<summary>Virtual Control Panels</summary>
<div class="details-list">
<ul>
Expand All @@ -266,7 +266,7 @@
</div>
</details>

<details open="open">
<details>
<summary>User Interface Programming</summary>
<div class="details-list">
<ul>
Expand All @@ -280,7 +280,7 @@
</details>


<details open="open">
<details>
<summary>Developer Information</summary>
<div class="details-list">
<ul>
Expand All @@ -299,7 +299,7 @@

<h3>General Information</h3>

<details open="open">
<details>
<summary>Glossary, Copyright, History &amp; Overview</summary>
<div class="details-list">
<ul>
Expand Down
16 changes: 8 additions & 8 deletions docs/src/lathe/lathe-user.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -70,18 +70,18 @@ In AXIS the following figures show what the Tool Positions look like, as entered
(((Tool Positions 1, 2, 3 & 4)))
[[fig:Outil-Positions-1-2-3-4]]
.Tool Positions 1, 2, 3 & 4
image:images/tool-pos-1_en.svg["Tool Position 1"]
image:images/tool-pos-2_en.svg["Tool Position 2"]
image:images/tool-pos-3_en.svg["Tool Position 3"]
image:images/tool-pos-4_en.svg["Tool Position 4"]
image:images/tool-pos-1_en.svg["Tool Position 1", align=left, pdfwidth=24%]
image:images/tool-pos-2_en.svg["Tool Position 2", align=left, pdfwidth=24%]
image:images/tool-pos-3_en.svg["Tool Position 3", align=left, pdfwidth=24%]
image:images/tool-pos-4_en.svg["Tool Position 4", align=left, pdfwidth=24%]

(((Tool Positions 5, 6, 7 & 8)))
[[fig:Outil-Positions-5-6-7-8]]
.Tool Positions 5, 6, 7 & 8
image:images/tool-pos-5_en.svg["Tool Position 5"]
image:images/tool-pos-6_en.svg["Tool Position 6"]
image:images/tool-pos-7_en.svg["Tool Position 7"]
image:images/tool-pos-8_en.svg["Tool Position 8"]
image:images/tool-pos-5_en.svg["Tool Position 5", align=left, pdfwidth=24%]
image:images/tool-pos-6_en.svg["Tool Position 6", align=left, pdfwidth=24%]
image:images/tool-pos-7_en.svg["Tool Position 7", align=left, pdfwidth=24%]
image:images/tool-pos-8_en.svg["Tool Position 8", align=left, pdfwidth=24%]

== Tool Touch Off

Expand Down
7 changes: 7 additions & 0 deletions docs/src/lcnc-overrides.css
Original file line number Diff line number Diff line change
Expand Up @@ -392,3 +392,10 @@ body:not(.article):not(.book):not(.manpage) tr:has(> th:only-child) > * {
color: #f0f0f0;
}
}

@media screen and (min-width:768px){
h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:revert}
h1{font-size:revert}
h2{font-size:revert}
h3,#toctitle,.sidebarblock>.content>.title{font-size:revert}
h4,h5{font-size:revert}}
5 changes: 2 additions & 3 deletions docs/src/man/man1/hal_input.1.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -57,9 +57,8 @@ with a dash. Each letter in the subset option specifies a device feature
to *include*. Features that are not specified are excluded. For
instance, to export keyboard LEDs to HAL without exporting keys, use

____
hal_input -L _keyboard_ ...
____
`hal_input -L keyboard ...`


== DEVICE FEATURES SUPPORTED

Expand Down
12 changes: 4 additions & 8 deletions docs/src/man/man1/halcmd.1.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -302,22 +302,18 @@ variable substitution take place.

Environment variables have the following formats:

____
*$ENVVAR* followed by end-of-line or whitespace
- *$ENVVAR* followed by end-of-line or whitespace

*$(ENVVAR)*
____
- *$(ENVVAR)*

=== INI file variables

INI file variables are available only when an INI file was specified
with the halcmd *-i* flag. They have the following formats:

____
*[SECTION]VAR* followed by end-of-line or whitespace
- *[SECTION]VAR* followed by end-of-line or whitespace

*[SECTION](VAR)*
____
- *[SECTION](VAR)*

== LINE CONTINUATION

Expand Down
2 changes: 0 additions & 2 deletions docs/src/man/man1/vfdb_vfd.1.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,13 @@ VFD-B must be reconfigured via the face plate by the integrator before
it will work. This section gives a brief description of what changes
need to be made, consult your Delta VFD-B manual for more details.

____
Switch the VFD-B to Modbus RTU frame format::
Switch parameter 09-04 from the factory default of 0 (Ascii framing) to 3, 4, or 5 (RTU framing).
The setting you choose will determine several serial parameters in addition to the Modbus framing protocol.
Set the frequency control source to be Modbus, not the keypad::
Switch parameter 02-00 from factory default of 00 (keypad control) to 5 (control from RS-485).
Set the run/stop control source to be Modbus, not the keypad:: Switch parameter 02-01 from the factory default of 0 (control from
keypad) to 3 (control from Modbus, with Stop enabled on the keypad).
____

== OPTIONS

Expand Down
4 changes: 1 addition & 3 deletions docs/src/man/man3/hal_type_t.3.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ typedef ... *real_t*;::
typedef ... *ireal_t*;::
A nonvolatile unsigned integral type the same size as *hal_float_t*.
typedef enum *hal_type_t*;::
+

*HAL_BIT*;;
Corresponds to the type *hal_bit_t*.
*HAL_FLOAT*;;
Expand All @@ -43,10 +43,8 @@ typedef enum *hal_type_t*;::
larger than just 0 and 1. When testing the value of a *hal_bit_t*, never
compare it to 1. Prefer one of the following:

____
* if(b)
* if(b != 0)
____

It is often useful to refer to a type that can represent all the values
as a HAL type, but without the volatile qualifier. The following types
Expand Down
4 changes: 2 additions & 2 deletions docs/src/man/man3/hm2_bspi_set_read_function.3.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ to be called every time that the main Hostmot2 driver calls the generic
printed with rtapi_print_msg during the driver loading process and take
the form:

____
----
hm2_<board name>.<board index>.bspi.<index>
____
----

For example hm2_5i23.0.bspi.0.

Expand Down
Loading
Loading