-
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Labels
Waiting for: ImplementationAdded to a milestone, will be resolved according to the milestone timeline.Added to a milestone, will be resolved according to the milestone timeline.documentationImprovements or additions to the documentation.Improvements or additions to the documentation.enhancementAdding or requesting a new feature.Adding or requesting a new feature.good first issueOpportunity for newcoming contributors.Opportunity for newcoming contributors.
Milestone
Description
Describe the problem
Right now, there is a huge table of file format capabilities at https://docs.weblate.org/en/latest/formats.html#translation-types-capabilities
This is hard to read, navigate, and find.
Describe the solution you'd like
The documentation should be moved to file format specific pages. Each page should have a heading section (table or field list) including data from the table.
The actual rendering should be first discussed, but we're already using field lists for add-ons and checks, so it might be reasonable to be consistent here.
Additional info should be included:
- Support for read-only strings (currently at https://docs.weblate.org/en/latest/formats.html#read-only-strings)
- List of file extensions/names common for this format
- API identifier - ID which is used when identifying this file format in API, can be found as
format_idin the source, for example:weblate/weblate/formats/ttkit.py
Line 1175 in 5a62dca
format_id = "po-mono"
Describe alternatives you've considered
No response
Screenshots
No response
Additional context
As a preparation for this, file format documentation was split to individual pages in 1d32263.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
Waiting for: ImplementationAdded to a milestone, will be resolved according to the milestone timeline.Added to a milestone, will be resolved according to the milestone timeline.documentationImprovements or additions to the documentation.Improvements or additions to the documentation.enhancementAdding or requesting a new feature.Adding or requesting a new feature.good first issueOpportunity for newcoming contributors.Opportunity for newcoming contributors.