diff options
Diffstat (limited to 'src/config.xml')
| -rw-r--r-- | src/config.xml | 42 |
1 files changed, 36 insertions, 6 deletions
diff --git a/src/config.xml b/src/config.xml index 3ca3313..a75ff80 100644 --- a/src/config.xml +++ b/src/config.xml @@ -1148,12 +1148,42 @@ can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. ' defval='1' depends='GENERATE_HTML'/> <option type='bool' id='SERVER_BASED_SEARCH' docs=' When the SERVER_BASED_SEARCH tag is enabled the search engine will be -implemented using a PHP enabled web server instead of at the web client -using Javascript. Doxygen will generate the search PHP script and index -file to put on the web server. The advantage of the server -based approach is that it scales better to large projects and allows -full text search. The disadvantages are that it is more difficult to setup -and does not have live searching capabilities. +implemented using a web server instead of a web client using Javascript. +There are two flavours of web server based search depending on the +EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for +searching and an index file used by the script. When EXTERNAL_SEARCH is +enabled the indexing and searching needs to be provided by external tools. +See the manual for details. +' defval='0' depends='SEARCHENGINE'/> + <option type='bool' id='EXTERNAL_SEARCH' docs=' +When EXTERNAL_SEARCH is enabled doxygen will no longer generate the PHP +script for searching. Instead the search results are written to an XML file +which needs to be processed by an external indexer. Doxygen will invoke an +external search engine pointed to by the SEARCHENGINE_URL option to obtain +the search results. Doxygen ships with an example indexer (doxyindexer) and +search engine (doxysearch.cgi) which are based on the open source search engine +library Xapian. See the manual for configuration details. +' defval='0' depends='SEARCHENGINE'/> + <option type='string' id='SEARCHENGINE_URL' docs=' +The SEARCHENGINE_URL should point to a search engine hosted by a web server +which will returned the search results when EXTERNAL_SEARCH is enabled. +Doxygen ships with an example search engine (doxysearch) which is based on +the open source search engine library Xapian. See the manual for configuration +details. +' defval='' depends='SEARCHENGINE'/> + <option type='string' id='SEARCHDATA_FILE' format='file' docs=' +When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed +search data is written to a file for indexing by an external tool. With the +SEARCHDATA_FILE tag the name of this file can be specified. +' defval='searchdata.xml' depends='SEARCHENGINE'/> + <option type='list' id='EXTRA_SEARCH_MAPPINGS' docs=' +The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through other +doxygen projects that are not otherwise connected via tags files, but are +all added to the same search index. Each project needs to have a tag file set +via GENERATE_TAGFILE. The search mapping then maps the name of the tag file +to a relative location where the documentation can be found, similar to the +TAGFILES option but without actually processing the tag file. +The format is: EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ... ' defval='0' depends='SEARCHENGINE'/> </group> <group name='LaTeX' docs='configuration options related to the LaTeX output'> |