development/HTML/HTML.notes

   1 TODO:
   2 1. The counter patch, and better output for InsetRef.
   3 2. Better output for citations, meaning better labels. Numerical, as said below,
   4    should be easy, and author-year oughtn't to be THAT hard. But it'll need a
   5          bit of work.
   6 3. CSS needs work in several places, mostly floats. Maybe check elyxer on that.
   7 4. MathML
   8
   9
  10 These insets work but still need work:
  11         InsetBibtex: There are a few issues here.
  12                 - One is that the output is not very nice. This will be solved, though, by
  13                         a patch of mine I seem to have forgotten to finish.
  14                 - Another issue concerns cross-references. At the moment, we simply use the
  15                         xref information for every entry, rather than listing the xref separately and
  16                         then referencing it. That should not be terribly hard, but it would take a bit
  17                         of work.
  18         InsetBox: The CSS isn't there yet.
  19         InsetCitation: This has two limitations as of 20 XI 2009. The first is that we
  20                 ignore the citation style and output square brackets, no matter what. The
  21                 second is that we only do numerical citations. It will not be terribly hard
  22                 to do author-year citations, but the complexLabel() routine in InsetCitation
  23                 will need adapting before that is possible.
  24         InsetFlex: I think this one is OK, but it needs some testing.
  25         InsetFloat: This seems to work OK, but it will need testing and tweaking. There is
  26                 also no CSS yet for these.
  27         InsetFloatList: Seems to work well, but may need testing.
  28         InsetGraphics: This works in a pretty primitive way, in that it outputs the graphic
  29           and appropriate img tag. But we don't yet do any sort of scaling, rotating, and
  30                 so forth. That won't be hard, since we can just call ImageMagick to do this for
  31                 us, but appropriate routines will need to be written.
  32         InsetRef: At present, we just use the label name as associated text, and put it
  33                 into square brackets. It'd be nice to be able to do more, but for that we'd need to
  34                 associate counters with the labels, and we don't have that yet.
  35         InsetTabular: Works reasonably well, but we don't do anything with any of the
  36                 arguments provided for longtable. There are probably other limitations, too,
  37                 since I'm very much not an expert with tables.
  38
  39
  40 Math
  41   We have a fair bit of math now working via MathML output, but there are still some
  42   isues, and not all the insets work. Here are the ones I know still need work:
  43         - Array: Should be able to use alignment information via appropriate attributes, for
  44                 mtable, mrow, and mtd.
  45         - Box: There is a general issue here with text mode nesting. See the FIXME attached
  46                 to the SetMode class.
  47         - Lefteqn: For this, and numbering in general, probably need mlabeledtr, which may
  48                 mean we always need to output <mtable>.
  49         - Par?
  50         - Phantom: There is some support for this in MathML....
  51         - Ref: Needs to be deferred.
  52         - Size: Unclear if we want to do anything here, though we could. See
  53                 lib/symbols for the commands supported, of course.
  54         - Space: Needs checking.
  55         - SpecialChar: Needs checking.
  56         - Split: There are some alignment issues here, but it basically works.
  57         - Substack: This is a stack of however many cells, all in a smaller style.
  58                 Probably do something with <mover>, again.
  59         - Tabular: This is more or less a text-like table in math. Probably output it
  60                 as a table, but set the font.
  61
  62 Other math notes:
  63         - Hull:
  64                 -       Need to handle the equation hull type by outputting a counter. But that will
  65                         have to wait for the counter patch. The counter probably goes with mlabeledtr,
  66                         which may mean we always need to output <mtable>.
  67                 - Similar issues about eqnarray.
  68                 - It's not clear if we need to do much about the other hull types.
  69         - XYMatrix: So far as I can tell, using this in LyX effectively involves using a
  70                 lot of ERT, within the matrix, to get the arrow effects. At present, it just prints
  71                 as an InsetMathGrid, from which it inherits, and so as a simple table. I don't know
  72                 how much more we can do.
  73
  74
  75 These insets do not work and are not yet scheduled to work:
  76         InsetExternal: It may be that this won't be too hard, but I don't understand
  77                 these so am not sure what to do. For now, it is disabled.
  78         InsetIndex and InsetPrintIndex: An "advanced" case. What really would be cool
  79                 would be to collect all of these and then write the index as a series of links
  80                 back to the occurrences. But not now.
  81         InsetNomencl and InsetPrintNomencl: Also "advanced".
  82
  83 May need to make use here of TocWidget::itemInset, which should then be moved
  84 to TocBackend.