User Tools

Site Tools


Sidebar






Old

wiki_rules

Правила организации информации в Wiki

Преамбула: в целом, организация информации в Wiki подчиняется общим правилам разработки исходного кода в объектно-ориентированном стиле. Пространства имён, страницы, правила размещения и т.п. подчиняются здравому смыслу разработки, исходя из этого ниже описаны наиболее общие рекомендации к ведению базы знаний

Общие рекомендации

  1. При создании страниц не обязательно именовать внутренние ссылки явно через “|”, так как имя автоматически возьмётся из заголовка страницы которую вы создадите:
    [[:xxx:yyy]] - имя берётся из заголовка страницы yyy
    [[:xxx:yyy|zzz]] - имя указывается явно, если не хотим, чтобы оно совпадало с заголовком
  2. Перемещение страниц между пространствами имён допустим только через специальную кнопку справа на панели “Переименовать страницу”: в этом случае
    • сохраненится вся история изменений
    • обновятся все ссылки на эту страницу по Wiki автоматически
  3. Базовая страница пространства имён именуется “start”, это позволяет делать некоторые вещи удобнее (потом напишу какие). Важно заметить, что во внутрених ссылках слово “start” упоминать не надо, Wiki сама перейдёт на эту страницу при обращении к пространству имён - это ключевое зарезервированное слово
  4. При перемещении страницы не нужно нигде ставить галочку типа “Создать страницу со ссылкой на перемещаемую”, это излишне
  5. Расставлять заголовки на странице сильно полезно, делать это удобнее через верхнее меню (клавиши “H”) - после создания заголовков автоматически справа страницы сформируется её краткое содержание
  6. Исходный код при его вставке на страницу нужно обрамлять тэгами <code cpp></code> с указанием языка - плагин подсветит синтаксис
  7. Экранирование спецсимволов типа [[ делается так
    %% [[ %%
  8. Страницы и пространства имён именуются чисто английскими терминами - использование транслита плохой тон, исключениями конечно можно считать имена собственные, аббревиатуры…

Полезно знать

  1. Есть возможность добавить дискуссию к странице, если считаете, что обратная связь может быть полезна. Делаетя это добавлением в конце страницы:
    ~~DISCUSSION~~
  2. В редакторе страниц справа внизу есть возможность расширить поле редактирования нажатием несколько раз стрелки “вниз” - так удобнее
  3. Внутренние ссылки могут содержать в том числе заголовок внутри страницы, чтобы переходить сразу к нужному месту страницы
  4. Если вы сделали совершенно незначительные изменения на страничке и не хотите, чтобы они попали в общую рассылку изменений по Wiki тем, кто на неё подписан - можно поставить галочку “Небольшие изменения” справа от кнопки “Сохранить”

Типовые ошибки

  1. Ссылки на страницы / файлы внутри Wiki оформлены как внешние: внутренние ссылки необходимо оформлять именно как внутренние, так как иначе при перемещении страниц/пространств имён Wiki не сможет корректно обновить положение ресурсов и ссылка погибнет
  2. Создана пустая страница: не нужно резервировать место под страницу через её создание, если прямо сейчас не собираетесь там ничего размещать. Существование страницы предполагает наличие на ней какого-то осмысленного содержимого, необходимости резервировать “красивое имя” страницы нет
You could leave a comment if you were logged in.
wiki_rules.txt · Last modified: 2020/08/27 09:51 (external edit)