Skip to content
This repository was archived by the owner on Nov 19, 2024. It is now read-only.

Commit 2619038

Browse files
Small changes (#4799)
* Update checkout_new_step.md Custom step is hidden when using back button * Add __('<your_string>') method in Alert Widget For Alert widget, Add __('<your_string>') method in Example because this method is used for translation of the string. * Fix description of theme.xml contents * Fixed up formatting errors. * Update docs about composer-packaged themes to include naming convention * Fix root to be visible on Magento DevDocs website The Magento website (https://devdocs.magento.com/guides/v2.3/config-guide/cli/config-cli-subcommands-mode.html) renders the <magento_root> tags as html, so they are not visible to the reader. * Add bash code block around the command * Apply suggestions from code review Co-Authored-By: Jeff Matthews <[email protected]> * Add content related to loader widget * Add __('<your_string>') method in Examples Add __('<your_string>') method in Confirm Widget Example
1 parent 171fe19 commit 2619038

File tree

10 files changed

+37
-19
lines changed

10 files changed

+37
-19
lines changed

guides/v2.1/extension-dev-guide/package/package_module.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ The `composer.json` uses [Composer's generic schema](https://getcomposer.org/doc
2727

2828
Element | Description
2929
--- | ---
30-
`name` | A fully-qualified component name, in the format `<vendor-name>/<component-name>`. All letters must be in lowercase. Use dashes in the `<component-name>` to separate words.
30+
`name` | A fully-qualified component name, in the format `<vendor-name>/<component-name>`. All letters must be in lowercase. Use dashes in the `<component-name>` to separate words. Themes must use the format `<vendor-name>/theme-<area>-<theme-name>`.
3131
`type` | For modules, this value must be set to `magento2-module`. Other possible types are `metapackage`, `magento2-theme`, and `magento2-language`.
3232
`autoload` | Specify necessary information to be loaded, such as [registration.php]({{ page.baseurl }}/extension-dev-guide/build/component-registration.html). For more information, see [Autoloading](https://getcomposer.org/doc/01-basic-usage.md#autoloading) from Composer.
3333

guides/v2.1/frontend-dev-guide/themes/theme-structure.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -230,7 +230,7 @@ The directories and files structure described below is the most extended one. It
230230
</td>
231231
<td colspan="1">optional</td>
232232
<td colspan="1">
233-
Describes the theme dependencies and some meta-information. Will be here if your theme is a Composer package.
233+
Describes the theme dependencies and some meta-information. Will be here if your theme is a Composer package. The "name" field must be in the format <code>"&lt;vendor-name&gt;/theme-&lt;area&gt;-&lt;theme-name&gt;"</code>.
234234
</td>
235235
</tr>
236236
<tr>
@@ -248,7 +248,7 @@ The directories and files structure described below is the most extended one. It
248248
</td>
249249
<td colspan="1">required</td>
250250
<td colspan="1">
251-
The file is mandatory as it declares a theme as a system component. It contains the basic meta-information, like the theme name and the parent theme name, if the theme is inherited from an existing theme. The file is used by the Magento system to recognize the theme.
251+
The file is mandatory as it declares a theme as a system component. It contains the basic meta-information, like the theme title and the parent theme name, if the theme is inherited from an existing theme. The file is used by the Magento system to recognize the theme.
252252
</td>
253253
</tr>
254254
</tbody>

guides/v2.1/howdoi/checkout/checkout_new_step.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,9 +106,11 @@ define(
106106
* The navigate() method is responsible for navigation between checkout step
107107
* during checkout. You can add custom logic, for example some conditions
108108
* for switching to your custom step
109+
* When the user navigates to the custom step via url anchor or back button we_must show step manually here
109110
*/
110111
navigate: function () {
111112

113+
this.isVisible(true);
112114
},
113115

114116
/**

guides/v2.1/javascript-dev-guide/widgets/widget_alert.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ The alert widget can be initialized with or without binding to a certain element
1919

2020
```javascript
2121
$('#init_element').alert({
22-
title: 'Warning',
23-
content: 'Warning content',
22+
title: $.mage.__('Warning'),
23+
content: $.mage.__('Warning content'),
2424
actions: {
2525
always: function(){}
2626
}
@@ -34,8 +34,8 @@ require([
3434
], function(alert) { // Variable that represents the `alert` function
3535

3636
alert({
37-
title: 'Some title',
38-
content: 'Some content',
37+
title: $.mage.__('Some title'),
38+
content: $.mage.__('Some content'),
3939
actions: {
4040
always: function(){}
4141
}

guides/v2.1/javascript-dev-guide/widgets/widget_confirm.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ The confirmation widget can be initialized with or without binding to a certain
2020

2121
```javascript
2222
$('#confirm_init').confirm({
23-
title: 'Confirmation title',
23+
title: $.mage.__('Confirmation title'),
2424
actions: {
2525
confirm: function(){}, //callback on 'Ok' button click
2626
cancel: function(){}, //callback on 'Cancel' button click
@@ -36,8 +36,8 @@ require([
3636
], function(confirmation) { // Variable that represents the `confirm` widget
3737

3838
confirmation({
39-
title: 'Some title',
40-
content: 'Some content',
39+
title: $.mage.__('Some title'),
40+
content: $.mage.__('Some content'),
4141
actions: {
4242
confirm: function(){},
4343
cancel: function(){},

guides/v2.1/javascript-dev-guide/widgets/widget_loader.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ $("#element").loader("show");
6868

6969
Hide the loader.
7070

71-
Invoke the show method:
71+
Invoke the hide method:
7272

7373
```javascript
7474
$("#element").loader("hide");
@@ -83,8 +83,20 @@ Loader is subscribed to the following events:
8383
### `processStart` {#l_processStart}
8484
Display the loader. Can be triggered on any page element.
8585

86+
Start show loading:
87+
88+
```javascript
89+
$("body").trigger('processStart');
90+
```
91+
8692
### `processStop` {#l_processStop}
8793
Hide the loader. Can be triggered on any page element.
8894

95+
Stop show loading:
96+
97+
```javascript
98+
$("body").trigger('processStop');
99+
```
100+
89101
[lib/web/mage/loader.js]: {{ site.mage2bloburl }}/{{ page.guide_version }}/lib/web/mage/loader.js
90102
[JavaScript initialization]: {{page.baseurl}}/javascript-dev-guide/javascript/js_init.html

guides/v2.2/config-guide/cli/config-cli-subcommands-mode.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,8 +125,10 @@ When you change from production to developer mode, you should clear generated cl
125125

126126
1. If you're changing from production mode to developer mode, delete the contents of the `generated/code` and `generated/metadata` directories:
127127

128+
```bash
128129
rm -rf <magento_root>/generated/metadata/* <magento_root>/generated/code/*
129-
130+
```
131+
130132
2. Set the mode:
131133

132134
```bash

guides/v2.2/frontend-dev-guide/themes/theme-structure.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -230,7 +230,7 @@ The directories and files structure described below is the most extended one. It
230230
</td>
231231
<td colspan="1">optional</td>
232232
<td colspan="1">
233-
Describes the theme dependencies and some meta-information. Will be here if your theme is a Composer package.
233+
Describes the theme dependencies and some meta-information. Will be here if your theme is a Composer package. The "name" field must be in the format <code>"&lt;vendor-name&gt;/theme-&lt;area&gt;-&lt;theme-name&gt;"</code>.
234234
</td>
235235
</tr>
236236
<tr>
@@ -248,7 +248,7 @@ The directories and files structure described below is the most extended one. It
248248
</td>
249249
<td colspan="1">required</td>
250250
<td colspan="1">
251-
The file is mandatory as it declares a theme as a system component. It contains the basic meta-information, like the theme name and the parent theme name, if the theme is inherited from an existing theme. The file is used by the Magento system to recognize the theme.
251+
The file is mandatory as it declares a theme as a system component. It contains the basic meta-information, like the theme title and the parent theme name, if the theme is inherited from an existing theme. The file is used by the Magento system to recognize the theme.
252252
</td>
253253
</tr>
254254
</tbody>

guides/v2.3/comp-mgr/patching.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,9 @@ When the [patch][] program is run, this file is read in and the specified change
3434
1. Login to the server as the [Magento admin user][] and verify the file is in the correct directory.
3535
1. In the command line interface, run the following commands according to the patch extension:
3636

37-
patch < patch_file_name.patch
37+
```bash
38+
patch < patch_file_name.patch
39+
```
3840

3941
The command assumes the file to be patched is located relative to the patch file.
4042

@@ -55,7 +57,7 @@ Please refer to the [Magento Help Center][] for details on how to use Composer t
5557
<!-- Link Definitions -->
5658
[Magento Security Center]:https://magento.com/security/patches
5759
[-p1 instead of -p0]:http://man7.org/linux/man-pages/man1/patch.1.html
58-
[Back up and roll back the file system]:https://devdocs.magento.com/guides/v2.3/install-gde/install/cli/install-cli-backup.html
60+
[Back up and roll back the file system]:{{ page.baseurl }}/install-gde/install/cli/install-cli-backup.html
5961
[patch]:https://en.wikipedia.org/wiki/Patch_(Unix)
6062
[Magento Help Center]:https://support.magento.com/hc/en-us/articles/360005484154-Create-a-patch-for-a-Magento-2-Composer-installation-from-a-GitHub-commit
61-
[Magento Admin user]:https://devdocs.magento.com/guides/v2.3/config-guide/cli/config-cli.html#config-install-cli-first
63+
[Magento Admin user]:{{ page.baseurl }}/config-guide/cli/config-cli.html#config-install-cli-first

guides/v2.3/frontend-dev-guide/themes/theme-structure.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -230,7 +230,7 @@ The directories and files structure described below is the most extended one. It
230230
</td>
231231
<td colspan="1">optional</td>
232232
<td colspan="1">
233-
Describes the theme dependencies and some meta-information. Will be here if your theme is a Composer package.
233+
Describes the theme dependencies and some meta-information. Will be here if your theme is a Composer package. The "name" field must be in the format <code>"&lt;vendor-name&gt;/theme-&lt;area&gt;-&lt;theme-name&gt;"</code>.
234234
</td>
235235
</tr>
236236
<tr>
@@ -248,7 +248,7 @@ The directories and files structure described below is the most extended one. It
248248
</td>
249249
<td colspan="1">required</td>
250250
<td colspan="1">
251-
The file is mandatory as it declares a theme as a system component. It contains the basic meta-information, like the theme name and the parent theme name, if the theme is inherited from an existing theme. The file is used by the Magento system to recognize the theme.
251+
The file is mandatory as it declares a theme as a system component. It contains the basic meta-information, like the theme title and the parent theme name, if the theme is inherited from an existing theme. The file is used by the Magento system to recognize the theme.
252252
</td>
253253
</tr>
254254
</tbody>

0 commit comments

Comments
 (0)