Skip to content

Commit

Permalink
DOCS updated
Browse files Browse the repository at this point in the history
  • Loading branch information
MadScrewdriver committed Nov 1, 2023
1 parent 9359e9d commit b627033
Showing 1 changed file with 61 additions and 2 deletions.
63 changes: 61 additions & 2 deletions docs/how_to_guide/Validating a parameterized DXF file.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,24 +15,48 @@ the app will provide full debug report. Including place where the error occurred
Validation process
------------------

1. Go to [**QSketchMetric Validator**](https://qsketchmetricvalidator.eu.pythonanywhere.com/). For widgets and fields
1. Go to `QSketchMetric Validator <https://qsketchmetricvalidator.eu.pythonanywhere.com/>`_ . For widgets and fields
explanation (for example: tokens) see the `Widgets`_ section.

.. figure:: https://qsketchmetric.readthedocs.io/en/latest/_static/Media/validator.png
:alt: validator
:width: 75%

2. Upload a DXF file by clicking on the **Choose a file** button or drag and drop a file into the upload area.

.. figure:: https://qsketchmetric.readthedocs.io/en/latest/_static/Media/choose_a_file.png
:alt: Choose a file button
:width: 20%

3. Provide a variables needed for the parametrization. This are the variables on upon which the file is rendered.
To do so utilize the **set vars** button and add as many variables as needed.

.. figure:: https://qsketchmetric.readthedocs.io/en/latest/_static/Media/variables.png
:alt: set vars
:width: 50%

4. Click on the **Validate** button.

5.
.. figure:: https://qsketchmetric.readthedocs.io/en/latest/_static/Media/validate.png
:alt: validation button
:width: 20%

5.
1. If the file is properly parametrized, the app will display a message **validating succeeded** and the rendered
file will be available for download.

.. figure:: https://raw.githubusercontent.com/MadScrewdriver/qsketchmetric/main/docs/_static/Media/success.gif
:alt: validation success
:width: 50%


2. If the file is not properly parametrized, the app will display an **error message** and a **debug report** will
be available for download.

.. figure:: https://raw.githubusercontent.com/MadScrewdriver/qsketchmetric/main/docs/_static/Media/error.gif
:alt: validation success
:width: 50%

3. If the DXF file contains more entities than your user account allows, the app will display an **error message**
saying that the file contains more entities than the account allows.
In this case, see the `Increase entities limit`_ section.
Expand All @@ -42,15 +66,50 @@ Validation process
Widgets
-------
- **Choose a file** - button that allows to choose a file from your computer.

.. figure:: https://qsketchmetric.readthedocs.io/en/latest/_static/Media/choose_a_file.png
:alt: Choose a file button
:width: 20%

- **Validate** - button that starts the validation process.

.. figure:: https://qsketchmetric.readthedocs.io/en/latest/_static/Media/validate.png
:alt: validation button
:width: 20%

- **set vars** - button that allows to set variables needed for the parametrization.

.. figure:: https://qsketchmetric.readthedocs.io/en/latest/_static/Media/set_vars.png
:alt: set vars button
:width: 20%

- **entities** - field that displays the number of entities in a DXF file that can be validated with the account.

.. figure:: https://qsketchmetric.readthedocs.io/en/latest/_static/Media/entities.png
:alt: entities field
:width: 20%

- **tokens** - field that displays the number of validations that can be performed with current entity limit. After
each validation the number of tokens is decreased by one. When the number of tokens reaches zero, the user will revert
to the default entity limit of 20 entities.

.. figure:: https://qsketchmetric.readthedocs.io/en/latest/_static/Media/tokens.png
:alt: tokens field
:width: 20%

- **question mark** - button that displays a tooltip with a help center.

.. figure:: https://qsketchmetric.readthedocs.io/en/latest/_static/Media/question_mark.png
:alt: question mark button
:width: 20%

- **Increase entities limit** - button that tooltip with a `Increase entities limit`_ section.

.. figure:: https://qsketchmetric.readthedocs.io/en/latest/_static/Media/increase_entities_limit.png
:alt: increase entities limit button
:width: 20%


.. _Increase entities limit:
Increase entities limit
-----------------------
Expand Down

0 comments on commit b627033

Please sign in to comment.