Re: oXygen XML editor for XSDs and (potentially) tech doc formats: Mac or Win?

[Michael Hopwood <Michael -dot- Hopwood -at- Gleif -dot- org>]

Hello Alan, colleagues,

firstly thanks to Alan for this excellent feedback â I am now looking at a (valid) draft XML schema writing with oXygen in record time.

My follow-up question is for the whole list, because itâs not necessarily specific to oXygen:

Before I reinvent any wheels, could anyone share some best practice of single-sourcing the XML schema documentation?

Status quo is a lot of freehand <! - - comments - - >in the XML schema itself. Not very reusable or easy to keep updated.

Iâm planning on going through them all to at least chunk them down into e.g.

- element name
- cardinality
- content specification/datatype
- business rules beyond schema validation

The idea is to then update the comments simultaneously to changes to the schema content, and export the XML comments into some text format before editing and applying formatting for review. There will be a few cycles of this at least.

But are there some good tips and tricks, maybe using oXygen, maybe generally part of XML, like using <annotation> or some XSLT someone might know of (I found a lot of dead links while searching for that).

Iâm afraid I need something pretty simple, like dumping a table of extracted comments for use in Word - learning DocBook etc. will have to wait til next year once the schemaâs in use and stable.

Best wishes,

Michael
Technical Writer, GLEIF

On 7/21/16, 4:40 PM, "Alan Houser" <arh -at- groupwellesley -dot- com> wrote:

Michael,

There are no differences between the MacOS and Windows versions of 
oXygen. Also, I recall correctly, your license key will work on either 
platform. You don't need to pick an OS when you purchase oXygen, just 
download the appropriate installer.

It's refreshing to be able to use a full-featured tech pubs tool on MacOS.

-Alan
----

Alan Houser
Group Wellesley, Inc.
Consultant and Trainer, Technical Publishing
arh on Twitter
412-450-0532

On 7/21/16 10:01 AM, Michael Hopwood wrote:
> Dear techwhirl colleagues,
>   
> Iâm looking at buying oXygen XML editor for creating/testing/maintaining/documenting XSDs and (potentially) help in one or more of the typical tech doc formats.
>   
> I note there are both Mac and Windows versions â are there any pros or cons of using one or the other?
>   
> I would use the Win version on a virtual machine (Parallels).
>   
> Best wishes,
>
> Michael Hopwood
> Technical Writer
> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
> Global Legal Entity Identifier Foundation (GLEIF)
> Bleichstrasse 59, 60313, Frankfurt am Main, Germany
> Phone: +49 151 17120513
> Mobile: +49 175 15645-15
> Web: www.gleif.org
> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
> Global Legal Entity Identifier Foundation (GLEIF)
> BÃumleingasse 22, 4051, Basel, Switzerland
> Chairman of the Board: Gerard Hartsink
> CEO: Stephan Wolf
>
> This message may contain confidential and/or privileged information. If you are not the intended recipient or if you have received this message in error, please notify the sender and delete this message. Any unauthorised copying, disclosure or distribution of this message is strictly forbidden.
>
>



^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Visit TechWhirl for the latest on content technology, content strategy and content development | http://techwhirl.com

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot- 

To unsubscribe send a blank email to
techwr-l-leave -at- lists -dot- techwr-l -dot- com


Send administrative questions to admin -at- techwr-l -dot- com -dot-  Visit
http://www.techwhirl.com/email-discussion-groups/ for more resources and info.

Looking for articles on Technical Communications?  Head over to our online magazine at http://techwhirl.com

Looking for the archived Techwr-l email discussions?  Search our public email archives @ http://techwr-l.com/archives