summaryrefslogtreecommitdiffstats
path: root/doc/extsearch.doc
diff options
context:
space:
mode:
authoralbert-github <albert.tests@gmail.com>2017-06-04 10:52:50 (GMT)
committeralbert-github <albert.tests@gmail.com>2017-06-04 10:52:50 (GMT)
commit31cf78d223e52fe078ad9b0651672aeb73926065 (patch)
treedcdec5668323e779b92a9e0adfb91c88c25f1f65 /doc/extsearch.doc
parent9b7b33994f6443c26146837ba13dff94e5eba998 (diff)
downloadDoxygen-31cf78d223e52fe078ad9b0651672aeb73926065.zip
Doxygen-31cf78d223e52fe078ad9b0651672aeb73926065.tar.gz
Doxygen-31cf78d223e52fe078ad9b0651672aeb73926065.tar.bz2
Correction of non reachable links and redirected links in documentation.
The W3C link checker reported a number of problems regarding non reachable links and permanent redirects. Most of these problems have been fixed with this patch
Diffstat (limited to 'doc/extsearch.doc')
-rw-r--r--doc/extsearch.doc12
1 files changed, 6 insertions, 6 deletions
diff --git a/doc/extsearch.doc b/doc/extsearch.doc
index cead851..99a7219 100644
--- a/doc/extsearch.doc
+++ b/doc/extsearch.doc
@@ -52,7 +52,7 @@ The data flow is shown in the following diagram:
The first step is to make the search engine available via a web server.
If you use `doxysearch.cgi` this means making the
-<a href="http://en.wikipedia.org/wiki/Common_Gateway_Interface">CGI</a> binary
+<a href="https://en.wikipedia.org/wiki/Common_Gateway_Interface">CGI</a> binary
available from the web server (i.e. be able to run it from a
browser via an URL starting with http:)
@@ -187,7 +187,7 @@ The next subsections describe these interfaces in more detail.
\subsection extsearch_api_index Indexer input format
The search data produced by doxygen follows the
-<a href="http://wiki.apache.org/solr/UpdateXmlMessages">Solr XML index message</a>
+<a href="https://wiki.apache.org/solr/UpdateXmlMessages">Solr XML index message</a>
format.
The input for the indexer is an XML file, which consists of one `<add>` tag containing
@@ -224,12 +224,12 @@ Each field has a name. The following field names are supported:
- *text*: the documentation associated with the item. Note that only words are present, no markup.
@note Due to the potentially large size of the XML file, it is recommended to use a
-<a href="http://en.wikipedia.org/wiki/Simple_API_for_XML">SAX based parser</a> to process it.
+<a href="https://en.wikipedia.org/wiki/Simple_API_for_XML">SAX based parser</a> to process it.
\subsection extsearch_api_search_in Search URL format
When the search engine is invoked from a doxygen generated HTML page, a number of parameters are
-passed to via the <a href="http://en.wikipedia.org/wiki/Query_string">query string</a>.
+passed to via the <a href="https://en.wikipedia.org/wiki/Query_string">query string</a>.
The following fields are passed:
- *q*: the query text as entered by the user
@@ -247,14 +247,14 @@ It represents a query for the word 'list' (`q=list`) requesting 20 search result
starting with the result number 20 (`p=1`) and using callback 'dummy' (`cb=dummy`):
-@note The values are <a href="http://en.wikipedia.org/wiki/Percent-encoding">URL encoded</a> so they
+@note The values are <a href="https://en.wikipedia.org/wiki/Percent-encoding">URL encoded</a> so they
have to be decoded before they can be used.
\subsection extsearch_api_search_out Search results format
When invoking the search engine as shown in the previous subsection, it should reply with
the results. The format of the reply is
-<a href="http://en.wikipedia.org/wiki/JSONP">JSON with padding</a>, which is basically
+<a href="https://en.wikipedia.org/wiki/JSONP">JSON with padding</a>, which is basically
a javascript struct wrapped in a function call. The name of function should be the name of
the callback (as passed with the *cb* field in the query).