From 3aef1afb880077b776d9807b1186a6744d851760 Mon Sep 17 00:00:00 2001 From: Darrell Anderson Date: Wed, 19 Feb 2014 18:58:08 -0600 Subject: [PATCH] Add help handbook, add DocPath, rename files. --- Makefile.am | 2 +- doc/Makefile.am | 1 + doc/en/Makefile.am | 2 + doc/en/index.docbook | 61 +++++++++++++++ kchmviewer.kdevses | 74 ------------------- lib/tdeio-msits/kchmviewer.desktop | 1 + src/Makefile.am | 8 +- src/kchmbookmarkwindow.h | 2 +- src/kchmconfig.cpp | 2 +- src/kchmcontentswindow.cpp | 2 +- src/kchmcontentswindow.h | 2 +- src/kchmdialogchooseurlfromlist.cpp | 2 +- src/kchmlistitemtooltip.h | 2 +- src/kchmmainwindow.cpp | 2 +- src/kchmmainwindow.h | 2 +- src/kchmnavtoolbar.cpp | 2 +- src/kchmsearchtoolbar.h | 2 +- src/kchmsearchwindow.h | 2 +- src/kchmsetupdialog.cpp | 7 ++ src/kchmviewwindow.h | 2 +- src/kchmviewwindow_qtextbrowser.cpp | 2 +- src/kchmviewwindow_qtextbrowser.h | 2 +- src/kchmviewwindowmgr.cpp | 2 +- src/kchmviewwindowmgr.h | 2 +- src/main.cpp | 4 +- src/{kde-qt.cpp => tde-tqt.cpp} | 2 +- src/{kde-qt.h => tde-tqt.h} | 0 src/{kde => tde}/Makefile.am | 0 src/{kde => tde}/kchmdcopiface.cpp | 0 src/{kde => tde}/kchmdcopiface.h | 0 src/{kde => tde}/kchmdcopiface_skel.cpp | 0 .../kchmviewwindow_tdehtmlpart.cpp | 2 +- src/{kde => tde}/kchmviewwindow_tdehtmlpart.h | 2 +- subdirs | 2 +- 34 files changed, 99 insertions(+), 101 deletions(-) create mode 100644 doc/Makefile.am create mode 100644 doc/en/Makefile.am create mode 100644 doc/en/index.docbook delete mode 100644 kchmviewer.kdevses rename src/{kde-qt.cpp => tde-tqt.cpp} (99%) rename src/{kde-qt.h => tde-tqt.h} (100%) rename src/{kde => tde}/Makefile.am (100%) rename src/{kde => tde}/kchmdcopiface.cpp (100%) rename src/{kde => tde}/kchmdcopiface.h (100%) rename src/{kde => tde}/kchmdcopiface_skel.cpp (100%) rename src/{kde => tde}/kchmviewwindow_tdehtmlpart.cpp (99%) rename src/{kde => tde}/kchmviewwindow_tdehtmlpart.h (99%) diff --git a/Makefile.am b/Makefile.am index d0665f9..dd66115 100644 --- a/Makefile.am +++ b/Makefile.am @@ -1,6 +1,6 @@ AUTOMAKE_OPTIONS = foreign 1.6 -SUBDIRS = lib src po +SUBDIRS = lib src po doc package-messages: $(MAKE) -f admin/Makefile.common package-messages diff --git a/doc/Makefile.am b/doc/Makefile.am new file mode 100644 index 0000000..81fee21 --- /dev/null +++ b/doc/Makefile.am @@ -0,0 +1 @@ +SUBDIRS = en diff --git a/doc/en/Makefile.am b/doc/en/Makefile.am new file mode 100644 index 0000000..72e7ae5 --- /dev/null +++ b/doc/en/Makefile.am @@ -0,0 +1,2 @@ +KDE_LANG = en +KDE_DOCS = kchmviewer diff --git a/doc/en/index.docbook b/doc/en/index.docbook new file mode 100644 index 0000000..3226287 --- /dev/null +++ b/doc/en/index.docbook @@ -0,0 +1,61 @@ + +KCHMViewer"> + + + +]> + +
+The &kappname; Handbook + + +The &kappname; Handbook + + +&tde-authors; + + + +&tde-release-version; +Reviewed: &tde-release-date; + + +&tde-copyright-date; +&tde-team; + + + + + + +&kappname; is a Microsoft help file (CHM) viewer. + + + + +TDE +CHM + + + + + +We Apologize +No documentation has yet been written for &kappname;. + +If you need help, please check The &tde; +web site, submit questions to the +&tde; mail lists, or file a bug report at the +&tde; bug tracker. + +If you are interested in helping, please consider writing the help file. +Submitting a basic text file is acceptable as the &tde-team; will convert the text. + +Thank you for helping and thank you for your patience. + +&underFDL; + + + +
diff --git a/kchmviewer.kdevses b/kchmviewer.kdevses deleted file mode 100644 index 47a0b2f..0000000 --- a/kchmviewer.kdevses +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/lib/tdeio-msits/kchmviewer.desktop b/lib/tdeio-msits/kchmviewer.desktop index 31558d8..83dd1cc 100644 --- a/lib/tdeio-msits/kchmviewer.desktop +++ b/lib/tdeio-msits/kchmviewer.desktop @@ -9,3 +9,4 @@ Name=KchmViewer GenericName=CHM (MS-Help) Viewer Comment=A viewer for CHM (MS-Help) files MimeType=application/chm +DocPath=kchmviewer/index.html diff --git a/src/Makefile.am b/src/Makefile.am index e14ed77..cd05f38 100644 --- a/src/Makefile.am +++ b/src/Makefile.am @@ -1,13 +1,13 @@ if AMC_USE_KDE -LIB_KDEEXTRADIR = kde -LIB_KDEEXTRA = kde/libkdeextra.a +LIB_KDEEXTRADIR = tde +LIB_KDEEXTRA = tde/libkdeextra.a endif bin_PROGRAMS = kchmviewer kchmviewer_SOURCES = iconstorage.cpp kchmbookmarkwindow.cpp kchmconfig.cpp \ kchmindexwindow.cpp kchmmainwindow.cpp kchmsearchtoolbar.cpp kchmsearchwindow.cpp \ kchmsettings.cpp kchmsourcefactory.cpp kchmtreeviewitem.cpp kchmviewwindow.cpp main.cpp \ - kchmdialogchooseurlfromlist.cpp kde-qt.cpp kchmviewwindow_qtextbrowser.cpp \ + kchmdialogchooseurlfromlist.cpp tde-tqt.cpp kchmviewwindow_qtextbrowser.cpp \ kchmsetupdialog.ui kqtempfile.cpp kchmnavtoolbar.cpp kchmviewwindowmgr.cpp \ kchmkeyeventfilter.cpp kchmcontentswindow.cpp kchmsearchengine_impl.cpp \ kchmsearchengine.cpp @@ -28,7 +28,7 @@ KDE_ICON = AUTO noinst_HEADERS = kchmsettings.h forwarddeclarations.h kchmsourcefactory.h \ iconstorage.h kchmbookmarkwindow.h kchmconfig.h kchmtreeviewitem.h \ kchmdialogchooseurlfromlist.h kchmviewwindow.h kchmindexwindow.h \ - kchmmainwindow.h kchmviewwindow_qtextbrowser.h kchmsearchtoolbar.h kde-qt.h \ + kchmmainwindow.h kchmviewwindow_qtextbrowser.h kchmsearchtoolbar.h tde-tqt.h \ kchmsearchwindow.h kqtempfile.h kqrunprocess.h kchmnavtoolbar.h kchmviewwindowmgr.h \ kchmkeyeventfilter.h kchmcontentswindow.h kchmlistitemtooltip.h kchmsearchengine_impl.h \ kchmsearchengine.h diff --git a/src/kchmbookmarkwindow.h b/src/kchmbookmarkwindow.h index ef57278..2a79b49 100644 --- a/src/kchmbookmarkwindow.h +++ b/src/kchmbookmarkwindow.h @@ -22,7 +22,7 @@ #ifndef KCHMBOOKMARKWINDOW_H #define KCHMBOOKMARKWINDOW_H -#include "kde-qt.h" +#include "tde-tqt.h" #include "forwarddeclarations.h" #include "kchmsettings.h" diff --git a/src/kchmconfig.cpp b/src/kchmconfig.cpp index 8f33057..c96acb0 100644 --- a/src/kchmconfig.cpp +++ b/src/kchmconfig.cpp @@ -19,7 +19,7 @@ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. * ***************************************************************************/ -#include "kde-qt.h" +#include "tde-tqt.h" #include "kchmconfig.h" #include "kchmsettings.h" #include "kchmmainwindow.h" diff --git a/src/kchmcontentswindow.cpp b/src/kchmcontentswindow.cpp index b98b444..200df61 100644 --- a/src/kchmcontentswindow.cpp +++ b/src/kchmcontentswindow.cpp @@ -19,7 +19,7 @@ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. * ***************************************************************************/ -#include "kde-qt.h" +#include "tde-tqt.h" #include "libchmfile.h" diff --git a/src/kchmcontentswindow.h b/src/kchmcontentswindow.h index e47b0fb..5c29956 100644 --- a/src/kchmcontentswindow.h +++ b/src/kchmcontentswindow.h @@ -22,7 +22,7 @@ #ifndef INCLUDE_KCHMCONTENTSWINDOW_H #define INCLUDE_KCHMCONTENTSWINDOW_H -#include "kde-qt.h" +#include "tde-tqt.h" #include "kchmtreeviewitem.h" /** diff --git a/src/kchmdialogchooseurlfromlist.cpp b/src/kchmdialogchooseurlfromlist.cpp index 41bc64a..bb50a13 100644 --- a/src/kchmdialogchooseurlfromlist.cpp +++ b/src/kchmdialogchooseurlfromlist.cpp @@ -19,7 +19,7 @@ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. * ***************************************************************************/ -#include "kde-qt.h" +#include "tde-tqt.h" #include "kchmdialogchooseurlfromlist.h" #include "kchmtreeviewitem.h" diff --git a/src/kchmlistitemtooltip.h b/src/kchmlistitemtooltip.h index 8bf43bf..1867900 100644 --- a/src/kchmlistitemtooltip.h +++ b/src/kchmlistitemtooltip.h @@ -22,7 +22,7 @@ #ifndef INCLUDE_KCHMLISTITEMTOOLTIP_H #define INCLUDE_KCHMLISTITEMTOOLTIP_H -#include "kde-qt.h" +#include "tde-tqt.h" #include "forwarddeclarations.h" /** diff --git a/src/kchmmainwindow.cpp b/src/kchmmainwindow.cpp index da29e54..5aabdae 100644 --- a/src/kchmmainwindow.cpp +++ b/src/kchmmainwindow.cpp @@ -26,7 +26,7 @@ #include #include -#include "kde-qt.h" +#include "tde-tqt.h" #include #include diff --git a/src/kchmmainwindow.h b/src/kchmmainwindow.h index 586e0ee..a4d1127 100644 --- a/src/kchmmainwindow.h +++ b/src/kchmmainwindow.h @@ -22,7 +22,7 @@ #ifndef KCHMMAINWINDOW_H #define KCHMMAINWINDOW_H -#include "kde-qt.h" +#include "tde-tqt.h" #include "libchmfile.h" diff --git a/src/kchmnavtoolbar.cpp b/src/kchmnavtoolbar.cpp index de42ece..7ebb6fc 100644 --- a/src/kchmnavtoolbar.cpp +++ b/src/kchmnavtoolbar.cpp @@ -19,7 +19,7 @@ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. * ***************************************************************************/ -#include "kde-qt.h" +#include "tde-tqt.h" #include "kchmnavtoolbar.h" #include "kchmmainwindow.h" #include "kchmviewwindow.h" diff --git a/src/kchmsearchtoolbar.h b/src/kchmsearchtoolbar.h index cde8e95..f031cca 100644 --- a/src/kchmsearchtoolbar.h +++ b/src/kchmsearchtoolbar.h @@ -22,7 +22,7 @@ #ifndef KCHMSEARCHTOOLBAR_H #define KCHMSEARCHTOOLBAR_H -#include "kde-qt.h" +#include "tde-tqt.h" #include "forwarddeclarations.h" diff --git a/src/kchmsearchwindow.h b/src/kchmsearchwindow.h index e52066d..5a068a8 100644 --- a/src/kchmsearchwindow.h +++ b/src/kchmsearchwindow.h @@ -22,7 +22,7 @@ #ifndef KCHMSEARCHWINDOW_H #define KCHMSEARCHWINDOW_H -#include "kde-qt.h" +#include "tde-tqt.h" #include "kchmsettings.h" #include "forwarddeclarations.h" diff --git a/src/kchmsetupdialog.cpp b/src/kchmsetupdialog.cpp index c7e8b6b..592db23 100644 --- a/src/kchmsetupdialog.cpp +++ b/src/kchmsetupdialog.cpp @@ -23,6 +23,7 @@ #include #include #include +#include /* * Constructs a KCHMSetupDialog as a child of 'parent', with the @@ -277,6 +278,7 @@ KCHMSetupDialog::KCHMSetupDialog( TQWidget* parent, const char* name, bool modal clearWState( WState_Polished ); // signals and slots connections + connect( buttonHelp, TQT_SIGNAL( clicked() ), this, TQT_SLOT( slotShowHelp() ) ); connect( buttonOk, TQT_SIGNAL( clicked() ), this, TQT_SLOT( accept() ) ); connect( buttonCancel, TQT_SIGNAL( clicked() ), this, TQT_SLOT( reject() ) ); connect( m_radioUseTDEHTMLPart, TQT_SIGNAL( toggled(bool) ), groupKhtmlSecurity, TQT_SLOT( setEnabled(bool) ) ); @@ -311,6 +313,11 @@ KCHMSetupDialog::KCHMSetupDialog( TQWidget* parent, const char* name, bool modal setTabOrder( buttonOk, buttonCancel ); } +void KCHMSetupDialog::slotShowHelp() +{ + kapp->invokeHelp( TQString(), "kchmviewer" ); +} + /* * Destroys the object and frees any allocated resources */ diff --git a/src/kchmviewwindow.h b/src/kchmviewwindow.h index fae779e..9a23a01 100644 --- a/src/kchmviewwindow.h +++ b/src/kchmviewwindow.h @@ -23,7 +23,7 @@ #define KCHMVIEWWINDOW_H #include "forwarddeclarations.h" -#include "kde-qt.h" +#include "tde-tqt.h" /** @author Georgy Yunaev diff --git a/src/kchmviewwindow_qtextbrowser.cpp b/src/kchmviewwindow_qtextbrowser.cpp index dea8626..41db166 100644 --- a/src/kchmviewwindow_qtextbrowser.cpp +++ b/src/kchmviewwindow_qtextbrowser.cpp @@ -24,7 +24,7 @@ #include #include -#include "kde-qt.h" +#include "tde-tqt.h" #include "kchmmainwindow.h" #include "kchmviewwindow_qtextbrowser.h" diff --git a/src/kchmviewwindow_qtextbrowser.h b/src/kchmviewwindow_qtextbrowser.h index df76985..15550cb 100644 --- a/src/kchmviewwindow_qtextbrowser.h +++ b/src/kchmviewwindow_qtextbrowser.h @@ -22,7 +22,7 @@ #ifndef KCHMVIEWWINDOW_TQTEXTBROWSER_H #define KCHMVIEWWINDOW_TQTEXTBROWSER_H -#include "kde-qt.h" +#include "tde-tqt.h" #include "kchmviewwindow.h" #include "kchmsourcefactory.h" diff --git a/src/kchmviewwindowmgr.cpp b/src/kchmviewwindowmgr.cpp index 6499951..bf2bc69 100644 --- a/src/kchmviewwindowmgr.cpp +++ b/src/kchmviewwindowmgr.cpp @@ -30,7 +30,7 @@ #include "kchmviewwindow_qtextbrowser.h" #if defined (USE_KDE) - #include "kde/kchmviewwindow_tdehtmlpart.h" + #include "tde/kchmviewwindow_tdehtmlpart.h" #endif diff --git a/src/kchmviewwindowmgr.h b/src/kchmviewwindowmgr.h index 34d791f..eea46de 100644 --- a/src/kchmviewwindowmgr.h +++ b/src/kchmviewwindowmgr.h @@ -22,7 +22,7 @@ #ifndef INCLUDE_KCHMVIEWWINDOWMGR_H #define INCLUDE_KCHMVIEWWINDOWMGR_H -#include "kde-qt.h" +#include "tde-tqt.h" #include "forwarddeclarations.h" #include "kchmsettings.h" diff --git a/src/main.cpp b/src/main.cpp index 8e84f20..35542f4 100644 --- a/src/main.cpp +++ b/src/main.cpp @@ -19,7 +19,7 @@ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. * ***************************************************************************/ -#include "kde-qt.h" +#include "tde-tqt.h" #include "kchmmainwindow.h" #include "kchmconfig.h" @@ -29,7 +29,7 @@ #include #include - #include "kde/kchmdcopiface.h" + #include "tde/kchmdcopiface.h" #endif KCHMMainWindow * mainWindow; diff --git a/src/kde-qt.cpp b/src/tde-tqt.cpp similarity index 99% rename from src/kde-qt.cpp rename to src/tde-tqt.cpp index d12e01b..f668466 100644 --- a/src/kde-qt.cpp +++ b/src/tde-tqt.cpp @@ -19,7 +19,7 @@ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. * ***************************************************************************/ -#include "kde-qt.h" +#include "tde-tqt.h" #if defined (USE_KDE) KQListView::KQListView( TQWidget * parent, const char * name, int ) diff --git a/src/kde-qt.h b/src/tde-tqt.h similarity index 100% rename from src/kde-qt.h rename to src/tde-tqt.h diff --git a/src/kde/Makefile.am b/src/tde/Makefile.am similarity index 100% rename from src/kde/Makefile.am rename to src/tde/Makefile.am diff --git a/src/kde/kchmdcopiface.cpp b/src/tde/kchmdcopiface.cpp similarity index 100% rename from src/kde/kchmdcopiface.cpp rename to src/tde/kchmdcopiface.cpp diff --git a/src/kde/kchmdcopiface.h b/src/tde/kchmdcopiface.h similarity index 100% rename from src/kde/kchmdcopiface.h rename to src/tde/kchmdcopiface.h diff --git a/src/kde/kchmdcopiface_skel.cpp b/src/tde/kchmdcopiface_skel.cpp similarity index 100% rename from src/kde/kchmdcopiface_skel.cpp rename to src/tde/kchmdcopiface_skel.cpp diff --git a/src/kde/kchmviewwindow_tdehtmlpart.cpp b/src/tde/kchmviewwindow_tdehtmlpart.cpp similarity index 99% rename from src/kde/kchmviewwindow_tdehtmlpart.cpp rename to src/tde/kchmviewwindow_tdehtmlpart.cpp index 73f136e..3a57e35 100644 --- a/src/kde/kchmviewwindow_tdehtmlpart.cpp +++ b/src/tde/kchmviewwindow_tdehtmlpart.cpp @@ -24,7 +24,7 @@ #include #include -#include "kde-qt.h" +#include "tde-tqt.h" #include "kchmmainwindow.h" #include "kchmconfig.h" #include "kchmviewwindow_tdehtmlpart.h" diff --git a/src/kde/kchmviewwindow_tdehtmlpart.h b/src/tde/kchmviewwindow_tdehtmlpart.h similarity index 99% rename from src/kde/kchmviewwindow_tdehtmlpart.h rename to src/tde/kchmviewwindow_tdehtmlpart.h index 4bc45c7..0dcbe47 100644 --- a/src/kde/kchmviewwindow_tdehtmlpart.h +++ b/src/tde/kchmviewwindow_tdehtmlpart.h @@ -22,7 +22,7 @@ #ifndef KCHMVIEWWINDOW_TDEHTMLPART_H #define KCHMVIEWWINDOW_TDEHTMLPART_H -#include "kde-qt.h" +#include "tde-tqt.h" #include "kchmviewwindow.h" #include "kchmsourcefactory.h" diff --git a/subdirs b/subdirs index 2841462..c73839a 100644 --- a/subdirs +++ b/subdirs @@ -1,4 +1,4 @@ -kchmviewer-3.1 +doc lib po src