Re: [Doxygen-develop] Opensearch provider for doxygen docs

[Arnold.Steve <arn...@en...>]

Sounds good to me, but I don't speak for upstream.  What I can do is test a patch in Gentoo, and put it out for other people to play with.  Let me know, or file a Gentoo bug with your patch.

Thanks...

--
Steve

________________________________________
From: Phil Lello [phi...@sq...]
Sent: Monday, June 20, 2011 7:13 PM
To: Dox...@li...
Subject: [Doxygen-develop] Opensearch provider for doxygen docs

Hi all,

I have written a prototype implementation of an opensearch provider for doxygen, which allows a doxygen docset to be searched in Firefox (and possibly IE and others) via the browser quicksearch (top-right box on firefox). It could also be extended to allow AJAX-based 'live' searches with server-side searches.

I've managed to get this to provide both generic search functionality, as well as implementing search suggestions. Initially this was via manual edits ('gross hacks') to the generated search.php. I'm currently rolling the changes I made to the default search.php into htmlgen.cpp and search.php, and hope to have something to share over the next few days.

To reduce the 'gross hack' elements, I've been re-structuring the mix between HtmlGenerator::writeSearchPage() and am approaching a version where the run-time decisions in writeSearchPage are largely writing config, and most decisions are made at run time.

To elegantly split functionality for 'normal' search results and 'opensearch' results/suggestions, it would be neatest to split search.php into several parts:

- A config.php that holds the config settings(!) - mostly strings from 'theTranslator' or Config_getXXX()
- A search-functions.php that holds common code
- A search.php that includes config.php and search-functions.php, and is basically the HTML header & footer
- An opensearch.php that takes care of the opensearch interface.

Does anyone have any objections to this approach, or anticipate resistance from users?

Cheers,

Phil Lello


The information contained in this email message is intended only for the use of the individual(s) to whom it is addressed and may contain information that is privileged and sensitive. If you are not the intended recipient, or otherwise have received this communication in error, please notify the sender immediately by email at the above referenced address and note that any further dissemination, distribution or copying of this communication is strictly prohibited.

The U.S. Export Control Laws regulate the export and re-export of technology originating in the United States. This includes the electronic transmission of information and software to foreign countries and to certain foreign nationals. Recipient agrees to abide by these laws and their regulations -- including the U.S. Department of Commerce Export Administration Regulations and the U.S. Department of State International Traffic in Arms Regulations -- and not to transfer, by electronic transmission or otherwise, any content derived from this email to either a foreign national or a foreign destination in violation of such laws.