KDocTools 5.109.0
docbookxslt.h
1/*
2 This file is part of KDE Frameworks - KDocTools
3 The following contributors changed the signatures of the functions
4 exported here:
5
6 SPDX-FileCopyrightText: 2001 Stephan Kulow <coolo@kde.org>
7 SPDX-FileCopyrightText: 2005 Frerich Raabe <raabe@kde.org>
8 SPDX-FileCopyrightText: 2010 Albert Astals Cid <aacid@kde.org>
9 SPDX-FileCopyrightText: 2010, 2016, 2017 Luigi Toscano <luigi.toscano@tiscali.it>
10
11 SPDX-License-Identifier: LGPL-2.1-or-later
12*/
13
14#ifndef _KDOCTOOLS_XSLT_H_
15#define _KDOCTOOLS_XSLT_H_
16
17#include <QStandardPaths>
18#include <QVector>
19#include <kdoctools_export.h>
20
21class QByteArray;
22class QString;
23
28namespace KDocTools
29{
34KDOCTOOLS_EXPORT QString transform(const QString &file, const QString &stylesheet, const QVector<const char *> &params = QVector<const char *>());
35
41KDOCTOOLS_EXPORT QByteArray extractFileToBuffer(const QString &content, const QString &filename);
42
46KDOCTOOLS_EXPORT bool saveToCache(const QString &contents, const QString &filename);
47
52KDOCTOOLS_EXPORT void setupStandardDirs(const QString &srcdir = QString());
53
57KDOCTOOLS_EXPORT QString locateFileInDtdResource(const QString &file, const QStandardPaths::LocateOptions option = QStandardPaths::LocateFile);
58
63KDOCTOOLS_EXPORT QStringList documentationDirs();
64
65}
66
67#endif
Utility methods to generate documentation in various format from DocBook files.
QString locateFileInDtdResource(const QString &file, const QStandardPaths::LocateOptions option=QStandardPaths::LocateFile)
Find a specified file amongst the resource shipped with KDocTools.
QByteArray extractFileToBuffer(const QString &content, const QString &filename)
Extract the content of a single file from the content string generated by the transformation scripts.
bool saveToCache(const QString &contents, const QString &filename)
Save the content (compressed) in the specified filename.
QString transform(const QString &file, const QString &stylesheet, const QVector< const char * > &params=QVector< const char * >())
Transform and return the content of file with the specified XSLT stylesheet (both already in memory) ...
QStringList documentationDirs()
Returns the directories which can contain documentation.
void setupStandardDirs(const QString &srcdir=QString())
Initialize the XML catalog used by XSLT functions from the standard directories or from the specified...