development/HTML/HTML.notes

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