summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSteve Fanning <stevemfanning@yahoo.co.uk>2020-05-31 11:19:59 +0200
committerOlivier Hallot <olivier.hallot@libreoffice.org>2020-06-08 18:55:07 +0200
commit0c2b19daf2c1d08c53398f82da914e87aa4373f1 (patch)
tree8837683ab717c49346c0f0a924b1b74329dd3d5b
parent(func_color.xhp) Include square brackets in syntax section to indicate option... (diff)
downloadhelp-0c2b19daf2c1d08c53398f82da914e87aa4373f1.zip
help-0c2b19daf2c1d08c53398f82da914e87aa4373f1.tar.gz
(04060118.xhp) Include square brackets in syntax sections to indicate optional parameters.
ODF 1.2 used to confirm configuration of brackets for FV(), NPER(),and RATE(). Change-Id: I7b109974d3e1dbc6670c32628a5425741d882f4e Reviewed-on: https://gerrit.libreoffice.org/c/help/+/95208 Tested-by: Jenkins Reviewed-by: Olivier Hallot <olivier.hallot@libreoffice.org> (cherry picked from commit cf09e34b35c8f0803ecfb5151bdbf1a1cf1ccc68) Reviewed-on: https://gerrit.libreoffice.org/c/help/+/95728 Reviewed-by: Ilmari Lauhakangas <ilmari.lauhakangas@libreoffice.org>
-rw-r--r--source/text/scalc/01/04060118.xhp34
1 files changed, 17 insertions, 17 deletions
diff --git a/source/text/scalc/01/04060118.xhp b/source/text/scalc/01/04060118.xhp
index 850d2b1..a51d0cf 100644
--- a/source/text/scalc/01/04060118.xhp
+++ b/source/text/scalc/01/04060118.xhp
@@ -43,7 +43,7 @@
<paragraph id="par_id3147250" role="paragraph" xml-lang="en-US"><ahelp hid="HID_AAI_FUNC_ODDFPRICE">Calculates the price per 100 currency units par value of a security, if the first interest date falls irregularly.</ahelp></paragraph>
<embed href="text/scalc/01/common_func.xhp#sectionsyntax"/>
-<paragraph id="par_id3146098" role="code" xml-lang="en-US">ODDFPRICE(Settlement; Maturity; Issue; FirstCoupon; Rate; Yield; Redemption; Frequency; Basis)</paragraph>
+<paragraph id="par_id3146098" role="code" xml-lang="en-US">ODDFPRICE(Settlement; Maturity; Issue; FirstCoupon; Rate; Yield; Redemption; Frequency [; Basis])</paragraph>
<paragraph id="par_id3153337" role="paragraph" xml-lang="en-US"><emph>Settlement</emph> is the date of purchase of the security.</paragraph>
<paragraph id="par_id3149051" role="paragraph" xml-lang="en-US"><emph>Maturity</emph> is the date on which the security matures (expires).</paragraph>
<paragraph id="par_id3147297" role="paragraph" xml-lang="en-US"><emph>Issue</emph> is the date of issue of the security.</paragraph>
@@ -66,7 +66,7 @@
<paragraph id="par_id3147414" role="paragraph" xml-lang="en-US"><ahelp hid="HID_AAI_FUNC_ODDFYIELD">Calculates the yield of a security if the first interest date falls irregularly.</ahelp></paragraph>
<embed href="text/scalc/01/common_func.xhp#sectionsyntax"/>
-<paragraph id="par_id3152982" role="code" xml-lang="en-US">ODDFYIELD(Settlement; Maturity; Issue; FirstCoupon; Rate; Price; Redemption; Frequency; Basis)</paragraph>
+<paragraph id="par_id3152982" role="code" xml-lang="en-US">ODDFYIELD(Settlement; Maturity; Issue; FirstCoupon; Rate; Price; Redemption; Frequency [; Basis])</paragraph>
<paragraph id="par_id3157906" role="paragraph" xml-lang="en-US"><emph>Settlement</emph> is the date of purchase of the security.</paragraph>
<paragraph id="par_id3150026" role="paragraph" xml-lang="en-US"><emph>Maturity</emph> is the date on which the security matures (expires).</paragraph>
<paragraph id="par_id3149012" role="paragraph" xml-lang="en-US"><emph>Issue</emph> is the date of issue of the security.</paragraph>
@@ -89,7 +89,7 @@
<paragraph id="par_id3145145" role="paragraph" xml-lang="en-US"><ahelp hid="HID_AAI_FUNC_ODDLPRICE">Calculates the price per 100 currency units par value of a security, if the last interest date falls irregularly.</ahelp></paragraph>
<embed href="text/scalc/01/common_func.xhp#sectionsyntax"/>
-<paragraph id="par_id3155262" role="code" xml-lang="en-US">ODDLPRICE(Settlement; Maturity; LastInterest; Rate; Yield; Redemption; Frequency; Basis)</paragraph>
+<paragraph id="par_id3155262" role="code" xml-lang="en-US">ODDLPRICE(Settlement; Maturity; LastInterest; Rate; Yield; Redemption; Frequency [; Basis])</paragraph>
<paragraph id="par_id3149689" role="paragraph" xml-lang="en-US"><emph>Settlement</emph> is the date of purchase of the security.</paragraph>
<paragraph id="par_id3148753" role="paragraph" xml-lang="en-US"><emph>Maturity</emph> is the date on which the security matures (expires).</paragraph>
<paragraph id="par_id3150861" role="paragraph" xml-lang="en-US"><emph>LastInterest</emph> is the last interest date of the security.</paragraph>
@@ -116,7 +116,7 @@
<paragraph id="par_id3158002" role="paragraph" xml-lang="en-US"><ahelp hid="HID_AAI_FUNC_ODDLYIELD">Calculates the yield of a security if the last interest date falls irregularly.</ahelp></paragraph>
<embed href="text/scalc/01/common_func.xhp#sectionsyntax"/>
-<paragraph id="par_id3150018" role="code" xml-lang="en-US">ODDLYIELD(Settlement; Maturity; LastInterest; Rate; Price; Redemption; Frequency; Basis)</paragraph>
+<paragraph id="par_id3150018" role="code" xml-lang="en-US">ODDLYIELD(Settlement; Maturity; LastInterest; Rate; Price; Redemption; Frequency [; Basis])</paragraph>
<paragraph id="par_id3159132" role="paragraph" xml-lang="en-US"><emph>Settlement</emph> is the date of purchase of the security.</paragraph>
<paragraph id="par_id3150134" role="paragraph" xml-lang="en-US"><emph>Maturity</emph> is the date on which the security matures (expires).</paragraph>
<paragraph id="par_id3145245" role="paragraph" xml-lang="en-US"><emph>LastInterest</emph> is the last interest date of the security.</paragraph>
@@ -145,7 +145,7 @@
<paragraph id="par_id3154636" role="paragraph" xml-lang="en-US"><ahelp hid="HID_FUNC_VDB">Returns the depreciation of an asset for a specified or partial period using a variable declining balance method.</ahelp></paragraph>
<embed href="text/scalc/01/common_func.xhp#sectionsyntax"/>
-<paragraph id="par_id3149025" role="code" xml-lang="en-US">VDB(Cost; Salvage; Life; S; End; Factor; NoSwitch)</paragraph>
+<paragraph id="par_id3149025" role="code" xml-lang="en-US">VDB(Cost; Salvage; Life; S; End [; Factor [; NoSwitch]])</paragraph>
<paragraph id="par_id3150692" role="paragraph" xml-lang="en-US"><emph>Cost</emph> is the initial value of an asset.</paragraph>
<paragraph id="par_id3155369" role="paragraph" xml-lang="en-US"><emph>Salvage</emph> is the value of an asset at the end of the depreciation.</paragraph>
<paragraph id="par_id3154954" role="paragraph" xml-lang="en-US"><emph>Life</emph> is the depreciation duration of the asset.</paragraph>
@@ -174,7 +174,7 @@
<paragraph id="par_idN10E62" role="paragraph" xml-lang="en-US">If the payments take place at regular intervals, use the <link href="text/scalc/01/04060103.xhp#irr" name="IRR">IRR</link> function.</paragraph>
<embed href="text/scalc/01/common_func.xhp#sectionsyntax"/>
-<paragraph id="par_id3149826" role="code" xml-lang="en-US">XIRR(Values; Dates; Guess)</paragraph>
+<paragraph id="par_id3149826" role="code" xml-lang="en-US">XIRR(Values; Dates [; Guess])</paragraph>
<paragraph id="par_id3163821" role="paragraph" xml-lang="en-US"><emph>Values</emph> and <emph>Dates</emph> refer to a series of payments and the series of associated date values. The first pair of dates defines the start of the payment plan. All other date values must be later, but need not be in any order. The series of values must contain at least one negative and one positive value (receipts and deposits).</paragraph>
<paragraph id="par_id3149708" role="paragraph" xml-lang="en-US"><emph>Guess</emph> (optional) is a guess that can be input for the internal rate of return. The default is 10%.</paragraph>
@@ -324,7 +324,7 @@
<paragraph id="par_id3151052" role="paragraph" xml-lang="en-US"><ahelp hid="HID_FUNC_ZINS">Returns the constant interest rate per period of an annuity.</ahelp></paragraph>
<embed href="text/scalc/01/common_func.xhp#sectionsyntax"/>
-<paragraph id="par_id3158423" role="code" xml-lang="en-US">RATE(NPer; Pmt; PV; FV; Type; Guess)</paragraph>
+<paragraph id="par_id3158423" role="code" xml-lang="en-US">RATE(NPer; Pmt; PV [ ; [ FV ] [ ; [ Type ] [ ; Guess ] ] ])</paragraph>
<paragraph id="par_id3148910" role="paragraph" xml-lang="en-US"><emph>NPer</emph> is the total number of periods, during which payments are made (payment period).</paragraph>
<paragraph id="par_id3148925" role="paragraph" xml-lang="en-US"><emph>Pmt</emph> is the constant payment (annuity) paid during each period.</paragraph>
<paragraph id="par_id3149160" role="paragraph" xml-lang="en-US"><emph>PV</emph> is the cash value in the sequence of payments.</paragraph>
@@ -349,7 +349,7 @@
<paragraph id="par_id3149918" role="paragraph" xml-lang="en-US"><ahelp hid="HID_AAI_FUNC_INTRATE">Calculates the annual interest rate that results when a security (or other item) is purchased at an investment value and sold at a redemption value. No interest is paid.</ahelp></paragraph>
<embed href="text/scalc/01/common_func.xhp#sectionsyntax"/>
-<paragraph id="par_id3149800" role="code" xml-lang="en-US">INTRATE(Settlement; Maturity; Investment; Redemption; Basis)</paragraph>
+<paragraph id="par_id3149800" role="code" xml-lang="en-US">INTRATE(Settlement; Maturity; Investment; Redemption [; Basis])</paragraph>
<paragraph id="par_id3148618" role="paragraph" xml-lang="en-US"><emph>Settlement</emph> is the date of purchase of the security.</paragraph>
<paragraph id="par_id3148988" role="paragraph" xml-lang="en-US"><emph>Maturity</emph> is the date on which the security is sold.</paragraph>
<paragraph id="par_id3154604" role="paragraph" xml-lang="en-US"><emph>Investment</emph> is the purchase price.</paragraph>
@@ -372,7 +372,7 @@
<paragraph id="par_id3149927" role="paragraph" xml-lang="en-US"><ahelp hid="HID_AAI_FUNC_COUPNCD">Returns the date of the first interest date after the settlement date. Format the result as a date.</ahelp></paragraph>
<embed href="text/scalc/01/common_func.xhp#sectionsyntax"/>
-<paragraph id="par_id3150423" role="code" xml-lang="en-US">COUPNCD(Settlement; Maturity; Frequency; Basis)</paragraph>
+<paragraph id="par_id3150423" role="code" xml-lang="en-US">COUPNCD(Settlement; Maturity; Frequency [; Basis])</paragraph>
<paragraph id="par_id3150628" role="paragraph" xml-lang="en-US"><emph>Settlement</emph> is the date of purchase of the security.</paragraph>
<paragraph id="par_id3153536" role="paragraph" xml-lang="en-US"><emph>Maturity</emph> is the date on which the security matures (expires).</paragraph>
<paragraph id="par_id3145313" role="paragraph" xml-lang="en-US"><emph>Frequency</emph> is number of interest payments per year (1, 2 or 4).</paragraph>
@@ -394,7 +394,7 @@
<paragraph id="par_id3149488" role="paragraph" xml-lang="en-US"><ahelp hid="HID_AAI_FUNC_COUPDAYS">Returns the number of days in the current interest period in which the settlement date falls.</ahelp></paragraph>
<embed href="text/scalc/01/common_func.xhp#sectionsyntax"/>
-<paragraph id="par_id3149585" role="code" xml-lang="en-US">COUPDAYS(Settlement; Maturity; Frequency; Basis)</paragraph>
+<paragraph id="par_id3149585" role="code" xml-lang="en-US">COUPDAYS(Settlement; Maturity; Frequency [; Basis])</paragraph>
<paragraph id="par_id3152767" role="paragraph" xml-lang="en-US"><emph>Settlement</emph> is the date of purchase of the security.</paragraph>
<paragraph id="par_id3151250" role="paragraph" xml-lang="en-US"><emph>Maturity</emph> is the date on which the security matures (expires).</paragraph>
<paragraph id="par_id3146126" role="paragraph" xml-lang="en-US"><emph>Frequency</emph> is number of interest payments per year (1, 2 or 4).</paragraph>
@@ -416,7 +416,7 @@
<paragraph id="par_id3147100" role="paragraph" xml-lang="en-US"><ahelp hid="HID_AAI_FUNC_COUPDAYSNC">Returns the number of days from the settlement date until the next interest date.</ahelp></paragraph>
<embed href="text/scalc/01/common_func.xhp#sectionsyntax"/>
-<paragraph id="par_id3155121" role="code" xml-lang="en-US">COUPDAYSNC(Settlement; Maturity; Frequency; Basis)</paragraph>
+<paragraph id="par_id3155121" role="code" xml-lang="en-US">COUPDAYSNC(Settlement; Maturity; Frequency [; Basis])</paragraph>
<paragraph id="par_id3158440" role="paragraph" xml-lang="en-US"><emph>Settlement</emph> is the date of purchase of the security.</paragraph>
<paragraph id="par_id3146075" role="paragraph" xml-lang="en-US"><emph>Maturity</emph> is the date on which the security matures (expires).</paragraph>
<paragraph id="par_id3154620" role="paragraph" xml-lang="en-US"><emph>Frequency </emph>is number of interest payments per year (1, 2 or 4).</paragraph>
@@ -440,7 +440,7 @@
<paragraph id="par_id3146795" role="paragraph" xml-lang="en-US"><ahelp hid="HID_AAI_FUNC_COUPDAYBS">Returns the number of days from the first day of interest payment on a security until the settlement date.</ahelp></paragraph>
<embed href="text/scalc/01/common_func.xhp#sectionsyntax"/>
-<paragraph id="par_id3159083" role="code" xml-lang="en-US">COUPDAYBS(Settlement; Maturity; Frequency; Basis)</paragraph>
+<paragraph id="par_id3159083" role="code" xml-lang="en-US">COUPDAYBS(Settlement; Maturity; Frequency [; Basis])</paragraph>
<paragraph id="par_id3146907" role="paragraph" xml-lang="en-US"><emph>Settlement</emph> is the date of purchase of the security.</paragraph>
<paragraph id="par_id3159390" role="paragraph" xml-lang="en-US"><emph>Maturity</emph> is the date on which the security matures (expires).</paragraph>
<paragraph id="par_id3154414" role="paragraph" xml-lang="en-US"><emph>Frequency</emph> is the number of interest payments per year (1, 2 or 4).</paragraph>
@@ -463,7 +463,7 @@
<paragraph id="par_id3153678" role="paragraph" xml-lang="en-US"><ahelp hid="HID_AAI_FUNC_COUPPCD">Returns the date of the interest date prior to the settlement date. Format the result as a date.</ahelp></paragraph>
<embed href="text/scalc/01/common_func.xhp#sectionsyntax"/>
-<paragraph id="par_id3153790" role="code" xml-lang="en-US">COUPPCD(Settlement; Maturity; Frequency; Basis)</paragraph>
+<paragraph id="par_id3153790" role="code" xml-lang="en-US">COUPPCD(Settlement; Maturity; Frequency [; Basis])</paragraph>
<paragraph id="par_id3150989" role="paragraph" xml-lang="en-US"><emph>Settlement</emph> is the date of purchase of the security.</paragraph>
<paragraph id="par_id3154667" role="paragraph" xml-lang="en-US"><emph>Maturity</emph> is the date on which the security matures (expires).</paragraph>
<paragraph id="par_id3154569" role="paragraph" xml-lang="en-US"><emph>Frequency</emph> is the number of interest payments per year (1, 2 or 4).</paragraph>
@@ -486,7 +486,7 @@
<paragraph id="par_id3154350" role="paragraph" xml-lang="en-US"><ahelp hid="HID_AAI_FUNC_COUPNUM">Returns the number of coupons (interest payments) between the settlement date and the maturity date.</ahelp></paragraph>
<embed href="text/scalc/01/common_func.xhp#sectionsyntax"/>
-<paragraph id="par_id3153200" role="code" xml-lang="en-US">COUPNUM(Settlement; Maturity; Frequency; Basis)</paragraph>
+<paragraph id="par_id3153200" role="code" xml-lang="en-US">COUPNUM(Settlement; Maturity; Frequency [; Basis])</paragraph>
<paragraph id="par_id3159406" role="paragraph" xml-lang="en-US"><emph>Settlement</emph> is the date of purchase of the security.</paragraph>
<paragraph id="par_id3155864" role="paragraph" xml-lang="en-US"><emph>Maturity</emph> is the date on which the security matures (expires).</paragraph>
<paragraph id="par_id3154720" role="paragraph" xml-lang="en-US"><emph>Frequency</emph> is the number of interest payments per year (1, 2 or 4).</paragraph>
@@ -509,7 +509,7 @@
<paragraph id="par_id3154522" role="paragraph" xml-lang="en-US"><ahelp hid="HID_FUNC_ZINSZ">Calculates the periodic amortizement for an investment with regular payments and a constant interest rate.</ahelp></paragraph>
<embed href="text/scalc/01/common_func.xhp#sectionsyntax"/>
-<paragraph id="par_id3151283" role="code" xml-lang="en-US">IPMT(Rate; Period; NPer; PV; FV; Type)</paragraph>
+<paragraph id="par_id3151283" role="code" xml-lang="en-US">IPMT(Rate; Period; NPer; PV [; FV [; Type]])</paragraph>
<paragraph id="par_id3147313" role="paragraph" xml-lang="en-US"><emph>Rate</emph> is the periodic interest rate.</paragraph>
<paragraph id="par_id3145158" role="paragraph" xml-lang="en-US"><emph>Period</emph> is the period, for which the compound interest is calculated. Period=NPER if compound interest for the last period is calculated.</paragraph>
<paragraph id="par_id3147577" role="paragraph" xml-lang="en-US"><emph>NPer</emph> is the total number of periods, during which annuity is paid.</paragraph>
@@ -535,7 +535,7 @@
<paragraph id="par_id3154140" role="paragraph" xml-lang="en-US"><ahelp hid="HID_FUNC_ZW">Returns the future value of an investment based on periodic, constant payments and a constant interest rate (Future Value).</ahelp></paragraph>
<embed href="text/scalc/01/common_func.xhp#sectionsyntax"/>
-<paragraph id="par_id3145215" role="code" xml-lang="en-US">FV(Rate; NPer; Pmt; PV; Type)</paragraph>
+<paragraph id="par_id3145215" role="code" xml-lang="en-US">FV(Rate; NPer; Pmt [ ; [ PV ] [ ; Type ] ])</paragraph>
<paragraph id="par_id3155136" role="paragraph" xml-lang="en-US"><emph>Rate</emph> is the periodic interest rate.</paragraph>
<paragraph id="par_id3156029" role="paragraph" xml-lang="en-US"><emph>NPer</emph> is the total number of periods (payment period).</paragraph>
<paragraph id="par_id3151322" role="paragraph" xml-lang="en-US"><emph>Pmt</emph> is the annuity paid regularly per period.</paragraph>
@@ -583,7 +583,7 @@
<paragraph id="par_id3152363" role="paragraph" xml-lang="en-US"><ahelp hid="HID_FUNC_ZZR">Returns the number of periods for an investment based on periodic, constant payments and a constant interest rate.</ahelp></paragraph>
<embed href="text/scalc/01/common_func.xhp#sectionsyntax"/>
-<paragraph id="par_id3155934" role="code" xml-lang="en-US">NPER(Rate; Pmt; PV; FV; Type)</paragraph>
+<paragraph id="par_id3155934" role="code" xml-lang="en-US">NPER(Rate; Pmt; PV [ ; [ FV ] [ ; Type ] ])</paragraph>
<paragraph id="par_id3155946" role="paragraph" xml-lang="en-US"><emph>Rate</emph> is the periodic interest rate.</paragraph>
<paragraph id="par_id3149042" role="paragraph" xml-lang="en-US"><emph>Pmt</emph> is the constant annuity paid in each period.</paragraph>
<paragraph id="par_id3153134" role="paragraph" xml-lang="en-US"><emph>PV</emph> is the present value (cash value) in a sequence of payments.</paragraph>