Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Highlight query Amend the doc pages #3742

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Highlight query Amend the doc pages #3742

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
65b620a
gethighlightquery.xml The combined spelling of highlightquery is conf…
mmalferov Sep 12, 2024
dea1841
gethighlightquery.xml Add the tags
mmalferov Sep 12, 2024
ef39644
sethighlightquery.xml Amend the method page
mmalferov Sep 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions reference/solr/solrquery/gethighlightquery.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<refentry xml:id="solrquery.gethighlightquery" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>SolrQuery::getHighlightQuery</refname>
<refpurpose>return the highlightquery (hl.q)</refpurpose>
<refpurpose>Return the highlight query</refpurpose>
</refnamediv>

<refsect1 role="description">
Expand All @@ -12,16 +12,23 @@
<void/>
</methodsynopsis>
<para>
Returns previously set highlight query.
Returns previously set highlight query from the
<literal>hl.q</literal> parameter.
This parameter allows you to highlight different terms or fields than those being used to retrieve documents.
See
<link xlink:href="https://solr.apache.org/guide/solr/latest/query-guide/highlighting.html">
Highlighting
</link>
section for more details.
</para>

</refsect1>

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the current SolrHighlightQuery string, or null if not set.
Returns a string that contains the highlight query of the current <classname>SolrQuery</classname>,
or &null; if highlight query is not set.
</para>
</refsect1>
</refentry>
Expand Down
21 changes: 15 additions & 6 deletions reference/solr/solrquery/sethighlightquery.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<refentry xml:id="solrquery.sethighlightquery" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>SolrQuery::setHighlightQuery</refname>
<refpurpose>A query designated for highlighting (hl.q)</refpurpose>
<refpurpose>A query designated for highlighting</refpurpose>
</refnamediv>

<refsect1 role="description">
Expand All @@ -12,12 +12,21 @@
<methodparam><type>string</type><parameter>q</parameter></methodparam>
</methodsynopsis>
<para>
A query to use for highlighting.
A query to use for highlighting and which will be set as the value of the Solr <literal>hl.q</literal> parameter.
This parameter allows one to highlight different terms or fields than those being used to retrieve documents.
</para>

<para>Default value when not set: the value of the request's q parameter</para>
<para>Solr Parameter reference: hl.q</para>
<para>
Default value when not set: the value of the request's <literal>q</literal> parameter.
</para>

<para>
See
<link xlink:href="https://solr.apache.org/guide/solr/latest/query-guide/highlighting.html">
Highlighting
</link>
section for more details about the Solr <literal>hl.q</literal> parameter.
</para>
</refsect1>

<refsect1 role="parameters">
Expand All @@ -28,7 +37,7 @@
<term><parameter>q</parameter></term>
<listitem>
<para>
Highlight Query
Highlight Query.
</para>
</listitem>
</varlistentry>
Expand All @@ -39,7 +48,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the current <classname>SolrQuery</classname> object, if the return value is used.
Returns the current <classname>SolrQuery</classname> object.
</para>
</refsect1>

Expand Down