обзор
Это Textpattern плагин. Он содержит один тег, < txp: soo_toc / >. Этот тег может быть помещен только в любом месте и будет автоматически генерировать оглавление для любой статьи , он находит, так долго , как эта статья содержит HTML заголовки (h1, h2 и т.д.) с атрибутами Ид. Конечно , это требует контекст статьи, либо список или физическое лицо.
Это очень похоже на cbs_article_indexплагин . Тем не менее, предлагает вложенный список, фильтрацию заголовка уровня, и выбор относительного или абсолютного URL с. Если вам не нужны эти функции, вы можете предпочесть cbs_article_indexдля его более легкого следа.
Синтаксис
<ТхР: soo_toc />
Атрибуты
Первые пять являются стандартными Textpattern атрибутов; только последние две ( levelи full_url) являются плагин-специфичны.
label=«text»
Этикетка должна предшествовать список содержимого. Необязательный; по умолчанию не установлен.
labeltag=«tag name»
(X) HTML элемент (без скобок) для метки. Необязательный; по умолчанию не установлен.
break=«text»
(X) HTML элемент (без скобок) или текст для разделения элементов списка. Необязательный; по умолчанию li. Если изменить это, вы должны также изменить wraptag.
wraptag=«tag name»
(X) HTML элемент для ограждающих списка. Необязательный; по умолчанию ul. Если изменить это на что – то другое , чем ol, вы должны также изменить break.
class=«class name»
(X) HTML атрибут класса для применения к wraptag. Необязательный; по умолчанию toc.
level=«value»
Число в диапазоне 1-6, что указывает на самый высокий уровень заголовка , чтобы включить в таблицу содержимого (см Уровень, ниже ). Обязательный ; по умолчанию 6(включая все заголовки).
full_url=«boolean»
Если trueиспользовать абсолютное вместо относительного URL с. Дополнительно (но см Относительная против Абсолютный URL s , ниже); по умолчанию не установлен (ложь).
Применение
Генеральная
Может быть использован в теле статьи, на странице, или в форме. Если с относительными URL с (настройка по умолчанию) , что требует отдельного контекста статьи. При использовании в списке статей, или на странице , в котором baseэлемент обозначает ничего, кроме текущей страницы, то full_urlатрибут должен быть установлен true(или что – нибудь другое , чем 0). (См Относительная против Абсолютный URL – ы , ниже) .
В статье рубрики
Только заголовки , которые имеют idбудут включены атрибут. Это должно дать ссылки в оглавлении что – то , чтобы он указывал. В текстильной, вы можете применить idатрибут , как это:
пример
производить:
Пример
уровень
levelАтрибут позволяет ограничить , какие уровни заголовка включить в оглавлении. Например, level=«3«будет ограничивать выход в h1, h2и h3заголовки. Значение по умолчанию 6, показать все заголовки.
Вы можете использовать это, чтобы иметь как полное и краткое оглавление, один на боковой панели, а другой в теле статьи. Или в сочетании с небольшим количеством JavaScript, чтобы позволить пользователю, чтобы развернуть или свернуть оглавления.
Относительный против абсолютного URL s
Выход по умолчанию использует ту же страница относительного URL s (например href=»#id_name»), который будет работать правильно только в индивидуальном контексте статьи. Для того, чтобы получить абсолютный (полный) URL с вместо, установите full_urlатрибут true(или любое другое значение , чем 0).
Если вы используете baseтег , чтобы указать на корень сайта (или что – нибудь, кроме текущей страницы), вам также нужно использовать полный URL с. (NB, такое использование base, строго говоря, неверно.)
Уплотненный выход
Если wraptagэто ul(значение по умолчанию) или ol, если изделие имеет различные уровни заголовков, оглавление будет вложенный список. Например, учитывая следующие заголовки статей (показано в текстильной):