Consider the files reload a project reloading, so it takes the lock and everything.
[kdevelop:agateau-kdevelop.git] / README.htdig
1 What you need to do in order to setup Ht://Dig for using with KDevelop.
2
3 1. If you use Ht://Dig v3.1.x patch the sources with this
4    (http://www.geocities.com/alexismikhailov/htdig_3_1_x.diff.zip)
5    file.
6 2. Copy htdig.conf into {kde_global_dir}/share/apps/kdevelop/tools/.
7
8 If you already use Ht://Dig to index your local documents and don't
9 want to litter database with links to development docs perform actions
10 in part I and go to part II. Otherwise skip part I and go to part II
11 directly.
12
13 -------------- I ---------------
14 3. Copy files from {htdig_dir}/common (for 3.1.x of htdig) or
15    {htdig_dir}/share/htdig (for 3.2.x of htdig) to some location
16    (f.e. {kde_global_dir}/share/apps/kdevelop/htdig/common).
17 4. Modify URL's in .html files for 'common' dir to be file://localhost urls
18    f.e. <img src="file://localhost/opt/www/htdocs/htdig/htdig.png">.
19 5. Modify htdig.conf (sample included in the end of this README).
20 5.1. Set database_dir to some location
21      (f.e. {kde_global_dir}/share/apps/kdevelop/htdig/db).
22 5.2. Set common_dir to point to the location you have copied files into
23      in step 1.
24 --------------- II -------------
25 6. Modify htdig.conf.
26 6.1. Set 'limit_urls_to' to 'file://' (without quotes of course).
27 6.2. Set 'maximum_pages' to '1'.
28 6.3. If you want to index documents that cointain 'noindex' tag
29      (all Qt docs) patch htdig with this
30      (http://www.geocities.com/alexismikhailov/htdig_3_1_x_noindex.diff.zip)
31      for htdig 3.1.x or this
32      (http://www.geocities.com/alexismikhailov/htdig_3_2_x_noindex.diff.zip)
33      patch and set 'ignore_noindex' to 'true'.
34 6.4. Set 'star_image' to 'file://localhost' type.
35 6.5. Set 'local_urls' to 'file://localhost=' for htdig 3.1.x and
36      to 'file://=' for htdig 3.2.x. As soon as my patches for
37      file:// support will be integrated (or someone else will
38      create this thing) you won't need this step (for htdig 3.2.x).
39
40
41 #=======================================================================
42 #
43 # Example config file for ht://Dig.
44 #
45 # This configuration file is used by all the programs that make up ht://Dig.
46 # Please refer to the attribute reference manual for more details on what
47 # can be put into this file.  (http://www.htdig.org/confindex.html)
48 # Note that most attributes have very reasonable default values so you
49 # really only have to add attributes here if you want to change the defaults.
50 #
51 # What follows are some of the common attributes you might want to change.
52 #
53
54 #
55 # Specify where the database files need to go.  Make sure that there is
56 # plenty of free disk space available for the databases.  They can get
57 # pretty big.
58 #
59 database_dir:           /usr/local/kde/share/apps/kdevelop/htdig/db
60
61 #
62 # This specifies the URL where the robot (htdig) will start.  You can specify
63 # multiple URLs here.  Just separate them by some whitespace.
64 # The example here will cause the ht://Dig homepage and related pages to be
65 # indexed.
66 # You could also index all the URLs in a file like so:
67 # start_url:           `${common_dir}/start.url`
68 #
69 #start_url:             file://localhost/usr/local/kde/share/doc/HTML/en/kdevelop/
70 #http://localhost/
71 #http://www.htdig.org/
72
73 #
74 # This attribute limits the scope of the indexing process.  The default is to
75 # set it to the same as the start_url above.  This way only pages that are on
76 # the sites specified in the start_url attribute will be indexed and it will
77 # reject any URLs that go outside of those sites.
78 #
79 # Keep in mind that the value for this attribute is just a list of string
80 # patterns. As long as URLs contain at least one of the patterns it will be
81 # seen as part of the scope of the index.
82 #
83 limit_urls_to:          file://
84 #${start_url}
85
86 #
87 # If there are particular pages that you definately do NOT want to index, you
88 # can use the exclude_urls attribute.  The value is a list of string patterns.
89 # If a URL matches any of the patterns, it will NOT be indexed.  This is
90 # useful to exclude things like virtual web trees or database accesses.  By
91 # default, all CGI URLs will be excluded.  (Note that the /cgi-bin/ convention
92 # may not work on your web server.  Check the  path prefix used on your web
93 # server.)
94 #
95 exclude_urls:           /cgi-bin/ .cgi
96
97 #
98 # The string htdig will send in every request to identify the robot.  Change
99 # this to your email address.
100 #
101 maintainer:             unconfigured@htdig.searchengine.maintainer
102
103 #
104 # The excerpts that are displayed in long results rely on stored information
105 # in the index databases.  The compiled default only stores 512 characters of
106 # text from each document (this excludes any HTML markup...)  If you plan on
107 # using the excerpts you probably want to make this larger.  The only concern
108 # here is that more disk space is going to be needed to store the additional
109 # information.  Since disk space is cheap (! :-)) you might want to set this
110 # to a value so that a large percentage of the documents that you are going
111 # to be indexing are stored completely in the database.  At SDSU we found
112 # that by setting this value to about 50k the index would get 97% of all
113 # documents completely and only 3% was cut off at 50k.  You probably want to
114 # experiment with this value.
115 # Note that if you want to set this value low, you probably want to set the
116 # excerpt_show_top attribute to false so that the top excerpt_length characters
117 # of the document are always shown.
118 #
119 max_head_length:        10000
120
121 #
122 # To limit network connections, ht://Dig will only pull up to a certain limit
123 # of bytes. This prevents the indexing from dying because the server keeps
124 # sending information. However, several FAQs happen because people have files
125 # bigger than the default limit of 100KB. This sets the default a bit higher.
126 # (see <http://www.htdig.org/FAQ.html> for more)
127 #
128 max_doc_size:           200000
129
130 #
131 # Depending on your needs, you might want to enable some of the fuzzy search
132 # algorithms.  There are several to choose from and you can use them in any
133 # combination you feel comfortable with.  Each algorithm will get a weight
134 # assigned to it so that in combinations of algorithms, certain algorithms get
135 # preference over others.  Note that the weights only affect the ranking of
136 # the results, not the actual searching.
137 # The available algorithms are:
138 #       exact
139 #       endings
140 #       synonyms
141 #       soundex
142 #       metaphone
143 # By default only the "exact" algorithm is used with weight 1.
144 # Note that if you are going to use any of the algorithms other than "exact",
145 # you need to use the htfuzzy program to generate the databases that each
146 # algorithm requires.
147 #
148 search_algorithm:       exact:1 synonyms:0.5 endings:0.1
149
150 common_dir:     /usr/local/kde/share/apps/kdevelop/htdig/common
151 maximum_pages:  1
152 ignore_noindex: true
153
154 #
155 # The following are the templates used in the builtin search results
156 # The default is to use compiled versions of these files, which produces
157 # slightly faster results. However, uncommenting these lines makes it
158 # very easy to change the format of search results.
159 # See <http://www.htdig.org/hts_templates.html for more details.
160 #
161 # template_map: Long long ${common_dir}/long.html \
162 #               Short short ${common_dir}/short.html
163 # template_name: long
164
165 #
166 # The following are used to change the text for the page index.
167 # The defaults are just boring text numbers.  These images spice
168 # up the result pages quite a bit.  (Feel free to do whatever, though)
169 #
170 next_page_text:         <img src=/opt/www/htdocs/htdig/buttonr.png border=0 align=middle width=30 height=30 alt=next>
171 no_next_page_text:
172 prev_page_text:         <img src=/opt/www/htdocs/htdig/buttonl.png border=0 align=middle width=30 height=30 alt=prev>
173 no_prev_page_text:
174 page_number_text:       "<img src=/opt/www/htdocs/htdig/button1.gif border=0 align=middle width=30 height=30 alt=1>" \
175                         "<img src=/opt/www/htdocs/htdig/button2.png border=0 align=middle width=30 height=30 alt=2>" \
176                         "<img src=/htdig/button3.gif border=0 align=middle width=30 height=30 alt=3>" \
177                         "<img src=/htdig/button4.gif border=0 align=middle width=30 height=30 alt=4>" \
178                         "<img src=/htdig/button5.gif border=0 align=middle width=30 height=30 alt=5>" \
179                         "<img src=/htdig/button6.gif border=0 align=middle width=30 height=30 alt=6>" \
180                         "<img src=/htdig/button7.gif border=0 align=middle width=30 height=30 alt=7>" \
181                         "<img src=/htdig/button8.gif border=0 align=middle width=30 height=30 alt=8>" \
182                         "<img src=/htdig/button9.gif border=0 align=middle width=30 height=30 alt=9>" \
183                         "<img src=/htdig/button10.gif border=0 align=middle width=30 height=30 alt=10>"
184 #
185 # To make the current page stand out, we will put a border arround the
186 # image for that page.
187 #
188 no_page_number_text:    "<img src=/opt/www/htdocs/htdig/button1.png border=2 align=middle width=30 height=30 alt=1>" \
189                         "<img src=/htdig/button2.gif border=2 align=middle width=30 height=30 alt=2>" \
190                         "<img src=/htdig/button3.gif border=2 align=middle width=30 height=30 alt=3>" \
191                         "<img src=/htdig/button4.gif border=2 align=middle width=30 height=30 alt=4>" \
192                         "<img src=/htdig/button5.gif border=2 align=middle width=30 height=30 alt=5>" \
193                         "<img src=/htdig/button6.gif border=2 align=middle width=30 height=30 alt=6>" \
194                         "<img src=/htdig/button7.gif border=2 align=middle width=30 height=30 alt=7>" \
195                         "<img src=/htdig/button8.gif border=2 align=middle width=30 height=30 alt=8>" \
196                         "<img src=/htdig/button9.gif border=2 align=middle width=30 height=30 alt=9>" \
197                         "<img src=/htdig/button10.gif border=2 align=middle width=30 height=30 alt=10>"
198
199 star_image:     file://localhost/opt/www/htdocs/htdig/star.png
200 star_blank:     file://localhost/opt/www/htdocs/htdig/star_blank.png
201
202 # local variables:
203 local_urls: file://localhost=
204 #local_urls: file://=
205 # mode: text
206 # eval: (if (eq window-system 'x) (progn (setq font-lock-keywords (list '("^#.*" . font-lock-keyword-face) '("^[a-zA-Z][^ :]+" . font-lock-function-name-face) '("[+$]*:" . font-lock-comment-face) )) (font-lock-mode)))
207 # end: