Skip to content

Commit

Permalink
Improve section numbering
Browse files Browse the repository at this point in the history
CDI specification up to version 3.0 used to have the sections numbered
in a friendly way:

1. Architecture
2. Concepts
3. Programming model

And so on. With CDI 4.0 and the split to Lite and Full, sections were
renumbered in a more ugly fashion:

1. Architecture
2. CDI Lite
2.1. Concepts
2.2. Programming model
3. CDI Full

Note that this numbering is different from the TCK Audit tool expectations
and hence the TCK Audit reports are incorrect.

This commit restores the original numbering, which is more user-friendly
and also conforms to the expectations of the TCK Audit tool.
  • Loading branch information
Ladicek committed Sep 20, 2022
1 parent 74827d2 commit 8e69428
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 14 deletions.
14 changes: 5 additions & 9 deletions spec/src/main/asciidoc/cdi-spec.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,10 @@ include::architecture.asciidoc[]
[[part_1]]
= Part I - Core CDI

== {cdi_lite}
include::core/core_structure.adoc[]

:leveloffset: +1
[[part_1a]]
= Part I.A - {cdi_lite}

include::core/definition.asciidoc[]

Expand All @@ -59,11 +60,8 @@ include::core/spi_lite.asciidoc[]

include::core/packagingdeployment.asciidoc[]

:leveloffset: -1

== {cdi_full}

:leveloffset: +1
[[part_1b]]
= Part I.B - {cdi_full}

include::core/definition_full.asciidoc[]

Expand All @@ -85,8 +83,6 @@ include::core/spi_full.asciidoc[]

include::core/packagingdeployment_full.asciidoc[]

:leveloffset: -1

[[part_2]]
= Part II - CDI in Java SE

Expand Down
10 changes: 10 additions & 0 deletions spec/src/main/asciidoc/core/core_structure.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
:numbered!:

== Structure

The Core CDI specification has two subparts:

* {cdi_lite} specification which contains a subset of CDI features and which can be implemented in more restricted environments; this is part of the Jakarta EE Core Profile;
* {cdi_full} specification that builds on top of Lite and adds all advanced CDI features; this is the classic CDI platform that is part of the Jakarta EE Web Profile and Jakarta EE Platform.

:numbered:
5 changes: 3 additions & 2 deletions spec/src/main/asciidoc/core/definition_full.asciidoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
[[concepts_full]]

[partintro]
--
{cdi_full} contains all the functionality defined in {cdi_lite} and adds some additional features such as specialization, decorators, session scope or conversation scope.
Some of these concepts were briefly mentioned in the previous {cdi_lite} chapter and this section of specification defines them in depth.
--

[[scopes_full]]

Expand Down
6 changes: 3 additions & 3 deletions spec/src/main/asciidoc/preface.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ include::license-{license}.asciidoc[]
This document is organized in 4 parts:

* An introduction (this part), which is not part of the specification but introduces CDI concepts and gives examples.
* Core CDI specification: <<part_1>>. This part has two sections:
** {cdi_lite} specification which contains a subset of CDI features and which can be implemented in more restricted environments;
** {cdi_full} specification that builds on top of Lite and adds all advanced CDI features; this is the standard Jakarta EE CDI platform.
* Core CDI specification: <<part_1>>. This part has two subparts:
** {cdi_lite} specification: <<part_1a>>;
** {cdi_full} specification: <<part_1b>>.
* Specific CDI features for Java SE: <<part_2>>.
* Specific CDI features for Jakarta EE: <<part_3>>.

Expand Down

0 comments on commit 8e69428

Please sign in to comment.