Различия

Здесь показаны различия между двумя версиями данной страницы.

--- terms:теги [2009/08/07 19:10]
+++ terms:теги [2010/04/13 12:22] (текущий)
@@ Строка 1: / Строка 1: @@
 ====== Теги в разделе пользовательской документации ======
-Статьи в разделе пользовательской документации данного ресурса сортируются с помощью тегов. Тег - это ключевое слово (или кототкое словосочетание), описывающее категорию, к которой относится статья. Например, если в статье говориться о том, как поменять обои на рабочем столе GNOME, то вполне разумным будет поставить на неё теги //«GNOME»// и //«Оформление»//.
+Статьи в [[:wiki|разделе пользовательской документации]] данного ресурса сортируются с помощью тегов. Тег - это ключевое слово (или короткое словосочетание), описывающее категорию, к которой относится статья. Например, если в статье говориться о том, как поменять обои на рабочем столе GNOME, то вполне разумным будет поставить на неё теги //«GNOME»// и //«Оформление»//.
 Статьи, помеченные тегами, попадают в индексы, которые формируются очень просто: все статьи с указанным тегом выводятся на страницу в виде списка. Например, [[:wiki:gnome|индексная статья]] для тега //«GNOME»//.
 Таким образом пользовательская документация устроена следующим образом: все статьи делятся на категории, за каждой из которых закреплён определённый тег. Для каждой категории существует индексная страница, на которую можно попасть по ссылкам с [[:wiki|главной страницы]] раздела пользовательской документации. На индексную страницу любой категории //автоматически// попадают все статьи, помеченные тегом этой категории.
+<note important>Вручную добавлять в индексные страницы ссылки на статьи запрещено (кроме особых случаев), индексы формируются //автоматически//, поэтому помечайте свои статьи нужными тегами и они попадут в соответствующие индексы.</note>
 У статьи может быть несколько тегов и, таким образом, она может относиться к нескольким категориям, как в приведённом выше примере. Создавая статью в разделе пользовательской документации вы должны чётко определить к каким категориям она относится и поставить соответствующие теги, чтобы ваша статья не потерялась. Вы можете ставить теги, для которых ещё нет соответствующих категорий, возможно, они появятся в дальнейшем, как только накопится достаточное количество статей данной тематики. Вообще желательно как можно более полно описывать содержание статьи помечающими её тегами.
@@ Строка 11: / Строка 13: @@
 Если вы затрудняетесь с нужными тегами, пометьте статью тегом //«NEW»//, редакторы увидят это и расставят необходимые теги.
-<note important>Все создаваемые в [[:wiki|разделе пользовательской документации]] статьи в обязательном порядке должны снабжаться хотя бы одним тегом.</note>
+<note important>Все создаваемые в [[:wiki|разделе пользовательской документации]] статьи в обязательном порядке должны снабжаться хотя бы одним тегом, кроме того, они должны попадать хотя бы в один раздел.</note>
 Теги не чувствительны к регистру, однако всё же стоит писать их единообразно, т.е. первое слово начинать с заглавной буквы, всё остально писать строчными, соблюдая при этом принятные правила написания различных сокращений и т.д., например, //«GNOME»// пишется именно как //«GNOME»//, а не как //«Gnome»// и уж точно не как //«GNoMe»//.
@@ Строка 19: / Строка 21: @@
 Кроме категорий статьи делятся на типы:
-  * HOWTO - подробные руководства.
+  * **HOWTO** - подробные руководства.
-  * Tips - подсказки и советы.
+  * **Tips** - подсказки и советы.
-  * Проблемы - статьи, посвящённые решению тех или иных проблем.
+  * **Проблемы** - статьи, посвящённые решению тех или иных проблем.
-  * Остальные статьи - статьи, не относящиеся ни к одному из приведённых выше типов.
+  * **Остальные статьи** - статьи, не относящиеся ни к одному из приведённых выше типов.
-Разделение на типы позволяет группировать статьи не только по категориям, как, например, это сделано на [[:wiki:gnome|индексной странице]] GNOME.
+Разделение на типы позволяет группировать статьи не только по категориям, к примеру, на [[:wiki:gnome|индексной странице]] GNOME статьи разбиты по типу.
 Чтобы отнести статью к одному из типов необходимо добавить соответствующий тег: //«HOWTO»//, //«Tips»//, //«Проблемы»// или ни один из них для остальных статей. Статья должна относиться только к одному из приведённых выше типов.
@@ Строка 42: / Строка 44: @@
 ===== Как узнать, какой тег соответствует той или иной категории =====
-Допустим, вы написали статью и хотите чтоб она попала в индексы некоторых категорий. Для этого вам всего лишь необходимо поставить нужные теги. Но как узнать, какой тег соответствует той или иной категории? Это не всегда очевидно, поэтому в правом нижнем углу каждой индексной страницы написан тег, по которому статьи попадают на эту страницу. Например, внизу [[:wiki:gnome|индексной страницы GNOME]] написано:
+Допустим, вы написали статью и хотите чтоб она попала в индексы некоторых категорий. Для этого вам всего лишь необходимо поставить нужные теги. Но как узнать, какой тег соответствует той или иной категории? Это не всегда очевидно, поэтому в правом нижнем углу каждой индексной страницы написан тег, по которому статьи попадают на эту страницу (не перепутайте с тегом //«Индексная страница»//, который проставлен для каждого индекса). Например, внизу [[:wiki:gnome|индексной страницы GNOME]] написано:
   tag: GNOME
 Значит, чтобы ваша статья попала в этот индекс, необходимо поставить ей тег //«GNOME»//.
+===== Специальные теги =====
+Существует четыре специальных тега, относящихся скорей не к содержанию статьи, а к необходимым действиям над ней:
+  * **NEW** - этим тегом должны помечаться новые статьи если автор не знает, какие ещё теги можно поставить на статью и в какую категорию эту статью можно определить (например, если подходящей категории просто нет).
+  * **Можно_улучшить** - этим тегом должны помечаться статьи, содержание которых вполне описывает заявленную проблему, но которым необходимы различные мелкие доработки, например, стилистические правки, добавление скриншотов, примеров конфигурации и так далее.
+  * **%%FIXME%%** - этим тегом должны помечаться все статьи, требующие исправлений, например, недописанные статьи, статьи с ошибками и т.д.
+  * **Незаконченная_статья** - данный тег аналогичен тегу //%%FIXME%%//, однако между ними существует ряд отличий. Тег //%%FIXME%%// говорит нам, что статья нуждается в доработке и любой желающий может улучшать ее когда хочет. Тег //Незаконченная_статья// предназначен для другого. Существуют ситуации, когда первоначальный вариант статьи автор пишет постепенно. В таком случае, автору, естественно, не хочется ставить тег //%%FIXME%%//, т. к. на данном этапе работы над статьей он лучше знает((ну по крайней мере так он считает %%=)%% )) что еще нужно с ней сделать. Вот для этого и предназначен тег //Незаконченная_статья//. Таким образом, если вы решили написать статью, по каким то причинам ее не окончили, однако собираетесь завершить над ней работу в течение недели или двух — вы можете вместо тега //%%FIXME%%// поставить ей тег //Незаконченная_статья//. В таком случае статья не отображается в списке статей, требующих доработки. Если в течение двух недель вы не сделаете в статье новых правок, редакторы снимут тег //Незаконченная_статья// и выставят статье тег //%%FIXME%%//. Будьте внимательны при создании новых статей, если вы не дописали статью до конца и не выставили ей один из тегов //Незаконченная_статья// или //%%FIXME%%//, статье будет выставлен тег //%%FIXME%%// и использование с ней тега //Незаконченная_статья// будет впредь запрещено.
+  * **Устаревшая** - этим тегом помечаются статьи, информация в которых устарела и не является до конца верной.
+Кроме того, существует специальный тег для учёта индексов:
+  * **Индексная_статья** - этим тегом помечаются все индексные статьи, помечать их категорийными тегами или тегами типов запрещено.
 ===== Список категорий, имеющих на данный момент индексные статьи =====
 {{topic>Индексная_статья&nouser&nodate}}

Теги в разделе пользовательской документации Сравнение версий

Различия