Note: This bug is displayed in read-only format because the product is no longer active in Red Hat Bugzilla.

Bug 840639

Summary:	Inconsistent casing of titles
Product:	Red Hat Enterprise Virtualization Manager	Reporter:	Stephen Gordon <sgordon>
Component:	Documentation	Assignee:	Stephen Gordon <sgordon>
Status:	CLOSED CURRENTRELEASE	QA Contact:	ecs-bugs
Severity:	unspecified	Docs Contact:
Priority:	unspecified
Version:	3.1.0	CC:	acathrow, dyasny, gklein, jskeoch, yeylon
Target Milestone:	---	Keywords:	Documentation
Target Release:	---
Hardware:	Unspecified
OS:	Unspecified
Whiteboard:
Fixed In Version:	Red_Hat_Enterprise_Virtualization-Installation_Guide-3.1-Beta-web-en-US-3.1.0-7.el6eng	Doc Type:	Bug Fix
Doc Text:		Story Points:	---
Clone Of:		Environment:
Last Closed:	2012-12-04 17:26:21 UTC	Type:	Bug
Regression:	---	Mount Type:	---
Documentation:	---	CRM:
Verified Versions:		Category:	---
oVirt Team:	---	RHEL 7.3 requirements from Atomic Host:
Cloudforms Team:	---	Target Upstream Version:
Embargoed:
Bug Depends On:
Bug Blocks:	815463

Description Stephen Gordon 2012-07-16 19:08:14 UTC

Description of problem:

As part of the rewrite of the Administration Guide many topics are currently having their titles changed to sentence casing (from title case). This is line with the recently adopted IBM Style Guide although the (brief) title case provision does currently still exist in the ECS Style Guide for now.

Many of these topics are also used in the Installation Guide which, at this point, still largely uses title case. Given this we need to decide whether we wish to:

1) Switch the entire Installation Guide to sentence case, ensuring that existing po files for translation are also renamed to match the update titles.

2) Ignore the issue for now, resulting in mixed casing of titles in this guide. 

Version-Release number of selected component (if applicable):

3.1.0

Comment 1 Stephen Gordon 2012-07-16 19:29:04 UTC

Obviously I've missed "3) change all Admin Guide topics to title-case" because I am not sure how feasible this is given the number of topics involved (at least for the 3.1 betas that are fast approaching).

Comment 2 David Ryan 2012-07-18 05:46:36 UTC

Are you using Skynet/Pressgang CCMS? If so, you could run the script that mcasperson ran when the original ruling was made. We were, up until that point, using sentence case too. Maybe ping Matt and see if that's an option.

Comment 3 Stephen Gordon 2012-07-31 15:04:24 UTC

(In reply to comment #2)
> Are you using Skynet/Pressgang CCMS? If so, you could run the script that
> mcasperson ran when the original ruling was made. We were, up until that
> point, using sentence case too. Maybe ping Matt and see if that's an option.

I think Tim checked in on this and the script only handles updating the fixed URLs once the titles had already been updated, makes sense to me because even in sentence case proper nouns remain capitalized which would make scripting such a change difficult (though I guess still not impossible if you are willing to accept some percentage of mistakes).

From an Installation Guide point of view I have gone with option 2 as the guide is being translated for the beta and had to be delivered as is.

Comment 4 Stephen Gordon 2012-09-06 14:45:37 UTC

Content Specification ID: 8983
Revision: 244600

All part/chapter/section titles should now be in title case.