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

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


wiki:plugin:wrap

Это старая версия документа!


Wrap для «ДокуВики»

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

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

Он полностью заменяет: class, clearfloat, div_span_shorthand, divalign2, divalign, emphasis, hide, important_paragraf, importanttext, lang, ltr, noprint, pagebreak, side_note, tip, wpre

Частично заменяет: box, button, color, columns, fontcolor, fontfamily, fontsize2, fontsize, highlight, layout, note, styler, tab, tablewidth, typography

Совместимость

  • 2009-05-28 «Манеры Фрустерика»
    • Не работает: auth_aclquickcheck не может обрабатывать начальные двоеточия в идентификаторах, поэтому я чувствую, что это все еще не работает в «ДокуВики», но, по крайней мере, плагин может правильно учитывать ACL .

Монтаж

Используйте менеджер плагинов для установки или…

  1. скачать zip-файл
  2. распаковать его в<dokuwiki>/lib/plugins/
  3. войдите как администратор и измените плагин в менеджере конфигурации

Применение

Синтаксис

Основной синтаксис:

<WRAP classes #id width :language>
"big" content
</WRAP>

**or**
<block classes #id width :language>
"big" content
</block>

or
<div classes #id width :language>
"big" content
</div>

<WRAP> в верхнем регистре (или, альтернативно, <block> или <div>) создает div и должен использоваться для «больших» контейнеров, окружающих абзацы, списки, таблицы и т. д.

<wrap classes #id width :language>"small" content</wrap>

или
<inline classes #id width :language>"small" content</inline>

или
<span classes #id width :language>"small" content</span>

<wrap> в нижнем регистре (или альтернативно <inline> or <span>) создает span и должен использоваться для «маленьких» контейнеров, внутри абзацев, списков, таблиц и т. д.

Начиная с версии 2013-06-13 также используется сокращенный синтаксис (для оберток без содержимого):

<WRAP classes #id /> или <block classes #id /> или <div classes #id />

и

<wrap classes #id /> или <inline classes #id /> или <span classes #id />

:!: Обратите внимание, что некоторые вещи не будут работать с промежутками : выравнивание (включая выравнивание, созданное путем изменения направления текста), несколько столбцов и ширина, если соответствующий перенос также не плавает.

Примеры

Плагин поставляется с примером страницы, которая должна многое объяснить и выглядит так в шаблоне по умолчанию (см. ниже).

Классы

На данный момент доступны следующие классы:

имя класса описание/примечания
columns – аналогично columns, side_note, styler, tip
column так же, как left в языках LTR и так же, как right в языках с письмом справа налево
left то же, что и column, позволит вам разместить контейнер слева
right позволит контейнеру плавать правильно
center расположит контейнер в горизонтальном центре страницы
col2..col5 будет показывать текст в нескольких столбцах в зависимости от их количества (2, 3, 4 или 5), работает только в современных браузерах (без IE9 и ниже)
colsmall, colmedium, collarge также будет отображаться текст в нескольких столбцах, но в зависимости от их ширины (маленький, средний или большой), работает только в современных браузерах (без IE9 и ниже)
ширина :!: экспериментальная , может работать не так, как ожидалось, включает поддержку мобильных устройств
half подходит для двух столбцов подряд, следует использовать парами
third подходит для трех или двух столбцов подряд, следует использовать в тройках или вместе с twothirds
twothirds подходит для двух столбцов подряд при использовании вместе с third, один шириной 1/3, а другой шириной 2/3
quarter помещается в четыре столбца подряд, следует использовать в четырехугольниках
выравнивания — аналогично <color #22b14c>divalign , columns , styler</color> — :!: не работают с промежутками!
leftalign выравнивает текст по левому краю
rightalign выравнивает текст по правому краю
centeralign центрирует текст
justify оправдывает текст
коробки и заметки - аналогично <color #22b14c>коробке , заметке , подсказке</color>
box создает рамку вокруг контейнера (использует цвета из style.ini)
info (было information в предыдущих версиях) создает синее поле со значком информации
important создает оранжевое поле с важным значком
alert (было:!: warning в предыдущих версиях) создает красное поле со значком предупреждения
tip создает желтую коробку со значком подсказки
help создает фиолетовое поле со значком помощи
todo создает голубое поле со значком todo
download создает зеленое поле со значком загрузки
round добавляет закругленные углы к любому контейнеру с цветом фона или рамкой (работает только в современных браузерах, т.е. без IE )
danger создает красную заметку об опасности
warning создает оранжевое предупреждение о безопасности
caution создает предупреждение о безопасности желтого цвета
notice создает синее уведомление о безопасности
safety создает зеленую заметку о безопасности
метки — похожие на выделение , <color #22b14c>важный_параграф , важный текст</color>
hi помечает текст как выделенный
lo помечает текст как менее значимый
em помечает текст как особо выделенный
разнообразный
clear similar to clearfloat, похоже на <color #22b14c>clearfloat</color> , желательно использовать с div, т.е. с прописными <WRAP>буквами
tabs если обернуть список ссылок, они будут отображаться как вкладки
hide скрывает текст для CSS (текст по-прежнему будет отображаться в исходном коде, в несовременных браузерах и доступен для поиска)
noprint выводит текст на экран, но не на печать, аналогично <color #22b14c>noprint</color>
onlyprint отображает текст только в печатном виде, но не на экране
pagebreak принудительно открывает новую страницу в распечатках (не отображается на экране), аналогично <color #22b14c>разрыву страницы</color>
nopagebreak пытается избежать разрыва страницы в распечатках (не виден на экране)
spoiler показывает белый текст на белом фоне, который раскрывается только при его выделении; похоже на <color #22b14c>скрыть</color>
button при обертывании ссылки стилизует ее как кнопку
tablewidth устанавливает ширину таблиц внутри в зависимости от ширины обертки, частично заменяет <color #22b14c>ширину таблицы</color>
indent делает отступ в тексте, может использоваться вместо <color #22b14c>табуляции</color>
outdent «выступающий» текст, может быть частично использован вместо <color #22b14c>«выступающий»</color>
prewrap оборачивает текст внутри предварительно отформатированных блоков кода, аналогично <color #22b14c>wpre</color>

Known restrictions

  • WRAPs export to ODT format but not everything works 100%
  • Round corners only work in modern browsers (no IE8 and below).
  • Multiple columns only work in modern browsers (no IE9 and below).
  • Width classes are experimental and only work in modern browsers (no IE8 and below).
  • Normal DokuWiki Headlines used to not work and a work-around was added. Now that headlines do work, the work-around is not needed anymore but kept for backwards-compatibility. It was deprecated in version 2018-04-22 and disabled by default. They can be enabled by using the emulatedHeadlines config option. The following syntax would then produce two different kinds of emulated headlines inside any wrap:
    • //**__Big Underlined Headline__**// (They will look a bit different in safety notes.)
    • //**Small Headline**//
  • do not include ~~DISCUSSION~~ within a WRAP noprint block

You might need to adjust a few of the classes to your template's needs, especially hi, lo and em. If you have a dark or otherwise heavily coloured theme, please use the darkTpl config option.

The classes are easily adjustable and extensible. Any wishes are welcome.

Обновление

Для обновления удалите исходную папку lib/plugins/displaywikipage и установите новую версию, как указано выше.

Файл для загрузки

Лицензия

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

Только авторизованные участники могут оставлять комментарии.
wiki/plugin/wrap.1691699728.txt.gz · Последнее изменение: 2023/08/10 23:35 — vladpolskiy