Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

Revert "Added some very basic documentation"

This reverts commit 78dcde9.
  • Loading branch information...
commit 7a8dcee29a77bf99b7ea2df4b6564e8c45f34da6 1 parent ce57c54
Kasper Laudrup authored June 23, 2011
3  CMakeLists.txt
@@ -22,6 +22,3 @@ add_subdirectory(pics)
22 22
 
23 23
 # The icons
24 24
 add_subdirectory(icons)
25  
-
26  
-# The documentation
27  
-add_subdirectory(doc)
2  creox/creox.cpp
@@ -165,7 +165,7 @@ void Creox::initEffectsGui()
165 165
   dockDistortion->setWidget(trayDistortion);
166 166
   dockDistortion->setWindowTitle(distortion->effectName());
167 167
 
168  
-  //dockDistortion->setWindowIcon(KIcon("media-playback-start"));//, iconLoader));
  168
+  dockDistortion->setWindowIcon(KIcon("media-playback-start"));//, iconLoader));
169 169
 
170 170
   // dockDistortion->setFeatures(QDockWidget::DockWidgetClosable | QDockWidget::DockWidgetMovable |
171 171
   //                             QDockWidget::DockWidgetFloatable | QDockWidget::DockWidgetVerticalTitleBar);
2  doc/CMakeLists.txt
... ...
@@ -1 +1 @@
1  
-kde4_create_handbook(index.docbook INSTALL_DESTINATION ${HTML_INSTALL_DIR}/en SUBDIR creox)
  1
+add_subdirectory(en)
3  doc/en/CMakeLists.txt
... ...
@@ -0,0 +1,3 @@
  1
+kde4_create_handbook(index.docbook INSTALL_DESTINATION ${HTML_INSTALL_DIR}/en)
  2
+
  3
+# XXX: Install documentation
433  doc/en/index.docbook
... ...
@@ -0,0 +1,433 @@
  1
+<?xml version="1.0" ?>
  2
+<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.1-Based Variant V1.0//EN" "dtd/kdex.dtd" [
  3
+  <!ENTITY creox '<application>Creox</application>'>
  4
+  <!ENTITY kapp "&creox;"><!-- replace creox here -->
  5
+  <!ENTITY % addindex "IGNORE">
  6
+  <!ENTITY % English "INCLUDE"><!-- change language only here -->
  7
+  
  8
+  
  9
+  <!-- Do not define any other entities; instead, use the entities
  10
+       from kde-genent.entities and $LANG/user.entities. -->
  11
+]>
  12
+<!-- kdoctemplate v0.8 October 1 1999 
  13
+     Minor update to "Credits and Licenses" section on August 24, 2000
  14
+     Removed "Revision history" section on 22 January 2001   -->
  15
+
  16
+<!--
  17
+This template was designed by: David Rugge davidrugge@mindspring.com
  18
+with lots of help from: Eric Bischoff ebisch@cybercable.tm.fr
  19
+and Frederik Fouvry fouvry@sfs.nphil.uni-tuebingen.de
  20
+of the KDE DocBook team.
  21
+
  22
+You may freely use this template for writing any sort of KDE documentation.
  23
+If you have any changes or improvements, please let us know.
  24
+
  25
+In the future, we may want to change from SGML-based DocBook to XML-based
  26
+DocBook. To make this change easier, please be careful :
  27
+- in XML, the case of the <tags> and attributes is relevant ;
  28
+- also, quote all attributes.
  29
+
  30
+Please don't forget to remove all these comments in your final documentation,
  31
+thanks ;-).
  32
+-->
  33
+
  34
+<!-- ................................................................ -->
  35
+
  36
+<!-- The language must NOT be changed here. -->
  37
+
  38
+<book lang="&language;">
  39
+
  40
+<!-- This header contains all of the meta-information for the document such
  41
+as Authors, publish date, the abstract, and Keywords -->
  42
+
  43
+<bookinfo>
  44
+<title>The Creox Handbook</title>
  45
+
  46
+<authorgroup>
  47
+<author>
  48
+<firstname>George</firstname>
  49
+<othername>N.</othername>
  50
+<surname>Ugnacious</surname>
  51
+<affiliation>
  52
+<address><email>gnu@kde.org</email></address>
  53
+</affiliation>
  54
+</author>
  55
+</authorgroup>
  56
+
  57
+<!-- TRANS:ROLES_OF_TRANSLATORS -->
  58
+
  59
+<copyright>
  60
+<year>1999</year>
  61
+<year>2000</year>
  62
+<holder>George N. Ugnacious</holder>
  63
+</copyright>
  64
+<!-- Translators: put here the copyright notice of the translation -->
  65
+<!-- Put here the FDL notice.  Read the explanation in fdl-notice.docbook 
  66
+     and in the FDL itself on how to use it. -->
  67
+<legalnotice>&FDLNotice;</legalnotice>
  68
+
  69
+<!-- Date and version information of the documentation
  70
+Don't forget to include this last date and this last revision number, we
  71
+need them for translation coordination !
  72
+Please respect the format of the date (DD/MM/YYYY) and of the version
  73
+(V.MM.LL), it could be used by automation scripts.
  74
+Do NOT change these in the translation. -->
  75
+
  76
+<date>03/04/1999</date>
  77
+<releaseinfo>1.01.00</releaseinfo>
  78
+
  79
+<!-- Abstract about this handbook -->
  80
+
  81
+<abstract>
  82
+<para>
  83
+&creox; is an application specially designed to do nothing you would
  84
+ever want.
  85
+</para>
  86
+</abstract>
  87
+
  88
+<!-- This is a set of Keywords for indexing by search engines.
  89
+Please at least include KDE, the KDE package it is in, the name
  90
+ of your application, and a few relevant keywords. -->
  91
+
  92
+<keywordset>
  93
+<keyword>KDE</keyword>
  94
+<keyword>kdeutils</keyword>
  95
+<keyword>Kapp</keyword>
  96
+<keyword>nothing</keyword>
  97
+<keyword>nothing else</keyword>
  98
+</keywordset>
  99
+
  100
+</bookinfo>
  101
+
  102
+<!-- The contents of the documentation begin here.  Label
  103
+each chapter so with the id attribute. This is necessary for two reasons: it
  104
+allows you to easily reference the chapter from other chapters of your
  105
+document, and if there is no ID, the name of the generated HTML files will vary
  106
+from time to time making it hard to manage for maintainers and for the CVS
  107
+system. Any chapter labelled (OPTIONAL) may be left out at the author's
  108
+discretion. Other chapters should not be left out in order to maintain a
  109
+consistent documentation style across all KDE apps. -->
  110
+
  111
+<chapter id="introduction">
  112
+<title>Introduction</title>
  113
+
  114
+<!-- The introduction chapter contains a brief introduction for the
  115
+application that explains what it does and where to report
  116
+problems. Basically a long version of the abstract.  Don't include a
  117
+revision history. (see installation appendix comment) -->
  118
+
  119
+<para>
  120
+&kapp; is a program that lets you do absolutely nothing. Please report
  121
+any problems or feature requests to the KDE mailing lists.
  122
+</para>
  123
+</chapter>
  124
+
  125
+<chapter id="using-kapp">
  126
+<title>Using Creox</title>
  127
+
  128
+<!-- This chapter should tell the user how to use your app. You should use as
  129
+many sections (Chapter, Sect1, Sect3, etc...) as is necessary to fully document
  130
+your application. -->
  131
+
  132
+<para>
  133
+
  134
+<!-- Note that all graphics should be in .png format. Use no gifs because of
  135
+patent issues. -->
  136
+
  137
+<screenshot>
  138
+<screeninfo>Here's a screenshot of &kapp;</screeninfo>
  139
+	<mediaobject>
  140
+	  <imageobject>
  141
+	    <imagedata fileref="screenshot.png" format="PNG"/>
  142
+	  </imageobject>
  143
+	  <imageobject>
  144
+	    <imagedata fileref="screenshot.eps" format="EPS"/>
  145
+	  </imageobject>
  146
+	  <textobject>
  147
+	    <phrase>Screenshot</phrase>
  148
+	  </textobject>
  149
+	</mediaobject>
  150
+</screenshot>
  151
+</para>
  152
+
  153
+
  154
+<sect1 id="kapp-features">
  155
+<title>More Kapp features</title>
  156
+
  157
+<para>It slices! It dices! and it comes with a free toaster!</para>
  158
+<para>
  159
+The Squiggle Tool <guiicon><inlinemediaobject>
  160
+	  <imageobject>
  161
+	    <imagedata fileref="squiggle.png" format="PNG"/>
  162
+	  </imageobject>
  163
+	  <imageobject>
  164
+	    <imagedata fileref="squiggle.eps" format="EPS"/>
  165
+	  </imageobject>
  166
+	  <textobject>
  167
+	    <phrase>Squiggle</phrase>
  168
+	  </textobject>
  169
+</inlinemediaobject></guiicon> is used to draw squiggly lines all over
  170
+the &creox; main window. It's not a bug, it's a feature!
  171
+</para>
  172
+
  173
+</sect1>
  174
+</chapter>
  175
+
  176
+<chapter id="commands">
  177
+<title>Command Reference</title>
  178
+
  179
+<!-- (OPTIONAL, BUT RECOMMENDED) This chapter should list all of the
  180
+application windows and their menubar and toolbar commands for easy reference.
  181
+Also include any keys that have a special function but have no equivalent in the
  182
+menus or toolbars. This may not be necessary for small apps or apps with no tool
  183
+or menu bars. -->
  184
+
  185
+<sect1 id="kapp-mainwindow">
  186
+<title>The main Creox window</title>
  187
+<para></para>
  188
+
  189
+<sect2>
  190
+<title>The File Menu</title>
  191
+<para>
  192
+<variablelist>
  193
+<varlistentry>
  194
+<term><menuchoice>
  195
+<shortcut>
  196
+<keycombo><keycap>Ctrl</keycap><keycap>n</keycap></keycombo>
  197
+</shortcut>
  198
+<guimenu>File</guimenu>
  199
+<guimenuitem>New</guimenuitem>
  200
+</menuchoice></term>
  201
+<listitem><para><action>Creates a new document</action></para></listitem>
  202
+</varlistentry>
  203
+<varlistentry>
  204
+<term><menuchoice>
  205
+<shortcut>
  206
+<keycombo><keycap>Ctrl</keycap><keycap>s</keycap></keycombo>
  207
+</shortcut>
  208
+<guimenu>File</guimenu>
  209
+<guimenuitem>Save</guimenuitem>
  210
+</menuchoice></term>
  211
+<listitem><para><action>Saves the document</action></para></listitem>
  212
+</varlistentry>
  213
+<varlistentry>
  214
+<term><menuchoice>
  215
+<shortcut>
  216
+<keycombo><keycap>Ctrl</keycap><keycap>q</keycap></keycombo>
  217
+</shortcut>
  218
+<guimenu>File</guimenu>
  219
+<guimenuitem>Quit</guimenuitem>
  220
+</menuchoice></term>
  221
+<listitem><para><action>Quits</action> &kapp;</para></listitem>
  222
+</varlistentry>
  223
+</variablelist>
  224
+</para>
  225
+
  226
+</sect2>
  227
+
  228
+</sect1>
  229
+</chapter>
  230
+
  231
+<chapter id="developers">
  232
+<title>Developer's Guide to Creox</title>
  233
+
  234
+<!-- (OPTIONAL) A Programming/Scripting reference chapter should be
  235
+used for apps that use plugins or that provide their own scripting hooks
  236
+and/or development libraries. -->
  237
+
  238
+<para>
  239
+Programming &creox; plugins is a joy to behold. Just read through the next
  240
+66 pages of API's to learn how!
  241
+</para>
  242
+
  243
+<!-- Use refentries to describe APIs.  Refentries are fairly complicated and you
  244
+should consult the docbook reference for further details. The example below was
  245
+taken from that reference and shortened a bit for readability. -->
  246
+
  247
+</chapter>
  248
+
  249
+<chapter id="faq">
  250
+<title>Questions and Answers</title>
  251
+
  252
+<!-- (OPTIONAL but recommended) This chapter should include all of the silly
  253
+(and not-so-silly) newbie questions that fill up your mailbox. This chapter
  254
+should be reserved for BRIEF questions and answers! If one question uses more
  255
+than a page or so then it should probably be part of the
  256
+"Using this Application" chapter instead. You should use links to
  257
+cross-reference questions to the parts of your documentation that answer them.
  258
+This is also a great place to provide pointers to other FAQ's if your users
  259
+must do some complicated configuration on other programs in order for your
  260
+application work. -->
  261
+
  262
+&reporting.bugs;
  263
+&updating.documentation;
  264
+
  265
+<qandaset id="faqlist">
  266
+<qandaentry>
  267
+<question>
  268
+<para>My Mouse doesn't work. How do I quit &kapp;?</para>
  269
+</question>
  270
+<answer>
  271
+<para>You silly goose! Check out the <link linkend="commands">Commands
  272
+Section</link> for the answer.</para>
  273
+</answer>
  274
+</qandaentry>
  275
+<qandaentry>
  276
+<question>
  277
+<para>Why can't I twiddle my documents?</para>
  278
+</question>
  279
+<answer>
  280
+<para>You can only twiddle your documents if you have the foobar.lib
  281
+installed.</para>
  282
+</answer>
  283
+</qandaentry>
  284
+</qandaset>
  285
+</chapter>
  286
+
  287
+<chapter id="credits">
  288
+
  289
+<!-- Include credits for the programmers, documentation writers, and
  290
+contributors here. The license for your software should then be included below
  291
+the credits with a reference to the appropriate license file included in the KDE
  292
+distribution. -->
  293
+
  294
+<title>Credits and License</title>
  295
+
  296
+<para>
  297
+&kapp;
  298
+</para>
  299
+<para>
  300
+Program copyright 1997 John Q. Hacker <email>jqh@kde.org</email>
  301
+</para>
  302
+<para>
  303
+Contributors:
  304
+<itemizedlist>
  305
+<listitem><para>Konqui the KDE Dragon <email>konqui@kde.org</email></para>
  306
+</listitem>
  307
+<listitem><para>Tux the Linux Penguin <email>tux@linux.org</email></para>
  308
+</listitem>
  309
+</itemizedlist>
  310
+</para>
  311
+
  312
+<para>
  313
+Documentation copyright 1999 George N. Ugnacious <email>gnu@kde.org</email>
  314
+</para>
  315
+
  316
+<!-- TRANS:CREDIT_FOR_TRANSLATORS -->
  317
+
  318
+&underFDL;               <!-- FDL: do not remove. Commercial development should -->
  319
+<!-- replace this with their copyright and either remove it or re-set this.-->
  320
+
  321
+<!-- Determine which license your application is licensed under, 
  322
+     and delete all the remaining licenses below:
  323
+
  324
+     (NOTE:  All documentation are licensed under the FDL, 
  325
+     regardless of what license the application uses) -->
  326
+
  327
+&underGPL;        	 <!-- GPL License -->
  328
+&underBSDLicense;        <!-- BSD License -->
  329
+&underArtisticLicense;   <!-- BSD Artistic License -->
  330
+&underX11License;        <!-- X11 License  -->
  331
+
  332
+</chapter>
  333
+
  334
+<appendix id="installation">
  335
+<title>Installation</title>
  336
+
  337
+<sect1 id="getting-creox">
  338
+<title>How to obtain Creox</title>
  339
+
  340
+<para>
  341
+&creox; is part of the KDE project
  342
+<ulink url="http://www.kde.org">http://www.kde.org</ulink>.
  343
+&creox; can be found in the kdeutils package on
  344
+<ulink url="ftp://ftp.kde.org/pub/kde/">ftp://ftp.kde.org/pub/kde/</ulink>, the
  345
+main ftp site of the KDE project. </para>
  346
+</sect1>
  347
+
  348
+<sect1 id="requirements">
  349
+<title>Requirements</title>
  350
+
  351
+<!--
  352
+List any special requirements for your application here. This should include:
  353
+.Libraries or other software that is not included in kdesupport,
  354
+kdelibs, or kdebase.
  355
+.Hardware requirements like amount of RAM, disk space, graphics card
  356
+capabilities, screen resolution, special expansion cards, etc.
  357
+.Operating systems the app will run on. If your app is designed only for a
  358
+specific OS, (you wrote a graphical LILO configurator for example) put this
  359
+information here.
  360
+-->
  361
+
  362
+<para>
  363
+In order to successfully use &creox;, you need KDE 1.1. Foobar.lib is required
  364
+in order to support the advanced &creox; features. &creox; uses about 5 megs of
  365
+memory to run, but this may vary depending on your platform and
  366
+configuration.
  367
+</para>
  368
+
  369
+<para>
  370
+All required libraries as well as &creox; itself can be found
  371
+on <ulink url="ftp://ftp.kapp.org">The &creox; home page</ulink>.
  372
+</para>
  373
+
  374
+<!-- For a list of updates, you may refer to the application web site
  375
+or the ChangeLog file, or ... -->
  376
+<para>
  377
+You can find a list of changes at <ulink
  378
+url="http://apps.kde.org/kapp">http://apps.kde.org/kapp</ulink>.
  379
+</para>
  380
+</sect1>
  381
+
  382
+<sect1 id="compilation">
  383
+<title>Compilation and Installation</title>
  384
+
  385
+<para>
  386
+In order to compile and install KApp on your system, type the following in the base
  387
+directory of the Icon Editor distribution:
  388
+<screen width="40">
  389
+<prompt>%</prompt> <userinput>./configure</userinput>
  390
+<prompt>%</prompt> <userinput>make</userinput>
  391
+<prompt>%</prompt> <userinput>make install</userinput>
  392
+</screen>
  393
+</para>
  394
+
  395
+<para>Since KApp uses autoconf and automake you should have not trouble compiling it.
  396
+Should you run into problems please report them to the KDE mailing lists.</para>
  397
+
  398
+</sect1>
  399
+
  400
+<sect1 id="configuration">
  401
+<title>Configuration</title>
  402
+
  403
+<para>Don't forget to tell your system to start the <filename>dtd</filename>
  404
+dicer-toaster daemon first, or KApp won't work !</para>
  405
+
  406
+</sect1>
  407
+
  408
+</appendix>
  409
+
  410
+&documentation.index;
  411
+</book>
  412
+<!--
  413
+Local Variables:
  414
+mode: sgml
  415
+sgml-minimize-attributes:nil
  416
+sgml-general-insert-case:lower
  417
+sgml-indent-step:0
  418
+sgml-indent-data:nil
  419
+End:
  420
+-->
  421
+
  422
+
  423
+
  424
+
  425
+
  426
+
  427
+
  428
+
  429
+
  430
+
  431
+
  432
+
  433
+
43  doc/index.docbook
... ...
@@ -1,43 +0,0 @@
1  
-<?xml version="1.0" ?>
2  
-<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN"
3  
-"dtd/kdex.dtd" [
4  
-<!ENTITY creox "<application>Creox</application>">
5  
-<!ENTITY % addindex "IGNORE">
6  
-<!ENTITY % English "INCLUDE">
7  
-]>
8  
-<article lang="&language;">
9  
-  <title>Creox</title>
10  
-  <articleinfo>
11  
-    <authorgroup>
12  
-      <author><firstname>Kasper</firstname>
13  
-      <surname>Laudrup</surname>
14  
-      <affiliation>
15  
-        <address><email>laudrup@stacktrace.dk</email></address>
16  
-      </affiliation>
17  
-      </author>
18  
-    </authorgroup>
19  
-    <date>2011-06-23</date>
20  
-    <releaseinfo>0.3</releaseinfo>
21  
-</articleinfo>
22  
-
23  
-<para>
24  
-  Creox is a real-time sound processor. You can plug your electric guitar or any
25  
-  other musical instrument directly to the PC's sound card and start
26  
-  experimenting with various sound effects. Creox has a nice user-friendly GUI, a
27  
-  preset support, a low-latency DSP engine and each effect parameter can be
28  
-  altered "on the fly".
29  
-</para>
30  
-
31  
-<itemizedlist>
32  
-  <title>Online Resources</title>
33  
-  <listitem><para>
34  
-    <ulink url="http://kde-apps.org/content/show.php/Creox+4?content=142906">Creox on KDE-Apps.org</ulink>
35  
-  </para></listitem>
36  
-  <listitem>
37  
-    <para><ulink url="https://github.com/laudrup/Creox4/issues">Creox Issue Tracker</ulink></para>
38  
-  </listitem>
39  
-  <listitem><para>
40  
-    <ulink url="https://github.com/laudrup/Creox4">Creox Repository</ulink>
41  
-  </para></listitem>
42  
-</itemizedlist>
43  
-</article>

0 notes on commit 7a8dcee

Please sign in to comment.
Something went wrong with that request. Please try again.