ESyr's Wiki pages:Editing conventions
Материал из eSyr's wiki.
Содержание |
Виды статей
На данных страницах вики можно выделить следующие виды статей:
- Конспект лекции
- Статьи, посвящённые понятиям и терминам
- Описание курса
- Прочие
Конспект лекции
Название
Название должно быть следующего вида: <Название курса>, <Номер лекции, не менее двух цифр> лекция (от <число в формате дд мммм>)
Пример: Базы Данных, 02 лекция (от 07 сентября)
Оформление
Стуктурное оформление
Вначале можно опционально указать краткое содержание лекции. Оно не должно предваряться заголовком.
Справа должна находиться панель с краткой информацией о лекции:
- Курс
- Лектор
- Номер лекции
- Дата прочтения
В конце лекции должен быть указан шаблон Lection и, в случае, если лекция не вычитана, Lection-stub. Также, при наличии шаблона для данного курса лекции, нужно указывать и его.
Кроме того, необходимо указать следующие категории: Лекции, <Название курса>.
Оформление текста
Главный принцип — стараться использовать синтаксис вики там, где это возможно. То есть, использование <p>…</p>, <ul>, <strong> и прочих тегов оформления является излишним. Тем не менее, если же средств вики не хватает для достижения необходимого форматирования (например, для верхнего или нижнего регистра) использование средств HTML и CSS допускается и поощряется.
Ещё один главный принцип — соответствие правилам типографики. То есть, там, где должно стоять длинное тире, должно стоять длинное тире, там, где кавычки, должны стоять угловые кавычки (причём их вид зависит от языка, на котором написан входящий в них текст; например, для русского текста это угловые кавычки — « и »). Для простановки различных спецсимволов надо использовать возможности HTML. Ниже приведена таблица некоторых наиболее часто встречающихся символов, которую мне лень делать (а здесь внешняя ссылка на полную таблицу).
Заголовки
Уровень заголовков должен ориентироваться на глобальную структуру курса.
Определения, комментарии и примеры кода
Если я вдруг таки прикручу стили к CSS-ке, то для пометки, что это определения можно будет использовать стиль definition, для комментария — comment, для примера кода — code. Соответственно, подобные куски текста следует писать внутри <div class="…"> </div>
Кроме того, для определений рекомендуется создавать отдельные статьи.
Ссылки
Должны присутствовать ссылки на источники, где можно узнать дополнительную информацию по теме. Также, если в тексте есть ссылка на другие лекции, то они должны быть оформлены как ссылки. Кроме того, для терминов должна быть ссылка на основную статью (не более одного раза).
Статьи, посвящённые понятиям и терминам
Данные статьи создаются для того, чтобы можно было поучить информацию по понятию, не перерывая весь курс лекций (так как обычно всё, связанное с некоторым понятием, растягивается на несколько лекций).
Название
Название статьи должно совпадать с названием понятия. Также, должны быть проставлены переходы со всех возможных альтернативных названий. Например, на статью «целостность» можно сделать переходы с названий «ссылочная целостность», «integrity».
Оформление
Стуктурное оформление
В начале любой статьи, посвящённой понятию, должно присутствовать определение этого понятия. Оно не должно предваряться никаким заголовком. После определения могут рассматриваться некоторые аспекты понятия (например, для теорем — их доказательства и применение, для класса понятий — отдельные представители понятия (например, для понятия «нормализация», «нормальная форма» можно кратко рассмотреть в статье шесть нормальных форм, хотя, конечно, для них также должны быть отдельные статьи), и так далее), которые уже предваряются отдельными заголовками. Если есть какие-то аспекты понятия, специфичные для отдельного курса (например, роль БЭСМ-6 в становлении современных языков программирования специфична для курса Языков Программирования), то это нужно указать в заголовке.
Оформление текста
Такое же, как и для конспектов лекций.
Ссылки
Должны присутствовать ссылки на места в курсе, где встречаютмся данные понятия, а также на смежные понятия.
