Расширение:Включение именованных разделов

From MediaWiki.org
Jump to navigation Jump to search
This page is a translated version of the page Extension:Labeled Section Transclusion and the translation is 87% complete.

Outdated translations are marked like this.
Other languages:
Deutsch • ‎English • ‎Lëtzebuergesch • ‎català • ‎dansk • ‎español • ‎français • ‎hrvatski • ‎italiano • ‎magyar • ‎polski • ‎português • ‎português do Brasil • ‎sicilianu • ‎suomi • ‎Ελληνικά • ‎български • ‎русский • ‎українська • ‎العربية • ‎فارسی • ‎मराठी • ‎हिन्दी • ‎বাংলা • ‎中文 • ‎日本語
Справка по расширениям MediaWiki
Crystal Clear action run.svg
Labeled Section Transclusion
Статус релиза: стабильный
Реализация Tag, Parser function
Описание Разрешает включение (трансклюдинг) маркированных фрагментов текста.
Автор(ы) Steve Sanbeg
Последняя версия continuous updates
MediaWiki 1.25+
PHP 5.4+
Изменения БД Нет
Лицензия GNU General Public License 2.0 or later
Загрузка
Переведите расширение Labeled Section Transclusion если оно доступно на translatewiki.net
Проверьте использование и версию.
Проблемы Открытые задачи · Сообщить об ошибке

Это расширение позволяет выборочно включать отмеченные фрагменты текста. Возможности данного тега подобны расширенной версии тега <onlyinclude> с обычным включением в вики, позволяющим выбирать включаемые секции. Расширение включено во всех проектах Фонда Викимедиа.

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

Однако, есть определённые различия. В обычном включении шаблонов, фрагменты в зависимости от предполагаемого поведения, таким образом возможно включить или пропустить лишь один (возможно, несмежный) фрагмент.

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

Создание именованных разделов вместо разметки в зависимости от поведения позволяет ссылкам редактирования разделов быть представленными более подходящим образом для получения выдержек из больших текстов, поскольку расширение теперь может учитывать разделы, пропущенные в начале страницы, позволяя включённым разделам быть смещённым нужным образом.

Как это работает

Шаг 1: пометьте разделы

Отметьте разделы текста, используя теги <section> следующим образом:

<section begin=chapter1 /><translate>this is a chapter</translate><section end=chapter1 />

Обратите внимание, что эти теги не HTML/XML, а не использовать обычный синтаксис атрибута; скорее, весь текст между $section и в конце > или /> - это метка.

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

Шаг 2а: Включите раздел

Вызовите функцию парсера #lst для включения раздела; например, включите раздел под названием chapter1 со страницы, названной articleX:

 {{#lst:articleX|chapter1}}

Целевая статья определяет расположение раздела; его поведение определяется функцией парсера.

Шаг 2б: Включите страницу, но исключите раздел

Для того, чтобы включить страницу, но исключить определённый раздел, используйте функцию #lstx:

{{#lstx:articleX|chapter1}}

Опционально можно добавить замещающий текст для исключённого раздела.

{{#lstx:articleX|chapter1|replacement_text}}

Пример:

{{#lstx:articleX|chapter1|See chapter 1 in [[articleX]].}}

Текст замещения появится на месте пропущенного (исключённого) раздела.

Другие функции

Несмежные разделы

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

Диапазоны разделов

Эти функции имеют дополнительный, опциональный аргумент для указания диапазона разделов. Например, {{#lst:articleX|chapter1|chapter3}} , для включения всего текста от начала первой главы до конца третьей главы. Это позволяет использовать пустые пары маркеров для пометки одного конца секции, возможно в шаблоне. Похожий механизм используется во французской Викитеке.

Подстановка

Всё это также работает и с подстановкой. Даже возможно, чтобы статья подставила свой собственный раздел. Одно из использований этого обеспечивает аккуратный способ архивировать страницы обсуждения: отметьте текст, который следует заархивировать, используя <section begin=archive /> и т.д. Далее, создайте страницу архива с текстом, используя {{subst:#lst:talk_page|archive}}, которая скопирует заархивированные разделы. И напоследок, замените содержимое страницы обсуждения с {{subst:#lstx:talk_page|archive}} для удаления этих разделов.

Включение разделов по их заголовкам

Существует опциональная поддержка включения разделов, помеченных обычными заголовками, такими как ==this section==. Если установлена, то это осуществляется при помощи функции lsth.

Включение вводного раздела

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

{{#lsth:pagename}}

Включение конкретного раздела

Вы также можете включить всё содержимое sectionX (что включает все его подразделы, за исключением заголовка самого раздела sectionX).

{{#lsth:pagename|sectionX}}

На заметку:

  1. Если у вас есть более одного раздела с одинаковым названием sectionX, включается только самый первый раздел с таким названием.
  2. Убедитесь, что вы вводите заголовок sectionX таким, какой он есть в вики-коде, а не таким, как он отображается. Например, если заголовок раздела — ==List of [[Extension]]==, то вы должны ввести «List of [[Extension]]», а не «List of Extension».
  3. Соответствие является регистронезависимым, для предотвращения поломки ссылок из-за изменения регистра.

Включение нескольких разделов

Вы также можете включать от первого появления sectionX (исключая заголовок самой sectionX) до тех пор, пока не достигается следующее появление sectionY. Заметьте, что sectionY играет роль точки остановки, поэтому включение не содержит текста sectionY.

{{#lsth:pagename|sectionX|sectionY}}

Замечания относительно пропущенных заголовков

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

Когда используется это расширение (с MediaWiki 1.9 или более поздним), функции #lst и #lsth считают разделы в «пропущенной» начальной части и смещают включённые разделы должным образом. Это позволяет этой ссылке указывать на корректные разделы в простых случаях.

Заметьте, что #lstx не считает пропущенные заголовки, и пропущенные заголовки в пределах несмежных секций не смещаются. Но похоже, что это теперь было исправлено (вероятно при переходе на новый препроцессор MediaWiki). Включённые заголовки могут быть связаны с правильными разделами..

Локализация

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

функция английский немецкий иврит (RTL) португальский
#lst #section #Abschnitt
#קטע
#trecho
#lstx #section-x #Abschnitt-x
#בלי קטע
#trecho-x
#lsth #section-h

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

английский
<section begin=x/> ... <section end=x/>
немецкий
<Abschnitt Anfang=x/> ... <Abschnitt Ende=x/>
иврит (RTL)
<קטע התחלה=א> ... <קטע סוף=א> (код «начала» справа, код «конца» слева.)
португальский
<trecho começo=x/> ... <trecho fim=x/>

Ограничения

  • В то время, как можно использовать расширение в различных пространствах имён, интервики-ссылки не разрешаются. Пока не представляется возможным, например, включить часть страницы Википедии в удалённую установку MediaWiki.
  • Теги разделов не могут быть включены сами по себе для того, чтобы работать на других страницах. Это означает, например, что эти теги не могут быть включены в шаблоны, использующие параметры шаблонов и функции парсера. Волшебное слово #tag не работает с тегами разделов. #tag приводит к парным тегам, в то время, как теги разделов является одинарными. См. задача T39256.
  • По состоянию на 2014 год, теги разделов не действуют, когда используются в параметрах шаблонов. Если страница A содержит текст {{B|X}}, у {{#lst:A|...}} нет доступа к X.

Скачивание

Расширение можно получить непосредственно из Git [?]:

  • Просмотреть код
  • Некоторые расширения имеют теги для стабильных выпусков.
  • Каждая ветвь связана с прошлым выпуском MediaWiki. Существует также ветвь "master", содержащая последнюю альфа-версию (может потребоваться альфа-версия MediaWiki).

Извлеките snapshot и поместите его в каталог extensions/LabeledSectionTransclusion/ вашей MediaWiki.

Если вы знакомы с git и имеете доступ к оболочке на своём сервере, тогда Вы можете получить расширение следующим образом:

cd extensions/
git clone https://gerrit.wikimedia.org/r/p/mediawiki/extensions/LabeledSectionTransclusion.git

Установка

  • Скачайте и распакуйте файл(ы) в папку с названием LabeledSectionTransclusion в вашу папку extensions/.
  • Добавьте следующий код в файл LocalSettings.php (в самый конец):
    wfLoadExtension( 'LabeledSectionTransclusion' );
    
  • Yes Готово – Перейдите на страницу «Special:Version» на своём сайте, чтобы удостовериться в том, что расширение успешно установлено.

Для использующих MediaWiki 1.27 или более ранние:

В приведенных выше инструкциях описывается новый способ установки этого расширения с использованием wfLoadExtension() Если вам нужно установить это расширение на более ранние версии (MediaWiki 1.27 и более ранние), вместо wfLoadExtension( 'LabeledSectionTransclusion' );, Вам необходимо использовать:

require_once "$IP/extensions/LabeledSectionTransclusion/LabeledSectionTransclusion.php";

There is also a Gadget in use on various Wikisources that makes it possible to define sections with a simplified ## label ## syntax. Its code can be found at Wikisource:MediaWiki:Gadget-Easy_LST.js.

Примеры

См. также