[Info-vax] VMS documentation, was: Re: callable BACKUP example
Arne Vajhøj
arne at vajhoej.dk
Fri Jul 16 20:09:42 EDT 2021
On 7/16/2021 7:53 PM, Chris Townley wrote:
> On 17/07/2021 00:28, Arne Vajhøj wrote:
>> On 7/16/2021 1:52 PM, Simon Clubley wrote:
>>> On 2021-07-15, Arne Vajhøj <arne at vajhoej.dk> wrote:
>>>> A complete example makes it easy to copy paste and show some of the
>>>> extra stuff that need to be done in final code.
>>>>
>>>> But a complete example also tend to be much bigger and taking
>>>> much more time to read than a snippet that only show the the
>>>> specific stuff the example need to illustrate.
>>>>
>>>
>>> Each VMS .pdf manual that contains extracts from source code examples
>>> should also come with a .zip file at the same location as the .pdf
>>> manual
>>> which contains the full versions of those examples. A .zip archive is
>>> preferable to placing the code in sys$examples: because it keeps the
>>> manual and the source code together.
>>>
>>> Use extracts from the full examples to explain certain points within the
>>> manuals and then provide the full source code for those examples
>>> somewhere
>>> outside of the .pdf.
>>
>> Or switch entirely to web and HTML. Then making links to full
>> examples is easy.
>
> Not much use if they are hosted with HP/HPE - they kept changing them,
> so any link was quickly useless.
>
> ISTR IBM doing the same
VMS is all VSI now. And they will have more focus on VMS.
But they should either allow download of full HTML doc set
so people can browser offline or ship the full HTML doc set
with VMS including a small web server for serving it or both.
Arne
More information about the Info-vax
mailing list