tris/recoll
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

doc

Browse Source
This commit is contained in:
Jean-Francois Dockes 2019-04-13 09:47:11 +02:00
parent 0a18e8f4e6
commit b6e450129f
4 changed files with 35 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
src/doc/user/sphinx/index.rst → docs/index.rst
View File

@ -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
----------------

8
src/doc/user/Makefile
View File

@ -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 '/<?xml version="1.0"?>/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

39
src/doc/user/usermanual.html
View File

@ -92,11 +92,11 @@ alink="#0000FF">
"#RCL.INDEXING.INTRODUCTION.CONFIG">Configurations,
multiple indexes</a></span></dt>
<dt><span class="sect2">2.1.3. <a href=
"#idm229">Document types</a></span></dt>
"#idm227">Document types</a></span></dt>
<dt><span class="sect2">2.1.4. <a href=
"#idm270">Indexing failures</a></span></dt>
"#idm268">Indexing failures</a></span></dt>
<dt><span class="sect2">2.1.5. <a href=
"#idm282">Recovery</a></span></dt>
"#idm280">Recovery</a></span></dt>
</dl>
</dd>
<dt><span class="sect1">2.2. <a href=
@ -482,17 +482,16 @@ alink="#0000FF">
application and start the <span class=
"command"><strong>recoll</strong></span> graphical user
interface (GUI), which will ask permission to index your
home directory by default, allowing you to search
immediately after indexing completes.</p>
home directory, allowing you to search immediately after
indexing completes.</p>
<p>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 <a class="link" href="#RCL.INDEXING.CONFIG"
title="2.3.&nbsp;Index configuration">configuration</a> to
restrict the indexed area (for the very impatient with a
completed package install, from the <span class=
"command"><strong>recoll</strong></span> GUI: <span class=
"guimenu">Preferences</span> → <span class=
restrict the indexed area (shortcut: from the <span class=
"command"><strong>recoll</strong></span> GUI go to:
<span class="guimenu">Preferences</span> → <span class=
"guimenuitem">Indexing configuration</span>, then adjust
the <span class="guilabel">Top directories</span>
section).</p>
@ -501,12 +500,10 @@ alink="#0000FF">
"6.2.&nbsp;Supporting packages">supporting applications</a>
for document types that need them (for example <span class=
"application">antiword</span> for <span class=
"application">Microsoft Word</span> files).</p>
<p>The <span class="application">Recoll</span> for
<span class="application">Windows</span> package is
self-contained and includes most useful auxiliary programs.
You will just need to install <span class=
"application">Python</span> 2.7.</p>
"application">Microsoft Word</span> files). The
<span class="application">Recoll</span> for <span class=
"application">Windows</span> package is self-contained and
includes most useful auxiliary programs.</p>
</div>
<div class="sect1">
<div class="titlepage">
@ -961,8 +958,8 @@ alink="#0000FF">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a name="idm229" id=
"idm229"></a>2.1.3.&nbsp;Document types</h3>
<h3 class="title"><a name="idm227" id=
"idm227"></a>2.1.3.&nbsp;Document types</h3>
</div>
</div>
</div>
@ -1059,8 +1056,8 @@ alink="#0000FF">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a name="idm270" id=
"idm270"></a>2.1.4.&nbsp;Indexing failures</h3>
<h3 class="title"><a name="idm268" id=
"idm268"></a>2.1.4.&nbsp;Indexing failures</h3>
</div>
</div>
</div>
@ -1095,8 +1092,8 @@ alink="#0000FF">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a name="idm282" id=
"idm282"></a>2.1.5.&nbsp;Recovery</h3>
<h3 class="title"><a name="idm280" id=
"idm280"></a>2.1.5.&nbsp;Recovery</h3>
</div>
</div>
</div>

14
src/doc/user/usermanual.xml
View File

@ -74,15 +74,15 @@
<link linkend="RCL.INSTALL.BINARY">install</link> the application
and start the <command>recoll</command> 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.</para>
<para>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 <link linkend="RCL.INDEXING.CONFIG">configuration</link>
to restrict the indexed area (for the very impatient with a
completed package install, from the <command>recoll</command> GUI:
to restrict the indexed area (shortcut: from the
<command>recoll</command> GUI go to:
<menuchoice>
<guimenu>Preferences</guimenu>
<guimenuitem>Indexing configuration</guimenuitem>
@ -94,11 +94,9 @@
<link linkend="RCL.INSTALL.EXTERNAL">supporting applications</link>
for document types that need them (for
example <application>antiword</application> for
<application>Microsoft Word</application> files).</para>
<para>The &RCL; for &WIN; package is self-contained and includes
most useful auxiliary programs. You will just need to install
<application>Python</application> 2.7.</para>
<application>Microsoft Word</application> files).
The &RCL; for &WIN; package is self-contained and includes
most useful auxiliary programs.</para>
</sect1>