Git commit b065e59d59a567c9c8bbcc5664b1b255bee7fa59 by Thomas Baumgart. Committed on 23/02/2020 at 20:38. Pushed by tbaumgart into branch '5.0'.
Documentation improves http: to https:, Review links and some menu items Summary: First fixes from translation workflow Test Plan: Validate links Reviewers: #kmymoney, habacker, yurchor, ostroffjh Reviewed By: #kmymoney, ostroffjh Subscribers: tbaumgart, ostroffjh, kde-doc-english Tags: #kmymoney, #documentation Differential Revision: https://phabricator.kde.org/D27582 (cherry picked from commit b68096444484c982cac5d6bfe944cda329081647) M +3 -3 doc/details-accounts.docbook M +6 -6 doc/details-database.docbook M +1 -1 doc/details-formats.docbook M +3 -3 doc/details-impexp-csv.docbook M +4 -3 doc/details-impexp-csvexp.docbook M +14 -15 doc/details-impexp.docbook M +1 -1 doc/details-institutions.docbook M +3 -3 doc/details-investments.docbook M +1 -1 doc/details-search.docbook M +6 -7 doc/faq.docbook M +12 -12 doc/firsttime.docbook M +2 -2 doc/introduction.docbook M +9 -9 doc/makemostof.docbook M +1 -1 doc/reference.docbook M +1 -1 doc/whatsnew.docbook https://commits.kde.org/kmymoney/b065e59d59a567c9c8bbcc5664b1b255bee7fa59 diff --git a/doc/details-accounts.docbook b/doc/details-accounts.docbook index 692d5b6b5..3714cd46f 100644 --- a/doc/details-accounts.docbook +++ b/doc/details-accounts.docbook @@ -108,9 +108,9 @@ </para> <para> - The Account Number and the <acronym><ulink - url="http://en.wikipedia.org/wiki/International_Bank_Account_Number";>IBAN - (International Bank Account Number)</ulink></acronym> are not currently used + The Account Number and the <ulink + url="https://en.wikipedia.org/wiki/International_Bank_Account_Number";><acronym>IBAN</acronym> + (International Bank Account Number)</ulink> are not currently used by &kmymoney;. These fields may be left blank and filled in at a later time; they are only required for online banking. </para> diff --git a/doc/details-database.docbook b/doc/details-database.docbook index f4feeeef2..72a4e51ce 100644 --- a/doc/details-database.docbook +++ b/doc/details-database.docbook @@ -55,7 +55,7 @@ In addition to the database software itself, you must also install the corresponding &Qt; driver module. Most distributions will include driver modules for the more popular databases. Otherwise, check with the <ulink - url="http://qt-project.org";>&Qt; software web site</ulink> and search for + url="https://www.qt.io/";>&Qt; software web site</ulink> and search for 'SQL drivers' </para> @@ -135,8 +135,8 @@ <para> Using &kmymoney;, open or import an existing data file, or create a new - one. Then select <guimenuitem>Save as Database</guimenuitem> from the - <guimenu>File</guimenu> menu. This will present the following dialog: + one. Then select <menuchoice><guimenu>File</guimenu><guimenuitem>Save as Database</guimenuitem></menuchoice> + menu item. This will present the following dialog: </para> <screenshot> @@ -160,7 +160,7 @@ This box lists all &Qt; SQL drivers installed on your system. Select the driver for your database type. If the one you want is not in the list, you need to install the appropriate driver. See your distribution documentation, - or visit the <ulink url="http://qt-project.org/"; type="">&Qt; software web + or visit the <ulink url="https://www.qt.io/"; type="">&Qt; software web site</ulink> and search for 'SQL drivers'. </para> </sect3> @@ -218,8 +218,8 @@ <title>Table design</title> <para> - To access your data in &kmymoney;, use the <guimenuitem>Open - Database</guimenuitem> entry in the <guimenu>File</guimenu> menu. This will + To access your data in &kmymoney;, use the <menuchoice><guimenu>File</guimenu><guimenuitem>Open + Database</guimenuitem></menuchoice> menu item. This will open a dialog similar to the above. </para> diff --git a/doc/details-formats.docbook b/doc/details-formats.docbook index 08f8c71c8..f0bafef06 100644 --- a/doc/details-formats.docbook +++ b/doc/details-formats.docbook @@ -121,7 +121,7 @@ <para> The details about how to generate a key-pair and how to take care of it are beyond the scope of this document. A Mini Howto on this subject can be found - at <ulink url="http://www.gnupg.org/documentation/howtos.en.html";>http://www.gnupg.org/documentation/howtos.en.html</ulink>. + at <ulink url="https://www.gnupg.org/documentation/howtos.en.html";>https://www.gnupg.org/documentation/howtos.en.html</ulink>. </para> </sect2> diff --git a/doc/details-impexp-csv.docbook b/doc/details-impexp-csv.docbook index 60f03fd5a..05adc74e0 100644 --- a/doc/details-impexp-csv.docbook +++ b/doc/details-impexp-csv.docbook @@ -36,8 +36,8 @@ source files. Once the distro package is installed, or the source files are compiled and installed, the menu choice to import CSV files will automatically show up under the - <menuchoice><guimenu>File</guimenu><guimenuitem>Import</guimenuitem></menuchoice> - menu. + <menuchoice><guimenu>File</guimenu><guisubmenu>Import</guisubmenu></menuchoice> + submenu. </para> <para> @@ -65,7 +65,7 @@ <para> To import a CSV file, choose the importer from the menu bar: - <menuchoice><guimenu>File</guimenu><guimenuitem>Import</guimenuitem><guimenuitem>CSV...</guimenuitem></menuchoice>. + <menuchoice><guimenu>File</guimenu><guisubmenu>Import</guisubmenu> <guimenuitem>CSV...</guimenuitem></menuchoice>. If CSV does not show up under Import, you do not have the CSV Importer Plugin installed correctly. Please see the previous section. </para> diff --git a/doc/details-impexp-csvexp.docbook b/doc/details-impexp-csvexp.docbook index ac2348b2a..bfff73ca9 100644 --- a/doc/details-impexp-csvexp.docbook +++ b/doc/details-impexp-csvexp.docbook @@ -1,9 +1,10 @@ <sect1 id="details.impexp.csvexp"> <title>CSV Exporter</title> <para> - To export one of your accounts to a CSV file, choose - the <menuchoice><guimenuitem>Export</guimenuitem> <guimenuitem>CSV</guimenuitem></menuchoice> from - the <guimenu>File</guimenu> menu. You will be prompted for some options. + To export one of your accounts to a CSV file, choose the + <menuchoice><guimenu>File</guimenu><guisubmenu>Export</guisubmenu> + <guimenuitem>CSV...</guimenuitem></menuchoice> menu item. You will + be prompted for some options. </para> <para> diff --git a/doc/details-impexp.docbook b/doc/details-impexp.docbook index 4fa06d0e5..528722a15 100644 --- a/doc/details-impexp.docbook +++ b/doc/details-impexp.docbook @@ -49,7 +49,7 @@ <guimenu>File</guimenu><guimenuitem>Open</guimenuitem> </menuchoice> or <menuchoice> - <guimenu>File</guimenu><guimenuitem>Import</guimenuitem> + <guimenu>File</guimenu><guisubmenu>Import</guisubmenu> </menuchoice> menu items. </para> @@ -584,9 +584,8 @@ <para> To import a QIF file, first ensure you have a valid &kmymoney; file open. - Then select <menuchoice><guimenuitem>Import</guimenuitem> - <guimenuitem>QIF...</guimenuitem> </menuchoice> from - the <guimenu>File</guimenu> menu. + Then select <menuchoice><guimenu>File</guimenu><guisubmenu>Import</guisubmenu> + <guimenuitem>QIF...</guimenuitem> </menuchoice> menu item. </para> <para> @@ -884,9 +883,10 @@ <title>QIF Exporter</title> <para> To export one of your accounts to a QIF file, choose - the <menuchoice><guimenuitem>Export</guimenuitem> <guimenuitem>QIF</guimenuitem></menuchoice> from - the <guimenu>File</guimenu> menu. You will be prompted for which single - account to export, what file to export it to, and what QIF Profile to use. + the <menuchoice><guimenu>File</guimenu><guisubmenu>Export</guisubmenu> + <guimenuitem>QIF...</guimenuitem></menuchoice> menu item. You will be prompted for + which single account to export, what file to export it to, and what QIF Profile + to use. </para> <note><para> @@ -922,7 +922,7 @@ not built into the core program. You must obtain and install the OFX Importer Plugin. Once that is installed, the command to import OFX files will automatically show up under the <menuchoice><guimenu>File</guimenu> - <guimenuitem>Import</guimenuitem></menuchoice> menu. + <guisubmenu>Import</guisubmenu></menuchoice> submenu. </para> <para> @@ -955,7 +955,7 @@ <para> OFX stands for <quote>Open Financial Exchange</quote>. According to the - <ulink url="http://www.ofx.net/";>OFX web site</ulink> <quote>Open Financial + <ulink url="https://www.ofx.net/";>OFX web site</ulink> <quote>Open Financial Exchange (OFX) is a unified specification for the electronic exchange of financial data between financial institutions, businesses and consumers via the Internet. OFX is not a financial institution.</quote> The specification @@ -975,7 +975,7 @@ </para> <para> - Another site with good information is <ulink url="http:/ofxhome.com/">OFX + Another site with good information is <ulink url="https:/ofxhome.com/">OFX Home</ulink>. They maintain a directory of financial institutions that support OFX. This can be useful if you have problems setting up <link linkend="details.impexp.ofxdirectconnect">OFX direct connect.</link> They also @@ -988,11 +988,10 @@ <para> The most basic way to import an OFX file is to choose the importer from the - menu bar. From the <guimenu>File</guimenu> menu, - choose <guimenuitem>Import</guimenuitem>, and - then <guimenuitem>OFX...</guimenuitem>. If OFX does not show up under Import, - you do not have the OFX Importer Plugin installed correctly. Please see the - previous section. + menu bar. From the <menuchoice><guimenu>File</guimenu><guisubmenu>Import</guisubmenu> + <guimenuitem>OFX...</guimenuitem></menuchoice> menu item. If OFX does not show + up under Import, you do not have the OFX Importer Plugin installed correctly. + Please see the previous section. </para> <para> diff --git a/doc/details-institutions.docbook b/doc/details-institutions.docbook index bb81c1345..a27918493 100644 --- a/doc/details-institutions.docbook +++ b/doc/details-institutions.docbook @@ -213,7 +213,7 @@ optional. As with the personal information dialog, this data is not currently used by &kmymoney;, but will be required by future releases for certain features. In particular, the Routing Number and the <acronym><ulink - url="http://en.wikipedia.org/wiki/ISO_9362";>BIC (Bank Identifier + url="https://en.wikipedia.org/wiki/ISO_9362";>BIC (Bank Identifier Code)</ulink></acronym> will be required for online banking. </para> </sect2> diff --git a/doc/details-investments.docbook b/doc/details-investments.docbook index c0b29a398..231d4bef7 100644 --- a/doc/details-investments.docbook +++ b/doc/details-investments.docbook @@ -560,7 +560,7 @@ <para> At your request, &kmymoney; will fetch a page from the web that contains the latest price for each security. By default, prices are fetched from - <ulink url="http://finance.yahoo.com";>finance.yahoo.com</ulink>, and are + <ulink url="https://finance.yahoo.com";>finance.yahoo.com</ulink>, and are subject to the terms and conditions of that site. </para> @@ -575,7 +575,7 @@ <para> To find the trading symbol for a security supported by Yahoo, use the <quote>Symbol Lookup</quote> feature - at <ulink url="http://finance.yahoo.com";>finance.yahoo.com</ulink>. + at <ulink url="https://finance.yahoo.com";>finance.yahoo.com</ulink>. </para> </sect3> @@ -705,7 +705,7 @@ <para> The page parser looks for a symbol, a date, and a price. Regular expressions tell it how to extract those items from the page. Please review the documentation for - the <ulink url="http://qt-project.org/doc/qt-4.8/qregexp.html#1";>QRegExp + the <ulink url="https://doc.qt.io/qt-5/qregexp.html";>QRegExp class</ulink> for the exact syntax regular expressions used by &kmymoney;. There should be exactly one capture expression, surrounded by parentheses, in each regexp field. The date format further tells the date parser the order of year, month, and diff --git a/doc/details-search.docbook b/doc/details-search.docbook index acc43ecff..4ebbaef71 100644 --- a/doc/details-search.docbook +++ b/doc/details-search.docbook @@ -115,7 +115,7 @@ If you check the <guilabel>Treat Text as regular expression</guilabel> box, the text will be treated as a regular expression. For details on how to craft a regular expression, visit the &Qt; documentation about the - <ulink url="http://qt-project.org/doc/qt-4.8/qregexp.html#1";>QRegExp + <ulink url="https://doc.qt.io/qt-5/qregexp.html";>QRegExp class</ulink>. </para> </sect2> diff --git a/doc/faq.docbook b/doc/faq.docbook index be88e26f6..9bf7bbf41 100644 --- a/doc/faq.docbook +++ b/doc/faq.docbook @@ -179,10 +179,9 @@ <para>There is no global search and replace function in KMyMoney. Nevertheless, it is easy to change a payees name: select the Payees view and find the entry with the name you want to change. Click with the &RMB; on the - payee, and select <menuchoice><guimenuitem>Rename - payee</guimenuitem></menuchoice>. Enter the new name. Since the transactions - only use a reference to the payees record, all transactions now show the new - name.</para> + payee, and select <guimenuitem>Rename payee</guimenuitem> from de context menu. + Enter the new name. Since the transactions only use a reference to the payees + record, all transactions now show the new name.</para> </answer> </qandaentry> @@ -210,8 +209,8 @@ </question> <answer> <para>Here are some external sources which might give your more information: - <ulink url="http://ofxblog.wordpress.com/";>ofxblog</ulink> and <ulink - url="http://www.ofxhome.com/";>ofxhome</ulink>.</para> + <ulink url="https://ofxblog.wordpress.com/";>OFX Blog</ulink> and <ulink + url="https://www.ofxhome.com/";>OFX Home</ulink>.</para> </answer> </qandaentry> @@ -230,7 +229,7 @@ Translating &kde;/&Qt;-based applications is very simple, and does not require any programming skills. If you would like to translate &kmymoney; into your language, please post a message to the proper <ulink - url="http://l10n.kde.org/teams-list.php";>team mailing list</ulink>. Should + url="https://l10n.kde.org/teams-list.php";>team mailing list</ulink>. Should you fail to find your language in the list or could not contact the team members please mail directly to the <ulink url="mailto:kde-i18n-...@kde.org";>KDE translation mailing list</ulink> (<ulink diff --git a/doc/firsttime.docbook b/doc/firsttime.docbook index 0e80a8d86..3b409af7e 100644 --- a/doc/firsttime.docbook +++ b/doc/firsttime.docbook @@ -53,7 +53,7 @@ <para> All tips have been extracted from the Frequently Asked Questions list (&FAQ;) that provides more detailed help and can be found on the project <ulink - url="http://www.kmymoney.org/faq.php";>website</ulink> and in <link + url="https://www.kmymoney.org/faq.php";>website</ulink> and in <link linkend="faq">this manual</link>. </para> @@ -68,7 +68,7 @@ this manual. Many details, such as fonts, colors, and icons, can be customized, either using the <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure - &kmymoney;...</guimenuitem></menuchoice> dialog or the &kde; &systemsettings; + &kmymoney;...</guimenuitem></menuchoice> menu item or the &kde; &systemsettings; application, depending on your operating system. </para> </note> @@ -357,7 +357,7 @@ <para> To create a new file you can either select <menuchoice><guimenu>File</guimenu><guimenuitem>New</guimenuitem></menuchoice> - from the menu or choose the <inlinemediaobject><imageobject><imagedata + menu item or choose the <inlinemediaobject><imageobject><imagedata fileref="new.png"/></imageobject><textobject><phrase>New</phrase></textobject></inlinemediaobject> icon from the toolbar. In addition, if the main welcome page is displayed, you can also select the first link: "Get started and setup accounts." @@ -560,7 +560,7 @@ <para> To create an account using the menu select <menuchoice><guimenu>Accounts</guimenu><guimenuitem>New - account</guimenuitem></menuchoice>. + account</guimenuitem></menuchoice> menu item. </para> </listitem> </varlistentry> @@ -775,8 +775,8 @@ <para> To backup your file through &kmymoney; Select - <guimenuitem>Backup</guimenuitem> from the <guimenu>File</guimenu> menu and - enter the folder where you wish the file to be saved. If the folder + <menuchoice><guimenu>File</guimenu><guimenuitem>Backup</guimenuitem></menuchoice> + menu item and enter the folder where you wish the file to be saved. If the folder needs mounting first and you have the sufficient privileges then check the tick box labeled <guilabel>Mount this directory before backing up</guilabel> and click on <guibutton>OK</guibutton>. @@ -836,7 +836,7 @@ tell it where you have put the data file, either by running from the command line, or from the <menuchoice><guimenu>File</guimenu><guimenuitem>Open...</guimenuitem></menuchoice> - menu. You should even be able to move between &Windows;, &MacOS;, and &Linux; systems. + menu item. You should even be able to move between &Windows;, &MacOS;, and &Linux; systems. </para> <para> @@ -894,7 +894,7 @@ Note that when upgrading from a previous version to version 5.0 or higher, the location of the template files used by the plugin for printing checks has changed. Please consult the release notes or the project <ulink - url="http://www.kmymoney.org/faq.php";>website</ulink> for more details. + url="https://www.kmymoney.org/faq.php";>website</ulink> for more details. </para> <note> @@ -938,10 +938,10 @@ <para> To report a bug please use the interface provided by &kmymoney; by selecting <menuchoice><guimenu>Help</guimenu><guimenuitem>Report - Bug</guimenuitem></menuchoice> and filling in the required information. + Bug</guimenuitem></menuchoice> menu item and filling in the required information. However, in case you have any difficulties with that method, you can report a bug (or file a wish-list or enhancement request) directly at the <ulink - url="http://bugs.kde.org";>&kde; bug reporting web site</ulink>. Reports + url="https://bugs.kde.org";>&kde; bug reporting web site</ulink>. Reports should be filed against the product <quote>kmymoney</quote>. </para> @@ -963,14 +963,14 @@ <para> Eli Goldberg wrote the canonical Bug-Writing Guideline, available at <ulink - url="http://issues.apache.org/bugwritinghelp.html";>http://issues.apache.org/bugwritinghelp.html</ulink>. + url="https://issues.apache.org/bugwritinghelp.html";>https://issues.apache.org/bugwritinghelp.html</ulink>. Generally, you'll be well-served by following these guidelines: </para> <formalpara><title>Include your system information</title> <para> The <menuchoice><guimenu>Help</guimenu><guimenuitem>Report - Bug</guimenuitem></menuchoice> menu choice will fill this in automatically, + Bug</guimenuitem></menuchoice> menu item will fill this in automatically, but if you would prefer not to use this interface, there are several items you need to include in the report. We will need to know what operating system you are using (&Linux;, &MacOS;, or &Windows;), the version of &kde;, diff --git a/doc/introduction.docbook b/doc/introduction.docbook index e5284a832..063edffd3 100644 --- a/doc/introduction.docbook +++ b/doc/introduction.docbook @@ -34,7 +34,7 @@ </listitem> <listitem> - <formalpara><title>Ease of Use.</title> + <formalpara><title>Ease of Use</title> <para> &kmymoney; strives to be the easiest open source personal finance manager to use, especially for the non-technical user. @@ -43,7 +43,7 @@ </listitem> <listitem> - <formalpara><title>Correctness.</title> + <formalpara><title>Correctness</title> <para> Based on tried and tested double entry accounting principles &kmymoney; ensures that your finances are kept in correct order. diff --git a/doc/makemostof.docbook b/doc/makemostof.docbook index df459b19b..890c8bac9 100644 --- a/doc/makemostof.docbook +++ b/doc/makemostof.docbook @@ -35,7 +35,7 @@ <para> You have some money in the pot marked <quote>Cash</quote>. You buy some goods, so you take some beans out of the cash pot and place them into another pot - marked <quote>Supplier.</quote> The supplier gives you some goods in exchange + marked <quote>Supplier</quote>. The supplier gives you some goods in exchange for the cash, so you take the beans out of the pot marked <quote>Supplier</quote> and put them in the pot marked <quote>Goods</quote>. </para> @@ -49,8 +49,8 @@ In this case you have two movements of beans, or transactions. Each transaction needs two entries, one to take beans out and one to put beans in. This is called <quote>double entry bookkeeping</quote> or <quote>double - entry accounting.</quote> The recording of the transactions is done in a - <quote>Ledger;</quote> each pot is known as an <quote>Account</quote> or + entry accounting</quote>. The recording of the transactions is done in a + <quote>Ledger</quote>; each pot is known as an <quote>Account</quote> or <quote>Ledger code</quote>. </para> @@ -59,7 +59,7 @@ in exchange. The goods were worth some beans and, hopefully, the customer has given us more beans than that, so making a profit. To over simplify, the beans from the Goods pot come back as Cash, but we can split that as the <quote>Cost - of Goods sold</quote> and <quote>Profit.</quote> This transaction has three + of Goods sold</quote> and <quote>Profit</quote>. This transaction has three entries; one side of the <quote>double entry</quote> has been split. </para> @@ -75,16 +75,16 @@ <title>Defining the accounts (personal records)</title> <para> - Most accounts, or pots, above represent a measure of our <quote>Worth.</quote> - The cash and goods represent our <quote>Assets;</quote> so does what we are + Most accounts, or pots, above represent a measure of our <quote>Worth</quote>. + The cash and goods represent our <quote>Assets</quote>; so does what we are owed if our customers have not yet given us the money. The money we owe, say - if we had not paid our suppliers, are our <quote>Liabilities.</quote> These + if we had not paid our suppliers, are our <quote>Liabilities</quote>. These accounts are transferable to Cash and have a value. </para> <para> Any pots that cannot be valued are <quote>Income</quote> or - <quote>Expense.</quote> Our phone bill (or the phone company to which we pay + <quote>Expense</quote>. Our phone bill (or the phone company to which we pay the bill) cannot be valued; we know how much we have paid, but not how much anyone else has paid. We know how much our employer has paid us, but we do not know how much they have paid anybody else, or how much money they have @@ -95,7 +95,7 @@ <para> In some cases a supplier is a <quote>Liability,</quote> in others it is an - <quote>Expense.</quote> This is something we need to consider and decide for + <quote>Expense</quote>. This is something we need to consider and decide for each case. Similarly, you may set up a loan as a Liability, particularly if you transfer the money into your bank account, but it could be an Expense if it was to buy some furniture. diff --git a/doc/reference.docbook b/doc/reference.docbook index 54cfdb81d..38d311794 100644 --- a/doc/reference.docbook +++ b/doc/reference.docbook @@ -110,7 +110,7 @@ <varlistentry> <term><menuchoice> <guimenu>File</guimenu> - <guimenuitem>Import</guimenuitem> + <guisubmenu>Import</guisubmenu> <guimenuitem>...</guimenuitem> </menuchoice></term> <listitem> diff --git a/doc/whatsnew.docbook b/doc/whatsnew.docbook index cdfa38b0c..ffa3e27e4 100644 --- a/doc/whatsnew.docbook +++ b/doc/whatsnew.docbook @@ -42,7 +42,7 @@ The program searches for the templates for the printcheck plugin in different locations. The user needs to account for this in the plugins setting dialog, <link linkend="details.settings.plugins">see this section for - more details.</link> + more details</link>. </para></listitem> </itemizedlist> </sect1>
