development/HTML/HTML.notes

   1 The main output routines now more or less work.
   2
   3 Known issues:
   4 * Right now, other than that some things don't work at all, none.
   5
   6 These insets are basically done, though there are probably issues here and there,
   7         and there are even some FIXMEs:
   8         Bibitem, Branch, Caption, Collapsable, Footnote, Hyperlink, Include, Info,
   9         Label, Line,  Listings, Marginal, Note, Newline, Newpage, Quotes, Space,
  10         SpecialChar, Wrap
  11
  12 These insets do nothing for XHTML:
  13         ERT, OptArg, Phantom
  14
  15 These insets work but still need work:
  16         InsetBibtex: There are a few issues here.
  17                 - One is that the output is not very nice. This will be solved, though, by
  18                         a patch of mine I seem to have forgotten to finish. To get output that
  19                         accorded with the BibTeX style, of course, we'd have to parse the bbl file.
  20                         I don't know if that's worth it.
  21                 - Another issue concerns cross-references. At the moment, we simply use the
  22                         xref information for every entry, rather than listing the xref separately and
  23                         then referencing it. That should not be terribly hard, but it would take a bit
  24                         of work.
  25                 - A third issue concerns the labels. At present, we use the BibTeX key as the
  26                         citation label. It would not be too hard, I think, to use numerical labels,
  27                         in the way BibTeX does. To do so, we'd need to move the sorting routine out
  28                         of InsetBibtex so we could do it before we print the citations. See below.
  29         InsetBox: The CSS isn't there yet.
  30         InsetCitation: This has two limitations as of 20 XI 2009. The first is that we
  31                 ignore the citation style and output square brackets, no matter what. The
  32                 second is that, with BibTeX, we simply use the BibTeX key as the citation
  33                 string, thus ignoring numerical, author-year, etc. It will not be too hard
  34                 to make numerical work. To do this, we need to collect information on the
  35                 used citations, alphabetize them, and then assign numerical labels via the
  36                 BibTeXInfo::label() method. A similar strategy will work for author-year and
  37                 the like, but calculating labels will be more complex---unless we just parse
  38                 the bbl file, which of course is the only fully general solution.
  39         InsetFlex: I think this one is OK, but it needs some testing.
  40         InsetFloat: This seems to work OK, but it will need testing and tweaking.
  41         InsetGraphics: This works in a pretty primitive way, in that it outputs the graphic
  42           and appropriate img tag. But we don't yet do any sort of scaling, rotating, and
  43                 so forth. That won't be hard, since we can just call ImageMagick to do this for
  44                 us, but appropriate routines will need to be written.
  45         InsetRef: At present, we just use the label name as associated text, and put it
  46                 into square brackets. It'd be nice to be able to do more, but for that we'd need to
  47                 associate counters with the labels, and we don't have that yet.
  48
  49 These insets do not work and are not yet scheduled to work:
  50         InsetExternal: It may be that this won't be too hard, but I don't understand
  51                 these so am not sure what to do. For now, it is disabled.
  52         InsetIndex and InsetPrintIndex: An "advanced" case. What really would be cool
  53                 would be to collect all of these and then write the index as a series of links
  54                 back to the occurrences. But not now.
  55         InsetNomencl and InsetPrintNomencl: Also "advanced".
  56
  57 May need to make use here of TocWidget::itemInset, which should then be moved
  58 to TocBackend.
  59
  60 These do not yet work and need some attention:
  61         InsetTabular: This shouldn't be too hard, but will need doing.
  62         InsetTOC: We should just be able to use what we have in the TOC. To get links to
  63                 work, though, we'll need to co-ordinate the writing of anchors in the sections,
  64                 which won't actually happen until later.
  65
  66 MATH
  67         Regarding math, the view seems to be that we should in the first instance just use what
  68         we get from instant preview and copy those over to the output directory, and then try
  69         to make MathML work.