[doc-en] master: Highlight query Amend the doc pages (#3742)
| From: | Mikhail Alferov via GitHub | Date: | Wed, 02 Sep 2026 08:30:22 +0000 |
| Subject: | [doc-en] master: Highlight query Amend the doc pages (#3742) | ||
| Groups: | php.doc.cvs | ||
| Request: | Send a blank email to doc-cvs+get-23696@lists.php.net to get a copy of this message | ||
Author: Mikhail Alferov (mmalferov)
Committer: GitHub (web-flow)
Pusher: lacatoire
Date: 2026-09-02T10:30:19+02:00
Commit: https://github.com/php/doc-en/commit/e549ce16fdd9c1f73653700729d29ed7d3272fab
Raw diff: https://github.com/php/doc-en/commit/e549ce16fdd9c1f73653700729d29ed7d3272fab.diff
Highlight query Amend the doc pages (#3742)
* gethighlightquery.xml The combined spelling of highlightquery is confusing
It is also confusing the
SolrHighlightQuery in Return value block. I guess that was
meant the SolrQuery object.
Please check the suggested corrections of this commit, maybe I got the articles wrong or other
corrections need to be made; or reject the commit completely
* gethighlightquery.xml Add the tags
* sethighlightquery.xml Amend the method page
* Apply suggestions from code review
Co-authored-by: Louis-Arnaud <la.catoire@gmail.com>
* fix: use <simpara> for inline paragraphs and add seealso sections
* fix: use <simpara> in listitem for Highlight Query parameter
---------
Co-authored-by: Louis-Arnaud <la.catoire@gmail.com>
Changed paths:
M reference/solr/solrquery/gethighlightquery.xml
M reference/solr/solrquery/sethighlightquery.xml
Diff:
diff --git a/reference/solr/solrquery/gethighlightquery.xml
b/reference/solr/solrquery/gethighlightquery.xml
index d7fe4266a26a..299b687c1f58 100644
--- a/reference/solr/solrquery/gethighlightquery.xml
+++ b/reference/solr/solrquery/gethighlightquery.xml
@@ -2,19 +2,22 @@
<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">
&reftitle.description;
<methodsynopsis>
- <modifier>public</modifier>
<type>string</type><methodname>SolrQuery::getHighlightQuery</methodname>
+ <modifier>public</modifier> <type
class="union"><type>string</type><type>null</type></type><methodname>SolrQuery::getHighlightQuery</methodname>
<void/>
</methodsynopsis>
- <para>
- Returns previously set highlight query.
+ <simpara>
+ 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.
- </para>
+ See the <link xlink:href="https://solr.apache.org/guide/solr/latest/query-guide/highlighting.html">Highlighting</link>
+ section for more details.
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -24,9 +27,19 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
- Returns the current SolrHighlightQuery string, or null if not set.
- </para>
+ <simpara>
+ Returns a string that contains the highlight query of the current
<classname>SolrQuery</classname>,
+ or &null; if highlight query is not set.
+ </simpara>
+ </refsect1>
+
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <simplelist>
+ <member><methodname>SolrQuery::setHighlightQuery</methodname></member>
+ <member><methodname>SolrQuery::getHighlightFields</methodname></member>
+ <member><methodname>SolrQuery::setHighlightFields</methodname></member>
+ </simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
diff --git a/reference/solr/solrquery/sethighlightquery.xml
b/reference/solr/solrquery/sethighlightquery.xml
index 79e29a8ca525..19ee9a77be92 100644
--- a/reference/solr/solrquery/sethighlightquery.xml
+++ b/reference/solr/solrquery/sethighlightquery.xml
@@ -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">
@@ -11,13 +11,19 @@
<modifier>public</modifier>
<type>SolrQuery</type><methodname>SolrQuery::setHighlightQuery</methodname>
<methodparam><type>string</type><parameter>q</parameter></methodparam>
</methodsynopsis>
- <para>
- A query to use for highlighting.
+ <simpara>
+ 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>
+ </simpara>
- <para>Default value when not set: the value of the request's q parameter</para>
- <para>Solr Parameter reference: hl.q</para>
+ <simpara>
+ Default value when not set: the value of the request's <literal>q</literal>
parameter.
+ </simpara>
+
+ <simpara>
+ See the <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.
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -27,9 +33,9 @@
<varlistentry>
<term><parameter>q</parameter></term>
<listitem>
- <para>
- Highlight Query
- </para>
+ <simpara>
+ Highlight Query.
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -38,9 +44,18 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
- Returns the current <classname>SolrQuery</classname> object, if the return value is
used.
- </para>
+ <simpara>
+ Returns the current <classname>SolrQuery</classname> object.
+ </simpara>
+ </refsect1>
+
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <simplelist>
+ <member><methodname>SolrQuery::getHighlightQuery</methodname></member>
+ <member><methodname>SolrQuery::setHighlightFields</methodname></member>
+ <member><methodname>SolrQuery::getHighlightFields</methodname></member>
+ </simplelist>
</refsect1>
</refentry>