ДСП:Правила оформления статей

Материал из docs.kb-agava.ru
Перейти к навигации Перейти к поиску

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

1 Текст

  1. Заголовки разделов - строчными буквами с первой заглавной.
  2. При копировании текстов из Word необходимо убедиться, что с текста заголовков снят признак "Жирный", иначе это приводит к двойному выделению заголовков жирностью. Ошибку видно не во всех браузерах, для проверки нужно использовать Firefox.
  3. Выравнивание одиночных изображений - по правому краю. Выравнивание группы изображений - по центру.
  4. Ссылки на раздел внутри документа необходимо предварить решеткой (#), например: [[#Субмодули расширения]].
  5. Для оформления абзацев с содержанием типа "Обратите внимание! ..." используйте шаблон {{Внимание}}. Например: {{Внимание|Тип=Восклицание красный.png|Текст=Интерфейсы USB и RS-232 не имеют гальванической развязки.}}. Для использования с шаблоном доступны иконки "Восклицание красный.png", "Восклицание желтый.png", "Восклицание синий.png".

2 Формулы

Для вставки формул используйте специальный синтаксис. См. описание: https://www.mediawiki.org/wiki/Extension:Math

3 Таблицы

  1. Все таблицы должны иметь строку заголовка с соответствующим выделением.
  2. При копировании таблиц из Word необходимо убедиться, что с текста заголовков таблиц снят признак "Жирный", иначе это приводит к двойному выделению заголовков жирностью. Видно не во всех браузерах. Для проверки нужно использовать Firefox.

4 Файлы/Изображения

  1. Запрещается загрузка нового изображения или файла без проверки имеющихся. Возможно загружаемый файл уже есть в системе.
  2. При необходимости замены изображения на новый/исправленный вариант запрещается загружать файл заново. Вместо этого используйте функцию "Загрузить новую версию файла" для уже загруженного.
  3. При загрузке изображений для текста конкретной статьи имя файла нужно предварить префиксом - короткой строкой без пробелов, объясняющей назначение изображения. Например, при загрузке изображений для статьи "Описание контроллера АГАВА ПК-40" всем изображениям нужно присвоить префикс "Пк40" или "ПК40", чтобы все загруженные изображения имели вид "ПК40-Имя изображения.расширение". Такой способ именования позволит быстрее находить нужные изображения в списке загруженных при повторном использовании. Избегайте добавления подстрок "Рис №", "Рисунок №" в имя загружаемого файла, так как при смене нумерации или перемещении изображения по статье номер рисунка изменится и перестанет соответствовать указанному в имени файла, что будет вносить путаницу.
  4. При загрузке изображений необходимо подобрать для них оптимальное разрешение, обеспечивающее наилучшее качество картинки при наименьшем размере файла. Запрещается загружать изображения разрешением вроде 3000х5000 пикс., если для этого нет веских оснований. Так же не загружайте сложные изображения вроде схемы устройств в разрешении 200х300 пикс., которые будут трудны для прочтения.