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

Commit 3d392ac

Browse files
livecodepanoslivecodepanos
committed
Merge remote-tracking branch 'upstream/develop-9.0' into merge-develop-9.0-23.07.2019
2 parents 20e880a + 13eaa38 commit 3d392ac

39 files changed

+197
-181
lines changed

‎docs/dictionary/command/print-link.lcdoc‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,24 +30,24 @@ Description:
3030
Use the print link command to define a hyperlink within a pdf printing
3131
loop.
3232

33-
If the url adjective is specified, then <link> is interpreted as a URL
33+
If the url adjective is specified, then *linkName* is interpreted as a URL
3434
and an external URL launching link is created in the PDF document. The
3535
given rectangle jumps to that URL when it is clicked.
3636

37-
If the anchor adjective is specified, then <link> is interpreted as an
37+
If the anchor adjective is specified, then *linkName* is interpreted as an
3838
internal anchor name, as specified by the print anchor command, and an
3939
internal anchor link is created in the PDF document. Clicking the given
4040
rectangle jumps to that anchor.
4141

42-
If no adjective is specified then <link> is interpreted as a URL if it
42+
If no adjective is specified then *linkName* is interpreted as a URL if it
4343
begins with (ASCII) letters followed by a colon. e.g. "mailto:foobar" is
4444
interpreted as a URL, whereas "mail-to-anchor:foo" is interpreted as an
4545
anchor name.
4646

4747
When printing fields, any text that has its <linkText> property set
4848
together with the link <textStyle> is treated as if a print link command
49-
had been executed with the contents of the property as <link>, and the
50-
<formattedRect> of the text as <rectangle>.
49+
had been executed with the contents of the property as *linkName*, and the
50+
<formattedRect> of the text as *rectArea*.
5151

5252
References: print bookmark (command), print anchor (command),
5353
open printing to pdf (command), cancel printing (command),

‎docs/dictionary/command/put.lcdoc‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,14 +47,15 @@ The result:
4747
>*Important:* If writing to a url container fails, an error is returned
4848
> in the result. For example:
4949

50-
<put> the result into tResult.
50+
local tResult
51+
<put> the result into tResult
5152

5253
> *Note:* Unlike its use with the <file> and <binfile URL> types, the
5354
> <put> <command>, when used with a <resfile>, does not create the <file>
5455
> if it doesn't exist. Instead, an error message is returned in the
5556
> <result>. To create a file, first use a statement like the following:
5657

57-
<open file> tFilepath
58+
open file tFilepath
5859

5960
> When used with an ftp <URL>, <upload|uploads> the <value> to an
6061
> <FTP> <server>. If an error occurs during uploading, the

‎docs/dictionary/command/rename.lcdoc‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,9 @@ on the same volume.
4242
> rename or move <files> and <folders> it didn't create without
4343
> obtaining explicit confirmation from the user.
4444

45+
>*Warning:* If a file with the same file path as the newPath already exists,
46+
> that file will be overwritten without confirmation.
47+
4548
Changes:
4649
The ability to move a file or folder on Mac OS and Windows systems with
4750
the rename command was introduced in version 1.1.1. In previous

‎docs/dictionary/command/reply.lcdoc‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Syntax: reply error <string>
88

99
Summary:
1010
<return|Returns> data to an application that sent LiveCode an
11-
<Apple event>.
11+
<Apple Event>.
1212

1313
Introduced: 1.0
1414

@@ -65,9 +65,10 @@ is equivalent to
6565
reply string with keyword "errs"
6666

6767

68-
For more information about Apple events, see Apple Computer's technical
69-
documentation, Inside Macintosh: Interapplication Communication, located
70-
at http://developer.apple.com/techpubs/mac/IAC/IAC-2.html.
68+
For more information about Apple events, refer to the section entitled
69+
"Apple Events Sent by the Mac OS" in the technical documentation section
70+
located on [Apple's website]
71+
(http://developer.apple.com/documentation/coreservices/apple_events).
7172

7273
References: send to program (command), return (constant),
7374
Apple Event (glossary), command (glossary), return (glossary),

‎docs/dictionary/command/request-appleEvent.lcdoc‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Type: command
77
Syntax: request appleEvent {class|ID|sender|returnID|data [with keyword <aeKey>]}
88

99
Summary:
10-
Gets data about an <Apple event> that was sent to LiveCode.
10+
Gets data about an <Apple Event> that was sent to LiveCode.
1111

1212
Introduced: 1.0
1313

@@ -73,7 +73,7 @@ specify which pieces you want to get.
7373
For more information about Apple events, refer to the section entitled
7474
"Apple Events Sent by the Mac OS" in the technical documentation section
7575
located on [Apple's website]
76-
(https://developer.apple.com/library/archive/documentation/Cocoa/Conceptual/ScriptableCocoaApplications/SApps_handle_AEs/SAppsHandleAEs.html#//apple_ref/doc/uid/20001239-1117769).
76+
(https://developer.apple.com/documentation/coreservices/apple_events).
7777

7878
References: send to program (command), handler (glossary),
7979
Apple Event (glossary), variable (glossary), command (glossary),

‎docs/dictionary/command/request.lcdoc‎

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ Type: command
55
Syntax: request <expression> {of | from} {program | application} <programAddress>
66

77
Summary:
8-
The <request> data gets information from another application via <Apple
9-
Event|Apple events>.
8+
The <request> data gets information from another application via
9+
<Apple Event|Apple Events>.
1010

1111
Introduced: 1.0
1212

@@ -34,10 +34,10 @@ omit the zone. If the other program is running on the same computer, you
3434
can omit both the zone and the computer name.
3535

3636
It:
37-
If the program supports this <Apple event>, it evaluates the expression
37+
If the program supports this <Apple Event>, it evaluates the expression
3838
and sends the result back to LiveCode, which places it in the <it>
39-
<variable>. The <request> <command> sends aneval <Apple event> to the
40-
<programAddress>. If the program supports this <Apple event>, it
39+
<variable>. The <request> <command> sends aneval <Apple Event> to the
40+
<programAddress>. If the program supports this <Apple Event>, it
4141
evaluates the expression and sends the result back to LiveCode, which
4242
places it in the <it> <variable>.
4343

@@ -49,11 +49,12 @@ the result <function>.
4949

5050
Description:
5151
Use the <request> <command> to obtain data from another application via
52-
the eval <Apple event>.
52+
the eval <Apple Event>.
5353

54-
For more information about Apple events, see Apple Computer's technical
55-
documentation, Inside Macintosh: Interapplication Communication, located
56-
at [Apple's developer site](https://developer.apple.com/library/archive/documentation/mac/IAC/IAC-2.html)
54+
For more information about Apple events, refer to the section entitled
55+
"Apple Events Sent by the Mac OS" in the technical documentation section
56+
located on [Apple's website]
57+
(https://developer.apple.com/documentation/coreservices/apple_events).
5758

5859
References: send to program (command), function (control structure),
5960
command (glossary), variable (glossary), Apple Event (glossary),

‎docs/dictionary/command/revExecuteSQL.lcdoc‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,9 @@ was opened.
3030

3131
SQLStatement (string):
3232
A string in Structured Query Language. (Do not include a semicolon at
33-
the end of the SQLStatement.) >*Note:* Some database systems, such as
34-
Oracle, are capable of handling a multiple-line SQL statement.
33+
the end of the SQLStatement.)
34+
> *Note:* Some database systems, such as
35+
> Oracle, are capable of handling a multiple-line SQL statement.
3536

3637
variablesList:
3738
The variablesList consists of one or more variable names (or expressions
@@ -41,9 +42,10 @@ name may also be the name of an array element, for example
4142

4243
arrayName (array):
4344
The name of a single array variable whose keys are sequential
44-
numbers.>*Note:* The variable names or arrayName must be enclosed in
45-
quotes; otherwise, the variable's value rather than its name is passed
46-
to the revExecuteSQL command.
45+
numbers.
46+
> *Note:* The variable names or arrayName must be enclosed in
47+
> quotes; otherwise, the variable's value rather than its name is passed
48+
> to the revExecuteSQL command.
4749

4850

4951
The result:
@@ -66,8 +68,7 @@ each of these placeholders. For example, if you have two
6668
<variable|variables> called "valueX" and "valueY", you can use a
6769
<SQLStatement> that includes placeholders as follows:
6870

69-
revExecuteSQL myID, "insert into mytable values(:1,:2,:1)", "valueX"
70-
,"valueY"
71+
revExecuteSQL myID, "insert into mytable values(:1,:2,:1)", "valueX","valueY"
7172

7273
The content of the variable valueX is substituted for the ":1" in the
7374
SQLQuery (in both places where ":1" appears), and the content of valueY
@@ -78,17 +79,16 @@ is substituted for ":2".
7879
> syntax error to be returned by the database because a placeholder is
7980
> being used to represent a column name (:1).
8081

81-
-- Invalid, will cause SQL syntax error
82-
revExecuteSQL myID,
83-
"insert into mytable(:1, name, date) values (:2, :3, :2)",
84-
"tColumnName", "tValueX", "tValueY"
82+
-- Invalid, will cause SQL syntax error
83+
revExecuteSQL myID,
84+
"insert into mytable(:1, name, date) values (:2, :3, :2)", "tColumnName", "tValueX", "tValueY"
8585

8686
If you specify an <arrayName> rather than a list of ordinary
8787
<variable|variables>, the <revExecuteSQL> <command> substitutes the
8888
corresponding <element> of the <array> for each of the placeholders in
8989
the query:
9090

91-
revExecuteSQL myID,"insert into mytable values(:1,:2,:1)","myArray"
91+
revExecuteSQL myID,"insert into mytable values(:1,:2,:1)","myArray"
9292

9393
The content of the element myArray[1] is substituted for the ":1" in the
9494
SQLQuery (in both places where ":1" appears), and the content of

‎docs/dictionary/command/revInitializeVideoGrabber.lcdoc‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -59,8 +59,8 @@ To use <VFW|Video for Windows> (on <Windows|Windows systems>), specify
5959
"VFW".
6060

6161
To close the window and unload the video capture code, you should use
62-
the <revCloseVideoGrabber> <command> when you're done with <video
63-
capture>.
62+
the <revCloseVideoGrabber> <command> when you're done with
63+
<video capture>.
6464

6565
>*Important:* The <revInitializeVideoGrabber> <command> is part of the
6666
> <Video library>. To ensure that the <command> works in a
@@ -87,9 +87,9 @@ revStopPreviewingVideo (command), stack window (glossary),
8787
video capture (glossary), Windows (glossary), VFW (glossary),
8888
Standalone Application Settings (glossary), video grabber (glossary),
8989
standalone application (glossary), function (glossary),
90-
command (glossary), LiveCode custom library (glossary), file (keyword),
91-
Video library (library), properties (property), dontUseQT (property),
92-
dontUseQTEffects (property)
90+
command (glossary), LiveCode custom library (glossary),
91+
QuickTime (glossary), file (keyword), Video library (library),
92+
properties (property), dontUseQT (property), dontUseQTEffects (property)
9393

9494
Tags: multimedia
9595

‎docs/dictionary/command/revMail.lcdoc‎

Lines changed: 20 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,18 @@ messageBody (string):
4242
This text appears in the 'body' of the email message.
4343

4444
The result:
45-
On return on iOS, the result is set to one of:. On return on Android,
46-
the result is set to:. * unknown - On Android the email activity does
47-
not return its status back to the calling activity so the result is set
48-
to 'unknown' in all cases.
45+
On return on iOS, the result is set to one of:
46+
* not configured - if the user has turned off or has not setup mail
47+
access on their device
48+
* cancel - if the user chooses to cancel the send
49+
* saved - if the user chose to save the message in drafts
50+
* sent - if the user elected to send the email
51+
* failed - if sending the email was attempted, but it failed
52+
53+
On return on Android, the result is set to:
54+
* unknown - On Android the email activity does not return its status
55+
back to the calling activity so the result is set to 'unknown' in all
56+
cases.
4957

5058
Description:
5159
Use the <revMail> <command> to create an email message from within a
@@ -54,8 +62,8 @@ Use the <revMail> <command> to create an email message from within a
5462
When LiveCode executes the <revMail> <command>, the user's email program
5563
is opened (if necessary) and a new email message with the specified
5664
<parameter|parameters> is created. The user can change any of the
57-
settings before sending the message, and the message is not sent
58-
automatically: the user must explicitly send it (for example, by
65+
settings before sending the message, and the message is not
66+
sent automatically: the user must explicitly send it (for example, by
5967
clicking a 'Mail' button in the email program).
6068

6169
On Mac OS systems, the mail message is opened in the application the
@@ -64,14 +72,6 @@ user has set for the 'mailto:' protocol in the Internet control panel
6472

6573
On iOS, <revMail> hooks into the iOS MessageUI framework.
6674

67-
* not configured - if the user has turned off or has not setup mail
68-
access on their device
69-
* cancel - if the user chooses to cancel the send
70-
* saved - if the user chose to save the message in drafts
71-
* sent - if the user elected to send the email
72-
* failed - if sending the email was attempted, but it failed
73-
74-
7575
>*Important:* On <Mac OS|Mac OS systems>, the <revMail> <command>
7676
> requires that AppleScript be installed and that the GURL <Apple Event>
7777
> be supported. GURL support is included in <Mac OS> 8.5 or later, and
@@ -86,9 +86,9 @@ For some older email programs, it may not be possible to specify a
8686
<command> still works with such programs, but only the 'To:' header is
8787
set.
8888

89-
>*Note:* When included in a <standalone application>, the <Common
90-
> library> is implemented as a hidden <group> and made available when
91-
> the <group> receives its first <openBackground> message. During the
89+
>*Note:* When included in a <standalone application>, the
90+
> <Common library> is implemented as a hidden <group> and made available
91+
> when the <group> receives its first <openBackground> message. During the
9292
> first part of the <application|application's> startup process, before
9393
> this <message> is sent, the <revMail> <command> is not yet available.
9494
> This may affect attempts to use this <command> in <startup>,
@@ -107,10 +107,9 @@ mobileComposeHtmlMail (command), parameter (glossary),
107107
main stack (glossary), handler (glossary), message (glossary),
108108
group (glossary), Mac OS (glossary), standalone application (glossary),
109109
Apple Event (glossary), command (glossary), application (glossary),
110-
file (keyword), revMail (library), Common library (library),
111-
library (library), startup (message), openBackground (message),
112-
preOpenStack (message), openStack (message), preOpenCard (message),
113-
stack (object)
110+
file (keyword), Common library (library), library (library),
111+
startup (message), openBackground (message), preOpenStack (message),
112+
openStack (message), preOpenCard (message), stack (object)
114113

115114
Tags: networking
116115

‎docs/dictionary/command/revPrintReport.lcdoc‎

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,7 @@ Type: command
55
Syntax: revPrintReport
66

77
Summary:
8-
Prints a report from the <report viewer|report viewers> on the
9-
<current card>.
8+
Prints a report from the report viewers on the <current card>.
109

1110
Introduced: 2.0
1211

@@ -21,22 +20,21 @@ revPrintReport
2120

2221
Description:
2322
Use the <revPrintReport> <command> to print a report that you have set
24-
up in the <Report Builder>.
23+
up in the Report Builder.
2524

26-
>*Note:* The <Report Builder> stack is no-longer supported but can
27-
> still
28-
> be used by manually launching the tool.
25+
>*Note:* The Report Builder stack is no-longer supported but can
26+
> still be used by manually launching the tool.
2927

30-
When you use the <Report Builder> to create a set of report settings,
28+
When you use the Report Builder to create a set of report settings,
3129
the settings are stored with the card. The <revPrintReport> <command>
32-
uses the settings specified in the <Report Builder> for the
30+
uses the settings specified in the Report Builder for the
3331
<current card> to print the report. If you have never used the
34-
<Report Builder> with the <current card> (and therefore there are no
32+
Report Builder with the <current card> (and therefore there are no
3533
report settings to use), the <revPrintReport> <command> causes a
3634
<error|script error>.
3735

3836
The <revPrintReport> <command> is equivalent to clicking "Print Report"
39-
in the <Report Builder>.
37+
in the Report Builder.
4038

4139
>*Important:* The <revPrintReport> <command> is part of the
4240
> <Printing library>. To ensure that the <command> works in a

0 commit comments

Comments
 (0)