A couple of DocBook style questions

Dean Sas dean at deansas.org
Mon Feb 13 14:30:52 UTC 2006


Matthew East wrote:

<snip>
> I'd also suggest that we use the <filename> tags around names of
> repositories, because that makes them stand out a bit, in monospace,
> which is nice I think.
> 
> As usual, voice any fierce objections here.


I know nothing about docbook, so my opinion is certainly not fierce, but 
shouldn't we use different tags for this?  A repositories tag or 
something more general? Though I'm not sure how trivial or acceptable it 
is to extend doc book in this way.

Using filename tags for something that isn't a file just for stylistic 
reasons isn't good for semantics and it could be non obvious to future 
maintainers or derivatives as to why repositories are marked up as files.

It also introduces extra work if the style for filenames is changed in 
the future, in a way that makes repositories marked up as filenames look 
out of place.

Dean (dsas)

(Forgot about reply-to-list being off)






More information about the ubuntu-doc mailing list