Документация


Автоматически сгенерированная документация по коду системы с разбиением на разделы и примеры.


МенюДокументацияПодразделы
/ WikiPages /

Function.WikiPages

./_documentation/_documentation.php
Функции работы со страницами в Wiki.

Подразделы


A

Эквивалент Anchor.

AllowComments

  • Запрещает/разрешает комментарии на данной конкретной странице.
  • Вызов: {{nocomments}}, {{allowcomments}}.

AllPageIndex

Выводит список всех страниц, по алфавиту.

Anchor

  • Создаёт якорь.
  • Вызов: {{Anchor href="ToC1" [text="Оглавление"] [title="Заголовок"]}}
  • Примечание: параметр href может называться как угодно.

BackLinks

  • Выводит список страниц, ссылающихся на данную.
  • Вызов: {{BackLinks [for="PageName"]}}
  • Параметр for может называться как угодно. Соответственно, первый параметр всегда считается параметром, определяющим, для какой страницы выводить список. По умолчанию равен “!", то есть текущей странице.

Changes

  • Выводит список последних изменений в каком-либо кластере.
  • Вызов: {{changes [for="PageName"] [max="количество страниц"] [date="YYYY-MM-DD"] [noxml=1]}}
  • Параметр for может называться как угодно. Соответственно, первый параметр всегда считается параметром, определяющим, для какого кластера выводить список. По умолчанию равен “!", то есть текущей странице.
  • Параметр max указывает на максимальное количество страниц, доступных к показу. Заметьте что реальное количество показанных страниц будет зависеть от персональных настроек пользователя.
  • Параметр date позволяет указать дату, начиная с которой (и далее в прошлое) нужно выводить список изменений. Параметр date= также можно указать в строке запроса.
  • Параметр noxml заставляет не выводить ссылку на RSS-поток изменений.
  • Синоним recentchanges выводит список последних изменений для всего узла (for="").

Flash

  • Позволяет вставлять flash-анимацию.
  • Вызов: {{flash url="someurl.swf" [width="300"] [height="400"]}}

Include

  • Включение какой-либо страницы целиком в тело данной.
  • Вызов: {{Include page="SomePage" [nomark="1"] [notoc="1"] [nowarning="1"] [first_anchor="..." last_anchor="..."] }}
  • Если стоит nomark=1, то инклюд не выделяется цветом. Если стоит nomark=2, то инклюд не выделяется цветом для тех пользователей, кому не разрешено его исправлять; тем же, кому разрешено — показывается оформление и контрольки. Если стоит notoc=1, то заголовки из включаемой страницы не попадают в оглавление. При выставлении в 1 параметра nowarning не выводится уведомления при вызове Include для страницы, на которую нет доступа.
  • Примечание: параметр page может называться как угодно.
  • Дополнительные параметры first_anchor и last_anchor позволяют указать, какую часть текста включаемого документа стоит показывать. Для этого во включаемом документе надо окружить желаемую область якорями: {{a name="plan_start"}} Текст {{a name="plan_end"}}, а потом указать имена этих якорей в параметрах first_anchor и last_anchor акшна include.

Замечание:
  • при инклюдах иногда глючит вставка страниц. такое ощущение, что она берётся из кэша, хотя кэш по-дефолту выключен. выражается в следующем, инклюдится страница, её редактируешь, возвращаешься на страницу с инклюдом, а там старая информация. экспериментальным путем лечится, когда вносишь какие либо изменения в страницу, которая содержит сам инклюд.
  • в странице, где есть инклюд, вставляется имя инклюдящейся страницы и ссылка «правка», (тема – мамбо, dobee). через некоторое время при заходе на страницу эти надписи становятся невидимы, но когда наводишь мышкой – появляются.

Index

  • Показывает список страниц, дочерних для данной.
  • Вызов: {{Index [for="PageName"] [owner="имя пользователя"]}}
  • Синоним для tree: depth всегда равен 1, а style – br.
  • Параметр for может называться как угодно. Соответственно, первый параметр всегда считается параметром, определяющим, для какого кластера выводить список. По умолчанию равен “!", то есть текущей странице.

InterWiki

  • Список всех InterWiki-узлов, которые определены в данной инсталляции.
  • Вызов: {{interwikilist}}

LastUsers

  • Выводит список из последних 100 зарегистрированных пользователей вместе с количеством принадлежащих им страниц.
  • Вызов: {{LastUsers [stat="0"] [max="количество пользователей"]}}
  • Параметр stat позволяет отключить показ количества принадлежащих пользователям страниц. Если он 0, то max по умолчанию равен 1000, иначе 100.

LinksTree

  • Строит дерево страниц согласно ссылкам между страницами, начиная с root на глубину levels.
  • Вызов: {{linkstree [root="HomePage"] [levels="3"]}}
  • Примечание: levels не может быть больше четырех.

MostPopular

  • Выводит список из N наиболее посещаемых страниц.
  • Вызов: {{mostpopular [max="количество страниц"]}}

MyChanges

  • Выводит список измененных вами страниц с возможностью сортировки.
  • Вызов: {{MyChanges [max="количество страниц"]}}

MyChangesWatches

  • Список изменённых «наблюдаемых» страниц
  • Вызов: {{MyChangesWatches [max="количество страниц"]}}

MyPages

  • Выводит список принадлежащих вам страниц с возможностью сортировки.
  • Вызов: {{MyPages [bychange="1"] [bydate="1"]}}

MyWatches

  • Список всех страниц под «наблюдением» данного пользователя.

Orphaned

  • Выводит список потерянных страниц (те страницы, на которые нет ни одной ссылки) для какого-либо кластера.
  • Вызов: {{orphaned [for="PageName"]}}
  • Параметр for может называться как угодно. Соответственно, первый параметр всегда считается параметром, определяющим, для какого кластера выводить список. По умолчанию равен “!", то есть текущей странице.
  • Синоним orphanedpages всегда работает для корня узла, то есть выводит список потерянных страниц всего узла (for="").

P

  • Проставляет нумерацию для абзацев.
  • Вызов: {{P [style="before|after|left|right"] [name="absolute|document-relative"]}}
  • Стиль влияет на то, где будут выводиться номера абзацев.

PageIndex

  • Выводит полный каталог всех страниц, упорядоченный по алфавиту.
  • Вызов: {{PageIndex}}

RandomPhrase

  • Включение случайной строки с какой-либо страницы в тело данной.
  • Вызов: {{RandomPhrase page="SomePage" [nomark="1"] [useemptystring="1"]}}
  • useemptystring означает разбивать страницу не по строкам, а по блокам, разделенным пустой строкой
  • Примечание: параметр page может называться как угодно.

RecentChanges

Вызов Changes c параметром root=''.

RecentComments

  • Выводит список последних комментариев в этой Wiki.
  • Вызов: {{RecentComments [for="PageName"] [max="количество страниц"]}}
  • Параметр for может называться как угодно. Соответственно, первый параметр всегда считается параметром, определяющим, для какого кластера выводить список. По умолчанию равен «/», т.е. корню сайта.

RecentlyCommented

  • Выводит список последних откомментированных страниц в этой Wiki.
  • Вызов: {{RecentlyCommented [for="PageName"] [max="количество страниц"]}}
  • Параметр for может называться как угодно. Соответственно, первый параметр всегда считается параметром, определяющим, для какого кластера выводить список. По умолчанию равен «/», т.е. корню сайта.

Redirect

  • Безусловно перенаправляет пользователя на другую страницу
  • Вызов: {{Redirect to="/KusoMendokusee"}}, {{Redirect to="!/ПодробнееПроДействия"}}

Search

  • Любой поиск по ваке.
  • Вызов: {{Search [for="что искать"] [topic="1"] [form="1"] [nomark="1"] [style=one of ("br","ul","ol","comma") ] [filter=one of ("pages", "all")]}}
  • Параметр for может называться как угодно; topic можно называть title — если он выставлен в 1, то поиск происходит только по именам страниц, иначе как по именам, так и по текстам; form — говорит, что нужно выводить форму поиска вместе с результатами. Параметр filter отвечает за то, где произодить поиск: только в страницах или в комментариях тоже. nomark, выставленный в единицу, позволяет спрятать рамочку вокруг результатов поиска. style отвечает за внешний вид результатов.
  • Все параметры опциональные.
  • Синоним searchfor отличается лишь тем, что не позволяет включить поиск только по заголовкам.
  • Синоним textsearch всегда выводит форму поиска.
  • Синоним topicsearch всегда ищет только по заголовкам.

TOC

  • Формирует оглавление на основе заголовков.
  • Вызов: {{TableOfContents [for|page="PageName"] [title="title of page"] [numerate="1"] [from="h2"] [to="h6"]}}
  • Параметр title влияет на заголовок самого оглавления. Параметр numerate позволяет пронумеровать все заголовки. Параметр from имеет умолчание “h2”, то есть заголовки первого уровня не включаются в оглавление.
  • Примечание: все параметры опциональные. Можно писать вообще {{TOC}}

Tree

  • Строит дерево страниц, начиная с текущей или указаной страницы.
  • Вызов: {{Tree [page="PageName"] [depth="depth of tree"] [style=one of ("br","ul","ol","indent") ] [owner="имя пользователя"] [nomark="1"]}}
  • Параметр page может называться как угодно. Соответственно, первый параметр всегда считается параметром, определяющим, от какой страницы строить дерево. Если page="", то будет построено дерево всего сайта. По умолчанию равен “!", то есть текущей странице.
  • Параметр depth определяет, на какую глубину отображать дерево. Если указать depth="full", другое не-число или 0, дерево будет выведено полностью.
  • Параметр style определяет стиль отображения дерева. По умолчанию style="indent"

UserGroups

  • Выводит список групп и входящих в них пользователей.
  • Вызов: {{usergroups [cols="5"] [nomark="1"]}}

Wanted

  • Выводит список несуществующих пока страниц, на которые есть ссылки для какого-либо кластера.
  • Вызов: {{wanted [for="PageName"]}}
  • Параметр for может называться как угодно. Соответственно, первый параметр всегда считается параметром, определяющим, для какого кластера выводить список. По умолчанию равен “!", то есть текущей странице.
  • Синоним wantedpages всегда работает для корня узла, то есть выводит список несуществующих страниц всего узла (for="").

Watchers

  • Выводит список наблюдающих страницу. Работает только для владельца страницы.
  • Вызов: {{Watchers [for="~SomePage"] [nomark="1"]}}
  • Параметр for может называться как угодно. Соответственно, первый параметр всегда считается параметром, определяющим, для какой страницы выводить список. По умолчанию равен “!", то есть текущей странице.

CreatePage

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

EmailMsg

Позволяет отправить сообщение с сайта.
Пример вызова: {{emailmsg usermail="to@someone.com"}}.

SavePage

function SavePage($tag, $body, $comment_on = '', $autowrite = “manual”)
Сохраняет страницу.
  • tag – Адрес страницы
  • body – Тело страницы
  • comment_on – Является ли комментарием к какой-то странице.
  • autowrite – Какие права задействовать для проверки того, может ли писать пользователь на данную страницу. Прав два варианта: auto и manual. При обычной правке используются manual, экшны могут использовать auto. Может использоваться, например, для организации гостевой книги.

Wacko

Наследует WackoOld.
Конструктор класса Wacko – основного класса в системе. В конструкторе
* Подгружаются библиотeки сервисов (в QSMini)
* Для всех сервисов выполняется инициализация (обработчик INIT)
* В случае, если пришел AJAX-запрос, подгружается необходимый класс и происходит предобработка переменных.
  • config – Массив из переменных конфигурации. Обычно берется из файла wakka.config.php

LoadIdByTag

Форсированно (с обращением в БД) загружает ID страницы по её тегу.

FormOpen

function FormOpen($method = “ ", $tag = “ ", $formMethod = “post”, $formname=" ", $formMore=" ")
Открывает форму с адекватной адресацией.
  • method – Хандлер
  • tag – Таг 
  • formMethod – Метод отсылки (POST или GET)
  • formname – Имя формы
  • formMore – Дополнительные теги в форме
Возвращает: Возвращает сгенерированное начало формы.

FormClose

function FormClose()
Возвращает сгенерированный конец формы.

QSMiniAction

function Action($action, $params, $forceLinkTracking = 0)
Возвращает результат работы экшна.
  • action – Имя экшна
  • params – Параметры экшна.

QSMiniMethod

function Method($handler,$method)
Возвращает результат работы экшна.
  • action – Имя экшна
  • params – Параметры экшна.

QSMiniRun

Запускает обработку. Рекомендуется переопределить.
  • handler – Набор хандлеров.
  • tag – Таг 
  • method – Метод.
Комментарии [0]  (показать)
Комментарии скрыты. Чтобы увидеть комментарии нажмите сюда.