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 code that manages the nesting of tags is pretty primitive. Its main function
   9         is to keep us from outputting too many "p" tags. But perhaps it does its work.
  10         We shall see.
  11
  12 These insets are basically done, though there are probably issues here and there,
  13         and there are even some FIXMEs:
  14         Branch, Hyperlink, Label, Line, Newline, Newpage, Quotes, Space, SpecialChar
  15
  16 These insets probably do nothing:
  17         OptArg, Phantom
  18
  19 These insets work but still need work:
  20         InsetBox: We need a Length::asHTML() method and the like, but it basically works.
  21                 though the CSS isn't there yet.
  22
  23 These insets do not work but should be completely straightforward:
  24         Caption, Flex (uses collapsable)
  25
  26 These do not yet work and need some attention:
  27         InsetBibitem: Should be fairly straightforward, in itself, actually.
  28         InsetBibtex: We should be able to collect the keys of references in
  29                 validate() and then use our parsed information to output some sort of
  30                 bibliography. Formatting is another question, but here again we could
  31                 try parsing the bbl file.
  32         InsetCitation: I think we'll want to do something here involving reference keys.
  33                 Maybe for the beginning, we should just do everything numerically, but even
  34                 that will need a bit of work. Validation is our friend, presumably.
  35         InsetCollapsable: This is a bit of a mess at the moment, but ought not to be
  36                 too hard to get right. Probably we ought to do as suggested there, and just
  37                 call InsetText::lyxhtml().
  38         InsetCommand: By default does nothing. That may be right?
  39         InsetERT: It's not entirely clear what it's best to do here. Maybe output it
  40                 verbatim. Perhaps wrapped in some CSS. (What else would one expect?)
  41         InsetExternal: I don't understand these so am not sure what to do.
  42         InsetFloat: This will need some work, again because I do not really understand
  43                 what these are meant to do. Presumably, we'll just use a div or something, but
  44                 it's not clear what subfloat means, etc.
  45         InsetFoot: Easy, but need CSS.
  46         InsetGraphics: This should be fairly straightforward, but I'll need to learn a bit
  47                 about export formats, etc, to get it completely right. We'll also want to make
  48                 some use of the params, eg, on width and height. I guess there is also some
  49                 issue about converting the graphics formats?
  50         InsetInclude: I think we just want to include it, straightforwardly. Probably will
  51                 base this more on the latex() routine, then. Another possibility, maybe with a
  52                 flag of some sort, would be to do it as a separate file, to which we link.
  53         InsetIndex: Not clear whether to do anything with this or not. Certainly it's an
  54                 "advanced" case.
  55         InsetInfo: Probably skip it.
  56         InsetListings: Probably just output it as <pre>.
  57         InsetMarginal: Fine, but will need CSS.
  58         InsetNomencl: Also "advanced".
  59         InsetNote: Need CSS, again.
  60         InsetRef: Presumably, this is an internal link. But what should the text be, and how
  61                 should we get it? Probably some validation thing again, where labels tell us where
  62                 they are. Alternatively, we could parse the aux file.
  63         InsetTabular: This shouldn't be too hard, but will need doing.
  64         InsetTOC: Here again, validation might do the trick, but I'm not sure. Or perhaps some
  65                 kind of post-processing? Another option, maybe the best option, would be just to use
  66                 the information we already have in the TOC.
  67         InsetVSpace: This will be easy, once we have the Length::asHTML() method.
  68         InsetWrap: This should be simple enough, probably a div and some CSS, but I'm not sure
  69                 precisely what this is supposed to do.
  70 There seems not to be much here for math, so that will take some doing.