Правила Оформления Материалов
В данном разделе собраны рекомендации по оформлению статей, переводов, комментариев и других материалов, добавляемых в Compo Wiki самими пользователями. Это необходимо по нескольким причинам и прежде всего – для какого-то единообразия в стиле представления однотипных материалов всеми авторами. Конечно, излагаемые здесь Правила носят рекомендательный характер и никоим образом не ограничивают свободу творчества самих авторов. Но нужно помнить, что «свобода есть осознанная необходимость» и учитывать, что оригинальное, но слишком вычурное оформление, если это не есть часть художественного замысла автора, обычно затрудняет пользователям восприятие материала. Поэтому вводимый в Compo Wiki институт редакторов и призван прежде всего осуществлять ненавязчивый контроль за общим порядком в оформлении материалов и в их структурировании.
Общие требования
- При оформлении текстовой части руководствуйтесь общими Правилами грамматики русского языка (орфография и пунктуация). Согласовывайте общий стиль оформления с принятым в разделе, включая рубрикацию и иллюстративный материал, общий дизайн групп статей и т.п. При необходимости консультируйтесь с редактором раздела.
- В качестве названия страницы (см. Вики Имя) следует выбирать ключевое слово или словосочетание, отражающее суть содержания. Язык названия и содержания должен быть один и тот же, за исключением случаев, когда название на иностранном языке необходимо для авторского замысла или по другим существенным причинам (например, название раздела описания функции не русифицированной программы).
- При редактировании страниц с чужим авторством обязательно указывайте свое имя и время редактирования. Всегда подписывайте свои авторские материалы.
- При включении в авторский материал цитат и других заимствованных материалов указание на первоисточник является обязательным. Если автор заимствованного материала сам является одним из пользователей Compo Wiki, то возможна ссылка на его личную страницу с указанием его авторства.
- При добавлении дискуссионного вопроса или комментария к странице добавляйте ниже всего имеющегося текста отстрочку (макрос "----") и заголовок: «Дискуссия» или «Комментарии», если соответствующий раздел на странице еще не создан.
- При возникновении каких-либо трудностей при оформлении материалов обращайтесь за помощью к редактору раздела, в котором будет размещен материал, или к любому опытному пользователю. Срочные вопросы рекомендуется задавать на Форуме.
Рубрикация
- При рубрикации материалов старайтесь следовать общепринятым требованиям редакций и издательств по оформлению материалов в печать.
- Сложность рубрикации должна повышаться соответственно сложности структуры материала и заголовки должны постепенно увеличиваться, начиная с самого нижнего уровня рубрикации, без пропусков отдельных уровней.
- Самым нижним уровнем рубрикации является выделение полужирным шрифтом ключевого заглавного слова или словосочетания, с которого начинается рубрика (абзац). Этот уровень, в соответствии со сложностью всего текста и вложенности рубрик, может не использоваться (быть опущен). В этом случае минимальным уровнем рубрикации является заголовок, выделяемый просто полужирным шрифтом на отдельной строке через 0.5 или один интервал (обычно задается контейнером-обрамлением "======").
- Каждый следующий уровень рубрикации вводится посредством увеличения размера шрифта заголовка на один шаг, что достигается сокращением в контейнере-обрамлении числа знаков "=" на единицу. Самый верхний уровень рубрикации задается всего двумя знаками "==". Образцы написания заголовков приведены на странице Заголовки
- При усложнении рубрикации на странице рекомендуется вводить стандартное оглавление с помощью действия {{toc}}, вставляемого в начало страницы. В этом случае все заголовки при Правильном их синтаксическом оформлении, в соответствии с их вложенностью, будут автоматически выноситься в заголовок по месту расположения макроса.
- Дополнительные возможности по рубрикации текстов можно получить с использованием нумерованных и ненумерованных списков и др. штатных средств мета-языка Compo Wiki (см. Compo Wiki Синтаксис ).
Структурные особенности вики
- Рекомендуется предварять основной материал страницы небольшой аннотацией с заголовком нижнего уровня. Непосредственно за аннотацией может идти оглавление (например, как на данной странице).
- Используйте для выделения важных мест в тексте цветовые макросы. Но не увлекайтесь этими элементами чрезмерно – чтобы не рябило в глазах у читателей. Применяйте цветовое выделение для цитат и дополнительные отступы слева (два пробела на каждый шаг в отступах; один отступ примерно равен шести пробелам.) Для многострочного цитирования используйте тег цитирования.
- В случаях сложного форматирования материалов страницы учитывайте интересы всех пользователей и старайтесь реализовывать как можно более простые схемы, допускающие и не очень большое разрешение монитора, и разумное масштабирование текстов. В очень сложных ситуациях обращайтесь за помощью к редакторам.