Standardize source formatting of ubuntu-docs source xml
Affects | Status | Importance | Assigned to | Milestone | |
---|---|---|---|---|---|
ubuntu-docs (Ubuntu) |
Confirmed
|
Wishlist
|
Unassigned |
Bug Description
Binary package hint: ubuntu-docs
The XML source for ubuntu-docs currently has no standardization, which results in a variety of formatting in the source documents. This can be troublesome when editing the docs, and quite possibly for translators as well. Some sentences span multiple lines, and in other cases a paragraph can be in one line.
I would suggest that the docs be formatted with one sentence per line. This means if a sentence is changed, only this string needs to be changed. Then there is a complete sentence structure that needs to be re-translated, rather than a partial thought or entire paragraph.
Reformatting of the source docs may be a good parallel target when switching to Mallard since strings will likely need to be re-translated at this time anyway.
Changed in ubuntu-docs (Ubuntu): | |
importance: | Undecided → Wishlist |
Agreed. This should become part of our new styleguide and team wiki pages.