diff options
Diffstat (limited to 'doc/keduca')
| -rw-r--r-- | doc/keduca/Makefile.am | 4 | ||||
| -rw-r--r-- | doc/keduca/index.docbook | 334 | ||||
| -rw-r--r-- | doc/keduca/man-keduca.1.docbook | 67 | ||||
| -rw-r--r-- | doc/keduca/man-keducabuilder.1.docbook | 74 | ||||
| -rw-r--r-- | doc/keduca/screenshot.png | bin | 0 -> 25747 bytes |
5 files changed, 479 insertions, 0 deletions
diff --git a/doc/keduca/Makefile.am b/doc/keduca/Makefile.am new file mode 100644 index 00000000..da8216ae --- /dev/null +++ b/doc/keduca/Makefile.am @@ -0,0 +1,4 @@ + +KDE_LANG = en +KDE_DOCS = AUTO +KDE_MANS = AUTO diff --git a/doc/keduca/index.docbook b/doc/keduca/index.docbook new file mode 100644 index 00000000..f6aef344 --- /dev/null +++ b/doc/keduca/index.docbook @@ -0,0 +1,334 @@ +<?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: +--> diff --git a/doc/keduca/man-keduca.1.docbook b/doc/keduca/man-keduca.1.docbook new file mode 100644 index 00000000..647a81b7 --- /dev/null +++ b/doc/keduca/man-keduca.1.docbook @@ -0,0 +1,67 @@ +<?xml version="1.0" ?> +<!DOCTYPE refentry PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ +<!ENTITY % English "INCLUDE"> +]> + +<refentry lang="&language;"> +<refentryinfo> +<title>KDE User's Manual</title> +<author>&Lauri.Watts;&Lauri.Watts.mail;</author> +<date>March 16, 2005</date> +<productname>K Desktop Environment</productname> +</refentryinfo> +<refmeta> +<refentrytitle><command>keduca</command></refentrytitle> +<manvolnum>1</manvolnum> +</refmeta> + +<refnamediv> +<refname><command>keduca</command></refname> +<refpurpose>Interactive form-based tests and exams.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<cmdsynopsis> +<command>keduca</command> +<group><option>file</option></group> +<arg choice="opt">KDE Generic Options</arg> +<arg choice="opt">Qt Generic Options</arg> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1> +<title>Description</title> +<para>&keduca; is flash card application, which allows you to make +interactive form based tests.</para> + +</refsect1> + +<refsect1> +<title>Options</title> + +<variablelist> +<varlistentry><term><option><replaceable>file</replaceable></option></term> +<listitem><para>File to load</para></listitem> +</varlistentry> +</variablelist> + +</refsect1> + +<refsect1> +<title>See Also</title> +<para>More detailed user documentation is available from <ulink +url="help:/keduca">help:/keduca</ulink> +(either enter this <acronym>URL</acronym> into &konqueror;, or run +<userinput><command>khelpcenter</command> +<parameter>help:/keduca</parameter></userinput>).</para> + +<para>There is also further information available at the <ulink +url="http://edu.kde.org/keduca/">KDE Educatainment project website</ulink>.</para> +</refsect1> + +<refsect1> +<title>Authors</title> +<para>&keduca; was written by <personname><firstname>Javier</firstname><surname>Campos</surname></personname></para> +</refsect1> + +</refentry> diff --git a/doc/keduca/man-keducabuilder.1.docbook b/doc/keduca/man-keducabuilder.1.docbook new file mode 100644 index 00000000..8d11cf87 --- /dev/null +++ b/doc/keduca/man-keducabuilder.1.docbook @@ -0,0 +1,74 @@ +<?xml version="1.0" ?> +<!DOCTYPE refentry PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ +<!ENTITY % English "INCLUDE"> +]> + +<refentry lang="&language;"> +<refentryinfo> +<title>KDE User's Manual</title> +<author><personname> +<firstname>Ben</firstname> +<surname>Burton</surname> +</personname> +<email>bab@debian.org</email></author> +<date>2005-05-27</date> +<productname>K Desktop Environment</productname> +</refentryinfo> + +<refmeta> +<refentrytitle><command>keducabuilder</command></refentrytitle> +<manvolnum>1</manvolnum> +</refmeta> + +<refnamediv> +<refname><command>keducabuilder</command></refname> +<refpurpose>test/exam editor for keduca</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<cmdsynopsis> +<command>keducabuilder</command> +<group><option>file</option></group> +<arg choice="opt">KDE Generic Options</arg> +<arg choice="opt">Qt Generic Options</arg> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1> +<title>Description</title> +<para><application>KEducaBuilder</application> is the test editor for +&keduca;, a flash-card application for working with interactive form-based +tests. KEducaBuilder is used to create and edit these tests, whereas +&keduca; itself can be used to view and take these tests. </para> +<para>This application is part of the &kde; edutainment module. </para> +</refsect1> + +<refsect1> +<title>Options</title> +<variablelist> +<varlistentry> +<term><option><replaceable>file</replaceable></option></term> +<listitem><para>Filename to load in the editor</para></listitem> +</varlistentry> +</variablelist> +</refsect1> + +<refsect1> +<title>See Also</title> +<para>keduca(1)</para> + +<para>More detailed user documentation is available from <ulink +url="help:/keduca">help:/&keduca;</ulink> +(either enter this <acronym>URL</acronym> into &konqueror;, or run +<userinput><command>khelpcenter</command> +<parameter>help:/keduca</parameter></userinput>).</para> + +<para>There is also further information available at the <ulink url="http://edu.kde.org/keduca/">&kde; Edutainment website:</ulink></para> +</refsect1> + +<refsect1> +<title>Authors</title> +<para>&keduca; was written by <personname><firstname>Javier</firstname><surname>Campos</surname></personname></para><para>This man page based on the one written for Debian by <personname><firstname>Ben</firstname><surname>Burton</surname></personname> <email>bab@debian.org</email>.</para> +</refsect1> + +</refentry> diff --git a/doc/keduca/screenshot.png b/doc/keduca/screenshot.png Binary files differnew file mode 100644 index 00000000..bbfef374 --- /dev/null +++ b/doc/keduca/screenshot.png |
