development/HTML/HTML.notes

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