-
Notifications
You must be signed in to change notification settings - Fork 173
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.
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
Add documentation for logging from extensions #1071
Add documentation for logging from extensions #1071
Conversation
[[sourcemap]] | ||
== sourcemap | ||
|
||
Keeps track of the file and line number for each parsed block. (Useful for tooling applications where the association between the converted output and the source file is important). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the parenthesis are a leftover?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I copied this sentence as is from the Asciidoctor.js module to make sure that we don't provide deviating definitions. :D
But yeah, I'll remove the parens.
I tested this and it works great. This is exactly what I had in mind for being able to log from an extension.
|
Something I think we should add to the docs is how to configure JUL so that it matches the default log output of Asciidoctor Ruby. This is more of demonstration, but it gives the user a launching off point. logging.properties
Calling asciidoctorj:
Let me know if you'd like a separate issue for that and I'll file it. |
Keep in mind that if the default level is INFO instead of WARNING, users will see provisional messages about possible invalid xrefs...which could be valid xrefs that Asciidoctor just can't resolve. |
Thanks for the feedback! |
Added a comment to the converter docs that they can also log by calling |
Thank you for opening a pull request and contributing to AsciidoctorJ!
Please take a bit of time giving some details about your pull request:
Kind of change
Description
Add documentation for how an extension can log messages that are also captured by build tools like the maven or gradle plugin.