You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by ho...@apache.org on 2017/06/14 02:02:49 UTC
[13/35] lucene-solr:jira/SOLR-10834: SOLR-10871: remove backticks for
monospace type in headings
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/0411504d/solr/solr-ref-guide/src/the-dismax-query-parser.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/the-dismax-query-parser.adoc b/solr/solr-ref-guide/src/the-dismax-query-parser.adoc
index ea250b1..d624d7c 100644
--- a/solr/solr-ref-guide/src/the-dismax-query-parser.adoc
+++ b/solr/solr-ref-guide/src/the-dismax-query-parser.adoc
@@ -58,7 +58,7 @@ In addition to the common request parameter, highlighting parameters, and simple
The sections below explain these parameters in detail.
[[TheDisMaxQueryParser-TheqParameter]]
-=== The `q` Parameter
+=== The q Parameter
The `q` parameter defines the main "query" constituting the essence of the search. The parameter supports raw input strings provided by users with no special escaping. The + and - characters are treated as "mandatory" and "prohibited" modifiers for terms. Text wrapped in balanced quote characters (for example, "San Jose") is treated as a phrase. Any query containing an odd number of quote characters is evaluated as if there were no quote characters at all.
@@ -70,13 +70,13 @@ The `q` parameter does not support wildcard characters such as *.
====
[[TheDisMaxQueryParser-Theq.altParameter]]
-=== The `q.alt` Parameter
+=== The q.alt Parameter
If specified, the `q.alt` parameter defines a query (which by default will be parsed using standard query parsing syntax) when the main q parameter is not specified or is blank. The `q.alt` parameter comes in handy when you need something like a query to match all documents (don't forget `&rows=0` for that one!) in order to get collection-wide faceting counts.
[[TheDisMaxQueryParser-Theqf_QueryFields_Parameter]]
-=== The `qf` (Query Fields) Parameter
+=== The qf (Query Fields) Parameter
The `qf` parameter introduces a list of fields, each of which is assigned a boost factor to increase or decrease that particular field's importance in the query. For example, the query below:
@@ -86,7 +86,7 @@ assigns `fieldOne` a boost of 2.3, leaves `fieldTwo` with the default boost (bec
[[TheDisMaxQueryParser-Themm_MinimumShouldMatch_Parameter]]
-=== The `mm` (Minimum Should Match) Parameter
+=== The mm (Minimum Should Match) Parameter
When processing queries, Lucene/Solr recognizes three types of clauses: mandatory, prohibited, and "optional" (also known as "should" clauses). By default, all words or phrases specified in the `q` parameter are treated as "optional" clauses unless they are preceded by a "+" or a "-". When dealing with these "optional" clauses, the `mm` parameter makes it possible to say that a certain minimum number of those clauses must match. The DisMax query parser offers great flexibility in how the minimum number can be specified.
@@ -116,7 +116,7 @@ The default value of `mm` is 100% (meaning that all clauses must match).
[[TheDisMaxQueryParser-Thepf_PhraseFields_Parameter]]
-=== The `pf` (Phrase Fields) Parameter
+=== The pf (Phrase Fields) Parameter
Once the list of matching documents has been identified using the `fq` and `qf` parameters, the `pf` parameter can be used to "boost" the score of documents in cases where all of the terms in the q parameter appear in close proximity.
@@ -124,19 +124,19 @@ The format is the same as that used by the `qf` parameter: a list of fields and
[[TheDisMaxQueryParser-Theps_PhraseSlop_Parameter]]
-=== The `ps` (Phrase Slop) Parameter
+=== The ps (Phrase Slop) Parameter
The `ps` parameter specifies the amount of "phrase slop" to apply to queries specified with the pf parameter. Phrase slop is the number of positions one token needs to be moved in relation to another token in order to match a phrase specified in a query.
[[TheDisMaxQueryParser-Theqs_QueryPhraseSlop_Parameter]]
-=== The `qs` (Query Phrase Slop) Parameter
+=== The qs (Query Phrase Slop) Parameter
The `qs` parameter specifies the amount of slop permitted on phrase queries explicitly included in the user's query string with the `qf` parameter. As explained above, slop refers to the number of positions one token needs to be moved in relation to another token in order to match a phrase specified in a query.
[[TheDisMaxQueryParser-Thetie_TieBreaker_Parameter]]
-=== The `tie` (Tie Breaker) Parameter
+=== The tie (Tie Breaker) Parameter
The `tie` parameter specifies a float value (which should be something much less than 1) to use as tiebreaker in DisMax queries.
@@ -146,7 +146,7 @@ A value of "0.0" - the default - makes the query a pure "disjunction max query":
[[TheDisMaxQueryParser-Thebq_BoostQuery_Parameter]]
-=== The `bq` (Boost Query) Parameter
+=== The bq (Boost Query) Parameter
The `bq` parameter specifies an additional, optional, query clause that will be added to the user's main query to influence the score. For example, if you wanted to add a relevancy boost for recent documents:
@@ -160,7 +160,7 @@ You can specify multiple `bq` parameters. If you want your query to be parsed as
[[TheDisMaxQueryParser-Thebf_BoostFunctions_Parameter]]
-=== The `bf` (Boost Functions) Parameter
+=== The bf (Boost Functions) Parameter
The `bf` parameter specifies functions (with optional boosts) that will be used to construct FunctionQueries which will be added to the user's main query as optional clauses that will influence the score. Any function supported natively by Solr can be used, along with a boost value. For example:
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/0411504d/solr/solr-ref-guide/src/the-extended-dismax-query-parser.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/the-extended-dismax-query-parser.adoc b/solr/solr-ref-guide/src/the-extended-dismax-query-parser.adoc
index fff5909..c0fdcae 100644
--- a/solr/solr-ref-guide/src/the-extended-dismax-query-parser.adoc
+++ b/solr/solr-ref-guide/src/the-extended-dismax-query-parser.adoc
@@ -39,64 +39,64 @@ In addition to supporting all the DisMax query parser parameters, Extended Disma
In addition to all the <<the-dismax-query-parser.adoc#TheDisMaxQueryParser-DisMaxParameters,DisMax parameters>>, Extended DisMax includes these query parameters:
[[TheExtendedDisMaxQueryParser-ThesowParameter]]
-=== The `sow` Parameter
+=== The sow Parameter
Split on whitespace: if set to `false`, whitespace-separated term sequences will be provided to text analysis in one shot, enabling proper function of analysis filters that operate over term sequences, e.g. multi-word synonyms and shingles. Defaults to `true`: text analysis is invoked separately for each individual whitespace-separated term.
[[TheExtendedDisMaxQueryParser-Themm.autoRelaxParameter]]
-=== The `mm.autoRelax` Parameter
+=== The mm.autoRelax Parameter
If true, the number of clauses required (<<the-dismax-query-parser.adoc#TheDisMaxQueryParser-Themm_MinimumShouldMatch_Parameter,minimum should match>>) will automatically be relaxed if a clause is removed (by e.g. stopwords filter) from some but not all <<the-dismax-query-parser.adoc#TheDisMaxQueryParser-Theqf_QueryFields_Parameter,`qf`>> fields. Use this parameter as a workaround if you experience that queries return zero hits due to uneven stopword removal between the `qf` fields.
Note that relaxing mm may cause undesired side effects, hurting the precision of the search, depending on the nature of your index content.
[[TheExtendedDisMaxQueryParser-TheboostParameter]]
-=== The `boost` Parameter
+=== The boost Parameter
A multivalued list of strings parsed as queries with scores multiplied by the score from the main query for all matching documents. This parameter is shorthand for wrapping the query produced by eDisMax using the `BoostQParserPlugin`
[[TheExtendedDisMaxQueryParser-ThelowercaseOperatorsParameter]]
-=== The `lowercaseOperators` Parameter
+=== The lowercaseOperators Parameter
A Boolean parameter indicating if lowercase "and" and "or" should be treated the same as operators "AND" and "OR".
[[TheExtendedDisMaxQueryParser-ThepsParameter]]
-=== The `ps` Parameter
+=== The ps Parameter
Default amount of slop on phrase queries built with `pf`, `pf2` and/or `pf3` fields (affects boosting).
[[TheExtendedDisMaxQueryParser-Thepf2Parameter]]
-=== The `pf2` Parameter
+=== The pf2 Parameter
A multivalued list of fields with optional weights, based on pairs of word shingles.
[[TheExtendedDisMaxQueryParser-Theps2Parameter]]
-=== The `ps2` Parameter
+=== The ps2 Parameter
This is similar to `ps` but overrides the slop factor used for `pf2`. If not specified, `ps` is used.
[[TheExtendedDisMaxQueryParser-Thepf3Parameter]]
-=== The `pf3` Parameter
+=== The pf3 Parameter
A multivalued list of fields with optional weights, based on triplets of word shingles. Similar to `pf`, except that instead of building a phrase per field out of all the words in the input, it builds a set of phrases for each field out of each triplet of word shingles.
[[TheExtendedDisMaxQueryParser-Theps3Parameter]]
-=== The `ps3` Parameter
+=== The ps3 Parameter
This is similar to `ps` but overrides the slop factor used for `pf3`. If not specified, `ps` is used.
[[TheExtendedDisMaxQueryParser-ThestopwordsParameter]]
-=== The `stopwords` Parameter
+=== The stopwords Parameter
A Boolean parameter indicating if the `StopFilterFactory` configured in the query analyzer should be respected when parsing the query: if it is false, then the `StopFilterFactory` in the query analyzer is ignored.
[[TheExtendedDisMaxQueryParser-TheufParameter]]
-=== The `uf` Parameter
+=== The uf Parameter
Specifies which schema fields the end user is allowed to explicitly query. This parameter supports wildcards. The default is to allow all fields, equivalent to `uf=\*`. To allow only title field, use `uf=title`. To allow title and all fields ending with '_s', use `uf=title,*_s`. To allow all fields except title, use `uf=*,-title`. To disallow all fielded searches, use `uf=-*`.
[[TheExtendedDisMaxQueryParser-Fieldaliasingusingper-fieldqfoverrides]]
-=== Field aliasing using per-field `qf` overrides
+=== Field aliasing using per-field qf overrides
Per-field overrides of the `qf` parameter may be specified to provide 1-to-many aliasing from field names specified in the query string, to field names used in the underlying query. By default, no aliasing is used and field names specified in the query string are treated as literal field names in the index.
@@ -223,7 +223,7 @@ Finally, in addition to the phrase fields (`pf`) parameter, `edismax` also suppo
[[TheExtendedDisMaxQueryParser-Usingthe_magicfields__val_and_query_]]
-== Using the 'magic fields' `\_val_` and `\_query_`
+== Using the "magic fields" \_val_ and \_query_
The Solr Query Parser's use of `\_val_` and `\_query_` differs from the Lucene Query Parser in the following ways:
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/0411504d/solr/solr-ref-guide/src/the-query-elevation-component.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/the-query-elevation-component.adoc b/solr/solr-ref-guide/src/the-query-elevation-component.adoc
index f70ed88..9898a08 100644
--- a/solr/solr-ref-guide/src/the-query-elevation-component.adoc
+++ b/solr/solr-ref-guide/src/the-query-elevation-component.adoc
@@ -74,7 +74,7 @@ The Query Elevation Search Component takes the following arguments:
|===
[[TheQueryElevationComponent-elevate.xml]]
-=== `elevate.xml`
+=== elevate.xml
Elevated query results are configured in an external XML file specified in the `config-file` argument. An `elevate.xml` file might look like this:
@@ -100,7 +100,7 @@ In this example, the query "foo bar" would first return documents 1, 2 and 3, th
== Using the Query Elevation Component
[[TheQueryElevationComponent-TheenableElevationParameter]]
-=== The `enableElevation` Parameter
+=== The enableElevation Parameter
For debugging it may be useful to see results with and without the elevated docs. To hide results, use `enableElevation=false`:
@@ -109,21 +109,21 @@ For debugging it may be useful to see results with and without the elevated docs
`\http://localhost:8983/solr/techproducts/elevate?q=ipod&df=text&debugQuery=true&enableElevation=false`
[[TheQueryElevationComponent-TheforceElevationParameter]]
-=== The `forceElevation` Parameter
+=== The forceElevation Parameter
You can force elevation during runtime by adding `forceElevation=true` to the query URL:
`\http://localhost:8983/solr/techproducts/elevate?q=ipod&df=text&debugQuery=true&enableElevation=true&forceElevation=true`
[[TheQueryElevationComponent-TheexclusiveParameter]]
-=== The `exclusive` Parameter
+=== The exclusive Parameter
You can force Solr to return only the results specified in the elevation file by adding `exclusive=true` to the URL:
`\http://localhost:8983/solr/techproducts/elevate?q=ipod&df=text&debugQuery=true&exclusive=true`
[[TheQueryElevationComponent-DocumentTransformersandthemarkExcludesParameter]]
-=== Document Transformers and the `markExcludes` Parameter
+=== Document Transformers and the markExcludes Parameter
The `[elevated]` <<transforming-result-documents.adoc#transforming-result-documents,Document Transformer>> can be used to annotate each document with information about whether or not it was elevated:
@@ -134,7 +134,7 @@ Likewise, it can be helpful when troubleshooting to see all matching documents
`\http://localhost:8983/solr/techproducts/elevate?q=ipod&df=text&markExcludes=true&fl=id,[elevated],[excluded]`
[[TheQueryElevationComponent-TheelevateIdsandexcludeIdsParameters]]
-=== The `elevateIds` and `excludeIds` Parameters
+=== The elevateIds and excludeIds Parameters
When the elevation component is in use, the pre-configured list of elevations for a query can be overridden at request time to use the unique keys specified in these request parameters.
@@ -149,6 +149,6 @@ For example, in the request below documents IW-02 and F8V7067-APL-KIT will be el
`\http://localhost:8983/solr/techproducts/elevate?q=ipod&df=text&elevateIds=IW-02,F8V7067-APL-KIT`
[[TheQueryElevationComponent-ThefqParameter]]
-=== The `fq` Parameter
+=== The fq Parameter
Query elevation respects the standard filter query (`fq`) parameter. That is, if the query contains the `fq` parameter, all results will be within that filter even if `elevate.xml` adds other documents to the result set.
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/0411504d/solr/solr-ref-guide/src/the-standard-query-parser.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/the-standard-query-parser.adoc b/solr/solr-ref-guide/src/the-standard-query-parser.adoc
index 94baedf..f389b92 100644
--- a/solr/solr-ref-guide/src/the-standard-query-parser.adoc
+++ b/solr/solr-ref-guide/src/the-standard-query-parser.adoc
@@ -187,7 +187,7 @@ The brackets around a query determine its inclusiveness.
[[TheStandardQueryParser-BoostingaTermwith_]]
-=== Boosting a Term with `^`
+=== Boosting a Term with "^"
Lucene/Solr provides the relevance level of matching documents based on the terms found. To boost a term use the caret symbol `^` with a boost factor (a number) at the end of the term you are searching. The higher the boost factor, the more relevant the term will be.
@@ -205,7 +205,7 @@ By default, the boost factor is 1. Although the boost factor must be positive, i
[[TheStandardQueryParser-ConstantScorewith_]]
-=== Constant Score with `^=`
+=== Constant Score with "^="
Constant score queries are created with `<query_clause>^=<score>`, which sets the entire clause to the specified score for any documents matching that clause. This is desirable when you only care about matches for a particular clause and don't want other relevancy factors such as term frequency (the number of times the term appears in the field) or inverse document frequency (a measure across the whole index for how rare a term is in a field).
@@ -279,7 +279,7 @@ or
[[TheStandardQueryParser-TheBooleanOperator_]]
-=== The Boolean Operator `+`
+=== The Boolean Operator "+"
The `+` symbol (also known as the "required" operator) requires that the term after the `+` symbol exist somewhere in a field in at least one document in order for the query to return a match.
@@ -296,7 +296,7 @@ This operator is supported by both the standard query parser and the DisMax quer
[[TheStandardQueryParser-TheBooleanOperatorAND_]]
-=== The Boolean Operator AND (`&&`)
+=== The Boolean Operator AND ("&&")
The AND operator matches documents where both terms exist anywhere in the text of a single document. This is equivalent to an intersection using sets. The symbol `&&` can be used in place of the word AND.
@@ -308,7 +308,7 @@ To search for documents that contain "jakarta apache" and "Apache Lucene," use e
[[TheStandardQueryParser-TheBooleanOperatorNOT_]]
-=== The Boolean Operator NOT (`!`)
+=== The Boolean Operator NOT ("!")
The NOT operator excludes documents that contain the term after NOT. This is equivalent to a difference using sets. The symbol `!` can be used in place of the word NOT.
@@ -319,7 +319,7 @@ The following queries search for documents that contain the phrase "jakarta apac
`"jakarta apache" ! "Apache Lucene"`
[[TheStandardQueryParser-TheBooleanOperator-]]
-=== The Boolean Operator `-`
+=== The Boolean Operator "-"
The `-` symbol or "prohibit" operator excludes documents that contain the term after the `-` symbol.
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/0411504d/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 95d373e..feb6931 100644
--- a/solr/solr-ref-guide/src/transforming-result-documents.adoc
+++ b/solr/solr-ref-guide/src/transforming-result-documents.adoc
@@ -51,7 +51,7 @@ The sections below discuss exactly what these various transformers do.
[[TransformingResultDocuments-_value_-ValueAugmenterFactory]]
-=== `[value]` - ValueAugmenterFactory
+=== [value] - ValueAugmenterFactory
Modifies every document to include the exact same value, as if it were a stored field in every document:
@@ -95,7 +95,7 @@ The "```value```" option forces an explicit value to always be used, while the "
[[TransformingResultDocuments-_explain_-ExplainAugmenterFactory]]
-=== `[explain]` - ExplainAugmenterFactory
+=== [explain] - ExplainAugmenterFactory
Augments each document with an inline explanation of its score exactly like the information available about each document in the debug section:
@@ -116,7 +116,7 @@ Supported values for "```style```" are "```text```", and "```html```", and "nl"
"value":1.052226,
"description":"weight(features:cache in 2) [DefaultSimilarity], result of:",
"details":[{
-...
+}]}}]}}
----
A default style can be configured by specifying an "args" parameter in your configuration:
@@ -130,7 +130,7 @@ A default style can be configured by specifying an "args" parameter in your conf
[[TransformingResultDocuments-_child_-ChildDocTransformerFactory]]
-=== `[child]` - ChildDocTransformerFactory
+=== [child] - ChildDocTransformerFactory
This transformer returns all <<uploading-data-with-index-handlers.adoc#UploadingDatawithIndexHandlers-NestedChildDocuments,descendant documents>> of each parent document matching your query in a flat list nested inside the matching parent document. This is useful when you have indexed nested child documents and want to retrieve the child documents for the relevant parent documents for any type of search query.
@@ -148,7 +148,7 @@ When using this transformer, the `parentFilter` parameter must be specified, and
[[TransformingResultDocuments-_shard_-ShardAugmenterFactory]]
-=== `[shard]` - ShardAugmenterFactory
+=== [shard] - ShardAugmenterFactory
This transformer adds information about what shard each individual document came from in a distributed request.
@@ -156,7 +156,7 @@ ShardAugmenterFactory does not support any request parameters, or configuration
[[TransformingResultDocuments-_docid_-DocIdAugmenterFactory]]
-=== `[docid]` - DocIdAugmenterFactory
+=== [docid] - DocIdAugmenterFactory
This transformer adds the internal Lucene document id to each document – this is primarily only useful for debugging purposes.
@@ -164,7 +164,7 @@ DocIdAugmenterFactory does not support any request parameters, or configuration
[[TransformingResultDocuments-_elevated_and_excluded_]]
-=== `[elevated]` and `[excluded]`
+=== [elevated] and [excluded]
These transformers are available only when using the <<the-query-elevation-component.adoc#the-query-elevation-component,Query Elevation Component>>.
@@ -191,12 +191,12 @@ fl=id,[elevated],[excluded]&excludeIds=GB18030TEST&elevateIds=6H500F0&markExclud
"id":"SP2514N",
"[elevated]":false,
"[excluded]":false},
-...
+]}}
----
[[TransformingResultDocuments-_json_xml_]]
-=== `[json]` / `[xml]`
+=== [json] / [xml]
These transformers replace field value containing a string representation of a valid XML or JSON structure with the actual raw XML or JSON structure rather than just the string value. Each applies only to the specific writer, such that `[json]` only applies to `wt=json` and `[xml]` only applies to `wt=xml`.
@@ -207,7 +207,7 @@ fl=id,source_s:[json]&wt=json
[[TransformingResultDocuments-_subquery_]]
-=== `[subquery]`
+=== [subquery]
This transformer executes a separate query per transforming document passing document fields as an input for subquery parameters. It's usually used with `{!join}` and `{!parent}` query parsers, and is intended to be an improvement for `[child]`.
@@ -246,17 +246,14 @@ Here is how it looks like in various formats:
"id":1,
"subject":["parentDocument"],
"title":["xrxvomgu"],
- "children":{
+ "children":{
"numFound":1, "start":0,
"docs":[
{ "id":2,
"cat":["childDocument"]
}
]
- }},
- {
- "id":4,
- ...
+ }}]}}
----
[source,java]
@@ -311,7 +308,7 @@ If subquery collection has a different unique key field name (let's say `foo_id`
[[TransformingResultDocuments-_geo_-Geospatialformatter]]
-=== `[geo]` - Geospatial formatter
+=== [geo] - Geospatial formatter
Formats spatial data from a spatial field using a designated format type name. Two inner parameters are required: `f` for the field name, and `w` for the format name. Example: `geojson:[geo f=mySpatialField w=GeoJSON]`.
@@ -321,7 +318,7 @@ In addition, this feature is very useful with the `RptWithGeometrySpatialField`
[[TransformingResultDocuments-_features_-LTRFeatureLoggerTransformerFactory]]
-=== `[features]` - LTRFeatureLoggerTransformerFactory
+=== [features] - LTRFeatureLoggerTransformerFactory
The "LTR" prefix stands for <<learning-to-rank.adoc#learning-to-rank,Learning To Rank>>. This transformer returns the values of features and it can be used for feature extraction and feature logging.
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/0411504d/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 7afc2e1..664bd8c 100644
--- a/solr/solr-ref-guide/src/updatehandlers-in-solrconfig.adoc
+++ b/solr/solr-ref-guide/src/updatehandlers-in-solrconfig.adoc
@@ -33,7 +33,7 @@ The settings in this section are configured in the `<updateHandler>` element in
Data sent to Solr is not searchable until it has been _committed_ to the index. The reason for this is that in some cases commits can be slow and they should be done in isolation from other possible commit requests to avoid overwriting data. So, it's preferable to provide control over when data is committed. Several options are available to control the timing of commits.
[[UpdateHandlersinSolrConfig-commitandsoftCommit]]
-=== `commit` and `softCommit`
+=== commit and softCommit
In Solr, a `commit` is an action which asks Solr to "commit" those changes to the Lucene index files. By default commit actions result in a "hard commit" of all the Lucene index files to stable storage (disk). When a client includes a `commit=true` parameter with an update request, this ensures that all index segments affected by the adds & deletes on an update are written to disk as soon as index updates are completed.
@@ -42,7 +42,7 @@ If an additional flag `softCommit=true` is specified, then Solr performs a 'soft
For more information about Near Real Time operations, see <<near-real-time-searching.adoc#near-real-time-searching,Near Real Time Searching>>.
[[UpdateHandlersinSolrConfig-autoCommit]]
-=== `autoCommit`
+=== autoCommit
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.
@@ -79,7 +79,7 @@ You can also specify 'soft' autoCommits in the same way that you can specify 'so
----
[[UpdateHandlersinSolrConfig-commitWithin]]
-=== `commitWithin`
+=== commitWithin
The `commitWithin` settings allow forcing document commits to happen in a defined time period. This is used most frequently with <<near-real-time-searching.adoc#near-real-time-searching,Near Real Time Searching>>, and for that reason the default is to perform a soft commit. This does not, however, replicate new documents to slave servers in a master/slave environment. If that's a requirement for your implementation, you can force a hard commit by adding a parameter, as in this example:
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/0411504d/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 30a2c3a..8bad5f5 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
@@ -148,7 +148,7 @@ When using the Join query parser in a Delete By Query, you should use the `score
The rollback command rolls back all add and deletes made to the index since the last commit. It neither calls any event listeners nor creates a new searcher. Its syntax is simple: `<rollback/>`.
[[UploadingDatawithIndexHandlers-UsingcurltoPerformUpdates]]
-=== Using `curl` to Perform Updates
+=== Using curl to Perform Updates
You can use the `curl` utility to perform any of the above commands, using its `--data-binary` option to append the XML message to the `curl` command, and generating a HTTP POST request. For example:
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/0411504d/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 e1c8414..670ef2b 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
@@ -48,7 +48,7 @@ While Apache Tika is quite powerful, it is not perfect and fails on some files.
====
[[UploadingDatawithSolrCellusingApacheTika-TryingoutTikawiththeSolrtechproductsExample]]
-== Trying out Tika with the Solr `techproducts` Example
+== Trying out Tika with the Solr techproducts Example
You can try out the Tika framework using the `techproducts` example included in Solr.
@@ -138,7 +138,7 @@ Here is the order in which the Solr Cell framework, using the Extracting Request
4. If `uprefix` is specified, any unknown field names are prefixed with that value, else if `defaultField` is specified, any unknown fields are copied to the default field.
[[UploadingDatawithSolrCellusingApacheTika-ConfiguringtheSolrExtractingRequestHandler]]
-== Configuring the Solr `ExtractingRequestHandler`
+== Configuring the Solr ExtractingRequestHandler
If you are not working with the supplied `sample_techproducts_configs `or` data_driven_schema_configs` <<config-sets.adoc#config-sets,config set>>, you must configure your own `solrconfig.xml` to know about the Jar's containing the `ExtractingRequestHandler` and its dependencies:
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/0411504d/solr/solr-ref-guide/src/using-zookeeper-to-manage-configuration-files.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/using-zookeeper-to-manage-configuration-files.adoc b/solr/solr-ref-guide/src/using-zookeeper-to-manage-configuration-files.adoc
index b2dc9d5..a9e0d71 100644
--- a/solr/solr-ref-guide/src/using-zookeeper-to-manage-configuration-files.adoc
+++ b/solr/solr-ref-guide/src/using-zookeeper-to-manage-configuration-files.adoc
@@ -58,7 +58,7 @@ It's a good idea to keep these files under version control.
[[UsingZooKeepertoManageConfigurationFiles-UploadingConfigurationFilesusingbin_solrorSolrJ]]
-== Uploading Configuration Files using `bin/solr` or SolrJ
+== Uploading Configuration Files using bin/solr or SolrJ
In production situations, <<config-sets.adoc#config-sets,Config Sets>> can also be uploaded to ZooKeeper independent of collection creation using either Solr's <<solr-control-script-reference.adoc#solr-control-script-reference,Solr Control Script>> or the {solr-javadocs}/solr-solrj/org/apache/solr/client/solrj/impl/CloudSolrClient.html[CloudSolrClient.uploadConfig] java method.
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/0411504d/solr/solr-ref-guide/src/working-with-dates.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/working-with-dates.adoc b/solr/solr-ref-guide/src/working-with-dates.adoc
index f0ac242..7d30b66 100644
--- a/solr/solr-ref-guide/src/working-with-dates.adoc
+++ b/solr/solr-ref-guide/src/working-with-dates.adoc
@@ -53,8 +53,8 @@ As you can see, the date format includes colon characters separating the hours,
This is normally an invalid query: `datefield:1972-05-20T17:33:18.772Z`
-These are valid queries: +
-`datefield:1972-05-20T17\:33\:18.772Z` +
+These are valid queries: +
+`datefield:1972-05-20T17\:33\:18.772Z` +
`datefield:"1972-05-20T17:33:18.772Z"` +
`datefield:[1972-05-20T17:33:18.772Z TO *]`
@@ -108,7 +108,7 @@ Note that while date math is most commonly used relative to `NOW` it can be appl
=== Request Parameters That Affect Date Math
[[WorkingwithDates-NOW]]
-==== `NOW`
+==== NOW
The `NOW` parameter is used internally by Solr to ensure consistent date math expression parsing across multiple nodes in a distributed request. But it can be specified to instruct Solr to use an arbitrary moment in time (past or future) to override for all situations where the the special value of "```NOW```" would impact date math expressions.
@@ -119,7 +119,7 @@ Example:
`q=solr&fq=start_date:[* TO NOW]&NOW=1384387200000`
[[WorkingwithDates-TZ]]
-==== `TZ`
+==== TZ
By default, all date math expressions are evaluated relative to the UTC TimeZone, but the `TZ` parameter can be specified to override this behaviour, by forcing all date based addition and rounding to be relative to the specified http://docs.oracle.com/javase/8/docs/api/java/util/TimeZone.html[time zone].
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/0411504d/solr/solr-ref-guide/src/working-with-enum-fields.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/working-with-enum-fields.adoc b/solr/solr-ref-guide/src/working-with-enum-fields.adoc
index c4d49b3..8931543 100644
--- a/solr/solr-ref-guide/src/working-with-enum-fields.adoc
+++ b/solr/solr-ref-guide/src/working-with-enum-fields.adoc
@@ -21,7 +21,7 @@
The EnumField type allows defining a field whose values are a closed set, and the sort order is pre-determined but is not alphabetic nor numeric. Examples of this are severity lists, or risk definitions.
[[WorkingwithEnumFields-DefininganEnumFieldinschema.xml]]
-== Defining an EnumField in `schema.xml`
+== Defining an EnumField in schema.xml
The EnumField type definition is quite simple, as in this example defining field types for "priorityLevel" and "riskLevel" enumerations:
@@ -52,7 +52,7 @@ In this example, there are two value lists defined. Each list is between `enum`
<value>Low</value>
<value>Medium</value>
<value>High</value>
- <value>Urgent</value>
+ <value>Urgent</value>
</enum>
<enum name="risk">
<value>Unknown</value>
@@ -60,7 +60,7 @@ In this example, there are two value lists defined. Each list is between `enum`
<value>Low</value>
<value>Medium</value>
<value>High</value>
- <value>Critical</value>
+ <value>Critical</value>
</enum>
</enumsConfig>
----
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/0411504d/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 31abc18..3aa0195 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
@@ -19,7 +19,7 @@
// under the License.
[[WorkingwithExternalFilesandProcesses-TheExternalFileFieldType]]
-== The `ExternalFileField` Type
+== The ExternalFileField Type
The `ExternalFileField` type makes it possible to specify the values for a field in a file outside the Solr index. For such a field, the file contains mappings from a key field to the field value. Another way to think of this is that, instead of specifying the field in documents as they are indexed, Solr finds values for this field in the external file.
@@ -74,7 +74,7 @@ It's possible to define an event listener to reload an external file when either
----
[[WorkingwithExternalFilesandProcesses-ThePreAnalyzedFieldType]]
-== The `PreAnalyzedField` Type
+== The PreAnalyzedField Type
The `PreAnalyzedField` type provides a way to send to Solr serialized token streams, optionally with independent stored values of a field, and have this information stored and indexed without any additional text processing applied in Solr. This is useful if user wants to submit field content that was already processed by some existing external text processing pipeline (e.g., it has been tokenized, annotated, stemmed, synonyms inserted, etc.), while using all the rich attributes that Lucene's TokenStream provides (per-token attributes).