Оформление статей

Материал из База знаний 'Клуб Пингвинов CPPS.APP'
Перейти к навигацииПерейти к поиску

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

Кнопки

Panel.png

  1. Полужирное начертание
  2. Курсивное начертание
  3. Внутренняя ссылка
  4. Внешняя ссылка (помните о префиксе https://cpps.app/)
  5. Заголовок 2-го уровня
  6. Встроенный файл
  7. Ссылка на медиа-файл
  8. Математическая формула
  9. Игнорировать вики форматирование
  10. Ваша подпись и момент времени (не используйте)
  11. Горизонтальная линия (не используйте)

Название статьи

Название статьи должно соответствовать действительности. В названии статьи запрещено использовать: символы (кавычки, восклицательные и вопросительные знаки, скобки), букву "ё".

Переименование. Перенаправление

Если статья, по какой-либо причине (например, с обновлениями), нуждается в переименовании, то необходимо перейти к необходимой статье и в правом верхнем углу нажать "Переименовать". Обязательно указывайте причину!

При перенаправлении, во избежании каких-либо ошибок и прочего, следует дополнительно сообщить Архитектор.

Определение

Все статьи, как правило, начинаются с определения слова или словосочетания, о котором пойдет речь. Слово или словосочетание выделяются полужирным шрифтом:

  • Слово - ...

Если это слово или словосочетания имеет сокращенную форму (чаще всего 2 буквы), то об этом следует написать между ним и - в круглых скобках, которые выделяются курсивом:

  • Слово (сокр. ... ) - ...

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

  • Слово (сокр. ... ; др. ... , ...) - ...
Итог:
'''Гарри Технарь''' ''(сокр. Гарри)'' - главный изобретатель на Острове и бывший владелец Спортивного магазина. Всегда появляется в одной и той же одежде: белом лаборантском халате и круглых больших очках. Раньше был очень стеснительным и болел клаустрофобией.Один самых частопоявляемых пингвинов.Если Новичков что-нибудь натворил, а это бывает нередко, то всегда все приходится исправлять Гарри.

Заголовки

Перед началом написания статьи необходимо разбить ее на разделы (заголовки), которые в дальнейшем вы будете заполнять. Заголовки бывают:

== 2 уровня ==
=== 3 уровня ===
==== 4 уровня ====

Заголовки 2 уровня используются для разбиения статьи на основные разделы (что вы и сделаете в самом начале). Однако, если заголовку необходим подзаголовок (в случае перечисления или подобные ему), то помимо заголовка 2 уровня, следует использовать заголовок 3 уровня. Также возможно использование заголовка 4 уровня, но настоятельно рекомендуем остановиться на 3 уровне, а при возможности и на втором.

Содержание

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

Знаки препинания

При расстановке знаков препинания в тексте статей следует руководствоваться правилами русского языка. При наборе:

  • запятой (,)
  • точки с запятой (;, .,)
  • двоеточия (:)
  • точки (.)
  • восклицательного знака (!)
  • вопросительного знака (?)
  • многоточия (...)

от предыдущего слова пробелом они не отделяются, но отделяются одиночным пробелом от следующего слова.

Скобки

В тексте в качестве скобок используются круглые скобки:

  • ... (текст) ...

Он отделяется снаружи одиночным пробелом с двух сторон. Если же сразу после скобки ставится какой-либо знак препинания, то пробел (см. правила выше) не ставится. Внутри между текстом и скобками по краям пробелы не приветствуются.

Кавычки

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

  • ... "текст" ...

Текст статьи

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

См. также

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

Категории

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

[[Категория:Тест]]

Страница может быть внесена больше чем в одну категорию, для чего проставляется несколько тегов. Например:

[[Категория:Тест2]] 
[[Категория:Тест3]

Категории принято располагать в конце статьи.

Ссылки

Ссылки бывают двух видов:

Внутренняя ссылка

Используется вид [[текст]], который направит на статью с названием из БЗ текст . Важно знать, что:

  • Первая буква точки назначения автоматически делается большой.
  • Внутренние пробелы автоматически представляются как подчеркивания (набор подчеркивания имеет тот же эффект, что и набор пробела, но не рекомендуется).

Таким образом, приведённая выше ссылка ведет на https://wiki.cpps.app/index.php?title=Текст, которая является статьей с названием "Текст".

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

Помимо этого, вы получите [[Монеты|30 монет]].

Помимо этого, вы получите 30 монет.

Внешняя ссылка

Используется вид [https://cpps.app/ Текст]. Важно знать, что в основе внешних ссылок могут быть использованы только такие сайты, как:

  • https://cpps.app/
  • http://youtube.com/

Таким образом, приведённая выше ссылка ведет на https://cpps.app/, которая отобразиться в статье как Текст.

Изображения

Обязательно к ознакомлению: Правила создания скриншотов для базы знаний

Все изображения, которые находятся в базе знаний, должны быть загружены на сервер. Максимальный размер файла: 2 МБ. Разрешенные типы файлов: png, gif, jpg, jpeg. Для включения файла в статью Вы можете использовать строки вида:

[[Файл:File.jpg]] -  для вставки полной версии файла.
[[Файл:File.png|200px|thumb|right]] - для вставки уменьшенной до 200 пикселей по ширине версии файла справа от текста.

Изображения должны быть расположены исключительно по правую сторону (right), иногда по центру (center) и никогда по левую сторону (left). Размер изображений уменьшенной версии строго 200 пикселей (за некоторым исключением расположения по центру или показа внешнего вида предмета в статье).

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

Подписи к изображениям

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

[[Файл:File.png|200px|thumb|right|ОПИСАНИЕ]]

Замена старой версии изображения на новую

Для замены изображения необходимо пройти к его просмотру > История файла > Загрузить новую версию этого файла.

Что делать? Расширение файла не соответствует его MIME-типу.

Загружаемый файл должен быть такого же расширения, как предыдущий. Т.е. для png - png, для gif - gif, для jpg - jpg.

Списки

Списки бывают двух видов:

Маркеры

Маркеры используются при перечислении того или иного предмета или действия. Имеется два варианта написания:

html-код
<ul>
	<li>...</li>
	<li>...</li>
	<li>...</li>
</ul>
wiki-разметка
*...
*...
*...

Нумерация

Нумерация используется при разъяснении хода действий. Имеется два варианта написания:

html-код
<ol>
	<li>...</li>
	<li>...</li>
	<li>...</li>
</ol>
wiki-разметка
#...
#...
#...

Таблицы

Таблица всегда должна быть расположена по центру, в отличии от текста в ней, который может быть расположен по любой ее край. Для расположения информации в таблице используется html-код:

<div align="center"><table border="1" width="600" style="text-align: center;">
	<tr>
		<td width="200">Строка 1. Столбец 1</td>
		<td width="200">Строка 1. Столбец 2</td>
		<td width="200">Строка 1. Столбец 3</td>
	</tr>
	<tr>
		<td>Строка 2. Столбец 1</td>
		<td>Строка 2. Столбец 2</td>
		<td>Строка 2. Столбец 3</td>
	</tr>
</table>
</div>

Пояснения:

<table border="1" width="600" style="text-align: center;"> ... </table> - код таблицы, где:
border="1" - вид таблицы;
width="600" - ширина в пикселях;
style="text-align: center;" - расположение текста в таблице.
<div align="center"> ... </div> - расположение таблицы по центру.
	<tr> ... </tr> - строки.
		<td width="200"> ... </td> - столбцы, где:
		width="200" - ширина столбца.