Skip to content

Commit dc11197

Browse files
marko-bekhtamarko-bekhta
committed
HHH-19827 Apply the unified Hibernate asciidoctor theme to all docs
1 parent a938e31 commit dc11197

File tree

95 files changed

+124
-3922
lines changed

Some content is hidden

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

95 files changed

+124
-3922
lines changed

‎dialects.adoc‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11
= Dialects
2+
:toc2:
3+
:toclevels: 1
4+
:sectanchors:
25

36
A dialect is a class that provides information about the specifics of a database and translators for the SQL dialect of the database.
47

@@ -70,4 +73,4 @@ The requirements for the database server are:
7073
* Access via SSH through confidential credentials
7174

7275
Get in touch with the Hibernate team on https://hibernate.zulipchat.com/#narrow/stream/132096-hibernate-user[Zulip]
73-
if you want to request the move of your dialect to hibernate-core.
76+
if you want to request the move of your dialect to hibernate-core.

‎documentation/documentation.gradle‎

Lines changed: 96 additions & 122 deletions
Original file line numberDiff line numberDiff line change
@@ -231,18 +231,31 @@ asciidoctorj {
231231
version '2.3.18'
232232
}
233233
}
234-
attributes icons: 'font',
235-
experimental: true,
236-
'source-highlighter': 'rouge',
237-
majorMinorVersion: hibernateVersion.family,
238-
fullVersion: hibernateVersion.fullName,
239-
javaCompatibleVersions: jdks.versions.compatible.get(),
240-
jakartaJpaVersion: jpaVersion.name,
241-
jdbcVersion: jdks.versions.jdbc.get(),
234+
235+
attributes icons: 'font',
236+
experimental: true,
237+
'source-highlighter': 'rouge',
238+
majorMinorVersion: hibernateVersion.family,
239+
fullVersion: hibernateVersion.fullName,
240+
javaCompatibleVersions: jdks.versions.compatible.get(),
241+
jakartaJpaVersion: jpaVersion.name,
242+
jdbcVersion: jdks.versions.jdbc.get(),
242243
'root-project-dir': rootProject.layout.projectDirectory.asFile.absolutePath,
243-
'doc-main-dir': project( ':documentation').layout.projectDirectory.dir('src').dir("main").asFile.absolutePath
244+
'doc-main-dir': project(':documentation').layout.projectDirectory.dir('src').dir("main").asFile.absolutePath,
245+
'theme-main-dir': rootProject.layout.buildDirectory.dir("unpacked-theme").get()
246+
.dir("hibernate-asciidoctor-theme").dir("asciidoc").asFile.absolutePath,
247+
stylesdir: "css",
248+
'iconfont-remote': false,
249+
'iconfont-name': 'font-awesome/css/solid',
250+
docinfo: 'shared,private',
251+
docinfodir: rootProject.layout.buildDirectory.dir("unpacked-theme").get()
252+
.dir("hibernate-asciidoctor-theme").dir("asciidoc").dir("docinfo").dir('hibernate').asFile.absolutePath,
253+
'html.meta.project-key': 'orm',
254+
'html.outdated-content.project-key': 'orm',
255+
'html-meta-description': 'Hibernate ORM, relational persistence for idiomatic Java',
256+
'html-meta-keywords': 'hibernate, orm, hibernate orm, database, db, jpa, sql'
244257

245-
options logDocuments: true
258+
options logDocuments: true
246259
}
247260

248261

@@ -260,6 +273,12 @@ def renderTopicalGuideHtmlTask = tasks.register( 'renderTopicalGuideHtml', Ascii
260273
from( 'src/main/asciidoc/topical/' ) {
261274
include '**/images/**'
262275
}
276+
from(rootProject.layout.buildDirectory.dir("unpacked-theme").get()
277+
.dir("hibernate-asciidoctor-theme").dir("asciidoc")) {
278+
include 'css/**'
279+
include 'images/**'
280+
include 'script/**'
281+
}
263282
}
264283
}
265284

@@ -297,21 +316,15 @@ def renderGettingStartedGuideHtmlTask = tasks.register( 'renderGettingStartedGui
297316

298317
outputDir = gettingStartedGuideHtmlDir
299318

300-
attributes linkcss: true,
301-
stylesheet: "css/hibernate.css",
302-
docinfo: 'private',
303-
jpaJavadocUrlPrefix: "https://javaee.github.io/javaee-spec/javadocs/javax/persistence/"
319+
attributes jpaJavadocUrlPrefix: "https://javaee.github.io/javaee-spec/javadocs/javax/persistence/"
304320

305321
resources {
306-
from( 'src/main/style/asciidoctor' ) {
307-
include 'images/**'
308-
}
309-
from( 'src/main/style/asciidoctor' ) {
310-
include 'css/**'
311-
}
312-
from( 'src/main/style/asciidoctor' ) {
313-
include 'js/**'
314-
}
322+
from(rootProject.layout.buildDirectory.dir("unpacked-theme").get()
323+
.dir("hibernate-asciidoctor-theme").dir("asciidoc")) {
324+
include 'css/**'
325+
include 'images/**'
326+
include 'script/**'
327+
}
315328
}
316329
}
317330

@@ -332,7 +345,7 @@ def renderGettingStartedGuidePdfTask = tasks.register( 'renderGettingStartedGuid
332345

333346
def renderGettingStartedGuidesTask = tasks.register( 'renderGettingStartedGuides' ) { task ->
334347
task.group = "Documentation"
335-
task.description = 'Renders the Getting Started Guide in all formats, as well as the acccompanying tutorial zip.'
348+
task.description = 'Renders the Getting Started Guide in all formats, as well as the accompanying tutorial zip.'
336349
task.dependsOn renderGettingStartedGuideHtmlTask, renderGettingStartedGuidePdfTask, buildTutorialZipTask
337350
}
338351

@@ -349,24 +362,18 @@ def renderIntroductionHtmlTask = tasks.register( 'renderIntroductionHtml', Ascii
349362

350363
outputDir = "$buildDir/asciidoc/introduction/html_single"
351364

352-
attributes linkcss: true,
353-
stylesheet: "css/hibernate.css",
354-
docinfo: 'private',
355-
jpaJavadocUrlPrefix: "https://javaee.github.io/javaee-spec/javadocs/javax/persistence/"
365+
attributes jpaJavadocUrlPrefix: "https://javaee.github.io/javaee-spec/javadocs/javax/persistence/"
356366

357367
resources {
358368
from( 'src/main/asciidoc/introduction/' ) {
359369
include 'images/**'
360370
}
361-
from( 'src/main/style/asciidoctor' ) {
362-
include 'images/**'
363-
}
364-
from( 'src/main/style/asciidoctor' ) {
365-
include 'css/**'
366-
}
367-
from( 'src/main/style/asciidoctor' ) {
368-
include 'js/**'
369-
}
371+
from(rootProject.layout.buildDirectory.dir("unpacked-theme").get()
372+
.dir("hibernate-asciidoctor-theme").dir("asciidoc")) {
373+
include 'css/**'
374+
include 'images/**'
375+
include 'script/**'
376+
}
370377
}
371378
}
372379

@@ -408,24 +415,18 @@ def renderQueryLanguageGuideHtmlTask = tasks.register( 'renderQueryLanguageGuide
408415

409416
task.outputDir = layout.buildDirectory.dir( "asciidoc/querylanguage/html_single" )
410417

411-
task.attributes linkcss: true,
412-
stylesheet: "css/hibernate.css",
413-
docinfo: 'private',
414-
jpaJavadocUrlPrefix: "https://javaee.github.io/javaee-spec/javadocs/javax/persistence/"
418+
task.attributes jpaJavadocUrlPrefix: "https://javaee.github.io/javaee-spec/javadocs/javax/persistence/"
415419

416420
task.resources {
417421
from( 'src/main/asciidoc/querylanguage/' ) {
418422
include 'images/**'
419423
}
420-
from( 'src/main/style/asciidoctor' ) {
421-
include 'images/**'
422-
}
423-
from( 'src/main/style/asciidoctor' ) {
424-
include 'css/**'
425-
}
426-
from( 'src/main/style/asciidoctor' ) {
427-
include 'js/**'
428-
}
424+
from(rootProject.layout.buildDirectory.dir("unpacked-theme").get()
425+
.dir("hibernate-asciidoctor-theme").dir("asciidoc")) {
426+
include 'css/**'
427+
include 'images/**'
428+
include 'script/**'
429+
}
429430
}
430431
}
431432

@@ -456,24 +457,18 @@ def renderRepositoriesHtmlTask = tasks.register( 'renderRepositoriesHtml', Ascii
456457

457458
task.outputDir = layout.buildDirectory.dir( "asciidoc/repositories/html_single" )
458459

459-
task.attributes linkcss: true,
460-
stylesheet: "css/hibernate.css",
461-
docinfo: 'private',
462-
jpaJavadocUrlPrefix: "https://javaee.github.io/javaee-spec/javadocs/javax/persistence/"
460+
task.attributes jpaJavadocUrlPrefix: "https://javaee.github.io/javaee-spec/javadocs/javax/persistence/"
463461

464462
task.resources {
465463
from( 'src/main/asciidoc/repositories/' ) {
466464
include 'images/**'
467465
}
468-
from( 'src/main/style/asciidoctor' ) {
469-
include 'images/**'
470-
}
471-
from( 'src/main/style/asciidoctor' ) {
472-
include 'css/**'
473-
}
474-
from( 'src/main/style/asciidoctor' ) {
475-
include 'js/**'
476-
}
466+
from(rootProject.layout.buildDirectory.dir("unpacked-theme").get()
467+
.dir("hibernate-asciidoctor-theme").dir("asciidoc")) {
468+
include 'css/**'
469+
include 'images/**'
470+
include 'script/**'
471+
}
477472
}
478473
}
479474

@@ -672,26 +667,20 @@ def renderUserGuideHtmlTask = tasks.register( 'renderUserGuideHtml', Asciidoctor
672667
}
673668
outputDir = "$buildDir/asciidoc/userguide/html_single"
674669

675-
attributes linkcss: true,
676-
stylesheet: "css/hibernate.css",
677-
docinfo: 'private',
678-
jpaJavadocUrlPrefix: "https://javaee.github.io/javaee-spec/javadocs/javax/persistence/",
670+
attributes jpaJavadocUrlPrefix: "https://javaee.github.io/javaee-spec/javadocs/javax/persistence/",
679671
'generated-report-dir': layout.buildDirectory.dir( 'orm/generated' ).get()
680672

681673
resources {
682674
from( 'src/main/asciidoc/userguide/' ) {
683675
include 'images/**'
684676
}
685-
from( 'src/main/style/asciidoctor' ) {
686-
include 'images/**'
687-
}
688-
from( 'src/main/style/asciidoctor' ) {
689-
include 'css/**'
690-
}
691-
from( 'src/main/style/asciidoctor' ) {
692-
include 'js/**'
693-
}
694-
}
677+
from(rootProject.layout.buildDirectory.dir("unpacked-theme").get()
678+
.dir("hibernate-asciidoctor-theme").dir("asciidoc")) {
679+
include 'css/**'
680+
include 'images/**'
681+
include 'script/**'
682+
}
683+
}
695684
}
696685

697686
def renderUserGuidesTask = tasks.register( 'renderUserGuides' ) { task ->
@@ -715,19 +704,16 @@ def renderIntegrationGuideHtmlTask = tasks.register( "renderIntegrationGuideHtml
715704

716705
outputDir = project.layout.buildDirectory.dir( 'asciidoc/integrationguide/html_single' )
717706

718-
attributes linkcss: true,
719-
stylesheet: "css/hibernate.css"
720-
721707
resources {
722708
from( 'src/main/asciidoc/integrationguide/' ) {
723709
include 'images/**'
724710
}
725-
from( 'src/main/style/asciidoctor' ) {
726-
include 'images/**'
727-
}
728-
from( 'src/main/style/asciidoctor' ) {
729-
include 'css/**'
730-
}
711+
from(rootProject.layout.buildDirectory.dir("unpacked-theme").get()
712+
.dir("hibernate-asciidoctor-theme").dir("asciidoc")) {
713+
include 'css/**'
714+
include 'images/**'
715+
include 'script/**'
716+
}
731717
}
732718
}
733719

@@ -766,16 +752,13 @@ def renderWhatsNewTask = tasks.register( "renderWhatsNew", AsciidoctorTask ) {
766752

767753
outputDir = project.layout.buildDirectory.dir( 'asciidoc/whats-new' )
768754

769-
attributes linkcss: true,
770-
stylesheet: "css/hibernate.css"
771-
772755
resources {
773-
from( 'src/main/style/asciidoctor' ) {
774-
include 'images/**'
775-
}
776-
from( 'src/main/style/asciidoctor' ) {
777-
include 'css/**'
778-
}
756+
from(rootProject.layout.buildDirectory.dir("unpacked-theme").get()
757+
.dir("hibernate-asciidoctor-theme").dir("asciidoc")) {
758+
include 'css/**'
759+
include 'images/**'
760+
include 'script/**'
761+
}
779762
}
780763
}
781764

@@ -805,16 +788,13 @@ def renderMigrationGuideTask = tasks.register( "renderMigrationGuide", Asciidoct
805788

806789
outputDir = project.layout.buildDirectory.dir( 'asciidoc/migration-guide' )
807790

808-
attributes linkcss: true,
809-
stylesheet: "css/hibernate.css"
810-
811791
resources {
812-
from( 'src/main/style/asciidoctor' ) {
813-
include 'images/**'
814-
}
815-
from( 'src/main/style/asciidoctor' ) {
816-
include 'css/**'
817-
}
792+
from(rootProject.layout.buildDirectory.dir("unpacked-theme").get()
793+
.dir("hibernate-asciidoctor-theme").dir("asciidoc")) {
794+
include 'css/**'
795+
include 'images/**'
796+
include 'script/**'
797+
}
818798
}
819799
}
820800

@@ -834,16 +814,13 @@ def renderLoggingReportTask = tasks.register( 'renderLoggingReport', Asciidoctor
834814

835815
task.outputDir = project.layout.buildDirectory.dir( 'asciidoc/logging' )
836816

837-
task.attributes linkcss: true,
838-
stylesheet: "css/hibernate.css"
839-
840817
task.resources {
841-
from( 'src/main/style/asciidoctor' ) {
842-
include 'images/**'
843-
}
844-
from( 'src/main/style/asciidoctor' ) {
845-
include 'css/**'
846-
}
818+
from(rootProject.layout.buildDirectory.dir("unpacked-theme").get()
819+
.dir("hibernate-asciidoctor-theme").dir("asciidoc")) {
820+
include 'css/**'
821+
include 'images/**'
822+
include 'script/**'
823+
}
847824
}
848825
}
849826

@@ -860,16 +837,13 @@ def renderDialectReportTask = tasks.register( 'renderDialectReport', Asciidoctor
860837

861838
task.outputDir = project.layout.buildDirectory.dir( 'asciidoc/dialect' )
862839

863-
task.attributes linkcss: true,
864-
stylesheet: "css/hibernate.css"
865-
866840
task.resources {
867-
from( 'src/main/style/asciidoctor' ) {
868-
include 'images/**'
869-
}
870-
from( 'src/main/style/asciidoctor' ) {
871-
include 'css/**'
872-
}
841+
from(rootProject.layout.buildDirectory.dir("unpacked-theme").get()
842+
.dir("hibernate-asciidoctor-theme").dir("asciidoc")) {
843+
include 'css/**'
844+
include 'images/**'
845+
include 'script/**'
846+
}
873847
}
874848
}
875849

‎documentation/src/main/asciidoc/integrationguide/Hibernate_Integration_Guide.adoc‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
= Hibernate ORM Integration Guide
2-
:toc:
2+
:toc2:
33
:toclevels: 3
4+
:sectanchors:
45

56
include::preface.adoc[]
67

‎documentation/src/main/asciidoc/introduction/Hibernate_Introduction.adoc‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ include::{shared-attributes-dir}/renderer-attributes.adoc[]
77

88

99
= A Short Guide to Hibernate 7
10-
:title-logo-image: image:../../style/asciidoctor/images/org/hibernate/logo.png[]
11-
:toc:
10+
:toc2:
1211
:toclevels: 3
12+
:sectanchors:
1313

1414
include::Preface.adoc[]
1515

‎documentation/src/main/asciidoc/querylanguage/Hibernate_Query_Language.adoc‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,9 @@ include::{shared-attributes-dir}/renderer-attributes.adoc[]
1111

1212
= A Guide to Hibernate Query Language
1313
:title-logo-image: image:../../style/asciidoctor/images/org/hibernate/logo.png[]
14-
:toc:
14+
:toc2:
1515
:toclevels: 3
16+
:sectanchors:
1617

1718
include::Preface.adoc[]
1819

‎documentation/src/main/asciidoc/quickstart/guides/index.adoc‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,9 @@ include::{shared-attributes-dir}/renderer-attributes.adoc[]
77

88
= Getting Started with Hibernate
99
:description: Quick start guide for Hibernate ORM
10-
:toc:
10+
:toc2:
1111
:toclevels: 3
12+
:sectanchors:
1213
:docinfo:
1314

1415
include::preface.adoc[]

0 commit comments

Comments
 (0)