path: root/doc/keduca/index.docbook

<?xml version="1.0" ?>
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
  <!ENTITY kappname "&keduca;">
  <!ENTITY package "kdeedu">
  <!ENTITY % addindex "IGNORE">
  <!ENTITY % English "INCLUDE">
]>

<book lang="&language;">

<bookinfo>
<title>The &keduca; Handbook</title>

<authorgroup>
<author>
<firstname>Javier</firstname>
<othername>J.</othername>
<surname>Campos</surname>
<affiliation>
<address><email>&Javier.J.Campos.mail;</email></address>
</affiliation>
</author>
<!-- TRANS:ROLES_OF_TRANSLATORS -->

</authorgroup>

<copyright>
<year>1999</year>
<holder>&Javier.J.Campos;</holder>
</copyright>

<date>2002-10-08</date>
<releaseinfo>1.1</releaseinfo>

<abstract>
<para>&keduca; is flash card application, which allows you to make
interactive form based tests.</para>
</abstract>

<keywordset>
<keyword>KDE</keyword>
<keyword>kdeedu</keyword>
<keyword>KEduca</keyword>
<keyword>test</keyword>
</keywordset>

</bookinfo>

<chapter id="introduction"> 
<title>Introduction</title> 

<para>&keduca; is flash card application, which allows you to make
interactive form based tests.</para>

<screenshot>
<screeninfo>&keduca; screenshot</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="screenshot.png" format="PNG" />
</imageobject>
<textobject>
<phrase>&keduca; screenshot</phrase>
</textobject>
</mediaobject>
</screenshot>

</chapter>
<!-- 
<chapter id="create-modify-test">
<title>Creating a New Test</title>

</chapter>

<chapter id="configuration">
<title>Configuring &keduca;</title>

</chapter>
-->
<chapter id="command-reference">
<title>Command Reference</title>

<sect1 id="file-menu">
<title>The <guimenu>File</guimenu> Menu</title>

<sect2 id="main-window-file-menu">
<title>The <guilabel>Main Window</guilabel> <guimenu>File</guimenu>
Menu</title>

<para>The <guilabel>Main Window</guilabel> has the following
entries:</para>

<variablelist>
<varlistentry>
<term><menuchoice><!-- <shortcut>
<keycombo action="simul">&Ctrl;<keycap>O</keycap></keycombo> 
</shortcut> -->
<guimenu>File</guimenu>
<guimenuitem>Open...</guimenuitem>
</menuchoice></term>
<listitem>
<para><action>Open an existing test file.</action></para>
</listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<guimenu>File</guimenu>
<guisubmenu>Open Recent</guisubmenu>
</menuchoice></term>
<listitem>
<para><action>Open a recently used test file.</action></para>
</listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<guimenu>File</guimenu>
<guimenuitem>Close</guimenuitem>
</menuchoice></term>
<listitem><para><action>
Close the currently open test file.
</action></para>
</listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<guimenu>File</guimenu>
<guimenuitem>Quit</guimenuitem>
</menuchoice></term>
<listitem><para><action>Quit</action> &keduca;</para></listitem>
</varlistentry>
</variablelist>

</sect2>

<sect2 id="edit-test-window-file-menu">
<title>The Editing Window <guimenu>File</guimenu> Menu</title>

<variablelist>
<varlistentry>
<term><menuchoice>
<guimenu>File</guimenu>
<guimenuitem>New</guimenuitem>
</menuchoice></term>
<listitem><para><action>Create a new test</action></para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<guimenu>File</guimenu>
<guimenuitem>Open...</guimenuitem>
</menuchoice></term>
<listitem>
<para><action>Open an existing test file.</action></para>
</listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<guimenu>File</guimenu>
<guisubmenu>Open Recent</guisubmenu>
</menuchoice></term>
<listitem>
<para><action>Open a recently used test file.</action></para>
</listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<guimenu>File</guimenu>
<guimenuitem>Save</guimenuitem>
</menuchoice></term>
<listitem><para><action>Save the currently open
test.</action></para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<guimenu>File</guimenu>
<guimenuitem>Save As...</guimenuitem>
</menuchoice></term>
<listitem><para><action>Save the currently open game with a new
name.</action></para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<guimenu>File</guimenu>
<guimenuitem>Close</guimenuitem>
</menuchoice></term>
<listitem><para><action>
Close the currently open test file.
</action></para>
</listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<guimenu>File</guimenu>
<guimenuitem>Print...</guimenuitem>
</menuchoice></term>
<listitem>
<para><action>Print the currently open
test.</action></para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<guimenu>File</guimenu>
<guimenuitem>Quit</guimenuitem>
</menuchoice></term>
<listitem><para><action>Quit</action> &keduca;</para></listitem>
</varlistentry>
</variablelist>

</sect2>

</sect1>

<sect1 id="build-menu">
<title>The <guimenu>Build</guimenu> Menu</title>

<para>The <guimenu>Build</guimenu> menu exists only in the
<guilabel>Main Window</guilabel> of &keduca;.</para>

<variablelist>
<varlistentry>
<term><menuchoice>
<guimenu>Build</guimenu>
<guimenuitem>Create/Modify...</guimenuitem>
</menuchoice></term>
<listitem>
<para><action>Create or modify a test</action> in the Create or Modify a test
window.</para>
</listitem>
</varlistentry>
</variablelist>

</sect1>

<sect1 id="settings-menu">
<title>The <guimenu>Settings</guimenu> Menu</title>

<para>The first entries are available in both of the main &keduca;
windows.</para>

<variablelist>
<varlistentry>
<term><menuchoice><guimenu>Settings</guimenu>
<guimenuitem>Show Toolbar</guimenuitem>
</menuchoice></term>
<listitem>
<para><action>Toggle on and off the display of the toolbar.</action>
The default is on.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><menuchoice><guimenu>Settings</guimenu>
<guimenuitem>Configure Shortcuts...</guimenuitem>
</menuchoice></term>
<listitem>
<para><action>Personalize the keybindings</action> for &keduca;.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><menuchoice><guimenu>Settings</guimenu>
<guimenuitem>Configure Toolbars...</guimenuitem>
</menuchoice></term>
<listitem>
<para><action>Personalize the toolbars</action> for &keduca;.</para>
</listitem>
</varlistentry>
</variablelist>

<para>The following entry is only available in the <guilabel>Main
Window</guilabel>.</para>

<variablelist>
<varlistentry>
<term><menuchoice><guimenu>Settings</guimenu>
<guimenuitem>Configure &keduca;</guimenuitem>
</menuchoice></term>
<listitem>
<para><action>Customize</action> &keduca;. The options available to
you are described in the Configuration chapter.</para>
</listitem>
</varlistentry>
</variablelist>

</sect1>

<sect1 id="help-menu">
<title>The <guimenu>Help</guimenu> Menu</title>

&help.menu.documentation;
</sect1>

</chapter>

<chapter id="credits-and-licenses">
<title>Credits and Licenses</title>

<para>&keduca; is copyright 2001, Javier Campos.</para>

<para>Documentation partly by &Lauri.Watts; &Lauri.Watts.mail;</para>

<!-- TRANS:CREDIT_FOR_TRANSLATORS -->

&underFDL;
&underGPL;

</chapter>
<!-- 
<appendix id="installation">
<title>Installation</title>

&install.intro.documentation;
&install.compile.documentation;
</appendix>
-->
&documentation.index;
</book>
<!--
Local Variables:
mode: sgml
sgml-minimize-attributes:nil
sgml-general-insert-case:lower
sgml-indent-step:0
sgml-indent-data:nil
End:
-->