Правила оформления
Версия от 12:51, 17 октября 2017; Vlegkun (обсуждение | вклад)
Содержание
Правила оформления статей применяются ко всем статьям - описаниям объектов - расположенных на этом портале.
Общие требования
- Стиль редактирования статьи должен соответствовать такому виду:
- Ссылка на описываемый объект должна быть размещена в соответствующей категории.
Состав описания
- Иконка объекта. Название объекта и его кратное описание (где и как его применять).
- Get Started - пошаговая инструкция "Для чайников" что нужно делать для запуска объекта в рабочем состоянии. Пример: [[[1]]]
- Раздел Основные параметры:
- Ссылка на объект, если объект использует общие параметры
- Картинка меню
- Описание всех свойств
- Раздел Добавляемые параметры:
- Картинка меню
- Описание всех параметров
- Раздел Состояния
- Описание всех состояний, которые можно передать данному объекту
- Другая необходимая информация о работе объекта. здесь могут быть:
- Структура файла уровней
- Хинты
- Записываемые параметры в опции
- Запись в логи
- Пример настроенного объекта в виде ссылки на скачивание. Пример Download