From 6b4e7430c3afb2cc0ab2189d4c4156b03ed88157 Mon Sep 17 00:00:00 2001 From: Jean-Francois Dockes Date: Sat, 29 Dec 2012 14:54:57 +0100 Subject: [PATCH] Use xml toolchain by default --- src/doc/user/{Makefile => Makefile.fbsd} | 0 src/doc/user/usermanual.sgml | 339 ++++++++++++----------- src/doc/user/xmlmake.sh | 6 +- 3 files changed, 174 insertions(+), 171 deletions(-) rename src/doc/user/{Makefile => Makefile.fbsd} (100%) diff --git a/src/doc/user/Makefile b/src/doc/user/Makefile.fbsd similarity index 100% rename from src/doc/user/Makefile rename to src/doc/user/Makefile.fbsd diff --git a/src/doc/user/usermanual.sgml b/src/doc/user/usermanual.sgml index 795dd0c3..891ba56d 100644 --- a/src/doc/user/usermanual.sgml +++ b/src/doc/user/usermanual.sgml @@ -43,15 +43,15 @@ - + Introduction - + Giving it a try If you do not like reading manuals (who does?) and would like to give &RCL; a try, just install the application and + linkend="RCL.INSTALL.BINARY">install the application and start the recoll graphical user interface (GUI), which will ask to index your home directory by default, allowing you to search immediately after indexing completes. @@ -59,17 +59,17 @@ 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 + the configuration to restrict the indexed area. Also be aware that you may need to install the - appropriate supporting + appropriate supporting applications for document types that need them (for example antiword for Microsoft Word files). - + Full text search &RCL; is a full text search application. Full text search @@ -111,7 +111,7 @@ - + Recoll overview &RCL; uses the @@ -186,7 +186,7 @@ &RCL; has many parameters which define exactly what to index, and how to classify and decode the source documents. These are kept in configuration files. A + linkend="RCL.INDEXING.CONFIG">configuration files. A default configuration is copied into a standard location (usually something like /usr/[local/]share/recoll/examples) @@ -203,21 +203,21 @@ the recoll GUI are stored in the standard location defined by Qt. - The indexing + The indexing process is started automatically the first time you execute the recoll GUI. Indexing can also be performed by executing the recollindex command. - Searches are usually + Searches are usually performed inside the recoll GUI, which has many options to help you find what you are looking for. However, there are other ways to perform &RCL; searches: mostly a + linkend="RCL.SEARCH.COMMANDLINE"> command line interface, a - + Python - programming interface, a + programming interface, a KDE KIO slave module, and a Ubuntu Unity Lens module. @@ -226,10 +226,10 @@ - + Indexing - + Introduction Indexing is the process by which the set of documents is @@ -245,25 +245,25 @@ aspects of the indexing processes and configuration, with links to detailed sections. - + Indexing modes &RCL; indexing can be performed along two different modes: - <link linkend="rcl.indexing.periodic"> + <title><link linkend="RCL.INDEXING.PERIODIC"> Periodic (or batch) indexing:</link> indexing takes place at discrete times, by executing the recollindex command. The typical usage is to have a nightly indexing run - + programmed into your cron file. - <link linkend="rcl.indexing.monitor">Real + <formalpara><title><link linkend="RCL.INDEXING.MONITOR">Real time indexing:</link> indexing takes place as soon as a file is created or changed. recollindex runs as a daemon @@ -292,12 +292,12 @@ - + Configurations, multiple indexes The parameters describing what is to be indexed and local preferences are defined in text files contained in a - configuration + configuration directory. All parameters have defaults, defined in system-wide @@ -329,7 +329,7 @@ For index generation, multiple configurations are totally independant from each other. When multiple indexes need to be used for a single search, - some parameters + some parameters should be consistent among the configurations. @@ -339,7 +339,7 @@ &RCL; knows about quite a few different document types. The parameters for document types recognition and processing are set in - configuration files. + configuration files. Most file types, like HTML or word processing files, only hold one document. Some file types, like email folders or zip @@ -355,7 +355,7 @@ Other file types (ie: postscript, pdf, ms-word, rtf ...) need external applications for preprocessing. The list is in the - installation + installation section. After every indexing operation, &RCL; updates a list of commands that would be needed for indexing existing files types. This list can be displayed by selecting the menu option @@ -375,7 +375,7 @@ signal itself by weird search results or crashes), the index files need to be erased before restarting a clean indexing pass. Just delete the xapiandb directory (see - next section), or, + next section), or, alternatively, start the next recollindex with the option, which will reset the database before indexing. @@ -383,7 +383,7 @@ - + Index storage The default location for the index data is the @@ -410,7 +410,7 @@ recoll ~/.indexes-email/xapiandb/. Using multiple configuration directories and configuration + linkend="RCL.INSTALL.CONFIG.RECOLLCONF">configuration options allows you to tailor multiple configurations and indexes to handle whatever subset of the available data you wish to make searchable. @@ -421,7 +421,7 @@ recoll specify a non-default storage location for the index by setting the dbdir parameter in the configuration file (see the configuration + linkend="RCL.INSTALL.CONFIG.RECOLLCONF">configuration section). This method would mainly be of use if you wanted to keep the configuration directory in its default location, but desired another location for the index, typically out of disk @@ -451,7 +451,7 @@ recoll (as long as the original documents exist), and it can always be destroyed safely. - + &XAP; index formats &XAP; versions usually support several formats for index @@ -474,7 +474,7 @@ recoll - + Security aspects The &RCL; index does not hold copies of the indexed @@ -498,15 +498,15 @@ recoll - + Index configuration Variables set inside the - &RCL; configuration files + &RCL; configuration files control which areas of the file system are indexed, and how files are processed. These variables can be set either by editing the text files or by using the - dialogs in the + dialogs in the recoll GUI. The first time you start recoll, you @@ -519,7 +519,7 @@ recoll empty configuration files, which you can edit by hand. The configuration is documented inside the - installation chapter + installation chapter of this document, or in the recoll.conf @@ -529,13 +529,13 @@ recoll current information will most likely be the comments inside the sample file. The most immediately useful variable you may interested in is probably - + topdirs, which determines what subtrees get indexed. The applications needed to index file types other than text, HTML or email (ie: pdf, postscript, ms-word...) are - described in the external + described in the external packages section. As of Recoll 1.18 there are two incompatible types of Recoll @@ -543,7 +543,7 @@ recoll diacritics. The next section describes the two types in more detail. - + Multiple indexes Multiple &RCL; indexes can be created by @@ -589,13 +589,13 @@ recoll have the same option concerning character case and diacritics stripping, but there are other constraints. Most of the relevant parameters are described in the - linked + linked section. - + Index case and diacritics sensitivity As of &RCL; version 1.18 you have a choice of building an @@ -616,7 +616,7 @@ recoll between terms, returning different results when searching for US and us or resume and résumé. - Read the section about search + Read the section about search case and diacritics sensitivity for more details. The type of index to be created is controlled by the @@ -639,7 +639,7 @@ recoll - + The index configuration GUI Most parameters for a given index configuration can @@ -677,7 +677,7 @@ recoll The meaning for most entries in the interface is self-evident and documented by a ToolTip popup on the text label. For more detail, you will need to - refer to the configuration + refer to the configuration section of this guide. The configuration tool normally respects the comments @@ -689,7 +689,7 @@ recoll - + Index WEB visited page history With the help of a Firefox @@ -723,10 +723,10 @@ recoll - + Periodic indexing - + Running indexing Indexing is always performed by the @@ -806,7 +806,7 @@ recoll file list. - + Using <command>cron</command> to automate indexing @@ -853,7 +853,7 @@ recoll - + Real time indexing Real time monitoring/indexing is performed by starting the @@ -915,7 +915,7 @@ fvwm When building &RCL;, the real time indexing support can be customised during package configuration with + linkend="RCL.INSTALL.BUILDING.BUILD">configuration with the or options. The default is currently to include inotify @@ -931,7 +931,7 @@ fvwm your system is short on resources. Periodic indexing is adequate in most cases. - + Slowing down the reindexing rate for fast changing files @@ -942,7 +942,7 @@ fvwm &RCL; provides a configuration option to specify the minimum time before which a file, specified by a wildcard pattern, cannot be reindexed. See the mondelaypatterns parameter in - the + the configuration section. @@ -950,10 +950,10 @@ fvwm - + Searching - + Searching with the Qt graphical user interface The recoll program provides the main user @@ -987,7 +987,7 @@ fvwm case (they would typically be printed without white space). - + Simple search @@ -1015,13 +1015,13 @@ fvwm where at least one of the terms appear. The Query Language features are - described in a separate + described in a separate section. All search modes allow wildcards inside terms (*, ?, []). You may want to have a look at the - section about wildcards + section about wildcards for more information about this. File name will specifically look for file @@ -1063,7 +1063,7 @@ fvwm Floor will only look for floor, in any character case. Stemming can also be disabled globally in the preferences. When using a raw index, the rules are a bit more + linkend="RCL.SEARCH.CASEDIAC">the rules are a bit more complicated. &RCL; remembers the last few searches that you @@ -1088,7 +1088,7 @@ fvwm this mode from the Query Language mode, where you have to care about the syntax. - You can use the + You can use the Tools Advanced search @@ -1097,7 +1097,7 @@ fvwm - + The default result list After starting a search, a list of results will instantly @@ -1142,7 +1142,7 @@ fvwm the functionality and use the standard desktop tool. You may also change the choice of applications by editing the - + mimeview configuration file if you find this more convenient. @@ -1151,15 +1151,15 @@ fvwm &RCL; has no configured way to preview a given file type (which was indexed by name only), or no configured external editor for the file type. This can sometimes be adjusted simply by tweaking - the + the mimemap and - + mimeview configuration files (the latter can be modified with the user preferences dialog). The format of the result list entries is entirely configurable by using the preference dialog to - edit an HTML + edit an HTML fragment. You can click on the Query details link @@ -1174,7 +1174,7 @@ fvwm toolbar or the links at the bottom of the page to browse the results. - + No results: the spelling suggestions When a search yields no result, and if the @@ -1189,7 +1189,7 @@ fvwm - + The result list right-click menu Apart from the preview and edit links, you can display a @@ -1258,7 +1258,7 @@ fvwm - + The result table In &RCL; 1.15 and newer, the results can be displayed in @@ -1292,7 +1292,7 @@ fvwm - + Displaying thumbnails The default format for the result list entries and the @@ -1317,7 +1317,7 @@ fvwm - + The preview window The preview window opens when you first click a @@ -1362,7 +1362,7 @@ fvwm P) in the window text. - + Searching inside the preview The preview window has an internal search capability, @@ -1416,7 +1416,7 @@ fvwm - + Complex/advanced search The advanced search dialog helps you build more complex queries @@ -1448,7 +1448,7 @@ fvwm Click on the Show query details link at the top of the result page to see the query expansion. - + Avanced search: the "find" tab This part of the dialog lets you constructc a query by @@ -1505,7 +1505,7 @@ fvwm - + Avanced search: the "filter" tab This part of the dialog has several sections which allow @@ -1559,7 +1559,7 @@ fvwm - + Avanced search history The advanced search tool memorizes the last 100 searches @@ -1577,7 +1577,7 @@ fvwm - + The term explorer tool &RCL; automatically manages the expansion of search terms @@ -1599,7 +1599,7 @@ fvwm xapi* would display all index terms beginning with xapi. (More about wildcards here). + linkend="RCL.SEARCH.WILDCARDS">here). @@ -1656,10 +1656,10 @@ fvwm - + Multiple indexes - See the section + See the section describing the use of multiple indexes for generalities. Only the aspects concerning the recoll GUI are described here. @@ -1713,7 +1713,7 @@ fvwm - + Document history Documents that you actually view (with the internal preview @@ -1728,7 +1728,7 @@ fvwm - + Sorting search results and collapsing duplicates The documents in a result list are normally sorted in @@ -1758,10 +1758,10 @@ fvwm - + Search tips, shortcuts - + Terms and search expansion Term completion @@ -1780,7 +1780,7 @@ fvwm Wildcards Wildcards can be used inside search terms in all forms - of searches. + of searches. More about wildcards. @@ -1826,7 +1826,7 @@ fvwm - + Working with phrases and proximity Phrases and Proximity searches @@ -1874,11 +1874,11 @@ fvwm - + Others Using fields - You can use the query + You can use the query language and field specifications to only search certain parts of documents. This can be especially helpful with email, for example only searching @@ -1949,7 +1949,7 @@ fvwm - + Customizing the search interface You can customize some aspects of the search interface by using @@ -1961,7 +1961,7 @@ fvwm returning results, and what indexes are searched. - + User interface parameters: @@ -2067,7 +2067,7 @@ fvwm - + Result list parameters: @@ -2083,18 +2083,18 @@ fvwm config (try the qtconfig command). - + Edit result list paragraph format string: allows you to change the presentation of each result list - entry. See the + entry. See the result list customisation section. - + Edit result page HTML header insert: allows you to define text inserted at the end of the result page HTML header. - More detail in the + More detail in the result list customisation section. @@ -2104,7 +2104,7 @@ fvwm should be specified as an strftime() string (man strftime). - + Abstract snippet separator: for synthetic abstracts built from index data, which are usually made of several snippets from different parts of the @@ -2115,7 +2115,7 @@ fvwm - + Search parameters: @@ -2129,7 +2129,7 @@ fvwm stemming obviously depends on the document's language. This listbox will let you chose among the stemming databases which were built during indexing (this is set in the main configuration + linkend="RCL.INSTALL.CONFIG.RECOLLCONF">main configuration file), or later added with recollindex -s (See the recollindex manual). Stemming languages which are dynamically added will be deleted at the next @@ -2186,7 +2186,7 @@ fvwm - + External indexes: This panel will let you browse for additional indexes that you may want to search. External indexes are designated by @@ -2207,7 +2207,7 @@ fvwm need to implement a way of purging the index from stale data, - + The result list format The result list presentation can be exhaustively customized @@ -2236,7 +2236,7 @@ fvwm page about customising the result list on the &RCL; web site. - + The paragraph format This is an arbitrary HTML string where the following printf-like @@ -2251,7 +2251,7 @@ fvwm %IIcon image name. This is normally determined from the mime type. The associations are defined inside the - + mimeconf configuration file. If a thumbnail for the file is found at the standard Freedesktop location, this will be displayed @@ -2298,7 +2298,7 @@ fvwm the field named fieldname for this document. Only stored fields can be accessed in this way, the value of indexed but not stored fields is not known at this point in the - search process (see field + search process (see field configuration). There are currently very few fields stored by default, apart from the values above (only author and filename), so this @@ -2342,7 +2342,7 @@ fvwm site, with pictures to show how they look. It is also possible to - + define the value of the snippet separator inside the abstract section. @@ -2351,10 +2351,10 @@ fvwm - + Searching with the KDE KIO slave - + What's this The &RCL; KIO slave allows performing a &RCL; search @@ -2389,7 +2389,7 @@ fvwm - + Searchable documents As a sample application, the &RCL; KIO slave could allow @@ -2419,7 +2419,7 @@ fvwm - + Searching on the command line There are several ways to obtain search results as a text @@ -2432,7 +2432,7 @@ fvwm By writing a custom Python program, using the - Recoll Python API. + Recoll Python API. @@ -2497,7 +2497,7 @@ text/html [file:///Users/uncrypted-dockes/projets/bateaux/ilur/factEtCie/r - + The query language The query language processor is activated in the GUI @@ -2576,7 +2576,7 @@ text/html [file:///Users/uncrypted-dockes/projets/bateaux/ilur/factEtCie/r Modifiers can be set on a phrase clause, for example to specify a proximity search (unordered). See - the modifier + the modifier section. &RCL; currently manages the following default fields: @@ -2742,7 +2742,7 @@ dir:recoll dir:src -dir:utils -dir:common Specifying a wild-card on the left of a term can produce a very slow search (or even an incorrect one if the expansion is truncated because of excessive size). Also see - + More about wildcards. The document filters used while indexing have the @@ -2751,7 +2751,7 @@ dir:recoll dir:src -dir:utils -dir:common field search possibilities may be different for you if someone took care of the customisation. - + Modifiers Some characters are recognized as search modifiers when found @@ -2796,7 +2796,7 @@ dir:recoll dir:src -dir:utils -dir:common - + Search case and diacritics sensitivity For &RCL; versions 1.18 and later, and when working @@ -2867,7 +2867,7 @@ dir:recoll dir:src -dir:utils -dir:common - + Anchored searches and wildcards Some special characters are interpreted by &RCL; in search @@ -2876,7 +2876,7 @@ dir:recoll dir:src -dir:utils -dir:common succeed only if the match is found at or near the beginning of the document or one of its fields. - + More about wildcards All words entered in &RCL; search fields will be processed @@ -2917,7 +2917,7 @@ dir:recoll dir:src -dir:utils -dir:common Using a * at the end of a word can produce more matches than you would think, and strange search results. You can use the term explorer tool to + linkend="RCL.SEARCH.GUI.TERMEXPLORER">term explorer tool to check what completions exist for a given term. You can also see exactly what search was performed by clicking on the link at the top of the result list. In general, for natural @@ -2929,7 +2929,7 @@ dir:recoll dir:src -dir:utils -dir:common - + Anchored searches Two characters are used to specify that a search hit should @@ -2965,7 +2965,7 @@ dir:recoll dir:src -dir:utils -dir:common - + Desktop integration Being independant of the desktop type has its drawbacks: &RCL; @@ -2974,7 +2974,7 @@ dir:recoll dir:src -dir:utils -dir:common The KDE KIO Slave was - described in a previous + described in a previous section. @@ -2989,10 +2989,11 @@ dir:recoll dir:src -dir:utils -dir:common Krunner plugin. + Here follow a few other things that may help. - + Hotkeying recoll It is surprisingly convenient to be able to show or hide the @@ -3004,7 +3005,7 @@ dir:recoll dir:src -dir:utils -dir:common - + The KDE Kicker Recoll applet This is probably obsolete now. Anyway: @@ -3037,7 +3038,7 @@ dir:recoll dir:src -dir:utils -dir:common - + Programming interface &RCL; has an Application Programming Interface, usable both @@ -3052,7 +3053,7 @@ dir:recoll dir:src -dir:utils -dir:common - + Writing a document filter &RCL; filters cooperate to translate from the multitude @@ -3119,7 +3120,7 @@ dir:recoll dir:src -dir:utils -dir:common format can return an arbitrary amount of metadata inside HTML meta tags. These will be processed according to the directives found in - the + the fields configuration file. @@ -3138,7 +3139,7 @@ dir:recoll dir:src -dir:utils -dir:common manual. This will not be the case for the other ones, for which you will have to look at the code. - + Simple filters &RCL; simple filters are usually shell-scripts, but this is in @@ -3157,7 +3158,7 @@ dir:recoll dir:src -dir:utils -dir:common to add metadata or vary the output character encoding (this will be defined in a configuration file). Additionally, some formatting may be easier to preserve when previewing HTML. Actually the deciding factor - is metadata: &RCL; has a way to + is metadata: &RCL; has a way to extract metadata from the HTML header and use it for field searches.. @@ -3177,7 +3178,7 @@ dir:recoll dir:src -dir:utils -dir:common - + "Multiple" filters If you can program and want to write @@ -3221,8 +3222,9 @@ dir:recoll dir:src -dir:utils -dir:common none (typical for an archive file). If it is empty, this document will be useful anyway for some operations, as the parent of the actual data documents. + - + Telling &RCL; about the filter There are two elements that link a file to the filter which @@ -3231,7 +3233,7 @@ dir:recoll dir:src -dir:utils -dir:common The association of files to mime types is mostly based on name suffixes. The types are defined inside the - + mimemap file. Example: @@ -3242,7 +3244,7 @@ dir:recoll dir:src -dir:utils -dir:common mime type. The association of file types to filters is performed in - the + the mimeconf file. A sample will probably be of better help than a long explanation: @@ -3291,7 +3293,7 @@ application/x-chm = execm rclchm - + Filter HTML output The output HTML could be very minimal like the following @@ -3335,7 +3337,7 @@ application/x-chm = execm rclchm - + Page numbers The indexer will interpret ^L characters @@ -3348,7 +3350,7 @@ application/x-chm = execm rclchm - + Field data processing Fields are named pieces of information @@ -3414,16 +3416,17 @@ application/x-chm = execm rclchm At query time, the field can be displayed inside the result list by using the appropriate directive in the definition of the result list paragraph + linkend="RCL.SEARCH.GUI.CUSTOM.RESLIST">result list paragraph format. All fields are displayed on the fields screen of the preview window (which you can reach through the right-click menu). This is independant of the fact that the search which produced the results used the field or not. + You can find more information in the - section about the + section about the fields file, or in comments inside the file. @@ -3435,10 +3438,10 @@ application/x-chm = execm rclchm - + API - + Interface elements A few elements in the interface are specific and and need @@ -3496,10 +3499,10 @@ application/x-chm = execm rclchm - + Python interface - + Introduction &RCL; versions after 1.11 define a Python programming @@ -3534,7 +3537,7 @@ application/x-chm = execm rclchm - + Interface manual @@ -3726,7 +3729,7 @@ FUNCTIONS - + Example code The following sample would query the index with a user @@ -3766,10 +3769,10 @@ while query.next >= 0 and query.next < nres: - + Installation and configuration - + Installing a binary copy There are three types of binary &RCL; installations: @@ -3793,18 +3796,18 @@ while query.next >= 0 and query.next < nres: you should not have to worry about them. You will only have to check or install supporting applications + linkend="RCL.INSTALL.EXTERNAL">supporting applications for the file types that you want to index beyond those that are natively processed by &RCL; (text, HTML, email files, and a few others). You should also maybe have a look at the - configuration section + configuration section (but this may not be necessary for a quick test with default parameters). Most parameters can be more conveniently set from the GUI interface. - + Installing through a package system If you use a BSD-type port system or a prebuilt package (DEB, @@ -3813,7 +3816,7 @@ while query.next >= 0 and query.next < nres: - + Installing a prebuilt &RCL; The unpackaged binary versions on the &RCL; web site are @@ -3826,7 +3829,7 @@ while query.next >= 0 and query.next < nres: dependencies). After extracting the tar file, you can proceed with - installation as + installation as if you had built the package from source (that is, just type make install). The binary trees are built for installation to /usr/local. @@ -3834,7 +3837,7 @@ while query.next >= 0 and query.next < nres: - + Supporting packages &RCL; uses external applications to index some file @@ -3982,10 +3985,10 @@ while query.next >= 0 and query.next < nres: - + Building from source - + Prerequisites C++ compiler. Up to &RCL; version 1.13.04, its absence can @@ -4027,7 +4030,7 @@ while query.next >= 0 and query.next < nres: - + Building &RCL; has been built on Linux, FreeBSD, Mac OS X, and Solaris, @@ -4145,7 +4148,7 @@ while query.next >= 0 and query.next < nres: - + Installation Either type make install or execute @@ -4168,12 +4171,12 @@ while query.next >= 0 and query.next < nres: You can then proceed to configuration. + linkend="RCL.INSTALL.CONFIG">configuration. - + Configuration overview Most of the parameters specific to the @@ -4295,7 +4298,7 @@ while query.next >= 0 and query.next < nres: - + Main configuration file recoll.conf is the main @@ -4316,12 +4319,12 @@ while query.next >= 0 and query.next < nres: recoll interface. Some can only be set by editing the configuration file. - + Parameters affecting what documents we index: - + topdirs Specifies the list of directories or files to index (recursively for directories). You can use symbolic links @@ -4388,7 +4391,7 @@ skippedPaths = ~/somedir/∗.txt - + skippedPathsFnmPathname The values in the *skippedPaths variables are matched by @@ -4402,7 +4405,7 @@ skippedPaths = ~/somedir/∗.txt - + followLinks Specifies if the indexer should follow symbolic links while walking the file tree. The default is @@ -4497,7 +4500,7 @@ skippedPaths = ~/somedir/∗.txt - + Parameters affecting how we generate terms: Changing some of these parameters will imply a full @@ -4652,7 +4655,7 @@ unac_except_trans = - + Parameters affecting where and how we store things: @@ -4730,7 +4733,7 @@ unac_except_trans = - + Miscellaneous parameters: @@ -4884,7 +4887,7 @@ mondelaypatterns = *.log:20 "this one has spaces*:10" - + The fields file This file contains information about dynamic fields handling @@ -4966,7 +4969,7 @@ x-my-tag = mailmytag - + The mimemap file mimemap specifies the @@ -5003,7 +5006,7 @@ x-my-tag = mailmytag - + The mimeconf file mimeconf specifies how the @@ -5021,7 +5024,7 @@ x-my-tag = mailmytag recoll.conf). - + The mimeview file mimeview specifies which programs @@ -5132,10 +5135,10 @@ x-my-tag = mailmytag - + Examples of configuration adjustments - + Adding an external viewer for an non-indexed type Imagine that you have some kind of file which does not @@ -5180,7 +5183,7 @@ application/x-blobapp = blobviewer %f - + Adding indexing support for a new file type Let us now imagine that the above @@ -5217,7 +5220,7 @@ application/x-blobapp = exec rclblob will be given a file name as argument and should output the text or html contents on the standard output. - The filter + The filter programming section describes in more detail how to write a filter. diff --git a/src/doc/user/xmlmake.sh b/src/doc/user/xmlmake.sh index 187e29f9..f5033d93 100644 --- a/src/doc/user/xmlmake.sh +++ b/src/doc/user/xmlmake.sh @@ -14,11 +14,11 @@ # Wherever docbook.xsl and chunk.xsl live # Fbsd -XSLDIR="/usr/local/share/xsl/docbook/" +#XSLDIR="/usr/local/share/xsl/docbook/" # Mac #XSLDIR="/opt/local/share/xsl/docbook-xsl/" #Linux -#XSLDIR="/usr/share/xml/docbook/stylesheet/docbook-xsl/" +XSLDIR="/usr/share/xml/docbook/stylesheet/docbook-xsl/" dochunky=1 test $# -eq 1 && dochunky=0 @@ -50,7 +50,7 @@ test $dochunky -ne 0 && eval xsltproc $commonoptions \ # Produce the single file version eval xsltproc $commonoptions \ - -o usermanual-xml.html \ + -o usermanual.html \ "$XSLDIR/html/docbook.xsl" \ usermanual.xml