Screenshot of results including restructured text.

• nice find
• same issue with the results preview occurs with Python docs (​http://docs.python.org/) and MapServer? docs
• looking into this now

• same issue exists with OpenLayers? docs (​http://docs.openlayers.org/search.html?q=control&check_keywords=yes&area=default)

• checking into this...

• GeoServer? avoids this by just showing the document names in the search results (​http://docs.geoserver.org/stable/en/user/search.html?check_keywords=yes&area=default&q=install&x=0&y=0)
• this might be a nice solution
• checking...

Results summary using the html source files, instead of the restructured text files

Results showing only the page name (similar to how GeoServer? handles this)

Here is what I found:

• the search tool uses javascript to crawl the source restructured text files for the search term (around this line: source:/trunk/docs/_static/searchtools.js#L483)
• I can modify that to crawl the source .html files for the search term instead (see results in screengrab: attachment:html-results.jpg​)
• but since this searches the raw .html files, the html tags are displayed in the search results (not desirable)
• I can also change the search to output only the page names (see screengrab: attachment:pagename-only-results.jpg​)

So which option is more desirable? 1) as-is, restructured text, 2) raw html, or 3) page names only.

I prefer as-is. I like having some sample text,even if some restructured text syntax is included.

What is your preference? Let me know, thanks.

For anyone who is following along, here is a working example of the current search tool: http://www.zoo-project.org/docs/search.html?q=Kernel&check_keywords=yes&area=default

Comments welcome.

update: discussed with Nick on IRC, the search as-is is also the most desirable option at the moment.

I'll leave this ticket open if we need to come back to it later.