Replace deprecated 'headerFooter' by 'standalone' - Githubissues

asciidoctor / asciidoctorj

:coffee: Java bindings for Asciidoctor. Asciidoctor on the JVM!

http://asciidoctor.org

Apache License 2.0

623 stars 173 forks source link

Replace deprecated 'headerFooter' by 'standalone' #1161

Closed abelsromero closed 1 year ago

abelsromero commented 1 year ago

Kind of change

[ ] Bug fix
[ ] New non-breaking feature
[x] New breaking feature
[x] Documentation update
[ ] Build improvement

Description

What is the goal of this pull request?

Replace deprecated 'headerFooter' by 'standalone'

Replace headerFooter methods in OptionsBuild & Options
Update referenes to the old methods
Added 'standalone' description to docs Other changes included:
Re-ordered options in docs to follow alphabetical order
Remove some unnecessary throws from tests
Add missing '@deprecated' to templateDir method

How does it achieve that?

Simply rename method and change the use of the header_footer option in the internal map by standalone.

Are there any alternative ways to implement this?

We could have deprecated the headerFooter method but since this is for v3.0.0...breaking changes are ok. I'll create a PR to deprecate in v2.5.x

Are there any implications of this pull request? Anything a user must know? No.

Issue

If this PR fixes an open issue, please add a line of the form:

Fixes #1160

Release notes

Please add a corresponding entry to the file CHANGELOG.adoc

robertpanzer commented 1 year ago

Thank you!