[Info-vax] VMS documentation, was: Re: callable BACKUP example

[Simon Clubley]

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.

The licences should also permit unrestricted use and distribution of
that source code. Look at the EVE source code in sys$examples: for an
example of a licence that you do _NOT_ want to see on that source code.

BTW, talking about manuals, am I the only one to find the new manual
layouts less readable than the old VAX Document style layouts ?

Simon.

-- 
Simon Clubley, clubley at remove_me.eisner.decus.org-Earth.UFP
Walking destinations on a map are further away than they appear.