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

Commit 81c1b70

Browse files
committed
Import of dictionary and glossary.
1 parent eab750c commit 81c1b70

2,454 files changed

Lines changed: 102534 additions & 0 deletions

File tree

Some content is hidden

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

.gitattributes

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
*.gitattributes text
1313
*.mk text
1414
*.lc text
15+
*.xml text
1516

1617
# Declare files that will always have CRLF line endings on checkout.
1718
*.sln text eol=crlf
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
<doc>
2+
<legacy_id>3040</legacy_id>
3+
<name>XBrowser_Focus</name>
4+
<type>command</type>
5+
<syntax>
6+
<example>XBrowser_Focus<i> </i>[<i> instanceId </i>]</example>
7+
</syntax>
8+
<library>Browser Library</library>
9+
<objects>
10+
</objects>
11+
<synonyms>
12+
</synonyms>
13+
<classification>
14+
</classification>
15+
<references>
16+
<function tag="revBrowserOpen">revBrowserOpen Function</function>
17+
<command tag="XBrowser_Unfocus">XBrowser_Unfocus Command</command>
18+
</references>
19+
<history>
20+
<introduced version="2.8.1">Added.</introduced>
21+
</history>
22+
<platforms>
23+
<mac/>
24+
<windows/>
25+
</platforms>
26+
<classes>
27+
<desktop/>
28+
</classes>
29+
<security>
30+
<network/>
31+
</security>
32+
<summary>Has no affect, included for backwards comptability</summary>
33+
<examples>
34+
<example>XBrowser_Focus tBrowserId</example>
35+
</examples>
36+
<description>
37+
<p>The <b>XBrowser_Focus</b> command has no effect and is included for backwards compatibility with older applications.</p><p/><p><b>Parameters:</b></p><p>The <i>instanceId</i> is the integer identifier of a browser object</p><p/><p><b>Value:</b></p><p>The <b>XBrowser_Focus </b>command puts empty into the <function tag="result">result</function></p><p/><p><b>Note:</b> For general information on using the browser library, see the notes in the <function tag="revBrowserOpen">revBrowserOpen function</function> reference.</p>
38+
</description>
39+
</doc>
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
<doc>
2+
<legacy_id>3064</legacy_id>
3+
<name>XBrowser_Init</name>
4+
<type>command</type>
5+
<syntax>
6+
<example>XBrowser_Init <i>username</i>, <i>password</i></example>
7+
</syntax>
8+
<library>Browser Library</library>
9+
<objects>
10+
</objects>
11+
<synonyms>
12+
</synonyms>
13+
<classification>
14+
</classification>
15+
<references>
16+
<function tag="revBrowserOpen">revBrowserOpen Function</function>
17+
</references>
18+
<history>
19+
<introduced version="2.8.1">Added.</introduced>
20+
</history>
21+
<platforms>
22+
<mac/>
23+
<windows/>
24+
</platforms>
25+
<classes>
26+
<desktop/>
27+
</classes>
28+
<security>
29+
<network/>
30+
</security>
31+
<summary>Is included for backwards compatibility and does nothing.</summary>
32+
<examples>
33+
<example>XBrowser_Init "myUsername", "myPassword"</example>
34+
</examples>
35+
<description>
36+
<p>The <b>XBrowser_Init</b> 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.</p><p/><p><b>Note:</b> For general information on using the browser library, see the notes in the <function tag="revBrowserOpen">revBrowserOpen function</function> reference.</p>
37+
</description>
38+
</doc>
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
<doc>
2+
<legacy_id>3041</legacy_id>
3+
<name>XBrowser_Unfocus</name>
4+
<type>command</type>
5+
<syntax>
6+
<example>XBrowser_Unfocus<i> </i>[<i> instanceId </i>]</example>
7+
</syntax>
8+
<library>Browser Library</library>
9+
<objects>
10+
</objects>
11+
<synonyms>
12+
</synonyms>
13+
<classification>
14+
</classification>
15+
<references>
16+
<command tag="XBrowser_Focus">XBrowser_Focus Command</command>
17+
</references>
18+
<history>
19+
<introduced version="2.8.1">Added.</introduced>
20+
</history>
21+
<platforms>
22+
<mac/>
23+
<windows/>
24+
</platforms>
25+
<classes>
26+
<desktop/>
27+
</classes>
28+
<security>
29+
<network/>
30+
</security>
31+
<summary>Has no affect, included for backwards compatibility</summary>
32+
<examples>
33+
<example>XBrowser_Unfocus tBrowserId</example>
34+
</examples>
35+
<description>
36+
<p>The <b>XBrowser_Unfocus</b> command has no affect and is included for backwards compatibility with older applications.</p><p/><p><b>Parameters:</b></p><p>The <i>instanceId</i> is the integer identifier of a browser object</p><p/><p><b>Value:</b></p><p>The <b>XBrowser_Unfocus</b> command puts empty into the <function tag="result">result</function></p><p/><p><b>Note:</b> For general information on using the browser library, see the notes in the <function tag="revBrowserOpen">revBrowserOpen function</function> reference.</p>
37+
</description>
38+
</doc>

docs/dictionary/command/accept.xml

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
<doc>
2+
<legacy_id>1099</legacy_id>
3+
<name>accept</name>
4+
<type>command</type>
5+
<syntax>
6+
<example>accept [datagram] connections on port <i>number</i> with message <i>callbackMessage</i></example>
7+
</syntax>
8+
<library></library>
9+
<objects>
10+
</objects>
11+
<synonyms>
12+
</synonyms>
13+
<classification>
14+
<category>Networks &amp; Communication</category>
15+
</classification>
16+
<references>
17+
<command tag="close socket">close socket Command</command>
18+
<function tag="hostNameToAddress">hostNameToAddress Function</function>
19+
<command tag="open socket">open socket Command</command>
20+
<function tag="openSockets">openSockets Function</function>
21+
<command tag="read from socket">read from socket Command</command>
22+
<command tag="write to socket">write to socket Command</command>
23+
<function tag="peerAddress">peerAddress Function</function>
24+
<function tag="hostAddress">hostAddress Function</function>
25+
<function tag="hostAddressToName">hostAddressToName Function</function>
26+
<function tag="hostName">hostName Function</function>
27+
<property tag="HTTPProxy">HTTPProxy Property</property>
28+
</references>
29+
<history>
30+
<introduced version="1.0">Added.</introduced>
31+
</history>
32+
<platforms>
33+
<mac/>
34+
<windows/>
35+
<linux/>
36+
</platforms>
37+
<classes>
38+
<desktop/>
39+
<server/>
40+
<web/>
41+
</classes>
42+
<security>
43+
<network/>
44+
</security>
45+
<summary>Accepts an internet connection and creates a <glossary tag="socket">socket</glossary> for that connection.</summary>
46+
<examples>
47+
<example>accept connections on port 80 with message "webConnect"</example>
48+
<example>accept datagram connections on port it with message myMessage</example>
49+
</examples>
50+
<description>
51+
<p>Use the <b>accept</b> <glossary tag="command">command</glossary> when running a <glossary tag="server">server</glossary>, to accept <glossary tag="TCP">TCP</glossary> connections or <glossary tag="UDP">UDP</glossary> <glossary tag="datagram">datagrams</glossary> from other systems (or other <glossary tag="process">processes</glossary> on the same system).</p><p>Use the datagram option if you want to accept UDP datagrams.</p><p/><p><b>Parameters:</b></p><p>The <i>portNumber</i> is the <glossary tag="TCP">TCP</glossary> <glossary tag="port">port</glossary> number on which to accept connections.</p><p>The <i>callbackMessage</i> is the name of a <keyword tag="message box">message</keyword> to be sent when a connection is made or a <glossary tag="datagram">datagram</glossary> is received.</p><p></p><p><b>Comments:</b></p><p>When a connection is made or a datagram is received, the <b>accept</b> <glossary tag="command">command</glossary> creates a new <glossary tag="socket">socket</glossary> that can be used to communicate with the other system (or <glossary tag="process">process</glossary>). When using the <command tag="close socket">close socket</command>, <command tag="read from socket">read from socket</command>, or <command tag="write to socket">write to socket</command> <glossary tag="command">commands</glossary>, you can refer to this <glossary tag="socket">socket</glossary> with a socket identifier that looks like this:</p><p><i>host</i>:<i>port</i>[|<i>connectionID</i>]</p><p>where the <i>connectionID</i> is a number assigned by the <b>accept</b> <glossary tag="command">command</glossary>. (You only need to specify the connection number if there is more than one <glossary tag="socket">socket</glossary> connected to a particular <glossary tag="port">port</glossary> and <glossary tag="disabled">host</glossary>.)</p><p/><p>The <i>callbackMessage</i> is sent to the <glossary tag="object">object</glossary> whose <property tag="script">script</property> contains the <b>accept</b> <glossary tag="command">command</glossary>. Either one or two <glossary tag="parameter">parameters</glossary> are sent with this <keyword tag="message box">message</keyword>. The first <glossary tag="parameter">parameter</glossary> is the <glossary tag="IP address">IP address</glossary> of the system or <glossary tag="process">process</glossary> making the connection. If a <glossary tag="datagram">datagram</glossary> is being accepted, the second <glossary tag="parameter">parameter</glossary> is the contents of the <glossary tag="datagram">datagram</glossary>.</p><p/><p>For technical information about sockets, see RFC 147 at &lt;<u>http://www.ietf.org/rfc/rfc147.txt</u>&gt;.</p><p>For technical information about UDP datagrams, see RFC 768 at &lt;<u>http://www.ietf.org/rfc/rfc0768.txt</u>&gt;.</p><p>For technical information about the numbers used to designate standard ports, see the list of port numbers at &lt;<u>http://www.iana.org/assignments/port-numbers</u>&gt;<i>,</i> in particular the section entitled "Well Known Port Numbers".</p>
52+
</description>
53+
</doc>

docs/dictionary/command/add.xml

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
<doc>
2+
<legacy_id>1968</legacy_id>
3+
<name>add</name>
4+
<type>command</type>
5+
<syntax>
6+
<example>add <i>number</i> to [<i>chunk</i> of] <i>container</i></example>
7+
<example>add {<i>number </i>| <i>array</i>} to <i>arrayContainer</i></example>
8+
</syntax>
9+
<library></library>
10+
<objects>
11+
</objects>
12+
<synonyms>
13+
</synonyms>
14+
<classification>
15+
<category>Math, Logic, &amp; Dates</category>
16+
</classification>
17+
<references>
18+
<command tag="multiply">multiply Command</command>
19+
<command tag="union">union Command</command>
20+
<function tag="sum">sum Function</function>
21+
</references>
22+
<history>
23+
<introduced version="1.0">Added.</introduced>
24+
<changed version="1.1"></changed>
25+
</history>
26+
<platforms>
27+
<mac/>
28+
<windows/>
29+
<linux/>
30+
<ios/>
31+
<android/>
32+
</platforms>
33+
<classes>
34+
<desktop/>
35+
<server/>
36+
<web/>
37+
</classes>
38+
<security>
39+
</security>
40+
<summary>Adds a number to a <glossary tag="container">container</glossary> and places the resulting <function tag="value">value</function> in the <glossary tag="container">container</glossary>.</summary>
41+
<examples>
42+
<example>add 7 to field "Previous Amount"</example>
43+
<example>add field "New" to summaryOfInventory</example>
44+
<example>add qty * price to last line of myOrder</example>
45+
</examples>
46+
<description>
47+
<p>Use the <b>add</b> <glossary tag="command">command</glossary> to add a number to a <glossary tag="container">container</glossary> or a portion of a <glossary tag="container">container</glossary>, or to add two <glossary tag="array">arrays</glossary> containing numbers.</p><p/><p><b>Parameters:</b></p><p>The <i>number</i> is an <glossary tag="expression">expression</glossary> that <glossary tag="evaluate">evaluates</glossary> to a number.</p><p>The <i>chunk</i> is a <glossary tag="chunk expression">chunk expression</glossary> specifying a portion of the <i>container</i>.</p><p>The <i>container</i> is a <keyword tag="field">field</keyword>, <keyword tag="button">button</keyword>, or <glossary tag="variable">variable</glossary>, or the <keyword tag="message box">message box</keyword>.</p><p>The <i>arrayContainer</i> is an <glossary tag="array">array</glossary> <glossary tag="variable">variable</glossary> each of whose <glossary tag="element">elements</glossary> is a number.</p><p/><p><b>Comments:</b></p><p>The contents of the <i>container</i> (or the <i>chunk</i> of the <i>container</i>) must be a number or an <glossary tag="expression">expression</glossary> that <glossary tag="evaluate">evaluates</glossary> to a number.</p><p/><p>If a <i>number</i> is added to an <i>arrayContainer</i>, the <i>number</i> is added to each <keyword tag="element">element</keyword>. If an <i>array</i> is added to an <i>arrayContainer</i>, both <glossary tag="array">arrays</glossary> must have the same number of <glossary tag="element">elements</glossary> and the same dimension, and each <keyword tag="element">element</keyword> in the <i>array</i> is added to the corresponding <keyword tag="element">element</keyword> of the <i>arrayContainer</i>.</p><p/><p>If the <i>container</i> or an <keyword tag="element">element</keyword> of the <i>arrayContainer</i> is empty, the <b>add</b> <glossary tag="command">command</glossary> treats its contents as zero.</p><p>If <i>container</i> is a <keyword tag="field">field</keyword> or <keyword tag="button">button</keyword>, the <function tag="format">format</function> of the sum is determined by the <property tag="numberFormat">numberFormat</property> <glossary tag="property">property</glossary>.</p><p/><p><b>Changes:</b></p><p>The add to <i>arrayContainer</i> form was introduced in version 1.1. In previous versions, only single numbers could be used with the <b>add</b> <glossary tag="command">command</glossary>.</p>
48+
</description>
49+
</doc>
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
<doc>
2+
<legacy_id>2161</legacy_id>
3+
<name>answer color</name>
4+
<type>command</type>
5+
<syntax>
6+
<example>answer color [with <i>startingColor</i>]</example>
7+
</syntax>
8+
<library></library>
9+
<objects>
10+
</objects>
11+
<synonyms>
12+
</synonyms>
13+
<classification>
14+
<category>Windows &amp; Dialog Boxes</category>
15+
<category>Appearance &amp; Positioning</category>
16+
</classification>
17+
<references>
18+
<command tag="answer">answer Command</command>
19+
<property tag="backgroundColor">backgroundColor Property</property>
20+
<function tag="colorNames">colorNames Function</function>
21+
<property tag="colors">colors Property</property>
22+
<property tag="foregroundColor">foregroundColor Property</property>
23+
<keyword tag="it">it Keyword</keyword>
24+
<property tag="systemColorSelector">systemColorSelector Property</property>
25+
</references>
26+
<history>
27+
<introduced version="1.1">Added.</introduced>
28+
<changed version="1.1.1"></changed>
29+
</history>
30+
<platforms>
31+
<mac/>
32+
<windows/>
33+
<linux/>
34+
</platforms>
35+
<classes>
36+
<desktop/>
37+
<web/>
38+
</classes>
39+
<security>
40+
</security>
41+
<summary>Displays the operating system's standard color-selection <glossary tag="dialog box">dialog box</glossary>.</summary>
42+
<examples>
43+
<example>answer color</example>
44+
<example>if theItem is "Custom Color..." then answer color</example>
45+
<example>answer color with "#FF0033"</example>
46+
<example>answer color with "AliceBlue"</example>
47+
</examples>
48+
<description>
49+
<p>Use the <b>answer color</b> <glossary tag="command">command</glossary> to select a custom color.</p><p/><p><b>Parameters:</b></p><p>The <i>startingColor</i> is a <href tag="reference/color_reference.rev">color reference</href> consisting of one of the following:</p><p>* a standard color name</p><p>* three comma-separated integers between zero and 255, specifying the level of each of red, green, and blue</p><p>* an HTML-style color consisting of a hash mark (#) followed by three hexadecimal numbers, one for each of red, green, and blue.</p><p/><p><b>Comments:</b></p><p>The <b>answer color</b> <glossary tag="command">command</glossary> displays a <glossary tag="dialog box">dialog box</glossary> where the user can select a color. (This dialog box is displayed by the operating system, not by LiveCode.)</p><p/><p>The color the user chooses is placed in the <b>it</b> <glossary tag="variable">variable</glossary>. If the user cancels the <glossary tag="dialog box">dialog</glossary>, the <keyword tag="it">it</keyword> <glossary tag="variable">variable</glossary> is set to empty, and the <function tag="result">result</function> <control_st tag="function">function</control_st> <glossary tag="return">returns</glossary> "Cancel".</p><p/><p>If you specify a <i>startingColor</i>, the dialog box displays that color by default.</p><p/><p>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.</p><p/><p><b>Changes:</b></p><p>The option to specify a <i>startingColor</i> was introduced in version 1.1.1. In previous versions, the <glossary tag="dialog box">dialog box</glossary> displayed white by <keyword tag="default">default</keyword>.</p>
50+
</description>
51+
</doc>
Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
<doc>
2+
<legacy_id>1471</legacy_id>
3+
<name>answer effect</name>
4+
<type>command</type>
5+
<syntax>
6+
<example>answer effect</example>
7+
</syntax>
8+
<library></library>
9+
<objects>
10+
</objects>
11+
<synonyms>
12+
</synonyms>
13+
<classification>
14+
<category>Windows &amp; Dialog Boxes</category>
15+
<category>Images &amp; Multimedia</category>
16+
</classification>
17+
<references>
18+
<command tag="answer">answer Command</command>
19+
<command tag="answer record">answer record Command</command>
20+
<command tag="hide">hide Command</command>
21+
<function tag="QTEffects">QTEffects Function</function>
22+
<command tag="show">show Command</command>
23+
<command tag="visual effect">visual effect Command</command>
24+
<property tag="dontUseQTEffects">dontUseQTEffects Property</property>
25+
<property tag="dontUseQT">dontUseQT Property</property>
26+
</references>
27+
<history>
28+
<introduced version="1.1">Added.</introduced>
29+
</history>
30+
<platforms>
31+
<mac/>
32+
<windows/>
33+
</platforms>
34+
<classes>
35+
<desktop/>
36+
</classes>
37+
<security>
38+
</security>
39+
<summary>Displays the <glossary tag="QuickTime">QuickTime</glossary> special effects <glossary tag="dialog box">dialog box</glossary>.</summary>
40+
<examples>
41+
<example>answer effect</example>
42+
<example>if the altKey is down then answer effect</example>
43+
</examples>
44+
<description>
45+
<p>Use the <b>answer effect</b> <glossary tag="command">command</glossary> to choose a visual effect, or to set up an effect with complex options for later use.</p><p/><p><b>Comments:</b></p><p>The <b>answer effect</b> <glossary tag="command">command</glossary> displays a <glossary tag="dialog box">dialog box</glossary> where the user can select a visual effect and (for some effects) set parameters such as speed and direction. (This <glossary tag="dialog box">dialog box</glossary> is displayed by <glossary tag="QuickTime">QuickTime</glossary>, not by LiveCode.)</p><p/><p>An encoded description of the visual effect the user chooses is placed in the <b>it</b> <glossary tag="variable">variable</glossary>. You can either use the encoded description immediately, or store it (for example, in a <glossary tag="variable">variable</glossary> or in a <property tag="customProperties">custom property</property>) for later use. To display the effect, use the encoded description with the <command tag="visual effect">visual effect</command> <glossary tag="command">command</glossary>, with the <command tag="unlock screen">unlock screen</command> <glossary tag="command">command</glossary>, or with the<code> hide with visual effect </code>or<code> show with visual effect </code>form of the <b>hide</b> or <command tag="show">show</command> <glossary tag="command">command</glossary>.</p><p/><p>If the user cancels the dialog, the <b>it</b> <glossary tag="variable">variable</glossary> is set to empty, and the <function tag="result">result</function> <control_st tag="function">function</control_st> <glossary tag="return">returns</glossary> "Cancel".</p>
46+
</description>
47+
</doc>

0 commit comments

Comments
 (0)