Документация modx на русском: MODX документация на русском

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

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

14 октября 2020, 07:00

Компоненты / miniShop2 / Другие дополнения / msPromoCode2 / Кейсы / Установка промо-кода программно при входе на сайт

14 октября 2020, 07:00

Компоненты / miniShop2 / Другие дополнения / msPromoCode2 / Кейсы / Вывод информации по промо-коду в письме

14 октября 2020, 07:00

Компоненты / miniShop2 / Другие дополнения / msBonus2 / Кейсы / Дополнительные бонусы за первый заказ на сайте

14 октября 2020, 07:00

Компоненты / miniShop2 / Другие дополнения / msBonus2 / Кейсы / Вывод информации в письме о списанных бонусах за заказ

11 октября 2020, 07:00

Компоненты / pdoTools / Парсер

11 октября 2020, 07:00

Компоненты / miniShop2 / Сниппеты / msProducts

11 октября 2020, 07:00

Компоненты / miniShop2 / Другие дополнения / msBonus2 / События плагинов / Примеры

11 октября 2020, 07:00

Компоненты / miniShop2 / Другие дополнения / msBonus2 / События плагинов / msb2OnBeforeSetBonus

11 октября 2020, 07:00

Компоненты / miniShop2 / Другие дополнения / msBonus2 / События плагинов / msb2OnSetBonus

11 октября 2020, 07:00

Компоненты / miniShop2 / Другие дополнения / msBonus2 / События плагинов / msb2OnUnsetBonus

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

Основы Markdown

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

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

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

MODX Docs | MODX Docs

Примечание. В настоящее время вы просматриваете документацию по MODX 3. MODX 3 скоро будет в альфа-версии и пока не рекомендуется для использования в производстве.

Можете ли вы помочь обновить документацию для MODX 3? Найти открытые вопросы здесь

MODX Revolution (Revo) — это простая в использовании система управления контентом (CMS) и Application Framework, объединенные в одно целое. Несмотря на безграничные возможности, которые предоставляет вам MODX, мы думаем, что работать с ним будет просто и понятно. На каждом этапе MODX стремится предоставить полную свободу.

С MODX3, как платформа была модернизирована, также предлагает переработанный пользовательский интерфейс менеджера. Узнайте больше об обновлении до MODX 3.

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

Кроме того, есть доверенные, опытные MODX Профессионалы с кем вы можете взаимодействовать, чтобы выполнить работу. MODX также имеет коммерческую поддержку при поддержке поставщика варианты, поэтому независимо от ваших потребностей и требований — вы можете быть удовлетворены.

С чего начать

Этот сайт документации является подробным справочником по всем вопросам MODX, но есть также руководства и учебные пособия, которые помогут вам быстро и легко начать работу. Основные моменты включают в себя:

Если у вас есть вопрос об этом сайте документации, вы хотите помочь улучшить его, посмотреть источник документации и приложение на GitHub. Новые участники приветствуются!

MODX Revolution

Revolution — флагманская CMS и прикладная среда MODX, которую с любовью называют «Revo». Если вы новичок в MODX, начните с нее.

Быстрые ссылки

Другие ресурсы

Дополнения

Дополнения MODX расширяют основные функциональные возможности программного обеспечения MODX. Другие CMS называют их «плагинами» или «модулями». Многие дополнения разработаны основной командой MODX, а другие сторонними разработчиками. Хотя это ни в коем случае не исчерпывающая ссылка, большинство самых популярных дополнений документированы здесь.

xPDO

xPDO — это объектно-реляционный мост (ORB), который поддерживает MODX. Если вы знаете, что это значит, или вы любите приключения, то для вас следующее:

Быстрые ссылки

Другие ресурсы

Справочник участника

Любишь MODX? Узнайте, как принять участие в сообществе и внести свой вклад в проект с открытым исходным кодом.

А как насчет MODX Evolution?

Evolution — это классическая кодовая база MODX — оригинальная версия, выпущенная в 2005 году. По состоянию на апрель 2017 года Официально Evolution — это отдельный проект, уже не под крылом MODX. Это означает, что у Evolution есть собственное руководство, процессы и сообщество.

Всю информацию о Evolution, включая документацию и дополнительные материалы, можно найти по адресу evo.im.

Документация

Оглавление

#

MODx Revo. Тогда и сейчас.

Для начала окунемся в историю создания MODx, используя страничку в Wiki. Работа над проектом, получившим название MODx CMS, была начата в 2004 году. Её первыми разработчиками были Райан Трэш (Ryan Trash) и Реймонд Ирвинг (Raymond Irving). Именно они начали разрабатывать движок, причём сначала только как модуль DocVars для Etomite, системы управления сайтами.

После того, как разработчики Etomite отказались от развития своей CMS как открытого продукта, весной 2005 года авторами MODx был предпринят форк системы, и она стала развиваться в качестве самостоятельного продукта. В мае этого же года в команду вступил Джейсон Ковард (Jason Coward), который впоследствии стал главным архитектором MODx.

В 2007 году Реймонд Ирвинг на дружеских условиях покинул проект. Годом позже, Шон МакКормик (Shaun McCormick) присоединился к проекту. Кстати говоря, админку, которая построена на ExtJS 3.4.1 разработал именно он. Но к сожалению, Шон уже несколько лет не работает над MODx.

Над проектом в разное время работали и продолжают работать многие другие разработчики. Полный список контрибьюторов MODx можно посмотреть на официальном гитхаб-репозитории проекта.

#

С чего начать

Этот раздел документации является подробным справочником по всем вопросам связанным с MODx, но есть также руководства и учебные пособия, которые помогут вам быстро и легко начать работу. Основные моменты включают в себя:

• Руководство по созданию сайтов с MODx
• Создание блога с MODx

#

Быстрые ссылки

#

Другие ресурсы

#

Крупнейшее российское сообщество MODx, разработанное Василием Наумкиным

#

Магазин дополнений от Mark Hamstra

#

Почему я делаю свой перевод

Я решил что было бы неплохо создать свою собственную версию документации по MODx Revo, дак еще и на русском языке. Конечно я не претендую на то, что моя документация является некой «Библией» в мире разработки на MODx, но я стараюсь ей поддерживать в актуальном состоянии, пока сам работаю с данной системой.

Ну и самое главное, я не размещаю в документации то, в чем сам не разобрался. К тому же, перевод я делаю не через гугл-транслейт. Каждая страничка документации переведена «Для пользователей». Так же я постараюсь наполнить каждый раздел примерами, с помощью которых можно будет подружиться с функционалом MODx и его API.

Время работы: 0,1612 s
Время запросов: 0,1612 s
Количество запросов: 24
Источник: cache

Обзор MODX — Начало работы

Что такое MODX?

MODX — это платформа приложений контента. Что это значит? Ну, это зависит от того, кто вы есть:

Конечные пользователи

MODX предлагает вам систему, которая позволяет вам публиковать ваш автономный контент в Интернете в любой форме, форма или присутствие по вашему желанию. Он также предлагает полностью настраиваемый интерфейс бэкэнда, который вы можете сделать настолько простым (или сложным), сколько захотите.

Вы можете настроить все: от простого сайта до блога, полномасштабного присутствия в Интернете с помощью MODX, и сохранить свой интерфейс администратора простым и удобным в использовании. Перетащите ваши веб-страницы, чтобы изменить порядок и переместить их. Получите полный WYSIWYG просмотр ваших ресурсов. Оставьте Ресурсы неопубликованными, прежде чем закончите их. Настройте расписание ресурсов для публикации в определенное время.

MODX поможет вам организовать ваш контент так, как вы этого хотите, и получить потрясающие встроенные результаты SEO. MODX полностью совместим со 100% дружественным URL, поэтому получить mysite.com/my/own/custom/url.html невероятно просто и так же просто, как структурировать ваш сайт таким образом.

Дизайнеры

Вы когда-нибудь хотели полной свободы с вашим HTML и CSS? Устали от взлома существующих систем, чтобы ваш дизайн работал так, как вы его компилировали? MODX не генерирует ни одной строки HTML — он оставляет дизайн интерфейса на ваше усмотрение.

Вы можете использовать MODX в качестве своей системы управления контентом (CMS), так как MODX предлагает полностью гибкие шаблоны и доставку контента без ограничений. Разместите свой CSS и изображения там, где вы хотите. И как только вы закончите проектирование, либо передайте свои обязанности по разработке вашему разработчику, либо установите дополнительные возможности прямо из менеджера. Просто.

Разработчики

Вы смотрели на разные CMS, но обнаружили, что разработка в них — либо мешанина слишком большого количества не связанных между собой сниппетов кода, либо просто недостаточно мощная или достаточно элегантная. Вы посмотрели на PHP-фреймворки и обнаружили, что у них есть все возможности, но у вас нет управления контентом и нет достаточно хорошего пользовательского интерфейса для ваших клиентов. Вам нужна мощь и гибкость инфраструктуры с пользовательским интерфейсом и управлением контентом CMS.

Ввойдите в MODX Revolution. Полностью гибкий, мощный и надежный API, построенный на принципах ООП и использующий объектно-реляционную модель на основе PDO, называемую ORM. xPDO. Добавить богатый, Sencha пользовательский интерфейс для ваших клиентов (полностью настраиваемый). Пользовательские свойства и наборы. Поддержка интернационализации. Встроенное распределение пакетов, так что вы можете упаковать свой код и распределить его по любой установке Revolution. Добавьте пользовательские страницы менеджера для запуска целых приложений в MODX.

Основные понятия

MODX, по сути, имеет массу движущих частей. Основные части это:

Ресурсы

Ресурсы основа местоположения веб-страницы. Это может быть фактический контент HTML, или файл, ссылка для пересылки, или символическая ссылка, или что-то еще.

Шаблоны

Шаблоны являются домом, в котором живет Ресурс. Обычно они содержат нижний колонтитул и заголовок страницы.

Переменные шаблона (TV)

Переменные шаблона (TV) (TVs) являются настраиваемыми полями для шаблона, которые позволяют пользователю назначать динамические значения для ресурса. Отличным примером может служить TV с тегами, который позволяет указывать теги для ресурса. Вы можете иметь неограниченное количество TV на странице.

Чанки

Чанки просто небольшие блоки контента, будь то, что вы хотите внутри. Они могут содержать Сниппетыили любой другой тип элемента (Сниппет, чанк, TV и т.д.).

Сниппеты

Сниппеты динамические сниппеты кода PHP, которые запускаются при загрузке страницы. Они могут делать все, что вы можете кодировать, включая создание пользовательских меню, получение пользовательских данных, тегирование элементов, обработку форм, получение твитов и т.д.

Плагины

Плагины — это перехватчики событий, которые запускаются всякий раз, когда происходит событие. Они обычно используются для расширения ядра Revolution, чтобы что-то делать во время части процесса загрузки — например, удаление нецензурных слов в контенте, добавление словарных ссылок на слова, управление перенаправлениями для старых страниц и т.д.

Системные настройки

Системные настройки дают вам почти бесконечные возможности конфигурации. Большинство из них установлены наилучшим образом, но некоторые вещи (такие как дружественные urls) по умолчанию отключены или могут быть улучшены для ваших конкретных потребностей, просто изменив значение параметра. После установки перейдите в «Система»> «Системные настройки» в «Менеджере» и просмотрите доступные опции. Обязательно проверьте область «Сайт» (используйте выпадающий список «Фильтровать по области …»), там есть несколько интересных вещей для вас.

Так что же происходит по запросу?

MODX загружает запрошенный Ресурс, извлекает ресурсы Шаблон, а затем помещает содержимое ресурса в этот шаблон. Затем MODX анализирует итоговое объединенное содержимое, включая любые теги, которые могут быть в нем, в порядке их достижения. Оттуда он выводит ответ в браузер пользователя.

Смотрите также

1. Словарь терминов Revolution
   1. Объяснение структуры каталогов

Успешная установка, что теперь? — Начало работы

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

Базовая безопасность

Вы немедленно столкнетесь с любыми проблемами безопасности, которые могут и должны быть решены, чтобы помочь укрепить вашу систему MODX. Под первоначальными предупреждениями обычно понимается, что папка установки была не удалена или что основная папка доступна для общественности. Эти проблемы можно устранить, проверив, что папка «setup» была удалена, и переименовав файл «ht.access», расположенный в основной папке, в «.htaccess».

Редактирование ресурса по умолчанию

По умолчанию MODX изначально создает начальный ресурс, расположенный на вкладке «Ресурсы», и начальный шаблон, расположенный на вкладке «Элементы» под шаблонами. Для просмотра текущего состояния сайта MODX перейдите в верхнее меню, повторив эти шаги «Содержимое -> Предварительный просмотр сайта». Также можно щелкнуть ресурс по умолчанию и выбрать «Просмотр», либо щелкнуть сам ресурс и нажать кнопку «Просмотр».

Чтобы отредактировать содержимое этого ресурса, щелкните сам ресурс на вкладке «Ресурсы» и перейдите к редактированию содержимого, расположенного в поле «Содержимое». Отсюда вы также можете перейти к редактированию страницы, описания, сводки, если она должна быть опубликована или нет, и псевдониму ‘дружественные url’

После того, как изменения были нажаты, кнопка «Сохранить», расположенная в правом верхнем углу, или используйте сочетание клавиш «Ctrl + S», чтобы сохранить обновленный ресурс. Как только страница закончила сохранение сделанного вида, нажмите кнопку «Вид».

Редактирование шаблона по умолчанию

В дополнение к отправке с начальным ресурсом MODX также предоставляет начальный шаблон с именем «BaseTemplate». Этот шаблон находится на вкладке «Элементы» в разделе «Шаблоны». Редактирование этого шаблона может быть выполнено нажатием на сам шаблон, «BaseTemplate». Отсюда можно внести изменения в шаблон, описание и содержание, например, в приведенный ниже пример.

<!DOCTYPE html>
<html lang="en">
<head>
   <meta charset="UTF-8">
   <base href="[[!++site_url]]" />
   <title>[[*pagetitle]]</title>
   <!-- Continue to insert your css, scripts and other assets here -->
   <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0/css/bootstrap.min.css">
</head>
<body>
   <main>
       [[*content]]
   </main>
</body>
</html>

В приведенном выше примере шаблона есть несколько странных строк, заключенных в квадратные скобки. Это теги MODX, которые служат определенной цели. Например, тег content указывает MODX, что ему нужно передать вкладку контента, которую вы редактировали в ресурсе по умолчанию, в это место. Тег pagetitle относится к полю заголовка страницы, которое мы также редактировали в этом ресурсе. Узнайте больше о различных синтаксических тегах, их назначении и о том, как их использовать, посетите эту станицу.

После обновления шаблона нажмите кнопку «Сохранить» или «Ctrl + S» и продолжайте просматривать сайт, чтобы проверить изменения.

Создание нового ресурса

Чтобы создать новый ресурс, нажмите на вкладку «Ресурсы», а затем найдите значок «+» рядом с текстом «Веб-сайт». В качестве альтернативы, можно создать новый ресурс, щелкнув текст «Веб-сайт» и выбрав «Создать -> Документ» или «Быстрое создание -> Документ». Отсюда приступайте к редактированию ресурса, как описано ранее.

Создание нового шаблона

Чтобы создать новый шаблон, нажмите на вкладку «Элементы», а затем найдите значок «+» рядом с текстом «Шаблоны». Кроме того, можно создать новый шаблон, щелкнув правой кнопкой мыши текст «Шаблоны» и выбрав «Новый шаблон» или «Шаблон быстрого создания». Отсюда приступите к редактированию шаблона, как описано ранее.

MODX дополнения | MODX Docs

В этом разделе документации вы найдете информацию о дополнениях для MODX Revolution. Эти дополнения (и их документация) сделаны сторонними разработчиками, поэтому официально не поддерживаются.

Где найти дополнения

Официальный источник дополнений MODX.com. Ты можешь просматривать сотни (бесплатных) дополнений, каждая установка MODX уже настроена на загрузку и установку дополнений с MODX.com через менеджер пакетов.

Есть также сторонние источники и доступные торговые площадки, которые обычно предлагают комбинацию бесплатных и премиальных дополнений. Они включают:

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

Обычно используемые дополнения

Имея почти 1000 доступных дополнений, при начале работы может быть сложно определить, какие дополнения следует использовать. Дополнения в следующем списке считаются отличным выбором в зависимости от требований вашего проекта.

Это не означает, однако, что это ваши единственные варианты. Просматривайте репозиторий, читайте форумы и делитесь интересными дополнениями, которые вы найдете в сообществе.

Навигация и контент

• pdoTools представляет собой набор полезных сниппетов, который призван стать современной (в основном) заменой старых (но все еще поддерживаемых) дополнений:
  • pdoResources является эквивалентом getResources, который может быть использован для перечисления ресурсов. Их также можно использовать для подачи RSS или создания Sitemap.
  • pdoMenu является эквивалентом Wayfinder, который используется для создания (многоуровневых) меню из вашего дерева ресурсов.
  • pdoPage является эквивалентом getPage, который обертывает сниппеты, такие как getResources / pdoResources с возможностями разбиения на страницы
  • pdoCrumbs может быть использован аналогично Breadcrumbs создать хлебные крошки текущего ресурса.
• getResourceField, pdoField или fastField для получения одного поля ресурса.
• AdvSearch или mSearch3 (премиум дополнение от modstore) добавляет функцию поиска на ваш сайт
• Collections используется для большого количества ресурсов, таких как блоги или списки продуктов, и будет перечислять дочерние ресурсы в сетке вместо дерева
• NewsPublisher позволяет пользователям создавать ресурсы в front-end без необходимости доступа к MODX Manager (включая редактирование текста и браузер файлов/изображений).

Редактирование кода/текста

• TinyMCE RTE это текстовый редактор на основе TinyMCE 4. (Пакет называется просто TinyMCE использует более старый TinyMCE 3)
• TinymceWrapper реализация TinyMCE, использующая последнюю версию CDN
• Redactor (Премиум дополнение от Modmore) представляет собой MODX интеграцию от Redactor.
• CKEditor интегрирует CKEditor RTE в MODX.
• Ace позволяет редактировать код для ваших элементов в менеджере.

Медиа

• Gallery может быть использована для добавления альбомов изображений на ваш сайт
• MoreGallery (премиум дополнение от Modmore) для управления галереями изображений и видео (YouTube / Vimeo), реализованными как специальный тип ресурса

Формы

• FormIt является стандартом в обработке форм
• Formalicious ((Премиум дополнение от modmore и modstore)это конструктор форм на основе FormIt
• SPForm простая, защищенная от спама контактная форма

Мультисайтовый, многоязычный, мультидоменный, контексты

• xRouting это гибкий контекстный маршрутизатор, который поддерживает (суб) домены и каталоги с минимальной конфигурацией
• LangRouter это контекстный маршрутизатор, который выбирает контекст на основе языка посетителей
• Babel используется для соединения переводов в разных контекстах

Электронная коммерция

• MiniShop2 представляет собой мощное решение для электронной коммерции с открытым исходным кодом, со многими (платными и бесплатными) расширениями, доступными преимущественно из Modstore
• Commerce это мощное решение для электронной коммерции премиум-класса от modmore
• SimpleCart представляет собой более простое решение для электронной коммерции премиум-класса, изначально разработанное OostDesign и доступное в настоящее время от modmore

Пользователи

• Login представляет собой набор инструментов, которые помогут вам интегрировать функциональность интерфейсного пользователя, включая вход в систему и профили.
• HybridAuth может использоваться для входа пользователей через социальные сети
• Personalize может отображать разные чанки в зависимости от того, вошел ли пользователь в систему или нет

Ведение блога

• Collections перечислить дочерние ресурсы в сетке в диспетчере (а не в дереве ресурсов)
• Quip и Tickets для добавления функциональности комментирования
• Tagger для добавления тегов, которые вы можете фильтровать и искать посты

Управление версиями и рабочий процесс

• VersionX хранит копию изменений ваших ресурсов и элементов для легкого восстановления.
• Preview и Workflow (премиум дополнение от Extras.io) обеспечивают предварительный просмотр и публикацию рабочих процессов.
• MagicPreview (бесплатное дополнение от modmore) дает вам кнопку предварительного просмотра, которая позволяет вам видеть изменения вашего ресурса без необходимости сохранения изменений.
• StageCoach позволяет проводить изменения страницы, чтобы они были применены в будущем.

Инструменты разработки

• modDevTools добавляет дополнительную функциональность менеджеру, чтобы помочь разработчикам создавать сайты.
• MyComponent это полноценная среда разработки для создания дополнений MODX.

Инструменты для диагностики

• SiteCheck (Премиум дополнение от Bob Ray) выполняет тысячи проверок целостности вашего сайта.

Обновление MODX

• UpgradeMODX позволяет обновить MODX Revolution из админки MODX.
• GoRevo (Премиум дополнение от Bob Ray) предоставляет инструмент для перехода с MODX Evolution на MODX Revolution.

Распространение ваших собственных дополнений

Перейдите на страницу https://modx.com/extras/, войдите в свою учетную запись MODX (или создайте ее), затем нажмите кнопку внизу, чтобы «Отправить дополнение».

Там вы можете загрузить MODX транспортный пакет. Это специальный вид zip-файла, который гарантирует, что ваше дополнение и все его компоненты правильно установлены в целевой системе. Чтобы создать его, вам нужно создать скрипт сборки

Все дополнения, размещенные на MODX.com, проходят базовый обзор; обработка вашего заявления может занять несколько дней.

Система управления сайтом, разработка сайта на MODX CMS, програмирование на MODX

Система управления сайтом, разработка сайта на MODX CMS, програмирование на MODX

Как правильно использовать название «MODX» на письме?

После ребрендинга правильно писать «MODX» только заглавными буквами в точности так, как это ображено на логотипе.

Как правильно произносится MODX?

На русском языке наиболее правильно MODX произносится как «мóдэкс». Любые другие варианты, например, модикс, мод-икс, модыкс и тому подобное являются некорректными. Старайтесь избегать неправильного произношения.

Что мне потребуется для запуска MODX?

MODX работает на разнообразных системах программного обеспечения. Однако для достижения наилучшего результата мы советуем использовать последние актуальные версии языка программирования PHP, базы данных MySQL и веб-сервера Apache. Для работы дружественных адресов страниц (friendly URLs) наиболее удобный и быстрый путь — это использование веб-сервера Apache с включенным модулем mod_rewrite.

Как быстрее всего научиться работать с MODX?

В сообществе MODX есть много замечательных пользователей, которые написали отличные руководства и книги по нашему скромному Open Source проекту. Ознакомившись с этой информацией, вы сможете быстро приступить к работе с MODX.

Сколько стоит MODX?

Проект MODX выпускается под лицензией GNU GPL и не требует никаких лицензионных платежей за использование программного обеспечения. Ваши затраты могут складываться только из стоимости аренды или покупки серверов и услуг. Конечно, мы поощряем пользователей, которым нравится работать с нашим ПО, помочь проекту MODX, если у них есть такая возможность.

Как я могу добавить исправление ошибки (бага) в код проекта?

Если сообщение об ошибке еще не существует для специфической проблемы, пожалуйста, создайте запрос в нашем багтрекере для проектов Revo или Evo. Вы можете отправить пулл реквест (pull request) в аккаунт MODX на Github. Как и для многих других Open Source проектов, отправка вашего кода должна быть совмещена с подтверждением лицензионного соглашения (CLA, Contributors License Agreement).

Как я могу получить возможность для совершения коммитов?

MODX использует Github, поэтому вам не потребуется прямой доступ для коммитов для того, чтобы участвовать в разработке. Любой может начать отправлять пулл реквесты для кода, который находится на Github, но не забудьте, что перед этим вы должны подтвердить лицензионное соглашение (CLA).

Насколько хороша система управления сайтами MODX?

MODX настолько хороша, что Чак Норрис съеживается в страхе.

Должен ли я уметь программировать, чтобы использовать MODX?

Чтобы работать с сайтом ежедневно, определенно нет. Если вы умеете работать с Microsoft Word, то обычно в течение часа или даже менее того вы сможете научиться отлично работать в MODX с теми сайтами, которые были установлены для «обычных» редакторов и конечных пользователей. Однако для установки и настройки сайта вы должны знать и уметь применять базовые блоки веб-разработки: HTML, CSS, JavaScript, а также иметь опыт в ручной разработке сайтов.

Могу ли я использовать мою любимую JavaScript библиотеку в MODX?

Безусловно да, поскольку MODX не накладывает абсолютно никаких ограничений на то, что выводится в клиентской части (Front End).

Насколько большой сайт я могу построить на MODX?

Для MODX версии Evolution в зависимости от конфигурации вашего сервера система кеширования может иметь некоторые ограничения в размере порядка 5000 документов, но это только грубое предположение. MODX Revolution фактически устраняет большинство ограничений размера и масштаба сайта при правильной конфигурации системы.

Почему существует несколько версий MODX?

• 0.9.6.x — первоначальная основа программного кода, которая была запущена с первого стабильного релиза в виде версии 0.9.0 в конце октября 2005 года. Больше не поддерживается.
• Evolution — очищенный и обновленный дистрибутив версии 0.9.6.x с новыми соглашениями и терминологией, которые были приближены к нашему полностью переписанному релизу Revolution.
• Revolution — это полностью объектно-ориентированная система, которая находилась в разработке почти 3 года до ее начального релиза. Система предназначена для ликвидирования найденных в оригинальном коде ограничений с помощью действительно рекурсивного парсера и для преодоления теоретического потолка в 5000 документов в MODX Evolution.

Могу ли я обновить MODX с 0.9.6.x/Evolution на Revolution на существующем сайте?

В большинстве случаев обновление будет легко произведено с помощью нескольких дополнений для миграции. Если у вас имеется какой-либо проприетарный код (сниппеты), возможно, вам потребуется сделать некоторые средние изменения для обновления до нового API.

Существует ли в MODX система ревизий и отмены изменений? Рабочий процесс публикаций?

Эти возможности пока еще не входят в релиз ядра системы, но они запланированы на будущие релизы Revolution.

Может ли MODX поддерживать одновременно несколько сайтов из одной установки?

Да, хотя методы различаются для каждой версии MODX. Инструкции для поддержки нескольких сайтов в Evolution/0.9.6.x можете получить на форумах. Для поддержки нескольких сайтов в Revolution читайте статью Wiki.

Поддерживает ли MODX мультиязычность?

Да. В Менеджере MODX имеется перевод на многие языки. Для мультиязычных сайтов, пожалуйста, смотрите варианты решений на наших форумах.

Самое новое о MODX

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

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

14 октября 2020, 07:00

Компоненты / miniShop2 / Другие дополнения / msPromoCode2 / Кейсы / Установка промо-кода программно при входе на сайт

14 октября 2020, 07:00

Компоненты / miniShop2 / Другие дополнения / msPromoCode2 / Кейсы / Вывод информации по промо-коду в письме

14 октября 2020, 07:00

Компоненты / miniShop2 / Другие дополнения / msBonus2 / Кейсы / Дополнительные бонусы за первый заказ на сайте

14 октября 2020, 07:00

Компоненты / miniShop2 / Другие дополнения / msBonus2 / Кейсы / Вывод информации в письме о списанных бонусах за заказ

11 октября 2020, 07:00

Компоненты / pdoTools / Парсер

11 октября 2020, 07:00

Компоненты / miniShop2 / Сниппеты / ms

11 октября 2020, 07:00

Компоненты / miniShop2 / Другие дополнения / msBonus2 / События плагинов / Примеры

11 октября 2020, 07:00

Компоненты / miniShop2 / Другие дополнения / msBonus2 / События плагинов / msb2OnBeforeSetBonus

11 октября 2020, 07:00

Компоненты / miniShop2 / Другие дополнения / msBonus2 / События плагинов / msb2OnSetBonus

11 октября 2020, 07:00

Компоненты / miniShop2 / Другие дополнения / msBonus2 / События плагинов / msb2OnUnsetBonus

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

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

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

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

Идея

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

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

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

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

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

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

Структура

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

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

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

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

Заголовки

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

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

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

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

Ссылки

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

  [Название ссылки] [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/85333575318f1fb2e7fe928aeb25 .png)  

Выделение

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

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

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

  Здесь код  

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

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

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

Таблицы

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

  Первый заголовок | Второй заголовок
------------- | -------------
Ячейка содержимого | Ячейка содержимого
Ячейка содержимого | Ячейка содержимого  

Основы уценки

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

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

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

.

Документация

Оглавление

#

MODx Revo. Тогда и сейчас.

Для начала окунемся в историю создания MODx, используя страничку в Wiki. Работа над проектом, получившим название MODx CMS, была начата в 2004 году. Её первыми разработчиками были Райан Трэш (Райан Трэш) и Реймонд Ирвинг (Реймонд Ирвинг). Именно они начали разрабатывать движок, причём сначала как модуль DocVars для Etomite, системы управления сайтами.

После того, как разработчики Etomite отказались от развития своей CMS как открытого продукта, авторами MODx был предложен новый продукт, выпущенный весной 2005 года. В мае этого же года в команде вступил Джейсон Ковард (Джейсон Ковард), который стал главным архитектором MODx.

В 2007 году Реймонд Ирвинг на дружеских условиях покинул проект. Годом позже, Шон МакКормик (Шон МакКормик) присоединился к проекту.Кстати говоря, админку, которая построена на ExtJS 3.4.1 разработал именно он. Но к сожалению, Шон уже несколько лет не работает над MODx.

Над проектом в разное время работают и продолжают работать другие разработчики. Полный список контрибьюторов MODx можно посмотреть на официальном гитхаб-репозитории проекта.

#

С чего начать

Этот раздел документации является подробным справочником по всем вопросам с MODx, но есть также руководства и учебные пособия, которые помогут вам быстро и легко начать работу.Основные моменты включают в себя:

• Руководство по созданию сайтов с MODx
• Создание блога с MODx

#

Быстрые ссылки

#

Другие ресурсы

#

Крупнейшее российское сообщество MODx, разработанное Василием Наумкиным

#

Магазин дополнений от Mark Hamstra

#

Почему я делаю свой перевод

Я решил что было бы неплохо создать свою версию документации по MODx Revo, дак еще и на русском языке.«Библией» в мире разработки на MODx, но я стараюсь поддерживать в актуальном состоянии, пока сам работаю с данной системой.

Ну и самое главное, я не размещаю в документации то, в чем сам не разобрался. К тому же, перевод я делаю не через гугл-транслейт. Каждая страничка документации переведена «Для пользователей». Так же я постараюсь наполнить каждый раздел примерами, с помощью которых можно подружиться с функционалом MODx и его API.

Время работы: 0,1288 с
Время запросов: 0,1288 с
Количество запросов: 24
Источник: cache

.

Успешная установка, что теперь? — Начало работы

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

Базовая безопасность

Вы немедленно столкнулись с любыми проблемами безопасности, которые могут быть решены, чтобы помочь укрепить вашу систему MODX.Под предварительными установками обычно понимается, что папка не может быть удален. Эти проблемы можно устранить, проверив, что папка «setup» была удалена и переименована в файл «ht.access», расположенный в основном папке, в «.htaccess».

Редактирование ресурса по умолчанию

По умолчанию MODX изначально создается начальный ресурс, расположенный на вкладке «Ресурсы», и начальный шаблон, расположенный на вкладке «Элементы» под шаблонами.Для просмотра текущего состояния сайта MODX продолжить в верхнее меню, повторив эти шаги «Содержимое -> Предварительный просмотр сайта». Также можно щелкнуть ресурс по умолчанию и выбрать «Просмотр», либо щелкнуть сам ресурс и кнопку «Просмотр».

отредактировать содержимое этого ресурса, щелкните сам ресурс на вкладке «Ресурсы» и выполните к редактированию расположенного в поле «Содержимое». Отсюда вы также можете перейти к редактированию страницы, описания, сводки, если она должна быть опубликована или нет, и псевдониму ‘дружественные url’

После того, как изменения были нажаты, кнопка «Сохранить», расположенная в верхнем крайнем положении, или сочетание клавиш «Ctrl + S», чтобы сохранить обновленный ресурс.Как только страница закончила сохранение сделанного вида, нажмите кнопку «Вид».

Редактирование шаблона по умолчанию

В дополнение к отправке с начальным ресурсом MODX также предоставляет начальный шаблон с именем «BaseTemplate». Этот шаблон находится на вкладке «Элементы» в разделе «Шаблоны». Редактирование этого шаблона может быть выполнено нажатием на сам шаблон «BaseTemplate». Отсюда можно внести изменения в шаблон, описание и содержание, например, в приведенный ниже пример.

  


   
   
   
   
   


   <основной>
       [[* содержание]]