unrendered – code appearing in generated documentation for mode/2 directives

[Parker]

Generated documentation for has unrendered html codes in it.

Mode declaration in the source:

:- mode(write_clause(+), zero).

Rendered documentation:

Public interface
write_clause/1
compilation:
    static
mode – number of solutions:
    write_clause(+) – zero

Could it be a problem with the stylesheet?

[pmoura]

Could you provide some details? Which browser are you using? Are you using the provided "lgt2html" shell script and stylesheets? I'm unable to reproduce the problem.

[Parker]

I was generating documentation during compilation and then browsing the xml files in xml_doc/ directly. That was probably the cause of the problem.

Following your suggestion, I ran lgt2html and looked at the html files instead. There are no more unrendered html codes.

Presumably I was misusing the xml_docs/ so I have resolved this bug as invalid.

[pmoura]

You need to run the shell script "lgt2xml" in the "xmk_docs" directory first. This script copies the XSLT file (and some other files) into the directory so that opening the XML files directly in a web browser will work (as long as the browser embeds a XSLT processor like most modern browsers do nowadays).

[Parker]

I ran lgt2xml in xml_docs/ but my browser still shows the unrendered html codes. Here is my platform in case it is of interest.

Logtalk settings for documentation:

Default documenting compilation flags:
  XML documenting files (xmldocs):                            on
  XML documenting files directory (xmldir):                   xml_docs/
  XML specification file (xmlspec):                           dtd
  XML specification reference (xmlsref):                      local
  XSL stylesheet file (xslfile):                              lgtxml.xsl

Logtalk:    2.31.4
Prolog:     SWI 5.6.54
Browser:    Firefox 2.0.0.13
OS:         Ubuntu Gutsy i386

[pmoura]

This seems to be a glitch with the Firefox XSLT processor. I'm able to reproduce the problem with Firefox 2.0.0.14 but not with Safari 3.1.1 or Opera 9.27. If you use a command-line XSLT processor to generate the HTML file from the XML file using the "lgtxml.xsl" stylesheet and then open the HTML file on Firefox, no problem occurs.

[pmoura]

I've confirmed that the problem is indeed a Firefox issue. Firefox developers refuse to implement the "disable-output-escaping" attribute for the XSLT "text" tag. Search the web for "Firefox disable-output-escaping problem" for the dirty details.

[Parker]

Indeed. What a strange position the firefox are developers are taking.

I'll steer clear of the issue by sticking with html output.

Do you think this (logtalk) bug's status should be WONTFIX rather than INVALID? Just in case any other logtalk users stumble across the problem.

[pmoura]

It's not a Logtalk bug so the correct status is INVALID. I will add an entry to the Logtalk FAQ. To workaround this Firefox issue, either use other browser or run the "lgt2html" shell script in the "xml_docs" directory to convert the XML files into (X)HTML files.