Skip to content

Commit 034de72

Browse files
Added Editor section and issues
1 parent 5c1321b commit 034de72

1 file changed

Lines changed: 44 additions & 4 deletions

File tree

README.md

Lines changed: 44 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,16 @@ This product is intended for digital use only. It is prohibited to copy or distr
1010

1111
## Usage
1212

13+
#### The basics
14+
1315
Choose the shape you want to calculate features by clicking the corresponding image or name.
1416
You'll be redirected to the dedicated page where you can insert available data on the *_Dimensional data_* and *_Material data_* tables (blue tables).
1517

1618
Wether results will be available while inserting data, they will show in the bottom tables (orange tables).
17-
e.g.: If you're looking for the area of a rectangle as the base **and** the height will be filled in you'll have the result otherwise the field will be null.
19+
e.g.: If you're looking for the area of a rectangle as the base **and** the height will be filled in you'll have the result otherwise the field will be empty.
1820

1921
You can use the arrows on the right side of any input field to raise or decrease it by 1 unit, for your convenience.
20-
For a quicker input process, is suggested to use the _Tab_ key to jump on the next input field.
22+
For a quicker input process, it is suggested to use the _Tab_ key to jump on the next input field.
2123

2224
Results updates trigger whenever **one** of these events occur:
2325

@@ -32,23 +34,60 @@ All texts and numbers on the pages are able to be copied and pasted anywhere you
3234

3335
A button for getting back to the main page is provided on every profile page, directly below its title.
3436

37+
#### Equation page
38+
3539
The equations page is intuitive to use: clicking the shape from the list on the left makes the math for that shape visible.
3640
Some other extra features from MathJax library are also available when right-clicking on a equation, like the ability of zooming the expression or copying the LaTex string for further use.
3741

42+
#### Expression Editor
43+
44+
The core new feature from version 1.4 is the Expression Editor.
45+
This editor allows the user to quickly calculate the result of a mathematical expression and use it as a data input for the shape calculation process.
46+
47+
Any numerical input field from the *_Dimensional data_* and *_Material data_* tables (blue ones) can be used as targets for the expression calculation, in any of the shape pages.
48+
The Editor can be opened by pressing the "=" key on the keyboard while the related numerical input is selected.
49+
50+
A popup with the Editor itself will appear over the content, showing:
51+
- the variable selected to be the target for the result,
52+
- an empty text field for the expression,
53+
- the result preview of the expression,
54+
- an icon indicating if any errors are detected in the expression
55+
56+
Start typing the math expression in the text field and the preview will be updated in real time. Characters allowed for a correct calculation are digits from 0 to 9 and _. + - * / ( )_. Use the dot _"."_ as the decimal separator.
57+
58+
The editor can be left anytime by clicking the top-right X icon or pressing "Esc" on the keyboard and no action will be performed.
59+
60+
If the result of the typed expression is valid (green check icon after the result preview) it can be pasted in the related data input of the shape page. To use it, click the _"Use result"_ button on the bottom of the popup, or type "Enter" on the keyboard when the expression field is selected.
61+
62+
The result will be pasted into the table and the popup disappears. This can be used multiple times in any page.
63+
3864
## Known bugs and issues
3965

4066
#### Ellipse perimeter not exact
4167

4268
The formula used to get the perimeter is not an exact calculation, however is roughly the best approximation available.
4369
Notice that the more "squished" the ellipse, the more imprecise the result.
44-
The formula has been updated to a better one - this one - in version 1.2 and the approximation is totally suitable for the intended use of this tool.
70+
The formula has been updated to a better one - the actual one - in version 1.2 and the approximation is totally suitable for the intended use of this tool.
4571
This might mean that it won't be upgraded to an even more precise calculation (infinite series are not infinite in programming).
4672

4773
#### Truncated material names
4874

4975
When a material is selected from the dropdown menu, often the name overflows the space available.
5076
The issue will be solved in a future release.
5177

78+
#### Expression Editor
79+
80+
When the Editor is opened trough the "=" key, the expression text input is meant to be focused automatically.
81+
This should avoid moving hands to get back to the mouse and to the keyboard again, but something didn't work as expected.
82+
83+
If something is typed in the expression input field, if all characters in it are deleted, the result will be marked as "undefined".
84+
This result can also be pasted into the related data input, but nothing will happen as they're numerical inputs.
85+
86+
When confirming the result of the editor to be pasted in the data, results are not calculated with the new number.
87+
The page starts calculating again when another data is entered by directly typing the number, the ìn pressing Enter, Tab or clicking away.
88+
89+
All these issues will be fixed in a future patch.
90+
5291
## Next improvements to be added
5392

5493
Note: _The order of this list might not match the order these features will be added through next versions._
@@ -68,7 +107,8 @@ _Release date: October 22, 2021_
68107

69108
_Work Time: 8h_
70109

71-
-
110+
- Added the Expression Editor, where math expressions can be calculated and the result can be pasted as a data input
111+
- Some bugs related to the development of the Editor are still unfixed, but anyway it can be used correctly
72112

73113
#### v1.3
74114

0 commit comments

Comments
 (0)