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 * One option here, actually, would be to use just <div> and never use <p>, setting
  11         the spacing and such via CSS.
  12 * The code that manages the nesting of tags is pretty primitive. It needs a lot
  13         of work.
  14
  15 These insets are basically done, though there are probably issues here and there,
  16         and there are even some FIXMEs:
  17         Bibitem, Branch, Caption, Collapsable, Footnote, Hyperlink, Include, Info,
  18         Label, Line,  Listings, Marginal, Note, Newline, Newpage, Quotes, Space,
  19         SpecialChar, Wrap
  20
  21 These insets do nothing for XHTML:
  22         ERT, OptArg, Phantom
  23
  24 These insets work but still need work:
  25         InsetBibtex: There are a few issues here.
  26                 - One is that the output is not very nice. This will be solved, though, by
  27                         a patch of mine I seem to have forgotten to finish. To get output that
  28                         accorded with the BibTeX style, of course, we'd have to parse the bbl file.
  29                         I don't know if that's worth it.
  30                 - Another issue concerns cross-references. At the moment, we simply use the
  31                         xref information for every entry, rather than listing the xref separately and
  32                         then referencing it. That should not be terribly hard, but it would take a bit
  33                         of work.
  34                 - A third issue concerns the labels. At present, we use the BibTeX key as the
  35                         citation label. It would not be too hard, I think, to use numerical labels,
  36                         in the way BibTeX does. To do so, we'd need to move the sorting routine out
  37                         of InsetBibtex so we could do it before we print the citations. See below.
  38         InsetBox: The CSS isn't there yet.
  39         InsetCitation: This has two limitations as of 11 VI 2009. The first is that we
  40                 ignore the citation style and output square brackets, no matter what. The
  41                 second is that, with BibTeX, we simply use the BibTeX key as the citation
  42                 string, thus ignoring numerical, author-year, etc. It will not be too hard
  43                 to make numerical work. To do this, we need to collect information on the
  44                 used citations, alphabetize them, and then assign numerical labels via the
  45                 BibTeXInfo::label() method. A similar strategy will work for author-year and
  46                 the like, but calculating labels will be more complex---unless we just parse
  47                 the bbl file, which of course is the only fully general solution.
  48         InsetFlex: I think this one is OK, but it needs some testing.
  49         InsetFloat: This seems to work OK, but it will need testing and tweaking.
  50
  51 These insets do not work and are not yet scheduled to work:
  52         InsetExternal: It may be that this won't be too hard, but I don't understand
  53                 these so am not sure what to do. For now, it is disabled.
  54         InsetIndex and InsetPrintIndex: An "advanced" case. What really would be cool
  55                 would be to collect all of these and then write the index as a series of links
  56                 back to the occurrences. But not now.
  57         InsetNomencl and InsetPrintNomencl: Also "advanced".
  58
  59 May need to make use here of TocWidget::itemInset, which should then be moved
  60 to TocBackend.
  61
  62 These do not yet work and need some attention:
  63         InsetGraphics: This should be fairly straightforward, but I'll need to learn a bit
  64                 about export formats, etc, to get it completely right. We'll also want to make
  65                 some use of the params, eg, on width and height. I guess there is also some
  66                 issue about converting the graphics formats?
  67         InsetRef: Presumably, this is an internal link. But what should the text be, and how
  68                 should we get it? Probably some validation thing again, where labels tell us where
  69                 they are. Alternatively, we could parse the aux file.
  70         InsetTabular: This shouldn't be too hard, but will need doing.
  71         InsetTOC: We should just be able to use what we have in the TOC. To get links to
  72                 work, though, we'll need to co-ordinate the writing of anchors in the sections,
  73                 which won't actually happen until later.
  74
  75 MATH
  76         Regarding math, the view seems to be that we should in the first instance just use what
  77         we get from instant preview and copy those over to the output directory, and then try
  78         to make MathML work.