conversion.txt 2.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384
  1. ====================
  2. Document conversions
  3. ====================
  4. This document aims to document a list of semantic markup elements, which can
  5. not be converted into one or another markup language, so you have to expect
  6. loss in the semantic document information during conversions.
  7. Source RST
  8. ==========
  9. Conversion loss, when the source is a RST document.
  10. Docbook
  11. -------
  12. - Strong emphasis
  13. There is no strong emphasis markup in Docbook, so we use <emphasis
  14. role="strong"/> for this, while the role may be lost during further
  15. conversions.
  16. - Table colspan
  17. Table colspan are available in Docbook, but the markup is rather unintuitive
  18. and hard to read. These information may be lost during further conversions.
  19. - Footnote enumeration
  20. In docbook footnote do not have any user assigned enumeration, while in RST
  21. there may be multiple footnotes with the same (labeled) user assigned
  22. number. This information is completely lost during conversion.
  23. - Substitutions
  24. The substitution references are not preserved, but just substituted during
  25. the conversion process. The information about the parts which were
  26. substituted is completely lost.
  27. - Line blocks / literal blocks
  28. Line blocks and literal blocks are converted to <literalblock> elements,
  29. only differing by the given class attribute.
  30. - Bullet list tokens
  31. The information which kind of bullet list token has been used is completely
  32. omitted during the conversion.
  33. XHTML
  34. -----
  35. - Headers
  36. XHtml only allows a specification of header levels from 1 to 6. All headers
  37. with a depth of ≥ 6 contain a class attribute specifying their real depth.
  38. - Blockquote annotations
  39. There is no XHtml element for blockquote annotations, so that they are
  40. transformed to <div class="annotation"/> elements containing <cite>
  41. elements, which may be considered as a citation source. This information may
  42. be lost during further processing. The cite attribute of blockquotes only
  43. accept URIs.
  44. - Bullet list & ordered list types
  45. XHtml strict does not allow to specify the type of bullet lists or ordered
  46. lists, so that this information is lost during conversion.
  47. - Footnotes
  48. There is no dedicated XHtml element for footnotes, so that footnotes are
  49. referenced inside the text by internal links with the class "footnote", and
  50. the actual footnotes are added below the document in lists of the class
  51. footnote with the proper reference targets.
  52. - Line blocks
  53. Line blocks are transformed into paragraphs, where the lines are seperated
  54. by <br /> elements. This causes the right formatting, but may lose semantic
  55. information.