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

Commit b4ba7d7

Browse files
author
Monte Goulding
committed
Hard wrap lcdoc files
This patch wraps lcdoc files at 72 columns where appropriate and orders lcdoc elements consistently in all files. It also fixes some file naming anomalies where `_` or ` ` was used instead of `-` for space or the filename did not include the entire name. Additionally this patch removes web as a platform due to the confusion between the legacy browser plugin and html5 which is listed as an OS.
1 parent 46c93f6 commit b4ba7d7

File tree

2,621 files changed

+62489
-25006
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

2,621 files changed

+62489
-25006
lines changed

‎docs/dictionary/command/XBrowser_Focus.lcdoc‎

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,12 @@ Type: command
44

55
Syntax: XBrowser_Focus [<instanceId>]
66

7-
Summary: Has no affect, included for backwards comptability
7+
Summary:
8+
Has no affect, included for backwards comptability
89

910
Introduced: 2.8.1
1011

11-
OS: mac,windows
12+
OS: mac, windows
1213

1314
Platforms: desktop
1415

@@ -18,13 +19,19 @@ Example:
1819
XBrowser_Focus tBrowserId
1920

2021
Parameters:
21-
instanceId: The integer identifier of a browser object
22+
instanceId:
23+
The integer identifier of a browser object
2224

23-
The result: The XBrowser_Focus command puts empty into the <result>.
25+
The result:
26+
The XBrowser_Focus command puts empty into the <result>.
2427

2528
Description:
26-
The <XBrowser_Focus> command has no effect and is included for backwards compatibility with older applications.
29+
The <XBrowser_Focus> command has no effect and is included for backwards
30+
compatibility with older applications.
2731

28-
>*Note:* For general information on using the browser library, see the notes in the <revBrowserOpen function> reference.
32+
>*Note:* For general information on using the browser library, see the
33+
> notes in the <revBrowserOpen function> reference.
34+
35+
References: XBrowser_Unfocus (command), revBrowserOpen (function),
36+
revBrowserOpen function (function), result (function)
2937

30-
References: XBrowser_Unfocus (command), revBrowserOpen (function), revBrowserOpen function (function), result (function)

‎docs/dictionary/command/XBrowser_Init.lcdoc‎

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,14 @@ Name: XBrowser_Init
22

33
Type: command
44

5-
Syntax: XBrowser_Init <username>, <password>
5+
Syntax: XBrowser_Init <username>, <password>
66

7-
Summary: Is included for backwards compatibility and does nothing.
7+
Summary:
8+
Is included for backwards compatibility and does nothing.
89

910
Introduced: 2.8.1
1011

11-
OS: mac,windows
12+
OS: mac, windows
1213

1314
Platforms: desktop
1415

@@ -18,12 +19,19 @@ Example:
1819
XBrowser_Init "myUsername", "myPassword"
1920

2021
Parameters:
21-
username:
22-
password:
22+
username:
23+
24+
25+
password:
26+
2327

2428
Description:
25-
The <XBrowser_Init> command is included for backwards compatibility with altBrowser 2.x and 1.x. The command is no longer needed and calling it has no affect.
29+
The <XBrowser_Init> command is included for backwards compatibility with
30+
altBrowser 2.x and 1.x. The command is no longer needed and calling it
31+
has no affect.
2632

27-
>*Note:* For general information on using the browser library, see the notes in the <revBrowserOpen function> reference.
33+
>*Note:* For general information on using the browser library, see the
34+
> notes in the <revBrowserOpen function> reference.
2835

2936
References: revBrowserOpen (function), revBrowserOpen function (function)
37+

‎docs/dictionary/command/XBrowser_Unfocus.lcdoc‎

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,12 @@ Type: command
44

55
Syntax: XBrowser_Unfocus [<instanceId>]
66

7-
Summary: Has no affect, included for backwards compatibility
7+
Summary:
8+
Has no affect, included for backwards compatibility
89

910
Introduced: 2.8.1
1011

11-
OS: mac,windows
12+
OS: mac, windows
1213

1314
Platforms: desktop
1415

@@ -18,13 +19,19 @@ Example:
1819
XBrowser_Unfocus tBrowserId
1920

2021
Parameters:
21-
instanceId: The integer identifier of a browser object
22+
instanceId:
23+
The integer identifier of a browser object
2224

23-
The result: The <XBrowser_Unfocus> command puts empty into the <result>.
25+
The result:
26+
The <XBrowser_Unfocus> command puts empty into the <result>.
2427

2528
Description:
26-
The <XBrowser_Unfocus> command has no affect and is included for backwards compatibility with older applications.
29+
The <XBrowser_Unfocus> command has no affect and is included for
30+
backwards compatibility with older applications.
2731

28-
>*Note:* For general information on using the browser library, see the notes in the <revBrowserOpen function> reference.
32+
>*Note:* For general information on using the browser library, see the
33+
> notes in the <revBrowserOpen function> reference.
34+
35+
References: XBrowser_Focus (command), result (function),
36+
revBrowserOpen function (function)
2937

30-
References: XBrowser_Focus (command), result (function), revBrowserOpen function (function)

‎docs/dictionary/command/accept.lcdoc‎

Lines changed: 46 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,17 @@ Name: accept
22

33
Type: command
44

5-
Syntax: accept [datagram] connections on port <portNumber> with message <callbackMessage>
5+
Syntax: accept [datagram] connections on port <portNumber> with message <callbackMessage>
66

7-
Summary: Accepts an internet connection and creates a <socket> for that connection.
7+
Summary:
8+
Accepts an internet connection and creates a <socket> for that
9+
connection.
810

911
Introduced: 1.0
1012

11-
OS: mac,windows,linux,iOS,android
13+
OS: mac, windows, linux, ios, android
1214

13-
Platforms: desktop,server,web,mobile
15+
Platforms: desktop, server, mobile
1416

1517
Security: network
1618

@@ -30,28 +32,56 @@ on connectionMade pIPAddress
3032
end connectionMade
3133

3234
Parameters:
33-
callbackMessage: The name of a message to be sent when a connection is made or a datagram is received.
34-
portNumber: The TCP port number on which to accept connections.
35+
callbackMessage:
36+
The name of a message to be sent when a connection is made or a datagram
37+
is received.
3538

36-
Description:
37-
Use the <accept> <command> when running a <server>, to accept <TCP> connections or <UDP> <datagram|datagrams> from other systems (or other <process|processes> on the same system).
38-
Use the datagram option if you want to accept UDP datagrams.
39-
40-
When a connection is made or a datagram is received, the <accept> <command> creates a new <socket> that can be used to communicate with the other system (or <process>). When using the <close socket>, <read from socket>, or <write to socket> <command|commands>, you can refer to this <socket> with a socket identifier that looks like this:
41-
host:port[|connectionID]
42-
where the connectionID is a number assigned by the <accept> <command>. (You only need to specify the connection number if there is more than one <socket> connected to a particular <port> and <host>.)
39+
portNumber:
40+
The TCP port number on which to accept connections.
4341

44-
The <callbackMessage> is sent to the <object(glossary)> whose <script> contains the <accept> <command>. Either one or two <parameter|parameters> are sent with this <message>. The first <parameter> is the <IP address> of the system or <process> making the connection. If a <datagram> is being accepted, the second <parameter> is the contents of the <datagram>.
42+
Description:
43+
Use the <accept> <command> when running a <server>, to accept <TCP>
44+
connections or <UDP> <datagram|datagrams> from other systems (or other
45+
<process|processes> on the same system). Use the datagram option if you
46+
want to accept UDP datagrams.
47+
48+
When a connection is made or a datagram is received, the <accept>
49+
<command> creates a new <socket> that can be used to communicate with
50+
the other system (or <process>). When using the <close socket>, <read
51+
from socket>, or <write to socket> <command|commands>, you can refer to
52+
this <socket> with a socket identifier that looks like this:
53+
host:port[|connectionID] where the connectionID is a number assigned by
54+
the <accept> <command>. (You only need to specify the connection number
55+
if there is more than one <socket> connected to a particular <port> and
56+
<host>.)
57+
58+
The <callbackMessage> is sent to the <object(glossary)> whose <script>
59+
contains the <accept> <command>. Either one or two
60+
<parameter|parameters> are sent with this <message>. The first
61+
<parameter> is the <IP address> of the system or <process> making the
62+
connection. If a <datagram> is being accepted, the second <parameter> is
63+
the contents of the <datagram>.
4564

4665
- For technical information about sockets, see [RFC
4766
147](https://tools.ietf.org/html/rfc147)
4867
- For technical information about UDP datagrams, see [RFC
4968
768](https://tools.ietf.org/html/rfc768)
5069
- For technical information about the numbers used to designate
5170
standard ports, see the
52-
[official IANA list of port assignments](https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml)
71+
[official IANA list of port
72+
assignments](https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml)
5373
and [RFC 6335](https://tools.ietf.org/html/rfc6335)
5474

55-
References: HTTPProxy (property), script (property), read from socket (command), write to socket (command), close socket (command), open socket (command), openSockets (function), hostAddressToName (function), hostName (function), hostAddress (function), peerAddress (function), hostNameToAddress (function), datagram (glossary), IP address (glossary), TCP (glossary), port (glossary), command (glossary), socket (glossary), UDP (glossary), host (glossary), server (glossary), message (glossary), parameter (glossary), process (glossary), object (glossary)
75+
76+
References: read from socket (command), write to socket (command),
77+
close socket (command), open socket (command), openSockets (function),
78+
hostAddressToName (function), hostName (function), hostAddress (function),
79+
peerAddress (function), hostNameToAddress (function), datagram (glossary),
80+
IP address (glossary), TCP (glossary), port (glossary),
81+
command (glossary), socket (glossary), UDP (glossary), host (glossary),
82+
server (glossary), message (glossary), parameter (glossary),
83+
process (glossary), object (glossary), HTTPProxy (property),
84+
script (property)
5685

5786
Tags: networking
87+

‎docs/dictionary/command/add.lcdoc‎

Lines changed: 30 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,19 @@ Name: add
22

33
Type: command
44

5-
Syntax: add <number> to [<chunk> of] <container>
5+
Syntax: add <number> to [<chunk> of] <container>
66

7-
Syntax: add {<number> | <array>} to <arrayContainer>
7+
Syntax: add {<number> | <array>} to <arrayContainer>
88

9-
Summary: Adds a number to a <container> and places the resulting <value> in the <container>.
9+
Summary:
10+
Adds a number to a <container> and places the resulting <value> in the
11+
<container>.
1012

1113
Introduced: 1.0
1214

13-
OS: mac,windows,linux,ios,android
15+
OS: mac, windows, linux, ios, android
1416

15-
Platforms: desktop,server,web
17+
Platforms: desktop, server
1618

1719
Example:
1820
add 7 to field 1
@@ -42,11 +44,22 @@ on mouseUp
4244
end mouseUp
4345

4446
Parameters:
45-
number: An expression that evaluates to a number.
46-
chunk: A chunk expression specifying a portion of the container.
47-
container: A field, button, or variable, or the message box.
48-
array (array): An array variable each of whose elements is a number.
49-
arrayContainer (array): An array variable each of whose elements is a number.
47+
number:
48+
An expression that evaluates to a number.
49+
50+
chunk:
51+
A chunk expression specifying a portion of the container.
52+
53+
container:
54+
A field, button, or variable, or the message box.
55+
56+
array (array):
57+
An array variable each of whose elements is a number.
58+
59+
60+
arrayContainer (array):
61+
An array variable each of whose elements is a number.
62+
5063

5164
Description:
5265
Use the <add> <command> to add a number to a <container> or a portion of
@@ -67,11 +80,12 @@ empty, the <add> <command> treats its contents as zero.
6780
If <container> is a <field> or <button>, the <format> of the sum is
6881
determined by the <numberFormat> <property>.
6982

70-
References: array (glossary), button (object), combine (command),
71-
command (glossary), container (glossary), element (glossary),
72-
element (keyword), evaluate (glossary), expression (glossary),
73-
field (object), format (glossary), multiply (command),
74-
numberFormat (property), property (glossary), split (command),
75-
sum (function), union (command), value (function)
83+
References: combine (command), multiply (command), split (command),
84+
union (command), sum (function), value (function), array (glossary),
85+
command (glossary), container (glossary), element (glossary),
86+
evaluate (glossary), expression (glossary), format (glossary),
87+
property (glossary), element (keyword), button (object), field (object),
88+
numberFormat (property)
7689

7790
Tags: math
91+

‎docs/dictionary/command/answer-color.lcdoc‎

Lines changed: 33 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,14 @@ Type: command
44

55
Syntax: answer color [with <startingColor>]
66

7-
Summary: Displays the operating system's standard color-selection <dialog box>.
7+
Summary:
8+
Displays the operating system's standard color-selection <dialog box>.
89

910
Introduced: 1.1
1011

11-
OS: mac,windows,linux
12+
OS: mac, windows, linux
1213

13-
Platforms: desktop,web
14+
Platforms: desktop
1415

1516
Example:
1617
answer color
@@ -25,27 +26,46 @@ Example:
2526
answer color with "AliceBlue"
2627

2728
Parameters:
28-
startingColor: A <color reference> in one of the following forms:
29+
startingColor:
30+
A <color reference> in one of the following forms:
31+
2932
- a standard color name
30-
- three comma-separated integers between zero and 255, specifying the level of each of red, green, and blue
31-
- an HTML-style color consisting of a hash mark (#) followed by three hexadecimal numbers, one for each of red, green, and blue.
33+
- three comma-separated integers between zero and 255, specifying the
34+
level of each of red, green, and blue
35+
- an HTML-style color consisting of a hash mark (#) followed by three
36+
hexadecimal numbers, one for each of red, green, and blue.
37+
3238

33-
The result: If the user cancels the <dialog box|dialog>, the <it> <variable> is set to empty, and the <result> <function> <return|returns> "Cancel".
39+
It:
40+
The color the user chooses is placed in the <it> <variable>.
3441

35-
It: The color the user chooses is placed in the <it> <variable>.
42+
The result:
43+
If the user cancels the <dialog box|dialog>, the <it> <variable> is set
44+
to empty, and the <result> <function> <return|returns> "Cancel".
3645

3746
Description:
3847
Use the <answer color> <command> to select a custom color.
3948

40-
The <answer color> <command> displays a <dialog box> where the user can select a color. (This dialog box is displayed by the operating system, not by LiveCode.)
49+
The <answer color> <command> displays a <dialog box> where the user can
50+
select a color. (This dialog box is displayed by the operating system,
51+
not by LiveCode.)
4152

42-
If you specify a <startingColor>, the dialog box displays that color by default.
53+
If you specify a <startingColor>, the dialog box displays that color by
54+
default.
4355

44-
The color is returned in the form of three comma-separated integers between zero and 255, specifying the level of each of red, green, and blue. This format can be used directly to set any color property.
56+
The color is returned in the form of three comma-separated integers
57+
between zero and 255, specifying the level of each of red, green, and
58+
blue. This format can be used directly to set any color property.
4559

4660
Changes:
47-
The option to specify a startingColor was introduced in version 1.1.1. In previous versions, the dialog box displayed white by default.
61+
The option to specify a startingColor was introduced in version 1.1.1.
62+
In previous versions, the dialog box displayed white by default.
4863

49-
References: systemColorSelector (property), backgroundColor (property), colors (property), foregroundColor (property), it (keyword), answer (command), result (function), colorNames (function), dialog box (glossary), variable (glossary), command (glossary), return (glossary), function (control structure), color reference (glossary)
64+
References: answer (command), function (control structure),
65+
result (function), colorNames (function), dialog box (glossary),
66+
variable (glossary), command (glossary), return (glossary),
67+
color reference (glossary), it (keyword), systemColorSelector (property),
68+
backgroundColor (property), colors (property), foregroundColor (property)
5069

5170
Tags: ui
71+

0 commit comments

Comments
 (0)