Doc fixes (#910)

Author: thomascorthals

CHANGELOG.md

@@ -1,8 +1,8 @@
 # CHANGELOG
-All notable changes to the solarium library will be documented in this file.
+All notable changes to the Solarium library will be documented in this file.
 
-The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
-and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 
 ## [unreleased]
@@ -78,7 +78,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - \Solarium\Support\Utility::getXmlEncoding()
 
 ### Fixed
-- MoreLikeThis result parsing fails on Solr Cloud
+- MoreLikeThis result parsing fails on SolrCloud
 - MinimumScoreFilter plugin might fail on Solr 7 in cloud mode
 
 
@@ -168,7 +168,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [5.1.3]
 ### Fixed
-- Solarium\Component\ResponseParser\Debug fails on Solr Cloud 6.x during extracting timing phases
+- Solarium\Component\ResponseParser\Debug fails on SolrCloud 6.x during extracting timing phases
 
 
 ## [5.1.2]
@@ -415,7 +415,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [4.0.0-rc.1]
 ### Added
-- Basic support for Solr Cloud streaming expressions
+- Basic support for SolrCloud streaming expressions
 
 
 ## [4.0.0-beta.1]
@@ -430,7 +430,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - More integration tests
 
 ### Removed
-- Outdated symfony versions on test environment
+- Outdated Symfony versions on test environment
 
 ### Fixed
 - Don't escape the '*' in range queries

README.md

@@ -2,7 +2,7 @@
 
 ## What is Solarium?
 
-Solarium is a PHP Solr client library that accurately model Solr concepts. Where many other Solr libraries only handle
+Solarium is a PHP Solr client library that accurately models Solr concepts. Where many other Solr libraries only handle
 the communication with Solr, Solarium also relieves you of handling all the complex Solr query parameters using a
 well documented API.
 
@@ -12,8 +12,8 @@ Please see the [docs](http://solarium.readthedocs.io/en/stable/) for a more deta
 
 Solarium 6.x only supports PHP 7.2 and up.
 
-It's highly recommended to have Curl enabled in your PHP environment. However if you don't have Curl available you can
-switch from using Curl (the default) to a pure PHP based HTTP client adapter which works for the essential stuff but
+It's highly recommended to have cURL enabled in your PHP environment. However if you don't have cURL available you can
+switch from using cURL (the default) to a pure PHP based HTTP client adapter which works for the essential stuff but
 doesn't support things like parallel query execution.
 
 Alternatively you can inject any PSR-18 compatible HTTP Client using the `Psr18Adapter`.
@@ -34,7 +34,7 @@ Setting "timeout" as "option" in the HTTP Client Adapter is deprecated since Sol
 could handle it. The adapters which can handle it now implement the `TimeoutAwareInterface` and you need to set the
 timeout using the `setTimeout()` function after creating the adapter instance.
 
-In order to fix some issues with complex queries using local parameters solarium 6 destinguishs between query parameters
+In order to fix some issues with complex queries using local parameters Solarium 6 distinguishes between query parameters
 and local parameters to be embedded in a query. Solarium 5.2 already informed you about the deprecation of some
 parameter names which are in fact local parameters. Solarium doen't convert them magically anymore.
 Local parameter names now have to be prefixed with `local_` if set as option of a constructor.

docs/customizing-solarium.md

@@ -9,7 +9,7 @@ Solarium was designed to be highly customizable, in the following ways:
 What method of customization to use depends on your case:
 
 -   if you want to use only some parts of Solarium, but not modify it, go with method 1
--   if you want to customize solarium by altering/adding behaviour use the plugin structure. This has many advantages over extending:
+-   if you want to customize Solarium by altering/adding behaviour use the plugin structure. This has many advantages over extending:
     -   Plugins are easily reusable
     -   You can combine multiple plugins
     -   By leaving your Solarium library stock you can add plugins developed by others without issues
@@ -56,7 +56,7 @@ $response = $client->executeRequest($request);
 // and finally you can convert the response into a result
 $result = $client->createResult($query, $response);
 
-// display the total number of documents found by solr
+// display the total number of documents found by Solr
 echo 'NumFound: '.$result->getNumFound();
 
 // show documents using the resultset iterator

docs/documents.md

@@ -45,7 +45,7 @@ $query = $client->createQuery($client::QUERY_SELECT);
 // this executes the query and returns the result
 $resultset = $client->execute($query);
 
-// display the total number of documents found by solr
+// display the total number of documents found by Solr
 echo 'NumFound: '.$resultset->getNumFound();
 
 // show documents using the resultset iterator
@@ -167,7 +167,7 @@ $query->createFilterQuery('newprice')->setQuery('price:374');
 // this executes the query and returns the result
 $resultset = $client->select($query);
 
-// display the total number of documents found by solr
+// display the total number of documents found by Solr
 echo '<hr/>NumFound: '.$resultset->getNumFound();
 
 // show documents using the resultset iterator

docs/exceptions.md

@@ -128,4 +128,4 @@ This exception indicates that a problem occurred in the communication with the S
 
 #### `StreamException`
 
-This exception indicates that a problem occurred with a streaming expression. You should catch this (or a more generic exception) for every streaming exception request that is executed.
+This exception indicates that a problem occurred with a streaming expression. You should catch this (or a more generic exception) for every streaming expression request that is executed.

docs/getting-started.md

@@ -11,7 +11,7 @@ Installation
 
 For installing Solarium a minimal PHP version 7.2 is required.
 
-There is no Solr version requirement. But it's highly recommended that you use at least 7.7. All older version are EOL.
+There is no Solr version requirement. But it's highly recommended that you use at least 7.7. All older versions are EOL.
 
 ### Getting Solarium
 
@@ -51,7 +51,7 @@ To check your installation you can do a Solarium version check with the followin
 require_once(__DIR__.'/init.php');
 htmlHeader();
 
-// check solarium version available
+// check Solarium version available
 echo 'Solarium library version: ' . Solarium\Client::VERSION . ' - ';
 
 // create a client instance
@@ -115,7 +115,7 @@ If you know of any other integrations please let it know!
 Basic usage
 ===========
 
-All the code display below can be found in the /examples dir of the project, where you can also easily execute the code. For more info see [Example code](V3:Example_code "wikilink").
+All the code displayed below can be found in the /examples dir of the project, where you can also easily execute the code. For more info see [Example code](V3:Example_code "wikilink").
 
 All the examples use the init.php file. This file registers the Solarium autoloader, sets up a client adapter and event dispatcher, and also loads the `$config` array for use in the client constructor.
 
@@ -140,7 +140,7 @@ $config = array(
             'port' => 8983,
             'path' => '/',
             'core' => 'techproducts',
-            // For Solr Cloud you need to provide a collection instead of core:
+            // For SolrCloud you need to provide a collection instead of core:
             // 'collection' => 'techproducts',
         )
     )
@@ -166,7 +166,7 @@ $query = $client->createQuery($client::QUERY_SELECT);
 // this executes the query and returns the result
 $resultset = $client->execute($query);
 
-// display the total number of documents found by solr
+// display the total number of documents found by Solr
 echo 'NumFound: '.$resultset->getNumFound();
 
 // show documents using the resultset iterator
@@ -218,7 +218,7 @@ $facetSet->createFacetField('stock')->setField('inStock');
 // this executes the query and returns the result
 $resultset = $client->select($query);
 
-// display the total number of documents found by solr
+// display the total number of documents found by Solr
 echo 'NumFound: '.$resultset->getNumFound();
 
 // display facet counts
@@ -273,7 +273,7 @@ htmlFooter();
 
 ```
 
-Or by id 
+Or by id: 
 
 ```php
 <?php
@@ -354,7 +354,7 @@ Example code
 ============
 
 With Solarium a set of examples is available to demonstrate the usage and to test your Solr environment. But since the
-examples are not included in the distribution you need a git checkout of solarium and install the dependencies:
+examples are not included in the distribution you need a git checkout of Solarium and install the dependencies:
 ```
 git clone https://github.com/solariumphp/solarium.git
 cd solarium

docs/plugins.md

@@ -145,16 +145,16 @@ $customizer->createCustomization('id')
 // create a basic query to execute
 $query = $client->createSelect();
 
-// execute query (you should be able to see the extra params in the solr log file)
+// execute query (you should be able to see the extra params in the Solr log file)
 $resultset = $client->select($query);
 
-// display the total number of documents found by solr
+// display the total number of documents found by Solr
 echo 'NumFound: '.$resultset->getNumFound() . '<br/>';
 
 // execute the same query again (this time the 'id' param should no longer show up in the logs)
 $resultset = $client->select($query);
 
-// display the total number of documents found by solr
+// display the total number of documents found by Solr
 echo 'NumFound: '.$resultset->getNumFound();
 
 htmlFooter();
@@ -212,7 +212,7 @@ for ($i = 1; $i <= 8; $i++) {
     echo 'Server: ' . $loadbalancer->getLastEndpoint() .'<hr/>';
 }
 
-// force a server for a query (normally solr 3 is extremely unlikely based on its weight)
+// force a server for a query (normally 'local3' is extremely unlikely based on its weight)
 $loadbalancer->setForcedEndpointForNextQuery('local3');
 
 $resultset = $client->select($query);
@@ -275,7 +275,7 @@ $query->setFilterMode($query::FILTER_MODE_MARK);
 // this executes the query and returns the result
 $resultset = $client->execute($query);
 
-// display the total number of documents found by solr and the maximum score
+// display the total number of documents found by Solr and the maximum score
 echo 'NumFound: '.$resultset->getNumFound();
 echo '<br/>MaxScore: '.$resultset->getMaxScore();
 
@@ -377,7 +377,7 @@ htmlFooter();
 
 // Note: for this example on a default Solr index (with a tiny index) running on localhost the performance gain is
 // minimal to none, sometimes even slightly slower!
-// In a realworld scenario with network latency, a bigger dataset, more complex queries or multiple solr instances the
+// In a realworld scenario with network latency, a bigger dataset, more complex queries or multiple Solr instances the
 // performance gain is much more.
 
 ```
@@ -422,7 +422,7 @@ $query->createFilterQuery('fq')->setQuery($fq);
 // without the plugin this query would fail as it is bigger than the default servlet container header buffer
 $resultset = $client->select($query);
 
-// display the total number of documents found by solr
+// display the total number of documents found by Solr
 echo 'NumFound: '.$resultset->getNumFound();
 
 // show documents using the resultset iterator
@@ -481,7 +481,7 @@ $prefetch = $client->getPlugin('prefetchiterator');
 $prefetch->setPrefetch(2); //fetch 2 rows per query (for real world use this can be way higher)
 $prefetch->setQuery($query);
 
-// display the total number of documents found by solr
+// display the total number of documents found by Solr
 echo 'NumFound: ' . count($prefetch);
 
 // show document IDs using the resultset iterator

docs/queries/morelikethis-query.md

@@ -41,7 +41,7 @@ Use the `moreLikeThis` method of the client to execute the query object. See the
 Result of a MLT query
 ---------------------
 
-The result of a mlt query shares the features of the select query result. On top of that the following is added:
+The result of a MLT query shares the features of the select query result. On top of that the following is added:
 
 ### Interestingterms
 
@@ -76,7 +76,7 @@ $query->createFilterQuery('stock')->setQuery('inStock:true');
 $query->setInterestingTerms('details');
 $query->setMatchInclude(true);
 
-// enable mlt component
+// enable MLT component
 $mlt = $query->getMoreLikeThis();
 $mlt->setCount(10);
 
@@ -94,7 +94,7 @@ foreach ($resultset->getMatch() as $field => $value) {
 }
 echo '</table><hr/>';
 
-// display the total number of MLT documents found by solr
+// display the total number of MLT documents found by Solr
 echo 'Number of MLT matches found: '.$resultset->getNumFound().'<br/><br/>';
 echo '<b>Listing of matched docs:</b>';
 

docs/queries/ping-query.md

@@ -35,7 +35,7 @@ Example
 require_once(__DIR__.'/init.php');
 htmlHeader();
 
-// check solarium version available
+// check Solarium version available
 echo 'Solarium library version: ' . Solarium\Client::VERSION . ' - ';
 
 // create a client instance

docs/queries/query-helper/escaping.md

@@ -25,7 +25,7 @@ $query->setQuery('features:' . $helper->escapePhrase($input));
 // this executes the query and returns the result
 $resultset = $client->select($query);
 
-// display the total number of documents found by solr
+// display the total number of documents found by Solr
 echo 'NumFound: '.$resultset->getNumFound();
 
 // show documents using the resultset iterator