From b6e450129f706329296682e5af9dc65c399edddf Mon Sep 17 00:00:00 2001 From: Jean-Francois Dockes Date: Sat, 13 Apr 2019 09:47:11 +0200 Subject: [PATCH] doc --- {src/doc/user/sphinx => docs}/index.rst | 15 ++++------ src/doc/user/Makefile | 8 +++-- src/doc/user/usermanual.html | 39 ++++++++++++------------- src/doc/user/usermanual.xml | 14 ++++----- 4 files changed, 35 insertions(+), 41 deletions(-) rename {src/doc/user/sphinx => docs}/index.rst (99%) diff --git a/src/doc/user/sphinx/index.rst b/docs/index.rst similarity index 99% rename from src/doc/user/sphinx/index.rst rename to docs/index.rst index 0c520ad4..0218288e 100644 --- a/src/doc/user/sphinx/index.rst +++ b/docs/index.rst @@ -31,23 +31,20 @@ Giving it a try If you do not like reading manuals (who does?) but wish to give RCL a try, just `install <#RCL.INSTALL.BINARY>`__ the application and start the ``recoll`` graphical user interface (GUI), which will ask permission -to index your home directory by default, allowing you to search -immediately after indexing completes. +to index your home directory, allowing you to search immediately after +indexing completes. Do not do this if your home directory contains a huge number of documents and you do not want to wait or are very short on disk space. In this case, you may first want to customize the `configuration <#RCL.INDEXING.CONFIG>`__ to restrict the indexed area -(for the very impatient with a completed package install, from the -``recoll`` GUI: Preferences > Indexing configuration, then adjust the -Top directories section). +(shortcut: from the ``recoll`` GUI go to: Preferences > Indexing +configuration, then adjust the Top directories section). On Unix/Linux, you may need to install the appropriate `supporting applications <#RCL.INSTALL.EXTERNAL>`__ for document types that need -them (for example antiword for Microsoft Word files). - -The RCL for WIN package is self-contained and includes most useful -auxiliary programs. You will just need to install Python 2.7. +them (for example antiword for Microsoft Word files). The RCL for WIN +package is self-contained and includes most useful auxiliary programs. Full text search ---------------- diff --git a/src/doc/user/Makefile b/src/doc/user/Makefile index 33eae7ef..851ff69d 100644 --- a/src/doc/user/Makefile +++ b/src/doc/user/Makefile @@ -59,11 +59,13 @@ usermanual-rst: recoll-conf-xml sed -e '/xi:include/r rcl-conf-tail.xml' \ < usermanual.xml > full-man.xml sed -i -e '/xi:include/d' -e '//d' full-man.xml - test -d sphinx || mkdir sphinx - pandoc -s --toc -f docbook -t rst full-man.xml > sphinx/index.rst + pandoc -s --toc -f docbook -t rst full-man.xml > \ + ../../../docs/index.rst + rm -f rcl-conf-tail.xml full-man.xml -@echo fix termmatch and execute #(cd sphinx;make html) clean: - rm -f RCL.*.html usermanual.pdf usermanual.html index.html tmpfile.html + rm -f RCL.*.html usermanual.pdf usermanual.html index.html \ + tmpfile.html rcl-conf-tail.xml full-man.xml diff --git a/src/doc/user/usermanual.html b/src/doc/user/usermanual.html index 557f5dd1..779023e7 100644 --- a/src/doc/user/usermanual.html +++ b/src/doc/user/usermanual.html @@ -92,11 +92,11 @@ alink="#0000FF"> "#RCL.INDEXING.INTRODUCTION.CONFIG">Configurations, multiple indexes
2.1.3. Document types
+ "#idm227">Document types
2.1.4. Indexing failures
+ "#idm268">Indexing failures
2.1.5. Recovery
+ "#idm280">Recovery
2.2. application and start the recoll graphical user interface (GUI), which will ask permission to index your - home directory by default, allowing you to search - immediately after indexing completes.

+ home directory, allowing you to search immediately after + indexing completes.

Do not do this if your home directory contains a huge number of documents and you do not want to wait or are very short on disk space. In this case, you may first want to customize the configuration to - restrict the indexed area (for the very impatient with a - completed package install, from the recoll GUI: Preferences → recoll GUI go to: + Preferences → Indexing configuration, then adjust the Top directories section).

@@ -501,12 +500,10 @@ alink="#0000FF"> "6.2. Supporting packages">supporting applications for document types that need them (for example antiword for Microsoft Word files).

-

The Recoll for - Windows package is - self-contained and includes most useful auxiliary programs. - You will just need to install Python 2.7.

+ "application">Microsoft Word files). The + Recoll for Windows package is self-contained and + includes most useful auxiliary programs.

@@ -961,8 +958,8 @@ alink="#0000FF">
-

2.1.3. Document types

+

2.1.3. Document types

@@ -1059,8 +1056,8 @@ alink="#0000FF">
-

2.1.4. Indexing failures

+

2.1.4. Indexing failures

@@ -1095,8 +1092,8 @@ alink="#0000FF">
-

2.1.5. Recovery

+

2.1.5. Recovery

diff --git a/src/doc/user/usermanual.xml b/src/doc/user/usermanual.xml index 19a55939..1d91a245 100644 --- a/src/doc/user/usermanual.xml +++ b/src/doc/user/usermanual.xml @@ -74,15 +74,15 @@ install the application and start the recoll graphical user interface (GUI), which will ask permission to index your home - directory by default, allowing you to search immediately after + directory, allowing you to search immediately after indexing completes. Do not do this if your home directory contains a huge number of documents and you do not want to wait or are very short on disk space. In this case, you may first want to customize the configuration - to restrict the indexed area (for the very impatient with a - completed package install, from the recoll GUI: + to restrict the indexed area (shortcut: from the + recoll GUI go to: Preferences Indexing configuration @@ -94,11 +94,9 @@ supporting applications for document types that need them (for example antiword for - Microsoft Word files). - - The &RCL; for &WIN; package is self-contained and includes - most useful auxiliary programs. You will just need to install - Python 2.7. + Microsoft Word files). + The &RCL; for &WIN; package is self-contained and includes + most useful auxiliary programs.