src/output_docbook.h

   1 // -*- C++ -*-
   2 /**
   3  * \file output_docbook.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Lars Gullik Bjønnes
   8  * \author José Matos
   9  * \author Thibaut Cuvelier
  10  * \author Richard Kimberly Heck
  11  *
  12  * Full author contact details are available in file CREDITS.
  13  */
  14
  15 // TODO: respect languages when opening tags: par.getParLanguage(bparams) in output_latex.cpp
  16 // TODO: if the user specifically asks, output change-tracking information (choice between revisionflag attribute and
  17 //  Oxygen's formatting)
  18 //    <?oxy_options track_changes="on"?> <!-- After closing root tag -->
  19 //    <?oxy_comment_start author="XXX" timestamp="20221226T235332+0100" comment="XXX"?>...<?oxy_comment_end?>
  20 //    <?oxy_insert_start author="XXX" timestamp="20221226T235458+0100"?>XXX<?oxy_insert_end?>
  21 //    <?oxy_delete author="XXX" timestamp="20221226T235519+0100" content="XXX"?> <!-- XML-encoded deleted text
  22 //    (including tags) -->
  23
  24 #ifndef OUTPUT_DOCBOOK_H
  25 #define OUTPUT_DOCBOOK_H
  26
  27 #include "LayoutEnums.h"
  28 #include "ParagraphList.h"
  29
  30 #include "support/docstream.h"
  31 #include "support/strfwd.h"
  32 #include "xml.h"
  33
  34 namespace lyx {
  35
  36 class Buffer;
  37 class OutputParams;
  38 class Text;
  39
  40 /// generates an xml::StartTag for the given style
  41 xml::FontTag docbookStartFontTag(xml::FontTypes type);
  42 /// generates an xml::EndTag for the given style
  43 xml::EndFontTag docbookEndFontTag(xml::FontTypes type);
  44
  45 /// output a series of paragraphs into the XMLStream
  46 void docbookParagraphs(Text const &,
  47                                Buffer const &,
  48                        XMLStream &,
  49                                OutputParams const &);
  50
  51 /// output a single paragraph into the XMLStream
  52 ParagraphList::const_iterator makeAny(Text const &,
  53                                       Buffer const &,
  54                                       XMLStream &,
  55                                       OutputParams const &,
  56                                       ParagraphList::const_iterator);
  57
  58 } // namespace lyx
  59
  60 #endif