Skip to content

Commit

Permalink
docs: correct spelling (#747)
Browse files Browse the repository at this point in the history
  • Loading branch information
@GulomovCreative
GulomovCreative committed Oct 29, 2023
1 parent b8e0da3 commit cf4798d
Show file tree
Hide file tree
Showing 279 changed files with 771 additions and 735 deletions.
4 changes: 2 additions & 2 deletions docs/components/ajaxform.md
View file
Expand Up @@ -13,7 +13,7 @@ repository: https://github.com/modx-pro/AjaxForm
13 июня 2023 года команда [MODX RSC](https://github.com/modx-pro) прекратила поддержку **AjaxForm**. Он будет продолжать быть доступным на маркетплейсах [modstore.pro](https://modstore.pro/packages/utilities/ajaxform) и [extras.modx.com](https://modx.com/extras/package/ajaxform), но мы рекомендуем использовать вместо него компонент [FetchIt](/components/fetchit/).
:::

Cниппет для отправки любых форм через ajax. По умолчанию рассчитан на работу с [FormIt](https://docs.modx.com/current/en/extras/formit), но можно использовать и собственный сниппет.
Сниппет для отправки любых форм через ajax. По умолчанию рассчитан на работу с [FormIt](https://docs.modx.com/current/en/extras/formit), но можно использовать и собственный сниппет.

- Регистрирует нужные скрипты на фронтенде: [jQuery.Form](http://malsup.com/jquery/form/) и [jQuery.jGrowl](http://plugins.jquery.com/jgrowl/).
- Сохраняет в сессию `$scriptProperties` при вызове сниппета.
Expand Down Expand Up @@ -83,7 +83,7 @@ else {
<script type="text/javascript">
$(document).on('submit', '.ajax_form', function() {
// Здесь любой код для проверки формы при отправке
// Я просто печатаю её в консоли бразуреа
// Я просто печатаю её в консоли браузера
console.log(this);
// Результатом работы будет выставление глобальной переменной
Expand Down
2 changes: 1 addition & 1 deletion docs/components/ajaxformitlogin/events.md
View file
Expand Up @@ -20,7 +20,7 @@

1. `$user` - объект пользователя.
2. `$profile` - объект профиля пользователя.
3. `$data` - все данные переданные в масcиве $_POST.
3. `$data` - все данные переданные в массиве $_POST.

::: warning
Не пытайтесь что-то вернуть из ваших плагинов на эти события, так как результаты вызовов этих событий никак не обрабатываются, события инициализируются только для возможности сделать что-то с пользователем и его профилем ПОСЛЕ обновления и активации.
Expand Down
2 changes: 1 addition & 1 deletion docs/components/ajaxformitlogin/hooks/ajaxidentification.md
View file
Expand Up @@ -91,7 +91,7 @@
]}
```

Пароль удобнее всего обновлять отдельно от остальных жанных, чтобы он постоянно не перезаписывался.
Пароль удобнее всего обновлять отдельно от остальных данных, чтобы он постоянно не перезаписывался.

```fenom
{'!AjaxFormitLogin' | snippet : [
Expand Down
2 changes: 1 addition & 1 deletion docs/components/ajaxformitlogin/index.md
View file
Expand Up @@ -156,7 +156,7 @@ else {
```

::: danger
Для вывода ошибок валидации нет необходимости, добавлять в форму блоки с классами `error_имяполя`. Если этого не сделать, то сообщение с ошибкой будет выведено как всплывающее уведомление с текстом формата `имя_поля: текст сообщения`. Если вместо имени поля вы хотите показывать другой текст, укажите в вызове сниппета AjaxFormitLogin параметр `aliases` и параметр `transmittedParams`. `aliases` должен содержать строку вида `имяполя==Выводимый текст, имя_дргого_поля==Какой-то текст`.
Для вывода ошибок валидации нет необходимости, добавлять в форму блоки с классами `error_имя_поля`. Если этого не сделать, то сообщение с ошибкой будет выведено как всплывающее уведомление с текстом формата `имя_поля: текст сообщения`. Если вместо имени поля вы хотите показывать другой текст, укажите в вызове сниппета AjaxFormitLogin параметр `aliases` и параметр `transmittedParams`. `aliases` должен содержать строку вида `имя_поля==Выводимый текст, имя_другого_поля==Какой-то текст`.
Параметр `transmittedParams` должен содержать следующее значение `['error' => 'aliases']`.
:::

Expand Down
2 changes: 1 addition & 1 deletion docs/components/ajaxformitlogin/scripts-and-styles.md
View file
@@ -1,4 +1,4 @@
# Скрипты и cтили
# Скрипты и стили

::: info
**Стили** - компонент не использует своих стилей, кроме тех, что идут в комплекте с библиотекой показа уведомлений IziToast.
Expand Down
6 changes: 3 additions & 3 deletions docs/components/ajaxformitlogin/snippets/ajaxformitlogin.md
View file
Expand Up @@ -28,14 +28,14 @@
| **activation** | | Нужна ли активация, если да - на email пользователя будет выслано письмо с ссылкой на страницу активации. |
| **moderate** | | Нужна ли модерация. Если нужна - профиль пользователя будет заблокирован пока модератор его не разблокирует. |
| **activationResourceId** | | ID ресурса, на который будет отправлен пользователь для активации аккаунта. |
| **usergroupsField** | | Поле со списком групп разделенных запятыми, в которые нужно добавить пользователя при регистрации. Можно указать так же уровень доступа (Member или SuperUser) и rank: group_id:pemission_id:rank, например `2:1:0`. Можно указать только два первых параметра или только ID группы. |
| **usergroupsField** | | Поле со списком групп разделенных запятыми, в которые нужно добавить пользователя при регистрации. Можно указать так же уровень доступа (Member или SuperUser) и rank: group_id:permission_id:rank, например `2:1:0`. Можно указать только два первых параметра или только ID группы. |
| **authenticateContexts** | | Поле со списком контекстов разделенных запятыми, в которых нужно авторизовать пользователя. |
| **rememberme** | | Запоминать ли пользователя. |
| **activationUrlTime** | `10800` | Время действия ссылки на активацию в секундах. |
| **method** | | Метод класса AjaxIdentification (register, login, logout, forgot, update). |

::: tip
Bы так же можете использовать любые [параметры спиппета FormIt](https://docs.modx.com/current/ru/extras/formit).
Bы так же можете использовать любые [параметры сниппета FormIt](https://docs.modx.com/current/ru/extras/formit).
:::

Как видно из таблицы по умолчанию сниппет настроен на отправку форм и сохранение их данных в админке.
Expand All @@ -52,7 +52,7 @@ Bы так же можете использовать любые [парамет
]}
```

и обязательно должен вызываться некешированным. В чанк формы вы можете передавать какие угодно данные, указывая их как параметры сниппета. Так же любые данные можно
и обязательно должен вызываться некэшированным. В чанк формы вы можете передавать какие угодно данные, указывая их как параметры сниппета. Так же любые данные можно
передавать в JS через параметр `transmittedParams`.
А оптимальный вызов такой:

Expand Down
6 changes: 3 additions & 3 deletions docs/components/amocrm/setup.md
View file
Expand Up @@ -7,7 +7,7 @@
| **amocrm_account** | Аккаунт. Поддомен домена amocrm.ru |
| **amocrm_client_id** | ID интеграции, можно получить в виджете интеграции |
| **amocrm_client_secret** | Секрет интеграции, можно получить в виджете интеграции |
| **amocrm_client_code** | Код авторизации, можно получить в виджете нтеграции |
| **amocrm_client_code** | Код авторизации, можно получить в виджете интеграции |
| **amocrm_form_pipeline_id** | Заполняется для отправки из форм. Номер воронки в которую планируете отправлять заявки из форм. Можно взять из адресной строки URL |
| **amocrm_form_status_new** | Заполняется для отправки из форм. ID статуса указанной выше воронки. Можно посмотреть в инспекторе кода, выделив колонку статуса. |
| **amocrm_pipeline_id** | Заполняется для отправки заказов minishop2. Номер воронки в которую планируете отправлять заявки из форм. Можно взять из адресной строки URL. |
Expand All @@ -25,7 +25,7 @@

![Регистрация приложения - 1](https://www.amocrm.ru/static/assets/developers/files/oauth/create_integration.png?1)

После нажатия на кнопку Создать Интеграцию, в появившейся форме, вам необходимо указать Название интеграции, выбрать требуемые доступы и указать описание. Также необходимо указать Redirect URI – url страницы получения токенов. Здесь указываем адрес главной страницы сайта. Тот адрес что доступен у вас при написании `[[++site_url]]` — Обязательно сделать это один в один, включая слеш в конце адреса
После нажатия на кнопку Создать Интеграцию, в появившейся форме, вам необходимо указать Название интеграции, выбрать требуемые доступы и указать описание. Также необходимо указать Redirect URI – url страницы получения токенов. Здесь указываем адрес главной страницы сайта. Тот адрес что доступен у вас при написании `[[++site_url]]` — Обязательно сделать это один в один, включая слэш в конце адреса

В статье написано что обязательно наличие SSL, но пока что это не строго. И без https соединения все работает.

Expand Down Expand Up @@ -80,7 +80,7 @@

- **amocrm_save_user_by_profile**
При включении данной настройки отправка данных в amoCRM будет происходить при вызове события _OnUserProfileSave_ при сохранении профиля _$profile_save()_.
Поскольку при использовани процессоров или сохранении в админке передача данных происходит на событии _OnUserFormSave_,
Поскольку при использовании процессоров или сохранении в админке передача данных происходит на событии _OnUserFormSave_,
в большинстве случаев включение данной настройки не требуется. Если же ее включить, во многих случаях при одном сохранении пользователя отправка данных может осуществляться дважды.

Не рекомендуется включать, если нет осознанной необходимости
Expand Down
2 changes: 1 addition & 1 deletion docs/components/bannery/index.md
View file
Expand Up @@ -27,7 +27,7 @@ items: [
| Название | Описание |
|-----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **&positions** | Номера рекламных позиций для вывода баннеров, через запятую. |
| **&showLog** | Показывать дополнительную информацию о работе сниппета. Только для авторизованных в контекте «mgr». |
| **&showLog** | Показывать дополнительную информацию о работе сниппета. Только для авторизованных в контексте «mgr». |
| **&fastMode** | Быстрый режим обработки чанков. Все необработанные теги (условия, сниппеты и т.п.) будут вырезаны. |
| **&limit** | Ограничение выборки. |
| **&offset** | Пропуск результатов от начала. |
Expand Down
4 changes: 2 additions & 2 deletions docs/components/bannery/interface/positions.md
View file
@@ -1,12 +1,12 @@
# Позиции

Позиции это рекламные места, в которых предпологается выводить ваши баннеры. Проще говоря, это группа баннеров, которую вы покажете в том или ином месте.
Позиции это рекламные места, в которых предполагается выводить ваши баннеры. Проще говоря, это группа баннеров, которую вы покажете в том или ином месте.

Один баннер может относиться к разным позициям.

* Для создания позиции перейдите в **Компоненты** -> **BannerY**
* На вкладке **Позиции** нажмите **Создать** и после изменений сохранить.
* Во всплывающем окне вам нужно бедет ввести понятное вам название позиции. К самой позиции вы будете обращаться по ID.
* Во всплывающем окне вам нужно будет ввести понятное вам название позиции. К самой позиции вы будете обращаться по ID.

[![](https://file.modx.pro/files/e/a/d/eada167eaf16509c676548a84430f284s.jpg)](https://file.modx.pro/files/e/a/d/eada167eaf16509c676548a84430f284.png)
[![](https://file.modx.pro/files/2/0/f/20f18bbeae2329f068cb16bc77368388s.jpg)](https://file.modx.pro/files/2/0/f/20f18bbeae2329f068cb16bc77368388.png)
Expand Down

0 comments on commit cf4798d

Please sign in to comment.