Ticket #23 (assigned defect)

Opened 9 years ago

Last modified 9 years ago

Documentation search engine

Reported by: djay Owned by: jmckenna
Priority: minor Milestone: 1.2.0
Component: Documentation Version:
Keywords: Cc: nickboz

Description

When we are using the search engine from the Sphinx documentation, I noticed that the restructured text is displayed rather than HTML which can be easier to read.

If there is any way to solve this it can be great.

Attachments (3)

Capture d’écran 2011-04-20 à 14.51.33.png (151.1 KB) - added by djay 9 years ago.
Screenshot of results including restructured text.
html-results.jpg (101.4 KB) - added by jmckenna 9 years ago.
Results summary using the html source files, instead of the restructured text files
pagename-only-results.jpg (54.5 KB) - added by jmckenna 9 years ago.
Results showing only the page name (similar to how GeoServer? handles this)

Download all attachments as: .zip

Change History

Changed 9 years ago by djay

Screenshot of results including restructured text.

Changed 9 years ago by jmckenna

  • cc nickboz added
  • status changed from new to assigned

Changed 9 years ago by jmckenna

Changed 9 years ago by jmckenna

Changed 9 years ago by jmckenna

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

Changed 9 years ago by jmckenna

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

Changed 9 years ago by jmckenna

Here is what I found:

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.

Changed 9 years ago by jmckenna

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.

Changed 9 years ago by jmckenna

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.

Note: See TracTickets for help on using tickets.

Search

Context Navigation

ZOO Sponsors

http://www.zoo-project.org/trac/chrome/site/img/geolabs-logo.pnghttp://www.zoo-project.org/trac/chrome/site/img/neogeo-logo.png http://www.zoo-project.org/trac/chrome/site/img/apptech-logo.png http://www.zoo-project.org/trac/chrome/site/img/3liz-logo.png http://www.zoo-project.org/trac/chrome/site/img/gateway-logo.png

Become a sponsor !

Knowledge partners

http://www.zoo-project.org/trac/chrome/site/img/ocu-logo.png http://www.zoo-project.org/trac/chrome/site/img/gucas-logo.png http://www.zoo-project.org/trac/chrome/site/img/polimi-logo.png http://www.zoo-project.org/trac/chrome/site/img/fem-logo.png http://www.zoo-project.org/trac/chrome/site/img/supsi-logo.png http://www.zoo-project.org/trac/chrome/site/img/cumtb-logo.png

Become a knowledge partner

Related links

http://zoo-project.org/img/ogclogo.png http://zoo-project.org/img/osgeologo.png