toline

Назначение

Приводит аргумент к строке, где он был найден

Синтаксис

toline($группа)

Аргументы

Функция принимает один обязательный аргумент — ссылку на именованную группу.

Функция также принимает следующие опциональные именованные параметры:

Параметр

Пояснение

match:=range/arguments

Если аргумент разрывный и находится в нескольких разнесенных предложениях, то в результат идут только эти предложения. При указании именованного параметра match:=range в результат пойдет диапазон от первого фрагмента текста до последнего.

first:=<numeral>

При отсутствии аргументов параметр трактуется как диапазон значений. При наличии аргументов параметр задает смещение начального аргумента.

last:=<numeral>

При отсутствии аргументов параметр трактуется как диапазон значений. При наличии аргументов параметр задает смещение конечного аргумента.

separator:=<string>

Для разделения найденных аргументов можно указать пользовательский разделитель. По умолчанию разделитель равен переносу строки ("\n").

Примечания

  • Параметры first и last можно использовать автономно, без указания именованной группы.

  • При использовании параметров first и last в случае разрывного аргумента (или при отсутствии аргументов) повторяющиеся элементы, которые находит поисковый запрос, не удаляются. То есть сначала выводится диапазон от first до last для первого результата, затем для второго и т.д. Так сделано для удобства анализа результатов.

Возвращаемое значение

Текстовое значение.

Примеры

toline(first:=1, last:=3) приводит результат к трем первым строкам документа.

toline($m, first:=-1, last:=1) приводит именованную группу $m к строке до и строке после нее.

toline($m, first:=-1, last:=1, match:=range) приводит именованную группу $m к строке до и строке после нее в диапазоне от первого фрагмента текста до последнего.