mirrors/eiffel-org
1
0
Fork 0
mirror of https://github.com/EiffelSoftware/eiffel-org.git synced 2025-12-07 15:22:31 +01:00
Code Issues Packages Projects Releases Wiki Activity

Updated to upcoming 23.09

Browse Source 
git-svn-id: https://svn.eiffel.com/eiffel-org/trunk@2393 abb3cda0-5349-4a8f-a601-0c33ac3a8c38
This commit is contained in:
eifops
2023-09-25 09:13:12 +00:00
parent 246745930d
commit e2bb303f94
2975 changed files with 63910 additions and 342 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
documentation/23.09/eiffelstudio/eiffelstudio-reference/eiffelstudio-preferences/index.wiki Normal file
View File

@@ -0,0 +1,6 @@
[[Property:title|EiffelStudio Preferences]]
[[Property:weight|1]]
[[Property:uuid|780757a6-f04a-97d4-5069-d22328e6492f]]
Many of EiffelStudio's properties may be customized. A tool has been designed to help you set your preferences. <br/>
In this section, you will find a [[Preference window overview|description of this tool]]. You will also find [[Preferences Reference|an explanation of the different properties]] that may be modified by using it.

31
documentation/23.09/eiffelstudio/eiffelstudio-reference/eiffelstudio-preferences/preference-window-overview.wiki Normal file
View File

@@ -0,0 +1,31 @@
[[Property:title|Preference window overview]]
[[Property:weight|1]]
[[Property:uuid|52878474-02fd-c68f-0953-a785cac469c8]]
The preferences dialog provide the main table, a filter bar, a the bottom tool bar.
[[Image:dialogs-and-wizards--preferences-dialog]]
The table is used to display a grid with the preferences displayed in a tree or flat view.
There are several kinds of preferences:
* Boolean preferences : their possible values are "True" and "False". A check box will allow you to choose between both.
* Color preferences : Their value is represented by three integers, which are the RGB code of the color. You do not have to use RGB codes though. When you double-click such a preference a color chooser dialog will display, allowing you to change the color value.
* Font preferences : A font selection window will appear if you double-click the value label.
* Shortcut preferences : edit the value cell, and press the wanted shortcuts..
* Other preferences : They will be modified by typing their value directly into an editable text field.
If there is no message stating you need to restart EiffelStudio, changes will be taken into account immediately.
{{tip|below the table, you will find a text field with the internal name of the preference (for instance: ''editor.eiffel.auto-complete_...''). }}
{{tip|you can export preferences to xml file, and import from xml file, this can be convenient when reinstalling EiffelStudio). }}
{{warning|If you restore default preferences values by clicking on the "Restore Default" button, then ALL preferences will be reset. }}

46
documentation/23.09/eiffelstudio/eiffelstudio-reference/eiffelstudio-preferences/preferences-reference/debugger-preferences.wiki Normal file
View File

@@ -0,0 +1,46 @@
[[Property:title|Debugger Preferences]]
[[Property:weight|4]]
[[Property:uuid|79daaf39-447d-9437-8551-4ebbd78bd165]]
This category contains preferences that are specific to the EiffelStudio Debugger and the debugger tool. These preferences are: <br/>
{| border="1"
|-
| '''Label in the preferences window'''
| '''Complete Description'''
|-
| Critical stack depth
| Stack overflow detection: depth of stack at which execution will pause and ask whether it is ok to continue (only works in classic Eiffel).
|-
| Debug output evaluation
| Display DEBUG_OUTPUT.debug_output for objects whose base class inherits from DEBUG_OUTPUT.
|-
| Default displayed string size
| Default number of displayed characters of a STRING (increasing this value might slow down debugging).
|-
| Default expanded view size
| Default number of displayed characters in the expanded view (increasing this value might slow down debugging).
|-
| Default maximum stack depth
| Default number of call stack elements shown in Call Stack tool (-1 to show all of them).
|-
| Delay before cleaning objects grid
| Delay in milliseconds before cleaning the Objects tool view.
|-
| Dotnet debugger
| Which .NET debugger to launch.
|-
| Expanded display background color
| Background color for expanded display view (default is white, change it to better see white spaces in displayed text).
|-
| Generating type evaluation
| Display the base type of an object if enabled, otherwise just the base class (disabling it might speed up debugging).
|-
| Interrupt every n instructions
| Number of instructions that will be executed before interrupting the execution.
|-
| Max evaluation duration
| Number of seconds to wait before cancelling an evaluation.
|}

178
documentation/23.09/eiffelstudio/eiffelstudio-reference/eiffelstudio-preferences/preferences-reference/editor-preferences/eiffel-editor-preferences/index.wiki Normal file
View File

@@ -0,0 +1,178 @@
[[Property:title|Eiffel Editor Preferences]]
[[Property:weight|2]]
[[Property:uuid|0fd6b874-1a89-0acb-ee2e-47bab3b4c819]]
The Eiffel category under the main Editor category contains preferences for Eiffel specific editor values. For example, here you can customize the behavour of autocompletion in the editor, syntax completion on Eiffel keywords, or the colors of Eiffel keywords.
{| border="1"
|-
| '''Label in the preferences window'''
| '''Complete Description'''
|-
| Auto-complete brackets and parenthesis
| Brackets and parentheses are closed automatically?
|-
| Auto-complete quotes
| Quotes are closed automatically?
|-
| Auto auto-complete
| Auto complete appears automatically?
|-
| Auto-complete words
| Automatically completes words when a single best match is available?
|-
| Customized string 1
| User customized string.
|-
| Customized string 2
| User customized string.
|-
| Customized string 3
| User customized string.
|-
| Filter completion list
| Completion list entries are filtered based on matches?
|-
| Once and constant in upper
| Complete once and constants with a first upper case character?
|-
| Show ANY features
| ANY features appear in the feature call complete window?
|-
| Show completion signature
| Completion list shows feature signatures?
|-
| Show completion type
| Completion list shows return type?
|-
| Syntax complete enabled
| Enable syntax autocomplete?
|-
| Text mode is windows
| Text files format: True = Windows / False = UNIX.
|-
| Underscore is separator
| Underscore ' ' is a word separator?
|}
==Display Colors==
{| border="1"
|-
| '''Label in the preferences window'''
| '''Complete Description'''
|-
| Normal text color
| Foreground color for normal text.
|-
| Normal background color
| Background color for normal text.
|-
| Selection text color
| Foreground color for selected text.
|-
| Selection background color
| Background color for selected text.
|-
| String text color
| Foreground color for manifest strings.
|-
| String background color
| Background color for manifest strings.
|-
| Keyword text color
| Foreground color for keywords.
|-
| Keyword background color
| Background color for keywords.
|-
| Spaces text color
| Foreground color for spaces.
|-
| Spaces background color
| Background color for spaces.
|-
| Comments text color
| Foreground color for comments.
|-
| Comments background color
| Background color for comments.
|-
| Number text color
| Foreground color for numbers.
|-
| Number background color
| Background color for numbers.
|-
| Operator text color
| Foreground color for operators.
|-
| Operator background color
| Background color for operators.
|-
| Breakpoint background color
| Color for breakable marks and breakpoints.
|-
| Assertion tag text color
| Foreground color for assertion tags.
|-
| Assertion tag background color
| Background color for assertion tags.
|-
| Indexing tag text color
| Foreground color for indexing tags.
|-
| Indexing tag background color
| Background color for indexing tags.
|-
| Reserved text color
| Foreground color for reserved words.
|-
| Reserved background color
| Background color for reserved words.
|-
| Generic text color
| Foreground color for generics.
|-
| Generic background color
| Background color for generics.
|-
| Local text color
| Foreground color for locals.
|-
| Local background color
| Background color for locals.
|-
| Class text color
| Foreground color for classes.
|-
| Class background color
| Background color for classes.
|-
| Feature text color
| Foreground color for features.
|-
| Feature background color
| Background color for features.
|-
| Cluster text color
| Foreground color for clusters.
|-
| Cluster background color
| Background color for clusters.
|-
| Error text color
| Foreground color for errors.
|-
| Error background color
| Background color for errors.
|-
| Object text color
| Foreground color for objects.
|-
| Object background color
| Background color for objects.
|}

505
documentation/23.09/eiffelstudio/eiffelstudio-reference/eiffelstudio-preferences/preferences-reference/editor-preferences/eiffel-editor-preferences/syntax-automatic-completion-preferences/default-values-keyword-completion-preferences.wiki Normal file
View File

@@ -0,0 +1,505 @@
[[Property:title|Default values for keyword completion preferences]]
[[Property:weight|3]]
[[Property:uuid|17738f37-4f85-c762-4074-5add286c9281]]
This document contains the description of default completion for recognized keywords. The [[Keyword completion customization|syntax]] used is the one used to redefine keyword completion in the preferences. <br/>
Four tables list default values for each of the [[Keywords automatic completion preferences|four preferences]] attached to each keyword.
* Default value for [[Keywords automatic completion preferences|"Customized autocomplete (Space after keyword was typed)"]] <br/>
{| border="1"
|-
| '''Keyword'''
| '''Value'''
|-
| indexing
| "$cursor$"
|-
| class
| "$cursor$"
|-
| inherit
| "$cursor$"
|-
| creation
| "$cursor$"
|-
| feature
| "$cursor$"
|-
| is
| "$cursor$"
|-
| require
| "$cursor$"
|-
| require else
| "$cursor$"
|-
| local
| "$cursor$"
|-
| do
| "$cursor$end"
|-
| once
| "$cursor$end"
|-
| deferred
| "end$cursor$"
|-
| external
| ""$cursor$"end"
|-
| rescue
| "$cursor$"
|-
| ensure
| "$cursor$"
|-
| ensure then
| "$cursor$"
|-
| if
| "$cursor$then%N$indent$%T%N$indent$end"
|-
| then
| "$cursor$"
|-
| elseif
| "$cursor$then%N$indent$%T"
|-
| else
| "$cursor$"
|-
| inspect
| "$cursor$%N$indent$when then%N$indent$%T%N$indent$else%N$indent$%T%N$indent$end"
|-
| when
| "$cursor$then%N$indent$%T"
|-
| from
| "$cursor$%N$indent$until%N$indent$loop%N$indent$end"
|-
| variant
| "$cursor$"
|-
| until
| "$cursor$"
|-
| loop
| "$cursor$"
|-
| debug
| "$cursor$end"
|-
| check
| "$cursor$end"
|-
| rename
| "$cursor$"
|-
| redefine
| "$cursor$"
|-
| undefine
| "$cursor$"
|-
| select
| "$cursor$"
|-
| export
| "$cursor$"
|-
| Precursor
| "{$cursor$}"
|-
| create
| "$cursor$"
|-
| obsolete
| ""$cursor$""
|-
| invariant
| "$cursor$"
|-
| end
| "$cursor$"
|}
<br/>
* Default value for [[Keywords automatic completion preferences|"Customized autocomplete (Return after keyword was typed)"]] <br/>
{| border="1"
|-
| '''Keyword'''
| '''Return'''
|-
| indexing
| "%N$indent$%T$cursor$"
|-
| class
| "%N$indent$%T$cursor$"
|-
| inherit
| "%N$indent$%T$cursor$"
|-
| creation
| "%N$indent$%T$cursor$"
|-
| feature
| "%N$indent$%T$cursor$"
|-
| is
| "%N$indent$%T%T--$cursor$"
|-
| require
| "%N$indent$%T$cursor$"
|-
| require else
| "%N$indent$%T$cursor$"
|-
| local
| "%N$indent$%T$cursor$"
|-
| do
| "%N$indent$%T$cursor$%N$indent$end"
|-
| once
| "%N$indent$%T$cursor$%N$indent$end"
|-
| deferred
| "%N$indent$end$cursor$"
|-
| external
| "%N$indent$%T"$cursor$"%N$indent$end"
|-
| rescue
| "%N$indent$%T$cursor$"
|-
| ensure
| "%N$indent$%T$cursor$"
|-
| ensure then
| "%N$indent$%T$cursor$"
|-
| if
| "%N$indent$%T$cursor$%N$indent$then%N$indent$%T%N$indent$end"
|-
| then
| "%N$indent$%T$cursor$"
|-
| elseif
| "%N$indent$%T$cursor$%N$indent$then%N$indent$%T"
|-
| else
| "%N$indent$%T$cursor$"
|-
| inspect
| "%N$indent$%T$cursor$%N$indent$when then%N$indent$%T%N$indent$else%N$indent$%T%N$indent$end"
|-
| when
| "%N$indent$%T$cursor$%N$indent$then%N$indent$%T"
|-
| from
| "%N$indent$%T$cursor$%N$indent$until%N$indent$%T%N$indent$loop%N$indent$%T%N$indent$end"
|-
| variant
| "%N$indent$%T$cursor$"
|-
| until
| "%N$indent$%T$cursor$"
|-
| loop
| "%N$indent$%T$cursor$"
|-
| debug
| "%N$indent$%T$cursor$%N$indent$end"
|-
| check
| "%N$indent$%T$cursor$%N$indent$end"
|-
| rename
| "%N$indent$%T$cursor$"
|-
| redefine
| "%N$indent$%T$cursor$"
|-
| undefine
| "%N$indent$%T$cursor$"
|-
| select
| "%N$indent$%T$cursor$"
|-
| export
| "%N$indent$%T$cursor$"
|-
| Precursor
| "%N$indent$%T$cursor$"
|-
| create
| "%N$indent$%T$cursor$"
|-
| obsolete
| "%N$indent$%T"$cursor$""
|-
| invariant
| "%N$indent$%T$cursor$"
|-
| end
| "%N$indent$$cursor$"
|}
<br/>
* Default value for [[Keywords automatic completion preferences|"Customized autocomplete (Space, other cases)"]] <br/>
{| border="1"
|-
| '''Keyword'''
| '''Space'''
|-
| indexing
| "$cursor$"
|-
| class
| "$cursor$"
|-
| inherit
| "$cursor$"
|-
| creation
| "$cursor$"
|-
| feature
| "$cursor$"
|-
| is
| "$cursor$"
|-
| require
| "$cursor$"
|-
| require else
| "$cursor$"
|-
| local
| "$cursor$"
|-
| do
| "$cursor$"
|-
| once
| "$cursor$"
|-
| deferred
| "$cursor$"
|-
| external
| "$cursor$"
|-
| rescue
| "$cursor$"
|-
| ensure
| "$cursor$"
|-
| ensure then
| "$cursor$"
|-
| if
| "$cursor$"
|-
| then
| "$cursor$"
|-
| elseif
| "$cursor$"
|-
| else
| "$cursor$"
|-
| inspect
| "$cursor$"
|-
| when
| "$cursor$"
|-
| from
| "$cursor$"
|-
| variant
| "$cursor$"
|-
| until
| "$cursor$"
|-
| loop
| "$cursor$"
|-
| debug
| "$cursor$"
|-
| check
| "$cursor$"
|-
| rename
| "$cursor$"
|-
| redefine
| "$cursor$"
|-
| undefine
| "$cursor$"
|-
| select
| "$cursor$"
|-
| export
| "$cursor$"
|-
| Precursor
| "$cursor$"
|-
| create
| "$cursor$"
|-
| obsolete
| "$cursor$"
|-
| invariant
| "$cursor$"
|-
| end
| "$cursor$"
|}
<br/>
* Default value for [[Keywords automatic completion preferences|"Customized autocomplete (Return, other cases)"]] <br/>
{| border="1"
|-
| '''Keyword'''
| '''Return'''
|-
| indexing
| "%N$indent$$cursor$"
|-
| class
| "%N$indent$$cursor$"
|-
| inherit
| "%N$indent$$cursor$"
|-
| creation
| "%N$indent$$cursor$"
|-
| feature
| "%N$indent$$cursor$"
|-
| is
| "%N$indent$$cursor$"
|-
| require
| "%N$indent$$cursor$"
|-
| require else
| "%N$indent$$cursor$"
|-
| local
| "%N$indent$$cursor$"
|-
| do
| "%N$indent$$cursor$"
|-
| once
| "%N$indent$$cursor$"
|-
| deferred
| "%N$indent$$cursor$"
|-
| external
| "%N$indent$$cursor$"
|-
| rescue
| "%N$indent$$cursor$"
|-
| ensure
| "%N$indent$$cursor$"
|-
| ensure then
| "%N$indent$$cursor$"
|-
| if
| "%N$indent$$cursor$"
|-
| then
| "%N$indent$$cursor$"
|-
| elseif
| "%N$indent$$cursor$"
|-
| else
| "%N$indent$$cursor$"
|-
| inspect
| "%N$indent$$cursor$"
|-
| when
| "%N$indent$$cursor$"
|-
| from
| "%N$indent$$cursor$"
|-
| variant
| "%N$indent$$cursor$"
|-
| until
| "%N$indent$$cursor$"
|-
| loop
| "%N$indent$$cursor$"
|-
| debug
| "%N$indent$$cursor$"
|-
| check
| "%N$indent$$cursor$"
|-
| rename
| "%N$indent$$cursor$"
|-
| redefine
| "%N$indent$$cursor$"
|-
| undefine
| "%N$indent$$cursor$"
|-
| select
| "%N$indent$$cursor$"
|-
| export
| "%N$indent$$cursor$"
|-
| Precursor
| "%N$indent$$cursor$"
|-
| create
| "%N$indent$$cursor$"
|-
| obsolete
| "%N$indent$$cursor$"
|-
| invariant
| "%N$indent$$cursor$"
|-
| end
| "%N$indent$$cursor$"
|}
<br/>
{{seealso|<br/>
[[Keywords automatic completion preferences|Keywords automatic completion preferences]] <br/>
[[Keyword completion customization|Keyword completion customization]] <br/>
}}

6
documentation/23.09/eiffelstudio/eiffelstudio-reference/eiffelstudio-preferences/preferences-reference/editor-preferences/eiffel-editor-preferences/syntax-automatic-completion-preferences/index.wiki Normal file
View File

@@ -0,0 +1,6 @@
[[Property:title|Syntax automatic completion preferences]]
[[Property:weight|-1]]
[[Property:uuid|9899c28c-c7c9-8d0d-1e83-e0d1741c7f3c]]
EiffelStudio editor can detect many keywords and trigger an automatic syntax completion. <br/>
This section of the documentation contains a description of [[Keywords automatic completion preferences|what can be customized]]. You will also find an [[Keyword completion customization|explanation of the syntax]] to be used in completion preferences, [[Default values for keyword completion preferences|and their default values]].

91
documentation/23.09/eiffelstudio/eiffelstudio-reference/eiffelstudio-preferences/preferences-reference/editor-preferences/eiffel-editor-preferences/syntax-automatic-completion-preferences/keyword-completion-customization.wiki Normal file
View File

@@ -0,0 +1,91 @@
[[Property:title|Keyword completion customization]]
[[Property:weight|2]]
[[Property:uuid|5e41f619-9a27-d7a3-c722-07f7227c8952]]
This document describes the syntax used to customize keyword automatic completion. <br/>
[[Keywords automatic completion preferences|Four strings]] are used to define the completion of a keyword. The rules are the same for all of them:
* These strings will be inserted right after the keyword. The key that triggers the automatic completion will not be taken into account, i.e. no space or "new line" character will be inserted even though you press Space or Return. The strings should therefore begin with a space or a "new line" character (see below for "newline").
* Two reserved words will allow you to position the cursor and to indent the text properly. Insert the word ''$cursor$'' in the string where you want the cursor to be moved once the completion is finished. Insert the word ''$indent$'' where you want to copy as many blank spaces as there were on the line where the keyword was typed.
* Three special characters are available:
** ''%N'' represents the new line character.
** ''%T'' represents the tabulation
** ''%B'' represents the back space
<br/>
Examples :
1) You want the lines of code :
<code>
if
next_line_of_code
</code><br/>
to become:
<code>
if <cursor here> then
<one more tabulation>
end
next_line_of_code
</code>
as you press Space just after typing <code>if</code>.
To make this happen, you should define the "Customized auto complete (Space after keyword was typed)" string for <code>if</code> as :
<code lang="text">
$cursor$ then%N$indent$%T%N$indent$end
</code>
First, EiffelStudio editor has to insert a blank space after <code>if</code>. The string begins therefore by a blank space. <br/>
Then, ''$cursor$'' tells EiffelStudio to move the cursor to this position after the completion. <br/>
<code>then</code> is inserted after the cursor position. <br/>
''%N'' indicates that you want to insert a new line after <code>then</code>. <br/>
''$indent$%T'' means that this line is filled with as many blank spaces as there are before <code>if</code> plus a tabulation. <br/>
Another line is inserted with ''%N''. <br/>
Then ''$indent$end'' means that <code>end</code> will be inserted in this new line with the same indentation as <code>if</code>.
2) You want the lines of code :
<code>
end
next_line_of_code
</code>
to become:
<code>
end
next_line_of_code
</code>
as you press Return just after typing <code>end</code>.
To make this happen, you should define the "Customized auto complete (Return after keyword was typed)" string for <code>end</code> as :
<code lang="text">
%B%B%B%Bend%N$indent$%B$cursor$
</code>
The four ''%B'' will remove <code>end</code> plus one character before <code>end</code> (the tabulation character). <br/>
<code>end</code> will be inserted at this new position. <br/>
''%N'' indicates that you want to insert a new line. <br/>
''$indent$%B$cursor$'' means that the cursor will be moved to the end of the line where one less blank space than before the original <code>end</code> will have been inserted.
{{note|EiffelStudio editor can insert spaces instead of tabulation when you use special character ''%T''. This is set in [[General Editor Preferences|another section of the preferences]] .}}
{{seealso|<br/>
[[Keywords automatic completion preferences|Keywords automatic completion preferences]] <br/>
[[Default values for keyword completion preferences|Default values for keyword completion preferences]] <br/>
}}

74
documentation/23.09/eiffelstudio/eiffelstudio-reference/eiffelstudio-preferences/preferences-reference/editor-preferences/eiffel-editor-preferences/syntax-automatic-completion-preferences/keywords-automatic-completion-preferences.wiki Normal file
View File

@@ -0,0 +1,74 @@
[[Property:title|Keywords automatic completion preferences]]
[[Property:weight|1]]
[[Property:uuid|b54826e4-16f5-7ada-209c-4f7b77e02a29]]
==Description==
Keywords completion preferences can be found in the subdirectories of "Automatic completion" (located in "Editor" ->"Eiffel"). Keywords are located in subdirectories as described below :
* Class structure keywords:
** class
** creation
** feature
** indexing
** inherit
* Feature structure keywords
** is
** require
** require else
** local
** do
** deferred
** external
** rescue
** ensure
** ensure then
* Control structures keywords
** if
** then
** elseif
** else
** inspect
** when
** from
** variant
** until
** loop
** debug
** check
* Inherit clauses keywords
** rename
** redefine
** undefine
** select
** export
* Other keywords
** Precursor
** create
** obsolete
** invariant
** end
==Usage==
A directory is associated with each keyword. These directories contains six items which you may modify to customize the automatic completion of the keyword:
* Autocomplete <keyword>: If this is set to True, the automatic completion will be triggered when you type the keyword in the editor. If it is set to False, the keyword will be processed as a normal word.
* Use default autocomplete: If this is set to True, the next preferences will be ignored and the default completion scheme will be used. Otherwise, the automatic completion will use the user-defined strings described below.
* Customized autocomplete (Return after keyword was typed): This [[Keyword completion customization|string]] defines what will be inserted as you press Return just after typing the keyword if you chose not to use the [[Default values for keyword completion preferences|default value]] (see Use default autocomplete above).
* Customized autocomplete (Space after keyword was typed): This [[Keyword completion customization|string]] defines what will be inserted as you press Space just after typing the keyword if you chose not to use the [[Default values for keyword completion preferences|default value]] (see Use default autocomplete above).
* Customized autocomplete (Return, other cases): This [[Keyword completion customization|string]] defines what will be inserted as you press Return after a keyword which had been previously typed. It is effective only if you chose not to use the [[Default values for keyword completion preferences|default value]] (see Use default autocomplete above).
* Customized autocomplete (Space, other cases): This [[Keyword completion customization|string]] defines what will be inserted as you press Space after a keyword which had been previously typed. It is effective only if you chose not to use the [[Default values for keyword completion preferences|default value]] (see Use default autocomplete above).
The syntax used in the four last item is described in [[Keyword completion customization|Keyword completion customization]]. [[Default values for keyword completion preferences|Default values]] are accessible in Keyword completion default values.

120
documentation/23.09/eiffelstudio/eiffelstudio-reference/eiffelstudio-preferences/preferences-reference/editor-preferences/general-editor-preferences.wiki Normal file
View File

@@ -0,0 +1,120 @@
[[Property:title|General Editor Preferences]]
[[Property:weight|1]]
[[Property:uuid|37b448fb-37a8-7996-1a8a-35b4e74b17d0]]
General Preferences
{| border="1"
|-
| '''Label in the preferences window'''
| '''Complete Description'''
|-
| Automatic update
| Automatic update when the file has not been modified.
|-
| Blinking cursor
| Does text cursor blink?
|-
| Editor font
| All-purpose editor font.
|-
| Keyword font
| Keyword editor font.
|-
| Left margin width
| Width of left margin in editor. Note: this is not the breakpoint margin, but the whitespace to the left of the editor.
|-
| Mouse wheel scroll full page
| Mouse wheel scroll full page?
|-
| Mouse wheel scroll size
| Mouse wheel scroll size.
|-
| Quadruple click enabled
| Does a quadruple click select the entire document?
|-
| Scrolling common line count
| Number of common lines staying on screen after scrolling by one page up or down.
|-
| Show line numbers
| Indicates if editor displays the line numbers by default.
|-
| Smart indentation
| Should editor perform auto-indenting?
|-
| Tab step
| Number of spaces that a tabulation character represents.
|-
| Use buffered line
| Indicates if editor line drawing is first buffered and then drawn, or just drawn directly to the screen. If true scrolling will be smoother, but performance will be slower.
|-
| Use tab for indentation
| Should tab character be used for auto-indentation?
|}
Display Colors
{| border="1"
|-
| '''Label in the preferences window'''
| '''Complete Description'''
|-
| colors.normal_text_color
| Color for normal text.
|-
| colors.normal_background_color
| Background color for normal text.
|-
| colors.selection_text_color
| Color of selected text.
|-
| colors.selection_background_color
| Background color of selected text.
|-
| colors.string_text_color
| Color of string text.
|-
| colors.string_background_color
| Background color of string text.
|-
| colors.keyword_text_color
| Color of keyword text.
|-
| colors.keyword_background_color
| Background color of keyword text.
|-
| colors.spaces_text_color
| Color of space characters.
|-
| colors.spaces_background_color
| Background color of space characters.
|-
| colors.comments_text_color
| Color of comments text.
|-
| colors.comments_background_color
| Background color of comments text.
|-
| colors.operator_text_color
| Color of operator text.
|-
| colors.operator_background_color
| Background color of operator text.
|-
| colors.number_text_color
| Color of number text.
|-
| colors.number_background_color
| Background color of number text.
|-
| colors.margin_background_color
| Background color of line number margin.
|-
| colors.margin_separator_color
| Color of separator between line number margin and editor.
|-
| colors.line_number_text_color
| Color of line number text.
|}

5
documentation/23.09/eiffelstudio/eiffelstudio-reference/eiffelstudio-preferences/preferences-reference/editor-preferences/index.wiki Normal file
View File

@@ -0,0 +1,5 @@
[[Property:title|Editor Preferences]]
[[Property:weight|3]]
[[Property:uuid|fd7ec7c0-4c15-f2c2-70b7-82bc0a07a064]]
Some of the features of the EiffelStudio editor can be customized. This section of the documentation contains the necessary explanations to use the editor preferences. In addition to a description of [[General Editor Preferences|general preferences]] for the editor, you will find a document about [[Keyboard shortcuts preferences|user-definable keyboard shortcuts]] and a preferences for Eiffel specific preferences such as [[Syntax automatic completion preferences|automatic completion.]]

24
documentation/23.09/eiffelstudio/eiffelstudio-reference/eiffelstudio-preferences/preferences-reference/editor-preferences/keyboard-shortcuts-preferences.wiki Normal file
View File

@@ -0,0 +1,24 @@
[[Property:title|Keyboard shortcuts preferences]]
[[Property:weight|2]]
[[Property:uuid|1fbfc5fe-cbaf-9a55-cd5c-672f9b7a3e24]]
Some of the keyboard shortcuts used in the editor can be customized. A subfolder of the "Keyboard Shortcuts" folder in the editor preferences corresponds to each of these customizable shortcuts. There are four values to set to define a shortcut: which key must be pressed and whether <code>CTRL</code>, <code>ALT</code> or <code>SHIFT</code> have to be pressed at the same time. You will find a combination of all in each shortcut subfolder. The customizable shortcuts are:
* Autocomplete: Shortcut to trigger the feature call automatic completion. The default key combination is <code>CTRL</code>+<code>SPACE</code>.
* Class name autocomplete: Shortcut to trigger the class name automatic completion. The default key combination is <code>CTRL</code>+<code>SHIFT</code>+<code>SPACE</code>.
* Search selection: Shortcut to launch a search of the currently selected item. If there is no selected item, the editor will look for the next occurrence of the last searched pattern. The default key combination for this command is <code>F3</code>.
* Search again: Shortcut to move to the next occurrence of the searched pattern. If the shortcut is the same as for Search Selection, the effect of the command will be to search for the next occurrence of the currently searched pattern unless something else is selected in the editor. In that case, the editor will look for the next occurrence of the selected text. The default key combination for this command is <code>F3</code>.
* Search backwards: Shortcut to move to the previous occurrence of the searched pattern. The default key combination for this command is <code>SHIFT</code>+<code>F3</code>.
* Show search panel: Shortcut to make the search panel appear if it is not displayed and to give the focus to the "Search for" field. The default key combination for this command is <code>CTRL</code>+<code>F</code>.
* Show search and replace panel: Shortcut to make the search panel with the "Replace with" field appear if it is not displayed. The focus will be given to the "Search for" field. The default key combination for this command is <code>CTRL</code>+<code>H</code>.
{{note|You should avoid using key combinations made of only <code>ALT</code> and another key as they are reserved for menu shortcuts. }}
{{Tip|You may use combinations made of only one key to create very fast shortcuts, for example with the function keys. To know what string corresponds to a given key, you can look up in the EV_KEY_CONSTANTS of EiffelVision2.The `key_strings` table links keys with a string representation. }}
There are three other categories in the shortcut preferences. These can be used to automatically insert a user-defined string in the editor. If you find yourself typing some strings very often, these preferences can be handy.

111
documentation/23.09/eiffelstudio/eiffelstudio-reference/eiffelstudio-preferences/preferences-reference/eiffelstudio-tools-preferences/context-tools.wiki Normal file
View File

@@ -0,0 +1,111 @@
[[Property:title|Context Tools]]
[[Property:weight|1]]
[[Property:uuid|40300782-f154-3a13-acd4-ee48184be315]]
This category gathers the preferences related to context tools.
{| border="1"
|-
| '''Label in the preferences window'''
| '''Complete Description'''
|-
| Default class formatter index
| Class view format that is selected by default (see table below for available format indexes).
|-
| Default feature formatter index
| Feature view format that is selected by default (see table below for available format indexes).
|-
| Excluded indexing items
| Indexing items that need not be included in formatted texts.
|-
| Formatters history size
| Number of cached formatted text in history.
|-
| Show all callers
| Show all callers (as opposed to local callers) in `callers` form.
|}
Class views indices:
{| border="1"
|-
| '''Index'''
| '''Class view'''
|-
| 1
| Clickable view
|-
| 2
| Flat view
|-
| 3
| Contract view
|-
| 4
| Interface view
|-
| 5
| Ancestors
|-
| 6
| Descendants
|-
| 7
| Clients
|-
| 8
| Suppliers
|-
| 9
| Attributes
|-
| 10
| Routines
|-
| 11
| Deferred features
|-
| 12
| Once routines and constants
|-
| 13
| External features
|-
| 14
| Exported features
|}
Feature views indices:
{| border="1"
|-
| '''Index'''
| '''Feature view'''
|-
| 1
| Basic text view
|-
| 2
| Flat view
|-
| 3
| Callers
|-
| 4
| Implementers
|-
| 5
| Ancestor versions
|-
| 6
| Descendants versions
|-
| 7
| Homonyms
|}
{{seealso|<br/>
[[EiffelStudio Tools Preferences|Preferences for other tools]] }}

180
documentation/23.09/eiffelstudio/eiffelstudio-reference/eiffelstudio-preferences/preferences-reference/eiffelstudio-tools-preferences/eiffelstudio-diagram-tool-preferences.wiki Normal file
View File

@@ -0,0 +1,180 @@
[[Property:modification_date|Wed, 01 Jul 2020 08:37:22 GMT]]
[[Property:publication_date|Wed, 01 Jul 2020 08:37:22 GMT]]
[[Property:title|EiffelStudio Diagram Tool Preferences]]
[[Property:weight|2]]
[[Property:uuid|6e2eed8e-b225-0dee-5ea0-e4c25a0c3d5a]]
This category gathers the preferences related to the EiffelStudio BON Diagram tool. Preferences for BON notation are under the 'Bon' category and for UML notation are under the 'UML' category.
==General Preferences==
{| border="1"
|-
| '''Label in the preferences window'''
| '''Complete description'''
|-
| Ancestor depth
| Show ancestors of a class up to a level of preference value.
|-
| Autoscroll speed
| Speed for scrolling when dragging figures from diagram near the edge of the diagram tool (a valid value is between 0 and 100).
|-
| Client depth
| Show clients of a class up to a level of preference value.
|-
| Descendant depth
| Show descendants of a class down to a level of preference value.
|-
| Excluded class figures
| Names of classes that should not appear in generated diagrams.
|-
| Ignore excluded class figures
| Show ALL classes in the diagram (ignore the following list)?
|-
| Subcluster depth
| Show subclusters of a cluster down to a level of preference value.
|-
| Supercluster depth
| Show superclusters of a cluster up to a level of preference value.
|-
| Supplier depth
| Show suppliers of a class up to a level of preference value.
|}
==BON Preferences==
{| border="1"
|-
| Bon class name font
| Font for class names in BON class figures.
|-
| Bon class name color
| Color for class names in BON class figures.
|-
| Bon class fill color
| Color for BON class figures.
|-
| Bon class uncompiled fill color
| Color for uncompiled BON class figures.
|-
| Bon class generics font
| Font for generics in BON class figures.
|-
| Bon class generics color
| Color for generics in BON class figures.
|-
| Bon client label font
| Font for feature names on BON client supplier links.
|-
| Bon client label color
| Color for feature names on BON client supplier links.
|-
| Bon client color
| Color for BON client supplier links.
|-
| Bon client line width
| Line width for BON client supplier links.
|-
| Bon cluster line color
| Color for BON cluster line.
|-
| Bon cluster iconified fill color
| Iconified BON Cluster fill color.
|-
| Bon cluster name area color
| BON cluster name area fill color.
|-
| Bon cluster name color
| BON cluster name color.
|-
| Bon cluster name font
| BON cluster name font.
|-
| Bon inheritance color
| Color for BON inheritance links.
|-
| Bon inheritance line width
| Line width for BON inheritance links.
|}
==UML Preferences==
{| border="1"
|-
| Uml class name font
| Font for class names in UML class figures.
|-
| uml class deferred font
| Font for names of deferred classes in UML class figures.
|-
| Uml class properties font
| Font for class properties in UML class figures.
|-
| Uml class properties color
| Color for class properties in UML class figures.
|-
| Uml class name color
| Color for class names in UML class figures.
|-
| Uml class fill color
| Color for UML class figures.
|-
| Uml generics font
| Font for generics in UML class figures.
|-
| Uml generics color
| Color for generics in UML class figures.
|-
| Uml class features font
| Font for class features in UML class figures.
|-
| Uml class features color
| Color for class features in UML class figures.
|-
| Uml class feature section font
| Font for class feature sections in UML class figures.
|-
| Uml class feature section color
| Color for class feature sections in UML class figures.
|-
| Uml client line width
| Line width for UML client supplier links.
|-
| Uml client color
| Color for UML client supplier links.
|-
| Uml client label color
| Color for feature names on UML client supplier links.
|-
| Uml client label font
| Font for feature names on UML client supplier links.
|-
| Uml cluster line color
| Color for UML cluster line.
|-
| Uml cluster iconified fill color
| Iconified UML Cluster fill color.
|-
| Uml cluster name area color
| UML cluster name area fill color.
|-
| Uml cluster name color
| UML cluster name color.
|-
| Uml cluster name font
| UML cluster name font.
|-
| Uml inheritance line width
| Line width for UML inheritance links.
|-
| Uml inheritance color
| Color for UML inheritance links.
|}
{{seealso|<br/>
[[EiffelStudio Tools Preferences|Preferences for other tools]] }}

7
documentation/23.09/eiffelstudio/eiffelstudio-reference/eiffelstudio-preferences/preferences-reference/eiffelstudio-tools-preferences/index.wiki Normal file
View File

@@ -0,0 +1,7 @@
[[Property:title|EiffelStudio Tools Preferences]]
[[Property:weight|2]]
[[Property:uuid|76e278d3-c15d-43ba-ac79-611b05761b76]]
This section of the help deals with preferences related to a tool in particular. These preferences are distributed in two categories:
* A [[Context Tools]] category used to change preferences related to context tools.
* A [[EiffelStudio Diagram Tool Preferences|Diagram Tools]] category used to customize some features of the diagram tool, mainlycolors and fonts for graphical element display.

24
documentation/23.09/eiffelstudio/eiffelstudio-reference/eiffelstudio-preferences/preferences-reference/general-preferences.wiki Normal file
View File

@@ -0,0 +1,24 @@
[[Property:title|General Preferences]]
[[Property:weight|0]]
[[Property:uuid|cc42c410-bec5-4a4e-c45f-e005213cb260]]
General preferences are non-graphical preferences and preferences that are not related to a particular tool. These preferences are:
{| border="1"
|-
| '''Label in the preferences window'''
| '''Complete description'''
|-
| Acrobat Reader
| Command to read Adobe Acrobat files.
|-
| Shell command
| You may open a class in an external editor by dropping the corresponding pebble on the external editor icon. This preference sets which command line will be used to launch the external editor. The parameter "$target"will be replaced in the command with the file name corresponding to the class, "$line" with the line number if this information is relevant, with 1 otherwise.
|-
| Internet browser (GTK platforms only)
| This sets the command line that should be used to open an internet browser on a given HTML page. If present, "$url" will be replaced with the URL of the HTML page. This is used to display help files.
|}

5
documentation/23.09/eiffelstudio/eiffelstudio-reference/eiffelstudio-preferences/preferences-reference/index.wiki Normal file
View File

@@ -0,0 +1,5 @@
[[Property:title|Preferences Reference]]
[[Property:weight|2]]
[[Property:uuid|a93a61b7-4814-e8a8-0379-52c0012f5935]]
The top level preference categories for EiffelStudio preferences are listed below.

67
documentation/23.09/eiffelstudio/eiffelstudio-reference/eiffelstudio-preferences/preferences-reference/interface/development-window-preferences.wiki Normal file
View File

@@ -0,0 +1,67 @@
[[Property:title|Development Window Preferences]]
[[Property:weight|1]]
[[Property:uuid|b939459c-2ffe-4037-fb54-dd4bd61aa603]]
This category gathers a list of preferences related to the development window in EiffelStudio. <br/>
{| border="1"
|-
| '''Label in the preferences window'''
| '''Complete Description'''
|-
| Class completion
| Allow class name completion in the address combo boxes?
|-
| Ctrl right click receiver
| Receivers of control-right-click.
|-
| Dock tracking
| Docked tools track main window?
|-
| Editor left side
| Display editor on left? (Requires restart)
|-
| Expand feature tree
| Automatically expand the feature tree.
|-
| Feature clause order
| Order used to sort feature clauses in formatted texts.
|-
| Graphical output disabled
| Disable graphical output?
|-
| Left panel use explorer style
| Show only one tool (Features, Clusters, Search, Windows) at a time. (Requires restart)
|-
| Maximum history size
| Maximum number of items displayed in the history combo boxes.
|-
| Progress bar color
| Color for progress bar.
|-
| Remember completion list size
| Should size of completion list be remembered between completions in the editor?
|-
| Search tool show_options
| Should search tool be shown?
|-
| Show address toolbar
| Should address toolbar be shown?
|-
| Show all text in general toolbar
| Is text of toolbar items displayed?
|-
| Show general_toolbar
| Should general toolbar be shown?
|-
| Show project toolbar
| Should project toolbar be shown?
|-
| Show text in general_toolbar
| Should text be shown in general toolbar?
|-
| Unified stone
| Link the context tool with other components by default?
|}

8
documentation/23.09/eiffelstudio/eiffelstudio-reference/eiffelstudio-preferences/preferences-reference/interface/discardable-dialogs.wiki Normal file
View File

@@ -0,0 +1,8 @@
[[Property:title|Discardable dialogs]]
[[Property:weight|2]]
[[Property:uuid|c2e96013-d767-22a0-f5c3-2ecd8d3c66b1]]
Some dialogs in EiffelStudio include a check box labeled "Do not show me again". If you select it, the dialog will not be shown the next time the same situation occurs. The "dialogs" sub-category of "Interface" in the preferences lists the state of those discardable dialogs: a boolean preference is associated with each of them. The window will be shown if and only if the corresponding preference is set to True.

5
documentation/23.09/eiffelstudio/eiffelstudio-reference/eiffelstudio-preferences/preferences-reference/interface/index.wiki Normal file
View File

@@ -0,0 +1,5 @@
[[Property:title|Interface]]
[[Property:weight|1]]
[[Property:uuid|e0fe1870-cf02-4ca9-e46a-e69c8db1ed48]]
This section of the documentation describes preferences that belong to the "Interface" category. This group contains two kinds of properties, some related to the preferences for the EiffelStudio [[Development Window Preferences|development window]], others that define which [[Discardable dialogs|dialog windows]] should or should not be displayed. You can also decide to use animated icons in the status bars whenever possible (that is, during compilations and executions).

19
documentation/23.09/eiffelstudio/eiffelstudio-reference/eiffelstudio-preferences/preferences-reference/recent-project-preferences.wiki Normal file
View File

@@ -0,0 +1,19 @@
[[Property:title|Recent Project Preferences]]
[[Property:weight|5]]
[[Property:uuid|ab64bb5a-5c92-bd3c-b6d4-c31361d4fd1d]]
This category gathers a list of recently opened projects in EiffelStudio. It also let's you decide how many recently opened projects to store in the list: <br/>
{| border="1"
|-
| '''Label in the preferences window'''
| '''Complete description'''
|-
| Keep n projects
| This integral preference defines the maximum number of entries that should be displayed in the '''File/Recent projects''' menu.
|-
| Last opened projects
| A semi-colon separated list of the actual recently opened project
|}