[kio-gdrive] /: Introduce documentation

Elvis Angelaccio elvis.angelaccio at kde.org
Mon Oct 3 14:15:03 UTC 2016


Git commit e43cfbab5648ddc51d5d95c485455ef71391b0e7 by Elvis Angelaccio.
Committed on 03/10/2016 at 14:15.
Pushed by elvisangelaccio into branch 'master'.

Introduce documentation

M  +1    -0    CMakeLists.txt
A  +3    -0    doc/CMakeLists.txt
A  +41   -0    doc/index.docbook

http://commits.kde.org/kio-gdrive/e43cfbab5648ddc51d5d95c485455ef71391b0e7

diff --git a/CMakeLists.txt b/CMakeLists.txt
index 3e2cbab..361359d 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -62,6 +62,7 @@ if(DOLPHIN_INTEGRATION)
     add_subdirectory(desktop)
 endif()
 
+add_subdirectory(doc)
 add_subdirectory(src)
 
 feature_summary(WHAT ALL INCLUDE_QUIET_PACKAGES FATAL_ON_MISSING_REQUIRED_PACKAGES)
diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt
new file mode 100644
index 0000000..6af9f87
--- /dev/null
+++ b/doc/CMakeLists.txt
@@ -0,0 +1,3 @@
+kdoctools_create_handbook(index.docbook
+    INSTALL_DESTINATION ${KDE_INSTALL_DOCBUNDLEDIR}/en
+    SUBDIR kioslave5/gdrive)
diff --git a/doc/index.docbook b/doc/index.docbook
new file mode 100644
index 0000000..f5c137d
--- /dev/null
+++ b/doc/index.docbook
@@ -0,0 +1,41 @@
+<?xml version="1.0" ?>
+<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [
+<!ENTITY % addindex "IGNORE">
+<!ENTITY % English "INCLUDE" >
+]>
+
+<article lang="&language;" id="gdrive">
+<title>gdrive</title>
+
+<articleinfo>
+
+<authorgroup>
+  <author><firstname>Elvis</firstname><surname>Angelaccio</surname>
+    <affiliation>
+      <address>
+        <email>elvis.angelaccio at kde.org</email>
+      </address>
+    </affiliation>
+  </author>
+<!-- TRANS:ROLES_OF_TRANSLATORS -->
+</authorgroup>
+
+<date>2016-10-03</date>
+<releaseinfo>kio-gdrive 1.0.1</releaseinfo>
+
+</articleinfo>
+
+<para>KIO GDrive allows you to access and edit your Google Drive files using KDE applications that support KIO.</para>
+
+<para>You can use the gdrive kioslave like this:</para>
+<para><userinput>gdrive://</userinput> or <userinput>gdrive://<replaceable>foo at example.com</replaceable></userinput>.</para>
+
+<para>The first URL shows an OAuth login dialog from Google, if no Drive account has been authenticated yet,
+or the list of your authenticated accounts instead.</para>
+
+<para>The <userinput>gdrive://</userinput> URL can also be used at any time to add an additional account.</para>
+
+<para>The URL <userinput>gdrive://<replaceable>foo at example.com</replaceable></userinput> lists all the files and folders
+from the top level of the <userinput>foo at example.com</userinput> Drive account.</para>
+
+</article>


More information about the kde-doc-english mailing list