Bug 429295

Summary: Revise rendering of <systemitem> tag
Product: [Community] Publican Reporter: David O'Brien <daobrien>
Component: publicanAssignee: Andy Fitzsimon <afitzsim>
Status: CLOSED NEXTRELEASE QA Contact: Michael Hideo <mhideo>
Severity: low Docs Contact:
Priority: low    
Version: 2.0CC: bforte, mmcallis, publican-list
Target Milestone: ---Keywords: Documentation
Target Release: ---   
Hardware: All   
OS: Linux   
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2008-02-25 07:05:51 UTC Type: ---
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:

Description David O'Brien 2008-01-18 15:52:12 UTC
(created from RT 16771)

hey Andy,
in our doc I've introduced the following:
(e.g.)
<systemitem class="username">root</systemitem>

This gets used for, funnily enough, usernames. At present, text marked up this
way is rendered no differently from other text. I don't know if there are any
recommendations in any style guides, etc., but for our purposes it just needs to
stand out from the surrounding text. I'm happy for you to pick something (but
not italics please - yuk ;)

fwiw, <systemitem> also supports the following classes, so it might be worth
considering how we could group some of these for future use, and render accordingly:

constant
daemon
domainname
etheraddress
event
eventhandler
filesystem
fqdomainname
groupname
ipaddress
library
macro
netmask
newsgroup
osname
process
protocol
resource
server
service
systemname
username

I know you have a full plate; graphics comes before this :)

cheers mate

Comment 1 Andy Fitzsimon 2008-02-25 06:59:12 UTC
I've fixed this one upstream for all book themes now.



Comment 2 David O'Brien 2008-02-25 07:05:51 UTC
thanks Andy.

Brian, can bear this in mind when writing up any style guide doc?