[kde-doc-english] [kturtle] doc: KTurtle handbook update to 16.04
Burkhard Lück
lueck at hube-lueck.de
Tue May 10 19:23:04 UTC 2016
Git commit fdaa902851630f45f83915ad489c5383158d2dd1 by Burkhard Lück.
Committed on 10/05/2016 at 19:22.
Pushed by lueck into branch 'master'.
KTurtle handbook update to 16.04
remove package kdeedu
bump date + releaseinfo
remove appendix
add missing and, or, not, true, false, learn, return, to to index
remove commentes sect2 id name
add missing shortcut
remove guimenu markup in <title>
replace &help.menu.documentation; with link to fundamentals
REVIEW:127854
M +2 -24 doc/index.docbook
M +5 -42 doc/programming-reference.docbook
M +13 -8 doc/using-kturtle.docbook
http://commits.kde.org/kturtle/fdaa902851630f45f83915ad489c5383158d2dd1
diff --git a/doc/index.docbook b/doc/index.docbook
index f02bd0f..a0048bd 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -2,7 +2,6 @@
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN"
"dtd/kdedbx45.dtd" [
<!ENTITY kappname "&kturtle;">
- <!ENTITY package "kdeedu">
<!ENTITY turtlescript "TurtleScript">
<!ENTITY logo "Logo">
<!ENTITY % addindex "INCLUDE">
@@ -62,8 +61,8 @@
<legalnotice>&FDLNotice;</legalnotice>
-<date>2013-02-08</date>
-<releaseinfo>0.8.1 beta (&kde; 4.10)</releaseinfo>
+<date>2016-05-07</date>
+<releaseinfo>0.8.1 beta (Applications 16.04)</releaseinfo>
<abstract>
<para>&kturtle; is an educational programming environment that aims to make learning how to program as easy as possible. To achieve this &kturtle; makes all programming tools available from the user interface. The programming language used is &turtlescript; which allows its commands to be translated.</para>
@@ -165,27 +164,6 @@ Andrew Coles <email>andrew_coles AT yahoo DOT co DOT uk</email></para>
</chapter>
-
-
-<appendix id="installation">
-<title>Installation</title>
-
-<sect1 id="getting-kturtle">
-<title>How to obtain &kturtle;</title>
-
-&install.intro.documentation;
-
-</sect1>
-
-<sect1 id="compilation">
-<title>Compilation and Installation</title>
-
-&install.compile.documentation;
-
-</sect1>
-
-</appendix>
-
<!--&documentation.index; -->
<index id='command-index'>
<title>Command Index</title>
diff --git a/doc/programming-reference.docbook b/doc/programming-reference.docbook
index 7372e18..accf94c 100644
--- a/doc/programming-reference.docbook
+++ b/doc/programming-reference.docbook
@@ -61,7 +61,7 @@ In this example <userinput>print</userinput> is a command where <userinput>"Hell
<sect2 id="boolean-value">
<title>Boolean (true/false) values</title>
-<para>There are only two boolean values: <userinput>true</userinput> and <userinput>false</userinput>. Sometimes they are also called: on and off, yes and no, one and zero. But in &turtlescript; we call them, always, <userinput>true</userinput> and <userinput>false</userinput>. Have a look at this piece of &turtlescript;:
+<para>There are only two boolean values: <userinput>true</userinput><indexterm><primary>true</primary></indexterm> and <userinput>false</userinput><indexterm><primary>false</primary></indexterm>. Sometimes they are also called: on and off, yes and no, one and zero. But in &turtlescript; we call them, always, <userinput>true</userinput> and <userinput>false</userinput>. Have a look at this piece of &turtlescript;:
<screen>
$a = true
</screen>
@@ -111,7 +111,7 @@ The expressions inside parentheses will be calculated first. In this example, 20
<sect2 id="boolean-operators">
<title>Boolean (true/false) operators</title>
-<para>Where <link linkend="mathematical-operators">mathematical operators</link> are mainly for <link linkend="number">numbers</link>, boolean operators are for <link linkend="boolean-value">boolean values</link> (<userinput>true</userinput> and <userinput>false</userinput>). There are only three boolean operators, namely: <userinput>and</userinput>, <userinput>or</userinput>, and <userinput>not</userinput>. The following piece of &turtlescript; shows how to use them:
+<para>Where <link linkend="mathematical-operators">mathematical operators</link> are mainly for <link linkend="number">numbers</link>, boolean operators are for <link linkend="boolean-value">boolean values</link> (<userinput>true</userinput> and <userinput>false</userinput>). There are only three boolean operators, namely: <userinput>and</userinput><indexterm><primary>and</primary></indexterm>, <userinput>or</userinput><indexterm><primary>or</primary></indexterm>, and <userinput>not</userinput><indexterm><primary>not</primary></indexterm>. The following piece of &turtlescript; shows how to use them:
<screen>
$and_1_1 = true and true # -> true
$and_1_0 = true and false # -> false
@@ -745,7 +745,7 @@ while $x < 5 {
<title>The "for" loop, a counting loop</title>
<variablelist>
<varlistentry>
- <term>for<indexterm><primary>for</primary></indexterm><indexterm><primary>step</primary></indexterm></term>
+ <term>for<indexterm><primary>for</primary></indexterm><indexterm><primary>to</primary></indexterm><indexterm><primary>step</primary></indexterm></term>
<listitem><para><screen>for <link linkend="assignment-of-variables">variable</link> = <link linkend="number">number</link> to <link linkend="number">number</link> { ... }</screen>
The <userinput>for</userinput> loop is a <quote>counting loop</quote>, &ie; it keeps count for you. The first number sets the variable to the value in the first loop. Every loop the number is increased until the second number is reached.
<screen>
@@ -805,45 +805,8 @@ assert $in > 0
<sect1 id="learn">
-
-<!--<sect2 id="name">
-<title>Names</title>
-<para>When using the &turtlescript; programming language you create new things. If you write a program you will often need <link linkend="containers">containers</link> and in some cases you need <link linkend="learn">learn</link> to create new commands. When making a new command with <link linkend="learn">learn</link> you will have to specify a name.</para>
-<para>You can choose any name, as long as it does not already have a meaning. For instance you cannot name a function <link linkend="forward">forward</link>, since that name is already used for an internal command.
-<screen>
-# here forward is used as a new command,
-# but it already has a meaning so
-# this will produce an error:
-learn forward {
- print "this is invalid"
-}
-
-# this works:
-learn myforward {
- print "this is ok"
-}
-</screen>
-Names can contain only letters, numbers and underscores (_). Yet they have to start with a letter. Container names have to start with the container prefix ($).
-<screen>
-# here forward is used as a container,
-# starting with the $ prefix, so it does
-# not conflict with the forward command
-$forward = 20
-print $forward
-</screen>
-</para>
-<para>Containers are <glossterm>highlighted</glossterm> with bolded purple in the <link linkend="the-editor">code editor</link>.</para>
-<para>
-Please read the documentation on <link linkend="containers">containers</link> and the <link linkend="learn">learn</link> command for a better explanation and more examples.
-</para>
-</sect2>-->
-
-
-
-
-
<title>Create your own commands with <quote>learn</quote></title>
-<para><userinput>learn</userinput> is special as it is used to create your own commands. The commands you create can take <glossterm linkend="input-output">input</glossterm> and return <glossterm linkend="input-output">output</glossterm>. Let us take a look at how a new command is created:
+<para><userinput>learn</userinput><indexterm><primary>learn</primary></indexterm> is special as it is used to create your own commands. The commands you create can take <glossterm linkend="input-output">input</glossterm> and return <glossterm linkend="input-output">output</glossterm>. Let us take a look at how a new command is created:
<screen>
learn circle $x {
repeat 36 {
@@ -868,7 +831,7 @@ go 300,200
circle 40
</screen>
</para>
-<para>In the next example, a command with a return value is created.
+<para>In the next example, a command with a return<indexterm><primary>return</primary></indexterm> value is created.
<screen>
learn faculty $x {
$r = 1
diff --git a/doc/using-kturtle.docbook b/doc/using-kturtle.docbook
index e3c8adc..29f7991 100644
--- a/doc/using-kturtle.docbook
+++ b/doc/using-kturtle.docbook
@@ -50,7 +50,7 @@
<para>In the menubar you find all the actions of &kturtle;. They are in the following groups: <guimenu>File</guimenu>, <guimenu>Edit</guimenu>, <guimenu>Canvas</guimenu>, <guimenu>Run</guimenu>, <guimenu>Tools</guimenu>, <guimenu>Settings</guimenu>, and <guimenu>Help</guimenu>. This section describes them all.</para>
<sect2 id="the-file-menu">
-<title>The <guimenu>File</guimenu> Menu</title>
+<title>The File Menu</title>
<variablelist>
<anchor id="file-new" />
@@ -127,6 +127,9 @@
<anchor id="file-save-as" />
<varlistentry>
<term><menuchoice>
+ <shortcut>
+ <keycombo>&Ctrl;&Shift;<keycap>S</keycap></keycombo>
+ </shortcut>
<guimenu>File</guimenu>
<guimenuitem>Save As...</guimenuitem>
</menuchoice></term>
@@ -172,7 +175,7 @@
</sect2>
<sect2 id="the-edit-menu">
- <title>The <guimenu>Edit</guimenu> Menu</title>
+ <title>The Edit Menu</title>
<variablelist>
<anchor id="edit-undo" />
<varlistentry>
@@ -320,7 +323,7 @@
<sect2 id="the-canvas-menu">
- <title>The <guimenu>Canvas</guimenu> Menu</title>
+ <title>The Canvas Menu</title>
<variablelist>
<anchor id="canvas-export-to-image" />
<varlistentry>
@@ -354,7 +357,7 @@
</sect2>
<sect2 id="the-run-menu">
- <title>The <guimenu>Run</guimenu> Menu</title>
+ <title>The Run Menu</title>
<variablelist>
<anchor id="run-execute" />
<varlistentry>
@@ -409,7 +412,7 @@
<sect2 id="the-tools-menu">
- <title>The <guimenu>Tools</guimenu> Menu</title>
+ <title>The Tools Menu</title>
<variablelist>
<anchor id="tools-direction-chooser" />
<varlistentry>
@@ -433,7 +436,7 @@
</sect2>
<sect2 id="the-setting-menu">
- <title>The <guimenu>Settings</guimenu> Menu</title>
+ <title>The Settings Menu</title>
<variablelist>
<anchor id="settings-set-script-language" />
<varlistentry>
@@ -527,8 +530,10 @@
</sect2>
<sect2 id="the-help-menu">
- <title>The <guimenu>Help</guimenu> Menu</title>
- &help.menu.documentation;
+ <title>The Help Menu</title>
+<para>&kturtle; has a default &kde; <guimenu>Help</guimenu> menu as described in the
+<ulink url="help:/fundamentals/ui.html#menus-help">&kde; Fundamentals</ulink>
+with one additional entry:</para>
<variablelist>
<anchor id="help-context-help" />
<varlistentry>
More information about the kde-doc-english
mailing list