Open Stack

On 11/20/2013 06:54 PM, Andy Dugas wrote:
> Most of our doc team uses Xmetal and DITA. I understand the need to use
> oXygen with the plugin.
> 
> My questions is, XML being XML, if I could use Xmetal locally as an
> editor, then use oXygen to move the same files in and out of the
> OpenStack doc repositories. Would our CMS-related tags be accepted (ie,
> ignored) or would they (or anything else in this scenario) prevent their
> inclusion in OpenStack docs?

Hi Andy,
There's no requirement to use Oxygen to edit OpenStack XML and there is
no integration with Oxygen and git to worry about. You can just use git
from the command line to do your gerrit reviews.

I haven't used XMetaL in several years, so check with XMetaL support to
see if they've fixed this, but a mis-feature of XMetaL is that if you
configure it to pretty-print the XML, then it reformats the entire file
according to its rules when you open the file. As a result, when you do
your gerrit review, it will appear as if you touched every line in the
file and make it impossible to see what you actually changed, so your
gerrit review would probably die on the vine. The alternative is to
configure XMetaL not to pretty-print DocBook files. The only down-side
to this is that where  you do write new content or revise existing
content, the XML will not be formatted at all. It will be one long line.

Oxygen is much nicer in this respect in that it only reformats the
elements you actually edit. So you could use Oxygen in conjunction with
other editors without having Oxygen introduce spurious whitespace
changes. If you're using a source control system to manage your XML
files, it's really only feasible to use XMetaL in an environment where
everyone uses XMetaL and all the versions of XMetaL are configured
exactly the same way wrt pretty printing.

You should also check to see if XMetaL now supports relaxNG schemas. If
so, you could validate it against our schema. Back when I used it,
XMetaL could only use DTDs and w3c schemas (though I think a w3c DocBook
schema now exists out there somewhere).

Regards,
David

> 
> Please advise.
> 
> Andy Dugas
> Staff Technical Writer
> adugas at vmware.com
> 3421 Hillview Ave. Palo Alto CA 94304 (work)
> USA-CA-Promontory A
> 1-650-427-3803
> 
> 
> 
> _______________________________________________
> Openstack-docs mailing list
> Openstack-docs at lists.openstack.org
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
>