Уже несколько лет мы помогаем разработчикам плагинов и тем оформления писать руководства, объясняющие, как их продукты должны работать в многоязычной среде. Мы обнаружили, что документация является неотъемлемой частью любого цикла разработки, а демонстрация Вашим клиентам того, как использовать Вашу тему или плагин с WPML, имеет еще больше преимуществ.
В чем преимущества написания документации о совместимости Вашей темы или плагина с WPML?
Документация объяснит, как создавать многоязычные сайты с помощью Вашей темы или плагина, что поможет Вашим клиентам использовать их на многоязычных сайтах и снизит нагрузку на Ваши форумы поддержки. Это также может помочь увеличить Ваши продажи, поскольку клиенты с большей вероятностью купят Ваш продукт для создания многоязычного сайта. Ссылка на Вашу документацию будет добавлена на страницу Вашей темы или плагина на сайте wpml.org.
Рекомендуемые пункты документации для темы или плагина (структура)
- Введение: несколько слов о теме или плагине и их интеграции с WPML. Вы также можете включить ссылку на общедоступный тестовый сайт WPML для этой темы (например: http://YOURTHEME.compatibility.wpml.org/), где клиенты смогут увидеть многоязычную тему или плагин в действии.
- Что Вам понадобится: версия темы или плагина и ссылка для скачивания, любые необходимые плагины (если применимо), версия плагина WPML и необходимые дополнения WPML.
- Основные ресурсы: ссылки на Вашу документацию или любой раздел документации WPML, который может быть полезен клиенту.
- Содержание: список пунктов, которые будут включены в документацию.
- Начало работы: объясните, как активировать и настроить тему вместе с WPML и его дополнениями. Также может быть полезно включить инструкции по импорту демо-контента или демонстрационных данных (если применимо).
- Перевод: подробные шаги по переводу элементов Вашей темы или вывода Вашего плагина. Для тем оформления Вы можете включить следующие пункты:
- Перевод главной страницы.
- Перевод других страниц, записей, произвольных типов записей и произвольных таксономий.
- Перевод параметров темы.
- Перевод других текстов темы.
- Перевод меню.
- Перевод необходимых сторонних плагинов (например, если Вы используете Slider Revolution в Вашей теме, Вы можете сослаться на его документацию здесь).
- Заключение: результат, которого можно достичь благодаря интеграции Вашей темы или плагина с WPML.
Вы можете сослаться на некоторые разделы в документации WPML:
- Руководство по началу работы
- Настройка языка
- Использование модуля Управление переводами WPML
- Локализация тем и плагинов
- Перевод строк
- Перевод меню
- Перевод виджетов
- Пользовательский переключатель языков
- Перевод слагов в URL-адресах
Примеры документации
- Пример документации для темы (Использование WPML с темой AVADA)
- Пример документации для плагина (Создание многоязычных слайдеров с помощью Slider Revolution и WPML)
Плагин Multilingual Tools
Плагин Multilingual Tools поможет Вам протестировать многоязычные возможности Вашей темы или плагина. Он автоматически добавит код языка или пользовательские уведомления к переведенному контенту, позволяя Вам проверить, что работает правильно, а что требует доработки для перевода.
С помощью этого инструмента Вы можете:
- Автоматически генерировать строки для перевода.
- Добавлять информацию о языке к дублированным записям.
- Генерировать конфигурационный файл WPML (wpml-config.xml).
Ознакомьтесь с полной документацией по плагину Multilingual Tools.
