[kde-doc-english] [cantor] doc: Update Cantor handbook to 16.04
Burkhard Lück
lueck at hube-lueck.de
Mon May 9 18:04:32 UTC 2016
Git commit a3384f1417ad48211732b2f88f8484d4abaf8614 by Burkhard Lück.
Committed on 09/05/2016 at 18:04.
Pushed by lueck into branch 'master'.
Update Cantor handbook to 16.04
remove entity kappname + package kdeedu
bump date + releaseinfo
add python 3
replace Setting + Help menu with link to fundamentals
remove chapter developers
remove appendix
REVIEW:127872
M +21 -113 doc/index.docbook
http://commits.kde.org/cantor/a3384f1417ad48211732b2f88f8484d4abaf8614
diff --git a/doc/index.docbook b/doc/index.docbook
index 2f25fad..ce6273f 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -1,8 +1,6 @@
<?xml version="1.0" ?>
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [
- <!ENTITY kappname "&cantor;">
- <!ENTITY package "kdeedu">
<!ENTITY latex "L<superscript>A</superscript>T<subscript>E</subscript>X">
<!ENTITY % addindex "IGNORE">
<!ENTITY % English "INCLUDE">
@@ -29,8 +27,8 @@
</copyright>
<legalnotice>&FDLNotice;</legalnotice>
-<date>2014-05-09</date>
-<releaseinfo>0.5 (&kde; 4.14)</releaseinfo>
+<date>2016-04-26</date>
+<releaseinfo>Applications 16.04</releaseinfo>
<abstract>
<para>
@@ -174,7 +172,7 @@ Screenshot:
</listitem>
</varlistentry>
<varlistentry>
- <term>Python2:</term>
+ <term>Python2 and Python3:</term>
<listitem>
<para>
Python is a remarkably powerful dynamic programming language that is used
@@ -189,12 +187,7 @@ to scientific programming.
This backend adds an additional item to the &cantor;'s main menu, <guimenu>Package</guimenu>. The only item of this menu is <menuchoice><guimenu>Package</guimenu><guimenuitem>Import Package</guimenuitem></menuchoice>. This item can be used to import Python packages to the worksheet.
</para>
</note>
- <warning>
- <para>
- This backend supports Python 2 only.
- </para>
- </warning>
- </listitem>
+ </listitem>
</varlistentry>
<varlistentry>
<term>Scilab:</term>
@@ -263,7 +256,7 @@ to scientific programming.
<orderedlist>
<listitem><para>The tab bar, where you can switch through the open worksheets.</para></listitem>
<listitem><para>A help panel, where help for a specific command is displayed if you enter "? command".</para></listitem>
- <listitem><para>A Variable Manager panel where you can see the list of all available variables on the current worksheet. The Help and Variable Manager panels are shown as tabs on a sidebar of a &cantor; window. Variable manager can be used for Maxima (if enabled on <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure &cantor;...</guimenuitem></menuchoice> <guilabel>Maxima</guilabel> page), &kalgebra;, Octave, Python2, Qalculate, and Scilab backends only.</para></listitem>
+ <listitem><para>A Variable Manager panel where you can see the list of all available variables on the current worksheet. The Help and Variable Manager panels are shown as tabs on a sidebar of a &cantor; window. Variable manager can be used for Maxima (if enabled on <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure &cantor;...</guimenuitem></menuchoice> <guilabel>Maxima</guilabel> page), &kalgebra;, Octave, Python2, Python3, Qalculate, and Scilab backends only.</para></listitem>
<listitem><para>The worksheet itself.</para></listitem>
</orderedlist>
</para>
@@ -532,9 +525,9 @@ TODO add screenshots and descriptions of each assistant
<varlistentry>
<term><menuchoice>
<guimenu>Worksheet</guimenu>
-<guimenuitem>Insert Image</guimenuitem>
+<guimenuitem>Insert Latex Entry</guimenuitem>
</menuchoice></term>
-<listitem><para><action>Inserts the image template below the current cursor position.</action> You will need to click with &RMB; at the template to configure the image details.</para></listitem>
+<listitem><para><action>Inserts a latex entry below the current cursor position.</action>.</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
@@ -557,60 +550,31 @@ TODO add screenshots and descriptions of each assistant
</para>
</sect2>
-<sect2 id="settings-menu">
-<title>The Settings Menu</title>
+<!--FIXME
+Additional menus depending on backend?
+Linear Algebra Create Matrix Compute Eigenvalues Compute Eigenvectors Invert Matrix
+Calculate Differentiate Integrate Solve equation
+Plot Plot 2D Plot 3D
+Settings ??
+-->
+<sect2 id="settings-help-menu">
+<title>The Settings and Help Menu</title>
<para>
-This menu contains standard &kde; <guimenu>Settings</guimenu> items, as well as the items described in <link linkend="worksheet-settings">Settings section</link>.
+&cantor; has the common &kde; <guimenu>Settings</guimenu> and <guimenu>Help</guimenu>
+menu items, for more information read the sections about the <ulink
+url="help:/fundamentals/ui.html#menus-settings">Settings Menu</ulink> and
+<ulink url="help:/fundamentals/ui.html#menus-help">Help Menu</ulink>
+of the &kde; Fundamentals.
</para>
-</sect2>
-
-<sect2 id="help-menu">
-<title>The Help Menu</title>
-
-&help.menu.documentation;
</sect2>
</sect1>
</chapter>
-<chapter id="developers">
-<title>Developer's Guide to &cantor;</title>
-
-<para>
-&cantor; is easily extendable by plugins. You can write
-<variablelist>
- <varlistentry>
- <term>Backends:</term>
- <listitem>
- <para>
- A new backend enables you to use the &cantor; interface with a different program.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Assistants:</term>
- <listitem>
- <para>
- Assistants provide dialogs to allow common tasks to be automated (such entering a matrix or running a script.)
- </para>
- </listitem>
- </varlistentry>
-</variablelist>
-</para>
-<para>
-At present, there are no special developer tutorials or API documentation, so if you want to write a plugin you will have to read through the sources.
-All interface definitions are in the <filename role="directory">lib</filename> directory. For some example implementations, look at the plugins shipped with &cantor;.
-</para>
-
-</chapter>
-
<chapter id="faq">
<title>Questions and Answers</title>
-&reporting.bugs;
-&updating.documentation;
-
<qandaset id="faqlist">
<qandaentry>
<question><para>The Menu Item <guimenuitem>Typeset using LaTeX</guimenuitem> is not available</para></question>
@@ -653,62 +617,6 @@ Documentation Copyright © 2009-2011 Alexander Rieder <email>alexanderrieder
&underGPL; <!-- GPL License -->
</chapter>
-<appendix id="installation">
-<title>Installation</title>
-
-<sect1 id="getting-kapp">
-<title>How to obtain &cantor;</title>
-
-&install.intro.documentation;
-
-</sect1>
-
-<sect1 id="requirements">
-<title>Requirements</title>
-
-<para>
-In order to successfully use &cantor;, you need &kde; 4.
-If you want support for type-setting to be enabled, you need to install &latex; and LibSpectre.
-To use the different Backends, the appropriate math package is required.
-</para>
-
-<!--
-<para>
-All required libraries as well as &cantor; itself can be found
-on <ulink url="ftp://ftp.kapp.org">The &cantor; 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>
-
-&install.compile.documentation;
-
-</sect1>
-
-<sect1 id="configuration">
-<title>Configuration</title>
-
-<para>
- Depending on your system, you may need to adjust the paths to the
- different applications used by &cantor;.
-</para>
-
-</sect1>
-
-</appendix>
-
&documentation.index;
</book>
More information about the kde-doc-english
mailing list