Modx документация: О проекте / docs.modx.pro

О проекте / docs.modx.pro

Последние обновления

06 апреля 2023, 19:30
Компоненты / AjaxFormItLogin / Общие сведения / Особенности и Быстрый старт

06 апреля 2023, 19:30
Компоненты / AjaxFormItLogin / Общие сведения / Системные настройки

06 апреля 2023, 19:30
Компоненты / msProductDiscounts / JavaScripts

23 марта 2023, 18:00
Компоненты / AjaxFormItLogin / Валидаторы / aflUserExists

15 марта 2023, 15:30
Компоненты / cityFields / Формирование карты сайта

11 марта 2023, 10:00
Компоненты / msProductDiscounts / Перед началом работы

07 марта 2023, 11:30
Компоненты / msProductDiscounts / Кейсы

06 марта 2023, 22:00
Компоненты / msProductDiscounts / JavaScrips

02 марта 2023, 20:30
Компоненты / cityFields / Управление городами и данными

02 марта 2023, 20:30
Компоненты / cityFields / Использование доменов, поддоменов и подкаталогов

Open Source документация MODX Revolution, распространяемая через GitHub.

Для того, чтобы внести свой вклад в развитие документации, вам нужно просто сделать pull-request в репозиторий.

Такая организация гарантирует:

• Сохранение истории всех изменений.
• Использование простого языка разметки Markdown.
• Возможность не переживать за проект — вы всегда можете запустить копию у себя.

Идея

Сам принцип подсмотрен у проекта daux.io, который генерирует сайт налету по статичным страницам. Для работы нужен только его скрипт и директория с определённой структурой и файлами в формате Markdown.

Однако, на мой взгляд у daux.io есть несколько серьёзных недостатков:

• Неудобное управление шаблоном.
• Отсутствие мультиязычности в оформлении страниц.
• Нет кэширования, неизвестно каких объемов документацию он потянет.
• Нет встроенного поиска.
• Нет перенаправления с одного адреса на другой, при переносе документа.
• Довольно много ошибок в коде.

В общем, для небольших объёмов это хорошее решение, но для нашего проекта мы используем MODX.

Принцип остаётся тот же: директория с файлами Markdown, из которых строится сайт. Но теперь это самостоятельный сайт, со всеми наворотами, который обновляет свои страницы из GitHub. Мы избавились от всех недостатков daux.io и добавили преимущества MODX.

Правила оформления документации

Структура

Формат репозитория определяется следующей структурой:

1. Языковая версия
2. Раздел
3. Тема
4. Дальше структура определяется в зависимости от темы
5. Чтобы указать порядок директорий и файлов, мы используем числовые префиксы.

Вот путь к файлу с описанием сниппета HybridAuth на русском:

/ru/02_Компоненты/04_HybridAuth/01_Сниппеты/01_HybridAuth

Заголовки

Для заголовков мы используем хештэги ## и между ними и текстом ставим пробел. Например: ## Заголовок

Заголовки должны быть не больше h3, то есть, 2 решетки ##:

• h3 = ##
• h4 = ###
• h5 = ####

Между заголовком и текстом сверху оставляется одна пустая строка. Между заголовком и текстом снизу отступов делать не нужно.

Ссылки

Ссылки на документы нужно проставлять в конце страницы, чтобы их было удобно искать и обновлять. В markdown это делается так:

[Название ссылки][1]
[Название другой ссылки][2]
[1]: http://mylink.com/
[2]: http://mylink.com/test.html

Помимо прочего, это позволяет использовать одну ссылку несколько раз на странице:

[Ссылка 1][1]
[Ссылка 2][2]
[1]: http://mylink.com/

Ссылки на страницы репозитория необходимо указывать от корня, с ведущим слешем, тогда по ним можно переходить прямо на GitHub:

[Ссылка на русский раздел pdoTools][3];
[3]: /ru/01_Компоненты/01_pdoTools

Проще всего открывать нужную страницу на GitHub и копировать адрес из url.

Ссылки на изображения можно вставлять сразу в тексте. Для указания изображений лучше использовать сервис на file.modx.pro (требует авторизацию). Он автоматически сгенерирует уменьшенную копию и код markdown для вставки.

[![](https://file. modx.pro/files/8/5/3/85333575318f1fb2e7fe2881eb25559as.jpg)](https://file.modx.pro/files/8/5/3/85333575318f1fb2e7fe2881eb25559a.png)

Выделение

Cистемные параметры нужно выделять жирным текстом, например: **&parametr** будет выглядеть, как &parametr.

Плейсхолдеры оборачиваются в одинарные обратные апострофы. Например: `[[+placeholder]]` будет выглядеть, как [[+placeholder]].

Для обрамления кода нужно использовать 3 обратных апострофа «` перед секцией кода, и после:

Здесь код

Сам код начинается с новой строки. Пустые строки до и после кода — по желанию.

Перенос строки

Для принудительного переноса строки нужно добавить 2 пробела на конце. Парсер заменит их на тег br.

Таблицы

Вы можете использовать таблицы для удобного отображения различных данных, например параметров какого-то сниппета:

First Header  | Second Header
------------- | -------------
Content Cell  | Content Cell
Content Cell  | Content Cell

First Header	Second Header
Content Cell	Content Cell
Content Cell	Content Cell

Основы Markdown

Подробная документация на сайте у автора.

Обратите внимание, что на этом сайте используется Markdown Extra, в котором можно использовать таблицы и другие навороты.

Проверить, как будет выглядеть ваш документ можно на bezumkin.ru/utils/markdown.

MODX 2.8.3 Revolution + Shopkeeper3 — Возможности PayKeeper

Установка модуля PayKeeper в

CMS MODX Revolution версии 2.8.3

Для корректной работы данного модуля требуется CMS MODX Revolution версии 2.8.3, а также установленное расширение Shopkeeper3.

1. Установка модуля.

Добавьте транспортный пакет модуля (paykeeper-0.1-SHK3REV.transport.zip) в файловую систему CMS с локацией www/<корень сайта>/core/packages/.

Перейдите в панель управления CMS . Выбрать в меню пункты «Пакеты» — «Установщик»(Рис.1)

Рис.

1

Нажмите кнопку «Загрузить пакеты» — «Искать пакеты локально»(Рис.2).

Рис.2

Подтвердите поиск локальных пакетов(Рис.3).

Рис.3

Найдите в списке модуль Paykeeper и установите его.(Рис.4)

(Рис.4)

2. Проверка установленных компонентов модуля.

Во вкладке «Ресурсы» должна присутствовать страница «Обработчик оплаты paykeeper», шаблон — пустой, псевдоним — pkpay, страница должна быть опубликована(!!!), содержимое страницы следующее:[[!Shopkeeper3]][[!Paykeeper_payment]].(Рис.5)

(Рис.5)

Во вкладке «Элементы» в разделе «Сниппеты» должна существовать категория «paykeeper», и в этой категории находится сниппет с названием «Paykeeper_payment» следующего содержания:

название — «Paykeeper_payment», категория — «paykeeper»,описание — «Сниппет инициализации оплаты Paykeeper»,код сниппета — «<?php return require MODX_CORE_PATH. »components/payment/paykeeper/paykeeper.inc.php»;» . (Рис.6)

Рис.6

Во вкладке «Файлы» в файловой системе в папке «/core/components/payment/paykeeper/»должны присутствовать 3 файла(Рис.7):

 

Рис.7

Перейдите в системное меню «системные настройки» (Рис.8).

Рис.8

Выберите пространство имен «paykeeper»(Рис.9)

Рис.9

Проверьте наличие 4 системных переменных:

• form_url — «http://<your_site>.server.paykeeper.ru/create/»

• secret_key — «secret_key»

• vat — «0»

• forced_discount_check — «Нет»

3. Настройка модуля.

Для корректной работы модуля необходимо использовать форму заказа, которая имеет следующие поля (name):

• fullname;

• email;

• phone;

• shk_delivery;

• payment.

Такую конфигурацию например, поддерживает стандартный чанк формы заказа Shopkeeper3 — shopOrderForm.

Форму заказа надо настроить так, чтобы при выборе оплаты через paykeeper, в параметре action был адрес ресурса «Обработчик оплаты paykeeper», или если Вы используете дополнение — обработчик формы такое как FormIt, то в нем необходимо настроить редирект на ресурс «Обработчик оплаты paykeeper», то есть параметру redirectTo необходимо присвоить идетификатор ресурса «Обработчик оплаты paykeeper», в данном случае(Рис. 10) id=6.

Рис.10

В итоге форма заказа должна отправить параметы fullname, email, phone, shk_delivery,

payment на адрес «http://<your_site>/index.php?id=6». При этом параметр payment должен содержать слово «paykeeper» (в том случае конечно, если выбрана оплата через paykeeper).

Перейдите в системное меню «системные настройки» (Рис.8).

Выберите пространство имен «paykeeper»(Рис.9).

Настройте 4 системных переменных:

• form_url — Замените в шаблоне строки <your_site> на Ваш сайт.

• secret_key — Замените секретное слово, которое используется для оплаты, его можно сгенерировать в личном кабинете Paykeeper.

• vat — установите числовое значение — НДС для товаров и услуг доставки.

• forced_discount_check — если в Вашем магазине есть скидки установите в «Да».

В главном меню выберите «Пакеты» — «Управление заказами (SHK3)»(Рис.12).

Рис.12

В правом верхнем углу нажмите кнопку —  и выберите «настройки» (Рис.13).

Рис.13

Выберите настройку «Методы оплаты»(Рис.14).

Рис.14

Нажмите кнопку «Добавить» и заполните поля «Название» и «Значение». Поле «Название» может быть произвольным — это текстовое представление типа оплаты в форме заказа. Поле «Значение» обязательно должно содержать слово «paykeeper» без заглавных букв, именно это слово передается формой оплаты в параметре «payment».

Очистите кеш сайта.

4. Настройка личного кабинета.

Перейдите в личный кабинет, в настройках выберите вкладку «Получение информации о платежах»(Рис.15).Установите «Способ получения информации о платежах» в «POST-оповещения».

Рис.15

В поле «URL, на который будут отправляться POST-запросы» установите адрес «https://<your_site>/core/components/payment/paykeeper/paykeeper_callback.inc.php».

<your_site> Замените на свой сайт.

В поле «секретное слово» введите цифробуквенный код, который будет идентифицировать Ваш магазин при инициализации оплаты. Также Вы можете сгенерировать его нажав на соответствующую кнопку.

Перейдите на вкладку «Адреса перенаправления клиента»(Рис.16)

Рис.16

Заполните поля для успешной и неуспешной оплаты.

Улучшение документации MODX — 29 марта 2019 г.

Улучшение документации MODX — 29 марта 2019 г.

Реклама

1 из 42

Верхний вырезанный слайд

Мой заключительный доклад на встрече MODX в Амстердаме, 29 марта 2019 г. Цель этого выступления состояла в том, чтобы рассказать людям больше о том, как они могут внести свой вклад в MODX, продемонстрировав инициативу сообщества по созданию новой документации MODX. Встреча транслировалась в прямом эфире, и ее можно посмотреть здесь: https://www.youtube.com/watch?v=eUJxqh3AHuM Это выступление начнется примерно в 7:34:00.

Реклама

Реклама

Реклама

Улучшение документации MODX — 29 марта 2019 г.

1. Улучшение Документация MODX @mark_hamstra Еще для MODX
2. Обучение пользователей имеет решающее значение
3. Обучать пользователей тоже сложно
4. docs.modx.com ● Много наследия ● Нет (общедоступной) истории редактирования ● Требуется создание учетной записи вручную. ● Нет разрешений на редактирование. ● Один язык ● Одиночная версия
5. Как мы можем, общество, сделать его лучше?
6. docs.modx.com ● Много наследия – совместная уборка, избавление от старого ● Нет (общедоступной) истории изменений — используйте контроль версий, например Git. ● Требуется создание учетной записи вручную — используйте существующую платформу, например GitHub. ● Отсутствие разрешений на редактирование — обязательные проверки для всех добавленных материалов. ● Один язык — добавьте многоязычную поддержку. ● Единая версия – добавьте ветки версий.
7. https://github.com/modxcms/mab-recommendations/pull/19
8. Почему уценка? ● Очень распространенный, практически де-факто, формат форматированного текстового файла. ● _Легко_ **писать** ○ [К ссылкам нужно привыкнуть](https://google.com/) ● Легко читается как людьми, так и компьютерами. ● Преобразование в HTML ● Отсутствие привязки к какому-либо конкретному приложению ● Дополнительные метаданные во вступительной части.
9. Почему мерзавец? ● Децентрализованное хранилище (создайте собственную копию/зеркало) ● Филиалы ● Полная история изменений: имя, дата, изменения
10. Почему GitHub? ● Крупнейшая платформа для обмена кодами. ● Уже используется для решения проблем с ядром и документацией MODX. ● Запросы на слияние — мощный инструмент проверки. ● Онлайн-редактирование без необходимости разбираться в Git.
11. Как нам это сделать? 1. Получите копию текущей документации 2. Преобразуйте его из HTML в Markdown 3. Перенесите уценку в репозиторий git и опубликуйте на GitHub. 4. Создайте новый сайт для размещения документации 5. Очистите и улучшите контент 6. Замените docs.modx.com новой документацией.
12. github.com/Mark-H/Docs
13. github.com/Mark-H/Docs
14. github.com/Mark-H/Docs
15. github.com/Mark-H/Docs
16. github.com/Mark-H/Docs
17. github.com/Mark-H/Docs
18. github.com/Mark-H/Docs
19. github.com/Mark-H/Docs
20. С исходным кодом, размещенным на GitHub. .. ● Любой может предлагать изменения ○ Большинство правок только через интерфейс ○ Для больших изменений доступно локальное редактирование с помощью git. ● Обзоры прозрачны, и обязательные обзоры могут быть установлены для каждого пользователя. язык/ветвь ● Доступна полная история редактирования каждого файла.
21. Далее: создайте сайт для обслуживания документация для пользователей
22. github.com/Mark-H/DocsApp
23. docs.modx.org
24. Пока все хорошо!
25. Что еще нужно сделать: ● Очистка содержимого ○ Некоторые страницы должны быть переписаны ● Тестирование дизайна, отзывчивость ● Переключение языка ● Реализовать поиск ● Автоматизация развертывания
26. Вы можете помочь!
27. Присоединяйтесь к #documentation на Slack сообщества (modx.org)
28. Использовали ли вы ранее MODX? Тогда вы можете помочь улучшить контент: ● Проверить проблемы в Mark-H/Docs: ○ Проблемы с преобразованием, которые необходимо исправить вручную. ○ Страницы, помеченные как действительно устаревшие ● Проверьте проблемы в modxcms/Docs: ○ Более 140 проблем с сообщениями о проблемах ○ Найдите то, о чем вы что-то знаете
29. Вы говорите на другом языке? Почему бы не создавать документацию на вашем языке? ● См. источник Mark-H/Docs: ○ EN является основным языком ○ RU выполняется ○ NL только начинается
30. Вы дизайнер или фронтенд-разработчик? Тогда вы можете помочь с дизайном сайта документации: ● Дизайн все еще находится в стадии разработки. ● Браузерное/отзывчивое тестирование ● Присоединяйтесь к обсуждению в Slack и GitHub для координации усилий.
31. Вы бэкенд-разработчик? Затем вы можете помочь создать сайт документации: ● Проверяйте проблемы в Mark-H/DocsApp. ○ Нужны некоторые утилиты и дополнительные функции ○ Аудит кода ● Приветствуются все улучшения
32. У вас есть агентство? Дайте возможность своим сотрудникам/подрядчикам помочь и поощряйте их
33. Вместе мы сможем это сделать легче изучить MODX
34. Авторы документов
35. участников DocsApp
36. Напоминание: проверьте свою сумку с подарками! ● «Красная» тема свободной коммерции ● Бесплатная лицензия на выбор: Redactor, MoreGallery или ContentBlocks. ● Товары/вкусности (Действует до 1 мая)
37. 5x Серебряный конверт
38. Ссылки: https://docs. modx.org https://github.com/Mark-H/Документы https://github.com/Mark-H/DocsApp
39. Ссылки: https://docs.modx.org https://github.com/Mark-H/Документы https://github.com/Mark-H/DocsApp Хороших выходных!
40. Ужин и напитки в Hannekes Boom ● Дейксграхт 4 ● 19:00
41. Пешеходная экскурсия по Амстердаму ● Завтра в 11:00 ● Встретиться в CS ● После обеда

Реклама

О проекте / docs.modx.pro

Последние обновления

09 марта 2021, 07:00
Компоненты / PageSpeed

28 августа 2020, 07:00
Компоненты / pdoTools / Классы / pdoFetch

26 июня 2020, 07:00
Компоненты / FrontendEditor

05 апреля 2020, 07:00
Компоненты / pdoTools / Фрагменты / pdoMenu

21 февраля 2020, 07:00
Компоненты / pdoTools / Парсер

18 октября 2019, 07:00
Компоненты / miniShop2 / Фрагменты / msGetOrder

12 сентября 2019, 07:00
Компоненты / mSearch3 / Фрагменты / mSearchForm

12 сентября 2019, 07:00
Компоненты / mSearch3 / Фрагменты / mFilter2

12 сентября 2019, 07:00
Компоненты / mSearch3 / Фрагменты / mSearch3

25 августа 2019, 07:00
Компоненты / Sendex / Фрагмент

Документация с открытым исходным кодом для MODX Revolution

Цель

Основная цель этой документации — дать возможность каждому внести свой вклад. Не нужно сразу логиниться, запрашивать доступ у кого угодно, вы просто отправляете коммит в этот репозиторий, и он будет принят.

Мы описываем сторонние компоненты и ядро ​​MODX на двух языках: русском и английском. Если вы готовы управлять документацией на другом языке, свяжитесь с нами, создав задачу.

Формат

Все файлы написаны в Markdown, имена совместимы с daux.io. В любой момент вы можете клонировать этот репозиторий и развернуть его на своем сервере. Также вы можете читать файлы прямо на GitHub.

Структура

Формат репозитория определяется следующей структурой:

1. Языковая версия
2. Раздел
3. Тема
4. Дальнейшая структура определяется в зависимости от темы
5. Чтобы указать порядок каталогов и файлов, мы используем числовые префиксы.

Вот путь к файлу с описанием сниппета HybridAuth на английском:

 /en/02_Components/04_HybridAuth/01_Snippets/01_HybridAuth 

Заголовки

Для заголовков используем хештеги ## и между ними и текстом поставить пробел. Например: ## Заголовок

Заголовки не должны быть больше h3, например — 2 хэштега ##:

• h3 = ##
• ч4 = ###
• ч5 = ####

Между заголовком и текстом сверху одна пустая строка. Между заголовком и текстом внизу пустая строка не нужна.

Ссылки

Ссылки на документы должны быть добавлены в конец страницы, чтобы упростить поиск и обновление. В уценке это достигается:

[Ссылка][1]
[Название другой ссылки][2]
[1]: http://mylink.com/
[2]: http://mylink.com/test.html
 

Среди прочего, это позволяет использовать одну ссылку несколько раз на странице:

[Ссылка 1][1]
[Ссылка 2][1]
[1]: http://mylink.com/
 

Ссылки на страницы репозитория должны начинаться с начального слэша, указывающего на корень, после чего можно сразу перейти на GitHub:

[Ссылка на английский раздел pdoTools][3]
[3]: /en/01_Components/01_pdoTools
 

Проще открыть нужную страницу на GitHub и скопировать адрес из url.

Ссылки на изображения можно вставлять прямо в текст. Указать образ и воспользоваться сервисом на file.modx.pro (требуется авторизация). Он автоматически генерирует миниатюру и код уценки для вставки.

 [![](https://file.modx.pro/files/8/5/3/85333575318f1fb2e7fe2881eb25559as.jpg)](https://file.modx.pro/files/8/5/3/85333575318f1fb2e7fe2881eb25559a .png) 

Выделение

Системные настройки должны быть выделены жирным шрифтом, например: **&параметр** будет выглядеть как &параметр .

Заполнители, заключенные в одиночные обратные апострофы. Например: `[[+placeholder]]` будет выглядеть как [[+placeholder]] .

Для блока с кодом мы используем 3 обратных апострофа «` до и после:

```
Вот код
```
 

Код начинается с новой строки. Пустые строки до и после кода добровольно.

Новая строка

Для принудительного разрыва строки необходимо добавить два пробела в конце строки.