Оформление

Материал из Compilers Wiki
Версия от 16:36, 5 апреля 2018; Admin (обсуждение | вклад)
(разн.) ← Предыдущая | Текущая версия (разн.) | Следующая → (разн.)
Перейти к: навигация, поиск

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

  1. Каждый текст разбивается на визуально удобно читабельные абзацы.
    1. Если у текста есть первоисточник, то под каждым таким абзацем указывать аналогичный абзац первоисточника.
      1. Думаю, теги pre для выделения оригинала подойдут.
      2. Для каждой статьи обязательно указывать ресурс-первоисточник. Это можно сделать единоразово, в конце страницы: два отступа («\n») от конца текста, разделительная черта (h1, но лучше 4 тире - черта в Wiki-разметке), текст «Источник: », домен, к которому прилагается точная ссылка. Пример. Источник: c9x.me.
    2. Разрешается создавать Wiki-структуры и использовать возможности HTML для оформления страниц.
  2. В каждой статье, в случае, если применяются аббревиатуры, либо термины, к каждому такому термину в русскоязычном тексте/переводе указывать ссылку на сторонний ресурс ([ссылка Термин]) или на уже существующую на нашей Wiki статью (
    [[Термин]]
    или, если термин склоняется,
    [[СтатьяНаWiki | Термин]]
    ).
  3. Код оформляется двумя способами.
    1. Если строка используется в где-то в тексте, то её нужно выделить либо тегами
      <code></code>
      , либо
      <b></b>
      =
      <strong></strong>
    2. Если код приводится после текста/абзаца, то каждая строка к каждой строке с кодом добавляем пробел в ее начало. Это выделит код в блок.
      1. Если в тексте есть указание на какой-то конкретный пример кода, который уже был приведен, либо только будет приведен, желательно, первую строку в п. 3.2. начать с
        <strong>Пример.<strong>
      2. Если в тексте присутствует не один пример, а несколько, то каждый блок кода, являющийся примером, должен начинаться с
        <strong>Пример НомерПримера.</strong>
    3. Комментарии в блоках кода для удобства чтения будем указывать по принципу QBE (у Python так же) - через символ решетки. То есть, например, </code>%a = w add 0,1 # Кладем 1 в переменную а</code>.
  4. В массивных текстах, в которых возможно логическое разделение на главы, лучше это практиковать. В Wiki-разметке первый уровень выделяется в два знака равно, второй в три знака равно, третий - в четыре, и тд. Пример:
    == Глава 1 ==, === Раздел 1 (первой главы) ===
  5. В случае возникновения проблем с переводом, либо при отсутствии возможности однозначной трактовки, обязательно указывать через слэш, либо в круглых скобках вторую возможную трактовку/комментарий/примечание.