Skip to content
This repository was archived by the owner on Aug 31, 2021. It is now read-only.

Commit f1bd3b5

Browse files
peter-bpeter-b
committed
docs: Formatting and syntax improvements to engine release notes
1 parent 3cf8417 commit f1bd3b5

18 files changed

+241
-101
lines changed

‎docs/notes/bugfix-15097.md‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1-
# Ensure 'the effective rect of stack' is more accurate on Linux
1+
---
2+
version: 8.0.0-dp-9
3+
---
4+
# Make "the effective rect of stack" more accurate on Linux
25

3-
With the move to GDK since 7.0 there is a better method for computing the effective rect of a window. The engine has been updated to use this method, rather than the heuristic which was there before.
6+
Because the engine began using GDK on Linux in LiveCode 7.0, there is
7+
now a better method for computing the **effective rect** of a
8+
window. The engine has been updated to use this method, rather than
9+
the heuristic which was there before.

‎docs/notes/bugfix-15129.md‎

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,21 @@
11
---
22
version: 8.0.0-dp-5
33
---
4-
# LCS-Widget: Add 'popup widget' command
4+
# New "popup widget" command
55

6-
Syntax: `popup widget <kind> [ at <location> ] [ with properties <propertyArray> ]`
6+
A new **popup widget** command has been added which opens a widget
7+
within a popup window. The syntax is:
78

8-
Summary: Opens a widget within a popup window.
9+
popup widget <kind> [ at <location> ] [ with properties <propertyArray> ]
910

10-
Example:
11+
For example, this command can be used to show a color picker widget as
12+
a popup:
1113

1214
local tProps
13-
// Set the size of the popup
15+
-- Set the size of the popup
1416
put "0,0,120,50" into tProps["rect"]
15-
// Set the initial color value
17+
-- Set the initial color value
1618
put "1,1,0.5" into tProps["initialColor"]
1719

18-
// Show the widget in a popup window
20+
-- Show the widget in a popup window
1921
popup widget "com.example.mycolorpicker" at the mouseloc with properties tProps

‎docs/notes/bugfix-15855.md‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
1-
# Native string operations are much slower compared to 6.7
2-
3-
The performance of native string operations has been vastly improved
4-
with many achieving similar speeds to those in 6.7.
1+
---
2+
version: 8.0.0-dp-10
3+
---
4+
# Native string operations are much faster compared to LiveCode 7
55

6+
The performance of native string operations has been vastly improved,
7+
with many achieving similar speeds to those in LiveCode 6.7.

‎docs/notes/bugfix-16272.md‎

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,21 @@
1-
# Ignore clicks to menu items that open submenus
1+
---
2+
version: 8.0.0-dp-8
3+
---
4+
# Changed behaviour of submenu menu items
25

36
Previously, clicks to menu items that open submenus would dismiss
4-
the menu and send a 'mouseRelease' message. Unfortunately, this
7+
the menu and send a **mouseRelease** message. Unfortunately, this
58
did not match the conventions of modern user interfaces where
69
these clicks are ignored. This can be seen on OSX where the
710
system's menus are used instead of being emulated by LiveCode.
811

912
Now, clicking on the item that anchors a submenu will send the
10-
'mouseRelease' message as before but, if that message is not
11-
handled or is passed, the click will be ignored and the menu
12-
will remain on-screen.
13+
**mouseRelease** message as before but, if that message is not handled
14+
or is passed, the click will be ignored and the menu will remain
15+
on-screen.
1316

14-
To restore the old behaviour, handle the 'mouseRelease' message
17+
To restore the old behaviour, handle the **mouseRelease** message
1518
without passing. To add the new behaviour to existing code that
16-
handles the 'mouseRelease' message, add a 'pass' command to the
19+
handles the **mouseRelease** message, add a **pass** command to the
1720
end of the handler.
1821

‎docs/notes/bugfix-16294.md‎

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
1+
---
2+
version: 8.0.0-dp-11
3+
---
14
# Improve printing on Linux
25

3-
The Linux printing commands now use revpdfprinter to generate a PDF to
4-
send through the system printing process.
6+
The Linux printing commands now use the revpdfprinter external to
7+
generate a PDF to send through the system printing process.
58

69
Among other things, this means that there is now full support for Unicode
710
text.
811

9-
Note: To use printing on Linux in standalones you must now make sure you
10-
include revpdfprinter - make sure the appropriate checkbox is hilited in
11-
the standalone builder.
12+
**Note:** To use printing on Linux in standalones you must now make
13+
sure you include revpdfprinter. Make sure the appropriate checkbox is
14+
highlighted in the standalone builder.

‎docs/notes/bugfix-16474.md‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1+
---
2+
version: 8.0.0-dp-11
3+
---
14
# Make odd numbers of dashes work properly.
25

3-
If the dashes property of a graphic was set to an odd number
4-
of items, then the pattern would not replicate correctly.
6+
If the **dashes** property of a graphic was set to an odd number of
7+
items, then the pattern would not replicate correctly.

‎docs/notes/feature-datagrid_inclusion.md‎

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,15 @@
1+
---
2+
version: 8.0.0-dp-8
3+
---
14
# DataGrid added to the Standalone Settings script libraries list
25

3-
Formerly, the DataGrid library was only included in a standalone application if the stack saved as a standalone was using a DataGrid.
6+
Formerly, the DataGrid library was only included in a standalone
7+
application if the stack saved as a standalone was using a DataGrid.
8+
When the stack saved did not use DataGrid, but loaded a stack which
9+
used it, the DataGrid library was not saved with the standalone, and
10+
the DataGrid would not work in the loaded stack.
411

5-
This have been causing issues, in case the stack saved does not use DataGrid, but loads a stack which uses it: the DataGrid library was not saved with the standalone, and the DataGrid would not work in the loaded stack.
6-
7-
To tackle this issue, we have added 'DataGrid' in the list of Script Libraries in the Standalone Settings. You can now force the inclusion of the DataGrid library, to ensure that any stack loaded by the standalone can use DataGrids.
8-
12+
To correct this, "DataGrid" has been added to the list of "Script
13+
Libraries" in the "Standalone Settings" dialog. You can now force the
14+
inclusion of the DataGrid library, to ensure that any stack loaded by
15+
the standalone can use DataGrids.

‎docs/notes/feature-documentFilename.md‎

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
1-
# documentFilename property
1+
---
2+
version: 8.0.0-dp-9
3+
---
4+
# New "documentFilename" stack property
25

36
A new property has been added to specify the file path to the file that a stack
47
represents.
58

6-
On mac setting the documentFilename property will set the represented filename
7-
of the window. The window will show an icon for the file next to the window
8-
title.
9+
On Mac OS X, setting the **documentFilename** property will set the
10+
represented filename of the window. The window will show an icon for
11+
the file next to the window title.
912

10-
On other platforms there is no visual representation of the association between
11-
the stack and the document file but the property may still be used to manage
12-
the association.
13+
On other platforms there is no visual representation of the
14+
association between the stack and the document file, but the property
15+
may still be used to manage the association.

‎docs/notes/feature-emscripten.md‎

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,16 @@
1-
# Support for the web platform using HTML5 (experimental)
1+
---
2+
version: 8.0.0-dp-4
3+
---
4+
# New HTML5 deployment platform for LiveCode apps (experimental)
25

3-
The LiveCode engine will now run in web browsers that support HTML5. This means that you can now deploy simple LiveCode apps to users without any installation required.
6+
The LiveCode engine will now run in web browsers that support HTML5.
7+
This means that you can now deploy simple LiveCode apps to users
8+
without any installation required.
49

5-
To deploy a stack as an HTML5 application, enable the "Build for HTML5" checkbox on the "HTML5" page of the standalone settings window, and then generate the standalone in the normal way.
10+
To deploy a stack as an HTML5 application, enable the "Build for
11+
HTML5" checkbox on the "HTML5" page of the standalone settings window,
12+
and then generate the standalone in the normal way.
613

7-
For more information on HTML5 deployment, including options for embedding LiveCode standalones in web pages, please see the "HTML5 Deployment" guide in the IDE dictionary.
14+
For more information on HTML5 deployment, including options for
15+
embedding LiveCode standalones in web pages, please see the "HTML5
16+
Deployment" guide in the IDE dictionary.

‎docs/notes/feature-external_resize_handles.md‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
# Resize handles outside object rect
1+
---
2+
version: 8.0.0-dp-8
3+
---
4+
# Position resize handles outside object rectangle
25

3-
The resize handles of a selected object are now outside the rect of the object. Moreover
4-
the minimum width and height of an object when resizing via handles has been removed.
6+
The resize handles of a selected object are now outside the rect of
7+
the object. There is no longer a minimum width and height of an object
8+
when resizing via handles.

0 commit comments

Comments
 (0)