diff --git a/src/doc/user/usermanual.sgml b/src/doc/user/usermanual.sgml index da1f6153..e184cb13 100644 --- a/src/doc/user/usermanual.sgml +++ b/src/doc/user/usermanual.sgml @@ -3410,45 +3410,45 @@ skippedPaths = ~/somedir/∗.txt Adding an external viewer for an non-indexed type - Imagine that you have some kind of file which does not - have indexable content, but for which you would like to have a - functional Edit link in the result list - (when found by file name). The file names end in - .blob and can be displayed by - application blobviewer. + Imagine that you have some kind of file which does not + have indexable content, but for which you would like to have a + functional Edit link in the result list + (when found by file name). The file names end in + .blob and can be displayed by + application blobviewer. You need two entries in the configuration files for this - to work: - - In $RECOLL_CONFDIR/mimemap - (typically ~/.recoll/mimemap), add the - following line: - - application/x-blobapp = .blob - - Note that the mime type is made up here, and you could - call it diesel/oil just the - same. - - In - $RECOLL_CONFDIR/mimeview under the - [view] section: - - application/x-blobapp = blobviewer %f - + to work: - We are supposing that - blobviewer wants a file name - parameter here, you would use %u if + + In $RECOLL_CONFDIR/mimemap + (typically ~/.recoll/mimemap), add the + following line: +.blob = application/x-blobapp + + Note that the mime type is made up here, and you could + call it diesel/oil just the + same. + + In $RECOLL_CONFDIR/mimeview + under the [view] section, add: + +application/x-blobapp = blobviewer %f + + We are supposing + that blobviewer wants a file + name parameter here, you would use %u if it liked URLs better. If you just wanted to change the application used by - &RCL; to display a mime type which it already knows, you - would just need to edit mimeview. The - entries you add in your personal file override those in the - central configuration, which you do not need to alter + &RCL; to display a mime type which it already knows, you + would just need to edit mimeview. The + entries you add in your personal file override those in the + central configuration, which you do not need to + alter. mimeview can also be modified + from the Gui. @@ -3456,48 +3456,43 @@ skippedPaths = ~/somedir/∗.txt Adding indexing support for a new file type Let us now imagine that the above - .blob files actually contain - indexable text and that you know how to extract it with a - command line program. Getting &RCL; to index the files is - easy. You need to perform the above alteration, and also to - add data to the mimeconf file - (typically in ~/.recoll/mimeconf): - + .blob files actually contain + indexable text and that you know how to extract it with a + command line program. Getting &RCL; to index the files is + easy. You need to perform the above alteration, and also to + add data to the mimeconf file + (typically in ~/.recoll/mimeconf): Under the [index] - section, add the following line (more about the - rclblob indexing script later): - - application/x-blobapp = exec rclblob - - + section, add the following line (more about the + rclblob indexing script + later): +application/x-blobapp = exec rclblob + - Under the [icons] - section, you should choose an icon to be displayed for the - files inside the result lists. Icons are normally 64x64 - pixels PNG files which live in - /usr/[local/]share/recoll/images. - + section, you should choose an icon to be displayed for the + files inside the result lists. Icons are normally 64x64 + pixels PNG files which live in + /usr/[local/]share/recoll/images. - Under the [categories] - section, you should add the mime type where it makes sense - (you can also create a category). Categories may be used - for filtering in advanced search. + section, you should add the mime type where it makes sense + (you can also create a category). Categories may be used + for filtering in advanced search. - The rclblob filter should - be an executable program or script which exists inside - /usr/[local/]share/recoll/filters. It - will be given a file name as argument and should output the - text contents on the standard output. + be an executable program or script which exists inside + /usr/[local/]share/recoll/filters. It + will be given a file name as argument and should output the + text or html contents on the standard output. The filter - programming section describes in more detail how to - write a filter. + programming section describes in more detail how + to write a filter. +