DocBook isn't the easiest toolchain to work with (alas)... It has the advantage of generating both PDF and reasonable HTML. There is also the option of writing it in LaTeX (which can also generate both HTML and PDF), or in straight HTML (great things are possible these days with using CSS, including generating reasonable PDF). As for using YAML for the spec itself - YAML Ain't Markup Language. It is meant for data, and writing a document is definitely markup rather then data.

Have fun,

    Oren Ben-Kiki

On Sun, Oct 16, 2011 at 7:41 AM, Peter Murphy <> wrote:

> In the mean time, I would really like to see this in a GitHub project,
> so we can get this ball really rolling. That will make it easier to
> collaborate and others can submit issues if they see problems or have
> ideas. This can be a pure specs project, and implementation can be
> handled later in a fork.
> I don't know how familiar you are with git, so let me know and I'm
> happy to do as much as needed to make it happen.

I have used git in several areas, albeit in cloning existing projects
rather than creating new projects. Which leads onto the following...

> BTW, what format is the original document in?

The first version of the document was written in MS Word 2007 - latter
versions were written in LibreOffice to an .odt format. On the plus
side, it is easy to save to PDF. On the minus side, LibreOffice is not
the most user friendly tool. I have not worked out if there are any
good tools to get it to DocBook. (And DocBook is what the original
YAML specs were written in.)

What format should the master YPath specification document be in?
DocBook XML? (Unless someone's worked out how to make some YAML
variant of DocBook, which would take "eating your own dogfood" to the
next level). Or any other suggestions?

Best regards,
All the data continuously generated in your IT infrastructure contains a
definitive record of customers, application performance, security
threats, fraudulent activity and more. Splunk takes this data and makes
sense of it. Business sense. IT sense. Common sense.
Yaml-core mailing list