mirror of
https://github.com/Kitware/CMake.git
synced 2025-06-21 04:01:40 +08:00
dbfe335099
Attributes in XML may contain alphanumeric characters, underscores, colons and dots. When DocBook is chunked, the dot is often used as a path separator. To generate a valid ID, we take the title of the section, transform all non-alphanumeric characters to underscores and then add a prefix separated with dots. We also add the document name as a prefix, in order to 'xinclude' eg. cmake.docbook and ctest.docbook in the same document. IDs are written in multiple places, so the code is factored to a function.
44 lines
1.7 KiB
C++
44 lines
1.7 KiB
C++
/*============================================================================
|
|
CMake - Cross Platform Makefile Generator
|
|
Copyright 2000-2009 Kitware, Inc., Insight Software Consortium
|
|
|
|
Distributed under the OSI-approved BSD License (the "License");
|
|
see accompanying file Copyright.txt for details.
|
|
|
|
This software is distributed WITHOUT ANY WARRANTY; without even the
|
|
implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
|
|
See the License for more information.
|
|
============================================================================*/
|
|
#ifndef _cmDocumentationFormatterDocbook_h
|
|
#define _cmDocumentationFormatterDocbook_h
|
|
|
|
#include "cmStandardIncludes.h"
|
|
|
|
#include "cmDocumentationFormatter.h"
|
|
|
|
/** Class to print the documentation as Docbook.
|
|
http://www.oasis-open.org/docbook/xml/4.2/ */
|
|
class cmDocumentationFormatterDocbook : public cmDocumentationFormatter
|
|
{
|
|
public:
|
|
cmDocumentationFormatterDocbook();
|
|
|
|
virtual cmDocumentationEnums::Form GetForm() const
|
|
{ return cmDocumentationEnums::DocbookForm;}
|
|
|
|
virtual void PrintHeader(const char* docname, const char* appname,
|
|
std::ostream& os);
|
|
virtual void PrintFooter(std::ostream& os);
|
|
virtual void PrintSection(std::ostream& os,
|
|
const cmDocumentationSection& section,
|
|
const char* name);
|
|
virtual void PrintPreformatted(std::ostream& os, const char* text);
|
|
virtual void PrintParagraph(std::ostream& os, const char* text);
|
|
private:
|
|
void PrintId(std::ostream& os, const char* prefix, std::string id);
|
|
std::set<std::string> EmittedLinkIds;
|
|
std::string docname;
|
|
};
|
|
|
|
#endif
|