Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 123776 - Power Managment Guide guidexml fixes and minor touchups
Summary: Power Managment Guide guidexml fixes and minor touchups
Status: RESOLVED FIXED
Alias: None
Product: [OLD] Docs on www.gentoo.org
Classification: Unclassified
Component: Other documents (show other bugs)
Hardware: All Linux
: High normal (vote)
Assignee: Docs Team
URL: http://www.gentoo.org/doc/en/power-ma...
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2006-02-22 19:06 UTC by Chris White (RETIRED)
Modified: 2006-07-27 01:21 UTC (History)
1 user (show)

See Also:
Package list:
Runtime testing required: ---


Attachments
power-management-guide.diff (power-management-guide.diff,25.32 KB, patch)
2006-02-22 19:06 UTC, Chris White (RETIRED)
Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Chris White (RETIRED) gentoo-dev 2006-02-22 19:06:01 UTC
See the attached diff for the gorey details!
Comment 1 Chris White (RETIRED) gentoo-dev 2006-02-22 19:06:21 UTC
Created attachment 80489 [details, diff]
power-management-guide.diff
Comment 2 Dennis Nienhüser (RETIRED) gentoo-dev 2006-02-23 06:38:25 UTC
Thanks for the cleanup, looks good to me. Not sure about <e> vs. <b>, is there some kind of policy for that?
Comment 3 nm (RETIRED) gentoo-dev 2006-03-11 10:31:37 UTC
(In reply to comment #0)
> See the attached diff for the gorey details!
> 

Eh, I'm not liking this. It's not proper English to capitalize articles (a, an, the) and conjunctives (and, but). Also, the general title capitalization standard across the guides has been this: If it's a Chapter title, capitalize all the words (with the above exceptions). If it's just a Section title, then only the first word of the title is capitalized. 90% of the docs are done this way, at least!

Still, you did do some significant work in creating this patch. Can you clean it up and resubmit for further evaluation? And/or explanations, etc. I'd be much obliged. :)
Comment 4 nm (RETIRED) gentoo-dev 2006-03-11 10:32:30 UTC
(In reply to comment #3)
> (In reply to comment #0)
Oh, and prepositions should never be capitalized. Forgot to mention that.
Comment 5 Chris White (RETIRED) gentoo-dev 2006-03-11 13:15:51 UTC
Well, let's say that:

http://www.gentoo.org/doc/en/xml-guide.xml

is considered the "policy" on writing docs. Then the actual rule would go:

"Chapter and section titles should have just the first letter capitalized. The same rule applies to pre captions as well."

If we want something different it should be noted in the policy so the docs are more consistant. Otherwise it seems a little odd to tell people "Do it this way before the patch gets commited". The same rule has applied to Gentoo development in general, and has worked out pretty well (save the flamewars ;). Once a decision is made I'll clean this up.
Comment 6 Dennis Nienhüser (RETIRED) gentoo-dev 2006-05-13 15:55:08 UTC
Any progress here?
Comment 7 Łukasz Damentko (RETIRED) gentoo-dev 2006-07-27 01:21:13 UTC
Fixed in CVS. Thanks for the patch. If you want to modify it further, please reopen the bug.