Set "dryrun" to true for XHTML copying routine. This suppresses

[lyx.git] / src / sgml.h

diff --git a/src/sgml.h b/src/sgml.h
index b49aa9467682f67d61a6a256260249479b4e0a39..ed0f1403a5475d9f59c01869a9ffe790cd204702 100644 (file)
--- a/src/sgml.h
+++ b/src/sgml.h
@@ -1,36 +1,60 @@
+// -*- C++ -*-
 /**
  * \file sgml.h
- * Copyright 2002 the LyX Team
- * Read the file COPYING
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
  *
- * \author José Matos
- * \author John Levon <levon@movementarian.org>
+ * \author José Matos
+ * \author John Levon
+ *
+ * Full author contact details are available in file CREDITS.
  */
 
 #ifndef SGML_H
 #define SGML_H
- 
-#include "LString.h"
- 
-#include <algorithm>
-#include <iosfwd>
- 
+
+#include "support/types.h"
+#include "support/docstring.h"
+
+namespace lyx {
+
+class Buffer;
+class Paragraph;
+class OutputParams;
+
 namespace sgml {
 
 /**
- * Escape the given character if necessary
- * to an SGML entity. Returns true
- * if it was a whitespace character.
+ * Escape the given character, if necessary,
+ * to an SGML entity.
  */
-std::pair<bool, string> escapeChar(char c);
+docstring escapeChar(char_type c);
+
+/// Escape a word instead of a single character
+docstring escapeString(docstring const & raw);
+
+/// replaces illegal characters from SGML/XML ID attributes
+docstring cleanID(Buffer const & buf, OutputParams const & runparams,
+                   docstring const & orig);
+
+/// returns a unique numeric id
+docstring const uniqueID(docstring const label);
+
+/// Opens tag
+void openTag(odocstream & os, std::string const & name,
+           std::string const & attribute = std::string());
+
+/// Open tag
+void openTag(Buffer const & buf, odocstream & os,
+            OutputParams const & runparams, Paragraph const & par);
+
+/// Close tag
+void closeTag(odocstream & os, std::string const & name);
 
-/// FIXME
-int openTag(std::ostream & os, Paragraph::depth_type depth,
-           bool mixcont, string const & latexname);
+/// Close tag
+void closeTag(odocstream & os, Paragraph const & par);
 
-/// FIXME
-int closeTag(std::ostream & os, Paragraph::depth_type depth,
-           bool mixcont, string const & latexname);
-}
+} // namespace sgml
+} // namespace lyx
 
 #endif // SGML_H