From f8e556fceea75436d1a84e807d4e153be7cbea9c Mon Sep 17 00:00:00 2001
From: Jean-Francois Dockes
Date: Fri, 7 Jan 2022 11:52:06 +0100
Subject: [PATCH] Documentation for %l
---
src/doc/user/usermanual.html | 27 +++++++++++++++++-------
src/doc/user/usermanual.xml | 41 ++++++++++++++++++++++--------------
2 files changed, 44 insertions(+), 24 deletions(-)
diff --git a/src/doc/user/usermanual.html b/src/doc/user/usermanual.html
index c538dfa8..e679932c 100644
--- a/src/doc/user/usermanual.html
+++ b/src/doc/user/usermanual.html
@@ -10758,17 +10758,28 @@ other = rclcat:other
%p. Page index. Only significant for
a subset of document types, currently only PDF,
- Postscript and DVI files. Can be used to start the
- editor at the right page for a match or
- snippet.
+ Postscript and DVI files. If it is set, a
+ significant term will be chosen in the query, and
+ %p will be substituted with the first page where
+ the term appears. Can be used to start the editor
+ at the right page for a match or snippet.
+
+
+ %l. Line number. Only significant
+ for document types with relevant line breaks,
+ mostly text/plain and analogs. If it is set, a
+ significant term will be chosen in the query, and
+ %p will be substituted with the first line where
+ the term appears.
%s. Search term. The value will only
- be set for documents with indexed page numbers (ie:
- PDF). The value will be one of the matched search
- terms. It would allow pre-setting the value in the
- "Find" entry inside Evince for example, for easy
- highlighting of the term.
+ be set for documents with indexed page or line
+ numbers and if %p or %l is also used. The value
+ will be one of the matched search terms. It would
+ allow pre-setting the value in the "Find" entry
+ inside Evince for example, for easy highlighting of
+ the term.
%u. Url.
diff --git a/src/doc/user/usermanual.xml b/src/doc/user/usermanual.xml
index 168a7a4c..cc2e81f7 100644
--- a/src/doc/user/usermanual.xml
+++ b/src/doc/user/usermanual.xml
@@ -5,7 +5,7 @@
Recoll">
http://www.recoll.org/pages/features.html">
-
+
Xapian">
Windows">
Unix-like systems">
@@ -7114,28 +7114,37 @@ other = rclcat:other
(possibly a script) to be able to handle it.
- %M
- MIME type
+
+ %MMIME type
- %p
- Page index. Only significant for a subset of document
- types, currently only PDF, Postscript and DVI files. Can be
- used to start the editor at the right page for a match or
- snippet.
+
+ %pPage index. Only significant for a subset of
+ document types, currently only PDF, Postscript and DVI files. If it is set, a
+ significant term will be chosen in the query, and %p will be substituted with the
+ first page where the term appears. Can be used to start the editor at the right page
+ for a match or snippet.
- %s
- Search term. The value will only be set for documents
- with indexed page numbers (ie: PDF). The value will be one of
- the matched search terms. It would allow pre-setting the
- value in the "Find" entry inside Evince for example, for easy
- highlighting of the term.
+
+ %lLine number. Only significant for document
+ types with relevant line breaks, mostly text/plain and analogs. If it is set, a
+ significant term will be chosen in the query, and %p will be substituted with the
+ first line where the term appears.
- %u
- Url.
+
+ %sSearch term. The value will only be set for
+ documents with indexed page or line numbers and if %p or %l is also used. The value
+ will be one of the matched search terms. It would allow pre-setting the value in the
+ "Find" entry inside Evince for example, for easy highlighting of the
+ term.
+
+
+ %uUrl.
+
+
In addition to the predefined values above, all strings like