Модуль:Stringconvert/doc

Материал из свободной русской энциклопедии «Традиция»
Перейти к навигации Перейти к поиску

Это страница документации Модуль:Stringconvert.

Модуль предназначен для форматирования строки в ссылки. Этот модуль используется в шаблоне {{aslinks}}.

Описание функций и параметров

  • aslinks — функция форматирования строки в ссылки.
    Принимает шесть параметров, которые могут иметь значения:
    1. text= — исходная строка (обязательный)
    2. delimiter= — строка из разделителей (необязательный, по умолчанию = ", " — разделять слова запятой или пробелом)
    3. nospace= — без пробела (yes или no).
    4. hide= — слово, которые нужно удалить из текста (удаляются также ссылки на слово).
    5. nocomment — без комментариев в круглых скобках (yes или no).
    6. lang= — буквенный код языка (ru, en, fr и т.п.).
  • strip_macrons — функция удаляет макроны, знаки ударения и заменяет слоговые знаки на обычные
    Принимает один неименованный параметр — исходную строку для обработки.

Технические детали

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

Для удаления слова или словосочетания из строки можно использовать параметр hide=. Следующие за словом пробелы и запятая тоже удаляются. Например:

С помощью второго параметра, можно переопределить разделители по умолчанию. Пробел в разделители добавлять не нужно, он добавляется по умолчанию. Например:

  • {{#invoke:stringconvert|aslinks|choix {{m}}; sélection {{f}}|,;}}choix м.; sélection ж.

Если нужно подавить добавление пробела используйте параметр nospace=1. Например:

Используйте в разделителе escape последовательность  , если нужно разделять строки только пробелом. Например сравните:

Чтобы учесть все разделители и знаки препинания используйте строку %s%p:

Внешние и внутренние сылки, HTML теги, круглые, угловые скобки, одинарные парные кавычки, пайп, амперсант и одиночные знаки пунктуации — пропускаются. Например:

  • {{#invoke:stringconvert|aslinks|мн.: люди, грабли}}мн.: люди, грабли
  • {{#invoke:stringconvert|aslinks|''мн.'': люди, грабли}}мн.: люди, грабли
  • {{#invoke:stringconvert|aslinks|<i>мн.</i>: люди, грабли}}мн.: люди, грабли
  • {{#invoke:stringconvert|aslinks|{{мн}} люди, грабли}}Шаблон:Мн люди, грабли
  • {{#invoke:stringconvert|aslinks|''частичн.'': добро, счастье, удача}}частичн.: добро, счастье, удача
  • {{#invoke:stringconvert|aslinks|grablje {{f}} {{мн.}}}}grablje ж. Мн.
  • {{#invoke:stringconvert|aslinks|{{incorrect|ми́нутый}}}}*ми́нутый
  • {{#invoke:stringconvert|aslinks|{{пример|текст в примере}}}}Ошибка скрипта: Модуля «Example» не существует.

Для формирование ссылки на языковый раздел используйте параметр lang

  • {{#invoke:stringconvert|aslinks|prōcēssus|lang=la}}prōcēssus
  • {{#invoke:stringconvert|aslinks|processus|lang=fr}}processus