From J Wiki
Jump to: navigation, search

This page is for general comments, ideas, enhancement requests, bugs, etc. related to Literate Programming. Use the entry below as a format example with a @SIG@ at the end.

Other Ways to Provide Feedback

Other way to provide feedback include

  • updates to these wiki pages inline
  • comments in a separate page section
== Discussion ==
  • send general comments to the general forum

-- Oleg Kobchenko <<DateTime(2007-03-19T08:08:29Z)>>

Literate Fragment Syntax

It seems that literate parser grabs

-- Andrew Nikitin <<DateTime(2007-03-20T18:45:24Z)>>

  • So, there is no way to have literal '
    • It's a matter of practicality. If it does not work like it does in Wiki, then it's a bug.-- Oleg Kobchenko <<DateTime(2007-03-20T19:40:40Z)>>
  • I am not advocating new behaviour. I am advocating listing of potential bad strings that can explode. -- Andrew Nikitin <<DateTime(2007-03-20T20:01:53Z)>>

Currently, there is a bug that does not escape "<" as in <text in fragment code.

-- Oleg Kobchenko <<DateTime(2007-03-20T18:54:53Z)>>

  • {OK} This is now fixed: both in fragment body and tags -- Oleg Kobchenko <<DateTime(2007-03-23T23:47:14Z)>>

Back Links

On the weave side of a matter. Currently a section reference generates a hyperlink to a place where it first defined. This should be retained for inline section references, but section name in the heading of literate block should generate hyperlink to a place where this section is first referenced in some other literate block. -- Andrew Nikitin <<DateTime(2007-03-20T19:16:04Z)>>

  • Yes, this is another enhancement to Literate parser. The problem was a perception, that the parser only "sees" current fragment. But nevertheless, it would be possible to adorn a reference with a back-link target. In HTML notation

<a name="anchor"></a> <a href="#backlink.anchor">«anchor»=</a>
   <a name="backlink.anchor"></a> <a href="#anchor">«anchor»</a>

-- Oleg Kobchenko <<DateTime(2007-03-20T19:36:32Z)>>

    • {OK} This is now implemented: click back and forth between declaration and definition -- Oleg Kobchenko <<DateTime(2007-03-23T23:47:14Z)>>
  • in cweb first definition of a section looks like <<section>>= and all the other look like <<section>>+=. I am not sure how much this is better, just a side note.
    •  :\ Yes, I noticed it in the Knuth's paper, describing yet Pascal's WEB. But I thought it's a redundancy. -- Oleg Kobchenko <<DateTime(2007-03-20T20:04:14Z)>>


Maybe it should not insert NB. as a first line of a literate script. Or, at least should not insert it unless file extension is .ijs. -- Andrew Nikitin <<DateTime(2007-03-20T20:10:02Z)>>

  • Yes it makes sense to define well-known extensions, like .ijs, .c, .bat, etc and corresponding line comments. For unknown extensions, it won't generate comments. And the URL should be properly escaped. -- Oleg Kobchenko <<DateTime(2007-03-23T09:26:54Z)>>
  • {OK} This is now implemented. Supported extensions: ijs, c, cpp, bat, py, pl -- Oleg Kobchenko <<DateTime(2007-03-23T23:47:14Z)>>

Conditional Fragments

It is possible to generate multiple scripts with almost the same content, specifying for='script.ijs' parameter. On wiki page such tags are shown with a tooltip:    <a name="backlink.anchor"></a> <a href="#anchor" title="for script.ijs" >«anchor»</a>

-- Oleg Kobchenko <<DateTime(2007-03-23T09:26:54Z)>>

  • {OK} This is now implemented. See definition of for="..." at Wiki Tool. -- Oleg Kobchenko <<DateTime(2007-03-23T23:47:14Z)>>