You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by dw...@apache.org on 2021/03/10 09:48:07 UTC
[lucene] 03/11: add autowidth headers where appropriate
This is an automated email from the ASF dual-hosted git repository.
dweiss pushed a commit to branch SOLR-14866
in repository https://gitbox.apache.org/repos/asf/lucene.git
commit 0772057375d43d742b32b5a8aeb0b4757069f2f9
Author: epugh <ep...@opensourceconnections.com>
AuthorDate: Tue Sep 15 07:54:35 2020 -0400
add autowidth headers where appropriate
---
solr/solr-ref-guide/src/common-query-parameters.adoc | 8 ++------
solr/solr-ref-guide/src/defining-fields.adoc | 4 +---
.../src/field-type-definitions-and-properties.adoc | 4 +---
.../solr-ref-guide/src/field-types-included-with-solr.adoc | 4 +---
solr/solr-ref-guide/src/other-parsers.adoc | 14 ++++----------
solr/solr-ref-guide/src/overview-of-the-solr-admin-ui.adoc | 4 +---
.../src/performance-statistics-reference.adoc | 12 +++---------
solr/solr-ref-guide/src/query-re-ranking.adoc | 4 +---
...requesthandlers-and-searchcomponents-in-solrconfig.adoc | 4 +---
9 files changed, 15 insertions(+), 43 deletions(-)
diff --git a/solr/solr-ref-guide/src/common-query-parameters.adoc b/solr/solr-ref-guide/src/common-query-parameters.adoc
index c101a8b..daa515f 100644
--- a/solr/solr-ref-guide/src/common-query-parameters.adoc
+++ b/solr/solr-ref-guide/src/common-query-parameters.adoc
@@ -45,9 +45,7 @@ In the case of primitive fields, or SortableTextFields, that are `multiValued="t
The table below explains how Solr responds to various settings of the `sort` parameter.
-// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
-
-[cols="30,70",options="header"]
+[%autowidth.spread,width="100%",options="header"]
|===
|Example |Result
| |If the sort parameter is omitted, sorting is performed as though the parameter were set to `score desc`.
@@ -117,9 +115,7 @@ The field list can be specified as a space-separated or comma-separated list of
This table shows some basic examples of how to use `fl`:
-// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
-
-[cols="30,70",options="header"]
+[%autowidth.spread,width="100%",options="header"]
|===
|Field List |Result
|id name price |Return only the id, name, and price fields.
diff --git a/solr/solr-ref-guide/src/defining-fields.adoc b/solr/solr-ref-guide/src/defining-fields.adoc
index 5e6b839..f4ebed9 100644
--- a/solr/solr-ref-guide/src/defining-fields.adoc
+++ b/solr/solr-ref-guide/src/defining-fields.adoc
@@ -46,9 +46,7 @@ Fields can have many of the same properties as field types. Properties from the
// TODO: SOLR-10655 BEGIN: refactor this into a 'field-default-properties.include.adoc' file for reuse
-// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
-
-[cols="20,40,20,20",options="header"]
+[%autowidth.spread,width="100%",options="header"]
|===
|Property |Description |Values |Implicit Default
|indexed |If true, the value of the field can be used in queries to retrieve matching documents. |true or false |true
diff --git a/solr/solr-ref-guide/src/field-type-definitions-and-properties.adoc b/solr/solr-ref-guide/src/field-type-definitions-and-properties.adoc
index 487cd4c..754e853 100644
--- a/solr/solr-ref-guide/src/field-type-definitions-and-properties.adoc
+++ b/solr/solr-ref-guide/src/field-type-definitions-and-properties.adoc
@@ -120,9 +120,7 @@ The default values for each property depend on the underlying `FieldType` class,
// TODO: SOLR-10655 BEGIN: refactor this into a 'field-default-properties.include.adoc' file for reuse
-// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
-
-[cols="20,40,20,20",options="header"]
+[%autowidth.spread,width="100%",options="header"]
|===
|Property |Description |Values |Implicit Default
|indexed |If true, the value of the field can be used in queries to retrieve matching documents. |true or false |true
diff --git a/solr/solr-ref-guide/src/field-types-included-with-solr.adoc b/solr/solr-ref-guide/src/field-types-included-with-solr.adoc
index 1e98d86..b9a236a 100644
--- a/solr/solr-ref-guide/src/field-types-included-with-solr.adoc
+++ b/solr/solr-ref-guide/src/field-types-included-with-solr.adoc
@@ -18,9 +18,7 @@
The following table lists the field types that are available in Solr. The `org.apache.solr.schema` package includes all the classes listed in this table.
-// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
-
-[cols="25,75",options="header"]
+[%autowidth.spread,width="100%",options="header"]
|===
|Class |Description
|BinaryField |Binary data.
diff --git a/solr/solr-ref-guide/src/other-parsers.adoc b/solr/solr-ref-guide/src/other-parsers.adoc
index 5395938..7a37394 100644
--- a/solr/solr-ref-guide/src/other-parsers.adoc
+++ b/solr/solr-ref-guide/src/other-parsers.adoc
@@ -237,7 +237,7 @@ Comma separated list of tags for excluding queries from parameters above. See ex
{!bool filter=foo should=bar}
----
-Parameters might also be multivalue references. The former example above is equivlent to
+Parameters might also be multivalue references. The former example above is equivlent to
[source,text]
----
@@ -251,7 +251,7 @@ Referred queries might be excuded via tags. Overall the idea is similar to <<fac
q={!bool must=$ref excludeTags=t2}&ref={!tag=t1}foo&ref={!tag=t2}bar
----
-Since the later query is excluded via `t2`, the resulting query is equivalent to
+Since the later query is excluded via `t2`, the resulting query is equivalent to
[source,text]
----
@@ -1082,8 +1082,6 @@ This parser takes the following parameters:
q.operators::
Comma-separated list of names of parsing operators to enable. By default, all operations are enabled, and this parameter can be used to effectively disable specific operators as needed, by excluding them from the list. Passing an empty string with this parameter disables all operators.
+
-// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
-+
[cols="15,20,50,15",options="header"]
|===
|Name |Operator |Description |Example query
@@ -1262,9 +1260,7 @@ An optional parameter used to determine which of several query implementations s
The {solr-javadocs}/solr-core/org/apache/solr/search/XmlQParserPlugin.html[XmlQParserPlugin] extends the {solr-javadocs}/solr-core/org/apache/solr/search/QParserPlugin.html[QParserPlugin] and supports the creation of queries from XML. Example:
-// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
-
-[cols="30,70",options="header"]
+[%autowidth.spread,width="100%",options="header"]
|===
|Parameter |Value
|defType |`xmlparser`
@@ -1294,9 +1290,7 @@ The {solr-javadocs}/solr-core/org/apache/solr/search/XmlQParserPlugin.html[XmlQP
The XmlQParser implementation uses the {solr-javadocs}/solr-core/org/apache/solr/search/SolrCoreParser.html[SolrCoreParser] class which extends Lucene's {lucene-javadocs}/queryparser/org/apache/lucene/queryparser/xml/CoreParser.html[CoreParser] class. XML elements are mapped to {lucene-javadocs}/queryparser/org/apache/lucene/queryparser/xml/QueryBuilder.html[QueryBuilder] classes as follows:
-// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
-
-[width="100%",cols="30,70",options="header"]
+[%autowidth.spread,width="100%",options="header"]
|===
|XML element |QueryBuilder class
|<BooleanQuery> |{lucene-javadocs}/queryparser/org/apache/lucene/queryparser/xml/builders/BooleanQueryBuilder.html[BooleanQueryBuilder]
diff --git a/solr/solr-ref-guide/src/overview-of-the-solr-admin-ui.adoc b/solr/solr-ref-guide/src/overview-of-the-solr-admin-ui.adoc
index 5f8ca6a..3764a23 100644
--- a/solr/solr-ref-guide/src/overview-of-the-solr-admin-ui.adoc
+++ b/solr/solr-ref-guide/src/overview-of-the-solr-admin-ui.adoc
@@ -68,9 +68,7 @@ image::images/getting-assistance/Assistance.png[image]
These icons include the following links.
-// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
-
-[cols="25,75",options="header"]
+[%autowidth.spread,width="100%",options="header"]
|===
|Link |Description
|Documentation |Navigates to the Apache Solr documentation hosted on https://lucene.apache.org/solr/.
diff --git a/solr/solr-ref-guide/src/performance-statistics-reference.adoc b/solr/solr-ref-guide/src/performance-statistics-reference.adoc
index ed8bae0..2e0ecd0 100644
--- a/solr/solr-ref-guide/src/performance-statistics-reference.adoc
+++ b/solr/solr-ref-guide/src/performance-statistics-reference.adoc
@@ -50,9 +50,7 @@ To get request times, specifically, you can send an API request such as:
* `\http://localhost:8983/solr/admin/metrics?group=core&prefix=UPDATE./update.requestTimes`
* `\http://localhost:8983/solr/admin/metrics?group=core&prefix=QUERY./select.requestTimes`
-// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
-
-[cols="25,75",options="header"]
+[%autowidth.spread,width="100%",options="header"]
|===
|Attribute |Description
|15minRate |Requests per second received over the past 15 minutes.
@@ -118,9 +116,7 @@ You can get all update handler statistics shown in the table below with an API r
The following describes the specific statistics you can get:
-// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
-
-[cols="40,60",options="header"]
+[%autowidth.spread,width="100%",options="header"]
|===
|Attribute |Description
|`UPDATE.updateHandler.adds` |Total number of “add” requests since last commit.
@@ -191,9 +187,7 @@ You can get the statistics shown in the table below with an API request such as
The following statistics are available for each of the caches mentioned above:
-// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
-
-[cols="25,75",options="header"]
+[%autowidth.spread,width="100%",options="header"]
|===
|Attribute |Description
|cumulative_evictions |Number of cache evictions across all caches since this node has been running.
diff --git a/solr/solr-ref-guide/src/query-re-ranking.adoc b/solr/solr-ref-guide/src/query-re-ranking.adoc
index c3d59d1..cc2a711 100644
--- a/solr/solr-ref-guide/src/query-re-ranking.adoc
+++ b/solr/solr-ref-guide/src/query-re-ranking.adoc
@@ -27,9 +27,7 @@ A Ranking query can be specified using the `rq` request parameter. The `rq` para
Three rank queries are currently included in the Solr distribution. You can also configure a custom {solr-javadocs}/solr-core/org/apache/solr/search/QParserPlugin.html[QParserPlugin] you have written, but most users can just use a parser provided with Solr.
-// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
-
-[cols="30,70",options="header"]
+[%autowidth.spread,width="100%",options="header"]
|===
|Parser |QParserPlugin class
|rerank |{solr-javadocs}/solr-core/org/apache/solr/search/ReRankQParserPlugin.html[ReRankQParserPlugin]
diff --git a/solr/solr-ref-guide/src/requesthandlers-and-searchcomponents-in-solrconfig.adoc b/solr/solr-ref-guide/src/requesthandlers-and-searchcomponents-in-solrconfig.adoc
index 52e2788..c1cfc74 100644
--- a/solr/solr-ref-guide/src/requesthandlers-and-searchcomponents-in-solrconfig.adoc
+++ b/solr/solr-ref-guide/src/requesthandlers-and-searchcomponents-in-solrconfig.adoc
@@ -113,9 +113,7 @@ Search components define the logic that is used by the SearchHandler to perform
There are several default search components that work with all SearchHandlers without any additional configuration. If no components are defined (with the exception of `first-components` and `last-components` - see below), these are executed by default, in the following order:
-// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
-
-[cols="20,40,40",options="header"]
+[%autowidth.spread,width="100%",options="header"]
|===
|Component Name |Class Name |More Information
|query |`solr.QueryComponent` |Described in the section <<query-syntax-and-parsing.adoc#query-syntax-and-parsing,Query Syntax and Parsing>>.