Skip to content

Commit 8ae31d6

Browse files
committed
Fix images and references in OMEdit
1 parent 6939edc commit 8ae31d6

File tree

2 files changed

+30
-14
lines changed

2 files changed

+30
-14
lines changed

usersguide-sphinx/.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,3 +32,4 @@ source/openmodelica.bib
3232
source/switch.pdf
3333
source/switch.png
3434
source/switch.svg
35+
source/media/omedit-icons

usersguide-sphinx/source/omedit.rst

Lines changed: 29 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -518,9 +518,12 @@ available in OMEdit.
518518

519519
- *Bitmap Tool* – Draws a bitmap container.
520520

521-
The shape tools are located in the toolbar. See Figure 2 -16.
521+
The shape tools are located in the toolbar. See :numref:`omedit-user-defined-shapes`.
522522

523-
Figure 216: **User defined shapes.**
523+
.. figure :: media/omedit-user-defined-shapes.png
524+
:name: omedit-user-defined-shapes
525+
526+
User defined shapes.
524527
525528
The user can select any of the shape tools and start drawing on the
526529
Icon/Diagram View. The shapes created on the Diagram View of Model
@@ -668,6 +671,8 @@ Graphical Views
668671
- *Preserve aspect ratio* – If true then the component’s aspect ratio
669672
is preserved while scaling.
670673

674+
.. _omedit-settings-simulation :
675+
671676
Simulation
672677
~~~~~~~~~~
673678

@@ -790,6 +795,8 @@ Figaro
790795

791796
- *Figaro Process* – the Figaro process location.
792797

798+
.. _omedit-settings-debugger :
799+
793800
Debugger
794801
~~~~~~~~
795802

@@ -846,8 +853,8 @@ The compilation time overhead from having this tracing on is less than
846853
write the xml file containing the transformation tracing information.
847854

848855
Enable +d=infoXmlOperations in Tools->Options->Simulation (see section
849-
2.9.5) OR alternatively click on the checkbox *Generate operations in
850-
the info xml* in Tools->Options->Debugger (see section 2.9.12) which
856+
:ref:`omedit-settings-simulation`) OR alternatively click on the checkbox *Generate operations in
857+
the info xml* in Tools->Options->Debugger (see section :ref:`omedit-settings-debugger`) which
851858
performs the same thing.
852859

853860
This adds all the transformations performed by OpenModelica on the
@@ -858,7 +865,7 @@ source equation(s) to the position of the bug.
858865
Load a Model to Debug
859866
~~~~~~~~~~~~~~~~~~~~~
860867

861-
Load an interesting model. We will use the package `Debugging.mo <https://github.com/OpenModelica/OpenModelica-testsuite/blob/master/openmodelica/debugging/Debugging.mo>`
868+
Load an interesting model. We will use the package `Debugging.mo <https://github.com/OpenModelica/OpenModelica-testsuite/blob/master/openmodelica/debugging/Debugging.mo>`__
862869
since it contains suitable, broken models to demonstrate common errors.
863870

864871
.. todo ::
@@ -875,7 +882,9 @@ get a clickable link that starts the debugger. If the user interface is
875882
unresponsive or the running simulation uses too much processing power,
876883
click cancel simulation first.
877884

878-
Figure 217. **Simulating the model.**
885+
.. figure :: media/omedit-debug-more.png
886+
887+
Simulating the model.
879888
880889
Use the Transformation Debugger for Browsing
881890
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -895,15 +904,17 @@ Try some larger models, e.g. in the MultiBody library or some other
895904
library, to see more operations with several transformation steps
896905
between different versions of the relevant equation(s). If you do not
897906
trigger any errors in a model, you can still open the debugger, using
898-
File->Open Transformations File (model\_info.xml).
907+
File->Open Transformations File (model\_info.json).
899908

900-
Figure 218. **Transfomation Debugger.**
909+
.. figure :: media/omedit-transformationsbrowser.png
910+
911+
Transfomations Browser.
901912
902913
The Algorithmic Debugger
903914
------------------------
904915

905916
This section gives a short description how to get started using the
906-
algorithmic debugger in OMEdit. See section 2.9.12 for further details
917+
algorithmic debugger in OMEdit. See section :ref:`omedit-settings-simulation` for further details
907918
of debugger options/settings. The Algorithmic Debugger window can be
908919
launched from Tools->Windows->Algorithmic Debugger.
909920

@@ -918,7 +929,7 @@ There are two ways to add the breakpoints,
918929
- Open the Algorithmic Debugger window and add a breakpoint using the
919930
right click menu of Breakpoints Browser window.
920931

921-
.. figure :: media/image25.png
932+
.. figure :: media/omedit-add-breakpoint.png
922933
:name: omedit-add-breakpoint
923934
924935
Adding breakpoint in Text View.
@@ -939,10 +950,12 @@ There are four ways to start the debugger,
939950
Algorithmic Debugger.
940951

941952
- Open the Algorithmic Debugger window and from menu select
942-
Debug->Debug Configurations (see section 2.11.3).
953+
Debug-> :ref:`omedit-debug-configurations`.
943954

944955
- Open the Algorithmic Debugger window and from menu select
945-
Debug->Attach to Running Process (see section 2.11.4).
956+
Debug-> :ref:`omedit-debug-attach`.
957+
958+
.. _omedit-debug-configurations :
946959

947960
Debug Configurations
948961
~~~~~~~~~~~~~~~~~~~~
@@ -955,10 +968,12 @@ The debugger also supports MetaModelica data structures so one can debug
955968
omc executable. Select omc executable as program and write the name of
956969
the mos script file in Arguments.
957970

958-
.. figure :: media/image26.png
971+
.. figure :: media/omedit-debug-config.png
959972
960973
Debug Configurations.
961974
975+
.. _omedit-debug-attach :
976+
962977
Attach to Running Process
963978
~~~~~~~~~~~~~~~~~~~~~~~~~
964979

@@ -969,7 +984,7 @@ Attach to Running Process dialog. The dialog shows the list of processes
969984
running on the machine. The user selects the program that he/she wish to
970985
debug. OMEdit debugger attaches to the process.
971986

972-
.. figure :: media/image27.png
987+
.. figure :: media/omedit-attach-to-process.png
973988
:name: omedit-attach-to-process
974989
975990
Attach to Running Process.

0 commit comments

Comments
 (0)