As one of the template authors, I can tell you that the templates were intended for short documents - for longer ones, like gedit manual, it definitely makes sense to have more top-level sections. And yes, the templates could use some updating
As for lower-case "gedit", I'd suggest using just Gedit rather than &app; in the title. Sasha On 6/16/06, Joachim Noreiko <[EMAIL PROTECTED]> wrote: > (Resending this because Shaun didn't get it, mailing > lists being awkward.) > > I've started to take a look at the manual for gedit, > and there's a few points I'd like advice on. > > Firstly, the title of the manual is "gedit Manual", > with a lowercase g because &app; is defined with a > lowercase g -- gedit is always seen in lowercase, in > the app, on the website and so on. > Compare with > http://bugzilla.gnome.org/show_bug.cgi?id=344544, and > Shaun's comment that lowercase titles are bad (with > which I agree). What's the solution? > > Secondly, the manual closely follows the template > that's on the developer website [1]. It's divided into > Intro, Getting Started, and Usage. > The problem with this is that the Usage section is > already very big, and stands to get bigger as there > are a lot of new features since the manual was last > updated. > This would be ok if Yelp split it up, but it doesn't: > it's a single very long page. > Should I force Yelp to split the section into pages > (and could someone remind me how), or split more > top-level sections out of Usage? (And in that case, is > the title 'Usage' still accurate?) > > Sort of thirdly, should the template be updated to > reflect this sort of thing? > And while I'm on the subject of the templates, a very > long time ago Shaun told me they needed updating to > gnome-doc-utils. Has that been done yet? Is there > anything there I can help with? > > [1] > http://developer.gnome.org/projects/gdp/templates.html > > Joachim > > > _______________________________________________ gnome-doc-list mailing list [email protected] http://mail.gnome.org/mailman/listinfo/gnome-doc-list
