Lowering the participation barrier for Fedora Docs

Shaun McCance shaunm at gnome.org
Tue Nov 19 02:11:40 UTC 2013


On Mon, 2013-11-18 at 23:28 +0100, Jaromir Hradilek wrote:
> On 11/18/2013 05:39 PM, Shaun McCance wrote:
> > On Sat, 2013-11-16 at 19:21 -0500, Christopher Antila wrote:
> >> - - There is a significant barrier to entry. DocBook is clumsy at first, and
> >> writing XML markup by hand is always a pain (maybe I'm just not using the
> >> right tools). As far as I know, the only way to preview the final output is by
> >> actually making the final output, so DocBook needs a bit of imagination.
> >
> > Yelp renders DocBook on the fly. If you're running GNOME, it's already
> > installed. Auto-reload isn't currently hooked up for DocBook (it is for
> > Mallard), but that's fixable.
> >
> > Of course, Yelp's rendering will differ from Publican's, so you'll want
> > to use Publican for final proofing. But putting Yelp and a text editor
> > side-by-side is a nice way to see a preview of what you're writing.
> 
> For the record, this is what I do on a regular basis and the difference 
> in rendering is not that significant. What I really love about yelp is 
> how fast it renders a reasonably large page (or even an unreasonably 
> large one) in comparison with other tools. And if you ever find some 
> time to fix bug 704821 [1], it will be a killer app.
> 
> [1] https://bugzilla.gnome.org/show_bug.cgi?id=704821

OK, I can't resist making a killer app. Done. :)

https://git.gnome.org/browse/yelp/commit/?id=e3830746e2d03d52a3ac5ceba96198c74eda1ec7





More information about the docs mailing list