From c334059f303055f600cdf604d8fd2ba6556eedab Mon Sep 17 00:00:00 2001 From: Jean-Francois Dockes Date: Fri, 29 Jan 2016 20:09:57 +0100 Subject: [PATCH] doc --- src/doc/user/Makefile | 5 +- src/doc/user/usermanual.html | 59 +++++++++++-------- src/doc/user/usermanual.xml | 36 ++++++----- .../webhelp/docs/RCL.INDEXING.CONFIG.GUI.html | 2 +- .../docs/RCL.INDEXING.CONFIG.MULTIPLE.html | 2 +- .../docs/RCL.INDEXING.CONFIG.SENS.html | 2 +- .../webhelp/docs/RCL.INDEXING.CONFIG.html | 2 +- .../webhelp/docs/RCL.INDEXING.EXTATTR.html | 2 +- .../webhelp/docs/RCL.INDEXING.EXTTAGS.html | 2 +- .../RCL.INDEXING.INTRODUCTION.CONFIG.html | 2 +- .../docs/RCL.INDEXING.INTRODUCTION.MODES.html | 2 +- .../docs/RCL.INDEXING.INTRODUCTION.html | 2 +- .../docs/RCL.INDEXING.MONITOR.FASTFILES.html | 2 +- .../webhelp/docs/RCL.INDEXING.MONITOR.html | 2 +- .../docs/RCL.INDEXING.PERIODIC.AUTOMAT.html | 2 +- .../docs/RCL.INDEXING.PERIODIC.EXEC.html | 2 +- .../webhelp/docs/RCL.INDEXING.PERIODIC.html | 2 +- .../docs/RCL.INDEXING.STORAGE.FORMAT.html | 2 +- .../docs/RCL.INDEXING.STORAGE.SECURITY.html | 2 +- .../webhelp/docs/RCL.INDEXING.STORAGE.html | 2 +- .../webhelp/docs/RCL.INDEXING.WEBQUEUE.html | 2 +- src/doc/user/webhelp/docs/RCL.INDEXING.html | 2 +- .../user/webhelp/docs/RCL.INSTALL.BINARY.html | 2 +- .../RCL.INSTALL.BUILDING.BUILD.SOLARIS.html | 2 +- .../docs/RCL.INSTALL.BUILDING.BUILD.html | 2 +- .../docs/RCL.INSTALL.BUILDING.INSTALL.html | 2 +- .../docs/RCL.INSTALL.BUILDING.PREREQS.html | 2 +- .../webhelp/docs/RCL.INSTALL.BUILDING.html | 2 +- .../docs/RCL.INSTALL.CONFIG.ENVIR.html | 2 +- .../RCL.INSTALL.CONFIG.EXAMPLES.ADDINDEX.html | 2 +- .../RCL.INSTALL.CONFIG.EXAMPLES.ADDVIEW.html | 2 +- .../docs/RCL.INSTALL.CONFIG.EXAMPLES.html | 2 +- .../docs/RCL.INSTALL.CONFIG.FIELDS.XATTR.html | 2 +- .../docs/RCL.INSTALL.CONFIG.FIELDS.html | 2 +- .../docs/RCL.INSTALL.CONFIG.MIMECONF.html | 2 +- .../docs/RCL.INSTALL.CONFIG.MIMEMAP.html | 2 +- .../docs/RCL.INSTALL.CONFIG.MIMEVIEW.html | 2 +- .../docs/RCL.INSTALL.CONFIG.PTRANS.html | 2 +- .../RCL.INSTALL.CONFIG.RECOLLCONF.FILES.html | 2 +- ....INSTALL.CONFIG.RECOLLCONF.IDXTHREADS.html | 2 +- .../RCL.INSTALL.CONFIG.RECOLLCONF.MISC.html | 2 +- ...RCL.INSTALL.CONFIG.RECOLLCONF.STORAGE.html | 2 +- .../RCL.INSTALL.CONFIG.RECOLLCONF.TERMS.html | 2 +- .../docs/RCL.INSTALL.CONFIG.RECOLLCONF.html | 2 +- .../user/webhelp/docs/RCL.INSTALL.CONFIG.html | 2 +- .../webhelp/docs/RCL.INSTALL.EXTERNAL.html | 2 +- src/doc/user/webhelp/docs/RCL.INSTALL.html | 2 +- .../webhelp/docs/RCL.INTRODUCTION.RECOLL.html | 2 +- .../webhelp/docs/RCL.INTRODUCTION.SEARCH.html | 2 +- .../webhelp/docs/RCL.INTRODUCTION.TRYIT.html | 2 +- .../user/webhelp/docs/RCL.INTRODUCTION.html | 2 +- .../user/webhelp/docs/RCL.KICKER-APPLET.html | 2 +- .../docs/RCL.PROGRAM.API.ELEMENTS.html | 2 +- .../webhelp/docs/RCL.PROGRAM.API.PYTHON.html | 2 +- .../user/webhelp/docs/RCL.PROGRAM.API.html | 2 +- .../user/webhelp/docs/RCL.PROGRAM.FIELDS.html | 2 +- .../docs/RCL.PROGRAM.FILTERS.ASSOCIATION.html | 2 +- .../docs/RCL.PROGRAM.FILTERS.HTML.html | 2 +- .../docs/RCL.PROGRAM.FILTERS.MULTIPLE.html | 2 +- .../docs/RCL.PROGRAM.FILTERS.PAGES.html | 2 +- .../docs/RCL.PROGRAM.FILTERS.SIMPLE.html | 2 +- .../webhelp/docs/RCL.PROGRAM.FILTERS.html | 2 +- .../docs/RCL.PROGRAM.PYTHON.COMPAT.html | 2 +- .../docs/RCL.PROGRAM.PYTHON.EXAMPLES.html | 2 +- .../docs/RCL.PROGRAM.PYTHON.INTRO.html | 2 +- .../docs/RCL.PROGRAM.PYTHON.PACKAGE.html | 2 +- .../docs/RCL.PROGRAM.PYTHON.RCLEXTRACT.html | 2 +- .../docs/RCL.PROGRAM.PYTHON.RECOLL.html | 2 +- src/doc/user/webhelp/docs/RCL.PROGRAM.html | 2 +- .../user/webhelp/docs/RCL.SEARCH.ANCHOR.html | 2 +- .../webhelp/docs/RCL.SEARCH.ANCHORWILD.html | 2 +- .../webhelp/docs/RCL.SEARCH.CASEDIAC.html | 2 +- .../webhelp/docs/RCL.SEARCH.COMMANDLINE.html | 2 +- .../user/webhelp/docs/RCL.SEARCH.DESKTOP.html | 2 +- .../docs/RCL.SEARCH.GUI.COMPLEX.FILTER.html | 2 +- .../docs/RCL.SEARCH.GUI.COMPLEX.HISTORY.html | 2 +- .../docs/RCL.SEARCH.GUI.COMPLEX.TERMS.html | 2 +- .../webhelp/docs/RCL.SEARCH.GUI.COMPLEX.html | 2 +- .../docs/RCL.SEARCH.GUI.CUSTOM.RESLIST.html | 2 +- .../webhelp/docs/RCL.SEARCH.GUI.CUSTOM.html | 2 +- .../webhelp/docs/RCL.SEARCH.GUI.FRAGBUTS.html | 2 +- .../webhelp/docs/RCL.SEARCH.GUI.HISTORY.html | 2 +- .../webhelp/docs/RCL.SEARCH.GUI.MULTIDB.html | 2 +- .../docs/RCL.SEARCH.GUI.PREVIEW.SEARCH.html | 2 +- .../webhelp/docs/RCL.SEARCH.GUI.PREVIEW.html | 2 +- .../docs/RCL.SEARCH.GUI.RESLIST.SUGGS.html | 2 +- .../webhelp/docs/RCL.SEARCH.GUI.RESLIST.html | 2 +- .../webhelp/docs/RCL.SEARCH.GUI.RESTABLE.html | 2 +- .../docs/RCL.SEARCH.GUI.RESULTLIST.MENU.html | 2 +- .../docs/RCL.SEARCH.GUI.RUNSCRIPT.html | 2 +- .../webhelp/docs/RCL.SEARCH.GUI.SIMPLE.html | 2 +- .../webhelp/docs/RCL.SEARCH.GUI.SORT.html | 2 +- .../docs/RCL.SEARCH.GUI.TERMEXPLORER.html | 2 +- .../docs/RCL.SEARCH.GUI.THUMBNAILS.html | 2 +- .../docs/RCL.SEARCH.GUI.TIPS.MISC.html | 2 +- .../docs/RCL.SEARCH.GUI.TIPS.PHRASES.html | 2 +- .../docs/RCL.SEARCH.GUI.TIPS.TERMS.html | 2 +- .../webhelp/docs/RCL.SEARCH.GUI.TIPS.html | 2 +- src/doc/user/webhelp/docs/RCL.SEARCH.GUI.html | 2 +- .../webhelp/docs/RCL.SEARCH.KIO.INTRO.html | 2 +- .../docs/RCL.SEARCH.KIO.SEARCHABLEDOCS.html | 2 +- src/doc/user/webhelp/docs/RCL.SEARCH.KIO.html | 2 +- .../docs/RCL.SEARCH.LANG.MODIFIERS.html | 2 +- .../user/webhelp/docs/RCL.SEARCH.LANG.html | 34 ++++++----- .../user/webhelp/docs/RCL.SEARCH.PTRANS.html | 2 +- .../user/webhelp/docs/RCL.SEARCH.SAVING.html | 2 +- .../webhelp/docs/RCL.SEARCH.SHORTCUT.html | 2 +- .../webhelp/docs/RCL.SEARCH.SYNONYMS.html | 2 +- .../docs/RCL.SEARCH.WILDCARDS.PATH.html | 2 +- .../webhelp/docs/RCL.SEARCH.WILDCARDS.html | 2 +- src/doc/user/webhelp/docs/RCL.SEARCH.html | 2 +- src/doc/user/webhelp/docs/ch02s01s03.html | 4 +- src/doc/user/webhelp/docs/ch02s01s04.html | 4 +- src/doc/user/webhelp/docs/ch02s01s05.html | 4 +- src/doc/user/webhelp/docs/index.html | 4 +- website/BUGS.html | 8 +++ website/download.html | 6 +- website/index.html.en | 10 +++- website/index.html.fr | 11 +++- website/pages/recoll-windows.txt | 13 +++- website/release-1.21.html | 6 ++ 121 files changed, 240 insertions(+), 178 deletions(-) diff --git a/src/doc/user/Makefile b/src/doc/user/Makefile index 1262690b..4d1e51e6 100644 --- a/src/doc/user/Makefile +++ b/src/doc/user/Makefile @@ -19,8 +19,11 @@ commonoptions=--stringparam section.autolabel 1 \ # index.html chunk format target replaced by nicer webhelp (needs separate # make) in webhelp/ subdir -all: usermanual.html usermanual.pdf +all: usermanual.html usermanual.pdf webh +webh: + make -C webhelp + usermanual.html: usermanual.xml xsltproc ${commonoptions} \ -o tmpfile.html "${XSLDIR}/html/docbook.xsl" $< diff --git a/src/doc/user/usermanual.html b/src/doc/user/usermanual.html index ae4bbbe8..35c55cbf 100644 --- a/src/doc/user/usermanual.html +++ b/src/doc/user/usermanual.html @@ -20,8 +20,8 @@ alink="#0000FF">
-

Recoll user manual

+

Recoll user manual

@@ -109,13 +109,13 @@ alink="#0000FF"> multiple indexes
2.1.3. Document types
+ "#idp51664016">Document types
2.1.4. Indexing failures
+ "#idp51683696">Indexing failures
2.1.5. Recovery
+ "#idp51690704">Recovery @@ -962,8 +962,8 @@ alink="#0000FF">
-

2.1.3. Document types

+

2.1.3. Document types

@@ -1056,8 +1056,8 @@ indexedmimetypes = application/pdf
-

2.1.4. Indexing +

2.1.4. Indexing failures

@@ -1097,8 +1097,8 @@ indexedmimetypes = application/pdf
-

2.1.5. Recovery

+

2.1.5. Recovery

@@ -4661,8 +4661,8 @@ bye goodbye "see you" \ broadly has the same capabilities as the complex search interface in the GUI.

-

The language is based on the (seemingly defunct) - The language was based on the now defunct Xesam user search language specification.

@@ -4727,9 +4727,9 @@ bye goodbye "see you" \ "literal">OR word3.

-

With Recoll versions - 1.21 and later, you can use parentheses to group elements, - which will sometimes make things clearer, and may allow +

Recoll versions 1.21 + and later, allow using parentheses to group elements, which + will sometimes make things clearer, and may allow expressing combinations which would have been difficult otherwise.

@@ -4858,6 +4858,12 @@ author:john/ringo "5.4.3. The fields file">section about the fields file

+

The document input handlers used while indexing have the + possibility to create other fields with arbitrary names, + and aliases may be defined in the configuration, so that + the exact field search possibilities may be different for + you if someone took care of the customisation.

+

The field syntax also supports a few field-like, but special, criteria:

@@ -5038,19 +5044,26 @@ dir:recoll dir:src -dir:utils -dir:common "margin-left: 0.5in; margin-right: 0.5in;">

Note

-

mime is the mime, rclcat, size and date criteria always affect the whole + query (they are applied as a final filter), even if set + with other terms inside a parenthese.

+
+ +
+

Note

+ +

mime (or the equivalent + rclcat) is the only field with an OR default. You do need to use OR with ext terms for example.

-

The document input handlers used while indexing have the - possibility to create other fields with arbitrary names, - and aliases may be defined in the configuration, so that - the exact field search possibilities may be different for - you if someone took care of the customisation.

-
diff --git a/src/doc/user/usermanual.xml b/src/doc/user/usermanual.xml index 8621940a..aa52a186 100644 --- a/src/doc/user/usermanual.xml +++ b/src/doc/user/usermanual.xml @@ -3129,7 +3129,7 @@ bye goodbye "see you" \ capabilities as the complex search interface in the GUI. - The language is based on the (seemingly defunct) + The language was based on the now defunct Xesam user search language specification. @@ -3187,7 +3187,7 @@ bye goodbye "see you" \ word2) OR word3. - With &RCL; versions 1.21 and later, you can use parentheses to + &RCL; versions 1.21 and later, allow using parentheses to group elements, which will sometimes make things clearer, and may allow expressing combinations which would have been difficult otherwise. @@ -3284,8 +3284,14 @@ bye goodbye "see you" \ linkend="RCL.INSTALL.CONFIG.FIELDS">section about the fields file + The document input handlers used while indexing have the + possibility to create other fields with arbitrary names, and + aliases may be defined in the configuration, so that the exact + field search possibilities may be different for you if someone + took care of the customisation. + The field syntax also supports a few field-like, but - special, criteria: + special, criteria: @@ -3315,7 +3321,7 @@ dir:recoll dir:src -dir:utils -dir:common path (in any order), and which have not either utils or common. - + You can also use OR conjunctions with dir: clauses. @@ -3409,17 +3415,19 @@ dir:recoll dir:src -dir:utils -dir:common - - mime is the only field with an - OR default. You do need to use - OR with ext terms for - example. + + mime, rclcat, + size and date criteria + always affect the whole query (they are applied as a final + filter), even if set with other terms inside a parenthese. + - The document input handlers used while indexing have the - possibility to create other fields with arbitrary names, and - aliases may be defined in the configuration, so that the exact - field search possibilities may be different for you if someone - took care of the customisation. + + mime (or the equivalent + rclcat) is the only + field with an OR default. You do need to use + OR with ext terms for + example. Modifiers diff --git a/src/doc/user/webhelp/docs/RCL.INDEXING.CONFIG.GUI.html b/src/doc/user/webhelp/docs/RCL.INDEXING.CONFIG.GUI.html index c1723801..539517a9 100644 --- a/src/doc/user/webhelp/docs/RCL.INDEXING.CONFIG.GUI.html +++ b/src/doc/user/webhelp/docs/RCL.INDEXING.CONFIG.GUI.html @@ -4,7 +4,7 @@ The index configuration GUI - - Recoll user manual
Prev Up Next
 HomeÂ