Skip to content

Commit f6efc8c

Browse files
committed
<span> to <div> since the latter is block element.
1 parent 758de90 commit f6efc8c

File tree

11 files changed

+51
-37
lines changed

11 files changed

+51
-37
lines changed

docs/commands/codeception.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# CLI commands: vendor/bin/codecept
22

33

4-
<span class="bs-callout bs-callout-warning">
4+
<div class="bs-callout bs-callout-warning">
55
We do not recommend using Codeception commands directly as they can break the MFTF basic workflow.
6-
All the Codeception commands you need are wrapped using the [`mftf` tool][].</span>
6+
All the Codeception commands you need are wrapped using the [`mftf` tool][].</div>
77

88
To run the Codeception testing framework commands directly, change your directory to the `<Magento root>`.
99

@@ -35,9 +35,9 @@ vendor/bin/codecept run functional --group example --skip-group skip
3535
vendor/bin/codecept run
3636
```
3737

38-
<span class="bs-callout .bs-callout-info"
38+
<div class="bs-callout .bs-callout-info">
3939
The following documentation corresponds to Codeception 2.3.8.
40-
</span>
40+
</div>
4141

4242
```bash
4343
Full reference:

docs/commands/mftf.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# CLI commands: vendor/bin/mftf
22

3-
<span class="style="text-align: right"">_This topic was updated due to the 2.3.13 MFTF release._</span>
4-
53
The Magento Functional Testing Framework (MFTF) introduces the command line interface (CLI) tool `vendor/bin/mftf` to facilitate your interaction with the framework.
64

75
Note that `mftf` commands replace the `robo` commands that were used in previous releases.

docs/configuration.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ Example:
1818
MAGENTO_BASE_URL=http://magento2.vagrant251
1919
```
2020

21-
<span class=".bs-callout .bs-callout-info">
21+
<div class=".bs-callout .bs-callout-info">
2222
If the `MAGENTO_BASE_URL` contains a subdirectory (like `http://magento.test/magento2ce`), specify [`MAGENTO_CLI_COMMAND_PATH`][].
23-
</span>
23+
</div>
2424

2525
### MAGENTO_BACKEND_NAME
2626

@@ -86,10 +86,10 @@ SELENIUM_PROTOCOL=http
8686
SELENIUM_PATH=/wd/hub
8787
```
8888

89-
<span class=".bs-callout .bs-callout-warning">
89+
<div class=".bs-callout .bs-callout-warning">
9090
`SELENIUM_*` values are required if you are running Selenium on an external system.
9191
If you change the configuration of the external Selenium server, you must update these values.
92-
</span>
92+
</div>
9393

9494
#### SELENIUM_HOST
9595

docs/credentials.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -89,8 +89,8 @@ The MFTF dynamically retrieves, encrypts, and decrypts the sensitive data during
8989
Decrypted credentials do not appear in the console, error logs, or [test reports][].
9090
The decrypted values are only available in the `.credentials` file.
9191

92-
<span class=".bs-callout .bs-callout-info">
93-
The MFTF tests delivered with Magento application do not use credentials and do not cover external services, because of sensitivity of the data.</span>
92+
<div class=".bs-callout .bs-callout-info">
93+
The MFTF tests delivered with Magento application do not use credentials and do not cover external services, because of sensitivity of the data.</div>
9494

9595
<!-- Link definitions -->
9696
[`fillField`]: test/actions.md#fillfield

docs/getting-started.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -68,9 +68,9 @@ To disable the WYSIWYG and enable the web driver to process these fields as simp
6868
3. In the WYSIWYG Options section set the **Enable WYSIWYG Editor** option to **Disabled Completely**.
6969
4. Click **Save Config**.
7070

71-
<span class=".bs-callout .bs-callout-tip">
71+
<div class=".bs-callout .bs-callout-tip">
7272
When you want to test the WYSIWYG functionality, re-enable WYSIWYG in your test suite.
73-
</span>
73+
</div>
7474

7575
### Security settings {#security-settings}
7676

@@ -115,10 +115,10 @@ vendor/bin/mftf generate:urn-catalog --force .idea/
115115

116116
See [`generate:urn-catalog`][] for more details.'
117117

118-
<span class=".bs-callout .bs-callout-tip">
118+
<div class=".bs-callout .bs-callout-tip">
119119
You can simplify command entry by adding the absolute path to the `vendor/bin` directory path to your PATH environment variable.
120120
After adding the path, you can run `mftf` without having to include `vendor/bin`.
121-
</span>
121+
</div>
122122

123123
### Step 2. Edit environmental settings {#environment-settings}
124124

docs/introduction.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,10 @@ MFTF improves:
1515
- **Maintainability** based on simple test creation and overall structure.
1616

1717
Because MFTF tests are written in XML, you no longer need to learn PHP to write tests.
18-
<span class=".bs-callout .bs-callout-info">
18+
<div class=".bs-callout .bs-callout-info">
1919
We are actively developing functional tests.
2020
Refer to `<magento_root>/app/code/<vendor_name>/<module_name>/Test/Mftf/` for examples.
21-
</span>
21+
</div>
2222

2323
## Audience
2424

docs/reporting.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -277,9 +277,9 @@ Each time you run tests, the MFTF appends an XML file with results at the `tests
277277

278278
The official [Allure Test Report][] documentation is well-covered, so we'll list only the CLI commands that you would need for your day-to-day work.
279279

280-
<span class=".bs-callout .bs-callout-info">
280+
<div class=".bs-callout .bs-callout-info">
281281
The following commands are relative to the Magento installation directory.
282-
</span>
282+
</div>
283283

284284
To generate a report to the `allure-report/` at the current directory:
285285

docs/section.md

Lines changed: 20 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,10 @@ A `<section>` can define:
1414
Substitutable values in the test can be of the following formats:
1515

1616
- String literals (`stringLiteral`)
17-
- References to a [data entity](./data.md) (XML data from the corresponding `.../Data/*.xml`) such as `entityName.Field`.
17+
- References to a [data entity][] (XML data from the corresponding `.../Data/*.xml`) such as `entityName.Field`.
1818
- Persisted data:
19-
- `$persistedCreateDataKey.field$` for data created in the scope of a [test](./test.md#test-tag) using the [`<createData>`](./test/actions.md#createdata) action with `stepKey="persistedCreateDataKey"`.
20-
- `$$persistedCreateDataKey.field$$` for data created in [before](./test.md#before-tag) and [after](./test.md#after-tag) hooks. Even though `<before>`and `<after>` are nested inside a [test](./test.md#test-tag), persisted data is stored differently when it is done in a test hook. Therefore it must be accessed with a different notation.
19+
- `$persistedCreateDataKey.field$` for data created in the scope of a [test][] using the [`<createData>`][] action with `stepKey="persistedCreateDataKey"`.
20+
- `$$persistedCreateDataKey.field$$` for data created in [before][] and [after][] hooks. Even though `<before>`and `<after>` are nested inside a [test][], persisted data is stored differently when it is done in a test hook. Therefore it must be accessed with a different notation.
2121

2222
The following diagram shows the XML structure of an MFTF section:
2323

@@ -84,7 +84,7 @@ The following is an example of a call in test:
8484

8585
### section {#section-tag}
8686

87-
`<section>` contains the sequence of UI elements in a section of a [page](./page.md).
87+
`<section>` contains the sequence of UI elements in a section of a [page][].
8888

8989
Attributes|Type|Use|Description
9090
---|---|---|---
@@ -93,16 +93,16 @@ Attributes|Type|Use|Description
9393

9494
### element {#element-tag}
9595

96-
`<element>`is a UI element used in an [action](./test/actions.md).
96+
`<element>`is a UI element used in an [action][].
9797

9898
Attributes|Type|Use|Description
9999
---|---|---|---
100100
`name`|string|required|The element name; Must be alphanumeric.
101101
`type`|string|required|The type of the element. Possible values: `text`, `textarea`, `input`, `button`, `checkbox`, `radio`, `checkboxset`, `radioset`, `date`, `file`, `select`, `multiselect`, `wysiwyg`, `iframe`, `block`.
102-
`selector`|string|optional|[XPath](https://www.w3schools.com/xml/xpath_nodes.asp) or [CSS](https://www.w3schools.com/cssref/css_selectors.asp) selector of the element.
103-
`locatorFunction`|string|optional|[Locator function](./section/locator-functions.md) declaration to be used in lieu of a selector.
102+
`selector`|string|optional|[XPath][] or [CSS][] selector of the element.
103+
`locatorFunction`|string|optional|[Locator function][] declaration to be used in lieu of a selector.
104104
`timeout`|string|optional|The timeout after interaction with the element (in seconds). The default is _none_.
105-
`parameterized`|boolean|optional|Include and set to `true` if the `selector` for this element has parameters that need to be replaced for proper use. Learn more in [Parameterized selectors](./section/parameterized-selectors.md).
105+
`parameterized`|boolean|optional|Include and set to `true` if the `selector` for this element has parameters that need to be replaced for proper use. Learn more in [Parameterized selectors][].
106106
`remove`|boolean|optional|The default is `false`. Set to `true` to remove this element during parsing.
107107

108108
#### `timeout` attribute {#timeout-attribute}
@@ -138,4 +138,15 @@ Whenever the `signIn` button is used in a test, the MFTF will add a 30 second `w
138138

139139
<!-- Link definitions -->
140140

141-
[waitForPageLoad]: test/actions.md#waitforpageload
141+
[waitForPageLoad]: test/actions.md#waitforpageload
142+
[data entity]: ./data.md
143+
[test]: ./test.md#test-tag
144+
[`<createData>`]: ./test/actions.md#createdata
145+
[before]: ./test.md#before-tag
146+
[after]: ./test.md#after-tag
147+
[page]: ./page.md
148+
[action]: ./test/actions.md
149+
[XPath]: https://www.w3schools.com/xml/xpath_nodes.asp
150+
[CSS]: https://www.w3schools.com/cssref/css_selectors.asp
151+
[Locator function]: ./section/locator-functions.md
152+
[Parameterized selectors]: ./section/parameterized-selectors.md

docs/section/parameterized-selectors.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,9 +73,9 @@ For the parameterized part of the selector, add `{{var1}}, {{var2}}, ..., {{varN
7373
</section>
7474
```
7575

76-
<span class="bs-callout .bs-callout-info">
76+
<div class="bs-callout .bs-callout-info">
7777
There is no need to use sequential variables like `{{var1}}`, `{{var2}}`. Parameterized replacement reads variables and maps them to the test call of the element sequentially from left to right, meaning you can use a selector like `#element .{{categoryId}} .{{productId}}`."
78-
</span>
78+
</div>
7979

8080
## Use a parameterized selector in a test
8181

docs/test/actions.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1349,8 +1349,8 @@ Note that the makeScreenshot action does not automatically add the screenshot to
13491349
<makeScreenshot userInput="example" stepKey="screenshotPage"/>
13501350
```
13511351

1352-
<span class=".bs-callout .bs-callout-info">
1353-
This action does not add a screenshot to the Allure [report](../reporting.md).</span>
1352+
<div class=".bs-callout .bs-callout-info">
1353+
This action does not add a screenshot to the Allure [report](../reporting.md).</div>
13541354

13551355
### maximizeWindow
13561356

@@ -2474,9 +2474,9 @@ Attribute|Type|Use|Description
24742474

24752475
Wait for all Magento loading overlays to disappear.
24762476

2477-
<span class=".bs-callout .bs-callout-info">
2477+
<div class=".bs-callout .bs-callout-info">
24782478
The CSS class for loading masks is not used consistently throughout Magento.
2479-
Therefore, this convenience function tries to wait for various specific selectors.</span>
2479+
Therefore, this convenience function tries to wait for various specific selectors.</div>
24802480

24812481
```config
24822482
# Wait for these classes to not be visible

0 commit comments

Comments
 (0)