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.
   9 * The code that manages the nesting of tags is pretty primitive. It needs a lot
  10         of work.
  11
  12 These insets are basically done, though there are probably issues here and there,
  13         and there are even some FIXMEs:
  14         Bibitem, Branch, Collapsable, Footnote, Hyperlink, Label, Line, Note,
  15         Newline, Newpage, Quotes, Space, SpecialChar
  16
  17 These insets do nothing for XHTML:
  18         ERT, OptArg, Phantom
  19
  20 These insets work but still need work:
  21         InsetBibtex: There are a few issues here. One is that the output is not very
  22                 nice. This will be solved, though, by a patch of mine I seem to have forgotten
  23                 to finish. To get output that accorded with the BibTeX style, of course, we'd
  24                 have to parse the bbl file. I don't know if that's worth it.
  25                 Another issue concerns cross-references. At the moment, we simply use the
  26                 xref information for every entry, rather than listing the xref separately and
  27                 then referencing it. That should not be terribly hard, but it would take a bit
  28                 of work.
  29         InsetBox: The CSS isn't there yet.
  30         InsetCitation: This has two limitations as of 11 VI 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
  41 These insets do not work but should be completely straightforward:
  42         Caption
  43
  44 These insets do not work and are not yet scheduled to work:
  45         InsetIndex and InsetPrintIndex: An "advanced" case. What really would be cool
  46                 would be to collect all of these and then write the index as a series of links
  47                 back to the occurrences. But not now.
  48
  49 May need to make use here of TocWidget::itemInset, which should then be moved
  50 to TocBackend.
  51
  52 These do not yet work and need some attention:
  53         InsetExternal: I don't understand these so am not sure what to do.
  54         InsetFloat: This will need some work, again because I do not really understand
  55                 what these are meant to do. Presumably, we'll just use a div or something, but
  56                 it's not clear what subfloat means, etc.
  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         InsetInfo: Probably skip it.
  65         InsetListings: Probably just output it as <pre>.
  66         InsetMarginal: Fine, but will need CSS.
  67         InsetNomencl and InsetPrintNomencl: Also "advanced".
  68         InsetRef: Presumably, this is an internal link. But what should the text be, and how
  69                 should we get it? Probably some validation thing again, where labels tell us where
  70                 they are. Alternatively, we could parse the aux file.
  71         InsetTabular: This shouldn't be too hard, but will need doing.
  72         InsetTOC: We should just be able to use what we have in the TOC. To get links to
  73                 work, though, we'll need to co-ordinate the writing of anchors in the sections,
  74                 which won't actually happen until later.
  75         InsetWrap: This should be simple enough, probably a div and some CSS, but I'm not sure
  76                 precisely what this is supposed to do.
  77
  78 MATH
  79         Regarding math, the view seems to be that we should in the first instance just use what
  80         we get from instant preview and copy those over to the output directory, and then try
  81         to make MathML work.