diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/Makefile.am | 6 | ||||
| -rw-r--r-- | doc/en/Makefile.am | 2 | ||||
| -rw-r--r-- | doc/en/compilation.html | 9 | ||||
| -rw-r--r-- | doc/en/configuration.html | 2 | ||||
| -rw-r--r-- | doc/en/credits.html | 6 | ||||
| -rw-r--r-- | doc/en/faq.html | 7 | ||||
| -rw-r--r-- | doc/en/index.docbook | 285 | ||||
| -rw-r--r-- | doc/en/index.html | 6 | ||||
| -rw-r--r-- | doc/en/installation.html | 2 | ||||
| -rw-r--r-- | doc/en/introduction.html | 9 | ||||
| -rw-r--r-- | doc/en/requirements.html | 4 | ||||
| -rw-r--r-- | doc/en/using-kio_sword.html | 7 |
12 files changed, 345 insertions, 0 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am new file mode 100644 index 0000000..82b4f3b --- /dev/null +++ b/doc/Makefile.am @@ -0,0 +1,6 @@ +# the SUBDIRS is filled automatically by am_edit. If files are +# in this directory they are installed into the english dir + +KDE_LANG = en +KDE_DOCS = kio_sword +SUBDIRS = $(AUTODIRS) diff --git a/doc/en/Makefile.am b/doc/en/Makefile.am new file mode 100644 index 0000000..627b8fa --- /dev/null +++ b/doc/en/Makefile.am @@ -0,0 +1,2 @@ +KDE_DOCS = kio_sword +KDE_LANG = en diff --git a/doc/en/compilation.html b/doc/en/compilation.html new file mode 100644 index 0000000..0b8f6d7 --- /dev/null +++ b/doc/en/compilation.html @@ -0,0 +1,9 @@ +<html><head><title>Compilation and Installation</title><link rel="stylesheet" href="help:/common/kde-default.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.48"><meta name="keywords" content="KDE, kio_sword, kio-sword, Kio-Sword, kiosword, sword, SWORD, Bible, kio"><meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"><meta name="GENERATOR" content="KDE XSL Stylesheet V1.13 using libxslt"><link rel="home" href="index.html" title="The Kio-Sword Handbook"><link rel="up" href="installation.html" title="Appendix A. Installation"><link rel="previous" href="requirements.html" title="Requirements"><link rel="next" href="configuration.html" title="Configuration"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table border="0" cellpadding="0" cellspacing="0" width="100%"><tr class="header"><td colspan="2"> </td></tr><tr id="logo"><td valign="top"><img src="help:/common/kde_logo.png" alt="KDE - The K Desktop Environment" width="296" height="79" border="0"></td><td valign="middle" align="center" id="location"><h1>Compilation and Installation</h1></td></tr></table><table width="100%" class="header"><tbody><tr><td align="left" class="navLeft" width="33%"><a accesskey="p" href="requirements.html">Prev</a></td><td align="center" class="navCenter" width="34%">Installation</td><td align="right" class="navRight" width="33%"> + <a accesskey="n" href="configuration.html">Next</a></td></tr></tbody></table><div class="sect1"><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="compilation"></a>Compilation and Installation</h2></div></div><p>In order to compile and install Kio-Sword on your system, first + unpack the source code. Then type the following in the base directory + of the Kio-Sword distribution:</p><pre class="screen"><tt>%</tt> <b><tt><span xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" class="command"><b>./configure</b></span></tt></b> +<tt>%</tt> <b><tt><span xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" class="command"><b>make</b></span></tt></b> +<tt>%</tt> <b><tt><span xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" class="command"><b>make</b></span> install</tt></b> +</pre><p>You will need the header files for kdelibs4 and SWORD installed on your system.</p><p>You will need to be root before doing the 'make install' step.</p><p>Since Kio-Sword uses <span xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" class="command"><b>autoconf</b></span> and +<span xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" class="command"><b>automake</b></span> you should have no trouble compiling it. Should you +run into problems please report them to the author.</p></div><table width="100%" class="bottom-nav"><tr><td width="33%" align="left" valign="top" class="navLeft"><a href="requirements.html">Prev</a></td><td width="34%" align="center" valign="top" class="navCenter"><a href="index.html">Home</a></td><td width="33%" align="right" valign="top" class="navRight"><a href="configuration.html">Next</a></td></tr><tr><td width="33%" align="left" class="navLeft">Requirements </td><td width="34%" align="center" class="navCenter"><a href="installation.html">Up</a></td><td width="33%" align="right" class="navRight"> Configuration</td></tr></table></body></html>
\ No newline at end of file diff --git a/doc/en/configuration.html b/doc/en/configuration.html new file mode 100644 index 0000000..b23b7ad --- /dev/null +++ b/doc/en/configuration.html @@ -0,0 +1,2 @@ +<html><head><title>Configuration</title><link rel="stylesheet" href="help:/common/kde-default.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.48"><meta name="keywords" content="KDE, kio_sword, kio-sword, Kio-Sword, kiosword, sword, SWORD, Bible, kio"><meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"><meta name="GENERATOR" content="KDE XSL Stylesheet V1.13 using libxslt"><link rel="home" href="index.html" title="The Kio-Sword Handbook"><link rel="up" href="installation.html" title="Appendix A. Installation"><link rel="previous" href="compilation.html" title="Compilation and Installation"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table border="0" cellpadding="0" cellspacing="0" width="100%"><tr class="header"><td colspan="2"> </td></tr><tr id="logo"><td valign="top"><img src="help:/common/kde_logo.png" alt="KDE - The K Desktop Environment" width="296" height="79" border="0"></td><td valign="middle" align="center" id="location"><h1>Configuration</h1></td></tr></table><table width="100%" class="header"><tbody><tr><td align="left" class="navLeft" width="33%"><a accesskey="p" href="compilation.html">Prev</a></td><td align="center" class="navCenter" width="34%">Installation</td><td align="right" class="navRight" width="33%"> + </td></tr></tbody></table><div class="sect1"><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="configuration"></a>Configuration</h2></div></div><p>You will need to install SWORD modules before using Kio-Sword.</p><p>User settings can be saved via the 'Settings' page.</p></div><table width="100%" class="bottom-nav"><tr><td width="33%" align="left" valign="top" class="navLeft"><a href="compilation.html">Prev</a></td><td width="34%" align="center" valign="top" class="navCenter"><a href="index.html">Home</a></td><td width="33%" align="right" valign="top" class="navRight"></td></tr><tr><td width="33%" align="left" class="navLeft">Compilation and Installation </td><td width="34%" align="center" class="navCenter"><a href="installation.html">Up</a></td><td width="33%" align="right" class="navRight"> </td></tr></table></body></html>
\ No newline at end of file diff --git a/doc/en/credits.html b/doc/en/credits.html new file mode 100644 index 0000000..3b8d6a4 --- /dev/null +++ b/doc/en/credits.html @@ -0,0 +1,6 @@ +<html><head><title>Chapter 4. Credits and License</title><link rel="stylesheet" href="help:/common/kde-default.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.48"><meta name="keywords" content="KDE, kio_sword, kio-sword, Kio-Sword, kiosword, sword, SWORD, Bible, kio"><meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"><meta name="GENERATOR" content="KDE XSL Stylesheet V1.13 using libxslt"><link rel="home" href="index.html" title="The Kio-Sword Handbook"><link rel="up" href="index.html" title="The Kio-Sword Handbook"><link rel="previous" href="faq.html" title="Chapter 3. Questions and Answers"><link rel="next" href="installation.html" title="Appendix A. Installation"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table border="0" cellpadding="0" cellspacing="0" width="100%"><tr class="header"><td colspan="2"> </td></tr><tr id="logo"><td valign="top"><img src="help:/common/kde_logo.png" alt="KDE - The K Desktop Environment" width="296" height="79" border="0"></td><td valign="middle" align="center" id="location"><h1>Credits and License</h1></td></tr></table><table width="100%" class="header"><tbody><tr><td align="left" class="navLeft" width="33%"><a accesskey="p" href="faq.html">Prev</a></td><td align="center" class="navCenter" width="34%"> </td><td align="right" class="navRight" width="33%"> + <a accesskey="n" href="installation.html">Next</a></td></tr></tbody></table><div class="chapter"><div class="titlepage"><div><h2 class="title"><a name="credits"></a>Chapter 4. Credits and License</h2></div></div><p> +Program and documentation copyright 2004-2006 Luke Plant <tt><<a href="mailto:L.Plant.98@cantab.net">L.Plant.98@cantab.net</a>></tt> +</p><p>This program is licensed under the terms of the <a href="common/gpl-license.html" target="_top">GNU General Public License</a>.</p><p>The code also draws ideas, methods and some code from <a href="http://www.bibletime.info" target="_top">BibleTime</a> + 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.</p><p>This Kio-Sword handbook is part of Kio-Sword and is licensed under the same terms. +</p></div><table width="100%" class="bottom-nav"><tr><td width="33%" align="left" valign="top" class="navLeft"><a href="faq.html">Prev</a></td><td width="34%" align="center" valign="top" class="navCenter"><a href="index.html">Home</a></td><td width="33%" align="right" valign="top" class="navRight"><a href="installation.html">Next</a></td></tr><tr><td width="33%" align="left" class="navLeft">Questions and Answers </td><td width="34%" align="center" class="navCenter"><a href="index.html">Up</a></td><td width="33%" align="right" class="navRight"> Installation</td></tr></table></body></html>
\ No newline at end of file diff --git a/doc/en/faq.html b/doc/en/faq.html new file mode 100644 index 0000000..b8e47db --- /dev/null +++ b/doc/en/faq.html @@ -0,0 +1,7 @@ +<html><head><title>Chapter 3. Questions and Answers</title><link rel="stylesheet" href="help:/common/kde-default.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.48"><meta name="keywords" content="KDE, kio_sword, kio-sword, Kio-Sword, kiosword, sword, SWORD, Bible, kio"><meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"><meta name="GENERATOR" content="KDE XSL Stylesheet V1.13 using libxslt"><link rel="home" href="index.html" title="The Kio-Sword Handbook"><link rel="up" href="index.html" title="The Kio-Sword Handbook"><link rel="previous" href="using-kio_sword.html" title="Chapter 2. Using Kio-Sword"><link rel="next" href="credits.html" title="Chapter 4. Credits and License"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table border="0" cellpadding="0" cellspacing="0" width="100%"><tr class="header"><td colspan="2"> </td></tr><tr id="logo"><td valign="top"><img src="help:/common/kde_logo.png" alt="KDE - The K Desktop Environment" width="296" height="79" border="0"></td><td valign="middle" align="center" id="location"><h1>Questions and Answers</h1></td></tr></table><table width="100%" class="header"><tbody><tr><td align="left" class="navLeft" width="33%"><a accesskey="p" href="using-kio_sword.html">Prev</a></td><td align="center" class="navCenter" width="34%"> </td><td align="right" class="navRight" width="33%"> + <a accesskey="n" href="credits.html">Next</a></td></tr></tbody></table><div class="chapter"><div class="titlepage"><div><h2 class="title"><a name="faq"></a>Chapter 3. Questions and Answers</h2></div></div><p>This document may have been updated since your installation. +You can find the latest version at <a href="http://docs.kde.org/current/kde-module/" target="_top">http://docs.kde.org/current/kde-module/</a>.</p><div class="qandaset"><dl><dt>3.1. <a href="faq.html#id2456316">I get the message 'No modules installed!'</a></dt></dl><table border="0"><col align="left" width="1%"><tbody><tr class="question"><td align="left" valign="top"><a name="id2456390"></a><a name="id2456316"></a><b>3.1. </b></td><td align="left" valign="top"><p>I get the message 'No modules installed!'</p></td></tr><tr class="answer"><td align="left" valign="top"><b></b></td><td align="left" valign="top"><p>Kio-Sword uses the SWORD modules already installed on your system. + You need to install some modules from <a href="http://www.crosswire.org" target="_top">Crosswire.org</a> + or use a SWORD frontend such as <a href="http://www.bibletime.info" target="_top">BibleTime</a> 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</p></td></tr></tbody></table></div></div><table width="100%" class="bottom-nav"><tr><td width="33%" align="left" valign="top" class="navLeft"><a href="using-kio_sword.html">Prev</a></td><td width="34%" align="center" valign="top" class="navCenter"><a href="index.html">Home</a></td><td width="33%" align="right" valign="top" class="navRight"><a href="credits.html">Next</a></td></tr><tr><td width="33%" align="left" class="navLeft">Using Kio-Sword </td><td width="34%" align="center" class="navCenter"><a href="index.html">Up</a></td><td width="33%" align="right" class="navRight"> Credits and License</td></tr></table></body></html>
\ No newline at end of file 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 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.1.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!ENTITY kio_sword "<application>Kio-Sword</application>"> + <!ENTITY kappname "&kio_sword;"><!-- Do *not* replace kappname--> + <!ENTITY package "kde-module"><!-- kdebase, kdeadmin, etc --> + <!ENTITY % addindex "IGNORE"> + <!ENTITY % English "INCLUDE"><!-- change language only here --> + + +]> + +<!-- ................................................................ --> + +<!-- The language must NOT be changed here. --> + +<book lang="&language;"> + +<bookinfo> +<title>The &kio_sword; Handbook</title> + +<authorgroup> +<author> +<firstname></firstname> +<othername></othername> +<surname>Luke Plant</surname> +<affiliation> +<address><email>L.Plant.98@cantab.net</email></address> +</affiliation> +</author> +</authorgroup> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> + +<copyright> +<year>2004-2006</year> +<holder>Luke Plant</holder> +</copyright> +<!-- Translators: put here the copyright notice of the translation --> +<!-- legalnotice + +For some reason, meinproc replaces my legal notice with a +link to help:/common/fdl-notice, so I've put legal information +in the relevant section. + --> + + +<!-- Date and version information of the documentation +Don't forget to include this last date and this last revision number, we +need them for translation coordination ! +Please respect the format of the date (YYYY-MM-DD) and of the version +(V.MM.LL), it could be used by automation scripts. +Do NOT change these in the translation. --> + +<date>2006-12-16</date> +<releaseinfo>0.3.0</releaseinfo> + +<!-- Abstract about this handbook --> + +<abstract> +<para> +&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). +</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>kio_sword</keyword> +<keyword>kio-sword</keyword> +<keyword>Kio-Sword</keyword> +<keyword>kiosword</keyword> +<keyword>sword</keyword> +<keyword>SWORD</keyword> +<keyword>Bible</keyword> +<keyword>kio</keyword> +</keywordset> + +</bookinfo> + +<chapter id="introduction"> +<title>Introduction</title> + +<para> +&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. +</para> + +<para> Please report any problems or feature requests to the author. +</para> +</chapter> + +<chapter id="using-kio_sword"> +<title>Using &kio_sword;</title> + +<para>To start using &kio_sword; simply type <ulink url="sword:/">sword:/</ulink> + 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: +<userinput>sword:/[modulename]/[reference]</userinput> +<variablelist> +<title>Examples</title> +<varlistentry> +<term><userinput>sword:/KJV/Hebrews 1:3</userinput></term> +<listitem> +<para>Takes you straight to Hebrews 1:3 in the King James Version</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><userinput>sword:/StrongsGreek/01234</userinput></term> +<listitem> +<para>Returns the information about the Strongs Number 01234 (Greek)</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><userinput>sword:John 3:16</userinput></term> +<listitem> +<para>Redirects to John 3:16 in your default Bible</para> +</listitem> +</varlistentry> + + +</variablelist> +</para> +<para>You can specify other options in the URL. See <ulink url="sword:/?settings">sword:/?settings</ulink>.</para> + +</chapter> +<chapter id="faq"> +<title>Questions and Answers</title> + +<!-- (OPTIONAL but recommended) This chapter should include all of the silly +(and not-so-silly) newbie questions that fill up your mailbox. This chapter +should be reserved for BRIEF questions and answers! If one question uses more +than a page or so then it should probably be part of the +"Using this Application" chapter instead. You should use links to +cross-reference questions to the parts of your documentation that answer them. +This is also a great place to provide pointers to other FAQ's if your users +must do some complicated configuration on other programs in order for your +application work. --> + +&reporting.bugs; +&updating.documentation; + +<qandaset id="faqlist"> +<qandaentry> +<question> +<para>I get the message 'No modules installed!'</para> +</question> +<answer> +<para>&kio_sword; uses the SWORD modules already installed on your system. + You need to install some modules from <ulink url="http://www.crosswire.org">Crosswire.org</ulink> + or use a SWORD frontend such as <ulink url="http://www.bibletime.info">BibleTime</ulink> 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</para> +</answer> +</qandaentry> +</qandaset> +</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> +Program and documentation copyright 2004-2006 Luke Plant <email>L.Plant.98@cantab.net</email> +</para> + +&underGPL; <!-- GPL License --> + +<para>The code also draws ideas, methods and some code from <ulink url="http://www.bibletime.info">BibleTime</ulink> + 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.</para> + +<para>This &kio_sword; handbook is part of &kio_sword; and is licensed under the same terms. +</para> + +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> + +<!-- Determine which license your application is licensed under, + and delete all the remaining licenses below: + + (NOTE: All documentation are licensed under the FDL, + regardless of what license the application uses) --> + + +</chapter> + +<appendix id="installation"> +<title>Installation</title> + +<sect1 id="getting-kio_sword"> +<title>How to obtain &kio_sword;</title> + +<para>Download from <ulink url="http://lukeplant.me.uk/kio-sword/">The &kio_sword; home page</ulink> </para> +<!-- This first entity contains boiler plate for applications that are +part of KDE CVS. You should remove it if you are releasing your +application --> +<!-- +&install.intro.documentation; +--> +</sect1> + +<sect1 id="requirements"> +<title>Requirements</title> +<!-- +List any special requirements for your application here. This should include: +.Libraries or other software that is not included in kdesupport, +kdelibs, or kdebase. +.Hardware requirements like amount of RAM, disk space, graphics card +capabilities, screen resolution, special expansion cards, etc. +.Operating systems the app will run on. If your app is designed only for a +specific OS, (you wrote a graphical LILO configurator for example) put this +information here. +--> + +<para>The following libraries are required:</para> +<para>SWORD 1.5.8 or greater</para> +<para>KDE 3 or greater</para> + +<!-- FIXME link to getting SWORD --> + +<!-- For a list of updates, you may refer to the application web site +or the ChangeLog file, or ... --> +<para> +You can find a list of changes at <ulink +url="http://apps.kde.org/kio_sword">http://apps.kde.org/kio_sword</ulink>. +</para> +</sect1> + +<sect1 id="compilation"> +<title>Compilation and Installation</title> + +<!-- copied from install-compile.docbook then modified --> +<para>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:</para> + +<screen><prompt>%</prompt> <userinput><command>./configure</command></userinput> +<prompt>%</prompt> <userinput><command>make</command></userinput> +<prompt>%</prompt> <userinput><command>make</command> install</userinput> +</screen> + +<para>You will need the header files for kdelibs4 and SWORD installed on your system.</para> + +<para>You will need to be root before doing the 'make install' step.</para> + +<para>Since &kappname; uses <command>autoconf</command> and +<command>automake</command> you should have no trouble compiling it. Should you +run into problems please report them to the author.</para> + +</sect1> + +<sect1 id="configuration"> +<title>Configuration</title> + +<para>You will need to install SWORD modules before using &kio_sword;.</para> +<para>User settings can be saved via the 'Settings' page.</para> + +</sect1> + +</appendix> + +&documentation.index; +</book> + +<!-- +Local Variables: +mode: sgml +sgml-minimize-attributes:nil +sgml-general-insert-case:lower +sgml-indent-step:0 +sgml-indent-data:nil +End: + +vim:tabstop=2:shiftwidth=2:expandtab +--> + diff --git a/doc/en/index.html b/doc/en/index.html new file mode 100644 index 0000000..3cbd320 --- /dev/null +++ b/doc/en/index.html @@ -0,0 +1,6 @@ +<html><head><title>The Kio-Sword Handbook</title><link rel="stylesheet" href="help:/common/kde-default.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.48"><meta name="keywords" content="KDE, kio_sword, kio-sword, Kio-Sword, kiosword, sword, SWORD, Bible, kio"><meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"><meta name="GENERATOR" content="KDE XSL Stylesheet V1.13 using libxslt"><link rel="home" href="index.html" title="The Kio-Sword Handbook"><link rel="next" href="introduction.html" title="Chapter 1. Introduction"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table border="0" cellpadding="0" cellspacing="0" width="100%"><tr class="header"><td colspan="2"> </td></tr><tr id="logo"><td valign="top"><img src="help:/common/kde_logo.png" alt="KDE - The K Desktop Environment" width="296" height="79" border="0"></td><td valign="middle" align="center" id="location"><h1>The Kio-Sword Handbook</h1></td></tr></table><table width="100%" class="header"><tbody><tr><td align="left" class="navLeft" width="33%"></td><td align="center" class="navCenter" width="34%"> </td><td align="right" class="navRight" width="33%"> + <a accesskey="n" href="introduction.html">Next</a></td></tr></tbody></table><div class="book"><div class="titlepage"><div><h1 class="title"><a name="id2369976"></a>The Kio-Sword Handbook</h1></div><div><p class="author"> Luke Plant <tt><L.Plant.98@cantab.net></tt></p></div><div>Revision <span class="releaseinfo">0.3.0 (<span class="date">2006-12-16</span>)</span></div><div><p class="copyright">Copyright © 2004-2006 Luke Plant</p></div><div><div><div class="abstract"><p> +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). +</p></div></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt>1. <a href="introduction.html">Introduction</a></dt><dt>2. <a href="using-kio_sword.html">Using Kio-Sword</a></dt><dt>3. <a href="faq.html">Questions and Answers</a></dt><dt>4. <a href="credits.html">Credits and License</a></dt><dt>A. <a href="installation.html">Installation</a></dt><dd><dl><dt><a href="installation.html#getting-kio_sword">How to obtain Kio-Sword</a></dt><dt><a href="requirements.html">Requirements</a></dt><dt><a href="compilation.html">Compilation and Installation</a></dt><dt><a href="configuration.html">Configuration</a></dt></dl></dd></dl></div></div><table width="100%" class="bottom-nav"><tr><td width="33%" align="left" valign="top" class="navLeft"></td><td width="34%" align="center" valign="top" class="navCenter"> </td><td width="33%" align="right" valign="top" class="navRight"><a href="introduction.html">Next</a></td></tr><tr><td width="33%" align="left" class="navLeft"> </td><td width="34%" align="center" class="navCenter"> </td><td width="33%" align="right" class="navRight"> Introduction</td></tr></table></body></html>
\ No newline at end of file diff --git a/doc/en/installation.html b/doc/en/installation.html new file mode 100644 index 0000000..b4d4222 --- /dev/null +++ b/doc/en/installation.html @@ -0,0 +1,2 @@ +<html><head><title>Appendix A. Installation</title><link rel="stylesheet" href="help:/common/kde-default.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.48"><meta name="keywords" content="KDE, kio_sword, kio-sword, Kio-Sword, kiosword, sword, SWORD, Bible, kio"><meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"><meta name="GENERATOR" content="KDE XSL Stylesheet V1.13 using libxslt"><link rel="home" href="index.html" title="The Kio-Sword Handbook"><link rel="up" href="index.html" title="The Kio-Sword Handbook"><link rel="previous" href="credits.html" title="Chapter 4. Credits and License"><link rel="next" href="requirements.html" title="Requirements"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table border="0" cellpadding="0" cellspacing="0" width="100%"><tr class="header"><td colspan="2"> </td></tr><tr id="logo"><td valign="top"><img src="help:/common/kde_logo.png" alt="KDE - The K Desktop Environment" width="296" height="79" border="0"></td><td valign="middle" align="center" id="location"><h1>Installation</h1></td></tr></table><table width="100%" class="header"><tbody><tr><td align="left" class="navLeft" width="33%"><a accesskey="p" href="credits.html">Prev</a></td><td align="center" class="navCenter" width="34%"> </td><td align="right" class="navRight" width="33%"> + <a accesskey="n" href="requirements.html">Next</a></td></tr></tbody></table><div class="appendix"><div class="titlepage"><div><h2 class="title"><a name="installation"></a>Appendix A. Installation</h2></div></div><div class="sect1"><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="getting-kio_sword"></a>How to obtain Kio-Sword</h2></div></div><p>Download from <a href="http://lukeplant.me.uk/kio-sword/" target="_top">The Kio-Sword home page</a> </p></div></div><table width="100%" class="bottom-nav"><tr><td width="33%" align="left" valign="top" class="navLeft"><a href="credits.html">Prev</a></td><td width="34%" align="center" valign="top" class="navCenter"><a href="index.html">Home</a></td><td width="33%" align="right" valign="top" class="navRight"><a href="requirements.html">Next</a></td></tr><tr><td width="33%" align="left" class="navLeft">Credits and License </td><td width="34%" align="center" class="navCenter"><a href="index.html">Up</a></td><td width="33%" align="right" class="navRight"> Requirements</td></tr></table></body></html>
\ No newline at end of file diff --git a/doc/en/introduction.html b/doc/en/introduction.html new file mode 100644 index 0000000..9c2bc53 --- /dev/null +++ b/doc/en/introduction.html @@ -0,0 +1,9 @@ +<html><head><title>Chapter 1. Introduction</title><link rel="stylesheet" href="help:/common/kde-default.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.48"><meta name="keywords" content="KDE, kio_sword, kio-sword, Kio-Sword, kiosword, sword, SWORD, Bible, kio"><meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"><meta name="GENERATOR" content="KDE XSL Stylesheet V1.13 using libxslt"><link rel="home" href="index.html" title="The Kio-Sword Handbook"><link rel="up" href="index.html" title="The Kio-Sword Handbook"><link rel="previous" href="index.html" title="The Kio-Sword Handbook"><link rel="next" href="using-kio_sword.html" title="Chapter 2. Using Kio-Sword"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table border="0" cellpadding="0" cellspacing="0" width="100%"><tr class="header"><td colspan="2"> </td></tr><tr id="logo"><td valign="top"><img src="help:/common/kde_logo.png" alt="KDE - The K Desktop Environment" width="296" height="79" border="0"></td><td valign="middle" align="center" id="location"><h1>Introduction</h1></td></tr></table><table width="100%" class="header"><tbody><tr><td align="left" class="navLeft" width="33%"><a accesskey="p" href="index.html">Prev</a></td><td align="center" class="navCenter" width="34%"> </td><td align="right" class="navRight" width="33%"> + <a accesskey="n" href="using-kio_sword.html">Next</a></td></tr></tbody></table><div class="chapter"><div class="titlepage"><div><h2 class="title"><a name="introduction"></a>Chapter 1. Introduction</h2></div></div><p> +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. +</p><p> Please report any problems or feature requests to the author. +</p></div><table width="100%" class="bottom-nav"><tr><td width="33%" align="left" valign="top" class="navLeft"><a href="index.html">Prev</a></td><td width="34%" align="center" valign="top" class="navCenter"><a href="index.html">Home</a></td><td width="33%" align="right" valign="top" class="navRight"><a href="using-kio_sword.html">Next</a></td></tr><tr><td width="33%" align="left" class="navLeft">The Kio-Sword Handbook </td><td width="34%" align="center" class="navCenter"><a href="index.html">Up</a></td><td width="33%" align="right" class="navRight"> Using Kio-Sword</td></tr></table></body></html>
\ No newline at end of file diff --git a/doc/en/requirements.html b/doc/en/requirements.html new file mode 100644 index 0000000..8fccc6a --- /dev/null +++ b/doc/en/requirements.html @@ -0,0 +1,4 @@ +<html><head><title>Requirements</title><link rel="stylesheet" href="help:/common/kde-default.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.48"><meta name="keywords" content="KDE, kio_sword, kio-sword, Kio-Sword, kiosword, sword, SWORD, Bible, kio"><meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"><meta name="GENERATOR" content="KDE XSL Stylesheet V1.13 using libxslt"><link rel="home" href="index.html" title="The Kio-Sword Handbook"><link rel="up" href="installation.html" title="Appendix A. Installation"><link rel="previous" href="installation.html" title="Appendix A. Installation"><link rel="next" href="compilation.html" title="Compilation and Installation"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table border="0" cellpadding="0" cellspacing="0" width="100%"><tr class="header"><td colspan="2"> </td></tr><tr id="logo"><td valign="top"><img src="help:/common/kde_logo.png" alt="KDE - The K Desktop Environment" width="296" height="79" border="0"></td><td valign="middle" align="center" id="location"><h1>Requirements</h1></td></tr></table><table width="100%" class="header"><tbody><tr><td align="left" class="navLeft" width="33%"><a accesskey="p" href="installation.html">Prev</a></td><td align="center" class="navCenter" width="34%">Installation</td><td align="right" class="navRight" width="33%"> + <a accesskey="n" href="compilation.html">Next</a></td></tr></tbody></table><div class="sect1"><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="requirements"></a>Requirements</h2></div></div><p>The following libraries are required:</p><p>SWORD 1.5.8 or greater</p><p>KDE 3 or greater</p><p> +You can find a list of changes at <a href="http://apps.kde.org/kio_sword" target="_top">http://apps.kde.org/kio_sword</a>. +</p></div><table width="100%" class="bottom-nav"><tr><td width="33%" align="left" valign="top" class="navLeft"><a href="installation.html">Prev</a></td><td width="34%" align="center" valign="top" class="navCenter"><a href="index.html">Home</a></td><td width="33%" align="right" valign="top" class="navRight"><a href="compilation.html">Next</a></td></tr><tr><td width="33%" align="left" class="navLeft">Installation </td><td width="34%" align="center" class="navCenter"><a href="installation.html">Up</a></td><td width="33%" align="right" class="navRight"> Compilation and Installation</td></tr></table></body></html>
\ No newline at end of file diff --git a/doc/en/using-kio_sword.html b/doc/en/using-kio_sword.html new file mode 100644 index 0000000..731edb0 --- /dev/null +++ b/doc/en/using-kio_sword.html @@ -0,0 +1,7 @@ +<html><head><title>Chapter 2. Using Kio-Sword</title><link rel="stylesheet" href="help:/common/kde-default.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.48"><meta name="keywords" content="KDE, kio_sword, kio-sword, Kio-Sword, kiosword, sword, SWORD, Bible, kio"><meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"><meta name="GENERATOR" content="KDE XSL Stylesheet V1.13 using libxslt"><link rel="home" href="index.html" title="The Kio-Sword Handbook"><link rel="up" href="index.html" title="The Kio-Sword Handbook"><link rel="previous" href="introduction.html" title="Chapter 1. Introduction"><link rel="next" href="faq.html" title="Chapter 3. Questions and Answers"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table border="0" cellpadding="0" cellspacing="0" width="100%"><tr class="header"><td colspan="2"> </td></tr><tr id="logo"><td valign="top"><img src="help:/common/kde_logo.png" alt="KDE - The K Desktop Environment" width="296" height="79" border="0"></td><td valign="middle" align="center" id="location"><h1>Using Kio-Sword</h1></td></tr></table><table width="100%" class="header"><tbody><tr><td align="left" class="navLeft" width="33%"><a accesskey="p" href="introduction.html">Prev</a></td><td align="center" class="navCenter" width="34%"> </td><td align="right" class="navRight" width="33%"> + <a accesskey="n" href="faq.html">Next</a></td></tr></tbody></table><div class="chapter"><div class="titlepage"><div><h2 class="title"><a name="using-kio_sword"></a>Chapter 2. Using Kio-Sword</h2></div></div><p>To start using Kio-Sword simply type <a href="sword:/" target="_top">sword:/</a> + 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: +<b><tt>sword:/[modulename]/[reference]</tt></b> +<div class="variablelist"><p><b>Examples</b></p><dl><dt><span class="term"><b><tt>sword:/KJV/Hebrews 1:3</tt></b></span></dt><dd><p>Takes you straight to Hebrews 1:3 in the King James Version</p></dd><dt><span class="term"><b><tt>sword:/StrongsGreek/01234</tt></b></span></dt><dd><p>Returns the information about the Strongs Number 01234 (Greek)</p></dd><dt><span class="term"><b><tt>sword:John 3:16</tt></b></span></dt><dd><p>Redirects to John 3:16 in your default Bible</p></dd></dl></div> +</p><p>You can specify other options in the URL. See <a href="sword:/?settings" target="_top">sword:/?settings</a>.</p></div><table width="100%" class="bottom-nav"><tr><td width="33%" align="left" valign="top" class="navLeft"><a href="introduction.html">Prev</a></td><td width="34%" align="center" valign="top" class="navCenter"><a href="index.html">Home</a></td><td width="33%" align="right" valign="top" class="navRight"><a href="faq.html">Next</a></td></tr><tr><td width="33%" align="left" class="navLeft">Introduction </td><td width="34%" align="center" class="navCenter"><a href="index.html">Up</a></td><td width="33%" align="right" class="navRight"> Questions and Answers</td></tr></table></body></html>
\ No newline at end of file |