[kxstitch] doc: cleanup kxstitch docbooks
Burkhard Lück
lueck at hube-lueck.de
Thu Dec 1 22:31:47 UTC 2016
Git commit fabea65fa11526da926fb2a66e506f3bb7ce94ce by Burkhard Lück.
Committed on 01/12/2016 at 22:31.
Pushed by lueck into branch 'master'.
cleanup kxstitch docbooks
replace kapp with entity kxstitch
remove empty faq docbook
fix date + releaseinfo
REVIEW:129595
M +7 -7 doc/commands.docbook
M +1 -1 doc/credits.docbook
M +1 -1 doc/dialogs.docbook
D +0 -4 doc/faq.docbook
M +4 -7 doc/index.docbook
M +4 -4 doc/install.docbook
M +2 -2 doc/introduction.docbook
M +3 -3 doc/patterns.docbook
M +2 -2 doc/printing.docbook
M +3 -3 doc/ui.docbook
https://commits.kde.org/kxstitch/fabea65fa11526da926fb2a66e506f3bb7ce94ce
diff --git a/doc/commands.docbook b/doc/commands.docbook
index 78de86c..0e385a6 100644
--- a/doc/commands.docbook
+++ b/doc/commands.docbook
@@ -2,7 +2,7 @@
<title>Command Reference</title>
<sect1 id="kxstitch-menus" >
- <title>&kapp; Menus</title>
+ <title>&kxstitch; Menus</title>
<sect2>
<title>The File Menu</title>
<para>
@@ -61,7 +61,7 @@
</varlistentry>
<varlistentry>
<term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo></shortcut><guimenuitem>Quit</guimenuitem></menuchoice></term>
- <listitem><simpara><action>Quits</action> &kapp;</simpara></listitem>
+ <listitem><simpara><action>Quits</action> &kxstitch;</simpara></listitem>
</varlistentry>
</variablelist>
</para>
@@ -139,7 +139,7 @@
to limit the selection.
</para>
<para>
- The paste operation in &kapp; allows you to press and hold the &LMB; down roughly in the position that
+ The paste operation in &kxstitch; allows you to press and hold the &LMB; down roughly in the position that
the paste data is to go which will provide an image of the paste data to allow accurate positioning before
releasing the mouse button to finalize the position. This technique is also used for the mirroring and
rotate functions. The cursor keys can also be used to move the pasted pattern around and the &Enter; key
@@ -446,7 +446,7 @@
<sect2>
<title>The Settings Menu</title>
<para>Apart from the common &kde; Settings menu entries described in the <ulink url="help:/fundamentals/ui.html#menus-settings">
- Settings Menu</ulink> chapter of the &kde; Fundamentals &kapp; has these application specific menu entries:
+ Settings Menu</ulink> chapter of the &kde; Fundamentals &kxstitch; has these application specific menu entries:
</para>
<para>
<variablelist>
@@ -491,8 +491,8 @@
<listitem><simpara><action>Show or hide all the background images</action></simpara></listitem>
</varlistentry>
<varlistentry>
- <term><menuchoice><guimenuitem>Configure &kapp;</guimenuitem></menuchoice></term>
- <listitem><simpara><action>Open &kapp; <link linkend="ConfigurationDialog">configuration dialog</link>.</action></simpara></listitem>
+ <term><menuchoice><guimenuitem>Configure &kxstitch;</guimenuitem></menuchoice></term>
+ <listitem><simpara><action>Open &kxstitch; <link linkend="ConfigurationDialog">configuration dialog</link>.</action></simpara></listitem>
</varlistentry>
</variablelist>
</para>
@@ -502,7 +502,7 @@
<sect2>
<title>The Help Menu</title>
<para>
- Additionally &kapp; has the common &kde; Help
+ Additionally &kxstitch; has the common &kde; Help
menu items, for more information read the section about the <ulink url="help:/fundamentals/ui.html#menus-help">Help Menu</ulink>
of the &kde; Fundamentals.
</para>
diff --git a/doc/credits.docbook b/doc/credits.docbook
index bb6f1ef..3d1f707 100644
--- a/doc/credits.docbook
+++ b/doc/credits.docbook
@@ -1,6 +1,6 @@
<chapter id="credits" >
<title>Credits and License</title>
- <para>&kapp;</para>
+ <para>&kxstitch;</para>
<para>Program copyright 2002-2015 Stephen P. Allewell <email>steve.allewell at gmail.com</email></para>
<para>
Contributors:
diff --git a/doc/dialogs.docbook b/doc/dialogs.docbook
index b2867e9..b2c9951 100644
--- a/doc/dialogs.docbook
+++ b/doc/dialogs.docbook
@@ -207,7 +207,7 @@
</para>
<para>
The text dialog allows you to select a font and size, then enter the text. Clicking <guibutton>OK</guibutton> closes the
- dialog and returns you to the &kapp; window. Positioning the text is the same as pasting any other
+ dialog and returns you to the &kxstitch; window. Positioning the text is the same as pasting any other
element. Press the &LMB; on the canvas roughly where you want the text, this will show a preview of
the text, position the text exactly where you want it, then release the &LMB;.
</para>
diff --git a/doc/faq.docbook b/doc/faq.docbook
deleted file mode 100644
index 1b27456..0000000
--- a/doc/faq.docbook
+++ /dev/null
@@ -1,4 +0,0 @@
-<chapter id="faq" >
- <title>Questions and Answers</title>
- &reporting.bugs;&updating.documentation;
-</chapter>
diff --git a/doc/index.docbook b/doc/index.docbook
index 8a09edf..76add93 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -1,7 +1,6 @@
<?xml version = '1.0'?>
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [
<!ENTITY kxstitch '<application>KXStitch</application>'>
- <!ENTITY kapp "&kxstitch;">
<!ENTITY % addindex "IGNORE">
<!ENTITY % English "INCLUDE">
<!ENTITY introduction SYSTEM "introduction.docbook">
@@ -11,14 +10,13 @@
<!ENTITY patterns SYSTEM "patterns.docbook">
<!ENTITY printing SYSTEM "printing.docbook">
<!ENTITY dialogs SYSTEM "dialogs.docbook">
- <!ENTITY faq SYSTEM "faq.docbook">
<!ENTITY credits SYSTEM "credits.docbook">
<!ENTITY install SYSTEM "install.docbook">
]>
<book lang="&language;">
<bookinfo>
- <title>The &kapp; Handbook</title>
+ <title>The &kxstitch; Handbook</title>
<authorgroup>
<author>
<firstname>Stephen</firstname>
@@ -33,11 +31,11 @@
<holder>Stephen P. Allewell</holder>
</copyright>
<legalnotice>&FDLNotice;</legalnotice>
- <date>15/7/2015</date>
- <releaseinfo>V.1.99.0</releaseinfo>
+ <date>2016-12-01</date>
+ <releaseinfo>KXStitch 2.0.0</releaseinfo>
<abstract>
<para>
- &kapp; is an application designed to allow people to create cross stitch patterns and print them.
+ &kxstitch; is an application designed to allow people to create cross stitch patterns and print them.
These patterns can be either created from scratch on a user defined size of grid, or an image can be
imported from various graphic files.
</para>
@@ -58,7 +56,6 @@
&patterns;
&printing;
&dialogs;
- &faq;
&credits;
&install;
diff --git a/doc/install.docbook b/doc/install.docbook
index 35d68bc..48286bd 100644
--- a/doc/install.docbook
+++ b/doc/install.docbook
@@ -2,17 +2,17 @@
<title>Installation</title>
<sect1 id="getting-kxstitch" >
- <title>How to obtain &kapp;</title>
+ <title>How to obtain &kxstitch;</title>
<para>
- The &kapp; source can be found at <ulink url="http://download.kde.org/stable/kxstitch/" >http://download.kde.org/stable/kxstitch/</ulink>.
- The &kapp; homepage can be found at <ulink url="http://userbase.kde.org/KXStitch" >http://userbase.kde.org/KXStitch</ulink>
+ The &kxstitch; source can be found at <ulink url="http://download.kde.org/stable/kxstitch/" >http://download.kde.org/stable/kxstitch/</ulink>.
+ The &kxstitch; homepage can be found at <ulink url="http://userbase.kde.org/KXStitch" >http://userbase.kde.org/KXStitch</ulink>
</para>
</sect1>
<sect1 id="requirements" >
<title>Requirements</title>
<para>
- &kapp; has been written for &kde; 5.x with &Qt; 5.x.
+ &kxstitch; has been written with &Qt; 5.x and &kf5-full;.
</para>
<para>
For the image import functions the ImageMagick libraries are required, this includes the development headers ImageMagick and Magick++,
diff --git a/doc/introduction.docbook b/doc/introduction.docbook
index 296e713..2f42063 100644
--- a/doc/introduction.docbook
+++ b/doc/introduction.docbook
@@ -1,7 +1,7 @@
<chapter id="introduction" >
<title>Introduction</title>
<para>
- &kapp; is a program that lets you create cross stitch patterns and charts.
+ &kxstitch; is a program that lets you create cross stitch patterns and charts.
Patterns can be created from scratch on a user defined size of grid, which can be
enlarged or reduced in size as your pattern progresses. Alternatively you can
import images from many graphics formats. When importing images you can restrict
@@ -25,6 +25,6 @@
</para>
<para>
Please report any bugs or feature requests to the <ulink url="http://bugs.kde.org">KDE Bugtracking System</ulink>
- or the <ulink url="http://mail.kde.org/mailman/listinfo/kxstitch">&kapp; mailing list</ulink>
+ or the <ulink url="http://mail.kde.org/mailman/listinfo/kxstitch">&kxstitch; mailing list</ulink>
</para>
</chapter>
diff --git a/doc/patterns.docbook b/doc/patterns.docbook
index dd1c3d3..e5618b1 100644
--- a/doc/patterns.docbook
+++ b/doc/patterns.docbook
@@ -2,9 +2,9 @@
<title>Creating patterns</title>
<sect1 id="starting-kxstitch">
- <title>Starting &kapp;</title>
+ <title>Starting &kxstitch;</title>
<para>
- When starting &kapp; you will be presented with a blank canvas of the default
+ When starting &kxstitch; you will be presented with a blank canvas of the default
size. This is also the case when selecting <menuchoice><guimenu>File</guimenu><guimenuitem>New</guimenuitem></menuchoice>.
The default sizes can be set in the pattern properties dialog by enabling the set as default checkbox.
</para>
@@ -23,7 +23,7 @@
<sect1 id="importing-images">
<title>Importing Images</title>
<para>
- &kapp; allows you to import an image. A dialog will be displayed that previews the
+ &kxstitch; allows you to import an image. A dialog will be displayed that previews the
image based on the default import options.
</para>
<para>
diff --git a/doc/printing.docbook b/doc/printing.docbook
index 5c80357..8980b52 100644
--- a/doc/printing.docbook
+++ b/doc/printing.docbook
@@ -2,11 +2,11 @@
<title>Printing patterns</title>
<para>
- Once you have completed your design, you will no doubt want to print it. &kapp; allows
+ Once you have completed your design, you will no doubt want to print it. &kxstitch; allows
you to customize the printing, from what is printed to how big the final print is.
</para>
<para>
- This version of &kapp; allows a fully customized printing layout. The new printer configuration
+ This version of &kxstitch; allows a fully customized printing layout. The new printer configuration
allows pages to be added, inserted or removed. The paper size and orientation can be selected and
each page can contain text elements, pattern elements or key elements.
</para>
diff --git a/doc/ui.docbook b/doc/ui.docbook
index f7495b1..1cf3348 100644
--- a/doc/ui.docbook
+++ b/doc/ui.docbook
@@ -2,15 +2,15 @@
<title>The User Interface</title>
<sect1 id="face-screenshot">
- <title>The &kapp; Main Window</title>
+ <title>The &kxstitch; Main Window</title>
<para>
<screenshot>
- <screeninfo>Here's a screen shot of &kapp;</screeninfo>
+ <screeninfo>Here's a screen shot of &kxstitch;</screeninfo>
<mediaobject><imageobject><imagedata fileref="user-interface.png" format="PNG" /></imageobject></mediaobject>
</screenshot>
</para>
<para>
- The &kapp; main window consists of an editor window shown on the right in the image above
+ The &kxstitch; main window consists of an editor window shown on the right in the image above
with three dock windows. The dock windows provide a preview of the pattern, the palette of
flosses and a history list. If an image is imported, an additional dock window showing a
preview of the original image for reference will be shown. Each of these dock windows can
More information about the kde-doc-english
mailing list