worldwide open-source software

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

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

[[wiki:DokuWiki]] группирует эти действия в разные меню, которые можно вставлять в шаблон в разных местах.

Также доступен [[https://www.patreon.com/posts/menus-14160215|вводный пост в блоге.]]

===== Доступные меню =====

^ вид ^ Источник ^ Описание ^
| ''site'' | [[https://github.com/dokuwiki/dokuwiki/blob/master/inc/Menu/SiteMenu.php|SiteMenu]] |определяет все действия на уровне вики, например действия, не относящиеся к одной странице. Примеры: недавние изменения, карта сайта) |
| ''user'' | [[https://github.com/dokuwiki/dokuwiki/blob/master/inc/Menu/UserMenu.php|UserMenu]] | определяет действия, относящиеся к текущему пользователю. Примеры: Логин, Администратор. |
| ''page'' | [[https://github.com/dokuwiki/dokuwiki/blob/master/inc/Menu/PageMenu.php|PageMenu]] | определяет действие, связанное с текущей страницей. Примеры: «Редактировать», «Показать старые версии». |
| ''detail'' | [[https://github.com/dokuwiki/dokuwiki/blob/master/inc/Menu/DetailMenu.php|DetailMenu]] | аналогично меню страницы, но связано с изображением при отображении в подробном представлении |
| | [[https://github.com/dokuwiki/dokuwiki/blob/master/inc/Menu/MobileMenu.php|MobileMenu]] | объединяет все элементы из меню «Сайт», «Пользователь» и «Страница», когда им разрешено отображение в мобильном контексте. Полезно для создания единого [[https://en.wikipedia.org/wiki/Hamburger_button|гамбургер-меню]]. |

Плагины могут расширять и изменять вышеуказанные меню, используя событие [[wiki:devel:event:MENU_ITEMS_ASSEMBLY|MENU_ITEMS_ASSEMBLY]].

===== Пункты меню =====

Меню состоят из пунктов меню — объектов, наследуемых от [[gh>inc/Menu/Item/AbstractItem.php|AbstractItem.php]]. Пункт меню настраивает несколько свойств, которые шаблон может использовать для отображения этого элемента. Сюда входят триггерное действие, метка, значок SVG и многое другое. Пожалуйста, обратитесь к [[gh>inc/Menu/Item/AbstractItem.php|источнику]] чтобы узнать, какие свойства доступны..

Плагины могут создавать свои собственные элементы и добавлять их в доступные меню с помощью события [[wiki:devel:event:MENU_ITEMS_ASSEMBLY]].

=== Иконки ===

Значок, возвращаемый методом ''getSVG()'' и заданный в ''$svg'' свойстве, должен соответствовать следующим ограничениям:

  * Он должен быть в формате SVG.
  * Размер файла должен быть меньше 2 КБ.
  * Он должен содержать только один объект пути.
Цвет заливки пути будет установлен CSS шаблона при его использовании.

Чтобы соответствовать стилю других значков, рекомендуется либо выбрать значок из огромного бесплатного выбора на https://materialdesignicons.com/, либо придерживаться [[https://material.io/guidelines/style/icons.html|рекомендаций по дизайну материалов]]  при разработке собственного значка..

===== Добавление меню в шаблоны =====

Меню, упомянутые выше, создают их экземпляры и либо используют один из удобных методов, либо просто вызывают ''getItems()'' и перебирают объекты элементов.

Пример: чтобы интегрировать UserMenu в виде списка ссылок, используйте это:


<code php>
echo (new \dokuwiki\Menu\UserMenu())->getListItems();
</code>

Выпадающее меню для мобильных устройств можно добавить следующим образом:

<code php>
echo (new \dokuwiki\Menu\MobileMenu())->getDropdown();
</code>

Пожалуйста, обратитесь к [[https://github.com/dokuwiki/dokuwiki/blob/master/inc/Menu/AbstractMenu.php|источнику]], чтобы узнать, что еще доступно.

Если вам нужен конкретный HTML-код для пунктов меню, вам нужно перебрать элементы меню и создать HTML самостоятельно. Например, этот цикл создаст значки в [[wiki:template:writr|шаблоне записи]], что немного сложнее:

<code php>
$items = (new \dokuwiki\Menu\PageMenu())->getItems();
foreach($items as $item) {
  echo '<li>'
      .'<a href="'.$item->getLink().'" title="'.$item->getTitle().'">'
      .'<span class="icon">'.inlineSVG($item->getSvg()).'</span>'
      . '<span class="a11y">'.$item->getLabel().'</span>'
      . '</a></li>';
}
</code>

===== Устаревшая поддержка =====

С появлением системы меню следующие функции стали устаревшими. Авторам шаблонов и плагинов следует обязательно заменить их в ближайшее время:

  * ''tpl_button()''
  * ''tpl_actionlink()''
  * ''tpl_get_action()''
  * ''tpl_actiondropdown()''
  * ''tpl_toolsevent()''