Проект:Таксономия/Документирование шаблонов

Материал из Википедии — свободной энциклопедии
Перейти к навигации Перейти к поиску
Портал:Таксономия   Проект:Таксономия   Обсуждение проекта   Справочные материалы   Участники проекта
Пожалуйста, добавляйте новые темы снизу
История вопроса: 01

Текущие проблемы с документацией шаблона Таксон[править код]

Перенесено со страницы Обсуждение проекта:Таксономия.

В развитие мыслей о «техзадании». Я сейчас посмотрел файл Шаблон:Таксон/doc — в нём, как оказалось, нет самого главного (с точки зрения стратегии его доработки): не указано его назначение. Сделать это на самом деле совсем не просто: шаблон Таксон ведь не просто средство, помогающее создавать карточки организма (как шаблон {{Taxobox}}), но и средство создания системы таксономических шаблонов. Но как должна создаваться эта система, на основании каких классификаций, насколько она должна быть детализирована? Централизованно она создаётся или нет? Все эти вопросы должны быть где-то подробным образом прописаны (не обязательно в самой документации шаблона, но в документации на них обязательно должна быть ссылка). Даже если относительно некоторых из этих вопросов ещё ничего не ясно, следует, как мне кажется, написать, что эти вопросы находятся в стадии обсуждения. --Bff 09:49, 22 июня 2010 (UTC)[ответить]

Согласен, подробных описаний и инструкций по использованию не хватает. Всё что пока удалось сделать, это документацию к шаблону и ту вероятно надо дорабатывать. Для исправления ситуации можно наметить ряд мер и попытаться их выполнить.
  1. Создать в проекте отдельную тему, например Проект:Таксономия/Документирование шаблонов, где концентрировать сырые материалы и предложения.Сделано, спасибо Bff. --Chan 03:07, 7 июля 2010 (UTC)[ответить]
  2. Подготовить и внести в рекомендации Википедия:Биологические статьи#«Карточка организма» сведения о шаблоне Таксон.
  3. Дополнить/переработать Википедия:Как читать карточку организма или создать дополнительную статью, где тоже отразить информацию о шаблоне Таксон.
  4. Попытаться написать „человеческим языком“ инструкцию по созданию таксономических шаблонов, понятную для людей знающих таксономию на достаточном уровне, но неосведомлённых о премудростях создания шаблонов.
Список, вероятно, можно дополнить. --Chan 10:58, 22 июня 2010 (UTC)[ответить]
Первый пункт — определить нормативный список функций шаблона Таксон (то есть консенсусный список тех функций, которые в нём должны быть). Некоторые функции, кстати (в том числе часть тех, которые были предложены участников SergeyJ), имеет смысл реализовывать вовсе не в рамках шаблона Таксона, а в рамках некоего другого шаблона, который, с одной стороны, будет от первого независимым (особенно в плане отладки), с другой стороны, может с шаблоном Таксон каким-либо образом взаимодействовать (комбинироваться, вызываться). --Bff 12:08, 22 июня 2010 (UTC)[ответить]
Если честно, мне сложно оперировать такими понятиями. Как правильно выделить функции шаблона и разложить по „полочкам“ исчерпывающим образом я не знаю. Могу определить только несколько общих функций, которые складываются в свою очередь из более мелких.
Реализованы:
  1. Отображение биологической классификации от указанного таксона.
  2. Отображение ссылок на родственные проекты и значимые ресурсы, + элементы сервиса по обращению к некоторым ссылкам.
  3. Отображение иллюстрации
  4. Отображение ареала
  5. Отображение сведений о типовом таксоне
  6. Отображение списка синонимов
  7. Отображение списка дочерних таксонов или ссылки на такой список
Дополнительно возможны:
  1. Категоризация статей о таксонах шаблоном Таксон в зависимости от значений параметров rang, latin и parent.
  2. Категоризация таксономических шаблонов в зависимости от значений параметров rang, latin и parent. Дополнение --Chan 10:01, 7 июля 2010 (UTC)[ответить]
Возможно, я что-нибудь упустил. Вы имели ввиду это? --Chan 12:27, 22 июня 2010 (UTC)[ответить]
Примерно. Важно определить, какие функции у шаблона должны быть обязательно. Если эти функции реализованы, шаблон можно рекомендовать к применению, если нет — нельзя. Некоторые пункты из этого списка очевидно правильные, некоторые требуют обсуждения. --Bff 12:48, 22 июня 2010 (UTC)[ответить]
Какие пункты из списка требуют обсуждения в первую очередь? --Chan 03:07, 7 июля 2010 (UTC)[ответить]

Функции шаблона Таксон[править код]

Функции шаблона Реализация Наличие документации, комментарии
Создание информационной карточки биологического таксона. + +
Отображение биологической классификации указанного таксона. + Есть краткая информация о таксономических шаблонах, используемых в карточке. Нет пояснений по принципам создания таких шаблонов.
Напрашивается создание Википедия:Таксономическая навигация. Тема многоплановая и обширная для документации одного шаблона. --Chan 10:05, 15 июля 2010 (UTC)[ответить]
Опционное отображение промежуточных рангов. + Нужны комментарии к данной функции.
Отображение ссылок на родственные проекты и значимые ресурсы; элементы сервиса по обращению к некоторым ссылкам. + Нет инструкций по использованию. Требуются комментарии по каждому пункту (к примеру, какую ссылку указывать на викисклад — на страницу категории таксона или страницу самого таксона). Нужны рекомендации для особых случаев (к примеру, для случая отсутствия соответствующих страниц на викискладе и викивидах).
Отображение иллюстраций + Нет рекомендаций. Нужен пример использования параметра images_set.
Отображение карты ареала + Нет рекомендаций.
Отображение сведений о типовом таксоне + Нет рекомендаций.
Отображение информации о синонимике таксона + Нет рекомендаций.
Отображение информации о дочерних таксонов + Нет рекомендаций.
Включение примечаний и ссылок в шаблон Таксон и таксономические шаблоны. + нет
Исключение лишней информации из карточек таксонов, у которых некоторые из родительских таксонов являются монотипными. нет Статьи о некоторых таксонах являются одновременно основными для одного или нескольких их родительских таксонов — так происходит, когда эти родительские таксоны являются монотипными (монотипическими). В подобных случаях в карточке таксона уместно указывать подробную информацию о названиях этих родительских таксонов (русское название, международное научное название, авторство названия). Но для дочерних (по отношению к данному) таксонов столь подробная информация о родительских таксонах неуместна (к примеру, в статье о роде Хвощ информация об авторах названий семейства Хвощёвые (Equisetaceae) и порядка Хвощёвые (Equisetales) уместна, но в статье Хвощ полевой неуместна).
Категоризация статей о таксонах шаблоном Таксон в зависимости от значений параметров rang, latin и parent. нет
Категоризация таксономических шаблонов в зависимости от значений параметров rang, latin и parent нет

Документация для вспомогательных шаблонов шаблона Таксон[править код]

Ниже приведена таблица, отражающая текущее состояние с документацией вспомогательных шаблонов шаблона Таксон, входящих в категорию «Шаблоны:Шаблоны для шаблона Таксон»

Шаблон Наличие и состояние документации Комментарий
{{FirstRang}} Шаблон:FirstRang/doc Имеется, но написана не слишком понятно.
{{GRIN+}} Шаблон:GRIN+/doc +
{{IPNI+}} Шаблон:IPNI+/doc +
{{IUCN+}} Шаблон:IUCN+/doc (+)
{{LastRang}} Шаблон:LastRang/doc +
{{Rang}} Шаблон:Rang/doc (+)
{{Rang/color}} Шаблон:Rang/color/doc (+)
{{TaxInfo}} Шаблон:TaxInfo/doc
{{TaxRecursion}} Шаблон:TaxRecursion/doc (+) Указаны только принципы работы
{{TaxString}} Шаблон:TaxString/doc
{{TaxSubRecursion}} Шаблон:TaxSubRecursion/doc (+)
{{Таксо-карточка}} Шаблон:Таксо-карточка/doc
{{Таксон/IUCN}} Шаблон:Таксон/IUCN/doc
{{Таксон/Цвет}} Шаблон:Таксон/Цвет/doc

Система таксономической навигации[править код]

Для включения в документацию шаблона

--Chan 11:37, 10 июля 2010 (UTC)[ответить]