KDocTools

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 <QList>
18#include <QStandardPaths>
19#include <kdoctools_export.h>
20
21class QByteArray;
22class QString;
23
24/**
25 * @namespace KDocTools
26 * Utility methods to generate documentation in various format from DocBook files
27 */
28namespace KDocTools
29{
30/**
31 * Transform and return the content of file with the specified XSLT stylesheet
32 * (both already in memory) using the optional parameters.
33 */
34KDOCTOOLS_EXPORT QString transform(const QString &file, const QString &stylesheet, const QList<const char *> &params = QList<const char *>());
35
36/**
37 * Extract the content of a single file from the content string
38 * generated by the transformation scripts.
39 * @since 5.32
40 */
41KDOCTOOLS_EXPORT QByteArray extractFileToBuffer(const QString &content, const QString &filename);
42
43/**
44 * Save the content (compressed) in the specified filename.
45 */
46KDOCTOOLS_EXPORT bool saveToCache(const QString &contents, const QString &filename);
47
48/**
49 * Initialize the XML catalog used by XSLT functions from the standard
50 directories or from the specified srcdir.
51 */
52KDOCTOOLS_EXPORT void setupStandardDirs(const QString &srcdir = QString());
53
54/**
55 * Find a specified file amongst the resource shipped with KDocTools.
56 */
58
59/**
60 * Returns the directories which can contain documentation.
61 * @since 5.36
62 */
63KDOCTOOLS_EXPORT QStringList documentationDirs();
64
65}
66
67#endif
Utility methods to generate documentation in various format from DocBook files.
KDOCTOOLS_EXPORT QString transform(const QString &file, const QString &stylesheet, const QList< const char * > &params=QList< const char * >())
Transform and return the content of file with the specified XSLT stylesheet (both already in memory) ...
Definition xslt.cpp:134
KDOCTOOLS_EXPORT QString locateFileInDtdResource(const QString &file, const QStandardPaths::LocateOptions option=QStandardPaths::LocateFile)
Find a specified file amongst the resource shipped with KDocTools.
Definition xslt.cpp:352
KDOCTOOLS_EXPORT QByteArray extractFileToBuffer(const QString &content, const QString &filename)
Extract the content of a single file from the content string generated by the transformation scripts.
Definition xslt.cpp:306
KDOCTOOLS_EXPORT bool saveToCache(const QString &contents, const QString &filename)
Save the content (compressed) in the specified filename.
Definition xslt_kde.cpp:8
KDOCTOOLS_EXPORT QStringList documentationDirs()
Returns the directories which can contain documentation.
Definition xslt.cpp:425
KDOCTOOLS_EXPORT void setupStandardDirs(const QString &srcdir=QString())
Initialize the XML catalog used by XSLT functions from the standard directories or from the specified...
Definition xslt.cpp:329
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Mon Nov 4 2024 16:34:30 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.