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