Add a stub handbook
This commit is contained in:
parent
f9db041a4b
commit
4e5406d48a
1 changed files with 350 additions and 0 deletions
350
doc/index.docbook
Normal file
350
doc/index.docbook
Normal file
|
|
@ -0,0 +1,350 @@
|
|||
<?xml version="1.0" ?>
|
||||
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [
|
||||
<!-- Define an entity for your application if it is not part of KDE
|
||||
Git -->
|
||||
<!ENTITY kmyapplication "<application>Danbooru Client</application>">
|
||||
<!ENTITY kappname "&kmyapplication;"><!-- replace kmyapplication here
|
||||
do *not* replace kappname-->
|
||||
<!ENTITY package "kde-module"><!-- kdebase, kdeadmin, etc. Leave
|
||||
this unchanged if your
|
||||
application is not maintained in KDE source archiv -->
|
||||
<!ENTITY % addindex "IGNORE">
|
||||
<!ENTITY % English "INCLUDE"> <!-- ONLY If you are writing non-English
|
||||
original documentation, change
|
||||
the language here -->
|
||||
|
||||
<!-- Do not define any other entities; instead, use the entities
|
||||
from entities/general.entities and en/user.entities. -->
|
||||
]>
|
||||
|
||||
<!-- ................................................................ -->
|
||||
|
||||
<!-- The language must NOT be changed here. -->
|
||||
<!-- If you are writing original documentation in a language other -->
|
||||
<!-- than English, change the language above ONLY, not here -->
|
||||
<!-- Change the value of id to the name of your application -->
|
||||
<book id="kmyapplication" 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 &kmyapplication; Handbook</title>
|
||||
|
||||
<authorgroup>
|
||||
<author>
|
||||
<personname>
|
||||
<firstname>Luca</firstname>
|
||||
<othername>N.</othername>
|
||||
<surname>Beltrame</surname>
|
||||
</personname>
|
||||
<email>lbeltrame@kde.org</email>
|
||||
</author>
|
||||
<!-- TRANS:ROLES_OF_TRANSLATORS -->
|
||||
</authorgroup>
|
||||
|
||||
<copyright>
|
||||
<year>2014</year>
|
||||
<holder>Luca Beltrames</holder>
|
||||
</copyright>
|
||||
<legalnotice>&FDLNotice;</legalnotice>
|
||||
|
||||
<!-- Date of the documentation
|
||||
Don't forget to include this last date.
|
||||
Please respect the format of the date (YYYY-MM-DD),it is used by scripts.
|
||||
-->
|
||||
<date>2014-04-03</date>
|
||||
|
||||
<!--version information of the application and kde this documentation is valid for.
|
||||
for example 'xx.yy.zz'
|
||||
-->
|
||||
<releaseinfo>0.02</releaseinfo>
|
||||
|
||||
<!-- Abstract about this handbook -->
|
||||
|
||||
<abstract>
|
||||
<para>
|
||||
&kmyapplication; is an application meant to access Danbooru-style image boards. It is meant to allow fast and easy retrieval of images. Additionally it offers multiple boards support and tag searching and tag-based (or rating-based) post filtering.
|
||||
</para>
|
||||
</abstract>
|
||||
|
||||
<!-- This is a set of Keywords for indexing by search engines.
|
||||
Please at least include KDE, the KDE section it is in, the name
|
||||
of your application, and a few relevant keywords. -->
|
||||
|
||||
<keywordset>
|
||||
<keyword>KDE</keyword>
|
||||
<keyword>Danbooru</keyword>
|
||||
<keyword>Danbooru Client</keyword>
|
||||
<keyword>Internet</keyword>
|
||||
</keywordset>
|
||||
|
||||
</bookinfo>
|
||||
|
||||
<chapter id="introduction">
|
||||
<title>Introduction</title>
|
||||
|
||||
<para>
|
||||
&kmyapplication; is an application meant to access Danbooru-style image boards. TODO: write more.
|
||||
</para>
|
||||
</chapter>
|
||||
|
||||
<chapter id="using-kapp">
|
||||
<title>Using &kmyapplication;</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 &kmyapplication;</screeninfo>
|
||||
<mediaobject>
|
||||
<imageobject>
|
||||
<imagedata fileref="screenshot.png" format="PNG"/>
|
||||
</imageobject>
|
||||
<textobject>
|
||||
<phrase>Screenshot</phrase>
|
||||
</textobject>
|
||||
</mediaobject>
|
||||
</screenshot>-->
|
||||
</para>
|
||||
|
||||
|
||||
<sect1 id="kapp-features">
|
||||
<title>Additional features</title>
|
||||
|
||||
<para><!--It slices! It dices! and it comes with a free toaster!</para>
|
||||
<para>
|
||||
The Squiggle Tool <guiicon><inlinemediaobject>
|
||||
<imageobject>
|
||||
<imagedata fileref="squiggle.png" format="PNG"/>
|
||||
</imageobject>
|
||||
<textobject>
|
||||
<phrase>Squiggle</phrase>
|
||||
</textobject>
|
||||
</inlinemediaobject></guiicon> is used to draw squiggly lines all over
|
||||
the &kmyapplication; main window. It's not a bug, it's a feature!-->
|
||||
</para>
|
||||
|
||||
</sect1>
|
||||
</chapter>
|
||||
|
||||
<chapter id="commands">
|
||||
<title>Command Reference</title>
|
||||
|
||||
<sect1 id="kapp-mainwindow">
|
||||
<title>The main &kmyapplication; window</title>
|
||||
|
||||
<sect2>
|
||||
<title>The File Menu</title>
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry id="file-new">
|
||||
<!-- Tip: With id's here, then you can use them like
|
||||
"select <xref linkend="file-new"/> to open the file dialog"
|
||||
which will be expanded to:
|
||||
"select File->New (Ctrl+N) to open the file dialog"
|
||||
-->
|
||||
<term><menuchoice>
|
||||
<shortcut>
|
||||
<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo>
|
||||
</shortcut>
|
||||
<guimenu>File</guimenu>
|
||||
<guimenuitem>New</guimenuitem>
|
||||
</menuchoice></term>
|
||||
<listitem><para><action>Creates a new document</action></para></listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><menuchoice>
|
||||
<shortcut>
|
||||
<keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo>
|
||||
</shortcut>
|
||||
<guimenu>File</guimenu>
|
||||
<guimenuitem>Save</guimenuitem>
|
||||
</menuchoice></term>
|
||||
<listitem><para><action>Saves the document</action></para></listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><menuchoice>
|
||||
<shortcut>
|
||||
<keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo>
|
||||
</shortcut>
|
||||
<guimenu>File</guimenu>
|
||||
<guimenuitem>Quit</guimenuitem>
|
||||
</menuchoice></term>
|
||||
<listitem><para><action>Quits</action> &kmyapplication;</para></listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
|
||||
</sect2>
|
||||
|
||||
<sect2>
|
||||
<title>The Help Menu</title>
|
||||
|
||||
<!-- Assuming you have a standard help menu (help, what's this, about -->
|
||||
<!-- &kmyapplication;, about KDE) then the documentation is already written. -->
|
||||
<!-- The following entity is valid anywhere that a variablelist is -->
|
||||
<!-- valid. -->
|
||||
|
||||
&help.menu.documentation;
|
||||
|
||||
</sect2>
|
||||
|
||||
</sect1>
|
||||
</chapter>
|
||||
|
||||
<chapter id="faq">
|
||||
<title>Questions and Answers</title>
|
||||
|
||||
|
||||
&reporting.bugs;
|
||||
&updating.documentation;
|
||||
|
||||
<!--<qandaset id="faqlist">
|
||||
<qandaentry>
|
||||
<question>
|
||||
<para>My Mouse doesn't work. How do I quit &kmyapplication;?</para>
|
||||
</question>
|
||||
<answer>
|
||||
<para>You silly goose! Check out the <link linkend="commands">Commands
|
||||
Section</link> for the answer.</para>
|
||||
</answer>
|
||||
</qandaentry>
|
||||
<qandaentry>
|
||||
<question>
|
||||
<para>Why can I not twiddle my documents?</para>
|
||||
</question>
|
||||
<answer>
|
||||
<para>You can only twiddle your documents if you have the foobar.lib
|
||||
installed.</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>
|
||||
&kmyapplication;
|
||||
</para>
|
||||
<para>
|
||||
Program copyright 2015 Luca Beltrame <email>lbeltrame@kde.org</email>
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Documentation Copyright © 2015 Luca Beltrame <email>lbeltrame@kde.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 -->
|
||||
&underBSDLicense; <!-- BSD License -->
|
||||
&underArtisticLicense; <!-- BSD Artistic License -->
|
||||
&underX11License; <!-- X11 License -->
|
||||
|
||||
</chapter>
|
||||
|
||||
<appendix id="installation">
|
||||
<title>Installation</title>
|
||||
|
||||
<sect1 id="getting-kapp">
|
||||
<title>How to obtain &kmyapplication;</title>
|
||||
|
||||
<!-- This first entity contains boiler plate for applications that are
|
||||
part of KDE archive. 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 or kf5
|
||||
.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 &kmyapplication;, you need few libraries from
|
||||
&kf5; 5.1 (bar, baz). Foobar.lib is
|
||||
required in order to support the advanced &kmyapplication; features. &kmyapplication; uses
|
||||
about 5 megs of memory to run, but this may vary depending on your
|
||||
platform and configuration.-->
|
||||
</para>
|
||||
|
||||
<para>
|
||||
<!--All required libraries as well as &kmyapplication; itself can be found
|
||||
on <ulink url="ftp://ftp.kapp.org">The &kmyapplication; home page</ulink>.-->
|
||||
</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://apps.kde.org/kapp">http://apps.kde.org/kapp</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>
|
||||
|
||||
<sect1 id="configuration">
|
||||
<title>Configuration</title>
|
||||
|
||||
<para>TODO</para>
|
||||
|
||||
</sect1>
|
||||
|
||||
</appendix>
|
||||
|
||||
&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;
|
||||
-->
|
||||
Loading…
Add table
Add a link
Reference in a new issue