Правила оформления

Материал из wiki.appsalutecreator.com
Перейти к: навигация, поиск

!.png Правила оформления статей применяются ко всем статьям - описаниям объектов - расположенных на этом портале.


Общие требования

  • Стиль редактирования статьи должен соответствовать такому виду:

Ss+(2017-10-17+at+03.46.37).png


  • Ссылка на описываемый объект должна быть размещена в соответствующей категории.


Состав описания

  • Иконка объекта. Название объекта и его кратное описание (где и как его применять).


  • Get Started - пошаговая инструкция "Для чайников" что нужно делать для запуска объекта в рабочем состоянии. Пример: [[[1]]]


  • Раздел Основные параметры:
    • Ссылка на объект, если объект использует общие параметры
    • Картинка меню
    • Описание всех свойств


  • Раздел Добавляемые параметры:
    • Картинка меню
    • Описание всех параметров


  • Раздел Состояния
    • Описание всех состояний, которые можно передать данному объекту


  • Другая необходимая информация о работе объекта. здесь могут быть:
    • Структура файла уровней
    • Хинты
    • Записываемые параметры в опции
    • Запись в логи


  • Пример настроенного объекта в виде ссылки на скачивание. Пример Download