Skip to content

Commit df490a9

Browse files
committed
HSEARCH-5492 Switch to a rouge highlighter
in preparation for the unified theme + add language wherever missing
1 parent 84c59bf commit df490a9

File tree

57 files changed

+697
-691
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

57 files changed

+697
-691
lines changed

documentation/pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -343,7 +343,7 @@
343343
<stylesdir>css</stylesdir>
344344
<iconfont-remote>false</iconfont-remote>
345345
<iconfont-name>font-awesome/css/font-awesome.min</iconfont-name>
346-
<source-highlighter>coderay</source-highlighter>
346+
<source-highlighter>rouge</source-highlighter>
347347
</attributes>
348348
</configuration>
349349
</execution>

documentation/src/main/asciidoc/internals/index.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
:html-meta-description: Hibernate Search, full text search for your entities - Internals of Hibernate Search
1414
:html-meta-keywords: hibernate, search, hibernate search, full text, lucene, elasticsearch, opensearch
1515
:html-meta-canonical-link: https://docs.jboss.org/hibernate/stable/search/internals/html_single/
16+
:html-meta-version-family: {hibernateSearchVersionShort}
1617

1718
This section is intended for new Hibernate Search contributors looking for an introduction
1819
to how Hibernate Search works.

documentation/src/main/asciidoc/migration/index.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
:html-meta-description: Hibernate Search, full text search for your entities - Migration Guide
1414
:html-meta-keywords: hibernate, search, hibernate search, full text, lucene, elasticsearch, opensearch
1515
:html-meta-canonical-link: https://docs.jboss.org/hibernate/search/{hibernateSearchVersionShort}/migration/html_single/
16+
:html-meta-version-family: {hibernateSearchVersionShort}
1617

1718
[[introduction]]
1819
== [[_introduction]] Introduction

documentation/src/main/asciidoc/public/getting-started/index.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
:html-meta-description: Hibernate Search, full text search for your entities - Getting Started Guides
1313
:html-meta-keywords: hibernate, search, hibernate search, full text, lucene, elasticsearch, opensearch
1414
:html-meta-canonical-link: https://docs.jboss.org/hibernate/stable/search/getting-started/en-US/html_single/
15+
:html-meta-version-family: {hibernateSearchVersionShort}
1516

1617
:relfileprefix: ../../
1718
:relfilesuffix: /../en-US/html_single/index.html

documentation/src/main/asciidoc/public/getting-started/orm/index.adoc

Lines changed: 22 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
:html-meta-description: Hibernate Search, full text search for your entities - Getting started with Hibernate Search in Hibernate ORM
1515
:html-meta-keywords: hibernate, search, hibernate search, full text, lucene, elasticsearch, opensearch
1616
:html-meta-canonical-link: https://docs.jboss.org/hibernate/stable/search/getting-started/orm/en-US/html_single/
17+
:html-meta-version-family: {hibernateSearchVersionShort}
1718

1819
:relfileprefix: ../../
1920
:relfilesuffix: /../en-US/html_single/index.html
@@ -54,7 +55,7 @@ The Hibernate Search artifacts can be found in Maven's http://central.sonatype.o
5455
If you get Hibernate Search from Maven, it is recommended to import Hibernate Search BOM
5556
as part of your dependency management to keep all its artifact versions aligned:
5657

57-
[source, XML, subs="+attributes"]
58+
[source, xml, subs="+attributes"]
5859
----
5960
<dependencyManagement>
6061
<dependencies>
@@ -91,7 +92,7 @@ storing the index on the local filesystem.
9192
+
9293
If you get Hibernate Search from Maven, use these dependencies:
9394
+
94-
[source, XML, subs="+attributes"]
95+
[source, xml, subs="+attributes"]
9596
----
9697
<dependencies>
9798
<!--
@@ -119,7 +120,7 @@ storing the index on a remote Elasticsearch or OpenSearch cluster (to be configu
119120
+
120121
If you get Hibernate Search from Maven, use these dependencies:
121122
+
122-
[source, XML, subs="+attributes"]
123+
[source, xml, subs="+attributes"]
123124
----
124125
<dependencies>
125126
<!--
@@ -167,7 +168,7 @@ but depending on your setup you might want to set the following:
167168

168169
.Hibernate Search properties in `persistence.xml` for a "Hibernate ORM + Lucene" setup
169170
====
170-
[source, XML, indent=0]
171+
[source, xml, indent=0]
171172
----
172173
include::{resourcesdir}/META-INF/persistence.xml[tags=gettingstarted-configuration-orm_lucene]
173174
----
@@ -177,7 +178,7 @@ By default, the backend will store indexes in the current working directory.
177178

178179
.Hibernate Search properties in `persistence.xml` for a "Hibernate ORM + Elasticsearch/OpenSearch" setup
179180
====
180-
[source, XML, indent=0]
181+
[source, xml, indent=0]
181182
----
182183
include::{resourcesdir}/META-INF/persistence.xml[tags=gettingstarted-configuration-orm_elasticsearch]
183184
----
@@ -196,11 +197,11 @@ and you want to index them in order to search the books contained in your databa
196197

197198
.Book and Author entities BEFORE adding Hibernate Search specific annotations
198199
====
199-
[source, JAVA, indent=0]
200+
[source, java, indent=0]
200201
----
201202
include::{sourcedir}/org/hibernate/search/documentation/mapper/orm/gettingstarted/withouthsearch/Book.java[tags=include;!getters-setters]
202203
----
203-
[source, JAVA, indent=0]
204+
[source, java, indent=0]
204205
----
205206
include::{sourcedir}/org/hibernate/search/documentation/mapper/orm/gettingstarted/withouthsearch/Author.java[tags=include;!getters-setters]
206207
----
@@ -216,11 +217,11 @@ Below is an example of how the model above can be mapped.
216217

217218
.Book and Author entities AFTER adding Hibernate Search specific annotations
218219
====
219-
[source, JAVA, indent=0]
220+
[source, java, indent=0]
220221
----
221222
include::{sourcedir}/org/hibernate/search/documentation/mapper/orm/gettingstarted/withhsearch/defaultanalysis/Book.java[tags=include;!getters-setters]
222223
----
223-
[source, JAVA, indent=0]
224+
[source, java, indent=0]
224225
----
225226
include::{sourcedir}/org/hibernate/search/documentation/mapper/orm/gettingstarted/withhsearch/defaultanalysis/Author.java[tags=include;!getters-setters]
226227
----
@@ -306,7 +307,7 @@ To that end, you can use the mass indexer API, as shown in the following code:
306307

307308
.Using Hibernate Search MassIndexer API to manually (re)index the already persisted data
308309
====
309-
[source, JAVA, indent=0]
310+
[source, java, indent=0]
310311
----
311312
include::{sourcedir}/org/hibernate/search/documentation/mapper/orm/gettingstarted/withhsearch/defaultanalysis/GettingStartedDefaultAnalysisIT.java[tags=manual-index]
312313
----
@@ -328,7 +329,7 @@ Thus, this code would transparently populate your index:
328329

329330
.Using Hibernate ORM to persist data, and implicitly indexing it through Hibernate Search
330331
====
331-
[source, JAVA, indent=0]
332+
[source, java, indent=0]
332333
----
333334
include::{sourcedir}/org/hibernate/search/documentation/mapper/orm/gettingstarted/withhsearch/defaultanalysis/GettingStartedDefaultAnalysisIT.java[tags=indexing]
334335
----
@@ -361,7 +362,7 @@ with the <<mapper-orm-getting-started-analysis-default-analyzer,default analyzer
361362

362363
.Using Hibernate Search to query the indexes
363364
====
364-
[source, JAVA, indent=0, subs="+callouts"]
365+
[source, java, indent=0, subs="+callouts"]
365366
----
366367
include::{sourcedir}/org/hibernate/search/documentation/mapper/orm/gettingstarted/withhsearch/defaultanalysis/GettingStartedDefaultAnalysisIT.java[tags=searching-lambdas]
367368
----
@@ -381,7 +382,7 @@ but it will be a bit more verbose:
381382

382383
.Using Hibernate Search to query the indexes -- object-based syntax
383384
====
384-
[source, JAVA, indent=0]
385+
[source, java, indent=0]
385386
----
386387
include::{sourcedir}/org/hibernate/search/documentation/mapper/orm/gettingstarted/withhsearch/defaultanalysis/GettingStartedDefaultAnalysisIT.java[tags=searching-objects]
387388
----
@@ -401,7 +402,7 @@ It is possible to get just the total hit count, using `fetchTotalHitCount()`.
401402

402403
.Using Hibernate Search to count the matches
403404
====
404-
[source, JAVA, indent=0, subs="+callouts"]
405+
[source, java, indent=0, subs="+callouts"]
405406
----
406407
include::{sourcedir}/org/hibernate/search/documentation/mapper/orm/gettingstarted/withhsearch/defaultanalysis/GettingStartedDefaultAnalysisIT.java[tags=counting]
407408
----
@@ -476,11 +477,11 @@ The examples below show how to define an analyzer with these components, dependi
476477

477478
.Analysis configurer implementation and configuration in `persistence.xml` for a "Hibernate ORM + Lucene" setup
478479
====
479-
[source, JAVA, indent=0, subs="+callouts"]
480+
[source, java, indent=0, subs="+callouts"]
480481
----
481482
include::{sourcedir}/org/hibernate/search/documentation/mapper/orm/gettingstarted/withhsearch/customanalysis/MyLuceneAnalysisConfigurer.java[tags=include]
482483
----
483-
[source, XML, indent=0, subs="+callouts"]
484+
[source, xml, indent=0, subs="+callouts"]
484485
----
485486
include::{resourcesdir}/META-INF/persistence.xml[tags=gettingstarted-configuration-orm_lucene-analysis]
486487
----
@@ -501,11 +502,11 @@ For more information about the format of bean references, see xref:{reference-do
501502

502503
.Analysis configurer implementation and configuration in `persistence.xml` for a "Hibernate ORM + Elasticsearch/OpenSearch" setup
503504
====
504-
[source, JAVA, indent=0, subs="+callouts"]
505+
[source, java, indent=0, subs="+callouts"]
505506
----
506507
include::{sourcedir}/org/hibernate/search/documentation/mapper/orm/gettingstarted/withhsearch/customanalysis/MyElasticsearchAnalysisConfigurer.java[tags=include]
507508
----
508-
[source, XML, indent=0, subs="+callouts"]
509+
[source, xml, indent=0, subs="+callouts"]
509510
----
510511
include::{resourcesdir}/META-INF/persistence.xml[tags=gettingstarted-configuration-orm_elasticsearch-analysis]
511512
----
@@ -530,11 +531,11 @@ Once analysis is configured, the mapping must be adapted to assign the relevant
530531

531532
.Book and Author entities after adding Hibernate Search specific annotations
532533
====
533-
[source, JAVA, indent=0, subs="+callouts"]
534+
[source, java, indent=0, subs="+callouts"]
534535
----
535536
include::{sourcedir}/org/hibernate/search/documentation/mapper/orm/gettingstarted/withhsearch/customanalysis/Book.java[tags=include;!getters-setters]
536537
----
537-
[source, JAVA, indent=0, subs="+callouts"]
538+
[source, java, indent=0, subs="+callouts"]
538539
----
539540
include::{sourcedir}/org/hibernate/search/documentation/mapper/orm/gettingstarted/withhsearch/customanalysis/Author.java[tags=include;!getters-setters]
540541
----
@@ -558,7 +559,7 @@ will show up in the results.
558559

559560
.Using Hibernate Search to query the indexes after analysis was configured
560561
====
561-
[source, JAVA, indent=0]
562+
[source, java, indent=0]
562563
----
563564
include::{sourcedir}/org/hibernate/search/documentation/mapper/orm/gettingstarted/withhsearch/customanalysis/GettingStartedCustomAnalysisIT.java[tags=searching]
564565
----

documentation/src/main/asciidoc/public/getting-started/standalone/index.adoc

Lines changed: 23 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
:html-meta-description: Hibernate Search, full text search for your entities - Getting started with Hibernate Search’s Standalone POJO Mapper
1515
:html-meta-keywords: hibernate, search, hibernate search, full text, lucene, elasticsearch, opensearch
1616
:html-meta-canonical-link: https://docs.jboss.org/hibernate/stable/search/getting-started/standalone/en-US/html_single/
17+
:html-meta-version-family: {hibernateSearchVersionShort}
1718

1819
:relfileprefix: ../../
1920
:relfilesuffix: /../en-US/html_single/index.html
@@ -57,7 +58,7 @@ The Hibernate Search artifacts can be found in Maven's http://central.sonatype.o
5758
If you get Hibernate Search from Maven, it is recommended to import Hibernate Search BOM
5859
as part of your dependency management to keep all its artifact versions aligned:
5960

60-
[source, XML, subs="+attributes"]
61+
[source, xml, subs="+attributes"]
6162
----
6263
<dependencyManagement>
6364
<dependencies>
@@ -95,7 +96,7 @@ storing the index on the local filesystem.
9596
+
9697
If you get Hibernate Search from Maven, use these dependencies:
9798
+
98-
[source, XML, subs="+attributes"]
99+
[source, xml, subs="+attributes"]
99100
----
100101
<dependencies>
101102
<!--
@@ -124,7 +125,7 @@ storing the index on a remote Elasticsearch or OpenSearch cluster (to be configu
124125
+
125126
If you get Hibernate Search from Maven, use these dependencies:
126127
+
127-
[source, XML, subs="+attributes"]
128+
[source, xml, subs="+attributes"]
128129
----
129130
<dependencies>
130131
<!--
@@ -158,7 +159,7 @@ are set programmatically when building the mapping.
158159

159160
.Hibernate Search properties for a "Standalone POJO Mapper + Lucene" setup
160161
====
161-
[source, JAVA, indent=0]
162+
[source, java, indent=0]
162163
----
163164
include::{sourcedir}/org/hibernate/search/documentation/mapper/pojo/standalone/gettingstarted/withhsearch/defaultanalysis/GettingStartedDefaultAnalysisIT.java[tags=setup-lucene]
164165
----
@@ -170,7 +171,7 @@ By default, the backend will store indexes in the current working directory.
170171

171172
.Hibernate Search properties for a "Standalone POJO Mapper + Elasticsearch/OpenSearch" setup
172173
====
173-
[source, JAVA, indent=0]
174+
[source, java, indent=0]
174175
----
175176
include::{sourcedir}/org/hibernate/search/documentation/mapper/pojo/standalone/gettingstarted/withhsearch/defaultanalysis/GettingStartedDefaultAnalysisIT.java[tags=setup-elasticsearch]
176177
----
@@ -208,11 +209,11 @@ and you want to index them in order to search for books.
208209

209210
.Book and Author types BEFORE adding Hibernate Search specific annotations
210211
====
211-
[source, JAVA, indent=0]
212+
[source, java, indent=0]
212213
----
213214
include::{sourcedir}/org/hibernate/search/documentation/mapper/pojo/standalone/gettingstarted/withouthsearch/Book.java[tags=include;!getters-setters]
214215
----
215-
[source, JAVA, indent=0]
216+
[source, java, indent=0]
216217
----
217218
include::{sourcedir}/org/hibernate/search/documentation/mapper/pojo/standalone/gettingstarted/withouthsearch/Author.java[tags=include;!getters-setters]
218219
----
@@ -231,11 +232,11 @@ Below is an example of how the model above can be mapped.
231232

232233
.Book and Author entities AFTER adding Hibernate Search specific annotations
233234
====
234-
[source, JAVA, indent=0]
235+
[source, java, indent=0]
235236
----
236237
include::{sourcedir}/org/hibernate/search/documentation/mapper/pojo/standalone/gettingstarted/withhsearch/defaultanalysis/Book.java[tags=include;!getters-setters]
237238
----
238-
[source, JAVA, indent=0]
239+
[source, java, indent=0]
239240
----
240241
include::{sourcedir}/org/hibernate/search/documentation/mapper/pojo/standalone/gettingstarted/withhsearch/defaultanalysis/Author.java[tags=include;!getters-setters]
241242
----
@@ -372,7 +373,7 @@ Use `add` when the entity is first added and you are absolutely certain it does
372373

373374
.Using the Standalone POJO Mapper to index data
374375
====
375-
[source, JAVA, indent=0]
376+
[source, java, indent=0]
376377
----
377378
include::{sourcedir}/org/hibernate/search/documentation/mapper/pojo/standalone/gettingstarted/withhsearch/defaultanalysis/GettingStartedDefaultAnalysisIT.java[tags=indexing]
378379
----
@@ -382,7 +383,7 @@ Use `addOrUpdate` to add/update the entity when the entity may already exist in
382383

383384
.Using the Standalone POJO Mapper to index data
384385
====
385-
[source, JAVA, indent=0]
386+
[source, java, indent=0]
386387
----
387388
include::{sourcedir}/org/hibernate/search/documentation/mapper/pojo/standalone/gettingstarted/withhsearch/defaultanalysis/GettingStartedDefaultAnalysisIT.java[tags=indexing-addOrUpdate]
388389
----
@@ -392,7 +393,7 @@ Add use `delete` to delete the entity from the index:
392393

393394
.Using the Standalone POJO Mapper to index data
394395
====
395-
[source, JAVA, indent=0]
396+
[source, java, indent=0]
396397
----
397398
include::{sourcedir}/org/hibernate/search/documentation/mapper/pojo/standalone/gettingstarted/withhsearch/defaultanalysis/GettingStartedDefaultAnalysisIT.java[tags=indexing-delete]
398399
----
@@ -412,7 +413,7 @@ with the <<mapper-pojo-standalone-getting-started-analysis-default-analyzer,defa
412413

413414
.Using Hibernate Search to query the indexes
414415
====
415-
[source, JAVA, indent=0, subs="+callouts"]
416+
[source, java, indent=0, subs="+callouts"]
416417
----
417418
include::{sourcedir}/org/hibernate/search/documentation/mapper/pojo/standalone/gettingstarted/withhsearch/defaultanalysis/GettingStartedDefaultAnalysisIT.java[tags=searching-lambdas]
418419
----
@@ -435,7 +436,7 @@ but it will be a bit more verbose:
435436

436437
.Using Hibernate Search to query the indexes -- object-based syntax
437438
====
438-
[source, JAVA, indent=0]
439+
[source, java, indent=0]
439440
----
440441
include::{sourcedir}/org/hibernate/search/documentation/mapper/pojo/standalone/gettingstarted/withhsearch/defaultanalysis/GettingStartedDefaultAnalysisIT.java[tags=searching-objects]
441442
----
@@ -458,7 +459,7 @@ It is possible to get just the total hit count, using `fetchTotalHitCount()`.
458459

459460
.Using Hibernate Search to count the matches
460461
====
461-
[source, JAVA, indent=0, subs="+callouts"]
462+
[source, java, indent=0, subs="+callouts"]
462463
----
463464
include::{sourcedir}/org/hibernate/search/documentation/mapper/pojo/standalone/gettingstarted/withhsearch/defaultanalysis/GettingStartedDefaultAnalysisIT.java[tags=counting]
464465
----
@@ -533,11 +534,11 @@ The examples below show how to define an analyzer with these components, dependi
533534

534535
.Analysis configurer implementation and configuration for a "Standalone POJO Mapper + Lucene" setup
535536
====
536-
[source, JAVA, indent=0, subs="+callouts"]
537+
[source, java, indent=0, subs="+callouts"]
537538
----
538539
include::{sourcedir}/org/hibernate/search/documentation/mapper/pojo/standalone/gettingstarted/withhsearch/customanalysis/MyLuceneAnalysisConfigurer.java[tags=include]
539540
----
540-
[source, JAVA, indent=0, subs="+callouts"]
541+
[source, java, indent=0, subs="+callouts"]
541542
----
542543
include::{sourcedir}/org/hibernate/search/documentation/mapper/pojo/standalone/gettingstarted/withhsearch/customanalysis/GettingStartedCustomAnalysisIT.java[tags=setup-lucene]
543544
----
@@ -558,11 +559,11 @@ For more information about the bean references, see xref:{reference-documentatio
558559

559560
.Analysis configurer implementation and configuration for a "Standalone POJO Mapper + Elasticsearch/OpenSearch" setup
560561
====
561-
[source, JAVA, indent=0, subs="+callouts"]
562+
[source, java, indent=0, subs="+callouts"]
562563
----
563564
include::{sourcedir}/org/hibernate/search/documentation/mapper/pojo/standalone/gettingstarted/withhsearch/customanalysis/MyElasticsearchAnalysisConfigurer.java[tags=include]
564565
----
565-
[source, XML, indent=0, subs="+callouts"]
566+
[source, xml, indent=0, subs="+callouts"]
566567
----
567568
include::{sourcedir}/org/hibernate/search/documentation/mapper/pojo/standalone/gettingstarted/withhsearch/customanalysis/GettingStartedCustomAnalysisIT.java[tags=setup-elasticsearch]
568569
----
@@ -587,11 +588,11 @@ Once analysis is configured, the mapping must be adapted to assign the relevant
587588

588589
.Book and Author entities after adding Hibernate Search specific annotations
589590
====
590-
[source, JAVA, indent=0, subs="+callouts"]
591+
[source, java, indent=0, subs="+callouts"]
591592
----
592593
include::{sourcedir}/org/hibernate/search/documentation/mapper/pojo/standalone/gettingstarted/withhsearch/customanalysis/Book.java[tags=include;!getters-setters]
593594
----
594-
[source, JAVA, indent=0, subs="+callouts"]
595+
[source, java, indent=0, subs="+callouts"]
595596
----
596597
include::{sourcedir}/org/hibernate/search/documentation/mapper/pojo/standalone/gettingstarted/withhsearch/customanalysis/Author.java[tags=include;!getters-setters]
597598
----
@@ -615,7 +616,7 @@ will show up in the results.
615616

616617
.Using Hibernate Search to query the indexes after analysis was configured
617618
====
618-
[source, JAVA, indent=0]
619+
[source, java, indent=0]
619620
----
620621
include::{sourcedir}/org/hibernate/search/documentation/mapper/pojo/standalone/gettingstarted/withhsearch/customanalysis/GettingStartedCustomAnalysisIT.java[tags=searching]
621622
----

0 commit comments

Comments
 (0)