HyperTeX?
cfme...@pacbell.net
Normal literate programming will allow you to combine source and
documantation, but you choose the documentation language. You could mix
HTML and plainTeX for example, but at any one time you are documanting in
either TeX or HTML. TeX provides superior looking output but HTML allows
you to link to specifiaction and interface documents.
Does anyone have any thoughts on how one could get TeX quality in printed
output, yet be able to have interactive links without having to do the
documentation twice in the web file, once for TeX then repeat an HTML
version?
Marc van Leeuwen
|> Does anyone have any thoughts on how one could get TeX quality in printed
|> output, yet be able to have interactive links without having to do the
|> documentation twice in the web file, once for TeX then repeat an HTML
|> version?
Your subject line gives the answer. HyperTeX is a convention to add \specials
to a DVIfile, that will allow hyperlinks to be followed by special previewers
like xhdvi. Those specials can easily be inserted automatically by
redefinition of certain macros that you were using already, so in a sense you
get the hypertext structure for free. For CWEB, macros are available that will
insert hyperlinks at some places (if I remember correctly, module names and
section numbers in the cross reference lists). For CWEBx I wrote some macros
that did more: click on any identifier to jump to its index entry, then click
on any section number where the identifier is also used (for instance one
where it is defined) to go there. I never really got around to making these
macros public, but I can send them if you like; its real fun using them. At
the time (around 1994) I thought the xhdvi program, and maybe the HyperTeX
project itself, was not quite stable. It appears though that not much has
changed since then. In any case, here are two places to take a look for
yourself:
http://xxx.lanl.gov:80/hypertex/
http://info.desy.de/user/projects/LitProg/HTML.html
Good luck,
Marc van Leeuwen | What has man wrought
CWI, Amsterdam | for the year naughty-naught?
http://www.cwi.nl/~maavl/ | '00-programming will get its revenge!
David Carlisle
From: cfme...@pacbell.net
Normal literate programming will allow you to combine source and
documantation, but you choose the documentation language. You could mix
HTML and plainTeX for example, but at any one time you are documanting in
either TeX or HTML. TeX provides superior looking output but HTML allows
you to link to specifiaction and interface documents.
Does anyone have any thoughts on how one could get TeX quality in printed
output, yet be able to have interactive links without having to do the
documentation twice in the web file, once for TeX then repeat an HTML
version?
There is a hypertex project that has specified a set of \specials that
allow hyperlinking to URLs. Various dvi drivers support this
(including xdvi and dvips in the new web2c7 TeX release for unix)
see http://xxx.lanl.gov/hypertex/
Alternatively and probably better if you want the documentation read
by a wider non-TeX audience is to convert the TeX output to Adobe pdf
format which also allows typeset quality setting with full hypertext
capabilities.
In either case (hypertex project specials or pdfmarks for converting
to pdf) the hyperref package on the ctan TeX archives will automate
all normal LaTeX cross referenceing to become hypertext links.
(There is also support for plain TeX from the above URL)
David
Erik Hetzner
> Normal literate programming will allow you to combine source and
> documantation, but you choose the documentation language. You could mix
> HTML and plainTeX for example, but at any one time you are documanting in
> either TeX or HTML. TeX provides superior looking output but HTML allows
> you to link to specifiaction and interface documents.
>
> Does anyone have any thoughts on how one could get TeX quality in printed
> output, yet be able to have interactive links without having to do the
> documentation twice in the web file, once for TeX then repeat an HTML
> version?
Alright, perhaps I'm an idiot, but I've been thinking about something like
this lately. I've just recently checked out Literate Programming systems,
having never used them before. And indeed, I've never written a program
with them. So take my comments with a barrel of salt. But:
I've been thinking about the possibilites of an SGML-based LP system. The
advantage is that the system uses the same syntax for defining things like
which text is to be in the index, or in italics, or whatever, with the
syntax that defines modules. For example:
<SECTION TI="Literate programming">
Blah blah <I>blah</I>.
<MOD>
Here's some code...
<MODREF REF="More code.">
</MOD>
<SECTION>
More blah blah blah.
<MOD NAME="More ...">
More code goes here.
</MOD>
Just an idea. It seems like it'd be easy to convert that to HTML, and I've
been fiddling with a simple SGML2TeX awk script that creates .tex files
that look like:
{\begsection{Literate Programming}
Blah blah {\begi blah\endit}.
{\begmod
Here's some code...
{\begmodref{More code.}\endmodref}
\endmod}
[...]
Anyways, just what I've been thinking about when I should be thinking
about what I'm supposed to be learning in class.
--
Erik Hetzner | `I'm celebrating my love for you;
e...@uclink4.berkeley.edu | with a pint of beer and a new tattoo.'