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.

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

Feature request: Allow customisation of confluence_page_generation_notice #928

Closed
adamtheturtle opened this issue Mar 18, 2024 · 5 comments
Labels
enhancement Something that can better improve this extension
Milestone

Comments

@adamtheturtle
Copy link

I'd like to add my own warning / styling to the notice.

@jdknight
Copy link
Member

jdknight commented Mar 18, 2024

If the level of customization is a simple text replacement for the notice, I do not see any major issues to support this. For example, supporting either:

confluence_page_generation_notice = True
 (or)
confluence_page_generation_notice = 'My custom notice message.'

Although, complete styling is a bit tricky, as the styling now varies between which Confluence editor used, and* there is a mix of translator/node building and template building (for index, search, etc. pages) that would need some tweaking.

If you would like a more detailed customization of the notice, maybe using a custom confluence_header_file instead would be best? This would allow you to generate any custom message, tags or styling support by the Confluence instance you are targeting.

If this is related to a translation capability (i.e. wanting to use a non-English message), we do accept translation for messages via Crowdin.

That all being said, if there is a customization ideas I missed, I'm open for any details describing the use case.

@adamtheturtle
Copy link
Author

Thank you for the quick and thorough response.

The text-only option would be a nice bonus, and plenty for me. This is not translation-related.
I want to add a warning about inline comments getting wiped (#698, related) .

@jdknight jdknight added the enhancement Something that can better improve this extension label Mar 19, 2024
@jdknight
Copy link
Member

Initial implementation for this has been added in #930. Feel free to try it out using the following command:

pip install git+https://github.com/sphinx-contrib/confluencebuilder.git@support-custom-page-gen-notice

@adamtheturtle
Copy link
Author

Amazingly fast - thank you @jdknight !

@jdknight jdknight added the available-next-release Merged into the main branch but waiting for PyPI release label Mar 21, 2024
@jdknight jdknight added this to the 2.5 milestone Mar 21, 2024
@jdknight
Copy link
Member

jdknight commented Apr 1, 2024

v2.5 is now available on PyPI -- marking as closed.

@jdknight jdknight closed this as completed Apr 1, 2024
@jdknight jdknight removed the available-next-release Merged into the main branch but waiting for PyPI release label Apr 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Something that can better improve this extension
Projects
None yet
Development

No branches or pull requests

2 participants