Skip to content
Closed
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
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,5 @@ _templates/*

# ignore VSCode settings
.vscode/*
*.code-workspace

2 changes: 2 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# User Manual, LibreCAD v2.2.0

# Read the Docs configuration file for Sphinx projects
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

Expand Down
2 changes: 2 additions & 0 deletions _static/css/theme_overrides.css
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
/* User Manual, LibreCAD v2.2.0 */

@import url("//media.readthedocs.org/css/sphinx_rtd_theme.css");
@import "theme.css";

Expand Down
2 changes: 1 addition & 1 deletion about/index.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. User Manual, LibreCAD v2.2.x
.. User Manual, LibreCAD v2.2.0

.. Default include
.. include:: /inclFiles/notice.rst
Expand Down
6 changes: 5 additions & 1 deletion appx/build.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
.. User Manual, LibreCAD v2.2.x
.. User Manual, LibreCAD v2.2.0

.. Default include
.. include:: /inclFiles/notice.rst



.. _build:
Expand Down
6 changes: 5 additions & 1 deletion appx/calculator.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
.. User Manual, LibreCAD v2.2.x
.. User Manual, LibreCAD v2.2.0

.. Default include
.. include:: /inclFiles/notice.rst



.. _calc:
Expand Down
6 changes: 5 additions & 1 deletion appx/contributing.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
.. User Manual, LibreCAD v2.2.x
.. User Manual, LibreCAD v2.2.0

.. Default include
.. include:: /inclFiles/notice.rst



.. _contributing:
Expand Down
6 changes: 5 additions & 1 deletion appx/fonts.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
.. User Manual, LibreCAD v2.2.x
.. User Manual, LibreCAD v2.2.0

.. Default include
.. include:: /inclFiles/notice.rst



.. _fonts:
Expand Down
6 changes: 5 additions & 1 deletion appx/hatches.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
.. User Manual, LibreCAD v2.2.x
.. User Manual, LibreCAD v2.2.0

.. Default include
.. include:: /inclFiles/notice.rst



.. _hatches:
Expand Down
2 changes: 1 addition & 1 deletion appx/index.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. User Manual, LibreCAD v2.2.x
.. User Manual, LibreCAD v2.2.0

.. Default include
.. include:: /inclFiles/notice.rst
Expand Down
7 changes: 5 additions & 2 deletions appx/languages.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
.. User Manual, LibreCAD v2.2.x
.. User Manual, LibreCAD v2.2.0

.. Default include
.. include:: /inclFiles/notice.rst


.. _languages:
Expand All @@ -20,7 +23,7 @@ Danish Korean Spanish; Casti
Dutch; Flemish Latvian Swedish
English (Australia) Macedonian Tamil
Estonian Norwegian Turkish
Finnish Panjabi; Punjabi Ukraine
Finnish Panjabi; Punjabi Ukrainian
French Polish
Galician Portuguese
============================= ============================= =============================
Expand Down
2 changes: 1 addition & 1 deletion appx/license-gpl.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. User Manual, LibreCAD v2.2.x
.. User Manual, LibreCAD v2.2.0

:orphan:

Expand Down
6 changes: 1 addition & 5 deletions appx/licenses.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. User Manual, LibreCAD v2.2.x
.. User Manual, LibreCAD v2.2.0


.. _licenses:
Expand Down Expand Up @@ -109,10 +109,6 @@ muParser was released under the MIT license.

- <http://beltoforion.de/article.php?a=muparser&hl=en&p=licence>

Shapelib was released under a "MIT Style" license or LGPLv2.

- <https://github.com/LibreCAD/LibreCAD/tree/master/plugins/importshp/shapelib>

The AZOmix fonts were released under the KST32B version 2.0 license.

- <https://github.com/LibreCAD/LibreCAD/blob/master/licenses/KST32B_v2.txt>
Expand Down
5 changes: 4 additions & 1 deletion appx/lines.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
.. User Manual, LibreCAD v2.2.x
.. User Manual, LibreCAD v2.2.0

.. Default include
.. include:: /inclFiles/notice.rst


.. _lines:
Expand Down
5 changes: 4 additions & 1 deletion appx/measurements.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
.. User Manual, LibreCAD v2.2.x
.. User Manual, LibreCAD v2.2.0

.. Default include
.. include:: /inclFiles/notice.rst


.. _measurements:
Expand Down
5 changes: 4 additions & 1 deletion appx/resources.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
.. User Manual, LibreCAD v2.2.x
.. User Manual, LibreCAD v2.2.0

.. Default include
.. include:: /inclFiles/notice.rst


.. _resources:
Expand Down
5 changes: 4 additions & 1 deletion appx/scales.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
.. User Manual, LibreCAD v2.2.x
.. User Manual, LibreCAD v2.2.0

.. Default include
.. include:: /inclFiles/notice.rst


.. _scales:
Expand Down
2 changes: 1 addition & 1 deletion conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@
# General information about the project.
project = 'LibreCAD'
title = 'LibreCAD User Manual'
copyright = '2018, LibreCAD.org'
copyright = '2018-2024, LibreCAD.org'
author = 'LibreCAD Documentation Team'

# The version info for the project you're documenting, acts as replacement for
Expand Down
2 changes: 1 addition & 1 deletion getstart/configure.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. User Manual, LibreCAD v2.2.x
.. User Manual, LibreCAD v2.2.0

.. Default include
.. include:: /inclFiles/notice.rst
Expand Down
2 changes: 1 addition & 1 deletion getstart/index.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. User Manual, LibreCAD v2.2.x
.. User Manual, LibreCAD v2.2.0

.. Default include
.. include:: /inclFiles/notice.rst
Expand Down
2 changes: 1 addition & 1 deletion getstart/install.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. User Manual, LibreCAD v2.2.x
.. User Manual, LibreCAD v2.2.0

.. Default include
.. include:: /inclFiles/notice.rst
Expand Down
2 changes: 1 addition & 1 deletion guides/annotate.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. User Manual, LibreCAD v2.2.x
.. User Manual, LibreCAD v2.2.0

.. Default include
.. include:: /inclFiles/notice.rst
Expand Down
2 changes: 1 addition & 1 deletion guides/blocks.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. User Manual, LibreCAD v2.2.x
.. User Manual, LibreCAD v2.2.0

.. Default include
.. include:: /inclFiles/notice.rst
Expand Down
3 changes: 2 additions & 1 deletion guides/cmdline.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. User Manual, LibreCAD v2.2.x
.. User Manual, LibreCAD v2.2.0

.. Default include
.. include:: /inclFiles/notice.rst
Expand Down Expand Up @@ -35,6 +35,7 @@ The commands available to use are shown in the :ref:`Drawing Tools <tools>` refe
#. Press [Ctrl + M], any command, and then [Enter] or the [Space bar].
#. Press [Shift], any command, and then [Enter] or the [Space bar].
#. Press [F1], any command, and then [Enter] or the [Space bar].
#. Press [Shift + Space bar] to force focus on the command prompt, any command, and then [Enter] or the [Space bar].
#. With the *Keycode Mode* on, type a **two letter** command (e.g. ``li``, ``ci``); pressing [Enter] is not required.

When the command line is activated, the prompt above the input text-box (initially showing "Command:" in black text) turns blue. After typing a command, the prompt will indicate the next input required, such as coordinates or the next action available.
Expand Down
2 changes: 1 addition & 1 deletion guides/completion.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. User Manual, LibreCAD v2.2.x
.. User Manual, LibreCAD v2.2.0

.. Default include
.. include:: /inclFiles/notice.rst
Expand Down
2 changes: 1 addition & 1 deletion guides/console-tool.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. User Manual, LibreCAD v2.2.x
.. User Manual, LibreCAD v2.2.0

.. Default include
.. include:: /inclFiles/notice.rst
Expand Down
2 changes: 1 addition & 1 deletion guides/dwg-edit.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. User Manual, LibreCAD v2.2.x
.. User Manual, LibreCAD v2.2.0

.. Default include
.. include:: /inclFiles/notice.rst
Expand Down
2 changes: 1 addition & 1 deletion guides/dwg-setup.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. User Manual, LibreCAD v2.2.x
.. User Manual, LibreCAD v2.2.0

.. Default include
.. include:: /inclFiles/notice.rst
Expand Down
2 changes: 1 addition & 1 deletion guides/index.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. User Manual, LibreCAD v2.2.x
.. User Manual, LibreCAD v2.2.0

.. Default include
.. include:: /inclFiles/notice.rst
Expand Down
2 changes: 2 additions & 0 deletions inclFiles/eoWrap.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. User Manual, LibreCAD v2.2.0

.. Force end of left / right text wrap

.. only:: html
Expand Down
12 changes: 4 additions & 8 deletions inclFiles/notice.rst
Original file line number Diff line number Diff line change
@@ -1,11 +1,7 @@
..
Notice / banner to include at top of every page via "include" command
.. include:: /inclFiles/notice.rst
.. User Manual, LibreCAD v2.2.0

.. Notice / banner to include at top of every page via "include" command

.. admonition:: LibreCAD v2.2.0 - User Manual

*This is an* **interim release** *of the of the* **LibreCAD User Manual** *and is subject to change.*

The manual is based on LibreCAD v2.2.0-rc1 with a few additions. If you are using another version of LibreCAD, your mileage may vary.
.. note::

This manual is for LibreCAD's stable release version 2.2.0.
11 changes: 8 additions & 3 deletions index.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,17 @@
.. User Manual, LibreCAD v2.2.x
.. User Manual, LibreCAD v2.2.0


====================
LibreCAD User Manual
====================

.. Default include
.. include:: /inclFiles/notice.rst
.. important::

This manual is for LibreCAD's stable release version 2.2.0.

For newer versions switch the manual version to ``latest`` in the flyout menu.

Information about pre 2.2.0 versions can be found in our `Wiki <http://dokuwiki.librecad.org>`_, or in the `Forum <http://forum.librecad.org>`_.

.. Show the LibreCAD's splash screen

Expand Down
2 changes: 1 addition & 1 deletion ref/customize.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. User Manual, LibreCAD v2.2.x
.. User Manual, LibreCAD v2.2.0

.. Default include
.. include:: /inclFiles/notice.rst
Expand Down
2 changes: 1 addition & 1 deletion ref/draw-prefs.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. User Manual, LibreCAD v2.2.x
.. User Manual, LibreCAD v2.2.0

.. Default include
.. include:: /inclFiles/notice.rst
Expand Down
2 changes: 1 addition & 1 deletion ref/fundamentals.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. User Manual, LibreCAD v2.2.x
.. User Manual, LibreCAD v2.2.0

.. Default include
.. include:: /inclFiles/notice.rst
Expand Down
2 changes: 1 addition & 1 deletion ref/index.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. User Manual, LibreCAD v2.2.x
.. User Manual, LibreCAD v2.2.0

.. Default include
.. include:: /inclFiles/notice.rst
Expand Down
3 changes: 1 addition & 2 deletions ref/menu.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. User Manual, LibreCAD v2.2.x
.. User Manual, LibreCAD v2.2.0

.. Default include
.. include:: /inclFiles/notice.rst
Expand Down Expand Up @@ -121,7 +121,6 @@ Plugins
"Read ascii points", , "", "Read points from a text file. Each line of the file is a point defined by an ID, X coordinate, Y coordinate, Z coordinate and an optional code. Each field can be separated by a comma, a tab or a space. The decimal separator is the point (.). The points can be connected with a line, ID, or coordinate and code fields can be plotted as text."
"Divide", , "", "Divide a line or a circle with *n* sections. A tick can be located at the limit of each section to show each limit. The size of this tick can be defined as a percentage of the segment length. The line or the circle can be broken at the limit of each section using :ref:`Divide <tool-modify>` tool."
"Gear plugin", , "", "Draw a gear by selecting the center of gear and defining parameters such as number of teeth, modulus, etc."
"ESRI Shapefile", , "", "Import GIS geospatial vector data shapefile (i.e. maps). **Warning:** The import process will lock LibreCAD until it is complete and large files can be very time consuming."
"List entities", , "", "List the selected entities along with their properties such as ID, layer, color, line type, line thickness, coordinates."
"Read PIC file", , "", "Import Pic graphics language diagrams."
"Plot plugin", , "", "Plot a mathematical function or a parametric function using the drawing coordinate system. The formula, start value, end value and step value are required. The plot can be lines, a polyline or a spline."
Expand Down
28 changes: 14 additions & 14 deletions ref/snaps.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. User Manual, LibreCAD v2.2.x
.. User Manual, LibreCAD v2.2.0

.. Default include
.. include:: /inclFiles/notice.rst
Expand All @@ -19,19 +19,19 @@ Snaps provide the ability to pick precise locations when using a mouse. Various

"Menu Item", "Icon", "Command", "Description"
"Exclusive Snap Mode", |icon01|, "", "**On**: only one snap mode is allowed. **Off**: multiple snap modes are allowed The snap modes are remembered in each state."
"Free Snap", |icon02|, "os, sf", "Allows for the crosshair to move freely while other snap modes are enabled."
"Snap on Grid", |icon03|, "sg", "Snap to a grid intersection."
"Snap on Endpoints", |icon04|, "se", "Snap to the endpoints of a line segment, the quadrants of a circle, a point, or the alignment point of a text or mtext object."
"Snap on Entity", |icon05|, "np, sn", "Snap to the path of an entity."
"Snap Center", |icon06|, "sc", "Snap to the center of a circle or ellipse. It will also snap to the foci of an ellipse."
"Snap Middle", |icon07|, "sm", "Snap to the middle of a path. Enabling this mode displays a ''Middle points'' input. If you change the value to 2 then you can snap to the trisection points of a line segment."
"Snap Distance", |icon08|, "sd", "If you snap to the endpoint of a line segment then activate ''snap distance'' and input 50, then it will snap to a point 50 units from the endpoint on the line segment. However, it will also snap to a point that is 50 units from the other endpoint."
"Snap Intersection", |icon09|, "si", "Snap to the intersection of two entities. Note this does not currently work for polylines."
"Restrict Horizontal", |icon10|, "rh", "Restricts the crosshairs to the x-axis (horizontal movement)."
"Restrict Vertical", |icon11|, "rv", "Restricts the crosshairs to the y-axis (vertical movement)."
"Restrict Orthogonal", |icon12|, "rr", "Restricts the crosshairs to the x **or** y-axis. (either horizontal **or** vertical movement)."
"Restrict Nothing", , "rn", "Turns off restricted cursor movements."
"Set relative zero position", |icon13|, "", "Manually sets the Relative Zero Point at the selected coordinate."
"Free Snap", |icon02|, "so, os, snapfree", "Allows for the crosshair to move freely while other snap modes are enabled."
"Snap on Grid", |icon03|, "sg, snapgrid", "Snap to a grid intersection."
"Snap on Endpoints", |icon04|, "se, snapend", "Snap to the endpoints of a line segment, the quadrants of a circle, a point, or the alignment point of a text or mtext object."
"Snap on Entity", |icon05|, "sn, np, snaponentity", "Snap to the path of an entity."
"Snap Center", |icon06|, "sc, snapcenter", "Snap to the center of a circle or ellipse. It will also snap to the foci of an ellipse."
"Snap Middle", |icon07|, "sm, snapmiddle", "Snap to the middle of a path. Enabling this mode displays a ''Middle points'' input. If you change the value to 2 then you can snap to the trisection points of a line segment."
"Snap Distance", |icon08|, "sd, snapdist", "If you snap to the endpoint of a line segment then activate ''snap distance'' and input 50, then it will snap to a point 50 units from the endpoint on the line segment. However, it will also snap to a point that is 50 units from the other endpoint."
"Snap Intersection", |icon09|, "si, snapintersection", "Snap to the intersection of two entities. Note this does not currently work for polylines."
"Restrict Horizontal", |icon10|, "rh, restricthorizontal", "Restricts the crosshairs to the x-axis (horizontal movement)."
"Restrict Vertical", |icon11|, "rv, restrictvertical", "Restricts the crosshairs to the y-axis (vertical movement)."
"Restrict Orthogonal", |icon12|, "rr, restrictogonal", "Restricts the crosshairs to the x **or** y-axis. (either horizontal **or** vertical movement)."
"Restrict Nothing", , "rn, restrictnothing", "Turns off restricted cursor movements."
"Set relative zero position", |icon13|, "rz, setrelativezero", "Manually sets the Relative Zero Point at the selected coordinate."
"Lock relative zero position", |icon14|, "", "Locks the Relative Zero Point to the current coordinate."


Expand Down
2 changes: 1 addition & 1 deletion ref/toolbars.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. User Manual, LibreCAD v2.2.x
.. User Manual, LibreCAD v2.2.0

.. Default include
.. include:: /inclFiles/notice.rst
Expand Down
Loading