TCKB:Регламент

Материал из TCKB 2.0

Перейти к: навигация, поиск
Эта статья заблокирована администрацией проекта. Возможно, это служебная страница, либо страница защищенная от вандализма.
WTF?

Эта статья содержит спорные, или несогласованные данные. Её необходимо обсудить.


Авторские права

RU.TCKB - Это не Википедия. Это база знаний, также включающая множество авторских материалов - в основном, статей.
Все авторские материалы размещены с разрешения авторов, либо (в тех случаях, когда с авторами связаться не удалось) - с указанием оригинального источника. Тексты всех авторских статей в базе размещаются в оригинальном виде, за исключением исправления грамматических и пунктуационных ошибок.
Такая ситуация налагает ограничение на правку некоторых материалов. Даже в том случае, когда разрешение на изменение текста статьи получено от автора, мы стараемся сохранить оригинальный текст. В том случае, если исправление необходимо (например, в статье допущена грубая неточность), оно вносится в виде сноски или врезки. Однако, в авторских статьях разрешается делать правки, не меняющие оригинальный текст - менять или добавлять изображения, вставлять ссылки, форматировать текст. Также, в некоторых случаях, возможны дополнения к таким материалам, идущие после основного текста и подписи автора. Решение о необходимости таких правок принимают члены координационного совета.

Отличить авторскую статью можно по наличию шаблона {{copyright}} в начале статьи.

Регламент добавления статей

Перенос материала из RU.TCKB

Перенос любых статей из RU.TCKB (chm-база версии 1.7 и более поздних) должен осуществляться с полным сохранением их содержимого. Во время переноса правки оригинального текста не допустимы, за исключением исправить грамматических и пунктуационных ошибок - в случае такой правки нужно обязательно указать на неё на странице обсуждения статьи. Только таким образом возможно сохранять идентичность содержимого онлайн и оффлайн вариантов базы.

Добавление новой статьи.

Несмотря на кажущуюся обьёмность, база знаний описывает далеко не все возможности применения Total Commander, так что работать всё ещё есть над чем.
Добавление новой статьи не ограничено ничем, кроме здравого смысла. Это значит, что любой пользователь (даже анонимный) может добавить собственный материал в TCKB, этот материал будет доступен для просмотра и редактирования всем желающим, а также будет иметь шанс на попадание в оффлайн-версию (см. Завершённые статьи). Писать стоит про то, о чём пока не написано - к примеру вы можете рассмотреть способы использования того или иного плагина, предложить собственный скрипт и т.д. Повторять уже существующие материалы не стоит - даже если вы напишете второй вариант статьи "Total Commander 7.0: что нового?", она вряд ли заменит первоначальный вариант (хотя всё возможно). Лучше предложите правку к существующей статье.
Само собой не стоит добавлять материалы, даже косвенно не имеющие отношения к Total Commander. Такие статьи, если они появятся, будут удалены.
И конечно, права на написанный материал полностью принадлежат автору (автором считается тот, чья подпись стоит под текстом статьи). Если вы желаете сохранить текст статьи неизменным - вставьте шаблон {{copyright}} в начало или конец статьи - в таком случае редактирование статьи остальными участниками проекта будет запрещено.

Регламент изменения статей

Авторские статьи

Авторские статьи - материалы, права на которые принадлежат только их авторам. Их текст не может быть изменён без ведома и согласия автора. В таких статьях разрешено вносить только изменения, не затрагивающие оригинальный текст - добавлять или изменять изображения, расставлять ссылки, изменять форматирование, а также, в особых случаях, вставлять сноски и врезки.

Изменение незавершённых статей

Незавершённые статьи открыты для свободного редактирования. Вносите в них свои правки, указывая на странице обсуждения и/или в истории версий, для чего эти изменения сделаны - тут нет никаких ограничений (если, конечно, статья не является авторской).

Изменение завершённых статей

Завершённые статьи закрыты для изменения обычным и анонимным пользователям, и внести в них изменения напрямую невозможно. Вместо этого нужно добавить изменение (вместе с его описанием) на страницу обсуждения статьи. Члены координационного совета рассмотрят измение и внесут его, либо откажут с указанием причины. Возможен также вариант, когда со статьи будет снят статус завершённой, и она снова будет открыта для свободной правки.

Возможно, вам кажется спорным этот элемент регламента. Напоминаем ещё раз - это не Википедия, здесь предпочитаются другие методы работы.

Описание изменений

В любом случае, внося изменения, обязательно укажите в строке "Описание изменений", что вы сделали. Например "Поправил нерабочие ссылки", "Исправил написание слова Comamnder на Commander" и т.д. Изменения необязательно указывать, если статья была создана вами недавно, и никто другой правок ещё не совершал.

Правила оформления статей

Общие принципы

Все статьи оформляются согласно нижеприведённым правилам. Следовать им строго рекомендуется, хотя и лишний фанатизм, как и везде, может навредить. Руководствуйтесь не только этими правилами, но и собственным здравым смыслом. Если вы видите, что отформатированная согласно правил статья выглядит плохо или некрасиво - сообщите об этом кому-нибудь из администрации, они придумают, как решить проблему.

Абзацы и переносы

Разбиение текста на абзацы помогает увеличить читабельность, а также помогает найти изменения при сравнении двух версий статьи. Определять, где заканчивать старый, и начинать новый абзац, должен уметь любой человек хотя бы со средним образованием :). Собственно, новый абзац начинается после пустой строки, идущей после старого абзаца (как сейчас).

Однако злоупотреблять разбивкой на абзацы не стоит. А вот внимательно следить, чтобы переносимые и вновь написанные тексты были отформатированы именно так, нужно.
Во многих случаях требуется простой перенос текста, без разрыва строки. Разбивка на абзацы тут непригодна, и требуется другое решение. Используйте в таком случае тег <br />, например код

текст
бла-бла-бла<br />
ля-ля-ля

будет отображён как

текст бла-бла-бла
ля-ля-ля

Обратите внимание - перенос строки есть только в том месте, где вставлен тег <br />. Простой перенос строки без тега в результате будет выведен как символ пробела.

Заголовки

Название статьи в саму статью вручную не вписывается. Дело в том, что в wiki название статьи и ссылка на неё - одно и то же; таким образом, создавая новую статью вы автоматически проставляете и то и другое. Пример: ссылка Введение: обзор TC для новичков ведёт на страницу с названием "Введение: обзор TC для новичков", и т.п.
Если название статьи и ссылка на неё не могут быть идентичны (например, если название содержит недопустимые в wiki-ссылке символы), то в начало статьи следует ставить шаблон {{Название|Настоящее название статьи}} Вставка заголовков статей производится следующим образом:
= Заголовок первого уровня =
== Заголовок второго уровня ==
=== Заголовок третьего уровня ===
Как выглядит этот код вы можете проверить, например, в песочнице. Старайтесь не использовать более трёх уровней заголовков - иначе статья будет смотреться очень плохо. Точки после заголовка вставлять необязательно, однако в пределах одной статьи следует следовать единожды выбранному стилю - либо ставить точки, либо не ставить.
Расставляя заголовки, следите, чтобы перед заголовком был только один перенос строки. В противном случае, между предыдущим абзацем и заголовком возникнет пустое место, что выглядит очень некрасиво.

Вставка содержания (списка заголовков) в статью происходит автоматически, если статья содержит четыре и более заголовка. Если содержание не вставлено автоматически, можно использовать служебный тег __TOC__. Этот же тег можно использовать для произвольного расположения содержания, например так:

Содержание

Убрать автоматически вставленный заголовок можно, используя тег __NOTOC__, однако делать это не рекомендуется (кроме как в некоторых служебных страницах и шаблонах). Каждый зарегистрированный пользователь может самостоятельно изменять настройки отображения содержания в своём профиле, либо менять их при просмотре статьи.

Выделение

В TCKB 2.0 приняты следующие принципы выделения текста:

  • Списки. Используются для перечисления чего-либо, например в этом списке перечисляются принципы выделения текста. Список создаётся автоматически, если строка начинается с последовательности * (звёздочка, пробел). Для создания многоуровневых списков достаточно использовать для строки количество звёздочек, равное номеру уровня.
    • Скажем это - второй уровень списка.
  • Нумерованные списки. Также используются для перечисления, в тех случаях когда последовательность пунктов особенно важна. Нумерованный список создаётся автоматически, если строка начинается с последовательности # (решётка, пробел). Один элемент списка должен представлять собой один абзац - иначе последовательность нумерации будет разорвана. Выглядит нумерованный список следующим образом:
  1. Это первый пункт.
  2. Это второй пункт.
    1. Подпункт второго пункта.
  3. И так далее.

Также, как и для обычных списков, многоуровневые нумерованные списки создаются повторением задающего символа (решётки) в начале строки.

  • Полужирный текст. Используется для выделения каких-то значимых фрагментов текста. Например, чуть выше таким образом выделен код вставки элемента списка. Выделить текст можно, заключив его с обеих сторон в тройные апострофы: '''этот текст полужирный'''.
  • Курсивный текст. Используется для примечаний и пояснений прямо в тексте статьи, не имеющих прямое отношение к описываемому в статье предмета, но важных для целостности её восприятия. (Например, это поясняет вот это самое пояснение). Выделение текста производится с помощью обрамления в двойные апострофы: ''вот так''.

Код

Код нужен для выделения преформатированных участков текста, например, исходных кодов или содержимого файлов конфигурации.
Код имеет три варианта оформления:

Это первый вариант оформления
Просто делайте отступ в один пробел перед каждой строкой.
И текст будет оформлен подобным образом.

Для создания пустых строк ставьте перенос строки после пробела.


Второй вариант оформления. Просто заключите форматируемый текст в теги <code></code>.

Можно не заботиться о пустых строках. Но выглядит такое форматирование хуже.
и третий вариант, наиболее предпочтительный - использование тегов <source></source>:

Использование тега <source>

В TCKB используется расширение SyntaxHighlight GeSHi, позволяющее осуществлять подсветку синтаксиса более сотни различных языков. Это повышает читаемость кода и позволяет сохранить оригинальное форматирование, поэтому во всех случаях, когда это возможно, рекомендуется использовать этот функционал.

Просто заключите ваш код в теги <source lang="lang_id"></source>, где lang_id - обозначение используемого языка, например:

<source lang="csharp">
// Hello World in Microsoft C# ("C-Sharp").

using System;

class HelloWorld
{
    public static int Main(String[] args)
    {
        Console.WriteLine("Hello, World!");
        return 0;
    }
}
</source>

даст результат

// Hello World in Microsoft C# ("C-Sharp").
 
using System;
 
class HelloWorld
{
    public static int Main(String[] args)
    {
        Console.WriteLine("Hello, World!");
        return 0;
    }
}


Таблица обозначений поддерживаемых языков: SyntaxHighlight_GeSHi#Supported_languages

Ссылки

Ссылки в wiki - это больше, чем ссылки. С ними гораздо проще и удобнее работать, чем с обычными html-тегами ссылок. Поэтому мы призываем, чтобы в статьях их было как можно больше (напоминаем - без фанатизма). Ссылки делятся на внутренние и внешние, а также на сноски. Ниже приведены примеры работы со ссылками:

Ссылки на существующие и отсутствующие статьи различаются цветом (пример Ссылка на статью, которую создавать не нужно). Если перейти по ссылке на отсутствующую статью, wiki-движок предложит вам такую статью написать (кстати, это один из способов создания новых статей).

Как определить в каких случаях вставлять ссылку? Очень просто: если в статье есть упоминание о чём-то, что описано в присутствующей в базе статье - ставьте ссылку. Если такой статьи нет, но вы считаете, что она должна быть - ставьте ссылку. Если в статье есть упоминание о чём-то, что напрямую к тематике TCKB не относится (например, какая-нибудь утилита) - ставьте ссылку.

Врезки и сноски

Иногда требуется вставить прямо в авторский текст статьи какое-то примечание (например, если автор в своей статье допустил ошибку, а исправить её, не нарушив авторских прав и/или целостности статьи невожможно). В этом случае можно воспользоваться врезкой:

Врезка
Наблюдения за автором показывают, что это психически уравновешенная личность, и всё, что он пишет - истина в последней инстанции.
Доктор Борменталь


Врезка
Чтобы вставить врезку, обтекаемую по левому краю, задайте последний параметр шаблона непустым.
Профессор Преображенский

Для вставки врезки используется шаблон {{Шаблон:Врезка}}. Не используйте врезки для комментариев, для них есть обсуждение страницы!

Сноски применяются в тех же случаях, что и врезки, но вставляют дополняющий или поясняющий текст не в тело статьи, а после основного текста, в основной же текст вставляется лишь номер сноски. Это позволяет избежать проблем с форматированием статьи (из-за размеров врезки).
Все сноски в статье автоматически нумеруются по порядку. Как выглядит сноска, можно посмотреть прямо здесь[1]. Для создания сноски используйте теги <ref> и </ref> (между тегами должен быть собственно текст сноски), после чего создайте в конце статьи новый раздел "Примечания", и запишите в него тег <references />. Наглядный пример использования вы можете увидеть, открыв код этой страницы.

Что предпочтительнее использовать - врезки или сноски? Это как раз тот случай, когда руководствоваться нужно здравым смыслом.

Изображения

Ом Намах Шивая Ом

Изображения помогают усвоить содержимое статьи, наглядно показывая, о чём идёт речь. Отсюда вывод - больше изображений, хороших и разных!

На момент написания статьи в базе (оффлайн-вариант) содержится более двухсот изображений, и по мере развития базы они будут добавляться. При переносе статьи в wiki необходимо также перенести все присутствующие в ней изображения (или хотя бы подготовить перенос этих изображений, расставив соответствующие теги). При этом нужно сохранять подписи под изображениями, а если их нет - рекомендуется их вставлять. Также необходимо сохранять оригинальное название файла, чтобы в дальнейшем избежать разногласий с оффлайн-вариантом. Изображения из оффлайн-базы можно достать воспользовавшись плагином CHMDir, либо любой программой для распаковки chm-файлов.

Для того, чтобы вставить картинку требуется:

  • Залить картинку на сервер (если она ещё не залита). Для этого нужно воспользоваться страницей заливки файлов (ссылку на неё вы всегда можете найти в панели "инструменты"). После заливки следует дать изображению осмысленное и полное описание, по возможности указав, к какой версии Total Commander оно относится (в случае, если это скриншот). Это описание не должно обязательно соответствовать тому, что приведено в оффлайн-варианте базы (многие изображения там вобще не содержит подписей), оно должно точно и полно описывать суть изображения.

Все изображения заливаются в формате png (для статичных изображений), либо gif (для изменяющихся изображений), при этом глубина цвета должна быть установлена в 8 бит (256 цветов). Как показывает практика, этого более чем достаточно для скриншотов.

  • Вставить в текст статьи тег [[Изображение:имя файла|200px|right|thumb|Описание изображения]]. Этот тег вставит на правой стороне страницы превью картинки с обтеканием слева (отформатирует её по ширине до 200 пикселов, высота изменится пропорционально). Также, в тех случаях, когда вставка по правой стороне нежелательна, можно использовать следующий вариант: [[Изображение:имя файла|200px|left|thumb|Описание изображения]] - он вставит изображение слева.

Движок wiki не делает превью самостоятельно - он лишь указывает браузеру, как отображать картинку, поэтому она будет загружена полностью. Если изображение имеет в ширину меньше 200 пикселов, то часть тега |200px| нужно опустить (чтобы избежать растягивания изображения).
Следует проверять, как смотрится изображение. Очень нежелательно, чтобы оно "выезжало" за пределы раздела, к которому относится. Поэтому изображения лучше всего вставлять в начало раздела, как, например, сделано на этой странице. Если изображения всё-таки не умещаются в пределы раздела, оставьте всё как есть, возможно администраторы найдут способ борьбы с этим.

Таблицы

На данный момент не существует строгого регламента по оформлению таблиц в статьях TCKB, хотя бы потому, что таблицы тут встречаются очень редко. Исключение составляют некоторые шаблоны, но использование таблиц в шаблонах никак не регламентируется. Возможно, некий регламент появится позже, если в нём возникнет необходимость.

Если вам нужно вставить таблицу в свою статью, прочтите соответствующую инструкцию в Википедии.

Подписи

Любой авторский текст должен быть подписан с помощью шаблона {{Автор}} следующим образом:

{{Автор|Имя автора|Дата|Источник}}

где

  • Автор - имя или ник автора статьи.
  • Дата - дата создания статьи (если известна).
  • Источник - первоначальный источник статьи (публиковавшее издание и/или ссылка).

Неизвестные параметры можно пропускать, записывая шаблон так:

{{Автор|Подкроватный прятальщик|2=|3=Записки несуществующих существ}}

Подкроватный прятальщик
Записки несуществующих существ


или так:

{{Шаблон:Автор|Привидение с мотором|xx.yy.zz|}}

Привидение с мотором
xx.yy.zz

Статьи собственного авторства можно подписывать тем же образом (это рекомендуемый вариант). В обсуждениях, и других местах, где требуется ваша подпись, лучше использовать теги ~~~ (вставляет подпись автора, так, как указано в его профиле) или ~~~~ (вставляет текущую дату после подписи).

Категории

Категории - удобный инструмент каталогизации статей. Они не только помогают автоматически составлять оглавления, но и облегчают поиск статей. Поэтому категоризация любых добавляемых материалов является строго обязательной. Как категоризировать статью? Очень просто: вставьте в любое место (лучше всего - в конец, после основного текста) тег [[Category:Название категории]]. Само собой, если статья относится к нескольким категориям, то и тегов должно быть вставлено несколько.
Чтобы определить, к какой категории относится написанная вами статья, нужно посмотреть список существующих категорий и выбрать подходящие. Если вы не сможете обнаружить подходящую категорию - свяжитесь с администрацией.

Ссылки на категории вставляются тем же ображом, что и обычные внутренние сслыки, за исключением того, что перед ссылкой ставится двоеточие: [[:Category:Категории|список существующих категорий]].

Любую вновь созданную категорию также требуется добавить в категорию Category:Категории.

Шаблоны

Шаблоны - это удобный инструмент автоподстановки заранее созданных страниц в новые статьи. Только на этой страниц вы обнаружите несколько шаблонов.
У каждого шаблона - свои правила использования. Найти их вместе со списком уже готовых шаблонов можно на странице Категория:Шаблоны.
Пожалуйста, обратите внимание, что некоторые шаблоны не завершены, и иногда представляют собой простую текстовую строку. В этом нет ничего страшного, используйте их по назначению. Шаблоны редактируются и добавляются быстро, возможно уже завтра "некрасивый" шаблон будет изменён, и это отразится на всех использующих его статьях.
Вы можете предлагать свои шаблоны - если они будут сочтены полезными, то их будут использовать. При создании нового шаблона добавляйте его в категорию "Шаблоны", обрамляя в служебный тег <noinclude></noinclude> - вот так: <noinclude>[[Категория:Шаблоны]]</noinclude>. Также, между этими тегами нужно вставить текст, поясняющий назначение шаблона (см., например, {{Шаблон:Автор}}).

Ключевые слова

Ключевые слова значительно облегчают поиск статей (особенно очень небольших, вроде). Ими можно очень кратко описать содержимое, например для этой статьи использованы следующие ключевые слова регламент, инструкция, правила. Можно заметить, что в оффлайн-версии базы ключевые слова прописаны для всех небольших статей (перейдите на вкладку "Указатель", или просмотрите исходный код какой-нибудь статьи раздела "Вопросы и ответы", тег meta name="keywords").

Поэтому вставка ключевых слов в статьи очень желательна. Добавление очень просто: вставьте в конец статьи шаблон {{keywords|ключевые слова через запятую}}.

Количество ключевых слов не ограничено, главное, чтобы они соответствовали статье. Можно использовать жаргонизмы (дебаг вместо отладка), неверные, но принятые в общем употреблении слова (мобильник вместо мобильный телефон) - как не прискорбно, некоторые пользователи по своей неграмотности будут искать именно такие слова. Само собой, что вставлять правильные слова также необходимо.

Завершённые статьи

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

Присвоение статуса завершённой статьи

Статус завершённой присваивается статье любым членом координационного совета в том случае, если она соответствует вышеприведённому описанию. Предложение сделать статью завершённой может поступить от любого пользователя - для этого ему необходимо вставить в начало статьи шаблон {{Предложена в завершённые}}, а на странице обсуждения описать причины, по которым он это предалагает. Если предложение встретит поддержку со стороны пользователей и не будет иметь возражений со стороны членов координационного совета, то статье будет присвоен такой статус, в противном случае предложение будет отклонено с обьяснением причин.

Завершённые статьи добавляются в категорию Завершённые статьи

Снятие статуса завершённой статьи

Если завершённая статья перестаёт соответствовать вышеуказанному описанию, то с неё может быть снят этот статус. Для этого пользователь, предлагающий отмену статуса, должен на странице обсуждения статьи указать причины несоответствия статусу. Это, например, может быть появление новой версии описанных плагинов, найденные серьёзные ошибки, и тому подобное. Для предложения снятия статуса вовсе не обязательно самому предлагать устранение найденных недостатков, достаточно лишь указать на них. Порядок рассмотрения заявки о снятии статуса такой же, как и в случае предложения присвоения статуса.

Дополнительная информация

Члены координационного комитета имеют право менять статус статей самостоятельно по одной простой причине - они обладают теми же правами, что и другие пользователи, поэтому могут вносить предложения, и тут же сами их рассматривать.

Координационный совет

Координационный совет - группа пользователей, имеющих права администрирования базы, а также имеющих право принимать решение о дальнейших путях её развития. Координационный совет - это также высшая инстанция по решению любых спорных вопросов. В совет назначаются пользователи, заинтересованные в развитии базы, и уже осуществившие соответствующий вклад. Назначение членов совета производится уже состоящими в нём пользователями по принципу общего обсуждения.

Полезные ссылки

Примечания

Ключевые слова: регламент, инструкция, правила
Личные инструменты
Реклама