[publican-list] Proposed changes to Book_Info.xml

Jeff Fearn jfearn at redhat.com
Mon Aug 18 05:37:10 UTC 2008


So after chatting with people about this here is the new, new plan! ;)

<bookinfo>
	<title>My Guide</title>
	<productname>The Product</productname>
	<productnumber>5.2</productnumber>
	<edition>1</edition>
	<pubsnumber>0</pubsnumber>



Where:

title: is the books title
productname: is the products name
productnumber: is the products version
edition: is the edition (X.Y)
pubsnumber: is the revision of this edition (Z)


The Layout would roughly be:

Product Name Product Version*
Title
Subtitle*
edition.pubsnumber

* = not mandatory

This gives us the ability to distinguish between major (X), minor (Y) and maintenance (Z) updates to documentation.

One of the main reasons for going to X.Y.Z is to allow translations to be updated independently of each other. So for any edition X.Y of a book, all translations have the same X.Y, but Z is independent for each and every language.

I'm currently working out with translators how best to allow them to set their own Z.

All comments and doughnuts gratefully received!

Cheers, Jeff.

-- 
Jeff Fearn <jfearn at redhat.com>
Software Engineer
Engineering Operations
Red Hat, Inc
Freedom ... courage ... Commitment ... ACCOUNTABILITY




More information about the publican-list mailing list