You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by ct...@apache.org on 2017/05/09 13:21:04 UTC
lucene-solr:jira/solr-10290: SOLR-10296: conversion, table cleanups
Repository: lucene-solr
Updated Branches:
refs/heads/jira/solr-10290 4a0b9b539 -> 029b600d0
SOLR-10296: conversion, table cleanups
Project: http://git-wip-us.apache.org/repos/asf/lucene-solr/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucene-solr/commit/029b600d
Tree: http://git-wip-us.apache.org/repos/asf/lucene-solr/tree/029b600d
Diff: http://git-wip-us.apache.org/repos/asf/lucene-solr/diff/029b600d
Branch: refs/heads/jira/solr-10290
Commit: 029b600d0c21ee140f5a8383c4dc7afe105e107e
Parents: 4a0b9b5
Author: Cassandra Targett <ct...@apache.org>
Authored: Tue May 9 08:20:45 2017 -0500
Committer: Cassandra Targett <ct...@apache.org>
Committed: Tue May 9 08:20:45 2017 -0500
----------------------------------------------------------------------
solr/solr-ref-guide/src/coreadmin-api.adoc | 40 ++++++++++++++-----
.../src/defining-core-properties.adoc | 4 +-
.../field-type-definitions-and-properties.adoc | 6 +--
.../field-type-definitions-and-properties.pdf | Bin 0 -> 142177 bytes
solr/solr-ref-guide/src/format-of-solr-xml.adoc | 20 +++++++---
.../src/implicit-requesthandlers.adoc | 4 +-
.../src/indexconfig-in-solrconfig.adoc | 4 +-
.../src/initparams-in-solrconfig.adoc | 5 +--
solr/solr-ref-guide/src/managed-resources.adoc | 12 ++++--
.../src/requestdispatcher-in-solrconfig.adoc | 4 +-
...lers-and-searchcomponents-in-solrconfig.adoc | 4 +-
.../src/updatehandlers-in-solrconfig.adoc | 12 ++++--
12 files changed, 82 insertions(+), 33 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/029b600d/solr/solr-ref-guide/src/coreadmin-api.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/coreadmin-api.adoc b/solr/solr-ref-guide/src/coreadmin-api.adoc
index 0d59396..4cd7147 100644
--- a/solr/solr-ref-guide/src/coreadmin-api.adoc
+++ b/solr/solr-ref-guide/src/coreadmin-api.adoc
@@ -24,7 +24,9 @@ The `STATUS` action returns the status of all running Solr cores, or status for
*Query Parameters*
-[width="100%",options="header",]
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+
+[cols="15,10,10,10,55",options="header"]
|===
|Parameter |Type |Required |Default |Description
|core |string |No | |The name of a core, as listed in the "name" attribute of a `<core>` element in `solr.xml`.
@@ -65,7 +67,9 @@ The core.properties file is built as part of the CREATE command. If you create a
*Query Parameters*
-[width="100%",options="header",]
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+
+[cols="15,10,10,10,55",options="header"]
|===
|Parameter |Type |Required |Default |Description
|name |string |Yes |N/A |The name of the new core. Same as "name" on the `<core>` element.
@@ -111,7 +115,9 @@ RELOAD performs "live" reloads of SolrCore, reusing some existing objects. Some
*Query Parameters*
-[width="100%",options="header",]
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+
+[cols="15,10,10,10,55",options="header"]
|===
|Parameter |Type |Required |Default |Description
|core |string |Yes |N/A |The name of the core, as listed in the "name" attribute of a `<core>` element in `solr.xml`.
@@ -129,7 +135,9 @@ The `RENAME` action changes the name of a Solr core.
**Query Parameters**
-[width="100%",options="header",]
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+
+[cols="15,10,10,10,55",options="header"]
|===
|Parameter |Type |Required |Default |Description
|core |string |Yes | |The name of the Solr core to be renamed.
@@ -156,7 +164,9 @@ Do not use `SWAP` with a SolrCloud node. It is not supported and can result in t
*Query Parameters*
-[width="100%",options="header",]
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+
+[cols="15,10,10,10,55",options="header"]
|===
|Parameter |Type |Required |Default |Description
|core |string |Yes | |The name of one of the cores to be swapped.
@@ -183,7 +193,9 @@ Unloading all cores in a SolrCloud collection causes the removal of that collect
*Query Parameters*
-[width="100%",options="header",]
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+
+[cols="15,10,10,10,55",options="header"]
|===
|Parameter |Type |Required |Default |Description
|core |string |Yes | |The name of one of the cores to be removed.
@@ -215,7 +227,9 @@ We can make this call run asynchronously by specifying the `async` parameter and
*Query Parameters*
-[width="100%",options="header",]
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+
+[cols="15,10,10,10,55",options="header"]
|===
|Parameter |Type |Required |Default |Description
|core |string |Yes | |The name of the target core/index.
@@ -236,7 +250,9 @@ The `SPLIT` action supports five parameters, which are described in the table be
*Query Parameters*
-[width="100%",options="header",]
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+
+[cols="15,10,10,10,55",options="header"]
|===
|Parameter |Type |Required |Default |Description
|core |string |Yes | |The name of the core to be split.
@@ -297,7 +313,9 @@ Request the status of an already submitted asynchronous CoreAdmin API call.
*Query Parameters*
-[width="100%",options="header",]
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+
+[cols="15,10,10,10,55",options="header"]
|===
|Parameter |Type |Required |Default |Description
|requestid |string |Yes | |The user defined request-id for the Asynchronous request.
@@ -319,7 +337,9 @@ The `REQUESTRECOVERY` action manually asks a core to recover by synching with th
*Query Parameters*
-[width="100%",options="header",]
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+
+[cols="15,10,10,10,55",options="header"]
|===
|Parameter |Type |Required |Default |Description
|core |string |Yes | |The name of the core to re-sync.
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/029b600d/solr/solr-ref-guide/src/defining-core-properties.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/defining-core-properties.adoc b/solr/solr-ref-guide/src/defining-core-properties.adoc
index 7dedc30..81d3947 100644
--- a/solr/solr-ref-guide/src/defining-core-properties.adoc
+++ b/solr/solr-ref-guide/src/defining-core-properties.adoc
@@ -56,7 +56,9 @@ Java properties files allow the hash (`#`) or bang (`!`) characters to specify c
This table defines the recognized properties:
-[width="100%",options="header",]
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+
+[cols="25,75",options="header"]
|===
|Property |Description
|`name` |The name of the SolrCore. You'll use this name to reference the SolrCore when running commands with the CoreAdminHandler.
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/029b600d/solr/solr-ref-guide/src/field-type-definitions-and-properties.adoc
----------------------------------------------------------------------
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 78f7ef7..5454b8f 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
@@ -22,10 +22,10 @@ Field types are defined in `schema.xml`. Each field type is defined between `fie
// - https://github.com/asciidoctor/asciidoctor-pdf/issues/409
// - https://github.com/asciidoctor/asciidoctor-pdf/issues/377
// - https://github.com/asciidoctor/asciidoctor-pdf/issues/133
-[source,xml]
+[source,xml,subs="verbatim,callouts"]
----
-<fieldType name="text_general" class="solr.TextField" positionIncrementGap="100"> <!--1-->
- <analyzer type="index"> <!--2-->
+<fieldType name="text_general" class="solr.TextField" positionIncrementGap="100"> --<1>
+ <analyzer type="index"> --<2>
<tokenizer class="solr.StandardTokenizerFactory"/>
<filter class="solr.StopFilterFactory" ignoreCase="true" words="stopwords.txt" />
<!-- in this example, we will only use synonyms at query time
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/029b600d/solr/solr-ref-guide/src/field-type-definitions-and-properties.pdf
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/field-type-definitions-and-properties.pdf b/solr/solr-ref-guide/src/field-type-definitions-and-properties.pdf
new file mode 100644
index 0000000..0134eac
Binary files /dev/null and b/solr/solr-ref-guide/src/field-type-definitions-and-properties.pdf differ
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/029b600d/solr/solr-ref-guide/src/format-of-solr-xml.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/format-of-solr-xml.adoc b/solr/solr-ref-guide/src/format-of-solr-xml.adoc
index b0cdf24..6483ce1 100644
--- a/solr/solr-ref-guide/src/format-of-solr-xml.adoc
+++ b/solr/solr-ref-guide/src/format-of-solr-xml.adoc
@@ -41,9 +41,9 @@ As you can see, the discovery Solr configuration is "SolrCloud friendly". Howeve
There are no attributes that you can specify in the `<solr>` tag, which is the root element of `solr.xml`. The tables below list the child nodes of each XML element in `solr.xml`.
-// TODO: This table has cells that won't work with PDF: https://github.com/ctargett/refguide-asciidoc-poc/issues/13
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
-[width="100%",options="header",]
+[cols="30,70",options="header"]
|===
|Node |Description
|`adminHandler` |If used, this attribute should be set to the FQN (Fully qualified name) of a class that inherits from CoreAdminHandler. For example, `<str name="adminHandler">com.myorg.MyAdminHandler</str>` would configure the custom admin handler (MyAdminHandler) to handle admin requests. If this attribute isn't set, Solr uses the default admin handler, `org.apache.solr.handler.admin.CoreAdminHandler`. For more information on this parameter, see the Solr Wiki at http://wiki.apache.org/solr/CoreAdmin#cores.
@@ -62,7 +62,9 @@ There are no attributes that you can specify in the `<solr>` tag, which is the r
This element defines several parameters that relate so SolrCloud. This section is ignored unless the solr instance is started with either `-DzkRun` or `-DzkHost`
-[width="100%",options="header",]
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+
+[cols="30,70",options="header"]
|===
|Node |Description
|`distribUpdateConnTimeout` |Used to set the underlying "connTimeout" for intra-cluster updates.
@@ -80,7 +82,9 @@ This element defines several parameters that relate so SolrCloud. This section i
==== The `<logging>` element
-[width="100%",options="header",]
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+
+[cols="30,70",options="header"]
|===
|Node |Description
|`class` |The class to use for logging. The corresponding JAR file must be available to solr, perhaps through a `<lib>` directive in solrconfig.xml.
@@ -89,7 +93,9 @@ This element defines several parameters that relate so SolrCloud. This section i
===== The `<logging><watcher>` element
-[width="100%",options="header",]
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+
+[cols="30,70",options="header"]
|===
|Node |Description
|`size` |The number of log events that are buffered.
@@ -107,7 +113,9 @@ Custom shard handlers can be defined in `solr.xml` if you wish to create a custo
Since this is a custom shard handler, sub-elements are specific to the implementation. The default and only shard handler provided by Solr is the HttpShardHandlerFactory in which case, the following sub-elements can be specified:
-[cols=",",options="header",]
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+
+[cols="30,70",options="header"]
|===
|Node |Description
|`socketTimeout` |The read timeout for intra-cluster query and administrative requests. The default is the same as the distribUpdateSoTimeout specified in the solrcloud section.
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/029b600d/solr/solr-ref-guide/src/implicit-requesthandlers.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/implicit-requesthandlers.adoc b/solr/solr-ref-guide/src/implicit-requesthandlers.adoc
index 74cea37..46e339a 100644
--- a/solr/solr-ref-guide/src/implicit-requesthandlers.adoc
+++ b/solr/solr-ref-guide/src/implicit-requesthandlers.adoc
@@ -7,7 +7,9 @@ Solr ships with many out-of-the-box RequestHandlers, which are called implicit b
[[ImplicitRequestHandlers-ListofImplicitlyAvailableEndpoints]]
== List of Implicitly Available Endpoints
-[cols=",,,",options="header",]
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+
+[cols="15,20,15,50",options="header"]
|===
|Endpoint |Request Handler class |Paramset |Description
|`/admin/file` |{solr-javadocs}/solr-core/org/apache/solr/handler/admin/ShowFileRequestHandler.html[ShowFileRequestHandler] |`_ADMIN_FILE` |Returns content of files in `${solr.home}` `/conf/`.
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/029b600d/solr/solr-ref-guide/src/indexconfig-in-solrconfig.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/indexconfig-in-solrconfig.adoc b/solr/solr-ref-guide/src/indexconfig-in-solrconfig.adoc
index f77909c..97fe220 100644
--- a/solr/solr-ref-guide/src/indexconfig-in-solrconfig.adoc
+++ b/solr/solr-ref-guide/src/indexconfig-in-solrconfig.adoc
@@ -176,7 +176,9 @@ The maximum time to wait for a write lock on an IndexWriter. The default is 1000
There are a few other parameters that may be important to configure for your implementation. These settings affect how or when updates are made to an index.
-[width="100%",options="header",]
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+
+[cols="30,70",options="header"]
|===
|Setting |Description
|reopenReaders |Controls if IndexReaders will be re-opened, instead of closed and then opened, which is often less efficient. The default is true.
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/029b600d/solr/solr-ref-guide/src/initparams-in-solrconfig.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/initparams-in-solrconfig.adoc b/solr/solr-ref-guide/src/initparams-in-solrconfig.adoc
index 7e0492a..5423801 100644
--- a/solr/solr-ref-guide/src/initparams-in-solrconfig.adoc
+++ b/solr/solr-ref-guide/src/initparams-in-solrconfig.adoc
@@ -28,9 +28,9 @@ This sets the default search field ("df") to be "_text_" for all of the request
The syntax and semantics are similar to that of a `<requestHandler>` . The following are the attributes
-// TODO: This table has cells that won't work with PDF: https://github.com/ctargett/refguide-asciidoc-poc/issues/13
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
-[width="100%",options="header",]
+[cols="30,70",options="header"]
|===
|Property |Description
|path |A comma-separated list of paths which will use the parameters. Wildcards can be used in paths to define nested paths, as described below.
@@ -43,7 +43,6 @@ For example, if an `<initParams>` section has the name "myParams", you can call
----
<requestHandler name="/dump1" class="DumpRequestHandler" initParams="myParams"/>
----
-
|===
[[InitParamsinSolrConfig-Wildcards]]
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/029b600d/solr/solr-ref-guide/src/managed-resources.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/managed-resources.adoc b/solr/solr-ref-guide/src/managed-resources.adoc
index 732c873..530853c 100644
--- a/solr/solr-ref-guide/src/managed-resources.adoc
+++ b/solr/solr-ref-guide/src/managed-resources.adoc
@@ -27,13 +27,19 @@ Let's begin learning about managed resources by looking at a couple of examples
To begin, you need to define a field type that uses the <<filter-descriptions.adoc#FilterDescriptions-ManagedStopFilter,ManagedStopFilterFactory>>, such as:
-[source,xml]
+// TODO callout isn't working in the PDF...
+// http://asciidoctor.org/docs/user-manual/#xml-callouts
+// TODO: relevant github issues w/possible font related work arounds...
+// - https://github.com/asciidoctor/asciidoctor-pdf/issues/409
+// - https://github.com/asciidoctor/asciidoctor-pdf/issues/377
+// - https://github.com/asciidoctor/asciidoctor-pdf/issues/133
+[source,xml,subs="verbatim,callouts"]
----
<fieldType name="managed_en" positionIncrementGap="100">
<analyzer>
<tokenizer class="solr.StandardTokenizerFactory"/>
- <filter class="solr.ManagedStopFilterFactory" <1>
- managed="english" /> <2>
+ <filter class="solr.ManagedStopFilterFactory" <!--1-->
+ managed="english" /> <!--2-->
</analyzer>
</fieldType>
----
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/029b600d/solr/solr-ref-guide/src/requestdispatcher-in-solrconfig.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/requestdispatcher-in-solrconfig.adoc b/solr/solr-ref-guide/src/requestdispatcher-in-solrconfig.adoc
index e8064b7..44ef0b1 100644
--- a/solr/solr-ref-guide/src/requestdispatcher-in-solrconfig.adoc
+++ b/solr/solr-ref-guide/src/requestdispatcher-in-solrconfig.adoc
@@ -55,7 +55,9 @@ The `<httpCaching>` element controls HTTP cache control headers. Do not confuse
This element allows for three attributes and one sub-element. The attributes of the `<httpCaching>` element control whether a 304 response to a GET request is allowed, and if so, what sort of response it should be. When an HTTP client application issues a GET, it may optionally specify that a 304 response is acceptable if the resource has not been modified since the last time it was fetched.
-[width="100%",options="header",]
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+
+[cols="20,80",options="header"]
|===
|Parameter |Description
|never304 |If present with the value `true`, then a GET request will never respond with a 304 code, even if the requested resource has not been modified. When this attribute is set to true, the next two attributes are ignored. Setting this to true is handy for development, as the 304 response can be confusing when tinkering with Solr responses through a web browser or other client that supports cache headers.
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/029b600d/solr/solr-ref-guide/src/requesthandlers-and-searchcomponents-in-solrconfig.adoc
----------------------------------------------------------------------
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 f01ac7e..380e2c5 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
@@ -106,7 +106,9 @@ 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:
-[width="100%",options="header",]
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+
+[cols="20,40,40",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>>.
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/029b600d/solr/solr-ref-guide/src/updatehandlers-in-solrconfig.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/updatehandlers-in-solrconfig.adoc b/solr/solr-ref-guide/src/updatehandlers-in-solrconfig.adoc
index 41b0830..fb3f2cf 100644
--- a/solr/solr-ref-guide/src/updatehandlers-in-solrconfig.adoc
+++ b/solr/solr-ref-guide/src/updatehandlers-in-solrconfig.adoc
@@ -30,7 +30,9 @@ For more information about Near Real Time operations, see <<near-real-time-searc
These settings control how often pending updates will be automatically pushed to the index. An alternative to `autoCommit` is to use `commitWithin`, which can be defined when making the update request to Solr (i.e., when pushing documents), or in an update RequestHandler.
-[width="100%",options="header",]
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+
+[cols="30,70",options="header"]
|===
|Setting |Description
|maxDocs |The number of updates that have occurred since the last commit.
@@ -81,7 +83,9 @@ The UpdateHandler section is also where update-related event listeners can be co
Users can write custom update event listener classes, but a common use case is to run external executables via the `RunExecutableListener`:
-[width="100%",options="header",]
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+
+[cols="30,70",options="header"]
|===
|Setting |Description
|exe |The name of the executable to run. It should include the path to the file, relative to Solr home.
@@ -107,7 +111,9 @@ Realtime Get currently relies on the update log feature, which is enabled by def
Three additional expert-level configuration settings affect indexing performance and how far a replica can fall behind on updates before it must enter into full recovery - see the section on <<read-and-write-side-fault-tolerance.adoc#ReadandWriteSideFaultTolerance-WriteSideFaultTolerance,write side fault tolerance>> for more information:
-[width="100%",options="header",]
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+
+[cols="20,10,10,60",options="header"]
|===
|Setting Name |Type |Default |Description
|numRecordsToKeep |int |100 |The number of update records to keep per log