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

web: changed bitbucket references

Browse Source
This commit is contained in:
Jean-Francois Dockes 2017-07-01 07:56:47 +02:00
parent 144da4a5ca
commit e352292e1d
12 changed files with 75 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
website/devel.html
View File

@ -59,14 +59,13 @@
<h1><a name="development">Development</a></h1>
<p>The Recoll source repository is
on <a href="http://bitbucket.org/medoc/recoll">Bitbucket</a>. Using
Mercurial, you're 2 commands away from cloning it and
hacking away.</p>
<p>The Recoll source repository is on
<a href="https://opensourceprojects.eu/p/recoll1/code/">opensourceprojects.eu</a>.
Use git, to clone it and hack away.</p>
<p>Apart from the many tasks inside the
<a href="http://bitbucket.org/medoc/recoll/issues">issue
tracking system</a>, these are the general areas where help or
<p>Apart from possible tickets in the
<a href="https://opensourceprojects.eu/p/recoll1/tickets/">tracking
system</a>, these are the general areas where help or
ideas are particularly welcome:</p>
<ul>
<li>A better GUI design (both the ergonomy and the

19
website/download.html
View File

@ -112,8 +112,8 @@
<h2><a name="bugs">Known bugs</a></h2>
<p>There is a <a href="BUGS.html">history of known bugs</a>, sorted
by fix release. Also see
the <a href="https://bitbucket.org/medoc/recoll/issues">
issue tracker on Bitbucket</a>.
the <a href="https://opensourceprojects.eu/p/recoll1/tickets/new/">
Recoll issue tracker</a>.
</p>
</div>
@ -138,8 +138,8 @@
<p>I sometimes release a source tarfile when I consider that the
current development version is stable enough. The current
snapshot contains commits up to 2240 (see
<a href="https://bitbucket.org/medoc/recoll/changesets">the
changelog</a>, and a synthetic abstract in the
<a href="https://opensourceprojects.eu/p/recoll1/code/commit_browser">
the changelog</a>, and a synthetic abstract in the
current <a href="release-1.16.html">1.16 release notes</a>).
<p><a href="betarecoll-2240.tar.gz">betarecoll-2240.tar.gz</a>.</p>
-->
@ -208,8 +208,8 @@
<p>The <span class="application">Recoll</span> source
repository is hosted
on <a href="http://bitbucket.org/medoc/recoll/overview">
bitbucket.org</a>. The trunk is usually a bit on the
on <a href="https://opensourceprojects.eu/p/recoll1/code/">
opensourceprojects.eu</a>. The trunk is usually a bit on the
bleeding edge, but there is always a maintenance branch for
the current production version.</p>
@ -430,7 +430,7 @@ sudo apt-get install recoll
Recoll 1.22 message file, handy to work on a new translation. You can
also <a href="translations/">list the directory</a> to see all the
translation files (same as those in the maintenance source branch on
Bitbucket).</p>
opensourceprojects.eu).</p>
<h3>Updated 1.22 translations that became available after the
release:</h3>
@ -451,8 +451,9 @@ sudo apt-get install recoll
<p>Note that, if you are running an older release, you may find updated
messages by looking inside the appropriate maintenance
branch on
<a href="https://bitbucket.org/medoc/recoll/src">bitbucket</a>.</p>
branch in
<a href="https://opensourceprojects.eu/p/recoll1/code/">
the source repository</a>.</p>
</div> <!-- translations -->
</div> <!-- content -->

2
website/faqsandhowtos/IndexOnAc.txt
View File

@ -3,7 +3,7 @@
For people using real time indexing on a laptop, kind user "The Doctor"
contributed a script to automatically start and stop indexing according to
power status. The script can be found here:
link:https://bitbucket.org/medoc/recoll/src/tip/src/desktop/recoll_index_on_ac.sh[recoll_index_on_ac.sh]
link:https://opensourceprojects.eu/p/recoll1/code/ci/144da4a5caa2b39d23d9d7cf262f03b6d80a4739/tree/src/desktop/recoll_index_on_ac.sh[recoll_index_on_ac.sh]
To use it, you need to copy it somewhere (e.g.: '/usr/bin', but any place
will do), make it executable (`chmod a+x recoll_index_on_ac.sh`), and edit

5
website/faqsandhowtos/WhyIsMyFileNotIndexed.txt
View File

@ -58,8 +58,9 @@ In case of indexer misbehaviour (e.g. using too much memory, you should run
_tail -f_ on the log to see what is going on.
If this is not enough, please
link:http://bitbucket.org/medoc/recoll/issues/new[open a tracker issue] and
attach or link to the log data, or just email me (jfd at recoll.org).
link:https://opensourceprojects.eu/p/recoll1/tickets/new/[open a tracker
issue] and attach or link to the log data, or just email me (jfd at
recoll.org).
*recollindex* and *recollindex -i* usually have the same criteria to
include a file or not (but see the _Path gotcha_ note below). It may

2
website/filters/filters.html
View File

@ -66,7 +66,7 @@
<p>There is a slightly more detailed description of the filter
installation procedure on the
<a href="https://bitbucket.org/medoc/recoll/wiki/FilterRetrofit.wiki">
<a href="http://www.recoll.org/faqsandhowtos/FilterRetrofit.html">
Recoll Wiki</a>.</p>
<p>The following entries are in reverse chronologic order. Each

4
website/index.html.en
View File

@ -302,7 +302,7 @@
</dd>
<dt>2014-02-27</dt><dd>While working on a
<a href="https://bitbucket.org/medoc/recoll/wiki/MuttAndRecoll">
<a href="http://www.recoll.org/faqsandhowtos/MuttAndRecoll.html">
Recoll-Mutt interface</a> I discovered incidentally that
the <a href="https://github.com/koniu/recoll-webui">Recoll
Webui Web interface</a> works quite well with the
@ -354,7 +354,7 @@
<dt>2012-09-11</dt> <dd>A new user-contributed script for those who use
real-time indexing on laptops: stop or start indexing
according to AC power status. See the details on
the <a href="https://bitbucket.org/medoc/recoll/wiki/IndexOnAc.wiki">
the <a href="http://www.recoll.org/faqsandhowtos/IndexOnAc.html">
Wiki</a>. </dd>
<dt>2012-04-07</dt><dd>We now have a Chinese user manual:

2
website/index.html.fr
View File

@ -156,7 +156,7 @@
<dt>2010-11-20</dt><dd>Un petit script pour activer/cacher recoll sur un
bureau gnome d'un seul coup de clavier:
<a href="http://bitbucket.org/medoc/recoll/wiki/HotRecoll">
<a href="http://www.recoll.org/faqsandhowtos/HotRecoll.html">
recette d'installation</a>.</dd>
</ul>

2
website/pages/recoll-windows.txt
View File

@ -77,7 +77,7 @@ manual] !
== Support
Please use the
https://bitbucket.org/medoc/recoll/issues[BitBucket Recoll issues tracker]
https://opensourceprojects.eu/p/recoll1/tickets/new/[Recoll issues tracker]
for reporting problems, or contact me by email: jfd at recoll.org.

4
website/recoll_XMP/index.txt
View File

@ -26,7 +26,7 @@ publication.
Here, we describe customizing Recoll to retrieve this metadata, store it,
and defining a result paragraph format to display it. See also a related
wiki entry,
link:https://bitbucket.org/medoc/recoll/wiki/HandleCustomField.wiki[Generating
link:http://www.recoll.org/faqsandhowtos/HandleCustomField.html[Generating
a custom field and using it to sort results], for sorting results on PDF
page count.
@ -229,7 +229,7 @@ a:active {
----
There are
link:https://bitbucket.org/medoc/recoll/wiki/ResultsThumbnails[various
link:http://www.recoll.org/faqsandhowtos/ResultsThumbnails.html[various
methods for creating the thumbnails]; the ones here were made by opening
the directory containing the PDFs in the Dolphin file manager (part of KDE)
and selecting the Preview option.

49
website/recoll_XMP/original-text.html
View File

@ -6,9 +6,17 @@
<body>
<h2>Introduction</h2>
<p>Organizing and searching a large collection of PDFs as part of a research project can be a demanding task.
<a href="http://en.wikipedia.org/wiki/Extensible_Metadata_Platform">XMP metadata</a> stored in a PDF, such as journal title, publication year, and user-added keywords, are often useful when searching for a publication.
Here, we describe the use of a custom Recoll filter to retrieve this metadata, an indexing configuration to store it, and result paragraph format to display it. See also a related wiki entry, <a href="https://bitbucket.org/medoc/recoll/wiki/HandleCustomField.wiki">Generating a custom field and using it to sort results</a>, for sorting results on PDF page count.
<a href="http://en.wikipedia.org/wiki/Extensible_Metadata_Platform">XMP
metadata</a> stored in a PDF, such as journal title, publication year,
and user-added keywords, are often useful when searching for a
publication. Here, we describe the use of a custom Recoll filter to
retrieve this metadata, an indexing configuration to store it, and
result paragraph format to display it. See also a related wiki
entry, <a href="http://www.recoll.org/faqsandhowtos/HandleCustomField.html">
Generating a custom field and using it to sort results</a>, for
sorting results on PDF page count. </p>
<h2>Saving metadata to PDFs</h2>
<p>Bibliographic metadata can be saved in the PDF file itself. In the <a href="http://jabref.sourceforge.net">JabRef</a> bibliography manager, this is done with the "Write XMP-metadata to PDFs" menu item. Note the presence of the keywords in the screenshot below; this field is a good place to tag the PDF with any words of your choosing to describe genre, topic, etc.
@ -110,16 +118,43 @@ application/pdf = exec /home/&lt;username>/.recoll/filters/rclpdf
&lt;/table>&lt;font color="#900000">%K&lt;/font>
&lt;br>&lt;br>
</pre>
The screenshot below also has the "Highlight color for query terms" set to <tt>black; font-weight:bold;</tt> for bold, black text (instead of the blue default). There are <a href="https://bitbucket.org/medoc/recoll/wiki/ResultsThumbnails">various methods for creating the thumbnails</a>; the ones here were made by opening the directory containing the PDFs in the Dolphin file manager (part of KDE) and selecting the Preview option.
The screenshot below also has the "Highlight color for query terms"
set to <tt>black; font-weight:bold;</tt> for bold, black text (instead
of the blue default). There
are <a href="http://www.recoll.org/faqsandhowtos/ResultsThumbnails.html">
various methods for creating the thumbnails</a>; the ones here were
made by opening the directory containing the PDFs in the Dolphin file manager
(part of KDE) and selecting the Preview option.
<h2>A search example</h2>
<p>The simple query is <tt>cerevisiae keyword:protein</tt>. This returns only PDFs that have the text "cerevisiae" and have been tagged with the "protein" keyword. The LaTeX-style formatting from the BibTeX database is displayed as HTML (note the italicized words in article title, and umlaut in author's name). Other queries could be made based on the PDF metadata, e.g. <tt>journal:plos</tt> or <tt>year:2013</tt> .
<p><img src="recoll_query.png">
<p>The simple query is <tt>cerevisiae keyword:protein</tt>. This
returns only PDFs that have the text "cerevisiae" and have been tagged
with the "protein" keyword. The LaTeX-style formatting from the BibTeX
database is displayed as HTML (note the italicized words in article
title, and umlaut in author's name). Other queries could be made based
on the PDF metadata, e.g. <tt>journal:plos</tt> or <tt>year:2013</tt>.</p>
<p><img src="recoll_query.png"></p>
<h2>More possibilities</h2>
<ul>
<li>The sort buttons (up- and down-arrows) in Recoll sort the results by the modified date on the file at the time of indexing. If you want this sorting to reflect the publication year, then the timestamp should be set accordingly. If names of the PDFs contain the year (e.g. BZS2007.pdf, CKE+2011.pdf), the following one-liner would set the modified date to January 1st of the year: <tt>for i in `ls *.pdf`; do touch -d `echo $i | sed 's/[^0-9]*//g'`-01-01 $i; done</tt> . Note that the publication year could then be shown in the result list using the stored date of the file (using "%D" in the result paragraph format, and date format "%Y") instead of having to add the year to the index as shown above.
<li>The filter can be modified to fill in the "journal" field for BibTex entries that aren't journal articles (e.g. bibtex:booktitle for "InCollection" entries).
<li>The sort buttons (up- and down-arrows) in Recoll sort the
results by the modified date on the file at the time of indexing. If
you want this sorting to reflect the publication year, then the
timestamp should be set accordingly. If names of the PDFs contain
the year (e.g. BZS2007.pdf, CKE+2011.pdf), the following one-liner
would set the modified date to January 1st of the year: <tt>for i in
`ls *.pdf`; do touch -d `echo $i | sed 's/[^0-9]*//g'`-01-01 $i;
done</tt> . Note that the publication year could then be shown in
the result list using the stored date of the file (using "%D" in the
result paragraph format, and date format "%Y") instead of having to
add the year to the index as shown above.
<li>The filter can be modified to fill in the "journal" field for
BibTex entries that aren't journal articles (e.g. bibtex:booktitle
for "InCollection" entries).
</ul>
</body>

4
website/release-1.19.html
View File

@ -232,15 +232,17 @@ Configuration</em> menu.</p>
<pre> localfields = ; attr1 = val1 ; attr2 = val2
</pre>
</li>
<li>Extended file attributes are now indexed by default. As a side effect,
recoll now uses st_ctime, not st_mtime to detect file changes. This means
that installing 1.19 will reindex many files (all those that were modified
since created). Recoll also now processes the <tt>charset</tt> and
<tt>mime_type</tt> standardized extended attributes.</li>
<li>The Python module has been expanded to include the interface for
extracting data. This means that you could now write most of the Recoll GUI
in Python if you wished. There is a <a
href="https://bitbucket.org/medoc/recoll/src/5b4bd9ef26a1/src/python/samples/recollgui/qrecoll.py?at=default">bit
href="https://opensourceprojects.eu/p/recoll1/code/ci/144da4a5caa2b39d23d9d7cf262f03b6d80a4739/tree/src/python/samples/recollgui/qrecoll.py">bit
of sample code</a> in the source package doing just this. A few
incompatible changes had to be made to the Python module. Especially the
"Query.next" field is gone and the module structure has been changed

5
website/support.html.en
View File

@ -41,8 +41,9 @@
improvement, <em>please</em> provide feedback. There are three
possible channels, depending on your preferences:
<ul>
<li>The <a href="http://bitbucket.org/medoc/recoll/issues">
issues tracking system</a> on Bitbucket.</li>
<li>The
<a href="https://opensourceprojects.eu/p/recoll1/tickets/new/">
Recoll issues tracking system</a>.</li>
<li>The <a href="http://www.freelists.org/list/recoll-user">
recoll-user</a> mailing list.</li>
<li>Direct <a href="mailto:jfd@recoll.org">email</a>.</li>