ДСП:Правила оформления статей: различия между версиями
Перейти к навигации
Перейти к поиску
| (не показано 9 промежуточных версий этого же участника) | |||
| Строка 1: | Строка 1: | ||
| + | Обратите внимание на каждый пункт данных правил. Все они обязательны для соблюдения, так как благодаря им статьи будут более легко читаемыми, обладать одинаковой структурой и иметь однотипное оформление. | ||
| + | |||
| + | С примерами оформления статей, соответствующим описываемым ниже правилам можно на странице [[:Категория:Статьи-образцы|Категория:Статьи-образцы]]. | ||
| + | |||
== Текст == | == Текст == | ||
# Заголовки разделов - строчными буквами с первой заглавной. | # Заголовки разделов - строчными буквами с первой заглавной. | ||
| − | # При копировании текстов из Word необходимо убедиться, что с | + | # Для оформления перечислений используйте нумерованные или маркированные списки. |
| − | # Выравнивание одиночных изображений - по правому краю. Выравнивание группы изображений - по центру. | + | # При копировании текстов из Word необходимо убедиться, что после вставки текст свободен от дополнительного оформления. Например, в скопированном тексте с заголовков должен быть снят признак "Жирный", иначе это приводит к двойному выделению заголовков жирностью. Ошибку видно не во всех браузерах, для проверки нужно использовать Firefox. |
| − | # Ссылки внутри документа | + | # Выравнивание одиночных изображений - по правому краю или по центру, если необходима вставка относительно большого изображения типа схемы или чертежа. Выравнивание группы изображений - по центру. Группу изображений можно ставить с помощью тегов <nowiki><div><ul><li> или таблицы с невидимыми границами.</nowiki> |
| + | # <s>Ссылки на раздел внутри документа необходимо предварить решеткой (#), например: <nowiki>[[#Субмодули расширения]]</nowiki>.</s> | ||
# Для оформления абзацев с содержанием типа "Обратите внимание! ..." используйте шаблон <nowiki>{{Внимание}}</nowiki>. Например: <nowiki>{{Внимание|Тип=Восклицание красный.png|Текст=Интерфейсы USB и RS-232 не имеют гальванической развязки.}}</nowiki>. Для использования с шаблоном доступны иконки "Восклицание красный.png", "Восклицание желтый.png", "Восклицание синий.png". | # Для оформления абзацев с содержанием типа "Обратите внимание! ..." используйте шаблон <nowiki>{{Внимание}}</nowiki>. Например: <nowiki>{{Внимание|Тип=Восклицание красный.png|Текст=Интерфейсы USB и RS-232 не имеют гальванической развязки.}}</nowiki>. Для использования с шаблоном доступны иконки "Восклицание красный.png", "Восклицание желтый.png", "Восклицание синий.png". | ||
== Формулы == | == Формулы == | ||
| − | + | ||
| + | # Для вставки формул используйте встроенный редактор математических и химических формул: В режиме редактора вызовите команду "Вставить → Больше → Математическая формула". | ||
== Таблицы == | == Таблицы == | ||
| Строка 19: | Строка 25: | ||
# Запрещается загрузка нового изображения или файла без проверки имеющихся. Возможно загружаемый файл уже есть в системе. | # Запрещается загрузка нового изображения или файла без проверки имеющихся. Возможно загружаемый файл уже есть в системе. | ||
# При необходимости замены изображения на новый/исправленный вариант запрещается загружать файл заново. Вместо этого используйте функцию "Загрузить новую версию файла" для уже загруженного. | # При необходимости замены изображения на новый/исправленный вариант запрещается загружать файл заново. Вместо этого используйте функцию "Загрузить новую версию файла" для уже загруженного. | ||
| − | # При загрузке изображений для | + | # При загрузке изображений к статье имя файла должно быть осмысленным и отражать суть изображения. Имена типа "рис. 1", "для docs" - недопустимы. Имя файла также нужно снабдить префиксом - короткой строкой без пробелов, объясняющей назначение изображения. Например, при загрузке изображений для статьи "Описание контроллера АГАВА ПК-40" всем изображениям нужно присвоить префикс "Пк40" или "ПК40", чтобы все загруженные изображения имели вид "ПК40-Имя изображения.расширение". Такой способ именования позволит быстрее находить нужные изображения в списке загруженных при повторном использовании. Избегайте добавления подстрок "Рис №", "Рисунок №" в имя загружаемого файла, так как при смене нумерации или перемещении изображения по статье номер рисунка изменится и перестанет соответствовать указанному в имени файла, что будет вносить путаницу. |
| − | + | Примеры правильного оформления: | |
| + | Пк50–Схема подключения питания.png | ||
| + | AgavaPLC–Виджет «Выбор значения из списка».png | ||
| + | AgavaEMU3-Дискретный вход в режиме настройки.png | ||
| + | Примеры неправильного оформления: | ||
| + | АДМ-100 (2).jpg - нет описания изображения | ||
| + | Adm100-228x228.jpg - префикс должен быть на языке оригинального наименования | ||
| + | Для WIKI.jpg - нет описания изображения | ||
| + | Рисунок 6378-2.jpg - нет описания изображения | ||
| + | Рис 1 - Внешний вид БПС .jpg - нет префикса, присутствует номер рисунка | ||
| + | МП4.jpg - нет префикса и описания изображения | ||
| + | Рисунок МП1.gif - нет префикса и описания изображения | ||
| + | Рис 2.png - нет префикса и описания изображения | ||
| + | Pk60-06-500x500.jpg - префикс должен быть на языке оригинального наименования, есть ненужное указание размера изображения, нет описания изображения | ||
| + | Screenshot 1.png - нет префикса и описания изображения | ||
| + | <blockquote>4. При загрузке изображений необходимо подобрать для них оптимальное разрешение, обеспечивающее наилучшее качество картинки при наименьшем размере файла. Запрещается загружать изображения разрешением вроде 3000х5000 пикс., если для этого нет веских оснований. Так же не загружайте сложные изображения вроде схемы устройств в разрешении 200х300 пикс., которые будут трудны для прочтения.</blockquote> | ||
Текущая версия на 20:00, 5 декабря 2021
Обратите внимание на каждый пункт данных правил. Все они обязательны для соблюдения, так как благодаря им статьи будут более легко читаемыми, обладать одинаковой структурой и иметь однотипное оформление.
С примерами оформления статей, соответствующим описываемым ниже правилам можно на странице Категория:Статьи-образцы.
1 Текст
- Заголовки разделов - строчными буквами с первой заглавной.
- Для оформления перечислений используйте нумерованные или маркированные списки.
- При копировании текстов из Word необходимо убедиться, что после вставки текст свободен от дополнительного оформления. Например, в скопированном тексте с заголовков должен быть снят признак "Жирный", иначе это приводит к двойному выделению заголовков жирностью. Ошибку видно не во всех браузерах, для проверки нужно использовать Firefox.
- Выравнивание одиночных изображений - по правому краю или по центру, если необходима вставка относительно большого изображения типа схемы или чертежа. Выравнивание группы изображений - по центру. Группу изображений можно ставить с помощью тегов <div><ul><li> или таблицы с невидимыми границами.
Ссылки на раздел внутри документа необходимо предварить решеткой (#), например: [[#Субмодули расширения]].- Для оформления абзацев с содержанием типа "Обратите внимание! ..." используйте шаблон {{Внимание}}. Например: {{Внимание|Тип=Восклицание красный.png|Текст=Интерфейсы USB и RS-232 не имеют гальванической развязки.}}. Для использования с шаблоном доступны иконки "Восклицание красный.png", "Восклицание желтый.png", "Восклицание синий.png".
2 Формулы
- Для вставки формул используйте встроенный редактор математических и химических формул: В режиме редактора вызовите команду "Вставить → Больше → Математическая формула".
3 Таблицы
- Все таблицы должны иметь строку заголовка с соответствующим выделением.
- При копировании таблиц из Word необходимо убедиться, что с текста заголовков таблиц снят признак "Жирный", иначе это приводит к двойному выделению заголовков жирностью. Видно не во всех браузерах. Для проверки нужно использовать Firefox.
4 Файлы/Изображения
- Запрещается загрузка нового изображения или файла без проверки имеющихся. Возможно загружаемый файл уже есть в системе.
- При необходимости замены изображения на новый/исправленный вариант запрещается загружать файл заново. Вместо этого используйте функцию "Загрузить новую версию файла" для уже загруженного.
- При загрузке изображений к статье имя файла должно быть осмысленным и отражать суть изображения. Имена типа "рис. 1", "для docs" - недопустимы. Имя файла также нужно снабдить префиксом - короткой строкой без пробелов, объясняющей назначение изображения. Например, при загрузке изображений для статьи "Описание контроллера АГАВА ПК-40" всем изображениям нужно присвоить префикс "Пк40" или "ПК40", чтобы все загруженные изображения имели вид "ПК40-Имя изображения.расширение". Такой способ именования позволит быстрее находить нужные изображения в списке загруженных при повторном использовании. Избегайте добавления подстрок "Рис №", "Рисунок №" в имя загружаемого файла, так как при смене нумерации или перемещении изображения по статье номер рисунка изменится и перестанет соответствовать указанному в имени файла, что будет вносить путаницу.
Примеры правильного оформления:
Пк50–Схема подключения питания.png AgavaPLC–Виджет «Выбор значения из списка».png AgavaEMU3-Дискретный вход в режиме настройки.png
Примеры неправильного оформления:
АДМ-100 (2).jpg - нет описания изображения Adm100-228x228.jpg - префикс должен быть на языке оригинального наименования Для WIKI.jpg - нет описания изображения Рисунок 6378-2.jpg - нет описания изображения Рис 1 - Внешний вид БПС .jpg - нет префикса, присутствует номер рисунка МП4.jpg - нет префикса и описания изображения Рисунок МП1.gif - нет префикса и описания изображения Рис 2.png - нет префикса и описания изображения Pk60-06-500x500.jpg - префикс должен быть на языке оригинального наименования, есть ненужное указание размера изображения, нет описания изображения Screenshot 1.png - нет префикса и описания изображения
4. При загрузке изображений необходимо подобрать для них оптимальное разрешение, обеспечивающее наилучшее качество картинки при наименьшем размере файла. Запрещается загружать изображения разрешением вроде 3000х5000 пикс., если для этого нет веских оснований. Так же не загружайте сложные изображения вроде схемы устройств в разрешении 200х300 пикс., которые будут трудны для прочтения.