id: Гость   вход   регистрация
текущее время 21:45 25/09/2017
Владелец: SATtva (создано 14/09/2006 22:50), редакция от 11/06/2010 20:38 (автор: SATtva) Печать
Категории: сайт проекта, руководства, wiki
создать
просмотр
редакции
ссылки

Действия


Оглавление документа:


Действия — это специальные модули, динамически формирующие и выводящие данные из wiki согласно параметрам запроса. В основном действия предназначены для автоматизации тех задач, выполнение которых вручную требовало бы слишком много времени и сил: например, автоматическое создание оглавления страницы.


Синтаксис действий таков:


{{ИмяДействия параметр1=321 параметр2="текст" ... }}

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

Оглавления и списки


Действия для создания оглавлений и различных списков страниц.

Автоматическое оглавление страницы (TOC)


Эта команда формирует оглавление документа на основе подзаголовков, которые размечены в тексте с помощью знаков «равно» ("===", см. основы форматирования). Каждая строка оглавления является ссылкой, прокручивающей окно просмотра документа так, чтобы соответствующий заголовок оказался в самом верху окна. Главный заголовок страницы (размеченный двойным «равно» — "==") в оглавление не включается и не нумеруется: он должен быть один в документе — на то он и главный заголовок.


Синтаксис



Вместо сокращенного названия {{TOC ... }} допустимо использовать синоним {{TableOfContents ... }}.


  • page — параметр, который содержит вики-имя страницы, для которой формируется оглавление. Если параметр опущен или пуст, оглавление формируется для данной страницы.
  • title — текст заголовка оглавления. Если параметр опущен, выводится просто "Оглавление документа".
  • numerate — нумерация заголовков в документе и в оглавлении. Для включения установите параметр равным 1.
  • from, to — какой диапазон заголовков включать в оглавление. По умолчанию это все кроме h1 — заголовка страницы.

Все приведенные параметры опциональны. Чтобы просто сформировать оглавление страницы, вставьте в нужном месте (для удобства, вверху) в текст документа одну команду: {{TOC}}.

Ссылающиеся страницы (BackLinks)


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


Синтаксис



  • page — позволяет задать имя страницы, для которой будет сформирован список. По умолчанию список формируется для текущей страницы.
  • ignore — разделенный запятыми перечень имен страниц, которые не должны отображаться в списке, даже если ссылки с них ведут на заданный документ. Полезно для создания вики-маркеров.

Иерархия документов (Tree)


Формирует и выводит дерево (карту) кластера относительно текущей страницы. Полезно для создания "оглавления" кластера, содержащего множество вложенных страниц.


Синтаксис



  • page — определяет корень кластера, для которого строится дерево (по умолчанию корнем является данная страница).
  • depth — на сколько уровней кластера выводить иерархию документов. Значение 0 выведет дерево на максимальную глубину.
  • style — метод форматирования списка. Может принимать одно из следующих значений: br, ul, ol, indent.
  • title — заголовок блока. Если параметр опущен, выводится просто "Дерево кластера".
  • nomark — если равно 1, не отображает стандартный заголовок либо заголовок, установленный через title.

Вместо действия {{Tree ... }} можно использовать более простой аналог {{Index}}. Это действие не принимает параметров, а только выводит список страниц, находящихся на один уровень ниже данной.

Иерархия ссылок (LinksTree)


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


Синтаксис



  • page — определяет корень кластера, для которого строится дерево (по умолчанию корнем является данная страница).
  • depth — на сколько уровней кластера выводить иерархию документов. Не может быть больше 4.
  • nomark — если равно 1, не отображает стандартный заголовок "Дерево ссылок".

Самые популярные страницы (MostPopular)


Действие выводит список из N самых популярных страниц сайта (популярность определяется по числу просмотров).


Синтаксис



Параметр max задает количество страниц, входящих в формируемый список.

Список наблюдателей (Watchers)


Выводит список пользователей, отслеживающих (с помощью функции "следить") изменения документа. Внимание: действие работает только для владельца документа.


Синтаксис



  • page — определяет имя страницы, для которой строится список (по умолчанию — для текущей страницы).
  • nomark — если равно 1, не отображает стандартный заголовок над списком.

Список ключевых слов / рубрик (Keywords)


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


Синтаксис



  • root — в списке рубрик рядом с каждой отображается количество страниц, отнесенных к ней. Аргумент root указывает кластер, от которого будет вестись этот подсчет. (Если задан аргумент ids, то полученный список страниц будет также принадлежать указанному кластеру.) По умолчанию считает от корня сайта, т.е. всё.
  • nomark — если равно 1, не отображает стандартный заголовок над списком. При значении 2 не отображает заголовок даже с аргументом keywords. По умолчанию 0.
  • list — если равно 0, ключевые слова в списке не будут ссылками, нажав на которые можно получить страницы, относящиеся к ним. По умолчанию 1, т.е. позволяет просмотреть страницы для каждого из ключевых слов.
  • ids — разделенный запятыми список ID-номеров рубрик. Если аргумент задан, действие не выводит список рубрик сайта, а только список страниц, относящихся к заданным здесь рубрикам (каждая страница должна относиться ко всем рубрикам сразу). Сами ID можно получить, вызвав действие без параметров — они будут указаны в ссылках ключевых слов. Данный аргумент отменяет действие list и inline.
  • sort — упорядочить список страниц, имеющих выбранное ключевое слово: "abc" — по алфавиту (выбор по умолчанию), "date" — по дате создания.
  • inline — вывести ключевые слова одним сплошным текстом, не выделяя в списке группы ключевых слов. По умолчанию 0.

Результат поиска / поисковая форма (Search)


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


Синтаксис



  • text — поисковый запрос. Если не включена опция strict или title, запрос может содержать стандартный поисковый синтаксис: знаки "плюс", "минус", скобки, "звёздочка" и т.д.
  • root — одно или несколько имён кластеров (разделённые запятыми), где должен производиться поиск. Чтобы запретить поиск в каких-то кластерах, поставьте перед каждым знак "минус". По умолчанию поиск ведётся по всему сайту.
  • keywords — разделённый запятыми список ключевых слов для поиска документов по рубрикам (полный список действительных ключевых слов и фраз находится на поисковой странице сайта). Запретить какие-то ключевые слова можно также с помощью знака "минус".
  • author — выбрать документы и комментарии, принадлежащие только конкретному автору. Указание нескольких имён не допускается.
  • filter — если установить в значение "pages", поиск будет производиться только на страницах сайта, но не в комментариях. По умолчанию равен "all", т.е. ищет везде.
  • title — поиск только в названиях документов (по умолчанию выключен). Одновременно отключает поиск в комментариях страниц.
  • strict — искать фразу буквально, как она введена в поисковом запросе. По умолчанию выключено, т.е. ищет похожие.
  • style — стиль отображения результатов. Может принимать одно из следующих значений: "br", "ul", "ol", "comma" для отображения, соответственно, на отдельный строчках, ненумерованным списком, нумерованным списком или через запятую. При этом при использовании списков кроме ссылки выводится часть текста найденного документа. По умолчанию использует "br".
  • limit — количество отображаемых результатов. Может быть от 1 до 100 и по умолчанию равно 5.
  • nomark — если равно 1, не отображает стандартный заголовок над списком результатов. По умолчанию 0.
  • form — показать поисковую форму. Использовать в комментариях не рекомендуется.

Заметьте, что использование всех аргументов совершенно не обязательно. Для простого отображения поисковых результатов достаточно использовать text или keywords (необходим хотя бы один из них).

Аналоги служебных страниц


Выводят локальные аналоги служебных списков страниц для определенного кластера.

Последние изменения в кластере (Changes)


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


Синтаксис



  • page — определяет корень кластера, для которого строится список (по умолчанию корнем является данная страница).
  • max — указывает на максимальное количество страниц, доступных к показу. Заметьте что реальное количество показанных страниц будет зависеть от персональных настроек пользователя.
  • date — позволяет указать дату, начиная с которой (и далее в прошлое) нужно выводить список изменений.
  • noxml — не выводить ссылку на RSS-поток.

Последние комментарии в кластере (RecentComments)


Строит список последних прокомментированных страниц в указанном кластере. Это локальный аналог общей страницы комментариев.


Синтаксис



  • page — определяет корень кластера, для которого строится список (по умолчанию корнем является данная страница).
  • max — указывает на максимальное количество страниц, доступных к показу.

Пропущенные страницы в кластере (Wanted)


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


Синтаксис



Единственный параметр page определяет корень кластера, для которого строится список (по умолчанию корнем является данная страница).

Забытые страницы в кластере (Orphaned)


Выводит список тех страниц кластера, на которые отсутствуют ссылки с других документов сайта (т.е. страниц, навигация к которым затруднена). Это действие, как и {{Wanted}}, особенно полезно в процессе работы над крупными многостраничными сложноструктурированными текстами.


Синтаксис



Единственный параметр page определяет корень кластера, для которого строится список (по умолчанию корнем является данная страница).

Специальные средства вывода и форматирования

Вызов текста другой страницы (Include)


Это действие позволяет отобразить текст одной страницы (целиком или частично) в теле другой (наподобие директивы SSI, используемой веб-серверами). Так можно создавать сводные страницы, на которых можно за раз охватить взглядом сразу несколько разрозненных документов, или делать вставки-цитаты.


Синтаксис



  • page — имя включаемой страницы.
  • notoc — если параметр равен 0 или опущен, то заголовки из включаемой страницы будут добавлены в оглавление текущей страницы. Значение 1 позволяет этого избежать.
  • nomark — если параметр выставлен в значение 0 или опущен, то текст включенной страницы будет окружен рамкой. Если nomark=1, то включенный текст никак не будет обозначен. Если же nomark=2, тогда пользователи, имеющие право на редактирование включенной страницы, увидят рамку и элементы управления, позволяющие перейти к редактированию вложения.
  • nowarning — если равно 1, и включенная страница имеет ограничения на право чтения, система не будет выводить предупреждение для пользователей, не имеющих нужного допуска.
  • first_anchor, last_anchor — эти дополнительные параметры позволяют указать, какую часть включаемого документа стоит показывать. Для этого во включаемом документе нужно окружить желаемую область якорями, а потом указать имена этих якорей в параметрах first_anchor и last_anchor.

Вставка случайной фразы (RandomPhrase)


Вставляет произвольный фрагмент указанной страницы в тело данной. Страница делится на фрагменты по переносам строк (абзацам). Особенно эффективно, если страница, с которой берется текст, содержит только независимые самодостаточные блоки текста (так можно создать на данной странице динамический блок наподобие "Знаете ли вы, что...").


Синтаксис



Поскольку действие RandomPhrase является лишь "обёрткой" для Include (см. выше), список параметров идентичен параметрам последнего.

Список соавторов документа, копирайт (Authors)


Данное действие выводит список пользователей, участвовавших в работе над текущим документом или документами кластера, и дополнительную информацию о лицензии и копирайте.


Синтаксис



  • add — оригинальные авторы (для заимствованного материала) или любой текст, который должен быть отображён над списком соавторов. Список может быть разделён точками с запятой, каждая часть будет отображена на новой строке. К тексту применимы правила вики-синтаксиса.
  • license — лицензионное соглашение, отображаемое ниже списка соавторов. Это может произвольный текст (вики-синтаксис учитывается) либо одна из следующих констант, автоматически выводящих логотип соответствующей лицензии и ссылку на её официальный текст:
    • CC-BY-ND — CreativeCommons-Attribution-NoDerivatives
    • CC-BY-NC-SA — CreativeCommons-Attribution-NonCommercial-ShareAlike
    • CC-BY-SA — CreativeCommons-Attribution-ShareAlike
    • GNU-FDL — GNU Free Documentation License
    • PD — Public Domain, общественное достояние
  • cluster — если равно 1, учитывает соавторов документов всего кластера. По умолчанию равно 0, т.е. отображает соавторов только текущего документа.

Отображение опроса (Polls)


Выводит форму для голосования или результаты опроса.


Синтаксис



  • id — идентификационный номер опроса, который требуется отобразить. Если параметр опущен, выводит все активные опросы.
  • results — если параметр равен 1 и опрос активен (т.е. голосование по нему продолжается), принудительно заставляет показать только его результаты. В противном случае, и если пользователь еще не голосовал, выводит форму голосования (по умолчанию).
  • align — ориентация блока опросов: по горизонтали ("h", значение по умолчанию) или по вертикали ("v"). Имеет смысл только если не указан параметр id.

Управляющие команды


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

Переадресация (Redirect)


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


Синтаксис



Параметр to задает целевую страницу переадресации.


Страницы, ссылающиеся на данную: Comment36587
Новости/2007/07-29-ОбновлениеПлатформыСайтаДоВерсии0820A
Новости/2007/08-26-РубрикаторИРасширениеВозможностейПоиска
Проект/Wiki
Проект/Wiki/КомментарииФайлы


 
Несколько комментариев (4) [показать комментарии/форму]
Ваша оценка документа [показать результаты]
-3-2-1 0+1+2+3