Embedding transform history in oXygen output
Hi all, thanks again for all the help several weeks ago. Demo'ing oXygen in a project-wide DocBook documentation planning session was very useful. I am wondering if there is a way to automatically embed information about transformation history into HTML generated by oXygen. I'm thinking about chapters and articles, etc. produced by a distributed volunteer force where an editor upstream may have questions about the XSL stylesheet version, the date the file was produced, etc. I am thinking this metadata would probably work best as hidden comments. We can (and probably should) use our forthcoming style manual to require inserting this information regardless of the method of production, and enforce usage through the usual methods (bribes, pleading, public floggings, etc.); not everyone will be using oXygen, and some may be using batch files that effectively serve the same purpose. But I can see where downstream it would be useful to generate as much of this automatically as possible. -- -- | Karen G. Schneider | Community Librarian | Equinox Software Inc. "The Evergreen Experts" | Toll-free: 1.877.Open.ILS (1.877.673.6457) x712 | kgs@esilibrary.com | Web: http://www.esilibrary.com
Hello, I think such DocBook metadata should be added inside the <info> element. An element <author> like the following can be added as child of <info> for each author/contributor: <author> <personname> <honorific>Dr</honorific> <firstname>John</firstname> <othername>D.</othername> <surname>Doe</surname> <lineage>Jr.</lineage> </personname> <contrib>Added intro chapter. Edited with Oxygen and transformed with the built-in DocBook XSL 1.75.1.</contrib> <address> <city>City</city> <street>Street</street> <postcode>123456</postcode> <country>USA</country> </address> <email>john.doe@abc.com</email> </author> Regards, Sorin Karen Schneider wrote:
Hi all, thanks again for all the help several weeks ago. Demo'ing oXygen in a project-wide DocBook documentation planning session was very useful.
I am wondering if there is a way to automatically embed information about transformation history into HTML generated by oXygen. I'm thinking about chapters and articles, etc. produced by a distributed volunteer force where an editor upstream may have questions about the XSL stylesheet version, the date the file was produced, etc. I am thinking this metadata would probably work best as hidden comments.
We can (and probably should) use our forthcoming style manual to require inserting this information regardless of the method of production, and enforce usage through the usual methods (bribes, pleading, public floggings, etc.); not everyone will be using oXygen, and some may be using batch files that effectively serve the same purpose. But I can see where downstream it would be useful to generate as much of this automatically as possible.
Hello, In Oxygen the contributors can enforce the author elements with a schema that validates the document. The author element is optional in the DocBook schema but you can create an additional schema that checks the conditions that you want, for example a Schematron schema and validate the DocBook document with both schemas: the DocBook schema and your additional schema. Regards, Sorin Karen Schneider wrote:
We can (and probably should) use our forthcoming style manual to require inserting this information regardless of the method of production, and enforce usage through the usual methods (bribes, pleading, public floggings, etc.); not everyone will be using oXygen, and some may be using batch files that effectively serve the same purpose.
On Fri, Jun 12, 2009 at 8:34 AM, Sorin Ristache<sorin@oxygenxml.com> wrote:
Hello,
In Oxygen the contributors can enforce the author elements with a schema that validates the document. The author element is optional in the DocBook schema but you can create an additional schema that checks the conditions that you want, for example a Schematron schema and validate the DocBook document with both schemas: the DocBook schema and your additional schema.
Regards, Sorin
Cool! Sounds like this would be a valuable part of our toolkit. -- -- | Karen G. Schneider | Community Librarian | Equinox Software Inc. "The Evergreen Experts" | Toll-free: 1.877.Open.ILS (1.877.673.6457) x712 | kgs@esilibrary.com | Web: http://www.esilibrary.com
participants (2)
-
Karen Schneider -
Sorin Ristache