Правила оформления — различия между версиями
Boyarin (обсуждение | вклад) (→Состав описания) |
Vlegkun (обсуждение | вклад) |
||
Строка 1: | Строка 1: | ||
+ | {{TOC right}} | ||
+ | [[Файл:!.png]] '''Правила оформления статей''' применяются ко всем статьям - описаниям объектов - расположенных на этом портале. | ||
+ | |||
== Общие требования == | == Общие требования == | ||
− | *Ссылка на описываемый объект должна быть | + | |
+ | * Стиль редактирования статьи должен соответствовать такому виду: | ||
+ | |||
+ | [[Файл:Ss+(2017-10-17+at+03.46.37).png]] | ||
+ | |||
+ | |||
+ | * Ссылка на описываемый объект должна быть размещена в соответствующей категории. | ||
== Состав описания == | == Состав описания == | ||
+ | |||
* Иконка объекта. Название объекта и его кратное описание (где и как его применять). | * Иконка объекта. Название объекта и его кратное описание (где и как его применять). | ||
+ | |||
+ | |||
* '''Get Started''' - пошаговая инструкция "Для чайников" что нужно делать для запуска объекта в рабочем состоянии. Пример: [[[http://wiki.appsalutecreator.com/index.php/Memory#Get_Started]]] | * '''Get Started''' - пошаговая инструкция "Для чайников" что нужно делать для запуска объекта в рабочем состоянии. Пример: [[[http://wiki.appsalutecreator.com/index.php/Memory#Get_Started]]] | ||
− | *Раздел '''Основные | + | |
+ | |||
+ | *Раздел '''Основные параметры:''' | ||
+ | ** Ссылка на [[Object|объект]], если объект использует общие параметры | ||
** Картинка меню | ** Картинка меню | ||
** Описание всех свойств | ** Описание всех свойств | ||
− | *Раздел ''' | + | |
+ | *Раздел '''Добавляемые параметры:''' | ||
** Картинка меню | ** Картинка меню | ||
** Описание всех параметров | ** Описание всех параметров | ||
− | *Пример настроенного объекта | + | |
+ | *Раздел '''Состояния''' | ||
+ | ** Описание всех состояний, которые можно передать данному объекту | ||
+ | |||
+ | |||
+ | *Другая необходимая информация о работе объекта. здесь могут быть: | ||
+ | ** Структура файла уровней | ||
+ | ** Хинты | ||
+ | ** Записываемые параметры в опции | ||
+ | ** Запись в логи | ||
+ | |||
+ | |||
+ | *Пример настроенного объекта в виде ссылки на скачивание. Пример [http://fs5.absolutist.com/files/wikisample/proj_LUA.zip Download] |
Текущая версия на 12:51, 17 октября 2017
Содержание
Правила оформления статей применяются ко всем статьям - описаниям объектов - расположенных на этом портале.
Общие требования
- Стиль редактирования статьи должен соответствовать такому виду:
- Ссылка на описываемый объект должна быть размещена в соответствующей категории.
Состав описания
- Иконка объекта. Название объекта и его кратное описание (где и как его применять).
- Get Started - пошаговая инструкция "Для чайников" что нужно делать для запуска объекта в рабочем состоянии. Пример: [[[1]]]
- Раздел Основные параметры:
- Ссылка на объект, если объект использует общие параметры
- Картинка меню
- Описание всех свойств
- Раздел Добавляемые параметры:
- Картинка меню
- Описание всех параметров
- Раздел Состояния
- Описание всех состояний, которые можно передать данному объекту
- Другая необходимая информация о работе объекта. здесь могут быть:
- Структура файла уровней
- Хинты
- Записываемые параметры в опции
- Запись в логи
- Пример настроенного объекта в виде ссылки на скачивание. Пример Download