Doc Template (Was: Doc-team members going to UDS?)

[Paul Cutler]

I'd like to echo Jim's comment and would be hopeful to see Mallard be used.
Not only is the markup much more simple than Docbook, especially for a new
contributor, but the focus on topic based help makes it better for readers
and easier for writers to write good help.

I've just switched back to Ubuntu after a break for the last couple of years
and I work on GNOME documentation and have started porting and writing
Mallard docs for some applications.  If you need any help, let me know.

Paul

On Sat, Oct 17, 2009 at 11:37 AM, Shaun McCance <shaunm at gnome.org> wrote:

> On Fri, 2009-10-16 at 15:39 -0400, Kyle Nitzsche wrote:
> > Jim Campbell wrote:
> > > On Fri, Oct 16, 2009 at 12:57 PM, Ian <vern at riseup.net> wrote:
> > >
> > >> Hi
> > >>
> > >>> I am hoping to hold a session on 'doctemplate.' This is a 'template'
> > >>> I've been developing hosted on LP (https://launchpad.net/doctemplate
> )
> > >>> that allows one to create new documentation:
> > >>>  * Whose source is docbook (article or book)
> > >>>  * That is easily localizable (images, strings)
> > >>>  * That supports numerous localized outputs: pdf, html (with a
> > >>> javascript-based UI with a navigation TOC, next/previous buttons,
> etc),
> > >>> docbook
> > >>>  * All controlled by a few simple and well-documented make commands.
> > >>>  * Optional installation with package installation such that it is
> > >>> registered with rarian for display in yelp.
> > >>>  * String localization can be done in LP in a straightforward manner.
> > >>>
> > >> Some more ideas:
> > >>
> > >> When you sign up to the doc team through LP, the first thing you’ll do
> > >> is check the  project you want out of bazaar
> > >> You send stuff by checking it in
> > >> The continuous build system will let you see your contributions
> > >> formatted as it will be printed in pdf/html etc.
> > >> And, if your contribution contains code it is kept in separate source
> > >> code files and the build system will include the extracts you want
> > >> directly into the formatted final document (and it’ll syntax highlight
> > >> them along the way).
> > >>
> > >> I will be @ UDS for the meeting
> > >>
> > >>
> > Looking forward to seeing you there, Ian, and talking more about these
> > ideas.
> > >> Ian
> > >>
> > >> --
> > >> http://ianlawrence.info
> > >>
> > >>
> > >
> > > I've started this as a new thread.  I'm hopeful that this project
> > > could be made to work with Mallard syntax (the xml-based syntax that
> > > is being used for new upstream GNOME documentation)
> > If Mallard provides xslt transforms that convert it into html (like
> > nwalsh's do for docbook) then this is possible. As a first step, I
> > assume the source is a docbook article or book. Mallard looks very
> > interesting, but I don't really know enough about it yet.
>
> It's all in gnome-doc-utils.
>
> And, by the way, if your goal is to produce HTML that is similar
> to what users will see in their help viewer, then you should look
> at using the DocBook stylesheets from gnome-doc-utils as well.
>
> --
> Shaun
>
>
>
> --
> ubuntu-doc mailing list
> ubuntu-doc at lists.ubuntu.com
> https://lists.ubuntu.com/mailman/listinfo/ubuntu-doc
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.ubuntu.com/archives/ubuntu-doc/attachments/20091017/0153946f/attachment.html>