Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Replace 'headerFooter' by 'standalone' #1160

Closed
2 tasks
abelsromero opened this issue Apr 5, 2023 · 1 comment · Fixed by #1161
Closed
2 tasks

Replace 'headerFooter' by 'standalone' #1160

abelsromero opened this issue Apr 5, 2023 · 1 comment · Fixed by #1161
Labels
enhancement

Comments

@abelsromero
Copy link
Member

abelsromero commented Apr 5, 2023 •
edited
Loading

I see in the docs that Ruby code :header_hooteris not the recommended option, but instead should be:standalone`.

So, as in other cases, I think we should:

  • Replace it in main branch: since we can do breaking changes 🎆
  • Deprecate in v2.5.8

The only other discrepancy with Asciidoctor Ruby I see are:

  • :header_only (in parseHeaderOnly in AsciidoctorJ), not sure about this, should we rename it?
  • timings, which is missing and I'd also like to add, the cli already has some work done. Will create another issue for that.
@abelsromero
Copy link
Member Author

abelsromero commented Apr 5, 2023 •
edited
Loading

Haven't mentioned, but my ideas with recent changes it:

  1. Get v3.0.0 out! Then port similar changes to the maven-plugin too and release it.
  2. Be able to provide a v2.5.x for a smother transition. Even if we release at the same time as v3.0.0, people should be able to use 2.5.8 first and don't miss much.

abelsromero added a commit to abelsromero/asciidoctorj that referenced this issue Apr 5, 2023
@abelsromero
Replace deprecated 'headerFooter' by 'standalone'
a1e6bbc 
* Replace headerFootr methods in OptionsBuild & Options
* Update referenes to the old methods
* Added 'standalone' description to docs
* Re-ordered options in docs to follow alphabetical order
* Remove some unnecessary throws from tests
* Add missing '@deprecated' to templateDir method

Fixes asciidoctor#1160
@abelsromero abelsromero mentioned this issue Apr 5, 2023
Merged
5 tasks
abelsromero added a commit to abelsromero/asciidoctorj that referenced this issue Apr 5, 2023
@abelsromero
Deprecate 'headerFooter' in favour of 'standalone'
bb37a90 
* Replace headerFooter methods in OptionsBuild & Options
* 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

Fixes asciidoctor#1160
@abelsromero abelsromero mentioned this issue Apr 5, 2023
Merged
5 tasks
abelsromero added a commit to abelsromero/asciidoctorj that referenced this issue Apr 5, 2023
@abelsromero
Replace deprecated 'headerFooter' by 'standalone'
af39c81 
* Replace headerFooter methods in OptionsBuild & Options
* Update referenes to the old methods
* Added 'standalone' description to docs
* Re-ordered options in docs to follow alphabetical order
* Remove some unnecessary throws from tests
* Add missing '@deprecated' to templateDir method

Fixes asciidoctor#1160
abelsromero added a commit to abelsromero/asciidoctorj that referenced this issue Apr 7, 2023
@abelsromero
Deprecate 'headerFooter' in favour of 'standalone'
665660d 
* Replace headerFooter methods in OptionsBuild & Options
* 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
* Add v2.5.x branch to run GH actions

Fixes asciidoctor#1160
abelsromero added a commit to abelsromero/asciidoctorj that referenced this issue Apr 7, 2023
@abelsromero
Deprecate 'headerFooter' in favour of 'standalone'
1be876f 
* Replace headerFooter methods in OptionsBuild & Options
* 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
* Add v2.5.x branch to run GH actions

Fixes asciidoctor#1160
abelsromero added a commit to abelsromero/asciidoctorj that referenced this issue Apr 7, 2023
@abelsromero
Deprecate 'headerFooter' in favour of 'standalone'
e330544 
* Replace headerFooter methods in OptionsBuild & Options
* 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
* Add v2.5.x branch to run GH actions

Fixes asciidoctor#1160
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Replace deprecated 'headerFooter' by 'standalone' abelsromero/asciidoctorj
1 participant
@abelsromero