Discussion:
Online and offline VMS documentation in HTML format
Add Reply
Simon Clubley
2021-10-02 16:42:33 UTC
Reply
Permalink
Does anyone else think it would be useful for VSI to supply and
host HTML versions of the documentation so that you could point
someone directly to a section of the manual without them having
to download the whole manual or having to read an older version
of the documentation online at a third party site ?

Simon.
--
Simon Clubley, ***@remove_me.eisner.decus.org-Earth.UFP
Walking destinations on a map are further away than they appear.
Dave Froble
2021-10-02 19:17:23 UTC
Reply
Permalink
Post by Simon Clubley
Does anyone else think it would be useful for VSI to supply and
host HTML versions of the documentation so that you could point
someone directly to a section of the manual without them having
to download the whole manual or having to read an older version
of the documentation online at a third party site ?
Simon.
Anyone interested should have downloaded all the manuals. Doesn't take
much storage.

As for me, I miss paper, where corners can be folded down, notes
written, paper clips for going back and forth between pages, ...
--
David Froble Tel: 724-529-0450
Dave Froble Enterprises, Inc. E-Mail: ***@tsoft-inc.com
DFE Ultralights, Inc.
170 Grimplin Road
Vanderbilt, PA 15486
Arne Vajhøj
2021-10-02 20:39:03 UTC
Reply
Permalink
Post by Simon Clubley
Does anyone else think it would be useful for VSI to supply and
host HTML versions of the documentation so that you could point
someone directly to a section of the manual without them having
to download the whole manual or having to read an older version
of the documentation online at a third party site ?
Online HTML has become the industry standard - IBM, Oracle,
Microsoft etc. all do it.

VSI should also do it.

Arne
Bob Eager
2021-10-02 21:54:49 UTC
Reply
Permalink
Post by Arne Vajhøj
Does anyone else think it would be useful for VSI to supply and host
HTML versions of the documentation so that you could point someone
directly to a section of the manual without them having to download the
whole manual or having to read an older version of the documentation
online at a third party site ?
Online HTML has become the industry standard - IBM, Oracle,
Microsoft etc. all do it.
VSI should also do it.
I write portable documents in TeXinfo now. PDF and HTML both easy.
--
My posts are my copyright and if @diy_forums or Home Owners' Hub
wish to copy them they can pay me £1 a message.
Use the BIG mirror service in the UK: http://www.mirrorservice.org
*lightning surge protection* - a w_tom conductor
Lawrence D’Oliveiro
2021-10-03 23:05:30 UTC
Reply
Permalink
Post by Bob Eager
I write portable documents in TeXinfo now. PDF and HTML both easy.
Markdown seems to be very popular nowadays. Doesn’t take much skill to write, and you can leave all the layout to CSS. And it is easy to produce PDF and HTML. And man pages too.

Me, I’ve actually started writing man pages directly using groff_man macros. ;)
Bob Eager
2021-10-04 08:03:01 UTC
Reply
Permalink
Post by Lawrence D’Oliveiro
Post by Bob Eager
I write portable documents in TeXinfo now. PDF and HTML both easy.
Markdown seems to be very popular nowadays.
Oh, I use that for smaller documents that ship with things I write.
Readable without any software! However it is rather limited compared to
TeXinfo.

You can take a look at some typical TeXinfo output here:

https://www.ml1.org.uk/doc.html
Post by Lawrence D’Oliveiro
Me, I’ve actually started writing man pages directly using groff_man macros. ;)
I do that too. But then I started using nroff in about 1975...
--
My posts are my copyright and if @diy_forums or Home Owners' Hub
wish to copy them they can pay me £1 a message.
Use the BIG mirror service in the UK: http://www.mirrorservice.org
*lightning surge protection* - a w_tom conductor
Lawrence D’Oliveiro
2021-10-05 00:27:45 UTC
Reply
Permalink
[Link to non-free docs deleted]
Phillip Helbig (undress to reply)
2021-10-05 06:20:07 UTC
Reply
Permalink
Post by Lawrence D’Oliveiro
[Link to non-free docs deleted]
What is the purpose of the above post?
Bob Eager
2021-10-05 10:15:46 UTC
Reply
Permalink
On Tue, 05 Oct 2021 06:20:07 +0000, Phillip Helbig (undress to reply)
Post by Phillip Helbig (undress to reply)
Post by Lawrence D’Oliveiro
[Link to non-free docs deleted]
What is the purpose of the above post?
I don't know. He doesn't seem to have a clue. Unless he's moaning about a
copyright notice.
--
My posts are my copyright and if @diy_forums or Home Owners' Hub
wish to copy them they can pay me £1 a message.
Use the BIG mirror service in the UK: http://www.mirrorservice.org
*lightning surge protection* - a w_tom conductor
Bob Eager
2021-10-05 10:14:59 UTC
Reply
Permalink
Post by Lawrence D’Oliveiro
[Link to non-free docs deleted]
Non free? They are all free. What made you think otherwise?
--
My posts are my copyright and if @diy_forums or Home Owners' Hub
wish to copy them they can pay me £1 a message.
Use the BIG mirror service in the UK: http://www.mirrorservice.org
*lightning surge protection* - a w_tom conductor
Jan-Erik Söderholm
2021-10-03 08:48:01 UTC
Reply
Permalink
Post by Simon Clubley
Does anyone else think it would be useful for VSI to supply and
host HTML versions of the documentation so that you could point
someone directly to a section of the manual without them having
to download the whole manual or having to read an older version
of the documentation online at a third party site ?
Simon.
I kind of like the page oriented style of PDF docs. If there is
something I'd need to sit down and read properly, I can easily
print 10-20 pages and get an easy to read version.
Post by Simon Clubley
without them having to download the whole manual...
What is the problem? I just tried a few of the PDF files from VSI,
and it is 1-3 sec per manual, more or less instant. The Cobol Ref
Manual (6,7 MB) took approx 1 sec.

Yes, HTML has some good sides, such as cross linking between different
parts of the docs, but then you have to write/design your docs that way
from the start. But I do not think this particular question is one of
the major ones for VSI to care about right now.

Jan-Erik.
Craig A. Berry
2021-10-03 13:12:15 UTC
Reply
Permalink
Post by Jan-Erik Söderholm
Post by Simon Clubley
Does anyone else think it would be useful for VSI to supply and
host HTML versions of the documentation so that you could point
someone directly to a section of the manual without them having
to download the whole manual or having to read an older version
of the documentation online at a third party site ?
Simon.
I kind of like the page oriented style of PDF docs. If there is
something I'd need to sit down and read properly, I can easily
print 10-20 pages and get an easy to read version.
Post by Simon Clubley
without them having to download the whole manual...
What is the problem? I just tried a few of the PDF files from VSI,
and it is 1-3 sec per manual, more or less instant. The Cobol Ref
Manual (6,7 MB) took approx 1 sec.
Yes, HTML has some good sides, such as cross linking between different
parts of the docs, but then you have to write/design your docs that way
from the start. But I do not think this particular question is one of
the major ones for VSI to care about right now.
It's not an either/or situation. Professional tech writers will most
likely be using XML in a DocBook schema, which can readily be
transformed to PDF, HTML, and numerous other formats. The anchor tags
could be automatically generated for section headings or even paragraphs
to provide the direct links that Simon was asking about. And yes, it
would be nice to have such links.
Jan-Erik Söderholm
2021-10-03 13:39:45 UTC
Reply
Permalink
Post by Jan-Erik Söderholm
Post by Simon Clubley
Does anyone else think it would be useful for VSI to supply and
host HTML versions of the documentation so that you could point
someone directly to a section of the manual without them having
to download the whole manual or having to read an older version
of the documentation online at a third party site ?
Simon.
I kind of like the page oriented style of PDF docs. If there is
something I'd need to sit down and read properly, I can easily
print 10-20 pages and get an easy to read version.
 > without them having to download the whole manual...
What is the problem? I just tried a few of the PDF files from VSI,
and it is 1-3 sec per manual, more or less instant. The Cobol Ref
Manual (6,7 MB) took approx 1 sec.
Yes, HTML has some good sides, such as cross linking between different
parts of the docs, but then you have to write/design your docs that way
from the start. But I do not think this particular question is one of
the major ones for VSI to care about right now.
It's not an either/or situation.  Professional tech writers will most
likely be using XML in a DocBook schema, which can readily be
transformed to PDF, HTML, and numerous other formats.  The anchor tags
could be automatically generated for section headings or even paragraphs
to provide the direct links that Simon was asking about.  And yes, it
would be nice to have such links.
I have not anything specific against HTML, only it if takes time from
other projects from VSI. In that case, the PDFs are just fine.

I just did not understood what the problem was with downloading
a coupe of MBs today.
Phillip Helbig (undress to reply)
2021-10-03 15:47:52 UTC
Reply
Permalink
Post by Craig A. Berry
It's not an either/or situation. Professional tech writers will most
likely be using XML in a DocBook schema, which can readily be
transformed to PDF, HTML, and numerous other formats.
Sort of like DEC Document?
Stephen Hoffman
2021-10-03 17:22:51 UTC
Reply
Permalink
Does anyone else think it would be useful for VSI to supply and host
HTML versions of the documentation so that you could point someone
directly to a section of the manual without them having to download the
whole manual or having to read an older version of the documentation
online at a third party site ?
There are many larger issues around information design at VSI, HTML
being one of many details involved.

I'd rather have updated doc in those PDFs, and examples and cookbooks, for now.

Further along and closer toward V9.3 or so, and particularly as part of
work toward better a better information design for VSI itself and its
documentation, sure.

Oh and BTW, you can specify a PDF page in a PDF in a hyperlink in many
tools. For example:

https://vmssoftware.com/docs/VSI_USERS_MANUAL.pdf#page=23

The PDF-generation tooling that VSI uses here could (preferably) make
that page numbering match reality and not contend with the archaic
DEC-style page numbering scheme, or (less preferably, and somewhat less
inconveniently) could make the page number in the generated PDF itself
into a hyperlink, but here we are.
--
Pure Personal Opinion | HoffmanLabs LLC
Volker Halle
2021-10-22 11:33:46 UTC
Reply
Permalink
VSI has now published OpenVMS documentation in both PDF and HTML format.

See announcement at: https://forum.vmssoftware.com/viewtopic.php?f=2&t=235

See documentation at: https://docs.vmssoftware.com/

Volker.
Simon Clubley
2021-10-22 12:21:33 UTC
Reply
Permalink
Post by Volker Halle
VSI has now published OpenVMS documentation in both PDF and HTML format.
See announcement at: https://forum.vmssoftware.com/viewtopic.php?f=2&t=235
See documentation at: https://docs.vmssoftware.com/
Ok, now _that_ is nice, and the HTML is broken up into sections much
more logically than the HP/HPE HTML. :-)

Clearly I wasn't the only one asking for this...

I wonder if VSI would consider packaging up both the HTML and PDF into
a single downloadable archive so we can work with them locally, much
like HP/HPE used to do ?

BTW, those fonts in the HTML are very nicely readable for me.

The only slight improvement would be to place code references such as

IO$_TTY_PORT!IO$M_LT_CONNECT

inside a monospaced font, but the fonts are readable as-is.

Simon.
--
Simon Clubley, ***@remove_me.eisner.decus.org-Earth.UFP
Walking destinations on a map are further away than they appear.
Hans Bachner
2021-10-22 14:20:33 UTC
Reply
Permalink
Post by Simon Clubley
[...]
The only slight improvement would be to place code references such as
IO$_TTY_PORT!IO$M_LT_CONNECT
inside a monospaced font, but the fonts are readable as-is.
In case you find any issues with the content or the portal, please use this thread to report them.
"this thread" refers to the vmssoftware forum...

Hans.
V***@SendSpamHere.ORG
2021-10-22 15:23:07 UTC
Reply
Permalink
Post by Simon Clubley
Post by Volker Halle
VSI has now published OpenVMS documentation in both PDF and HTML format.
See announcement at: https://forum.vmssoftware.com/viewtopic.php?f=2&t=235
See documentation at: https://docs.vmssoftware.com/
Ok, now _that_ is nice, and the HTML is broken up into sections much
more logically than the HP/HPE HTML. :-)
Clearly I wasn't the only one asking for this...
I wonder if VSI would consider packaging up both the HTML and PDF into
a single downloadable archive so we can work with them locally, much
like HP/HPE used to do ?
BTW, those fonts in the HTML are very nicely readable for me.
The only slight improvement would be to place code references such as
IO$_TTY_PORT!IO$M_LT_CONNECT
inside a monospaced font, but the fonts are readable as-is.
Wow! Something I can agree upon with Simon!
--
VAXman- A Bored Certified VMS Kernel Mode Hacker VAXman(at)TMESIS(dot)ORG

I speak to machines with the voice of humanity.
Andy Burns
2021-10-22 14:01:31 UTC
Reply
Permalink
Post by Volker Halle
VSI has now published OpenVMS documentation in both PDF and HTML format.
See documentation at:https://docs.vmssoftware.com/
Nicely done ...
David Jones
2021-10-22 16:59:05 UTC
Reply
Permalink
Post by Andy Burns
Post by Volker Halle
VSI has now published OpenVMS documentation in both PDF and HTML format.
See documentation at:https://docs.vmssoftware.com/
Nicely done ...
I notice the Utility Routines Manual doesn't include descriptions for BCK_OPT_K_GPT
and BCK_OPT_K_ZLIB options in the BACKUP API section.

Loading...