Версия для слабовидящих

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

Материал из Ярославский педагогический университет
Перейти к: навигация, поиск
Написание статей Написание статей
Техническая справка
Внешняя справка

Для соблюдения принципа стилистического единообразия внешнего вида статей (наиболее общее понятие — страница), а также для удобства их редактирования, просим вас при работе над статьями по возможности следовать приведённым ниже некоторым несложным правилам оформления.

Хотелось бы, чтобы этим требованиям соответствовали все статьи. В то же время, никто не заставляет вас полностью и в точности соблюдать их, пока вы ещё пишете статью. Следует всегда помнить, что главное — это хорошее, чёткое, информационно богатое и беспристрастное содержание, а не красивое оформление. Даже если никуда не годная по своему содержанию статья и будет красиво и правильно оформлена, толку от неё всё равно будет не больше, чем от любой другой плохой статьи. Но если статья с качественным содержанием ещё и безукоризненно оформлена, если каждому виден вложенный в неё труд автора, то это позволяет ей подняться на более высокий уровень в сравнении со столь же информативными, но плохо оформленными текстами.

Разумеется, для написания хорошей информативной и объективной статьи эти знания не так уж и необходимы — ведь написать хорошую статью всегда труднее, чем её оформить.

Как править статьи

Сайт ЯГПУ работает по принципу «вики», но не каждый может свободно отредактировать любую статью. Здесь рассказывается, как редактировать страницы, применяя вики-разметку.

Рубрикация

Для удобства ориентирования в статье, особенно в тех случаях когда она достигла достаточно большого размера, рационально использовать разделение текста на блоки — рубрикацию.

Цель рубрикации — создание чёткой системы заголовков, ясно отражающей логическую структуру статьи.

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

Заголовки набираются по несложным правилам.

Каждый заголовок занимает отдельную строку. Перед ним одна строка оставляется пустой, а последующий текст начинается сразу со следующей после заголовка строки.

При разделении текста на рубрики, обратите внимание, что после последнего слова заголовка точка не ставится.

…текст статьи.

== Новый заголовок ==
Продолжение текста статьи…

При разделении текста на части в первую очередь следует руководствоваться принципом разумности и необходимостью создания максимального удобства для читателя статьи.

Лучше всего позаботиться заранее о рубрикации будущей статьи, продумать содержание заголовков, их взаимную подчинённость и соотношение с текстом.

Текст заголовка должен быть по возможности кратким и максимально точно передавать содержание следующего за ним текста статьи. То есть, заголовок по содержанию не должен быть шире или уже текста, но должен быть достаточно полным, чтобы показать, о чём дальше в статье пойдёт речь.

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

Также обратите внимание на то, что если в подразделе оказался всего один внутренний заголовок, то, скорее всего, такое деление неправильное, и либо осталась неозаглавленная часть текста, либо внутренний заголовок по сути сам является подразделом.

Основной текст статьи

Основной текст статьи набирается без абзацного отступа с единичными пробельными интервалами между словами. Разделение текста на абзацы осуществляется набором одной пустой строки (дважды нажатая клавиша Enter). Единичный перевод строки не приводит к созданию нового абзаца, но может быть полезен для упорядочивания текста и удобства просмотра на этапе редактирования.

Механизм Wiki обеспечивает автоматическую вёрстку строк, выравнивая текст на странице в соответствии с индивидуальными настройками пользователя (по умолчанию, по левому краю), поэтому для разметки основного текста статьи не следует использовать инструменты языка HTML (шрифтовое и цветовое выделения, …)

Механизм переносов слов в Википедии не реализован, поэтому в помещаемом в статью тексте символов переноса быть не должно.

Таблицы

Для единообразного оформления статей рекомендуется использовать в общих случаях таблицы класса standard. Оформление таблиц для специальных случаев приведено в статье «Справка:Оформление таблиц»; а в статье «Справка:Таблицы» дано подробное описание составления самих таблиц.

Иллюстрации

Подписи к иллюстрациям

Как правило, все помещаемые в статью иллюстрации следует снабжать кратким информативным пояснением — подписями. Однако подпись не должна дословно дублировать часть текста статьи.

В состав подписи могут входить следующие элементы:

  • условное обозначение иллюстрации — слово Рис.;
  • номер иллюстрации;
  • название иллюстрации (тема);
  • расшифровка обозначений — легенда и (или) экспликация;
  • комментарии.

Естественно, что в подавляющем большинстве случаев состав подписи будет ограничен двумя-тремя элементами, или даже одним.

Примеры подписей к иллюстрациям:

  • 616. Артерии головы и шеи; справа (полусхематично)
  • Рис. 10.7. Установка для зонной плавки:
1 — нагреватели; 2 — зоны расплава
  • Рис. 10.23. Конические зубчатые колёса:
а — с прямыми; б — с косыми; в — с круговыми зубьями
  • Структурная формула холестерина

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

Требования к изображениям

Изображение, которое вы собираетесь поместить в свою статью, должно соответствовать ряду требований:

  • Соблюдение авторского права: никогда не помещайте изображения, если это не разрешено их правообладателями.
  • Используйте правильный формат изображений:
    • для векторных изображений применяйте формат SVG;
    • для неподвижных растровых изображений с преобладанием плавных цветовых переходов (фотографии, репродукции художественных произведений) применяйте формат JPEG;
    • для неподвижных [растровых изображений с резкими границами между цветными областями (схемы, карты, скриншоты программ, изображения символов и т. д.) применяйте формат PNG;
    • для подвижных (анимированных) растровых изображений применяйте формат GIF;
    • если ваши изображения имеют другие форматы, то конвертируйте их в рекомендуемые.
  • Для каждого изображения имеется страница с его описанием, которую вы обязаны заполнить. Поэтому приготовьте в обязательном порядке данные об источнике (в случае, если автор изображения не вы) и лицензии.

Загрузка файла на сайт

Загружать файлы на сайт могут только зарегистрированные участники.

Последовательность действий описана на странице Загрузить файл. При загрузке учитывайте некоторые особенности Вики:

  • в названии файлов Вики различает написание ПРОПИСНЫМИ и строчными буквами;
  • при загрузке изображения более высокого качества под тем же названием старое изображение не стирается, а сохраняется в «истории»;
  • для переименования изображения требуется новая загрузка файла. Старая версия должна быть стёрта администратором.

Загрузка файлов отражается в журнале загрузки файлов. Просмотреть ранее загруженные файлы можно в списке или в галерее загруженных изображений. Желательно также иметь имя автора (фотографа или художника) и подумать над описанием изображения. Последнее должно быть коротким и не отвлекать от созерцания самого изображения.

Формулы

Математические формулы следует оформлять с помощью специального языка разметки формул — TeX.

Формулы, которые набираются отдельным абзацем (то есть не внутри основного текста), размещаются с отступом слева (для чего перед абзацем ставится двоеточие), а не центрировано. Несколько идущих подряд формул или одну формулу, но разбитую на несколько строк, также набирают с отступом слева. Примеры:

<math>1-\frac12+\frac13-\frac14+\cdots=\ln2</math>.
  • Корни уравнения <math>ax^2 + bx + c = 0</math> можно отыскать по формуле:
<math>x_{1,2}={{-b\pm\sqrt{b^2-4ac}}\over{2a}}</math>.

Сноски (примечания)

Иногда возникает необходимость добавить к какому-либо месту основного текста комментарий, поясняющую цитату или указание на источник информации, но нежелательно расширять основной текст и отвлекать внимание от основного предмета. В таком случае необходимо пользоваться сносками, текст которых будет размещён внизу страницы документа в разделе «Примечания», подобно привычным нам примечаниям в книгах и статьях.

В MediaWiki, существует встроенная поддержка сносок.

Связь между текстом и сноской показывается цифрой или значком, который ставится в основном тексте после фрагмента поясняемого текста, а в разделе «Примечания» — перед текстом сноски.

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