Skip to content

[Sync-En] SolrQuery: clarify the highlight query accessors #1248

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

Merged
julionc merged 2 commits into from
Sep 3, 2026
+53 −22
Merged

[Sync-En] SolrQuery: clarify the highlight query accessors #1248

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
83d3692
[Sync-En] SolrQuery: clarify the highlight query accessors
lacatoire Sep 3, 2026
34508f1
SolrQuery: use por defecto and align on resaltado, the term used acro…
lacatoire Sep 3, 2026
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
32 changes: 23 additions & 9 deletions reference/solr/solrquery/gethighlightquery.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,22 +1,25 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 45819f24afaf2ce388bdbb9b2dcbbbe62414a4f7 Maintainer: PhilDaiguille Status: ready -->
<!-- EN-Revision: e549ce16fdd9c1f73653700729d29ed7d3272fab Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: yes -->
<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>Devuelve la consulta de resaltado (hl.q)</refpurpose>
<refpurpose>Devuelve la consulta de resaltado</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>
Devuelve la consulta de resaltado previamente definida.
<simpara>
Devuelve la consulta de resaltado definida previamente mediante el parámetro
<literal>hl.q</literal>.
Este parámetro permite resaltar términos o campos diferentes de los utilizados para recuperar los documentos.
</para>
Véase la sección <link xlink:href="https://solr.apache.org/guide/solr/latest/query-guide/highlighting.html">Highlighting</link>
para más detalles.
</simpara>
</refsect1>

<refsect1 role="parameters">
Expand All @@ -26,9 +29,20 @@

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Devuelve la cadena de consulta de resaltado actual, o null si no está definida.
</para>
<simpara>
Devuelve una cadena que contiene la consulta de resaltado del
<classname>SolrQuery</classname> actual, o &null; si la consulta de
resaltado no está definida.
</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
Expand Down
43 changes: 30 additions & 13 deletions reference/solr/solrquery/sethighlightquery.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 1d92acb7add86f36f352334a52679c078e328704 Maintainer: PhilDaiguille Status: ready -->
<!-- EN-Revision: e549ce16fdd9c1f73653700729d29ed7d3272fab Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: yes -->
<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>Una consulta designada para la resaltación (hl.q)</refpurpose>
<refpurpose>Una consulta designada para el resaltado</refpurpose>
</refnamediv>

<refsect1 role="description">
Expand All @@ -13,13 +13,21 @@
<modifier>public</modifier> <type>SolrQuery</type><methodname>SolrQuery::setHighlightQuery</methodname>
<methodparam><type>string</type><parameter>q</parameter></methodparam>
</methodsynopsis>
<para>
Una consulta a utilizar para la resaltación.
<simpara>
Una consulta a utilizar para el resaltado, que se asignará como valor del
parámetro Solr <literal>hl.q</literal>.
Este parámetro permite resaltar términos o campos diferentes de los utilizados para recuperar los documentos.
</para>
</simpara>

<para>El valor por omisión si no está definido: el valor del parámetro q de la consulta</para>
<para>Referencia del parámetro Solr: hl.q</para>
<simpara>
El valor predeterminado si no está definido: el valor del parámetro
<literal>q</literal> de la petición.
</simpara>

<simpara>
Véase la sección <link xlink:href="https://solr.apache.org/guide/solr/latest/query-guide/highlighting.html">Highlighting</link>
para más detalles sobre el parámetro Solr <literal>hl.q</literal>.
</simpara>
</refsect1>

<refsect1 role="parameters">
Expand All @@ -29,9 +37,9 @@
<varlistentry>
<term><parameter>q</parameter></term>
<listitem>
<para>
La consulta de resaltación
</para>
<simpara>
La consulta de resaltado.
</simpara>
</listitem>
</varlistentry>
</variablelist>
Expand All @@ -40,9 +48,18 @@

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Devuelve el objeto <classname>SolrQuery</classname> actual, si el valor devuelto es utilizado.
</para>
<simpara>
Devuelve el objeto <classname>SolrQuery</classname> actual.
</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>
Expand Down