Skip to content

Commit 0c638e3

Browse files
committed
Added documentation about OMEdit menus.
1 parent 6eaa1a8 commit 0c638e3

File tree

2 files changed

+127
-0
lines changed

2 files changed

+127
-0
lines changed

UsersGuide/source/encryption.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _encryption :
2+
13
OpenModelica Encryption
24
=======================
35

UsersGuide/source/omedit.rst

Lines changed: 125 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,8 @@ areas. If you want OMEdit to remember the new docked position of the
8787
browsers then you must enable Preserve User's GUI Customizations option,
8888
see section :ref:`omedit-settings-general`.
8989

90+
.. _omedit-filter-classes :
91+
9092
Filter Classes
9193
~~~~~~~~~~~~~~
9294

@@ -231,6 +233,129 @@ The prespective shows the list of stack frames, breakpoints and variables.
231233
232234
OMEdit Debugging Perspective.
233235
236+
File Menu
237+
---------
238+
239+
- *New Modelica Class* - Creates a new Modelica class.
240+
- *Open Model/Library File(s)* - Opens the Modelica file or a library.
241+
- *Open/Convert Modelica File(s) With Encoding* - Opens the Modelica file or
242+
a library with a specific encoding. It is also possible to convert to UTF-8.
243+
- *Load Library* - Loads a Modelica library. Allows the user to select the
244+
library path assuming that the path contains a package.mo file.
245+
- *Load Encrypted Library* - Loads an encrypted library. see :ref:`encryption`
246+
- *Open Result File(s)* - Opens a result file.
247+
- *Open Transformations File* - Opens a transformational debugger file.
248+
- *New Composite Model* - Creates a new composite model.
249+
- *Open Composite Model(s)* - Loads an existing composite model.
250+
- *Load External Model(s)* - Loads the external models that can be used within
251+
composite model.
252+
- *Open Directory* - Loads the files of a directory recursively. The files
253+
are loaded as text files.
254+
- *Save* - Saves the class.
255+
- *Save As* - Save as the class.
256+
- *Import*
257+
- *FMU* - Imports the FMU.
258+
- *FMU Model Description* - Imports the FMU model description.
259+
- *From OMNotbook* - Imports the Modelica models from OMNotebook.
260+
- *Ngspice netlist* - Imports the ngspice netlist to Modelica code.
261+
- "Export"
262+
- *To Clipboard* - Exports the current model to clipboard.
263+
- *Image* - Exports the current model to image.
264+
- *FMU* - Exports the current model to FMU.
265+
- *Read-only Package* - Exports a zipped Modelica library with file extension .mol
266+
- *Encrypted Package* - Exports an encrypted package. see :ref:`encryption`
267+
- *XML* - Exports the current model to a xml file.
268+
- *Figaro* - Exports the current model to Figaro.
269+
- *To OMNotebook* - Exports the current model to a OMNotebook file.
270+
- *System Libraries* - Contains a list of system libraries.
271+
- *Recent Files* - Contains a list of recent files.
272+
- *Clear Recent Files* - Clears the list of recent files.
273+
- *Print* - Prints the current model.
274+
- *Quit* - Quit the OpenModelica Connection Editor.
275+
276+
Edit Menu
277+
---------
278+
279+
- *Undo* - Undoes the last change.
280+
- *Redo* - Redoes the last undone change.
281+
- *Filter Classes* - Filters the classes in Libraries Browser. see :ref:`omedit-filter-classes`
282+
283+
View Menu
284+
---------
285+
286+
- *Toolbars* - Toggle visibility of toolbars.
287+
- *Windows* - Toggle visibility of windows.
288+
- *Close Window* - Closes the current model window.
289+
- *Close All Windows* - Closes all the model windows.
290+
- *Close All Windows But This* - Closes all the model windows except the current.
291+
- *Cascade Windows* - Arranges all the child windows in a cascade pattern.
292+
- *Tile Windows Horizontally* - Arranges all child windows in a horizontally tiled pattern.
293+
- *Tile Windows Vertically* - Arranges all child windows in a vertically tiled pattern.
294+
- *Toggle Tab/Sub-window View* - Switches between tab and subwindow view.
295+
- *Grid Lines* - Toggle grid lines of the current model.
296+
- *Reset Zoom* - Resets the zoom of the current model.
297+
- *Zoom In* - Zoom in the current model.
298+
- *Zoom Out* - Zoom out the current model.
299+
300+
Simulation Menu
301+
---------------
302+
303+
- *Instantiate Model* - Instantiates the current model.
304+
- *Check Model* - Checks the current model.
305+
- *Check All Models* - Checks all the models of a library.
306+
- *Simulate* - Simulates the current model.
307+
- *Simulate with Transformational Debugger* - Simulates the current model and
308+
opens the transformational debugger.
309+
- *Simulate with Algorithmic Debugger* - Simulates the current model and
310+
opens the algorithmic debugger.
311+
- *Simulate with Animation* - Simulates the current model and open the animation.
312+
- *Simulation Setup* - Opens the simulation setup window.
313+
314+
Debugger Menu
315+
-------------
316+
317+
- *Debug Configurations* - Opens the debug configurations window.
318+
- *Attach to Running Process* - Attaches the algorithmic debugger to a running process.
319+
320+
OMSimulator Menu
321+
----------------
322+
323+
- *New OMSimulator Model* - Creates a new OMSimulator model.
324+
- *Open OMSimulator Model(s)* - Opens the OMSimulator model(s).
325+
- *Add System* - Adds the system to a model.
326+
- *Add/Edit Icon* - Add/Edit the system/submodel icon.
327+
- *Delete Icon* - Deletes the system/submodel icon.
328+
- *Add Connector* - Adds a connector to a system/submodel.
329+
- *Add Bus* - Adds a bus to a system/submodel.
330+
- *Add TLM Bus* - Adds a TLM bus to a system/submodel.
331+
- *Add SubModel* - Adds a submodel to a system.
332+
- *Instantiate Model* - Instantiates the model.
333+
- *Simulate* - Simulates the model.
334+
- *Archived Simulations* - Opens the archived simulations window.
335+
336+
Tools Menu
337+
----------
338+
339+
- *OpenModelica Compiler CLI* - Opens the OpenModelica Compiler command line
340+
interface window.
341+
- *OpenModelica Command Prompt* - Opens the OpenModelica Command Prompt (Only
342+
available on Windows).
343+
- *Open Working Directory* - Opens the current working directory.
344+
- *Open Terminal* - Runs the terminal command set in :ref:`omedit-settings-general`.
345+
- *Options* - Opens the options window.
346+
347+
Help Menu
348+
---------
349+
350+
- *OpenModelica Users Guide* - Opens the OpenModelica Users Guide.
351+
- *OpenModelica Users Guide (PDF)* - Opens the OpenModelica Users Guide (PDF).
352+
- *OpenModelica System Documentation* - Opens the OpenModelica System Documentation.
353+
- *OpenModelica Scripting Documentation* - Opens the OpenModelica Scripting Documentation.
354+
- *Modelica Documentation* - Opens the Modelica Documentation.
355+
- *OMSimulator Users Guide* - Opens the OMSimulator Users Guide.
356+
- *OpenModelica TLM Simulator Documentation* - Opens the OpenModelica TLM Simulator Documentation.
357+
- *About OMEdit* - Shows the information about OpenModelica Connection Editor.
358+
234359
Modeling a Model
235360
----------------
236361

0 commit comments

Comments
 (0)