[education/kig] /: Documentation updates
Antoni Bella Pérez
null at kde.org
Wed Dec 23 16:19:31 GMT 2020
Git commit 788fac580eaf749e94f032701d2031935dd36867 by Antoni Bella Pérez.
Committed on 23/12/2020 at 16:18.
Pushed by bellaperez into branch 'master'.
Documentation updates
* Update date and version numbers
* Change http: to https:
* Add button images
* Some improves and suitable tagging
* Change to tabualtion, capitalization
* Use more entities
* Add @title:window helpers to GUI messages
A +- -- doc/edit-delete.png
M +44 -41 doc/index.docbook
A +1 -0 doc/index.html
A +- -- doc/kig_text.png
A +- -- doc/locus.png
M +12 -12 doc/man-kig.1.docbook
A +- -- doc/process-stop.png
A +- -- doc/system-run.png
A +- -- doc/text-x-python3.png
M +2 -2 kig/kig_part.cpp
M +1 -1 misc/kiginputdialog.cc
M +1 -1 modes/edittype.cc
M +1 -1 modes/historydialog.cc
M +1 -1 modes/macrowizard.cc
M +1 -1 modes/textlabelwizard.cc
M +1 -1 modes/typesdialog.cpp
M +1 -1 scripting/newscriptwizard.cc
M +1 -1 scripting/script_mode.cc
https://invent.kde.org/education/kig/commit/788fac580eaf749e94f032701d2031935dd36867
diff --git a/doc/edit-delete.png b/doc/edit-delete.png
new file mode 100644
index 00000000..1242de29
Binary files /dev/null and b/doc/edit-delete.png differ
diff --git a/doc/index.docbook b/doc/index.docbook
index ec1fca55..a836b742 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -32,8 +32,8 @@ Devriese</holder>
<legalnotice>&FDLNotice;</legalnotice>
-<date>2020-10-08</date>
-<releaseinfo>&kig; 1.0 (Applications 20.12)</releaseinfo>
+<date>2020-12-23</date>
+<releaseinfo>Applications 20.12</releaseinfo>
<abstract>
<para>
@@ -88,7 +88,7 @@ people, please open a review request for the change, so that
it can be evaluated for the inclusion in the distribution
(if you do this, it will be licensed under the
terms of &kig;'s license, the <ulink
-url="http://www.gnu.org/licenses/licenses.html#GPL">GPL</ulink>,
+url="https://www.gnu.org/licenses/licenses.html#GPL">GPL</ulink>,
so that other people can freely use and adapt it).
</para>
</chapter>
@@ -192,9 +192,9 @@ current cursor position and select it by clicking the &LMB;.
</para>
<para>
You can always cancel the construction of the new object by
-pressing the &Esc; button or by clicking
-on the <guiicon>Cancel Construction</guiicon> button (red circle with an
-inside bar) on the toolbar.
+pressing the &Esc; button or by clicking on the <inlinemediaobject>
+<imageobject> <imagedata fileref="process-stop.png" format="PNG"/> </imageobject>
+</inlinemediaobject> <guibutton>Cancel Construction</guibutton> button on the toolbar.
</para>
<screenshot>
<screeninfo>Constructing a circle.</screeninfo>
@@ -291,7 +291,8 @@ Press the ∇ key.
</listitem>
<listitem>
<para>
-Press the <guiicon>Delete Objects</guiicon> button on the toolbar.
+Press the <inlinemediaobject> <imageobject> <imagedata fileref="edit-delete.png" format="PNG"/>
+</imageobject> </inlinemediaobject> <guibutton>Delete Objects</guibutton> button on the toolbar.
</para>
</listitem>
<listitem>
@@ -352,7 +353,7 @@ Infrared Glasses</guimenuitem></menuchoice>.
In &kig;, you can undo almost any change you make in the
document. Just use the
<guiicon>Undo</guiicon>/<guiicon>Redo</guiicon> buttons on the
-toolbar, the <guimenu>Edit</guimenu> menu or the appropriate shortcuts.
+toolbar, the <guimenu>Edit</guimenu> menu or the appropriate keyboard shortcuts.
</para>
</sect1>
@@ -417,14 +418,14 @@ defined object as reference, for example:</para>
<guisubmenu>Angles</guisubmenu><guimenuitem>Angle by Three Points</guimenuitem>
</menuchoice> and make your desired angle of rotation somewhere in the &kig; window, generally in
an unobtrusive place. If desired, right click on the angle and click on
-<menuchoice><guimenu>Add Text Label</guimenu><guimenuitem>Angle in Degrees</guimenuitem></menuchoice>.</para></listitem>
+<menuchoice><guisubmenu>Add Text Label</guisubmenu><guimenuitem>Angle in Degrees</guimenuitem></menuchoice>.</para></listitem>
<listitem><para>Click with the &RMB; on the angle and select <guimenuitem>Set
Size</guimenuitem> and insert the new size for this angle in the dialog.
</para></listitem>
-<listitem><para>Click on <guimenu>Objects</guimenu> and construct your desired object.
+<listitem><para>Click on <guimenu>Objects</guimenu> menu and construct your desired object.
</para></listitem>
-<listitem><para>Right click on your shape, and select on <menuchoice><guimenu>
-Transform</guimenu><guimenuitem>Rotate</guimenuitem></menuchoice>.</para></listitem>
+<listitem><para>Right click on your shape, and select on <menuchoice><guisubmenu>Transform</guisubmenu>
+<guimenuitem>Rotate</guimenuitem></menuchoice>.</para></listitem>
<listitem><para>Set your desired point of rotation.</para></listitem>
<listitem><para>Click on your angle.</para></listitem>
<listitem><para>Your shape is rotated!</para></listitem>
@@ -452,11 +453,11 @@ rotation.</para>
</menuchoice> and construct the object by selecting the start and end point somewhere
in the &kig; window.</para></listitem>
<listitem><para>To adjust length and direction of the vector you have to edit its start
-and end point. Select them and choose in the context menu <guimenuitem>Set Coordinate...</guimenuitem>
+and end point. Select them and choose <guimenuitem>Set Coordinate...</guimenuitem> in the context menu.
</para></listitem>
<listitem><para>Click on <guimenu>Objects</guimenu> and construct your desired object.
</para></listitem>
-<listitem><para>Right click on your object, and select on <menuchoice><guimenu>Transform</guimenu>
+<listitem><para>Right click on your object, and select on <menuchoice><guisubmenu>Transform</guisubmenu>
<guimenuitem>Translate</guimenuitem></menuchoice>.</para></listitem>
<listitem><para>Select the vector to translate by.</para></listitem>
</orderedlist>
@@ -505,12 +506,13 @@ following image should make this a bit more clear:
</screenshot>
<para>
-Next comes defining the macro. Select <guimenuitem>New
-Macro...</guimenuitem> from the <guimenu>Types</guimenu> menu, or
-click on the button on the toolbar. A wizard will appear and
-ask you to select the given objects. In our example, these
-are the three points. Select the three points (click on them
-to select, click again to unselect) and click the
+Next comes defining the macro. Select the <menuchoice><guimenu>Types</guimenu>
+<guimenuitem>New Macro...</guimenuitem></menuchoice> menu item, or
+click on the <inlinemediaobject> <imageobject> <imagedata fileref="system-run.png"
+format="PNG"/></imageobject> </inlinemediaobject> <guibutton>New Macro...</guibutton>
+button on the toolbar. A wizard will appear and ask you to select the given objects.
+In our example, these are the three points. Select the three points (click on
+them to select, click again to unselect) and click the
<guibutton>Next</guibutton> button to continue. Finally,
select the last objects (only the circle in our example).
</para>
@@ -589,10 +591,11 @@ about objects (also known as <quote>properties</quote>).
</para>
<para>
To start constructing a text label, simply press the
-<guibutton>Text Label</guibutton> button in the &kig; toolbar or
-select <menuchoice><guimenu>Objects</guimenu><guisubmenu>Other
-</guisubmenu><guimenuitem>Text Label</guimenuitem>
-</menuchoice> in the menubar.
+ <inlinemediaobject> <imageobject> <imagedata fileref="kig_text.png" format="PNG"/>
+</imageobject> </inlinemediaobject> <guibutton>Text Label</guibutton>
+button in the &kig; toolbar or select the <menuchoice><guimenu>Objects</guimenu>
+<guisubmenu>Other</guisubmenu><guimenuitem>Text Label</guimenuitem>
+</menuchoice> menu item.
</para>
<para>
Next, you have to choose a location for the text label. You
@@ -716,15 +719,15 @@ travels while the first one moves around the circle is its locus.
</para>
<para>
Actually constructing the locus of a point is very easy. Click
-the <guiicon>locus</guiicon> button in the toolbar, or select
-<menuchoice><guimenu>Objects</guimenu>
-<guisubmenu>Other</guisubmenu>
-<guimenuitem>Locus</guimenuitem>
-</menuchoice>
-from the menubar. Then select the constrained point as the
+the <inlinemediaobject><imageobject> <imagedata fileref="locus.png"
+format="PNG"/> </imageobject></inlinemediaobject> <guibutton>Locus</guibutton>
+button in the toolbar, or select the <menuchoice><guimenu>Objects</guimenu>
+<guisubmenu>Other</guisubmenu><guimenuitem>Locus</guimenuitem></menuchoice>
+menu item. Then select the constrained point as the
moving point (the text <guilabel>Moving Point</guilabel> will
appear as you move the mouse over it), and the other as the
-dependent point. The locus of the dependent point will then be drawn.
+<guilabel>Dependent point</guilabel>. The locus of the dependent
+point will then be drawn.
</para>
</sect1>
</chapter>
@@ -749,8 +752,9 @@ then &kig; will show it for you.
<para>
Suppose you were not aware of the &kig; built-in type <quote>Mid Point</quote>,
and you wanted to show the midpoint of two given points. You
-would then click on the <guibutton>Python Script</guibutton>
-button in the toolbar, or select
+would then click on the <inlinemediaobject> <imageobject> <imagedata
+fileref="text-x-python3.png" format="PNG"/></imageobject> </inlinemediaobject>
+<guibutton>Python Script</guibutton> button in the toolbar, or select
<menuchoice><guimenu>Objects</guimenu><guisubmenu>Other</guisubmenu>
<guimenuitem>Python Script</guimenuitem></menuchoice> from the
menubar. You are then presented with a wizard that allows you
@@ -781,9 +785,8 @@ code is valid Python code. People familiar with Python will
notice that we are actually defining a Python function called
<function>calc</function>. It is therefore necessary to adhere
to the Python rules for defining functions. For example, every
-line of the function should start with a .
-The first line not starting with a ends the
-definition of the function.
+line of the function should start with a tab. The first line not
+starting with a tab ends the definition of the function.
</para>
<para>
The Python function that we want to define is called
@@ -854,7 +857,7 @@ can use ⪚ the <function>Point.coordinate()</function> method. You can
also return all kinds of objects, not just a <classname>Point</classname>.
Many more classes and methods are available in the &kig; Python code,
and a more complete reference is provided <ulink
-url="http://edu.kde.org/kig/manual/scripting-api/index.html">on
+url="https://edu.kde.org/kig/manual/scripting-api/index.html">on
the &kig; website</ulink>.
</para>
</chapter>
@@ -923,7 +926,7 @@ to files, import them from files, edit and delete them.
<para>
&kig; allows you to export a &kig; file to some interesting
formats, like images, <application>XFig</application> and
-<application>LaTeX</application> files, and <acronym>SVG</acronym>
+<application>LaTeX</application> files, and &SVG;
vectorial images. This is rather useful, because not all programs
support the &kig; file format yet.
</para>
@@ -991,7 +994,7 @@ Reviewed by &Philip.Rodrigues; &Philip.Rodrigues.mail;.
<title>Free Software</title>
<para>
&kig; is <ulink
-url="http://www.gnu.org/philosophy/philosophy.html#AboutFreeSoftware">
+url="https://www.gnu.org/philosophy/philosophy.html#AboutFreeSoftware">
Free Software</ulink>. This means that its source code is
freely available on the Internet, and everyone can use it,
read it, modify it, and distribute it.
@@ -1007,7 +1010,7 @@ software, you are allowed (and encouraged) to fix problems
you encounter while using it, to add features you miss, to
distribute your modified program, and to send these
modifications back for inclusion through the review tools
-available for the KDE community.
+available for the &kde; community.
</para>
<para>
If you are uncertain of your rights to use this software, or
@@ -1015,7 +1018,7 @@ other people's right to use any modifications you make to this
program &etc;, please read the license. You can find it in the
<filename>COPYING</filename> file in the &kig; source tree or
the license link in the <guilabel>About
-Kig</guilabel> dialog.
+&kig;</guilabel> dialog.
</para>
</sect1>
diff --git a/doc/index.html b/doc/index.html
new file mode 100644
index 00000000..0519ecba
--- /dev/null
+++ b/doc/index.html
@@ -0,0 +1 @@
+
\ No newline at end of file
diff --git a/doc/kig_text.png b/doc/kig_text.png
new file mode 100644
index 00000000..31d3c0b5
Binary files /dev/null and b/doc/kig_text.png differ
diff --git a/doc/locus.png b/doc/locus.png
new file mode 100644
index 00000000..16208ec0
Binary files /dev/null and b/doc/locus.png differ
diff --git a/doc/man-kig.1.docbook b/doc/man-kig.1.docbook
index 781be1eb..28e803a3 100644
--- a/doc/man-kig.1.docbook
+++ b/doc/man-kig.1.docbook
@@ -10,8 +10,8 @@
<firstname>Ben</firstname>
<surname>Burton</surname>
</personname><email>bab at debian.org</email></author>
-<date>2015-08-27</date>
-<releaseinfo>&kig; 1.0 (Applications 15.12)</releaseinfo>
+<date>2020-12-23</date>
+<releaseinfo>Applications 20.12</releaseinfo>
<productname>KDE Applications</productname>
</refentryinfo>
@@ -22,7 +22,7 @@
<refnamediv>
<refname><command>kig</command></refname>
-<refpurpose>an interactive geometry program by &kde;</refpurpose>
+<refpurpose>An interactive geometry program by &kde;</refpurpose>
</refnamediv>
<refsynopsisdiv>
@@ -38,17 +38,17 @@
<refsect1>
<title>Description</title>
-<para>&kig; is an application for interactive geometry. It is intended to
+<para>&kig; is an application for interactive geometry. It is intended to
serve two purposes:</para>
<itemizedlist><listitem><para>To allow students to interactively explore
mathematical figures and concepts using the computer;</para></listitem>
<listitem><para>To serve as a WYSIWYG tool for drawing mathematical figures and
including them in other documents.</para></listitem></itemizedlist>
<para>With this program you can do geometry on a computer just like you
-would on a blackboard in a classroom. However the program allows you to
+would on a blackboard in a classroom. However the program allows you to
move and change parts of a geometrical drawing so that you can see how other
parts change as a result.</para>
-<para>&kig; supports loci and user-defined macros. It also imports and
+<para>&kig; supports loci and user-defined macros. It also imports and
exports both to and from foreign file formats including
<application>Cabri</application>, <application>Dr. Geo</application>,
&kgeo;, <application>KSeg</application> and <application>XFig</application>.</para>
@@ -61,14 +61,14 @@ exports both to and from foreign file formats including
<variablelist>
<varlistentry>
<term><option>-c, --convert-to-native</option></term>
-<listitem><para>Do not show a &GUI;. Instead convert the specified file to
-native &kig; format. The native &kig; file will be written to standard
+<listitem><para>Do not show a &GUI;. Instead convert the specified file to
+native &kig; format. The native &kig; file will be written to standard
output unless <option>--outfile</option> is passed.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-o, --outfile <replaceable>filename</replaceable></option></term>
<listitem><para>Used with <option>--convert-to-native</option> to specify
-where to save the newly created &kig; file. Not specifying this option, or
+where to save the newly created &kig; file. Not specifying this option, or
providing a filename of <filename>-</filename> will output the file to
standard output.</para>
</listitem>
@@ -81,12 +81,12 @@ standard output.</para>
<title>See Also</title>
<para>More detailed user documentation is available from <ulink
url="help:/kig">help:/kig</ulink>
-(either enter this <acronym>URL</acronym> into &konqueror;, or run
+(either enter this &URL; into &konqueror;, or run
<userinput><command>khelpcenter</command>
<parameter>help:/kig</parameter></userinput>).</para>
<para>There is also further information available at the <ulink
-url="http://edu.kde.org/kig/">&kde; Edutainment website</ulink>.</para>
+url="https://edu.kde.org/kig/">&kde; Education website</ulink>.</para>
</refsect1>
<refsect1>
@@ -102,7 +102,7 @@ url="http://edu.kde.org/kig/">&kde; Edutainment website</ulink>.</para>
<email>toscano.pino at tiscali.it</email>,
<personname><firstname>David E.</firstname><surname>Narvaez</surname></personname>
<email>david.narvaez at computer.org</email>, and others.</para>
-<para>This man page based on the one prepared for Debian by
+<para>This man page based on the one prepared for &Debian; by
<personname><firstname>Ben</firstname><surname>Burton</surname></personname>
<email>bab at debian.org</email>.</para>
</refsect1>
diff --git a/doc/process-stop.png b/doc/process-stop.png
new file mode 100644
index 00000000..6f54051a
Binary files /dev/null and b/doc/process-stop.png differ
diff --git a/doc/system-run.png b/doc/system-run.png
new file mode 100644
index 00000000..95ee0e65
Binary files /dev/null and b/doc/system-run.png differ
diff --git a/doc/text-x-python3.png b/doc/text-x-python3.png
new file mode 100644
index 00000000..3bbec5d1
Binary files /dev/null and b/doc/text-x-python3.png differ
diff --git a/kig/kig_part.cpp b/kig/kig_part.cpp
index ff53f2ae..d0650c98 100644
--- a/kig/kig_part.cpp
+++ b/kig/kig_part.cpp
@@ -142,7 +142,7 @@ private:
KigPrintDialogPage::KigPrintDialogPage( QWidget* parent )
: QWidget( parent )
{
- setWindowTitle( i18n( "Kig Options" ) );
+ setWindowTitle( i18nc("@title:window", "Kig Options") );
QVBoxLayout* vl = new QVBoxLayout( this );
@@ -911,7 +911,7 @@ void KigPart::filePrint()
QPrinter printer;
KigPrintDialogPage* kp = new KigPrintDialogPage();
QPrintDialog printDialog( &printer, m_widget );
- printDialog.setWindowTitle( i18n("Print Geometry") );
+ printDialog.setWindowTitle( i18nc("@title:window", "Print Geometry") );
printDialog.setOptionTabs( { kp } );
printer.setFullPage( true );
//Unsupported in Qt
diff --git a/misc/kiginputdialog.cc b/misc/kiginputdialog.cc
index 0445c23d..1cecb4a5 100644
--- a/misc/kiginputdialog.cc
+++ b/misc/kiginputdialog.cc
@@ -137,7 +137,7 @@ KigInputDialog::KigInputDialog( QWidget* parent, const Goniometry& g )
QVBoxLayout* mainlay = new QVBoxLayout( mainWidget );
QHBoxLayout* horlay = new QHBoxLayout( mainWidget );
- setWindowTitle( i18n( "Set Angle Size" ) );
+ setWindowTitle( i18nc("@title:window", "Set Angle Size") );
setLayout( mainLayout );
okButton->setDefault( true );
okButton->setShortcut( Qt::CTRL | Qt::Key_Return );
diff --git a/modes/edittype.cc b/modes/edittype.cc
index 174594dc..694eed09 100644
--- a/modes/edittype.cc
+++ b/modes/edittype.cc
@@ -37,7 +37,7 @@ EditType::EditType( QWidget* parent, const QString& name, const QString& desc,
: QDialog( parent ),
mname( name ), mdesc( desc ), micon( icon )
{
- setWindowTitle( i18n( "Edit Type" ) );
+ setWindowTitle( i18nc("@title:window", "Edit Type") );
QDialogButtonBox *buttonBox = new QDialogButtonBox(QDialogButtonBox::Ok|QDialogButtonBox::Cancel|QDialogButtonBox::Help);
QWidget *mainWidget = new QWidget(this);
QVBoxLayout *mainLayout = new QVBoxLayout;
diff --git a/modes/historydialog.cc b/modes/historydialog.cc
index c7416590..6256493d 100644
--- a/modes/historydialog.cc
+++ b/modes/historydialog.cc
@@ -36,7 +36,7 @@
HistoryDialog::HistoryDialog( QUndoStack* kch, QWidget* parent )
: QDialog( parent ), mch( kch )
{
- setWindowTitle( i18n( "History Browser" ) );
+ setWindowTitle( i18nc("@title:window", "History Browser") );
QDialogButtonBox *buttonBox = new QDialogButtonBox(QDialogButtonBox::Close);
QWidget *mainWidget = new QWidget(this);
QVBoxLayout *mainLayout = new QVBoxLayout;
diff --git a/modes/macrowizard.cc b/modes/macrowizard.cc
index a4838e20..ed96048f 100644
--- a/modes/macrowizard.cc
+++ b/modes/macrowizard.cc
@@ -170,7 +170,7 @@ MacroWizard::MacroWizard( QWidget* parent, DefineMacroMode* m )
{
setModal( false );
setObjectName( QStringLiteral( "Define Macro Wizard" ) );
- setWindowTitle( i18n( "Define New Macro" ) );
+ setWindowTitle( i18nc("@title:window", "Define New Macro") );
setOption( HaveHelpButton );
mgivenArgsPage = new GivenArgsPage( this, mmode );
diff --git a/modes/textlabelwizard.cc b/modes/textlabelwizard.cc
index 68c103c2..04937207 100644
--- a/modes/textlabelwizard.cc
+++ b/modes/textlabelwizard.cc
@@ -116,7 +116,7 @@ TextLabelWizard::TextLabelWizard( QWidget* parent, TextLabelModeBase* mode )
{
setModal( false );
setObjectName( QStringLiteral( "TextLabelWizard" ) );
- setWindowTitle( i18n( "Construct Label" ) );
+ setWindowTitle( i18nc("@title:window", "Construct Label") );
setOption( HaveHelpButton );
setOption( HaveFinishButtonOnEarlyPages );
diff --git a/modes/typesdialog.cpp b/modes/typesdialog.cpp
index da6b2e5d..9945969c 100644
--- a/modes/typesdialog.cpp
+++ b/modes/typesdialog.cpp
@@ -343,7 +343,7 @@ TypesDialog::TypesDialog( QWidget* parent, KigPart& part )
: QDialog( parent ),
mpart( part )
{
- setWindowTitle( i18n( "Manage Types" ) );
+ setWindowTitle( i18nc("@title:window", "Manage Types") );
QDialogButtonBox *buttonBox = new QDialogButtonBox( QDialogButtonBox::Ok | QDialogButtonBox::Cancel | QDialogButtonBox::Help );
QWidget *mainWidget = new QWidget( this );
QVBoxLayout *mainLayout = new QVBoxLayout;
diff --git a/scripting/newscriptwizard.cc b/scripting/newscriptwizard.cc
index 5b8e641b..308afe2c 100644
--- a/scripting/newscriptwizard.cc
+++ b/scripting/newscriptwizard.cc
@@ -58,7 +58,7 @@ NewScriptWizard::NewScriptWizard( QWidget* parent, ScriptModeBase* mode, KIconLo
mmode( mode ), textedit( 0 ), document( 0 ), docview( 0 ), mIconLoader( il )
{
setObjectName( QStringLiteral( "New Script Wizard" ) );
- setWindowTitle( i18n( "New Script" ) );
+ setWindowTitle( i18nc("@title:window", "New Script") );
setOption( HaveHelpButton );
QWizardPage* firstPage = new QWizardPage( this );
diff --git a/scripting/script_mode.cc b/scripting/script_mode.cc
index d3db5e7b..55f6763e 100644
--- a/scripting/script_mode.cc
+++ b/scripting/script_mode.cc
@@ -307,7 +307,7 @@ ScriptEditMode::ScriptEditMode( ObjectTypeCalcer* exec_calc, KigPart& doc )
// in the editor and aborts the editing
morigscript = static_cast<const StringImp*>( imp )->data();
- mwizard->setWindowTitle( i18nc( "'Edit' is a verb", "Edit Script" ) );
+ mwizard->setWindowTitle( i18nc("@title:window 'Edit' is a verb", "Edit Script") );
mwizard->setText( morigscript );
mwizard->show();
mwizard->next();
More information about the kde-doc-english
mailing list