Open Source & Linux Lab

It's better when it's simple

User Tools

Site Tools


wiki_rules

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
wiki_rules [2016/08/07 00:55]
kel ↷ Page moved and renamed from etc:rules to wiki_rules
wiki_rules [2016/08/08 20:53]
kel ↷ Links adapted because of a move operation
Line 1: Line 1:
-DELETEME В работе +====== Правила ​организации информации в Wiki ====== 
-<​note>​ +//**Преамбула:**// в целом, организация информации в Wiki подчиняется общим ​правилам разработки ​исходного кода в объектно-ориентированном стиле. Пространства имён, страницы,​ правила размещения ​и т.п. подчиняются здравому смыслу разработки, исходя из этого ниже описаны наиболее общие рекомендации к ведению базы знаний
-Пока тут только список тем ​для разъяснения. ​Список дополняемый. +
-</​note>​ +
-====== Правила ведения вики ======+
  
-==== Имена страниц, пространства имен ==== +===== Общие рекомендации ===== 
- +  - При создании ​страниц ​не обязательно именовать внутренние ссылки явно через "​|",​ так как имя автоматически возьмётся из заголовка ​страницы которую ​вы создадите:<​code>​ 
-==== Хранение ​файлов ​==== +[[:​xxx:​yyy]] - имя берётся из заголовка страницы yyy 
- +[[:​xxx:​yyy|zzz]] - имя указывается явно, если не хотим, чтобы оно совпадало с заголовком</​code>​ 
-использование ​ftp, именование +  - Перемещение страниц между ​пространствами имён допустим только через специальную кнопку справа на панели //"​Переименовать страницу"//:​ в этом случае 
- +    * сохраненится вся история изменений 
-==== Формирование тезауруса ​==== +    ​* ​обновятся все ссылки на эту страницу по Wiki автоматически 
- +  - Базовая страница пространства имён именуется //"​start"//,​ это позволяет делать некоторые вещи удобнее (потом напишу какие). Важно ​заметить,​ что во внутрених ссылках слово //"​start"// ​упоминать не надо, Wiki сама перейдёт на эту страницу при обращении к пространству имён - это ключевое зарезервированное слово 
-==== Теги ​==== +  - При перемещении страницы не нужно нигде ставить галочку типа //"​Создать страницу со ссылкой на перемещаемую"//,​ это излишне 
- +  - Расставлять заголовки на странице сильно полезно,​ делать это удобнее через верхнее меню (клавиши "​H"​) - после создания заголовков автоматически справа страницы сформируется её краткое содержание 
-==== Блоги ​==== +  - Исходный код при его вставке на страницу нужно обрамлять тэгами %% <code c++></​code>​ %% с указанием языка - плагин подсветит синтаксис 
- +  - Экранирование спецсимволов типа %% [[ %% делается так <​code>​%% [[ %%</​code>​ 
-==== Ссылки на бумажные книги ​====+  - По некоторым направлениям существуют условно-эталонные страницы,​ описание чего-то на которых на данный момент наиболее полно, в этом случае логично посмотреть туда (а можно просто скопировать разделы, просмотрев исходник эталонной страницы): 
 +    * //​Описание проекта://​ ... 
 +  - Страницы и пространства имён именуются чисто английскими терминами - использование транслита плохой тон, исключениями конечно можно считать имена собственные,​ аббревиатуры...
  
 +===== Полезно знать =====
 +  - Есть возможность добавить дискуссию к странице,​ если считаете,​ что обратная связь может быть полезна. Делаетя это добавлением в конце страницы:<​code>​~~DISCUSSION~~</​code>​
 +  - В редакторе страниц справа внизу есть возможность расширить поле редактирования нажатием несколько раз стрелки "​вниз"​ - так удобнее
 +  - Внутренние ссылки могут содержать в том числе заголовок внутри страницы,​ чтобы переходить сразу к нужному месту страницы,​ например //​[[etc:​users:​jcmvbkbc#​you_can_find_me_there| искать здесь]]//​
 +  - Если вы сделали //​**совершенно**//​ незначительные изменения на страничке и не хотите,​ чтобы они попали в общую рассылку изменений по Wiki тем, кто на неё подписан - можно поставить галочку "​Небольшие изменения"​ справа от кнопки "​Сохранить"​
  
 +===== Типовые ошибки =====
 +  - //​Ссылки на страницы / файлы внутри Wiki оформлены как внешние//:​ внутренние ссылки необходимо оформлять именно как внутренние,​ так как иначе при перемещении страниц/​пространств имён Wiki не сможет корректно обновить положение ресурсов и ссылка погибнет
 +  - //​Создана пустая страница//:​ не нужно резервировать место под страницу через её создание,​ если прямо сейчас не собираетесь там ничего размещать. Существование страницы предполагает наличие на ней какого-то осмысленного содержимого,​ необходимости резервировать "​красивое имя"​ страницы нет
  
 ~~DISCUSSION~~ ~~DISCUSSION~~
- 
- 
wiki_rules.txt · Last modified: 2016/08/08 20:53 by kel