DocBook docs

Phil Bull philbull at gmail.com
Sat Dec 22 11:34:54 UTC 2007


Hi Emma,

On Mon, 2007-12-17 at 00:53 -0500, Emma Jane Hogbin wrote:
> I've been poking around on the new wikified style guide pages. Thanks 
> for breaking it up, Phil!
> 
> I found these two pages on DocBook:
> https://help.ubuntu.com/community/DocBook
> https://help.ubuntu.com/community/DocBookReference?highlight=%28%28DocBook%29%29
> 
> Apart from the license being wrong for the style guide, is there a 
> reason why this information shouldn't be incorporated into the Style 
> Guide/DocBook page at:
> https://wiki.ubuntu.com/DocumentationTeam/StyleGuide/DocbookConventions

No, that sounds like a good idea. It seems redundant having three pages
on (broadly) the same subject, and I don't really see the need to have
documentation on DocBook on the help wiki (as opposed to the team wiki).
There's another page on DocBook too [1].

The Style Guide should probably be relicensed to have the same license
as the wiki too.

> The first of those two pages on DocBook needs some editing as well--and 
> depending on the context of the document a re-think about the depth of 
> information to provide. Within the seven pages of information readers 
> jump from XML markup languages to shell scripting to style sheets and 
> transformations and needing a local web server configured (I don't 
> *think* Apache is installed by default, is it?). That's a LOT to absorb 
> all in one page.

It's worth saving the information on style sheets and the like, but they
might be more appropriately placed outside the style guide. What sort of
scope do you think the style guide section on DocBook should have?

Thanks,

Phil

[1] - https://wiki.ubuntu.com/DocumentationTeam/DocbookTags

-- 
Phil Bull
http://www.launchpad.net/people/philbull





More information about the ubuntu-doc mailing list