Skip to content

Commit 1204474

Browse files
committed
Updated OMEdit settings documentation.
1 parent 7af6b51 commit 1204474

File tree

1 file changed

+113
-112
lines changed

1 file changed

+113
-112
lines changed

UsersGuide/source/omedit.rst

Lines changed: 113 additions & 112 deletions
Original file line numberDiff line numberDiff line change
@@ -554,53 +554,52 @@ General
554554

555555
- General
556556

557-
- *Language* – Sets the application language.
557+
- *Language* – Sets the application language.
558558

559-
- *Working Directory* – Sets the application working directory.
559+
- *Working Directory* – Sets the application working directory.
560560

561-
- *Toolbar Icon Size* – Sets the size for toolbar icons.
561+
- *Toolbar Icon Size* – Sets the size for toolbar icons.
562562

563-
- *Preserve User’s GUI Customizations* – If true then OMEdit will
564-
remember its windows and toolbars positions and sizes.
563+
- *Preserve User’s GUI Customizations* – If true then OMEdit will
564+
remember its windows and toolbars positions and sizes.
565565

566-
- *Terminal Command* – Sets the terminal command.
566+
- *Terminal Command* – Sets the terminal command.
567567

568-
- *Terminal Command Arguments* – Sets the terminal command arguments.
568+
- *Terminal Command Arguments* – Sets the terminal command arguments.
569569

570570
- Libraries Browser
571571

572-
- *Library Icon Size* – Sets the size for library icons.
572+
- *Library Icon Size* – Sets the size for library icons.
573573

574-
- *Show Protected Classes* – Sets the application language.
574+
- *Show Protected Classes* – Sets the application language.
575575

576576
- Modeling View Mode
577577

578-
- *Tabbed View/SubWindow View* – Sets the view mode for modeling.
578+
- *Tabbed View/SubWindow View* – Sets the view mode for modeling.
579579

580580
- Default View
581581

582-
- *Icon View/DiagramView/Modelica Text View/Documentation View* – If no
583-
preferredView annotation is defined then this setting is used to show
584-
the respective view when user double clicks on the class in the
585-
Libraries Browser.
582+
- *Icon View/DiagramView/Modelica Text View/Documentation View* – If no
583+
preferredView annotation is defined then this setting is used to show
584+
the respective view when user double clicks on the class in the
585+
Libraries Browser.
586586

587587
- Enable Auto Save
588588

589-
- *Auto Save interval* – Sets the auto save interval value. The minimum
590-
possible interval value is 60 seconds.
589+
- *Auto Save interval* – Sets the auto save interval value. The minimum
590+
possible interval value is 60 seconds.
591591

592-
- *Enable Auto Save for single classes* – Enables the auto save for one
593-
class saved in one file.
592+
- *Enable Auto Save for single classes* – Enables the auto save for one
593+
class saved in one file.
594594

595-
- *Enable Auto Save for one file packages* – Enables the auto save for
596-
packages saved in one file.
595+
- *Enable Auto Save for one file packages* – Enables the auto save for
596+
packages saved in one file.
597597

598598
- Welcome Page
599599

600-
- *Horizontal View/Vertical View* – Sets the view mode for welcome
601-
page.
600+
- *Horizontal View/Vertical View* – Sets the view mode for welcome page.
602601

603-
- *Show Latest News –* if true then displays the latest news.
602+
- *Show Latest News –* if true then displays the latest news.
604603

605604
Libraries
606605
~~~~~~~~~
@@ -620,34 +619,36 @@ Modelica Text Editor
620619

621620
- Tabs and Indentation
622621

623-
- *Tab Policy* – Sets the tab policy to either spaces or tabs only.
622+
- *Tab Policy* – Sets the tab policy to either spaces or tabs only.
624623

625-
- *Tab Size* – Sets the tab size.
624+
- *Tab Size* – Sets the tab size.
626625

627-
- *Indent Size* – Sets the indent size.
626+
- *Indent Size* – Sets the indent size.
627+
628+
- *Preserve Text Indentation* – If true then uses *diffModelicaFileListings* API call otherwise uses the OMC pretty-printing.
628629

629630
- Syntax Highlight and Text Wrapping
630631

631-
- *Enable Syntax Highlighting* – Enable/Disable the syntax highlighting
632-
for the Modelica Text Widget.
632+
- *Enable Syntax Highlighting* – Enable/Disable the syntax highlighting
633+
for the Modelica Text Widget.
633634

634-
- *Match Parentheses within Comments and Quotes* – Enable/Disable the matching of parenthese
635-
within comments and quotes.
635+
- *Match Parentheses within Comments and Quotes* – Enable/Disable the matching of parenthese
636+
within comments and quotes.
636637

637-
- *Enable Line Wrapping* – Enable/Disable the line wrapping for the
638-
Modelica Text Widget.
638+
- *Enable Line Wrapping* – Enable/Disable the line wrapping for the
639+
Modelica Text Widget.
639640

640641
- Fonts and Colors
641642

642-
- *Font Family* – Contains the names list of available fonts.
643+
- *Font Family* – Contains the names list of available fonts.
643644

644-
- *Font Size* – Sets the font size.
645+
- *Font Size* – Sets the font size.
645646

646-
- *Items* – List of categories used of syntax highlighting the code.
647+
- *Items* – List of categories used of syntax highlighting the code.
647648

648-
- *Item Color* – Sets the color for the selected item.
649+
- *Item Color* – Sets the color for the selected item.
649650

650-
- *Preview* – Shows the demo of the syntax highlighting.
651+
- *Preview* – Shows the demo of the syntax highlighting.
651652

652653
Graphical Views
653654
~~~~~~~~~~~~~~~
@@ -683,27 +684,27 @@ Simulation
683684

684685
- Simulation
685686

686-
- *Matching Algorithm* – sets the matching algorithm for simulation.
687+
- *Matching Algorithm* – sets the matching algorithm for simulation.
687688

688-
- *Index Reduction Method* – sets the index reduction method for
689-
simulation.
689+
- *Index Reduction Method* – sets the index reduction method for
690+
simulation.
690691

691-
- *Target Language* – sets the target language in which the code is generated.
692+
- *Target Language* – sets the target language in which the code is generated.
692693

693-
- *Target Compiler* – sets the target compiler for compiling the generated code.
694+
- *Target Compiler* – sets the target compiler for compiling the generated code.
694695

695-
- *OMC Flags* – sets the omc flags for simulation.
696+
- *OMC Flags* – sets the omc flags for simulation.
696697

697-
- *Save class before simulation* – if ture then always saves the class
698-
before running the simulation.
698+
- *Save class before simulation* – if ture then always saves the class
699+
before running the simulation.
699700

700-
- Output
701+
- Output
701702

702-
- *Structured –* Shows the simulation output in the form of tree
703-
structure.
703+
- *Structured –* Shows the simulation output in the form of tree
704+
structure.
704705

705-
- *Formatted Text –* Shows the simulation output in the form of
706-
formatted text.
706+
- *Formatted Text –* Shows the simulation output in the form of
707+
formatted text.
707708

708709
.. _omedit-settings-messages :
709710

@@ -712,103 +713,103 @@ Messages
712713

713714
- General
714715

715-
- *Output Size* - Specifies the maximum number of rows the Messages
716-
Browser may have. If there are more rows then the rows are removed
717-
from the beginning.
716+
- *Output Size* - Specifies the maximum number of rows the Messages
717+
Browser may have. If there are more rows then the rows are removed
718+
from the beginning.
718719

719-
- *Reset messages number before simulation* – Resets the messages
720-
counter before starting the simulation.
720+
- *Reset messages number before simulation* – Resets the messages
721+
counter before starting the simulation.
721722

722723
- Font and Colors
723724

724-
- *Font Family* – Sets the font for the messages.
725+
- *Font Family* – Sets the font for the messages.
725726

726-
- *Font Size –* Sets the font size for the messages.
727+
- *Font Size –* Sets the font size for the messages.
727728

728-
- *Notification Color* – Sets the text color for notification messages.
729+
- *Notification Color* – Sets the text color for notification messages.
729730

730-
- *Warning Color* – Sets the text color for warning messages.
731+
- *Warning Color* – Sets the text color for warning messages.
731732

732-
- *Error Color* – Sets the text color for error messages.
733+
- *Error Color* – Sets the text color for error messages.
733734

734735
Notifications
735736
~~~~~~~~~~~~~
736737

737738
- Notifications
738739

739-
- *Always quit without prompt* – If true then OMEdit will quit without
740-
prompting the user.
740+
- *Always quit without prompt* – If true then OMEdit will quit without
741+
prompting the user.
741742

742-
- *Show item dropped on itself message* – If true then a message will
743-
pop-up when a class is dragged and dropped on itself.
743+
- *Show item dropped on itself message* – If true then a message will
744+
pop-up when a class is dragged and dropped on itself.
744745

745-
- *Show model is defined as partial and component will be added as
746-
replaceable message* – If true then a message will pop-up when a
747-
partial class is added to another class.
746+
- *Show model is defined as partial and component will be added as
747+
replaceable message* – If true then a message will pop-up when a
748+
partial class is added to another class.
748749

749-
- *Show component is declared as inner message* – If true then a
750-
message will pop-up when an inner component is added to another
751-
class.
750+
- *Show component is declared as inner message* – If true then a
751+
message will pop-up when an inner component is added to another
752+
class.
752753

753-
- *Show save model for bitmap insertion message* – If true then a
754-
message will pop-up when user tries to insert a bitmap from a local
755-
directory to an unsaved class.
754+
- *Show save model for bitmap insertion message* – If true then a
755+
message will pop-up when user tries to insert a bitmap from a local
756+
directory to an unsaved class.
756757

757758
Line Style
758759
~~~~~~~~~~
759760

760761
- Line Style
761762

762-
- *Color* – Sets the line color.
763+
- *Color* – Sets the line color.
763764

764-
- *Pattern* – Sets the line pattern.
765+
- *Pattern* – Sets the line pattern.
765766

766-
- *Thickness* – Sets the line thickness.
767+
- *Thickness* – Sets the line thickness.
767768

768-
- *Start Arrow* – Sets the line start arrow.
769+
- *Start Arrow* – Sets the line start arrow.
769770

770-
- *End Arrow* – Sets the line end arrow.
771+
- *End Arrow* – Sets the line end arrow.
771772

772-
- *Arrow Size* – Sets the start and end arrow size.
773+
- *Arrow Size* – Sets the start and end arrow size.
773774

774-
- *Smooth* – If true then the line is drawn as a Bezier curve.
775+
- *Smooth* – If true then the line is drawn as a Bezier curve.
775776

776777
Fill Style
777778
~~~~~~~~~~
778779

779780
- Fill Style
780781

781-
- *Color* – Sets the fill color.
782+
- *Color* – Sets the fill color.
782783

783-
- *Pattern* – Sets the fill pattern.
784+
- *Pattern* – Sets the fill pattern.
784785

785786
Plotting
786787
~~~~~~~~
787788

788789
- General
789790

790-
- *Auto Scale* – sets whether to auto scale the plots or not.
791+
- *Auto Scale* – sets whether to auto scale the plots or not.
791792

792793
- Plotting View Mode
793794

794-
- *Tabbed View/SubWindow View* – Sets the view mode for plotting.
795+
- *Tabbed View/SubWindow View* – Sets the view mode for plotting.
795796

796797
- Curve Style
797798

798-
- *Pattern* – Sets the curve pattern.
799+
- *Pattern* – Sets the curve pattern.
799800

800-
- *Thickness* – Sets the curve thickness.
801+
- *Thickness* – Sets the curve thickness.
801802

802803
Figaro
803804
~~~~~~
804805

805806
- Figaro
806807

807-
- *Figaro Library* – the Figaro library file path.
808+
- *Figaro Library* – the Figaro library file path.
808809

809-
- *Tree generation options* – the Figaro tree generation options file path.
810+
- *Tree generation options* – the Figaro tree generation options file path.
810811

811-
- *Figaro Processor* – the Figaro processor location.
812+
- *Figaro Processor* – the Figaro processor location.
812813

813814
.. _omedit-settings-debugger :
814815

@@ -817,31 +818,31 @@ Debugger
817818

818819
- Algorithmic Debugger
819820

820-
- *GDB Path* – the gnu debugger path
821+
- *GDB Path* – the gnu debugger path
821822

822-
- *GDB Command Timeout* – timeout for gdb commands.
823+
- *GDB Command Timeout* – timeout for gdb commands.
823824

824-
- *GDB Output Limit* – limits the GDB output to N characters.
825+
- *GDB Output Limit* – limits the GDB output to N characters.
825826

826-
- *Display C frames* – if true then shows the C stack frames.
827+
- *Display C frames* – if true then shows the C stack frames.
827828

828-
- *Display unknown frames* – if true then shows the unknown stack
829-
frames. Unknown stack frames means frames whose file path is unknown.
829+
- *Display unknown frames* – if true then shows the unknown stack
830+
frames. Unknown stack frames means frames whose file path is unknown.
830831

831-
- *Clear old output on a new run* – if true then clears the output
832-
window on new run.
832+
- *Clear old output on a new run* – if true then clears the output
833+
window on new run.
833834

834-
- *Clear old log on new run* – if true then clears the log window on
835-
new run.
835+
- *Clear old log on new run* – if true then clears the log window on
836+
new run.
836837

837838
- Transformational Debugger
838839

839-
- *Always show Transformational Debugger after compilation* – if true
840-
then always open the Transformational Debugger window after model
841-
compilation.
840+
- *Always show Transformational Debugger after compilation* – if true
841+
then always open the Transformational Debugger window after model
842+
compilation.
842843

843-
- *Generate operations in the info xml* – if true then adds the
844-
operations information in the info xml file.
844+
- *Generate operations in the info xml* – if true then adds the
845+
operations information in the info xml file.
845846

846847
.. _omedit-fmi-settings :
847848

@@ -850,21 +851,21 @@ FMI
850851

851852
- Export
852853

853-
- Version
854+
- Version
854855

855-
- *1.0* – Sets the FMI export version to 1.0
856+
- *1.0* – Sets the FMI export version to 1.0
856857

857-
- *2.0* – Sets the FMI export version to 2.0
858+
- *2.0* – Sets the FMI export version to 2.0
858859

859-
- Type
860+
- Type
860861

861-
- *Model Exchange* – Sets the FMI export type to Model Exchange.
862+
- *Model Exchange* – Sets the FMI export type to Model Exchange.
862863

863-
- *Co-Simulation* – Sets the FMI export type to Co-Simulation.
864+
- *Co-Simulation* – Sets the FMI export type to Co-Simulation.
864865

865-
- *Model Exchange and Co-Simulation* – Sets the FMI export type to Model Exchange and Co-Simulation.
866+
- *Model Exchange and Co-Simulation* – Sets the FMI export type to Model Exchange and Co-Simulation.
866867

867-
- *FMU Name* – Sets a prefix for generated FMU file.
868+
- *FMU Name* – Sets a prefix for generated FMU file.
868869

869870
Debugger
870871
--------

0 commit comments

Comments
 (0)