[kde-doc-english] [kate/frameworks] doc/katepart: change kwrite references to katepart
T.C. Hollingsworth
tchollingsworth at gmail.com
Sun Feb 23 03:16:07 UTC 2014
Git commit f38d73205aa33f22bccfa96d411d9aaee84f487b by T.C. Hollingsworth.
Committed on 19/02/2014 at 23:16.
Pushed by hollingsworth into branch 'frameworks'.
change kwrite references to katepart
includes reworking the Credits section to reflect the new focus of
the documentation while still detailing its venerable ancestry
M +9 -6 doc/katepart/fundamentals.docbook
M +29 -25 doc/katepart/index.docbook
M +2 -2 doc/katepart/menus.docbook
http://commits.kde.org/kate/f38d73205aa33f22bccfa96d411d9aaee84f487b
diff --git a/doc/katepart/fundamentals.docbook b/doc/katepart/fundamentals.docbook
index 949f222..b4a4d5c 100644
--- a/doc/katepart/fundamentals.docbook
+++ b/doc/katepart/fundamentals.docbook
@@ -2,17 +2,17 @@
<title>Some Fundamentals</title>
<para>
-&kwrite; is very simple to use. Anyone that has used a text editor
-should have no problems.
+&kwrite; and many other &katepart; users are very simple to use. Anyone that has
+used a text editor should have no problems.
</para>
<sect1 id="drag-and-drop">
<title>Drag and Drop</title>
<para>
-&kwrite; uses the &kde; Drag and Drop protocol. Files may be dragged and
-dropped onto &kwrite; from the Desktop, the filemanager &dolphin;, or some remote &FTP;
-site opened in one of &dolphin;'s windows.
+&katepart; uses the &kde; Drag and Drop protocol. Files may be dragged and
+dropped onto &katepart; from the Desktop, the filemanager &dolphin;, or some
+remote &FTP; site opened in one of &dolphin;'s windows.
</para>
</sect1>
@@ -26,6 +26,9 @@ terminal window. There are a few useful options that are available when
doing this.
</para>
+<para>Many other applications that use &katepart; offer similar command line
+options.</para>
+
<sect2 id="specify-a-file">
<title>Specify a File</title>
@@ -146,7 +149,7 @@ Shift+Home
<title>Shortcuts</title>
<para>Many of the shortcuts are configurable by way of the <link
- linkend="settings">Settings</link> menu. By default &kwrite; honors the
+ linkend="settings">Settings</link> menu. By default &katepart; honors the
following shortcuts:</para>
<informaltable>
<tgroup cols="2">
diff --git a/doc/katepart/index.docbook b/doc/katepart/index.docbook
index f17d8ec..a7994a2 100644
--- a/doc/katepart/index.docbook
+++ b/doc/katepart/index.docbook
@@ -1,7 +1,7 @@
<?xml version="1.0" ?>
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN"
"dtd/kdex.dtd" [
- <!ENTITY kappname "&kwrite;">
+ <!ENTITY kappname "&katepart;">
<!ENTITY package "kdebase">
<!ENTITY imgpath "../kate/">
<!ENTITY rcfile "kwriterc">
@@ -15,10 +15,10 @@
<!ENTITY % English "INCLUDE" > <!-- change language only here -->
]>
-<book id="kwrite" lang="&language;">
+<book id="katepart" lang="&language;">
<bookinfo>
-<title>The &kwrite; Handbook</title>
+<title>The &katepart; Handbook</title>
<authorgroup>
<author>&Thad.McGinnis; &Thad.McGinnis.mail;</author>
<author>&Anne-Marie.Mahfouf; &Anne-Marie.Mahfouf.mail;</author>
@@ -57,11 +57,13 @@
<releaseinfo>4.12 (&kde; 4.12)</releaseinfo>
<abstract>
-<para>&kwrite; is a text editor for &kde; allowing you to edit one file at the time per window.</para>
+<para>&katepart; is a fully featured editor component for &Qt; and &kde;
+applications.</para>
</abstract>
<keywordset>
<keyword>KDE</keyword>
+<keyword>KatePart</keyword>
<keyword>KWrite</keyword>
<keyword>text</keyword>
<keyword>editor</keyword>
@@ -73,17 +75,19 @@
<title>Introduction</title>
<para>
-&kwrite; is more than a text editor for the &kde; Desktop. It is meant
-to be a programmer's editor, and could be considered as at least a
-partial alternative to more powerful editors. It may be best used in
-conjunction with &konqueror; or &dolphin; for source file browsing for different
-languages. &kwrite; also works very well as a simple text editor. One
-of &kwrite;'s main features is the colorized syntax, customized for many
-different programming languages such as: C/C++, &Java;, Python, Perl,
+&katepart; is a fully featured text editor component used by many &Qt; and &kde;
+applications.
+&katepart; is more than a text editor; it is meant to be a programmer's editor,
+and could be considered as at least a partial alternative to more powerful
+editors. One of &katepart;'s main features is the colorized syntax, customized
+for many different programming languages such as: C/C++, &Java;, Python, Perl,
Bash, Modula 2, &HTML;, and Ada.
</para>
-<para>&kwrite; has a single document interface (<acronym>SDI</acronym>)
-allowing you to edit one file at the time per window.
+<para>&kwrite; is a simple text editor application based on &katepart;. It has
+a single document interface (<acronym>SDI</acronym>) allowing you to edit one
+file at the time per window. Since &kwrite; is a very simple implementation of
+&katepart;, it does not require its own documentation. If you know how to use
+&kwrite;, you can use &katepart; anywhere!
</para>
</chapter>
@@ -98,7 +102,7 @@ allowing you to edit one file at the time per window.
<chapter id="credits">
<title>Credits and License</title>
-<para>&kwrite; Copyright 2001 by the &kate; team.</para>
+<para>&katepart; and &kwrite; Copyright 2001-2014 by the &kate; team.</para>
<para>
Based on the original &kwrite;, which was Copyright 2000 by Jochen Wilhelmy
@@ -162,22 +166,22 @@ Based on the original &kwrite;, which was Copyright 2000 by Jochen Wilhelmy
</itemizedlist>
<para>
-Original documentation by &Thad.McGinnis; &Thad.McGinnis.mail;
+The &katepart; documentation is based on the original &kwrite; documentation,
+modified to be relevant to all &katepart; consumers.
</para>
<para>
-Updated by &Anne-Marie.Mahfouf; &Anne-Marie.Mahfouf.mail; and
-&Anders.Lund; &Anders.Lund.mail;
+The original &kwrite; documentation was written by &Thad.McGinnis;
+&Thad.McGinnis.mail;, with lots of modificaions from
+&Cristian.Tibirna; &Cristian.Tibirna.mail;. Converted to docbook/proofreading by
+&Lauri.Watts; &Lauri.Watts.mail; and updated by &Anne-Marie.Mahfouf;
+&Anne-Marie.Mahfouf.mail; and &Anders.Lund; &Anders.Lund.mail;
</para>
-<para>
-This version of the &kwrite; Handbook is based on the original by
-&Cristian.Tibirna; &Cristian.Tibirna.mail;
-</para>
-
-<para>
-Converted to docbook/proofreading by &Lauri.Watts; &Lauri.Watts.mail;
-</para>
+<para>The current &katepart; documentation is maintained by &TC.Hollingsworth;
+&TC.Hollingsworth.mail;. Please send comments or suggestions to the &katepart;
+development mailing list at <email>kwrite-devel at kde.org</email> or file a bug
+in the <ulink url="https://bugs.kde.org/">KDE Bugtracking System</ulink>.</para>
<!-- TRANS:CREDIT_FOR_TRANSLATORS -->
diff --git a/doc/katepart/menus.docbook b/doc/katepart/menus.docbook
index eff97ee..01c6511 100644
--- a/doc/katepart/menus.docbook
+++ b/doc/katepart/menus.docbook
@@ -898,10 +898,10 @@ the endianness (byte order) of a text file or stream, for more information see
<listitem>
<para>This submenu contains a list of all scripted actions. The list can easily be
modified by <ulink url="help:/kate/dev-scripting.html#dev-scripting-command-line">writing
-own scripts</ulink>. This way, &kwrite; can be extended with user-defined tools.
+own scripts</ulink>. This way, &katepart; can be extended with user-defined tools.
</para>
-<para>For more information about the scripts included with &kate;, see
+<para>For more information about the scripts included with &katepart;, see
<ulink url="help:/kate/scripts.html">Scripts</ulink>.</para>
</listitem>
</varlistentry>
More information about the kde-doc-english
mailing list