GNOME Bugzilla – Bug 791710
css documentation, non-breaking spaces/hyphens, and other details
Last modified: 2018-01-02 17:47:30 UTC
This series of patches fix a lot of formatting details in the CSS documentation. ---- Non-breaking spaces and hyphens ---- This is related to this bug on gtk-doc: https://bugzilla.gnome.org/show_bug.cgi?id=783368 3 patches address this issue: css docs: Get rid of non-breaking spaces css docs: Get rid of non-breaking hyphens css docs: Ensure the first column does not break for every table As you can see, I removed all the non-breaking characters, and used the DocBook element '<phrase role="nowrap">' instead. I didn't enclose every possible css property within the '<phrase>' elements, as it would make the whole thing unreadable. I just focused on the first column of every table, since it's where the non-breaking characters were located anyway. By doing it systematically for every cell of the first column, at least we get something consistent and readable. This will work only after the gtk-doc patch mentioned above is applied. In the meantime, for testing, it's still possible to modify the file 'style.css' in the generated documentation, and to add the line: span.nowrap { white-space: nowrap; } ---- Other patches ---- The other patches are typo and formatting that I fixed while I was passing by. Cheers !
Created attachment 365651 [details] [review] 0001-css-docs-Fix-some-angle-brackets-for-percentage.patch
Created attachment 365652 [details] [review] 0002-css-docs-Get-rid-of-non-breaking-spaces.patch
Created attachment 365653 [details] [review] 0003-css-docs-Get-rid-of-non-breaking-hyphens.patch
Created attachment 365654 [details] [review] 0004-css-docs-Ensure-the-first-column-does-not-break-for-.patch
Created attachment 365655 [details] [review] 0005-css-docs-Fix-refentry-and-refname.patch
Created attachment 365656 [details] [review] 0006-css-docs-Fix-duplicate-border-right-width.patch
Created attachment 365657 [details] [review] 0007-css-docs-swap-border-width-and-border-left-shorthand.patch
Created attachment 365658 [details] [review] 0008-css-docs-remove-useless-para.patch
Created attachment 365659 [details] [review] 0009-css-docs-fix-some-formatting-inconsistencies-along-t.patch
Created attachment 365660 [details] [review] 0010-gtk-remove-non-breaking-space-probably-there-by-mist.patch
This looks all good to me, thanks for working on this! Are these patches for gtk-3-22 or for master ?
This is all for the master branch.
Do we want these picked to 3-22 also? Certainly commit b42fc417bdfd26ebc5af65b3db8d8d646693029f should be, and I'll pick that shortly, but maybe the others would be good too. I've not tried them yet in case the answer to this question is no.
In general, keeping the branches closer together is a win, so if the patches apply without too much effort, picking them would be good.
Cool. They seem to apply fairly easily. However, should we withhold these from gtk-3-22 until a gtk-doc release containing the relevant patch has been made? I figure that pushing them before then might be a pain for distro packagers.
It is harmless - all that will happen is that some of the property names in those tables get broken at the dashes.