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

De-duplicate BBCodes information #9998

Open
Ivorforce opened this issue Sep 25, 2024 · 5 comments
Open

De-duplicate BBCodes information #9998

Ivorforce opened this issue Sep 25, 2024 · 5 comments
Labels
area:contributing Issues and PRs related to the Contributing/Development section of the documentation area:manual Issues and PRs related to the Manual/Tutorials section of the documentation enhancement

Comments

@Ivorforce
Copy link
Contributor

Ivorforce commented Sep 25, 2024

Referring to #9996 (comment), BBCodes are currently documented 3 5 times:

It might be better to have a separate, independent page for bbcodes. If the info from RichTextLabel should not be merged into the ones for the documentation system, at least the others can be merged together as they really are the same use-case.

@tetrapod00
Copy link
Contributor

Related: godotengine/godot-proposals#10339

@paddy-exe
Copy link
Contributor

The documentation for the GDExtension docs system can't be merged with the others because not all BBCode features are support in that system. Before creating my docs PR I tried out pretty much every tag there is.

@Ivorforce
Copy link
Contributor Author

@paddy-exe That's good to have confirmed.

But do you know if it's true for the class references and script documentation system too? I would have thought at least those 3 would use the same subset of bbcodes.

@paddy-exe
Copy link
Contributor

@Ivorforce From what I am seeing looking at these pages it seems to me like the GDExtension, GDScript system use the same system underneath.
The RichTextLabel docs are more in-depth since it supports all the tags available.
The class reference doesn't reference any [img] tag support. Not sure if it does support this. Otherwise I doubt that this would get merged into the engine anyways.
The class reference translation docs only explains a short section what should/should not be translated so I think that should be fine.

@Ivorforce
Copy link
Contributor Author

Ok, sounds good. Then i propose we create a new page for bbcodes / formatting in class references, link it from all 4 pages (translation too), and keep page-specific info to a minimum (eg in the translation Page, the info about how to work with these tags in translation). RichTextLabel can be linked for context but should be kept separate.

@skyace65 skyace65 added area:manual Issues and PRs related to the Manual/Tutorials section of the documentation area:contributing Issues and PRs related to the Contributing/Development section of the documentation labels Oct 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:contributing Issues and PRs related to the Contributing/Development section of the documentation area:manual Issues and PRs related to the Manual/Tutorials section of the documentation enhancement
Projects
None yet
Development

No branches or pull requests

4 participants