[multimedia/elisa] /: Remove docbook
Nate Graham
null at kde.org
Sun Jun 30 22:19:06 BST 2024
Git commit 2de8329130edadca870a42ff05811637381957ca by Nate Graham.
Committed on 30/06/2024 at 21:14.
Pushed by ngraham into branch 'master'.
Remove docbook
This app is fairly simple and easy to use, and in general people don't
read docs for these kinds of apps. In addition, Elisa's docs are
woefully out of date, currently of no use to anyone.
Instead of putting effort into improving them, let's instead delete them
and put that effort into improving the UI so anything that might need to
be explained by docs no one will read is instead obvious in the UI, as
the HIG recommends.
M +0 -9 CMakeLists.txt
M +0 -1 README.packagers
D +0 -13 doc/CMakeLists.txt
D +- -- doc/Screenshot_20180912_232200.png
D +0 -3 doc/Screenshot_20180912_232200.png.license
D +0 -251 doc/index.docbook
D +0 -3 doc/index.docbook.license
M +0 -1 org.kde.elisa.appdata.xml
M +0 -10 src/elisaapplication.cpp
M +0 -2 src/elisaapplication.h
M +0 -11 src/qml/ApplicationMenu.qml
M +0 -7 src/qml/NativeGlobalMenu.qml
M +0 -13 src/qml/NativeTrayMenu.qml
https://invent.kde.org/multimedia/elisa/-/commit/2de8329130edadca870a42ff05811637381957ca
diff --git a/CMakeLists.txt b/CMakeLists.txt
index 3995925d7..f748619bc 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -88,11 +88,6 @@ set_package_properties(KF6FileMetaData PROPERTIES
DESCRIPTION "Provides a simple library for extracting metadata."
TYPE RECOMMENDED)
-find_package(KF6DocTools ${REQUIRED_KF_VERSION} CONFIG QUIET)
-set_package_properties(KF6DocTools PROPERTIES
- DESCRIPTION "Create documentation from DocBook library."
- TYPE OPTIONAL)
-
find_package(KF6XmlGui ${REQUIRED_KF_VERSION} CONFIG QUIET)
set_package_properties(KF6XmlGui PROPERTIES
DESCRIPTION "Framework for managing menu and toolbar actions."
@@ -180,7 +175,6 @@ add_subdirectory(icons)
if (BUILD_TESTING)
add_subdirectory(autotests)
endif()
-add_subdirectory(doc)
if (KF6DBusAddons_FOUND)
ecm_generate_dbus_service_file(
@@ -205,9 +199,6 @@ install(
)
ki18n_install(po)
-if (KF6DocTools_FOUND)
- kdoctools_install(po)
-endif()
install(FILES elisa.categories DESTINATION ${KDE_INSTALL_LOGGINGCATEGORIESDIR})
diff --git a/README.packagers b/README.packagers
index 3d65b1ec0..e895077fd 100644
--- a/README.packagers
+++ b/README.packagers
@@ -41,7 +41,6 @@ Elisa has the following dependencies:
-- OPTIONAL:
* QtDBus (required version >= 5.12.0), Qt5 DBus is needed to provide MPris2 interface to allow remote control by the desktop workspace.
- * KDocTools (required version >= 5.70.0), Create documentation from DocBook library.
* KCrash (required version >= 5.70.0), Graceful handling of application crashes.
* KDBusAddons (required version >= 5.70.0), Convenience classes for D-Bus.
* PkgConfig
diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt
deleted file mode 100644
index 49ff77e4b..000000000
--- a/doc/CMakeLists.txt
+++ /dev/null
@@ -1,13 +0,0 @@
-# SPDX-FileCopyrightText: 2017 (c) Matthieu Gallien <matthieu_gallien at yahoo.fr>
-#
-# SPDX-License-Identifier: LGPL-3.0-or-later
-
-# documentation
-
-if (KF6DocTools_FOUND)
- KDOCTOOLS_CREATE_HANDBOOK(
- index.docbook
- INSTALL_DESTINATION ${KDE_INSTALL_DOCBUNDLEDIR}/en
- SUBDIR elisa
- )
-endif()
diff --git a/doc/Screenshot_20180912_232200.png b/doc/Screenshot_20180912_232200.png
deleted file mode 100644
index 67fffb8ab..000000000
Binary files a/doc/Screenshot_20180912_232200.png and /dev/null differ
diff --git a/doc/Screenshot_20180912_232200.png.license b/doc/Screenshot_20180912_232200.png.license
deleted file mode 100644
index 928ac03d1..000000000
--- a/doc/Screenshot_20180912_232200.png.license
+++ /dev/null
@@ -1,3 +0,0 @@
-SPDX-FileCopyrightText: 2018 Matthieu Gallien <matthieu_gallien at yahoo.fr>
-
-SPDX-License-Identifier: LGPL-3.0-or-later
\ No newline at end of file
diff --git a/doc/index.docbook b/doc/index.docbook
deleted file mode 100644
index 240141606..000000000
--- a/doc/index.docbook
+++ /dev/null
@@ -1,251 +0,0 @@
-<?xml version="1.0" ?>
-<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [
- <!ENTITY elisa "<application>Elisa</application>">
- <!ENTITY i18n-translatable-entity "<application>Elisa</application>">
- <!ENTITY % addindex "IGNORE">
- <!ENTITY % English "INCLUDE">
-]>
-<book id="elisa" lang="&language;">
-
-<!-- This header contains all of the meta-information for the document such
-as Authors, publish date, the abstract, and Keywords -->
-
-<bookinfo>
-<title>The &elisa; Handbook</title>
-
-<authorgroup>
-<author>
-<personname>
-<firstname>Matthieu</firstname>
-<surname>Gallien</surname>
-</personname>
-<email>matthieu_gallien at yahoo.fr</email>
-</author>
-<!-- TRANS:ROLES_OF_TRANSLATORS -->
-</authorgroup>
-
-<copyright>
-<year>2017-2018</year>
-<holder>Matthieu Gallien</holder>
-</copyright>
-<legalnotice>&CCBYSA4Notice;</legalnotice>
-
-<date>2018-09-14</date>
-
-<releaseinfo>Elisa 0.3.80</releaseinfo>
-
-<abstract>
-<para>
-Elisa is a music player developed by the KDE community that strives to be
-simple and nice to use. We also recognize that we need a flexible product to
-account for the different workflows and use-cases of our users.
-</para>
-<para>
-We focus on a very good integration with the Plasma desktop of the KDE
-community without compromising the support for other platforms (other Linux
-desktop environments, Windows and Android).
-</para>
-<para>
-We are creating a reliable product that is a joy to use and respects our users
-privacy. As such, we will prefer to support online services where users are in
-control of their data.
-</para>
-</abstract>
-
-<keywordset>
-<keyword>KDE</keyword>
-<keyword>kdemultimedia</keyword>
-<keyword>Elisa</keyword>
-<keyword>audio</keyword>
-<keyword>music</keyword>
-</keywordset>
-
-</bookinfo>
-
-<chapter id="introduction">
-<title>Introduction</title>
-
-<para>
-&elisa; is a music player designed to be simple to use.
-
-<screenshot>
-<screeninfo>Here's a screenshot of &elisa; start screen</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="Screenshot_20180912_232200.png" format="PNG"/>
- </imageobject>
- <textobject>
- <phrase>Screenshot</phrase>
- </textobject>
- </mediaobject>
-</screenshot>
-</para>
-</chapter>
-
-<chapter id="using-kapp">
-<title>Using &elisa;</title>
-
-<para>
-&elisa; indexes your music by searching in a list of paths configured by the user through a dedicated interface.
-</para>
-<para>
-In case the file indexer is not finding anything, a notification is shown with a button to open the configuration interface.
-</para>
-
-<para>
-You can find a list of changes at <ulink
-url="https://phabricator.kde.org/project/profile/193/">Elisa Project</ulink>.
-</para>
-
-<para>Currently no configuration is required before use of &elisa;.
-You can explore the menu of the application to see the customization possibilities. It is possible to choose the paths that will be indexed for music. It is also possible to modify the shortcuts for common actions inside the application.
-</para>
-
-<para>
-If you use the internal music indexer, you can configure the paths that will be searched.
-</para>
-
-
-<sect1 id="kapp-features">
-<title>&elisa; features</title>
-
-<para>
-&elisa; provides two different tasks: browsing your music to build a playlist and playing music.
-</para>
-
-<sect2>
-<title>Browsing Music</title>
-<para>
-From the different sources of music, it collects all your music and analyses their metadata such that their title, artist, ...
-It provides fourth ways to browse your music: a list of all albums, a list of all artists, a list of all tracks or a list of all genres.
-</para>
-<para>
-Each method uses a view of all your music along with a filter to allow to quickly find what you are looking for. You can also filter by rating.
-</para>
-<para>
-The filter of the view of all albums is implemented on the title or the artist of albums or the list of artists of each track of an album.
-The filter of the view of all artists is implemented on the name of the artists.
-The filter of the view of all tracks is implemented on the track title, track artist and track album name (if any).
-</para>
-<para>
-It is also possible to directly browse the file system and play music files.
-</para>
-</sect2>
-
-<sect2>
-<title>Building a Playlist</title>
-<para>
-When browsing your music, artists, albums and tracks can be added with a button shown when mouse is over it.
-It is also possible to clear the playlist and at the same time add some music.
-</para>
-<para>
-A toolbar below the playlist allows to operate on it. The following actions are possible:
-<itemizedlist>
- <listitem>
- <para>
- You can clear the whole playlist.
- </para>
- </listitem>
- <listitem>
- <para>
- You can navigate to the currently playing track.
- </para>
- </listitem>
- <listitem>
- <para>
- You can save the playlist to the m3u8 format.
- </para>
- </listitem>
- <listitem>
- <para>
- You can load a playlist that will replace your current one.
- </para>
- </listitem>
-</itemizedlist>
-</para>
-</sect2>
-
-<sect2>
-<title>Playing Music</title>
-<para>
-The playlist is read in the order of the tracks unless the <guilabel>Shuffle</guilabel> option is selected.
-At the end of the list playing is stopped unless the <guilabel>Repeat</guilabel> option is selected.
-</para>
-<para>
-It is possible to switch to the next or previous track in the list. If the mouse is over a track, it is possible to skip to it by pressing a button.
-</para>
-<para>
-The currently playing track is indicated by a flashing play icon.
-</para>
-</sect2>
-
-</sect1>
-
-</chapter>
-
-<chapter id="credits">
-
-<!-- Include credits for the programmers, documentation writers, and
-contributors here. The license for your software should then be included below
-the credits with a reference to the appropriate license file included in the KDE
-distribution. -->
-
-<title>Credits and License</title>
-
-<para>
-&elisa;
-</para>
-<para>
-Program copyright 2015-2018 The Elisa Team
-</para>
-<para>
-Contributors:
-<itemizedlist>
-<listitem><para>Matthieu Gallien Maintainer <email>matthieu_gallien at yahoo.fr</email></para>
-</listitem>
-<listitem><para>Andrew Lake (concept and design work) <email>jamboarder at gmail.com</email></para>
-</listitem>
-<listitem><para>Luigi Toscano (localizations) <email>luigi.toscano at tiscali.it</email></para>
-</listitem>
-<listitem><para>Safa Alfulaij (right-to-left support in interface) <email>safa1996alfulaij at gmail.com</email></para>
-</listitem>
-<listitem><para>Alexander Stippich Core developer <email>a.stippich at gmx.net</email></para>
-</listitem>
-<listitem><para>Diego Gangl (various improvements to the interface) <email>diego at sinestesia.co</email></para>
-</listitem>
-</itemizedlist>
-</para>
-
-<para>
-Documentation Copyright © 2017-2018 Matthieu Gallien <email>matthieu_gallien at yahoo.fr</email>
-</para>
-
-<!-- TRANS:CREDIT_FOR_TRANSLATORS -->
-
-&underCCBYSA4; <!-- CC BY-SA 4.0: do not remove -->
-
-<!-- Determine which license your application is licensed under,
- and delete all the remaining licenses below:
-
- (NOTE: All documentation are licensed under the CC BY-SA 4.0,
- regardless of what license the application uses) -->
-
-&underLGPL; <!-- LGPL License -->
-
-</chapter>
-
-&documentation.index;
-</book>
-
-<!--
-Local Variables:
-mode: xml
-sgml-minimize-attributes:nil
-sgml-general-insert-case:lower
-sgml-indent-step:0
-sgml-indent-data:nil
-End:
-
-vim:tabstop=2:shiftwidth=2:expandtab
-kate: space-indent on; indent-width 2; tab-width 2; indent-mode none;
--->
diff --git a/doc/index.docbook.license b/doc/index.docbook.license
deleted file mode 100644
index 3013e2f0a..000000000
--- a/doc/index.docbook.license
+++ /dev/null
@@ -1,3 +0,0 @@
-SPDX-FileCopyrightText: 2017 Matthieu Gallien <matthieu_gallien at yahoo.fr>
-
-SPDX-License-Identifier: LGPL-3.0-or-later
\ No newline at end of file
diff --git a/org.kde.elisa.appdata.xml b/org.kde.elisa.appdata.xml
index 8ae4c3c5f..fe6470c67 100644
--- a/org.kde.elisa.appdata.xml
+++ b/org.kde.elisa.appdata.xml
@@ -235,7 +235,6 @@ SPDX-License-Identifier: CC0-1.0
<url type="homepage">https://apps.kde.org/elisa</url>
<url type="bugtracker">https://bugs.kde.org/enter_bug.cgi?product=elisa</url>
<url type="donation">https://www.kde.org/community/donations/?app=elisa&source=appdata</url>
- <url type="help">https://docs.kde.org/?application=elisa</url>
<screenshots>
<screenshot type="default">
<caption>The Elisa music player</caption>
diff --git a/src/elisaapplication.cpp b/src/elisaapplication.cpp
index 5e7fbbafb..53d83d307 100644
--- a/src/elisaapplication.cpp
+++ b/src/elisaapplication.cpp
@@ -136,11 +136,6 @@ void ElisaApplication::setupActions(const QString &actionName)
d->mCollection.addAction(actionName, quitAction);
}
- if (actionName == QLatin1String("help_contents") && KAuthorized::authorizeAction(actionName)) {
- auto handBookAction = KStandardActions::helpContents(this, &ElisaApplication::appHelpActivated, &d->mCollection);
- d->mCollection.addAction(handBookAction->objectName(), handBookAction);
- }
-
if (actionName == QLatin1String("help_report_bug") && KAuthorized::authorizeAction(actionName) && !KAboutData::applicationData().bugAddress().isEmpty()) {
auto reportBugAction = KStandardActions::reportBug(this, &ElisaApplication::reportBug, &d->mCollection);
d->mCollection.addAction(reportBugAction->objectName(), reportBugAction);
@@ -279,11 +274,6 @@ void ElisaApplication::openRequested(const QList<QUrl> &uris)
openFiles(uris);
}
-void ElisaApplication::appHelpActivated()
-{
- QDesktopServices::openUrl(QUrl(QStringLiteral("help:/")));
-}
-
void ElisaApplication::reportBug()
{
#if KFXmlGui_FOUND
diff --git a/src/elisaapplication.h b/src/elisaapplication.h
index 70949c4f1..9d811cd78 100644
--- a/src/elisaapplication.h
+++ b/src/elisaapplication.h
@@ -195,8 +195,6 @@ Q_SIGNALS:
public Q_SLOTS:
- void appHelpActivated();
-
void reportBug();
void configureShortcuts();
diff --git a/src/qml/ApplicationMenu.qml b/src/qml/ApplicationMenu.qml
index 1cb44a470..265cadaae 100644
--- a/src/qml/ApplicationMenu.qml
+++ b/src/qml/ApplicationMenu.qml
@@ -16,7 +16,6 @@ Menu {
id: applicationMenu
title: i18nc("@title:menu", "Application Menu")
- property var helpAction: ElisaApplication.action("help_contents")
property var reportBugAction: ElisaApplication.action("help_report_bug")
property var aboutAppAction: ElisaApplication.action("help_about_app")
property var aboutKdeAction: ElisaApplication.action("help_about_kde")
@@ -94,16 +93,6 @@ Menu {
MenuSeparator {}
- Action {
- text: helpAction.text
- shortcut: ElisaApplication.actionShortcut(helpAction)
- icon.name: ElisaApplication.iconName(helpAction.icon)
- onTriggered: {
- applicationMenu.close()
- helpAction.trigger()
- }
- }
-
Action {
text: aboutAppAction.text
shortcut: ElisaApplication.actionShortcut(aboutAppAction)
diff --git a/src/qml/NativeGlobalMenu.qml b/src/qml/NativeGlobalMenu.qml
index 6968378f0..f72404061 100644
--- a/src/qml/NativeGlobalMenu.qml
+++ b/src/qml/NativeGlobalMenu.qml
@@ -150,13 +150,6 @@ MenuBar {
Menu {
title: i18nc("@title:menu", "Help")
- NativeMenuItemFromAction {
- elisaAction: "help_contents"
- }
-
- MenuSeparator {
- }
-
NativeMenuItemFromAction {
elisaAction: "help_about_app"
}
diff --git a/src/qml/NativeTrayMenu.qml b/src/qml/NativeTrayMenu.qml
index 0331b3124..0fa843eba 100644
--- a/src/qml/NativeTrayMenu.qml
+++ b/src/qml/NativeTrayMenu.qml
@@ -13,7 +13,6 @@ Menu {
id: applicationMenu
title: i18nc("@title:menu", "Application Menu")
- property var helpAction: ElisaApplication.action("help_contents")
property var quitApplication: ElisaApplication.action("file_quit")
property var reportBugAction: ElisaApplication.action("help_report_bug")
property var aboutAppAction: ElisaApplication.action("help_about_app")
@@ -75,18 +74,6 @@ Menu {
visible: reportBugAction.text !== ""
}
- MenuSeparator {
- visible: helpAction.text !== ""
- }
-
- MenuItem {
- text: helpAction.text
- shortcut: ElisaApplication.actionShortcut(helpAction)
- icon.name: ElisaApplication.iconName(helpAction.icon)
- onTriggered: helpAction.trigger()
- visible: helpAction.text !== ""
- }
-
MenuItem {
text: aboutAppAction.text
shortcut: ElisaApplication.actionShortcut(aboutAppAction)
More information about the kde-doc-english
mailing list