[Libreoffice-commits] help.git: AllLangHelp_sbasic.mk source/auxiliary source/text

Mon Jul 24 11:19:58 UTC 2017

AllLangHelp_sbasic.mk                          |    1 
 source/auxiliary/sbasic.tree                   |    1 
 source/text/sbasic/shared/03140010.xhp         |   77 +++++++++++++++++++++++++
 source/text/sbasic/shared/special_vba_func.xhp |    4 -
 4 files changed, 80 insertions(+), 3 deletions(-)

New commits:
commit 9411338fe715ff1c7190ec0761b5b54d40f1f5fb
Author: Olivier Hallot <olivier.hallot at libreoffice.org>
Date:   Mon Jul 24 00:54:24 2017 -0300

    tdf#108678 Help page for VBA function Rate
    
    Change-Id: Ied97ddb4654817c705108b77a62dedcf3b001e34
    Reviewed-on: https://gerrit.libreoffice.org/40352
    Reviewed-by: Olivier Hallot <olivier.hallot at edx.srv.br>
    Tested-by: Olivier Hallot <olivier.hallot at edx.srv.br>

diff --git a/AllLangHelp_sbasic.mk b/AllLangHelp_sbasic.mk
index d2c2ee8cb..d576d7aa4 100644
--- a/AllLangHelp_sbasic.mk
+++ b/AllLangHelp_sbasic.mk
@@ -334,6 +334,7 @@ $(eval $(call gb_AllLangHelp_add_helpfiles,sbasic,\
     helpcontent2/source/text/sbasic/shared/03140007 \
     helpcontent2/source/text/sbasic/shared/03140008 \
     helpcontent2/source/text/sbasic/shared/03140009 \
+    helpcontent2/source/text/sbasic/shared/03140010 \
     helpcontent2/source/text/sbasic/shared/05060700 \
     helpcontent2/source/text/sbasic/shared/code-stubs \
     helpcontent2/source/text/sbasic/shared/keys \
diff --git a/source/auxiliary/sbasic.tree b/source/auxiliary/sbasic.tree
index 04ec3e5a6..26531c192 100644
--- a/source/auxiliary/sbasic.tree
+++ b/source/auxiliary/sbasic.tree
@@ -212,6 +212,7 @@
 <topic id="sbasic/text/sbasic/shared/03103400.xhp">Public Statement [Runtime]</topic>
 <topic id="sbasic/text/sbasic/shared/03020204.xhp">Put Statement [Runtime]</topic>
 <topic id="sbasic/text/sbasic/shared/03010304.xhp">QBColor Function [Runtime]</topic>
+<topic id="sbasic/text/sbasic/shared/03140010.xhp">Rate Function [Runtime - VBA]</topic>
 <topic id="sbasic/text/sbasic/shared/03010305.xhp">RGB Function [Runtime]</topic>
 <topic id="sbasic/text/sbasic/shared/03120308.xhp">RSet Statement [Runtime]</topic>
 <topic id="sbasic/text/sbasic/shared/03120309.xhp">RTrim Function [Runtime]</topic>
diff --git a/source/text/sbasic/shared/03140010.xhp b/source/text/sbasic/shared/03140010.xhp
new file mode 100644
index 000000000..30767b726
--- /dev/null
+++ b/source/text/sbasic/shared/03140010.xhp
@@ -0,0 +1,77 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<helpdocument version="1.0">
+<!--
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ *   Licensed to the Apache Software Foundation (ASF) under one or more
+ *   contributor license agreements. See the NOTICE file distributed
+ *   with this work for additional information regarding copyright
+ *   ownership. The ASF licenses this file to you under the Apache
+ *   License, Version 2.0 (the "License"); you may not use this file
+ *   except in compliance with the License. You may obtain a copy of
+ *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
+-->
+
+<meta>
+  <topic id="textsbasicshared03140010xml" indexer="include" status="PUBLISH">
+    <title id="tit" xml-lang="en-US">Rate Function [Runtime - VBA]</title>
+    <filename>/text/sbasic/shared/03140010.xhp</filename>
+  </topic>
+</meta>
+
+<body>
+
+
+<section id="rate">
+<bookmark xml-lang="en-US" branch="index" id="bm_id3150499">
+  <bookmark_value>Rate function</bookmark_value>
+</bookmark>
+
+
+<paragraph id="hd_id3150499" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03140010.xhp" name="Rate Function [Runtime - VBA]">Rate Function [Runtime - VBA]</link></paragraph>
+<paragraph id="par_id3151384" role="paragraph" xml-lang="en-US">Returns the Present Value of an investment resulting from a series of regular payments.</paragraph>
+</section>
+<embed href="text/sbasic/shared/00000003.xhp#vbasupport"/>
+<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/>
+<bascode>
+<paragraph id="par_id3143267" role="bascode" localize="false" xml-lang="en-US">Pmt( NPer as Double, Pmt as Double, PV as Double [FV as Variant], [Due as Variant], [Guess as Variant] )</paragraph>
+</bascode>
+<embed href="text/sbasic/shared/00000003.xhp#functvalue"/>
+<paragraph id="par_id3150669" role="paragraph" localize="false" xml-lang="en-US">Double</paragraph>
+<embed href="text/sbasic/shared/00000003.xhp#functparameters"/>
+<paragraph id="par_id061420170420248911" role="paragraph" xml-lang="en-US"><emph>NPer</emph> is the total number of periods, during which annuity is paid.</paragraph>
+<paragraph id="par_id061420170420246794" role="paragraph" xml-lang="en-US"><emph>Pmt</emph> is the regular payment made per period.</paragraph>
+<paragraph id="par_id061620170603217534" role="paragraph" xml-lang="en-US"><emph>PV</emph> is the present value of the loan / investment.</paragraph>
+<paragraph id="par_id061620170603217534" role="paragraph" xml-lang="en-US"><emph>FV</emph> (optional) is the future value of the loan / investment.</paragraph>
+<paragraph id="par_id061420170420241932" role="paragraph" xml-lang="en-US"><emph>Due</emph> (optional) defines whether the payment is due at the beginning or the end of a period.</paragraph>
+<paragraph id="par_id0614201704292615" role="paragraph" xml-lang="en-US">0 - the payment is due at the end of the period;</paragraph>
+<paragraph id="par_id061420170429263061" role="paragraph" xml-lang="en-US">1 - the payment is due at the beginning of the period.</paragraph>
+<paragraph id="par_id240720170028547253" role="paragraph" xml-lang="en-US"><emph>Guess</emph>(optional) determines the estimated value of the interest with iterative calculation.</paragraph>
+<embed href="text/sbasic/shared/00000003.xhp#errorcode"/>
+<embed href="text/sbasic/shared/00000003.xhp#err5"/>
+<embed href="text/sbasic/shared/00000003.xhp#functexample"/>
+<bascode>
+<paragraph id="par_id240720170039054844" role="bascode" localize="false" xml-lang="en-US">REM ***** BASIC *****</paragraph>
+<paragraph id="par_id240720170039053945" role="bascode" localize="false" xml-lang="en-US">Option VBASupport 1</paragraph>
+<paragraph id="par_id240720170039056433" role="bascode" localize="false" xml-lang="en-US">Sub ExampleRate</paragraph>
+<paragraph id="par_id240720170039056654" role="bascode" xml-lang="en-US">' Calculate the interest rate required to pay off a loan of $100,000 over</paragraph>
+<paragraph id="par_id240720170039057978" role="bascode" xml-lang="en-US">' 6 years, with payments of $1,500, due at the end of each month.</paragraph>
+<paragraph id="par_id240720170039054755" role="bascode" localize="false" xml-lang="en-US"> Dim mRate As Double</paragraph>
+<paragraph id="par_id240720170039052259" role="bascode" localize="false" xml-lang="en-US"> mRate = Rate( 72, -1500, 100000 )</paragraph>
+<paragraph id="par_id240720170039052476" role="bascode" xml-lang="en-US"> print mRate' mRate is calculated to be 0.00213778025343334</paragraph>
+<paragraph id="par_id240720170039056365" role="bascode" localize="false" xml-lang="en-US">End sub</paragraph>
+</bascode>
+
+<section id="relatedtopics">
+<paragraph id="par_id061420170153186192" role="paragraph" xml-lang="en-US"><link href="text/scalc/01/04060118.xhp#bm_id3154267">RATE function in CALC</link></paragraph>
+<embed href="text/sbasic/shared/00000003.xhp#VBA-Financial"/>
+</section>
+</body>
+
+</helpdocument>
\ No newline at end of file
diff --git a/source/text/sbasic/shared/special_vba_func.xhp b/source/text/sbasic/shared/special_vba_func.xhp
index 39f33a57f..dd4998ba0 100644
--- a/source/text/sbasic/shared/special_vba_func.xhp
+++ b/source/text/sbasic/shared/special_vba_func.xhp
@@ -64,12 +64,10 @@
 <embed href="text/sbasic/shared/03140007.xhp#pmt"/>
 <embed href="text/sbasic/shared/03140008.xhp#ppmt"/>
 <embed href="text/sbasic/shared/03140009.xhp#pv"/>
+<embed href="text/sbasic/shared/03140010.xhp#rate"/>
 
 <list type="unordered">
   <listitem>
-    <paragraph id="par_id051820170335292174" role="paragraph" localize="false" xml-lang="en-US">Rate</paragraph>
-  </listitem>
-  <listitem>
     <paragraph id="par_id051820170335295504" role="paragraph" localize="false" xml-lang="en-US">SLN</paragraph>
   </listitem>
   <listitem>
