[x3d-public] production of node reference pages

[Joe D Williams]

> The key is getting the master document correct.

Of course we recognize that the 'master document' comprises the 
keystrokes and markup in the actual approved normative text of the ISO 
standards.
First, those must be correct and directly readable by humans and under 
direct transparent and trackable control of one or more but not too 
many human(s).
All the rest is non-normative and just some creative and thoughtfully 
applied automation to help keep the standard and supporting keystrokes 
real and adding some informative implementation details of the 
documentation. .

Thanks and Best,
Joe



----- Original Message ----- 
From: "Don Brutzman" <brutzman at nps.edu>
To: "Roy Walmsley" <roy.walmsley at ntlworld.com>
Cc: "'X3D Graphics public mailing list'" <x3d-public at web3d.org>
Sent: Thursday, October 22, 2015 6:08 AM
Subject: Re: [x3d-public] production of node reference pages


> Sounds great, very sensible.
>
> Every one of our automated products only emerged after much manual 
> effort, which is necessary to understand the problem and evolve best 
> practices.  No doubt you've observed this first-hand already.
>
> Thanks for the continued steady scrutiny, it helps everyone.
>
>
> On 10/21/2015 2:10 PM, Roy Walmsley wrote:
>> Don,
>>
>> I have been going through the node reference pages on the wiki as a 
>> means of reviewing both the DTD and the Schema. One result of this 
>> work has been the 'Status of xxxxx in DTD/Schema' series of mail 
>> reports. I was also intending to apply this review to the 
>> Schematron,  but haven't gone there yet.
>>
>> However, you are right. These could be auto generated. However, 
>> doing so in the first instance would weaken the depth and quality 
>> of the reviewing process. So, for the time being, I will probably 
>> continue manually, as and when we complete the ComposedTexture3D 
>> node in our Monday meeting.
>>
>> I am sure auto generation has a long way to run. The key is getting 
>> the master document correct.
>>
>> Onwards and upwards,
>>
>> Roy
>>
>> -----Original Message-----
>> From: Don Brutzman [mailto:brutzman at nps.edu]
>> Sent: 21 October 2015 20:53
>> To: Roy Walmsley
>> Cc: X3D Graphics public mailing list
>> Subject: production of node reference pages
>>
>> Roy, thanks for pointing out your node reference pages during 
>> today's working group call, e.g.
>>
>> http://www.web3d.org/wiki/index.php/Anchor
>>
>> Certainly there is great personal learning benefit to going thru 
>> this effort.
>>
>> Even so, it also looks like this information is all in X3D schema 
>> and X3D tooltips as well.  Each of those are XML documents so each 
>> wiki entry could be autogenerated.
>>
>> You might also cross-link pages:  spec paragraph, DTD docs, schema 
>> docs, tooltips bookmark, etc.
>>
>> http://www.web3d.org/x3d/content/X3dTooltips.html#Anchor
>> http://www.web3d.org/x3d/content/icons/Anchor.gif
>> http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/versionContent.html#Anchor
>> http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/networking.html#Anchor
>> http://www.web3d.org/specifications/X3dSchemaDocumentation3.3/x3d-3.3_Anchor.html
>> http://www.web3d.org/specifications/X3dDoctypeDocumentation3.3.html#Anchor
>>
>> Anyway seems ripe for page autogeneration at some point.  Could 
>> produce a wiki-prose document with everything.  Even better might 
>> be to autoproduce documents that can be uploaded to the server and 
>> replace everything at once.
>>
>> all the best, Don
>>
>
>
> all the best, Don
> -- 
> Don Brutzman  Naval Postgraduate School, Code USW/Br 
> brutzman at nps.edu
> Watkins 270,  MOVES Institute, Monterey CA 93943-5000 USA 
> +1.831.656.2149
> X3D graphics, virtual worlds, navy robotics 
> http://faculty.nps.edu/brutzman
>
> _______________________________________________
> x3d-public mailing list
> x3d-public at web3d.org
> http://web3d.org/mailman/listinfo/x3d-public_web3d.org