Skip to content

Commit 9451087

Browse files
author
Ivan Bochkarev
committed
refactor(docs): Исправление синтаксиса
1 parent 14d06c6 commit 9451087

File tree

7 files changed

+30
-42
lines changed

7 files changed

+30
-42
lines changed

docs/components/idimage/crontab.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,9 @@
2020
Использование в сторонних решениях
2121

2222
```php
23-
2423
# Подключение библиотеки
2524
$idImage = $modx->getService('idimage', 'idImage', MODX_CORE_PATH.'components/idimage/model/');
2625

27-
2826
# Создание товаров
2927
$Command = new \IdImage\Command\CreationCommand($idImage, $cli);
3028
$Command->run();
@@ -36,5 +34,4 @@ $Command->run();
3634
# Индексация товаров
3735
$command = new \IdImage\Command\IndexedCommand($idImage, $cli, 100);
3836
$command->run();
39-
4037
```

docs/components/idimage/index.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,14 +40,13 @@ items: [
4040
обеспечивая точные рекомендации.
4141

4242
#### Вкладка «Похоже товары»
43+
4344
После установки пакета в карточку товара MiniShop будет добавлена вкладка для отображения похожих товаров.
4445

4546
Она выглядит как обычная галерея, но на самом деле содержит товары, которые были автоматически подобраны.
4647

4748
![Похоже товары ](https://file.modx.pro/files/a/5/a/a5a9c6fe5c7b3c52994a27c5b4837935.png)
4849

49-
50-
5150
#### Пример блока похожие товары
5251

5352
*Товары подобраны автоматически без дополнительных характеристик.*

docs/components/idimage/indexed/index.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939
::: warning Важно
4040

4141
- Получение векторов может занять значительное время. За один проход обрабатывается 20 изображений.
42-
- Время выполнения одного прохода зависит от скорости интернета и загруженности сервиса idimage.ru, время запроса может составить от 1 секунды и более.
42+
- Время выполнения одного прохода зависит от скорости интернета и загруженности сервиса idimage.ru, время запроса может составить от 1 секунды и более.
4343
:::
4444

4545
### 3. Индексация товаров
@@ -48,14 +48,13 @@
4848

4949
![Индексация товаров](https://file.modx.pro/files/e/9/9/e9907ff791dc0ee2d78023866b52495e.png)
5050

51-
*После создания заданий появится запрос на запуск очереди для получения похожих товаров. Подтвердите действие или вы может позже запустить очередь на
52-
вкладке "**Задания**".*
51+
*После создания заданий появится запрос на запуск очереди для получения похожих товаров. Подтвердите действие или вы может позже запустить очередь на вкладке "**Задания**".*
5352

5453
::: warning Важно
5554

5655
- Убедитесь, что для всех изображений получены вектора.
5756
- Индексация может занять значительное время. Скорость выполнения зависит от количества товаров и мощности сервера. Чем больше товаров, тем дольше занимает
58-
процесс.
57+
процесс.
5958
:::
6059

6160
### 4. Размещение сниппета на странице
@@ -67,8 +66,7 @@
6766

6867
Добавьте следующий код в шаблон карточки товара:
6968

70-
```shell
71-
69+
```fenom
7270
{var $ids = $modx->runSnippet('idImageSimilar', [
7371
'pid' => $modx->resource->id,
7472
'min_scope' => 65,
@@ -87,7 +85,7 @@
8785

8886
## Задания
8987

90-
Задания необходимы для бесперебойного процесса индексации и векторизации.
88+
Задания необходимы для бесперебойного процесса индексации и векторизации.
9189
Вы можете управлять очередью заданий вручную или настроить их автоматический запуск в [фоновом режиме](/components/idimage/crontab).
9290

9391

docs/components/idimage/indexed/type.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@
44

55
![Тип индексации](https://file.modx.pro/files/8/b/1/8b1f7a1e6028293d6a1331df3783acea.png)
66

7-
8-
97
### Все товары
108

119
Сравнение всех товаров каталога со всеми
@@ -18,7 +16,7 @@
1816

1917
Товары, находящиеся в категории **Второй уровень**, сравниваются со всеми товарами, принадлежащими категории **Первый уровень**.
2018

21-
**Пример структуры каталога:**
19+
**Пример структуры каталога:**
2220
**Каталог → Первый уровень → Второй уровень**
2321

2422
Это означает, что при сравнении товаров из **Второго уровня** будут учитываться все товары из **Первого уровня**, к которому он относится.

docs/components/idimage/quick-start.md

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525

2626
![Проверка баланса](https://file.modx.pro/files/8/d/1/8d112cfd4e738b6c1b35865281513d17.png)
2727

28-
::: warning Важно
28+
::: warning Важно
2929
Баланс запросов в сервисе [idimage.ru](https://idimage.ru) должен быть положительным!
3030
:::
3131

@@ -37,7 +37,9 @@
3737

3838
Разместите сниппет в шаблоне карточки товара или в любом другом месте
3939

40-
```shell
40+
::: code-group
41+
42+
```modx
4143
[[!idImageSimilar]]
4244
[[!msProducts?
4345
&resources=`[[+idimage.ids]]`
@@ -47,22 +49,19 @@
4749
]]
4850
```
4951

50-
::: details Fenom
51-
52-
```php
53-
# Fenom
52+
```fenom
5453
{$modx->runSnippet('idImageSimilar', [
5554
'min_scope' => 65
5655
])}
5756
5857
{var $ids = $modx->getPlaceholder('idimage.ids')}
5958
{if $ids}
60-
{$modx->runSnippet('msProducts', [
61-
'tpl' => '@FILE chunks/catalog/product.row.tpl',
62-
'resources' => $ids,
63-
'sortby' => "FIELD(msProduct.id, {$ids})",
64-
'parents' => 0,
65-
])}
59+
{$modx->runSnippet('msProducts', [
60+
'tpl' => '@FILE chunks/catalog/product.row.tpl',
61+
'resources' => $ids,
62+
'sortby' => "FIELD(msProduct.id, {$ids})",
63+
'parents' => 0,
64+
])}
6665
{/if}
6766
```
6867

@@ -72,7 +71,7 @@
7271

7372
**Пример блока с похожими товарами**
7473

75-
::: warning Важно
74+
::: warning Важно
7675
Сниппет **idImageSimilar** возвращает только id товаров, и не каким образом не отвечает за то в каком визуальном виде товары будут выводиться.
7776
:::
7877

docs/components/idimage/requirements-and-dependencies.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,6 @@
99
## Зависимости
1010

1111
**idimage** использует в своей работе компоненты:
12+
1213
- pdoTools версии ^2
1314
- компонент miniShop2 версии ^2

docs/components/idimage/snippets.md

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,12 @@
11
## Сниппеты
22

3-
43
### idImageSimilar
54

65
Сниппет `idImageSimilar` **только предоставляет информацию** о том, какие ID товаров являются похожими на ID выбранного товара.
76

87
Он **не отвечает за отображение** блока с товарами, а лишь передает данные о схожих товарах для дальнейшей обработки.
98

10-
```shell
9+
```modx
1110
[[!idImageSimilar]]
1211
[[!msProducts?
1312
&resources=`[[+idimage.ids]]`
@@ -33,26 +32,23 @@
3332
| **&max_scope** | 100 | Максимальная вероятность от 100 до 0 (по умолчанию 100, если изображение схоже с оригиналом то вероятность будет 100%) |
3433
| **&limit** | 10 | Кол-во возвращаемых id товаров похожих на оригинал |
3534

36-
::: details Fenom
37-
38-
```php
39-
# Fenom
35+
::: code-group
4036

37+
```fenom
4138
# записываем id товаров в плейсхолдер idimage.ids
4239
{$modx->runSnippet('idImageSimilar', [
43-
'min_scope' => 65
40+
'min_scope' => 65
4441
])}
4542
4643
{var $ids = $modx->getPlaceholder('idimage.ids')}
4744
{if $ids}
48-
{$modx->runSnippet('msProducts', [
49-
'tpl' => '@FILE chunks/catalog/product.row.tpl',
50-
'resources' => $ids,
51-
'sortby' => "FIELD(msProduct.id, {$ids})",
52-
'parents' => 0,
53-
])}
45+
{$modx->runSnippet('msProducts', [
46+
'tpl' => '@FILE chunks/catalog/product.row.tpl',
47+
'resources' => $ids,
48+
'sortby' => "FIELD(msProduct.id, {$ids})",
49+
'parents' => 0,
50+
])}
5451
{/if}
55-
5652
```
5753

5854
```php

0 commit comments

Comments
 (0)