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/index.docbook | 322 |
3 files changed, 330 insertions, 0 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am new file mode 100644 index 0000000..12b6acb --- /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 = kdmtheme +SUBDIRS = $(AUTODIRS) diff --git a/doc/en/Makefile.am b/doc/en/Makefile.am new file mode 100644 index 0000000..98b1da6 --- /dev/null +++ b/doc/en/Makefile.am @@ -0,0 +1,2 @@ +KDE_DOCS = kdmtheme +KDE_LANG = en diff --git a/doc/en/index.docbook b/doc/en/index.docbook new file mode 100644 index 0000000..4e308a2 --- /dev/null +++ b/doc/en/index.docbook @@ -0,0 +1,322 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.1.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!ENTITY kdmtheme "<application>kdmtheme 1.1.3</application>"> + <!ENTITY kappname "&kdmtheme;"><!-- Do *not* replace kappname--> + <!ENTITY package "kde-module"><!-- kdebase, kdeadmin, etc --> + <!ENTITY % addindex "IGNORE"> + <!ENTITY % English "INCLUDE"><!-- change language only here --> + + + <!-- Do not define any other entities; instead, use the entities + from kde-genent.entities and $LANG/user.entities. --> +]> +<!-- kdoctemplate v0.8 October 1 1999 + Minor update to "Credits and Licenses" section on August 24, 2000 + Removed "Revision history" section on 22 January 2001 + Changed to Installation/Help menu entities 18 October 2001 + Other minor cleanup and changes 18 October 2001 --> + + +<!-- +This template was designed by: David Rugge davidrugge@mindspring.com +with lots of help from: Eric Bischoff ebisch@cybercable.tm.fr +and Frederik Fouvry fouvry@sfs.nphil.uni-tuebingen.de +of the KDE DocBook team. + +You may freely use this template for writing any sort of KDE documentation. +If you have any changes or improvements, please let us know. + +Remember: +- in XML, the case of the <tags> and attributes is relevant ; +- also, quote all attributes. + +Please don't forget to remove all these comments in your final documentation, +thanks ;-). +--> + +<!-- ................................................................ --> + +<!-- The language must NOT be changed here. --> + +<book 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 &kdmtheme; Handbook</title> + +<authorgroup> +<author> +<firstname></firstname> +<othername></othername> +<surname>Stephen Leaf</surname> +<affiliation> +<address><email>smileaf@smileaf.org</email></address> +</affiliation> +</author> +</authorgroup> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> + +<copyright> +<year>2005</year> +<year>%{YEAR}</year> +<holder>Stephen Leaf</holder> +</copyright> +<!-- Translators: put here the copyright notice of the translation --> +<!-- Put here the FDL notice. Read the explanation in fdl-notice.docbook + and in the FDL itself on how to use it. --> +<legalnotice>&FDLNotice;</legalnotice> + +<!-- 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-08-12</date> +<releaseinfo>1.1.3</releaseinfo> + +<!-- Abstract about this handbook --> + +<abstract> +<para> +&kdmtheme; is K Control Center Module designed to easily configure your KDM themes. +</para> +</abstract> + +<!-- This is a set of Keywords for indexing by search engines. +Please at least include KDE, the KDE package it is in, the name + of your application, and a few relevant keywords. --> + +<keywordset> +<keyword>KDE</keyword> +<keyword>kdmtheme</keyword> +<keyword>KDM</keyword> +<keyword>KDM Theme Manager</keyword> +</keywordset> + +</bookinfo> + +<!-- The contents of the documentation begin here. Label +each chapter so with the id attribute. This is necessary for two reasons: it +allows you to easily reference the chapter from other chapters of your +document, and if there is no ID, the name of the generated HTML files will vary +from time to time making it hard to manage for maintainers and for the CVS +system. Any chapter labelled (OPTIONAL) may be left out at the author's +discretion. Other chapters should not be left out in order to maintain a +consistent documentation style across all KDE apps. --> + +<chapter id="introduction"> +<title>Introduction</title> + +<!-- The introduction chapter contains a brief introduction for the +application that explains what it does and where to report +problems. Basically a long version of the abstract. Don't include a +revision history. (see installation appendix comment) --> + +<para> +&kdmtheme; is a K Control Module designed to easily configure your KDM themes. Please report problems either on <ulink url="http://kde-look.org/content/show.php?content=22120">kde-look/kde-apps</ulink> or email <email>smileaf@smileaf.org</email> +</para> +</chapter> + +<chapter id="using-kdmtheme"> +<title>Using &kdmtheme;</title> + +<!-- This chapter should tell the user how to use your app. You should use as +many sections (Chapter, Sect1, Sect3, etc...) as is necessary to fully document +your application. --> + +<para> + +<!-- Note that all graphics should be in .png format. Use no gifs because of +patent issues. --> + +<screenshot> +<screeninfo>Here's a screenshot of &kdmtheme;</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="kdmtheme.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Screenshot</phrase> + </textobject> + </mediaobject> +</screenshot> +</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>How do I create themes?</para> + </question> + <answer> + <para>I don't know but if you find a FAQ or tutorial please email me. I get this question ALOT.</para> + </answer> + </qandaentry> + <qandaentry> + <question> + <para>How do I install themes?</para> + </question> + <answer> + <para>Simply click the "install new theme" button on the bottom then use the browse button to find your theme archive, or type in the path to theme archive. URLs are accepted also. Alternatively you may supply a directory name of an un-archived theme, in this case the theme is temporarily inserted into the list.</para> + </answer> + </qandaentry> + <qandaentry> + <question> + <para>My buttons are disabled!</para> + </question> + <answer> + <para>Is the "Enable KDM Themes" check box checked?</para> + </answer> + </qandaentry> + <qandaentry> + <question> + <para>I don't see any themes what's wrong?!</para> + </question> + <answer> + <para>First make sure you didn't 'insert' any themes those are not saved only themes that appear in your theme directory are used. Next check your theme directory it should be located in your $KDEDIR/share/apps/kdm/themes/</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> +&kdmtheme; +</para> +<para> +Program copyright %{YEAR} Stephen Leaf <email>smileaf@smileaf.org</email> +</para> +<para> +Contributors: +<itemizedlist> + <listitem> + <para>Laurent Montel <email>montel@kde.org</email></para> + </listitem> + <listitem> + <para>Jonathan Patrick Davies <email>jpatrick@ubuntu.com</email></para> + </listitem> + <listitem> + <para>Chitlesh</para> + </listitem> + <listitem> + <para>kucrut</para> + </listitem> + <listitem> + <para>Lorenzo La Spada <email>l.laspada@yahoo.fr</email></para> + </listitem> +</itemizedlist> +</para> + +<para> +Documentation copyright %{YEAR} Stephen Leaf <email>smileaf@smileaf.org</email> +</para> + +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> + +&underFDL; <!-- FDL: 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 FDL, + regardless of what license the application uses) --> + +&underGPL; <!-- GPL License --> + +</chapter> + +<appendix id="installation"> +<title>Installation</title> + +<sect1 id="getting-kdmtheme"> +<title>How to obtain &kdmtheme;</title> + +<para> +&kdmtheme; is in most major distributions. Should yours not have a package please visit: <ulink url="http://kde-look.org/content/show.php?content=22120">The project page</ulink> +</para> +</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> +In order to successfully use &kdmtheme;, you need &kde; >=3.4 +</para> + + +<!-- 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://www.kde-apps.org/content/show.php?content=22120">The &kdmtheme; project page</ulink>. +</para> +</sect1> + +<sect1 id="compilation"> +<title>Compilation and Installation</title> + +<!-- This entity contains the boilerplate text for standard --> +<!-- compilation instructions. If your application requires any --> +<!-- special handling, remove it, and replace with your own text. --> + +&install.compile.documentation; + +</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 +--> + |