From 44c23c4159d9195718a7e80e005cc5c12c7001ce Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sl=C3=A1vek=20Banko?= Date: Wed, 21 Aug 2013 19:16:24 +0200 Subject: Initial import of kio-sword 0.3 --- doc/en/index.docbook | 285 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 285 insertions(+) create mode 100644 doc/en/index.docbook (limited to 'doc/en/index.docbook') diff --git a/doc/en/index.docbook b/doc/en/index.docbook new file mode 100644 index 0000000..365afa7 --- /dev/null +++ b/doc/en/index.docbook @@ -0,0 +1,285 @@ + +Kio-Sword"> + + + + + + +]> + + + + + + + + +The &kio_sword; Handbook + + + + + +Luke Plant + +
L.Plant.98@cantab.net
+ + + + + + + +2004-2006 +Luke Plant + + + + + + + +2006-12-16 +0.3.0 + + + + + +&kio_sword; is a Bible reading tool written for the &kde; environment. It is a + front-end for the SWORD Bible system, and enables you to view, browse and search + your SWORD modules from the web browser (Konqueror). + + + + +KDE +kio_sword +kio-sword +Kio-Sword +kiosword +sword +SWORD +Bible +kio + + + + + +Introduction + + +&kio_sword; is a Bible reading tool written for the &kde; environment. It is a + front-end for the SWORD Bible system, and enables you to view, browse and search + your SWORD modules from the web browser (Konqueror). It is intended to + be a lightweight companion to programs like BibleTime (for the KDE environment) + and other SWORD programs. + + + Please report any problems or feature requests to the author. + + + + +Using &kio_sword; + +To start using &kio_sword; simply type sword:/ + in the location bar in Konqueror, and start browsing your SWORD modules. + To go directly to a section of a module, use a URL like this: +sword:/[modulename]/[reference] + +Examples + +sword:/KJV/Hebrews 1:3 + +Takes you straight to Hebrews 1:3 in the King James Version + + + + +sword:/StrongsGreek/01234 + +Returns the information about the Strongs Number 01234 (Greek) + + + + +sword:John 3:16 + +Redirects to John 3:16 in your default Bible + + + + + + +You can specify other options in the URL. See sword:/?settings. + + + +Questions and Answers + + + +&reporting.bugs; +&updating.documentation; + + + + +I get the message 'No modules installed!' + + +&kio_sword; uses the SWORD modules already installed on your system. + You need to install some modules from Crosswire.org + or use a SWORD frontend such as BibleTime to install the + modules you want. You may need to edit your sword configuration in ~/.sword/ or /etc/sword as per + the instructions on crosswire.org + + + + + + + + + +Credits and License + + +Program and documentation copyright 2004-2006 Luke Plant L.Plant.98@cantab.net + + +&underGPL; + +The code also draws ideas, methods and some code from BibleTime + Diatheke (included in the SWORD source distribution) and the SWORD libraries themselves (all of which are GPL software). See also the AUTHORS file distributed with &kio_sword; for other contributions. + +This &kio_sword; handbook is part of &kio_sword; and is licensed under the same terms. + + + + + + + + + + +Installation + + +How to obtain &kio_sword; + +Download from The &kio_sword; home page + + + + + +Requirements + + +The following libraries are required: +SWORD 1.5.8 or greater +KDE 3 or greater + + + + + +You can find a list of changes at http://apps.kde.org/kio_sword. + + + + +Compilation and Installation + + +In order to compile and install &kappname; on your system, first + unpack the source code. Then type the following in the base directory + of the &kappname; distribution: + +% ./configure +% make +% make install + + +You will need the header files for kdelibs4 and SWORD installed on your system. + +You will need to be root before doing the 'make install' step. + +Since &kappname; uses autoconf and +automake you should have no trouble compiling it. Should you +run into problems please report them to the author. + + + + +Configuration + +You will need to install SWORD modules before using &kio_sword;. +User settings can be saved via the 'Settings' page. + + + + + +&documentation.index; + + + + -- cgit v1.2.1