Unsupported DocBook Elements

Benoit Guillon

$Id: unsupported.ref.html,v 1.9 2001/10/14 20:48:24 ben Exp $


Introduction

Some of the DocBook elements are not directly supported by LyX, since the LyX file format is more limited and/or contains different kind of information.

If the DocBook to LyX translation was only a process to publish a document it would not be a real problem, since at this level only the rendering purpose is important: for each element or element combinations a rendering choice can be taken. The initial document structure is then lost, but it is out of scope of the process.

The problem is that translating to LyX is translating from one structure to another. Thus structure or information is important and should not be lost. The DocBook to LyX translation should allow to translate back to XML without losing too much information. Besides, rendering is important too, since LyX display the document in a WYSIWYM way.

So, the strategy used to translate unsupported elements follows one of these cases:

  • The element is related to a similar LyX feature, but some of its information has no meaning in LyX. In this case the additionnal information is silently lost.

  • The element does not exist, but can be emulated to something else that respects the original principles and/or the default rendering.

  • The element does not exist, and trying to replace it by something else can involve a loss of information. The element is then copied as is by using the SGML Style (unsupported blocks) or ERT (unsupported inlined elements).

Of course, different methods can be applied to translate the same element, and selecting one method depends on some considerations discussed for each element. This reference lists all the unsupported elements translated to "something", and the reason of the translation choice.

Note

The elements listed here are about the features not basically supported by LyX. The elements that are not translated by the package due to missing things or bugs are not listed here because they are probably not known!

surname / firstname

Name

surname / firstname — Author name tags

Synopsis


These elements are copied by using ERT, because they are usually used inlined, and the defined styles Firstname and Surname are in general not used.


preface

Name

preface — command tag

Synopsis


This element is copied as SGML, since it must be displayed as a block.


revhistory|revision|revnumber|date

Name

revhistory|revision|revnumber|date — Revision list

Synopsis


The revision history and its related elements are not translated since there is no style defined for them in LyX.


note / important / warning / caution / tip

Name

note / important / warning / caution / tip — Note / Warning Elements

Synopsis


These elements are copied as SGML Style, because no similar style exists in LyX.


literal

Name

literal — command tag

Synopsis


This element is copied as ERT, since it is inlined.


address

Name

address — Adress Element

Synopsis


This element is copied as SGML, since it is displayed as a block. Perhaps this element could easily be supported with a new layout style.


sgmltag

Name

sgmltag — SGML tag

Synopsis


This element is copied as ERT, such as so many inlined items not supported by LyX.


procedure

Name

procedure — Procedure list

Synopsis


This element translated like an orderedlist because the rendering is the same.


simplelist

Name

simplelist — simplelist element

Synopsis


This element is copied as ERT with the attribute type="inline" and is copied as SGML Style when not inlined. Should the simple list be translated to render something nice rather than raw ERT/SGML copy?


simplelist/member

Name

simplelist/member — simplelist member element

Synopsis


Members of a simplelist are translated to ERT mode.


callout arearef

Name

callout arearef — Callout References

Synopsis


Callout arearef is not translated because we don't know how it should be translated in LyX. Any idea is welcome...


mediaobject

Name

mediaobject — Figure inclusion

Synopsis


This element translated only for figure file inclusion. The following example is well translated:

<figure float="0" id="figureeps"> 
  <title>A pdf/eps fig </title> 
  <mediaobject> 
    <imageobject> 
      <imagedata fileref="figures/sample" align="center" scale="75"> 
      </imagedata> 
    </imageobject> 
    <textobject> 
      <para> figure Description </para> 
    </textobject> 
  </mediaobject> 
</figure>

The question is: how should be translated the other media?


command

Name

command — command tag

Synopsis


This element is copied as ERT. Many of inlined elements are not supported in LyX.


computeroutput

Name

computeroutput — Console output

Synopsis


This element is copied as ERT. Many of inlined elements are not supported in LyX.


classname

Name

classname — Class name

Synopsis


This element is copied as ERT. Many of inlined elements are not supported in LyX.


prompt

Name

prompt — Prompt command

Synopsis


This element is copied as ERT. Many of inlined elements are not supported in LyX.


exceptionname|varname|methodname|interfacename|errorname

Name

exceptionname|varname|methodname|interfacename|errorname — Exception, Var name

Synopsis


This element is copied as ERT. Many of inlined elements are not supported in LyX.


shortcut|keycap

Name

shortcut|keycap — Shortcut, Keycap

Synopsis


This element is copied as ERT. Many of inlined elements are not supported in LyX.


systemitem

Name

systemitem — systemitem

Synopsis


This element is copied as ERT. Many of inlined elements are not supported in LyX.


superscript|subscript

Name

superscript|subscript — superscript and subscript

Synopsis


These elements are copied as ERT. Many of inlined elements are not supported in LyX.


envar

Name

envar — envar tag

Synopsis


This element is copied as ERT. Many of inlined elements are not supported in LyX.


filename

Name

filename — filename tag

Synopsis


This element is copied as ERT. Many of inlined elements are not supported in LyX.


function

Name

function — filename tag

Synopsis


This element is copied as ERT. Many of inlined elements are not supported in LyX.

Translating functions as is can make the output LyX file difficult to read. Should it be replaced by only a displaying translation?


option

Name

option — option tag

Synopsis


This element is copied as ERT. Many of inlined elements are not supported in LyX.


parameter

Name

parameter — parameter tag

Synopsis


This element is copied as ERT. Many of inlined elements are not supported in LyX.

This element is often combined with the function one.


replaceable

Name

replaceable — replaceable tag

Synopsis


This element is copied as ERT. Many of inlined elements are not supported in LyX.

This element is often combined with the function or command tag.


userinput

Name

userinput — userinput tag

Synopsis


This element is copied as ERT. Many of inlined elements are not supported in LyX.


authorgroup

Name

authorgroup — Authorgroup Element

Synopsis


This elements is copied as SGML Style, even if a new layout style could be added to support the element. The new layout style could look like:

# Authorgroup
Style Authorgroup
  CopyStyle             Author
  LatexType             Environment
  LatexName             authorgroup
  LatexParam            author
End

cmdsynopsis

Name

cmdsynopsis — Command Element

Synopsis


This element is copied as SGML, since it must be displayed as a block. The elements command, group, and arg used under this element are copied as ERT.

This element should be translated in another way because the output LyX file can be hardly readable if it contains many commands. The question is: should it be only rendered or should we keep the structure?


simpara

Name

simpara — Simple paragraph

Synopsis


This element is translated exactly like the para element. The reason is that it is really a basic element, and considering it as a paragraph make no information loss.

Anyway should this element be supported by a new LyX layout?


formalpara

Name

formalpara — Formal paragraph

Synopsis


This element is translated in raw SGML, since we don't know how to translate its title element.