lucene-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ctarg...@apache.org
Subject [1/2] lucene-solr:branch_7_1: Ref Guide: Lots of grammar fixes: remove random spaces before commas, periods, colons; add missing periods at ends of sentences; add monospace for conf filenames and paths; correct "i.e." and "e.g." usages
Date Fri, 20 Oct 2017 20:10:07 GMT
Repository: lucene-solr
Updated Branches:
  refs/heads/branch_7_1 8bde1e33b -> 82fa8c011


http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/82fa8c01/solr/solr-ref-guide/src/transforming-result-documents.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/transforming-result-documents.adoc b/solr/solr-ref-guide/src/transforming-result-documents.adoc
index b5b1cff..7696d86 100644
--- a/solr/solr-ref-guide/src/transforming-result-documents.adoc
+++ b/solr/solr-ref-guide/src/transforming-result-documents.adoc
@@ -76,7 +76,7 @@ By default, values are returned as a String, but a "```t```" parameter can
be sp
 q=*:*&fl=id,my_number:[value v=42 t=int],my_string:[value v=42]
 ----
 
-In addition to using these request parameters, you can configure additional named instances
of ValueAugmenterFactory, or override the default behavior of the existing `[value]` transformer
in your solrconfig.xml file:
+In addition to using these request parameters, you can configure additional named instances
of ValueAugmenterFactory, or override the default behavior of the existing `[value]` transformer
in your `solrconfig.xml` file:
 
 [source,xml]
 ----
@@ -264,7 +264,7 @@ fl=...*,categories:[subquery]&categories.fl=*&categories.q=...
 
 ==== Subquery Parameters Shift
 
-If subquery is declared as `fl=*,foo:[subquery]`, subquery parameters are prefixed with the
given name and period. eg
+If a subquery is declared as `fl=*,foo:[subquery]`, subquery parameters are prefixed with
the given name and period. For example:
 
 `q=*:*&fl=*,**foo**:[subquery]&**foo.**q=to be continued&**foo.**rows=10&**foo.**sort=id
desc`
 
@@ -272,15 +272,15 @@ If subquery is declared as `fl=*,foo:[subquery]`, subquery parameters
are prefix
 
 It's necessary to pass some document field values as a parameter for subquery. It's supported
via implicit *`row.__fieldname__`* parameter, and can be (but might not only) referred via
Local Parameters syntax: `q=namne:john&fl=name,id,depts:[subquery]&depts.q={!terms
f=id **v=$row.dept_id**}&depts.rows=10`
 
-Here departmens are retrieved per every employee in search result. We can say that it's like
SQL `join ON emp.dept_id=dept.id`.
+Here departments are retrieved per every employee in search result. We can say that it's
like SQL `join ON emp.dept_id=dept.id`.
 
-Note, when document field has multiple values they are concatenated with comma by default,
it can be changed by local parameter `foo:[subquery separator=' ']` , this mimics *`{!terms}`*
to work smoothly with it.
+Note, when a document field has multiple values they are concatenated with a comma by default.
This can be changed with the local parameter `foo:[subquery separator=' ']`, this mimics *`{!terms}`*
to work smoothly with it.
 
 To log substituted subquery request parameters, add the corresponding parameter names, as
in `depts.logParamsList=q,fl,rows,**row.dept_id**`
 
 ==== Cores and Collections in SolrCloud
 
-Use `foo:[subquery fromIndex=departments]` to invoke subquery on another core on the same
node, it's what *`{!join}`* does for non-SolrCloud mode. But in case of SolrCloud just (and
only) explicitly specify its' native parameters like `collection, shards` for subquery, eg:
+Use `foo:[subquery fromIndex=departments]` to invoke subquery on another core on the same
node, it's what *`{!join}`* does for non-SolrCloud mode. But in case of SolrCloud just (and
only) explicitly specify its native parameters like `collection, shards` for subquery, e.g.:
 
 `q=*:*&fl=*,foo:[subquery]&foo.q=cloud&**foo.collection**=departments`
 

http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/82fa8c01/solr/solr-ref-guide/src/update-request-processors.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/update-request-processors.adoc b/solr/solr-ref-guide/src/update-request-processors.adoc
index 085ad42..7316caf 100644
--- a/solr/solr-ref-guide/src/update-request-processors.adoc
+++ b/solr/solr-ref-guide/src/update-request-processors.adoc
@@ -331,7 +331,7 @@ These factories all provide functionality to _modify_ fields in a document
as th
 
 {solr-javadocs}/solr-core/org/apache/solr/update/processor/RegexReplaceProcessorFactory.html[RegexReplaceProcessorFactory]::
An updated processor that applies a configured regex to any CharSequence values found in the
selected fields, and replaces any matches with the configured replacement string.
 
-{solr-javadocs}/solr-core/org/apache/solr/update/processor/RemoveBlankFieldUpdateProcessorFactory.html[RemoveBlankFieldUpdateProcessorFactory]::
Removes any values found which are CharSequence with a length of 0. (ie: empty strings).
+{solr-javadocs}/solr-core/org/apache/solr/update/processor/RemoveBlankFieldUpdateProcessorFactory.html[RemoveBlankFieldUpdateProcessorFactory]::
Removes any values found which are CharSequence with a length of 0 (i.e., empty strings).
 
 {solr-javadocs}/solr-core/org/apache/solr/update/processor/TrimFieldUpdateProcessorFactory.html[TrimFieldUpdateProcessorFactory]::
Trims leading and trailing whitespace from any CharSequence values found in fields matching
the specified conditions.
 

http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/82fa8c01/solr/solr-ref-guide/src/uploading-data-with-index-handlers.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/uploading-data-with-index-handlers.adoc b/solr/solr-ref-guide/src/uploading-data-with-index-handlers.adoc
index ff59d61..100a5bf 100644
--- a/solr/solr-ref-guide/src/uploading-data-with-index-handlers.adoc
+++ b/solr/solr-ref-guide/src/uploading-data-with-index-handlers.adoc
@@ -398,7 +398,7 @@ curl 'http://localhost:8983/solr/my_collection/update?commit=true' --data-binary
 
 === CSV Update Parameters
 
-The CSV handler allows the specification of many parameters in the URL in the form: `f._parameter_._optional_fieldname_=_value_`
.
+The CSV handler allows the specification of many parameters in the URL in the form: `f._parameter_._optional_fieldname_=_value_`.
 
 The table below describes the parameters for the update handler.
 

http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/82fa8c01/solr/solr-ref-guide/src/uploading-data-with-solr-cell-using-apache-tika.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/uploading-data-with-solr-cell-using-apache-tika.adoc
b/solr/solr-ref-guide/src/uploading-data-with-solr-cell-using-apache-tika.adoc
index 2b8c7de..5c870fd 100644
--- a/solr/solr-ref-guide/src/uploading-data-with-solr-cell-using-apache-tika.adoc
+++ b/solr/solr-ref-guide/src/uploading-data-with-solr-cell-using-apache-tika.adoc
@@ -77,7 +77,7 @@ You can also use `bin/post` to send a PDF file into Solr (without the params,
th
 bin/post -c techproducts example/exampledocs/solr-word.pdf -params "literal.id=a"
 ----
 
-Now you should be able to execute a query and find that document. You can make a request
like `\http://localhost:8983/solr/techproducts/select?q=pdf` .
+Now you should be able to execute a query and find that document. You can make a request
like `\http://localhost:8983/solr/techproducts/select?q=pdf`.
 
 You may notice that although the content of the sample document has been indexed and stored,
there are not a lot of metadata fields associated with this document. This is because unknown
fields are ignored according to the default parameters configured for the `/update/extract`
handler in `solrconfig.xml`, and this behavior can be easily changed or overridden. For example,
to store and see all metadata and content, execute the following:
 
@@ -208,7 +208,7 @@ The `tika.config` entry points to a file containing a Tika configuration.
The `d
 
 === Parser-Specific Properties
 
-Parsers used by Tika may have specific properties to govern how data is extracted. For instance,
when using the Tika library from a Java program, the PDFParserConfig class has a method setSortByPosition(boolean)
that can extract vertically oriented text. To access that method via configuration with the
ExtractingRequestHandler, one can add the parseContext.config property to the solrconfig.xml
file (see above) and then set properties in Tika's PDFParserConfig as below. Consult the Tika
Java API documentation for configuration parameters that can be set for any particular parsers
that require this level of control.
+Parsers used by Tika may have specific properties to govern how data is extracted. For instance,
when using the Tika library from a Java program, the PDFParserConfig class has a method `setSortByPosition(boolean)`
that can extract vertically oriented text. To access that method via configuration with the
ExtractingRequestHandler, one can add the `parseContext.config` property to the `solrconfig.xml`
file (see above) and then set properties in Tika's PDFParserConfig as below. Consult the Tika
Java API documentation for configuration parameters that can be set for any particular parsers
that require this level of control.
 
 [source,xml]
 ----

http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/82fa8c01/solr/solr-ref-guide/src/uploading-structured-data-store-data-with-the-data-import-handler.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/uploading-structured-data-store-data-with-the-data-import-handler.adoc
b/solr/solr-ref-guide/src/uploading-structured-data-store-data-with-the-data-import-handler.adoc
index 9c7de4a..405efa2 100644
--- a/solr/solr-ref-guide/src/uploading-structured-data-store-data-with-the-data-import-handler.adoc
+++ b/solr/solr-ref-guide/src/uploading-structured-data-store-data-with-the-data-import-handler.adoc
@@ -968,7 +968,7 @@ groupNames::
 A comma separated list of field column names, used where the regex contains groups and each
group is to be saved to a different field. If some groups are not to be named leave a space
between commas.
 
 replaceWith::
-Used along with regex . It is equivalent to the method `new String(<sourceColVal>).replaceAll(<regex>,
<replaceWith>)`.
+Used along with regex. It is equivalent to the method `new String(<sourceColVal>).replaceAll(<regex>,
<replaceWith>)`.
 
 Here is an example of configuring the regex transformer:
 

http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/82fa8c01/solr/solr-ref-guide/src/v2-api.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/v2-api.adoc b/solr/solr-ref-guide/src/v2-api.adoc
index dff6f4c..6cc1e4b 100644
--- a/solr/solr-ref-guide/src/v2-api.adoc
+++ b/solr/solr-ref-guide/src/v2-api.adoc
@@ -61,13 +61,13 @@ To limit the introspect output to include just one particular HTTP method,
add r
 
 `\http://localhost:8983/api/c/_introspect?method=POST`
 
-Most endpoints support commands provided in a body sent via POST. To limit the introspect
output to only one command, add request param `command=_command-name_` .
+Most endpoints support commands provided in a body sent via POST. To limit the introspect
output to only one command, add request param `command=_command-name_`.
 
 `\http://localhost:8983/api/c/gettingstarted/_introspect?method=POST&command=modify`
 
 === Interpreting the Introspect Output
 
-Example : `\http://localhost:8983/api/c/gettingstarted/get/_introspect`
+Example: `\http://localhost:8983/api/c/gettingstarted/get/_introspect`
 
 [source,json]
 ----
@@ -95,12 +95,12 @@ Example : `\http://localhost:8983/api/c/gettingstarted/get/_introspect`
 
 Description of some of the keys in the above example:
 
-* `**documentation**` : URL to the online Solr reference guide section for this API
-* `**description**` : A text description of the feature/variable/command etc.
-* `**spec/methods**` : HTTP methods supported by this API
-* `**spec/url/paths**` : URL paths supported by this API
-* `**spec/url/params**` : List of supported URL request params
-* `**availableSubPaths**` : List of valid URL subpaths and the HTTP method(s) each supports
+* `**documentation**`: URL to the online Solr reference guide section for this API
+* `**description**`: A text description of the feature/variable/command etc.
+* `**spec/methods**`: HTTP methods supported by this API
+* `**spec/url/paths**`: URL paths supported by this API
+* `**spec/url/params**`: List of supported URL request params
+* `**availableSubPaths**`: List of valid URL subpaths and the HTTP method(s) each supports
 
 Example of introspect for a POST API: `\http://localhost:8983/api/c/gettingstarted/_introspect?method=POST&command=modify`
 

http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/82fa8c01/solr/solr-ref-guide/src/velocity-response-writer.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/velocity-response-writer.adoc b/solr/solr-ref-guide/src/velocity-response-writer.adoc
index 0101030..fa94816 100644
--- a/solr/solr-ref-guide/src/velocity-response-writer.adoc
+++ b/solr/solr-ref-guide/src/velocity-response-writer.adoc
@@ -38,7 +38,7 @@ Its JAR and dependencies must be added (via `<lib>` or solr/home lib
inclusion),
 </queryResponseWriter>
 ----
 
-The above example shows the optional initialization and custom tool parameters used by VelocityResponseWriter;
these are detailed in the following table. These initialization parameters are only specified
in the writer registration in solrconfig.xml, not as request-time parameters. See further
below for request-time parameters.
+The above example shows the optional initialization and custom tool parameters used by VelocityResponseWriter;
these are detailed in the following table. These initialization parameters are only specified
in the writer registration in `solrconfig.xml`, not as request-time parameters. See further
below for request-time parameters.
 
 == Configuration & Usage
 

http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/82fa8c01/solr/solr-ref-guide/src/working-with-external-files-and-processes.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/working-with-external-files-and-processes.adoc b/solr/solr-ref-guide/src/working-with-external-files-and-processes.adoc
index eb0c4c0..20f0bdc 100644
--- a/solr/solr-ref-guide/src/working-with-external-files-and-processes.adoc
+++ b/solr/solr-ref-guide/src/working-with-external-files-and-processes.adoc
@@ -165,7 +165,7 @@ name ::= text
 value ::= text
 ----
 
-Special characters in "text" values can be escaped using the escape character `\` . The following
escape sequences are recognized:
+Special characters in "text" values can be escaped using the escape character `\`. The following
escape sequences are recognized:
 
 [width="60%",options="header",]
 |===


Mime
View raw message