Инструменты пользователя

Инструменты сайта


Боковая панель

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

О «Докувики»

Дополнительные возможности

Corporate Use

Наше сообщество


Следуйте за нами на Фейсбуке, в Твиттере и других социальных сетях.

Конфиденциальность (англ.)

ru:plugin:subjectindex

Плагин SubjectIndex

Совместим с «Докувики»

Anteater, Rincewind, Angua, Adora Belle, Weatherwax

plugin Создаёт страницу (-цы) предметного указателя, основанного на тегоподобных элементах указателя в каждой странице

Последнее обновление:
2013-03-27
Предоставляет
Syntax, Action
Репозиторий
Исходный код
Конфликтует с
dw2pdf

Это расширение не обновлялось более двух лет. Возможно, оно больше не разрабатывается или не поддерживается; возможны проблемы совместимости.

Похож на tag

Теги: index, links, navigation, tags

Загрузка и установка

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

В последней разработанной версии:

ПРЕДУПРЕЖДЕНИЕ: последний релиз (2011-11-27) и описание ниже представляют собой полностью переработанную версию плагина. Я пришёл к выводу, что мою предыдущую версию сложно использовать и объяснять, и надеюсь, что новые изменения сделают её более простой для понимания.

Синтаксис и использование

Добавьте в произвольное место своих вики-страниц предметно-указательные или «теговые» элементы (entries), которые затем будут автоматически собраны в указатель. Список элементов потом может быть выведен на другую вики-страницу в алфавитном или вручную заданном вами порядке. Например алфавитные индексы выводятся вначале по первой букве, потом по заголовка и наконец по элементы и ссылке на страницу.

Этот плагин может быть точно описан как «структурные теги!» Его легко использовать как теги… однако он создаёт гораздо более полезные, удобочитаемые страницы указателей, особенно по сравнению с облаками тегов; напоминает алфавитный предметный указатель в конце справочника.

Все синтаксические параметры

Синтаксис Описание Пример По умолчанию
{{entry >[параметры]}} Добавить новый элемент предметного указателя на страницу {{entry >[раздел/][заголовок][|отображение}}
раздел1) Раздел (section), к которому будет добавлен элемент (0-9) {{entry >2/...}} 0
заголовок Новый заголовок (-ки), создаваемые в указателе: 1 или больше слов/фраз, разделённых «/» {{entry >2/Природа/Бабочки/Монарх...}}
отображение Что должно быть показано на странице:
1. отображаемый текст
2. |* или | означает показать весь заголовок
3. «-» означает не показывать ничего

{{entry >...|Что вы видите}}
{{entry >...|*}}
entry >...|-}}
значок звёздочка
{{subjectindex>[параметры]}} Добавляет таблицу предметного указателя к текущей странице {{subjectindex>section=1;border=inside;title;cols=3}}
abstract показать аннотацию (abstract) страницы содержания в виде всплывающей подсказки {{subjectindex>abstract}} нет
border отобразить рамку вокруг или внутри таблицы содержания, параметры - inside, outside, both либо none border=inside
border=both
none
cols поделить список на колонки, допускается до 6. cols=3 1
section2) Индекс отображаемого раздела (0-9)3) section=1 0
proper использовать правильный регистр для названий вики-страниц и элементов {{subjectindex>proper}} нет
title использовать заглавие (1-й заголовок) вместо названия страницы для ссылок {{subjectindex>title}} нет
noAtoZ не показывать главные буквенные заголовки, некоторые указатели не требуют этого (например могут быть числовыми) {{subjectindex>noAtoZ}}
showorder показывать указанные вручную номера в списках на вики-странице указателя {{subjectindex>showorder}} нет
default сделать данную страницу целевой по умолчанию страницей (default target page) для ссылок элементов (entry links) в этом разделе {{subjectindex>default}} нет
#tag Добавить новый тег на страницу4) #дом, #работа #два_слова
теги не могут содержать пробелов, однако вы можете использовать вместо них подчёркивание («_»), и оно будет заменено пробелом при отображении;
допускаются все международные символы

Как это работает

В этом плагине 2 основные части:

  • Множество элементов указателя или тегов, которые являются всего навсего простой разметкой на ваших вики-страницах: размещайте их где вам угодно, настолько часто, насколько требуется. Нет нужды помещать их внизу страницы…
  • Одна или более страниц, содержащих разметку предметного указателя: 5) отображают список или таблицу всех элементов и ссылок на каждую страницу.

За кулисами плагин собирает все элементы и теги вместе каждый раз, когда вы сохраняете страницу, и хранит их в скрытом УКАЗАТЕЛЕ, разбитом на РАЗДЕЛЫ, и затем позволяет вам отображать каждый раздел на отдельных страницах предметного указателя в алфавитном порядке. Это напоминает оглавление в конце хорошей книги. Вы можете иметь больше одной страницы предметного указателя в вашей вики, например для создания библиографии, хронологии, списка тегов, списка ссылок и т. д… Система очень гибкая!

Когда вы добавляете новый элемент, вы можете указать разделу с каким номером (0-9) принадлежит элемент. Однако плагину ещё нужно знать, на какую страницу (-ы) элемент должен ссылаться… поэтому у вас также есть параметр для установки целевой по умолчанию страницы для каждого раздела в указателе. Поясняющий пример: если вы поместили разметку {{subjectindex>section=2;default...}} на страницу, то все элементы в разделе 2 будут автоматически ссылаться на эту страницу. Плагин предостережёт вас, если вы создадите элемент без целевой по умолчанию страницы.

Добавление элемента предметного указателя (или тега)

Синтаксис:

{{entry >[раздел/заголовок/подзаголовок/]элемент[|отображаемый текст]}}

[..] = необязательный

Значение каждой составляющей элемента

  • раздел : элемент будет добавлен к этому разделу предметного указателя. Раздел представляет собой число 0-9
  • заголовок : главный заголовок на отображающей предметный указатель странице, под которым будет показан элемент, первая буква используется для буквенных заголовков
  • подзаголовок : то же самое, но ниже (может быть больше одного)
  • элемент : фактический текст элемента; значимое описание того, чему посвящён элемент
  • отображаемый текст : что должно быть видно на странице: может быть другим текстом, просто звёздочкой или отсутствовать!

Создание тегов:

#тег #тег_из_нескольких_слов

Международные символы допустимы, однако вы не можете использовать пробелы6). Всё же вы можете просто воспользоваться вместо них подчёркиванием (_), и оно преобразуется в пробел при отображении тега.

ЗАМЕЧАНИЕ: за кулисами теги являются просто сокращениями для нормальных элементов предметных указателей, т. е. в соответствии с настройками по умолчанию вы можете создать тег, набрав: {{entry >1/тег|}}

Несколько примеров:

{{entry >книги/фантастика/написание повестей|-}}
{{entry >1/книга/переплёт|}}
{{entry >2/книги/фантастика/написание технической документации|Написание документов}}

Последний из вышеприведённых примеров создаст новый элемент предметного указателя следующим образом:

  • К
    • книги
      • фантастика
        • написание повестей: ссылка на страницу7)

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

  1. Для отображения всего текста элемента на странице используйте …|}} либо …|*}} , оба будут работать.
  2. Для отображения только звёздочки используйте …}}
  3. Чтобы полностью скрыть звёздочку элемента и текст используйте следующее: ..|-}}

Полные примеры:

{{entry >книги/фантастика/написание повестей|-}}   => не видно ничего (запомните: минус или пустой заполнитель (place-holder))
{{entry >книги/фантастика/написание повестей}}     => только звёздочка (по умолчанию)
{{entry >книги/фантастика/написание повестей|*}}   => звёздочка + полный текст элемента

Элементы автоматически сохраняются в указателе при сохранении страницы. По умолчанию данные указателя хранятся в : «./data/index/subject.idx», вместе с другими поисковыми указателями Докувики. Это местоположение может быть изменено на администраторской странице настроек, но на самом деле особого смысла в этом нет.

Ручная сортировка списка предметного указателя

Что, если вам нужно управлять порядком элементов в списке указателя? К счастью существует способ это сделать—достаточно простой способ на самом деле! Вы можете вручную установить порядок каждого элемента, размещая номер с точкой перед любыми заголовками, подзаголовками или текстом элемента. Лучше всего это видно на примере:

{{entry >2.книги/3.фантастика/1.написание повестей}}
{{entry >1.фильмы/1.комедия/3.Три амигос}}
{{entry >3.животные/слоны}}

В вышеприведённых примерах нормальным порядком сортировки будет алфавитный: животные ⇒ книги ⇒ фильмы, но в данном случае будут соблюдены указанные вручную номера: 1.фильмы ⇒ 2.книги ⇒ 3.животные. Номера на каждом уровне тоже будут соблюдены.

По умолчанию маркирующие числа не будут показываться, но вы можете отобразить их используя параметр showorder, как указано выше в таблице. В основном это нужно для устранения ошибок при создании вами порядка вручную.

Создание страницы предметного указателя

Синтаксис:

{{subjectindex>[abstract;border;cols=?;section=?;proper;title;noAtoZ;default]}}

[..] = необязательный

Значение каждого параметра

  • abstract : показать аннотацию (abstract) содержимого страницы в виде всплывающей подсказки
  • border : показать рамки вокруг столбцов таблицы
  • cols=? : количество колонок на странице указателя (максимум = 12)
  • section=?: отобразить элементы соответствующие номеру этого раздела (по умолчанию = 0)
  • proper : использовать правильный регистр для названий вики-страниц и элементов
  • title : использовать заглавие (1-й заголовок) вместо названия для ссылок
  • default : сделать эту страницу целевой по умолчанию для всех элементов в разделе выше
  • noAtoZ : убрать буквенные заголовки; полезно, когда указатель числовой, или у вас есть свои собственные ключевые заголовки

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

Настройка

Вот несколько параметров, которые можно изменить на странице настроек Докувики:

subjectindex_data_dir местоположение файла данных предметного указателя ../data/index/
subjectindex_tag_section раздел указателя специально для тегов 1

Обсуждение

Пожалуйста пользуйтесь issue tracker на GitHub для сообщений об ошибках, проблемах, предложений и т. д… Любые полезные замечания будут обобщены и представлены ниже для общего блага.

Либо вы можете воспользоваться специально предназначенной страницей discussion.

ЧаВО

Пока ничего!

1)
бывший 'индекс', переименован во избежание путаницы
2)
бывший 'индекс', переименован
3)
смотрите разделы выше в этой таблице
4)
Вам потребуется установить «subjectindex_tag_section» в своих настройках, и подготовить целевую по умолчанию страницу для этого раздела, для корректной работы. По умолчанию теговые элементы (tag entries) ведут в раздел №1
5)
Просто нормальные вики-страницы. Смотрите Создание страницы предметного указателя заголовком ниже
6)
Иначе плагин не сможет распознать когда закончилось имя тега и начался другой текст
7)
ссылка на страницу будет указывать на любую заданную по умолчанию страницу для элементов в разделе 2
ru/plugin/subjectindex.txt · Последние изменения: 2015-04-06 04:27 — 37.200.79.3