4

I'm looking into webruby or cweb to write the documentation of my project.

Is there a plugin to eclipse or other gui system?

6

If you are referring Donald Knuth and Silvio Levy's CWEB system of structured documentation, and you have a TeXLive installation, you can find the CWEB documentation in the texmf-dist/doc/plain/cweb directory in your texlive tree.

In a standard Linux installation the path is /usr/local/texlive/2014/texmf-dist/doc/plain/cweb.

There you will find cwebman.dvi, which you can convert to PDF in the standard way:

dvips cwebman.dvi
ps2pdf cwebman.ps

(You can also try texdoc cweb but since there is no PDF it will try to process the DVI directly, which produced errors on my system.)

For the web2c system, enter texdoc web2c.

EDIT:

Dr. Knuth's original WEB system was for Pascal, but he and Silvio Levy converted it to C, producing CWEB, which you can read about in the cwebman manual described above. Norman Ramsey developed the SPIDER system to allow the WEB concept to be ported theoretically to any combination of a programming language and formatting/display language. See http://www.literateprogramming.com/spider.pdf. So one could write a new version for Ruby or another language.

Regarding editor support: Vim, for one, supports syntax highlighting for CWEB.

  • I know is a pascal version. Is ruby version or other scripts systems? – bardzo Dec 12 '14 at 15:24
  • @bardzo But doesn't Ruby have its own system of automatically generated documentation, RDoc? rdoc.sourceforge.net/doc/index.html – musarithmia Dec 12 '14 at 15:30
  • Documentation only API. I would like to documentation process of writing my program , and my decision concepts... – bardzo Dec 12 '14 at 15:34
  • 2
    @bardzo For a model, see Knuth's own progress log for building TeX, texdoc errorlog. (Thanks to @SeanAllred) – musarithmia Dec 12 '14 at 15:38
  • 2
    For Emacs there is a mode contributed by Donald Knuth (never tried though). – giordano Dec 12 '14 at 15:58

Your Answer

By clicking “Post Your Answer”, you agree to our terms of service, privacy policy and cookie policy

Not the answer you're looking for? Browse other questions tagged or ask your own question.