Git commit f36b470aebb05a7f07c1a45cf560b814f7cdf340 by Burkhard Lück. Committed on 08/12/2016 at 12:54. Pushed by lueck into branch 'master'.
update tellico index + menus docbook to kf5 remove entity package, unused in kf5 replace &appname; with &tellico; remove appendix installation proofread/update menu docbook and use link to fundamentals for Settings + Help REVIEW:129618 M +19 -42 doc/index.docbook M +18 -106 doc/menus.docbook https://commits.kde.org/tellico/f36b470aebb05a7f07c1a45cf560b814f7cdf340 diff --git a/doc/index.docbook b/doc/index.docbook index 9c1db494..e3e37ba8 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 appname '<application>Tellico</application>'> - <!ENTITY kappname "&appname;"> - <!ENTITY package "extragear/office"> + <!ENTITY kappname "&tellico;"> <!ENTITY % addindex "IGNORE"> <!ENTITY % English "INCLUDE"><!-- change language only here --> @@ -44,7 +42,7 @@ Do NOT change these in the translation. --> <date>28/08/2009</date> <releaseinfo>2.0</releaseinfo> -<title>The &appname; Handbook</title> +<title>The &tellico; Handbook</title> <authorgroup> <author> @@ -85,7 +83,7 @@ For licensing information of both the software and this documentation, please re <abstract> <para> -This document is a handbook for using &appname;, a collection manager software application. +This document is a handbook for using &tellico;, a collection manager software application. </para> </abstract> @@ -126,10 +124,10 @@ problems. Basically a long version of the abstract. Don't include a revision history. (see installation appendix comment) --> <sect1 id="tellico-intro"> -<title>&appname;</title> +<title>&tellico;</title> <para> -&appname; is a program for managing collections. It began as a simple +&tellico; is a program for managing collections. It began as a simple book collection manager, and has expanded to include default collection templates for bibliographies, comic books, videos, music, coins, stamps, trading cards, video games, wines, board games, and file listings. @@ -137,10 +135,10 @@ In addition, custom collections can be built for any other type of collectibles. </para> <sect2 id="what-tellico-is"> -<title>What &appname; Is</title> +<title>What &tellico; Is</title> <para> -&appname; keeps track of the items in a collection, and offers +&tellico; keeps track of the items in a collection, and offers an easy way to enter data for each entry. It provides several field types, and allows for an unlimited number of user-defined fields. The entries in a collection may be grouped by any @@ -157,19 +155,19 @@ or publication of data. </sect2> <sect2 id="what-tellico-is-not"> -<title>What &appname; Is Not</title> +<title>What &tellico; Is Not</title> <para> -&appname; is not an audio or video player. It does not provide +&tellico; is not an audio or video player. It does not provide facilities for reading or modifying multimedia files. It also does -not provide any image-editing functionality. Although &appname; has some +not provide any image-editing functionality. Although &tellico; has some functionality for managing bibliography lists, it is not a full-blown -bibliographic reference manager. &appname; also does not pretend to have +bibliographic reference manager. &tellico; also does not pretend to have all the capabilities of a full-fledged relational database. </para> <para> -As somewhat of a disclaimer, &appname; is a hobby for the author, and no +As somewhat of a disclaimer, &tellico; is a hobby for the author, and no guarantees are made about its functionality, usefullness, or otherwise. More information is included in the <link linkend="credits">license declaration</link>. @@ -184,9 +182,9 @@ More information is included in the <sect2 id="collections"> <title>Collections</title> <para> -In &appname;, a collection is the document. Only one collection exists in each &appname; +In &tellico;, a collection is the document. Only one collection exists in each &tellico; file. A collection contains any number of <link linkend="fields">fields</link> and -<link linkend="entries">entries</link>. &appname; supports 12 specific collection types by +<link linkend="entries">entries</link>. &tellico; supports 12 specific collection types by default: books, bibliographic entries, comic books, videos, music, trading cards, coins, stamps, video games, wines, board games, and file listings. In addition, an empty generic collection template is available for any other type of collectibles or lists. @@ -196,7 +194,7 @@ template is available for any other type of collectibles or lists. <sect2 id="fields"> <title>Collection Fields</title> <para> -Each collection may have an unlimited number of fields. &appname; supports eleven types of fields, +Each collection may have an unlimited number of fields. &tellico; supports eleven types of fields, which allow for a range of different data. The fields can be edited with the <link linkend="fields-dialog"><interface>Collection Fields Dialog</interface></link> and are explained further in the <link linkend="field-types">Field Types</link> section. @@ -207,15 +205,15 @@ which allow for a range of different data. The fields can be edited with the <title>Collection Entries</title> <para> -An entry is the basic record in &appname;. Each entry contains a single value for each field in +An entry is the basic record in &tellico;. Each entry contains a single value for each field in the collection. A collection may have an unlimited number of entries, in theory, although since the whole collection is always resident in memory, too many entries could slow down the application. </para> <para> -&appname; has been tested with a collection of 10,000 entries, and the speed was satisfactory. +&tellico; has been tested with a collection of 10,000 entries, and the speed was satisfactory. However, if many large images are included in the collection, the loading and processing time -does slow down greatly. Performance can be improved by having &appname; store images separate from +does slow down greatly. Performance can be improved by having &tellico; store images separate from the data file itself, either in the application-specific folder or a folder relative to the data file. More information can be found in the <link linkend="configuration">configuration section</link>. @@ -253,7 +251,7 @@ file included in the KDE distribution. --> <title>Credits and License</title> <para> -&appname; +&tellico; </para> <para> Program copyright 2001-2011 &robby; <email>&email;</email> @@ -272,27 +270,6 @@ url="http://www.freebsd.org/copyright/freebsd-doc-license.html";>FreeBSD Document </chapter> -<appendix id="installation"> -<title>Installation</title> - -<sect1 id="getting-tellico"> -<title>How to obtain &appname;</title> - -<para> -The &appname; home page is -<ulink url="&homepage;">&homepage;</ulink>. -Updates and news can be found there.</para> -</sect1> - -<sect1 id="compilation"> -<title>Compilation and Installation</title> - -&install.compile.documentation; - -</sect1> - -</appendix> - &documentation.index; </book> diff --git a/doc/menus.docbook b/doc/menus.docbook index 562bc348..115cb411 100644 --- a/doc/menus.docbook +++ b/doc/menus.docbook @@ -10,14 +10,14 @@ or menu bars. --> <sect1 id="main-window-menus"> -<title>The Main &appname; Window</title> +<title>The Main &tellico; Window</title> <para>Each menu item is discussed below. When there is a keyboard shortcut that performs a menu item function, the default shortcut is listed with the menu item. </para> <sect2> -<title>The <guimenu>File</guimenu> Menu</title> +<title>The File Menu</title> <para> <variablelist> @@ -31,7 +31,7 @@ performs a menu item function, the default shortcut is listed with the menu item </term> <listitem> -<para>This command <action>creates a new collection</action>. &appname; supports <link linkend="collection-types">12 default collection types</link> along with an empty user-defined custom collection.</para> +<para>This command <action>creates a new collection</action>. &tellico; supports <link linkend="collection-types">12 default collection types</link> along with an empty user-defined custom collection.</para> </listitem> </varlistentry> @@ -47,7 +47,7 @@ performs a menu item function, the default shortcut is listed with the menu item </term> <listitem> -<para>This command <action>opens a &appname; file</action>.</para> +<para>This command <action>opens a &tellico; file</action>.</para> </listitem> </varlistentry> @@ -87,6 +87,9 @@ modified.</para> <varlistentry> <term> <menuchoice> + <shortcut> + <keycombo>&Ctrl;&Shift;<keycap>S</keycap></keycombo> + </shortcut> <guimenu>File</guimenu> <guimenuitem>Save As...</guimenuitem> </menuchoice> @@ -122,7 +125,7 @@ modified.</para> </term> <listitem> -<para>This command <action>imports data from another file</action>. &appname; can import data from a number of <link linkend="importing">other formats</link>.</para> +<para>This command <action>imports data from another file</action>. &tellico; can import data from a number of <link linkend="importing">other formats</link>.</para> </listitem> </varlistentry> @@ -135,7 +138,7 @@ modified.</para> </term> <listitem> -<para>This command <action>exports the collection to another format</action>. &appname; can export data to a number of <link linkend="exporting">other formats</link>.</para> +<para>This command <action>exports the collection to another format</action>. &tellico; can export data to a number of <link linkend="exporting">other formats</link>.</para> </listitem> </varlistentry> @@ -151,7 +154,7 @@ modified.</para> </term> <listitem> -<para>This command <action>closes the &appname; window</action>. If the collection has unsaved changes, you will be prompted to save them before continuing.</para> +<para>This command <action>closes the &tellico; window</action>. If the collection has unsaved changes, you will be prompted to save them before continuing.</para> </listitem> </varlistentry> @@ -161,7 +164,7 @@ modified.</para> <!-- %%%%%%%%%%%%%%%%%%%%%%%%%%%%%% EDIT MENU %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%--> <sect2> -<title>The <guimenu>Edit</guimenu> Menu</title> +<title>The Edit Menu</title> <para> @@ -318,7 +321,7 @@ modified.</para> <!-- %%%%%%%%%%%%%%%%%%%%%%%%%%%%%% COLLECTION MENU %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%--> <sect2> -<title>The <guimenu>Collection</guimenu> Menu</title> +<title>The Collection Menu</title> <para> <variablelist> @@ -565,38 +568,15 @@ source and <action>update the selected entries</action>.</para> </para> </sect2> -<!-- %%%%%%%%%%%%%%%%%%%%%%%%%%%%%% SETTINGS MENU %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%--> +<!-- %%%%%%%%%%%%%%%%%%%%%%%%%%%%%% SETTINGS / HELP MENU %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%--> <sect2> -<title>The <guimenu>Settings</guimenu> Menu</title> -<para> +<title>The Settings and Help Menu</title> -<variablelist> - -<varlistentry> -<term> - <menuchoice> - <guimenu>Settings</guimenu> - <guimenuitem>Toolbars Shown</guimenuitem> - </menuchoice> -</term> - -<listitem> -<para>This command <action>toggles the display of the toolbars</action>.</para> -</listitem> -</varlistentry> - -<varlistentry> -<term> - <menuchoice> - <guimenu>Settings</guimenu> - <guimenuitem>Show Statusbar</guimenuitem> - </menuchoice> -</term> +<para>Apart from the common &kde; Settings and Help menus described in the <ulink url="help:/fundamentals/ui.html#menus">Menu</ulink> +chapter of the &kde; Fundamentals documentation &tellico; has these application specific menu entries: +</para> -<listitem> -<para>This command <action>toggles the display of the statusbar</action>.</para> -</listitem> -</varlistentry> +<variablelist> <varlistentry> <term> @@ -637,74 +617,6 @@ source and <action>update the selected entries</action>.</para> </listitem> </varlistentry> -<varlistentry> -<term> - <menuchoice> - <guimenu>Settings</guimenu> - <guimenuitem>Configure Shortcuts...</guimenuitem> - </menuchoice> -</term> - -<listitem> -<para>This command <action>opens the &kde; <interface>Keyboard Shortcut Configuration Dialog</interface></action>.</para> -</listitem> -</varlistentry> - -<varlistentry> -<term> - <menuchoice> - <guimenu>Settings</guimenu> - <guimenuitem>Configure Toolbars...</guimenuitem> - </menuchoice> -</term> - -<listitem> -<para>This command <action>opens the &kde; <interface>Toolbar Configuration Dialog</interface></action>.</para> -</listitem> -</varlistentry> - -<varlistentry> -<term> - <menuchoice> - <guimenu>Settings</guimenu> - <guimenuitem>Configure &appname;...</guimenuitem> - </menuchoice> -</term> - -<listitem> -<para>This command <action>opens the &appname; <interface>Configuration Dialog</interface></action>.</para> -</listitem> -</varlistentry> - -</variablelist> - -</para> -</sect2> - -<sect2> -<title>The <guimenu>Help</guimenu> Menu</title> - -<para>These are the &kde; standard items for the <guimenu>Help</guimenu> menu:</para> - -&help.menu.documentation; - -<para>Apart from the standard &kde; <guimenu>Help</guimenu> menu items -described above &appname; has this additional menu entry:</para> - -<variablelist> -<varlistentry> -<term> - <menuchoice> - <guimenu>Help</guimenu> - <guimenuitem>Tip of the Day</guimenuitem> - </menuchoice> -</term> - -<listitem> -<para>This command <action>opens the Tip of the Day dialog</action>. You can page through all the tips by using the buttons on the dialog.</para> -</listitem> -</varlistentry> - </variablelist> </sect2>
