Skip to content

Commit acd7287

Browse files
Renamed ExtraCommands.md to Commands.md
1 parent a985b6c commit acd7287

10 files changed

+76
-63
lines changed

AddOns.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
layout: default
33
---
44

5-
<!-- Don't use permalink: /Components in YAML matter above. It doesn't auto-redirect this page. -->
5+
<!-- Don't use permalink: /Components in YAML matter above. It doesn't auto-redirect. -->
66
### Page has moved
77

88
Please see [Components](Components) instead.

AddOnsDependants.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ layout: default
33
permalink: /ComponentsDependants
44
---
55

6-
<!-- Don't use permalink: /ComponentsDependants in YAML matter above. It doesn't auto-redirect this page. -->
6+
<!-- Don't use permalink: /ComponentsDependants in YAML matter above. It doesn't auto-redirect. -->
77
### Page has moved
88

99
Please see [ComponentsDependants](ComponentsDependants) instead.

Commands.md

+55
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
layout: default
3+
---
4+
{% include links %}
5+
* TOC
6+
{:toc}
7+
8+
# Overview
9+
[SeLite Commands](https://addons.mozilla.org/en-US/firefox/addon/selite-commands/) ([Components](Components) > [Commands](Components#commands)) provides several Selenese commands and related functionality.
10+
11+
# Robust commands #
12+
Commands with name in form `xxxRobust: typeRobust, clickRobust, selectRobust` action the same as original commands `xxx`, but if the target doesn't exist, then they skip and they don't fail.
13+
14+
# Random data #
15+
Commands with name in form `xxxRandom: clickRandom, selectRandom, typeRandom, typeRandomEmail` generate controlled random data. The commands enter (or select or click) a random value(or an option or a radio button) for a given field (of a specified type). Optionally, they can also store the entered/selected/clicked text/choice in a given Selenese variable, so that the [script] can use it later (e.g. to store it in [script] DB).
16+
17+
Those commands perform two functions
18+
19+
* main purpose: click/select a random element (matching the given selector), or type random text (more below)
20+
* optionally, capture the value of that clicked/selected element, or capture the typed text, into a stored variable. That facilitates later stages (e.g. when you submit the form and load a view of the record, then you want can validate that the clicked/selected/typed data got submitted).
21+
22+
For that the commands have two parameters:
23+
24+
* `selectLocator` (or `radiosXPath` or `locator`), required: a selector to match the set of elements, from which it chooses a random one
25+
* `store` or `paramsOrStore` (optional):
26+
* `store` is a name of stored variable, where the command saves the clicked/selected/typed value. It may include field or sub(sub-...)-field e.g. `variableName.fieldName, variableName.fieldName.subfieldName...`
27+
* `paramsOrStore` can be either
28+
* a string: a name of stored variable, just like `store` above
29+
* an object with one or multiple fields. Following examples use [SelBlocks Global] and its [EnhancedSelenese](EnhancedSelenese) to pass objects through `=<>...<>` notation.
30+
31+
`typeRandomEmail` co-operates with `typeRandom`. It types a random email address, based on a name already typed in another element.
32+
33+
For more details see [its Selenese tests](https://github.com/selite/selite/tree/master/commands/selenese-scripts).
34+
35+
# Timestamp-related commands #
36+
There are two sets of functionality that support [TimeStamps](TimeStamps). The first set defines commands (primary names): `sleepUntilTimestampDistinctDownToMilliseconds, sleepUntilTimestampDistinctDownToSeconds, sleepUntilTimestampDistinctDownToMinutes`. Each ensures that a timestamp from that moment will be unique, when compared to any timestamp created just before any previous or future call to the same command (or to a command with finer precision).
37+
38+
The second set defines functions `isTimestampDownToMilliseconds, isTimestampDownToSeconds, isTimestampDownToMinutes, isTimestampDownToPrecision`. You can't access those directly as commands in Selenium IDE. Instead, use commands like `verifyTimestampDownToSeconds` (see also {{navAutoGeneratedSeleneseCommands}}). Those serve to validate a displayed timestamp (identified by locator in `target` parameter) against a previously saved timestamp (passed in `value` parameter).
39+
40+
The second set also auto-generates commands like `waitForTimestampDownToSeconds`. However, do not use those commands because they could be misplaced with `sleeUntilTimestampDistinctDownToSeconds`. To prevent confusion, this subset of auto-generated commands (`waitForTimestampDownToSeconds` and similar) are handled specially: they fail. If you need to wait for a timestamp and to validate it, use a different `waitFor...` command (targeting the related element), and then verify or assert the timestamp (with e.g. `assertTimestampDownToSeconds`).
41+
42+
## Basic usage ##
43+
* trigger a change
44+
* `storeTimestampDownToSeconds` (or similar - for the chosen precision)
45+
* `sleepUntilTimestampDistinctDownToSeconds` (or similar)
46+
* load a view
47+
* `assertTimestampDownToSeconds` (or `verifyTimestampDownToSeconds`) against the stored timestamp
48+
49+
# Other commands #
50+
* `disableJavascript, enableJavascript`: disable/enable Javascript for the web application that is being automated
51+
* `indexBy` - index objects
52+
* `selectTopFrameAnd`
53+
54+
# Reference #
55+
For details see reference of those commands in Selenium IDE, [online](https://cdn.rawgit.com/selite/selite/master/commands/src/chrome/content/reference.xml) or locally at {{chromeUrl}} _chrome://selite-extension-sequencer/content/selenese_reference.html?chrome://selite-commands/content/reference.xml_.

Components.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ To get the latest releases, use the `download` links below for recent releases.
9797
</td>
9898
</tr>
9999
<tr>
100-
<td> <a name="commands"></a><a href='ExtraCommands'>Commands</a></td>
100+
<td> <a name="commands"></a><a href='Commands'>Commands</a></td>
101101
<td> <a href='https://addons.mozilla.org/en-US/firefox/addon/selite-commands/'>info</a> </td>
102102
<td> <a href='https://addons.mozilla.org/en-US/firefox/addon/selite-commands/versions/'>download</a> </td>
103103
<td> <ul>

ComponentsDependants.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,13 @@ If you disable some components, do it at {{chromeUrl}} _about:addons_. Don't dis
1212

1313
<!-- Keep the following table sorted alphabetically.-->
1414
<table class="table"><thead>
15-
<tr><td><strong>Providers</strong> &gt;<hr/>Dependents \/</td><td>&#160;</td><td>&#160;</td><td> <a href="Bootstrap">Bootstrap</a></td><td> Clipboard And Indent</td><td><a href="ExtraCommands">Commands</a></td><td>DB Objects</td><td><a href="ExtensionSequencer">ExtensionSequencer</a></td><td>Miscellaneous</td><td><a href="SelBlocksGlobal">SelBlocksGlobal</a></td><td><a href="Settings">Settings</a></td><td>SQLite<br/>Connection<br/>Manager</td><td>TestCase<br>Debug<br>Context</td></tr>
15+
<tr><td><strong>Providers</strong> &gt;<hr/>Dependents \/</td><td>&#160;</td><td>&#160;</td><td> <a href="Bootstrap">Bootstrap</a></td><td> Clipboard And Indent</td><td><a href="Commands">Commands</a></td><td>DB Objects</td><td><a href="ExtensionSequencer">ExtensionSequencer</a></td><td>Miscellaneous</td><td><a href="SelBlocksGlobal">SelBlocksGlobal</a></td><td><a href="Settings">Settings</a></td><td>SQLite<br/>Connection<br/>Manager</td><td>TestCase<br>Debug<br>Context</td></tr>
1616
</thead>
1717
<tbody>
1818
<tr><td> <a href="AutoCheck">AutoCheck</a> </td><td> <a href='https://addons.mozilla.org/en-US/firefox/addon/selite-auto-check/'>info</a> </td><td> <a href='https://addons.mozilla.org/en-US/firefox/addon/selite-auto-check/versions/'>download</a> </td><td> X </td><td> </td><td> </td><td> </td><td> X </td><td> X </td><td> </td><td> X </td><td> </td><td> X </td></tr>
1919
<tr><td> <a href="Bootstrap">Bootstrap</a> </td><td> <a href='https://addons.mozilla.org/en-US/firefox/addon/selite-bootstrap/'>info</a> </td><td> <a href='https://addons.mozilla.org/en-US/firefox/addon/SeLite-Bootstrap/versions/'>download</a> </td><td> </td><td> </td><td> </td><td> </td><td> X </td><td> X </td><td> X </td><td> X </td><td> </td><td> </td></tr>
2020
<tr><td> Clipboard And Indent </td><td> <a href='https://addons.mozilla.org/en-US/firefox/addon/selite-clipboard-and-indent/'>info</a> </td><td> <a href='https://addons.mozilla.org/en-US/firefox/addon/selite-clipboard-and-indent/versions'>download</a> </td><td> </td><td> </td><td> </td><td> </td><td> X </td><td> </td><td> </td><td> X(*) </td><td> </td><td> </td></tr>
21-
<tr><td> <a href='ExtraCommands'>Commands</a> </td><td> <a href='https://addons.mozilla.org/en-US/firefox/addon/selite-commands/'>info</a> </td><td> <a href='https://addons.mozilla.org/en-US/firefox/addon/selite-commands/versions/'>download</a> </td><td> </td><td> </td><td> </td><td> </td><td> X </td><td> X </td><td> </td><td> X </td><td> </td><td> </td></tr>
21+
<tr><td> <a href='Commands'>Commands</a> </td><td> <a href='https://addons.mozilla.org/en-US/firefox/addon/selite-commands/'>info</a> </td><td> <a href='https://addons.mozilla.org/en-US/firefox/addon/selite-commands/versions/'>download</a> </td><td> </td><td> </td><td> </td><td> </td><td> X </td><td> X </td><td> </td><td> X </td><td> </td><td> </td></tr>
2222
<tr><td> DB Objects </td><td> <a href='https://addons.mozilla.org/en-US/firefox/addon/selite-db-objects/'>info</a> </td><td> <a href='https://addons.mozilla.org/en-US/firefox/addon/selite-db-objects/versions/'>download</a> </td><td> </td><td> </td><td> X </td><td> </td><td> X </td><td> X </td><td> </td><td> X </td><td> X </td><td> </td></tr>
2323
<tr><td> <a href="ExitConfirmationChecker">ExitConfirmationChecker</a> </td><td> <a href='https://addons.mozilla.org/en-US/firefox/addon/selite-exit-confirmation-check/'>info</a> </td><td> <a href='https://addons.mozilla.org/en-US/firefox/addon/selite-exit-confirmation-check/versions'>download</a> </td><td> </td><td> </td><td> X(*) </td><td> </td><td> X </td><td> </td><td> </td><td> X </td><td> </td><td> X </td></tr>
2424
<tr><td> <a href="ExtensionSequencer">ExtensionSequencer</a> </td><td> <a href='https://addons.mozilla.org/en-US/firefox/addon/selite-extension-sequencer/'>info</a> </td><td> <a href='https://addons.mozilla.org/en-US/firefox/addon/selite-extension-sequencer/versions/'>download</a> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td></tr>
@@ -35,7 +35,7 @@ If you disable some components, do it at {{chromeUrl}} _about:addons_. Don't dis
3535
Notes
3636

3737
* Clipboard And Indent can work without [Settings](Settings). Then the default indentation step is 4 spaces.
38-
* [Exit Confirmation Checker] can be used either with or without [ExtraCommands](ExtraCommands). If used together, then it applies to Selenese defined in [ExtraCommands](ExtraCommands).
38+
* [Exit Confirmation Checker] can be used either with or without [Commands](Commands). If used together, then it applies to Selenese defined in [Commands](Commands).
3939
* Miscellaneous, [Settings](Settings) and SQLite Connnection Manager can be used without Selenium IDE (as Javascript code modules). Then they don't require [Extension Sequencer]. However, if you want to use them within Selenium IDE, you need [Extension Sequencer], too.
4040
* Run All Favorites also requires [Favorites (Selenium IDE)](https://addons.mozilla.org/en-US/firefox/addon/favorites-selenium-ide/).
4141
* [Settings](Settings) can be used without DB Objects, but then you can't reload [script][script db]/vanilla[vanilla db]/[app DB] through GUI (as per {{navReloadingDatabases}}).

ExtraCommands.md

+6-50
Original file line numberDiff line numberDiff line change
@@ -1,55 +1,11 @@
11
---
22
layout: default
33
---
4-
{% include links %}
5-
* TOC
6-
{:toc}
74

8-
# Overview
9-
[SeLite Commands](https://addons.mozilla.org/en-US/firefox/addon/selite-commands/) ([Components](Components) > [Commands](Components#commands)) provides several Selenese commands and related functionality.
5+
<!-- Don't use permalink: /Commands in YAML matter above. It doesn't auto-redirect. -->
6+
### Page has moved
107

11-
# Robust commands #
12-
Commands with name in form `xxxRobust: typeRobust, clickRobust, selectRobust` action the same as original commands `xxx`, but if the target doesn't exist, then they skip and they don't fail.
13-
14-
# Random data #
15-
Commands with name in form `xxxRandom: clickRandom, selectRandom, typeRandom, typeRandomEmail` generate controlled random data. The commands enter (or select or click) a random value(or an option or a radio button) for a given field (of a specified type). Optionally, they can also store the entered/selected/clicked text/choice in a given Selenese variable, so that the [script] can use it later (e.g. to store it in [script] DB).
16-
17-
Those commands perform two functions
18-
19-
* main purpose: click/select a random element (matching the given selector), or type random text (more below)
20-
* optionally, capture the value of that clicked/selected element, or capture the typed text, into a stored variable. That facilitates later stages (e.g. when you submit the form and load a view of the record, then you want can validate that the clicked/selected/typed data got submitted).
21-
22-
For that the commands have two parameters:
23-
24-
* `selectLocator` (or `radiosXPath` or `locator`), required: a selector to match the set of elements, from which it chooses a random one
25-
* `store` or `paramsOrStore` (optional):
26-
* `store` is a name of stored variable, where the command saves the clicked/selected/typed value. It may include field or sub(sub-...)-field e.g. `variableName.fieldName, variableName.fieldName.subfieldName...`
27-
* `paramsOrStore` can be either
28-
* a string: a name of stored variable, just like `store` above
29-
* an object with one or multiple fields. Following examples use [SelBlocks Global] and its [EnhancedSelenese](EnhancedSelenese) to pass objects through `=<>...<>` notation.
30-
31-
`typeRandomEmail` co-operates with `typeRandom`. It types a random email address, based on a name already typed in another element.
32-
33-
For more details see [its Selenese tests](https://github.com/selite/selite/tree/master/commands/selenese-scripts).
34-
35-
# Timestamp-related commands #
36-
There are two sets of functionality that support [TimeStamps](TimeStamps). The first set defines commands (primary names): `sleepUntilTimestampDistinctDownToMilliseconds, sleepUntilTimestampDistinctDownToSeconds, sleepUntilTimestampDistinctDownToMinutes`. Each ensures that a timestamp from that moment will be unique, when compared to any timestamp created just before any previous or future call to the same command (or to a command with finer precision).
37-
38-
The second set defines functions `isTimestampDownToMilliseconds, isTimestampDownToSeconds, isTimestampDownToMinutes, isTimestampDownToPrecision`. You can't access those directly as commands in Selenium IDE. Instead, use commands like `verifyTimestampDownToSeconds` (see also {{navAutoGeneratedSeleneseCommands}}). Those serve to validate a displayed timestamp (identified by locator in `target` parameter) against a previously saved timestamp (passed in `value` parameter).
39-
40-
The second set also auto-generates commands like `waitForTimestampDownToSeconds`. However, do not use those commands because they could be misplaced with `sleeUntilTimestampDistinctDownToSeconds`. To prevent confusion, this subset of auto-generated commands (`waitForTimestampDownToSeconds` and similar) are handled specially: they fail. If you need to wait for a timestamp and to validate it, use a different `waitFor...` command (targeting the related element), and then verify or assert the timestamp (with e.g. `assertTimestampDownToSeconds`).
41-
42-
## Basic usage ##
43-
* trigger a change
44-
* `storeTimestampDownToSeconds` (or similar - for the chosen precision)
45-
* `sleepUntilTimestampDistinctDownToSeconds` (or similar)
46-
* load a view
47-
* `assertTimestampDownToSeconds` (or `verifyTimestampDownToSeconds`) against the stored timestamp
48-
49-
# Other commands #
50-
* `disableJavascript, enableJavascript`: disable/enable Javascript for the web application that is being automated
51-
* `indexBy` - index objects
52-
* `selectTopFrameAnd`
53-
54-
# Reference #
55-
For details see reference of those commands in Selenium IDE, [online](https://cdn.rawgit.com/selite/selite/master/commands/src/chrome/content/reference.xml) or locally at {{chromeUrl}} _chrome://selite-extension-sequencer/content/selenese_reference.html?chrome://selite-commands/content/reference.xml_.
8+
Please see [Commands](Commands) instead.
9+
<script type="text/javascript">
10+
location.href= "/Commands";
11+
</script>

Terminology.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ It can be
9595

9696
* from XML using SelBlocks functionality (a part of [SelBlocks Global])
9797
* from SQLite with the help of SeLite object-oriented layer
98-
* random, within a range or from a list of choices, using SeLite [ExtraCommands](ExtraCommands)
98+
* random, within a range or from a list of choices, using SeLite [Commands](Commands)
9999

100100
## Test session
101101
It contains custom runtime variables in the test system, which serve for

0 commit comments

Comments
 (0)