diff options
author | Rafael Lima <rafael.palma.lima@gmail.com> | 2021-08-12 16:01:36 +0200 |
---|---|---|
committer | Olivier Hallot <olivier.hallot@libreoffice.org> | 2021-08-17 09:34:30 +0200 |
commit | 3a58cb35bdb6e11e7a80759b59d4c68fcd3c6be7 (patch) | |
tree | 84c0c994f0266bedcdfef8abd7e1aa6734781a1c | |
parent | 70819b10363aba5cce4c1655dae622b5e3776d51 (diff) |
Improve VALUE function help page
The help page for the VALUE function is created as a separate help page func_value.xhp.
This patch also refactors related help pages NUMBERVALUE, DATEVALUE and TIMEVALUE. Their main header was <h2> instead of <h1>.
Change-Id: Ic67893f0c35a58a19f13af1d34d68956e901a4a6
Reviewed-on: https://gerrit.libreoffice.org/c/help/+/120361
Tested-by: Jenkins
Reviewed-by: Steve Fanning <stevemfanning@yahoo.co.uk>
Reviewed-by: Olivier Hallot <olivier.hallot@libreoffice.org>
-rw-r--r-- | AllLangHelp_scalc.mk | 1 | ||||
-rw-r--r-- | source/text/scalc/01/04060110.xhp | 17 | ||||
-rw-r--r-- | source/text/scalc/01/func_datevalue.xhp | 53 | ||||
-rw-r--r-- | source/text/scalc/01/func_numbervalue.xhp | 8 | ||||
-rw-r--r-- | source/text/scalc/01/func_timevalue.xhp | 42 | ||||
-rw-r--r-- | source/text/scalc/01/func_value.xhp | 47 |
6 files changed, 99 insertions, 69 deletions
diff --git a/AllLangHelp_scalc.mk b/AllLangHelp_scalc.mk index 3cca39631c..149c66d346 100644 --- a/AllLangHelp_scalc.mk +++ b/AllLangHelp_scalc.mk @@ -259,6 +259,7 @@ $(eval $(call gb_AllLangHelp_add_helpfiles,scalc,\ helpcontent2/source/text/scalc/01/func_time \ helpcontent2/source/text/scalc/01/func_timevalue \ helpcontent2/source/text/scalc/01/func_today \ + helpcontent2/source/text/scalc/01/func_value \ helpcontent2/source/text/scalc/01/func_weekday \ helpcontent2/source/text/scalc/01/func_webservice \ helpcontent2/source/text/scalc/01/func_weeknum \ diff --git a/source/text/scalc/01/04060110.xhp b/source/text/scalc/01/04060110.xhp index 55a130d203..7b33f71390 100644 --- a/source/text/scalc/01/04060110.xhp +++ b/source/text/scalc/01/04060110.xhp @@ -794,22 +794,9 @@ </section> <section id="value"> -<bookmark xml-lang="en-US" branch="index" id="bm_id3150802"> - <bookmark_value>VALUE function</bookmark_value> -</bookmark> - -<bookmark xml-lang="en-US" branch="hid/SC_HID_FUNC_WERT" id="bm_id3150814" localize="false"/> - -<h2 id="hd_id3150802"><variable id="ValueFunction"><link href="text/scalc/01/04060110.xhp#value" name="ValueLink">VALUE</link></variable></h2> -<paragraph id="par_id3152551" role="paragraph" xml-lang="en-US"><ahelp hid="HID_FUNC_WERT">Converts a text string into a number.</ahelp></paragraph> - -<embed href="text/scalc/01/common_func.xhp#sectionsyntax"/> -<paragraph id="par_id3153638" role="code" xml-lang="en-US">VALUE("Text")</paragraph> -<paragraph id="par_id3153651" role="paragraph" xml-lang="en-US"> <emph>Text</emph> is the text to be converted to a number.</paragraph> - -<embed href="text/scalc/01/common_func.xhp#sectionexample"/> -<paragraph id="par_id3144733" role="paragraph" xml-lang="en-US"> <item type="input">=VALUE("4321")</item> returns 4321.</paragraph> +<embed href="text/scalc/01/func_value.xhp#func_value"/> </section> + <section id="webservice"> <embed href="text/scalc/01/func_webservice.xhp#webservicefuncheader"/> </section> diff --git a/source/text/scalc/01/func_datevalue.xhp b/source/text/scalc/01/func_datevalue.xhp index ea24c23be6..963c859269 100644 --- a/source/text/scalc/01/func_datevalue.xhp +++ b/source/text/scalc/01/func_datevalue.xhp @@ -21,32 +21,31 @@ <meta> - <topic id="textscalc01func_datevaluexml" indexer="include" status="PUBLISH"> - <title xml-lang="en-US" id="tit">DATEVALUE </title> - <filename>/text/scalc/01/func_datevalue.xhp</filename> - </topic> - </meta> - <body> -<bookmark xml-lang="en-US" branch="index" id="bm_id3145621"><bookmark_value>DATEVALUE function</bookmark_value> -</bookmark> -<bookmark xml-lang="en-US" branch="hid/SC_HID_FUNC_DATWERT" id="bm_id3163820" localize="false"/> -<h2 id="hd_id3145621"><variable id="datevalue"><link href="text/scalc/01/func_datevalue.xhp">DATEVALUE</link> -</variable></h2> - <paragraph xml-lang="en-US" id="par_id3145087" role="paragraph"><ahelp hid="HID_FUNC_DATWERT">Returns the internal date number for text in quotes.</ahelp></paragraph> - <paragraph xml-lang="en-US" id="par_id3149281" role="paragraph">The internal date number is returned as a number. The number is determined by the date system that is used by $[officename] to calculate dates.</paragraph> - <paragraph xml-lang="en-US" id="par_id0119200903491982" role="paragraph">If the text string also includes a time value, DATEVALUE only returns the integer part of the conversion.</paragraph> - <embed href="text/scalc/01/ODFF.xhp#odff"/> -<embed href="text/scalc/01/common_func.xhp#sectionsyntax"/> - <paragraph xml-lang="en-US" id="par_id3149268" role="code">DATEVALUE("Text")</paragraph> - <paragraph xml-lang="en-US" id="par_id3154819" role="paragraph"> - <emph>Text</emph> is a valid date expression and must be entered with quotation marks.</paragraph> - <embed href="text/scalc/01/04060102.xhp#datenumberinfo"/> - <embed href="text/scalc/01/04060102.xhp#datenumberwarn"/> -<embed href="text/scalc/01/common_func.xhp#sectionexample"/> - <paragraph xml-lang="en-US" id="par_id3155841" role="paragraph"> - <item type="input">=DATEVALUE("1954-07-20")</item> yields 19925.</paragraph> - <section id="relatedtopics"> + <topic id="textscalc01func_datevaluexml" indexer="include" status="PUBLISH"> + <title xml-lang="en-US" id="tit">DATEVALUE </title> + <filename>/text/scalc/01/func_datevalue.xhp</filename> + </topic> +</meta> +<body> + <bookmark xml-lang="en-US" branch="index" id="bm_id3145621"> + <bookmark_value>DATEVALUE function</bookmark_value> + </bookmark> + <bookmark xml-lang="en-US" branch="hid/SC_HID_FUNC_DATWERT" id="bm_id3163820" localize="false"/> + <h1 id="hd_id3145621"><variable id="datevalue"><link href="text/scalc/01/func_datevalue.xhp">DATEVALUE</link></variable></h1> + <paragraph xml-lang="en-US" id="par_id3145087" role="paragraph"><ahelp hid="HID_FUNC_DATWERT">Returns the internal date number for text in quotes.</ahelp></paragraph> + <paragraph xml-lang="en-US" id="par_id3149281" role="paragraph">The internal date number is returned as a number. The number is determined by the date system that is used by $[officename] to calculate dates.</paragraph> + <paragraph xml-lang="en-US" id="par_id0119200903491982" role="paragraph">If the text string also includes a time value, DATEVALUE only returns the integer part of the conversion.</paragraph> + <embed href="text/scalc/01/ODFF.xhp#odff"/> + <embed href="text/scalc/01/common_func.xhp#sectionsyntax"/> + <paragraph xml-lang="en-US" id="par_id3149268" role="code">DATEVALUE("Text")</paragraph> + <paragraph xml-lang="en-US" id="par_id3154819" role="paragraph"><emph>Text</emph> is a valid date expression and must be entered with quotation marks.</paragraph> + <embed href="text/scalc/01/04060102.xhp#datenumberinfo"/> + <embed href="text/scalc/01/04060102.xhp#datenumberwarn"/> + <embed href="text/scalc/01/common_func.xhp#sectionexample"/> + <paragraph xml-lang="en-US" id="par_id3155841" role="paragraph"> + <item type="input">=DATEVALUE("1954-07-20")</item> yields 19925.</paragraph> + <section id="relatedtopics"> <embed href="text/scalc/01/04060102.xhp#datetimefunctions"/> -</section> - </body> + </section> +</body> </helpdocument> diff --git a/source/text/scalc/01/func_numbervalue.xhp b/source/text/scalc/01/func_numbervalue.xhp index a0ccbe1724..18d9d976a7 100644 --- a/source/text/scalc/01/func_numbervalue.xhp +++ b/source/text/scalc/01/func_numbervalue.xhp @@ -28,11 +28,7 @@ <bookmark_value>NUMBERVALUE function</bookmark_value> </bookmark> <bookmark xml-lang="en-US" branch="hid/SC_HID_FUNC_NUMBERVALUE" id="bm_id3163820" localize="false"/> - <paragraph xml-lang="en-US" id="hd_id3145621" role="heading" level="2"> - <variable id="datevalue"> - <link href="text/scalc/01/func_numbervalue.xhp">NUMBERVALUE</link> - </variable> - </paragraph> + <h1 id="hd_id3145621"><variable id="numbervalue_h1"><link href="text/scalc/01/func_numbervalue.xhp">NUMBERVALUE</link></variable></h1> <paragraph xml-lang="en-US" id="par_id3145087" role="paragraph"> <ahelp hid="HID_FUNC_NUMBERVALUE">Converts the string representation of a number into a locale-independent numeric value.</ahelp> </paragraph> @@ -57,7 +53,7 @@ <tip id="par_id451626100385699">Refer to the <link href="https://wiki.documentfoundation.org/Documentation/Calc_Functions/NUMBERVALUE" name="NUMBERVALUE_Wiki">NUMBERVALUE</link> wiki page for more details about this function.</tip> <section id="relatedtopics"> - <embed href="text/scalc/01/04060110.xhp#ValueFunction"/> + <embed href="text/scalc/01/func_value.xhp#Value_h1"/> </section> </body> </helpdocument> diff --git a/source/text/scalc/01/func_timevalue.xhp b/source/text/scalc/01/func_timevalue.xhp index 7e6f442d5e..87bd8da08e 100644 --- a/source/text/scalc/01/func_timevalue.xhp +++ b/source/text/scalc/01/func_timevalue.xhp @@ -18,29 +18,29 @@ * the License at http://www.apache.org/licenses/LICENSE-2.0 . ****************************************************************--> <meta> -<topic id="topic_0506201512165345" status="PUBLISH"> -<title xml-lang="en-US" id="tit">TIMEVALUE </title> -<filename>/text/scalc/01/func_timevalue.xhp</filename> -</topic> + <topic id="topic_0506201512165345" status="PUBLISH"> + <title xml-lang="en-US" id="tit">TIMEVALUE </title> + <filename>/text/scalc/01/func_timevalue.xhp</filename> + </topic> </meta> <body> -<bookmark xml-lang="en-US" branch="index" id="bm_id3146755"> -<bookmark_value>TIMEVALUE function</bookmark_value> -</bookmark> -<bookmark xml-lang="en-US" branch="hid/SC_HID_FUNC_ZEITWERT" id="bm_id3146767" localize="false"/> -<h2 id="hd_id3146755"><variable id="timevalue"><link href="text/scalc/01/func_timevalue.xhp">TIMEVALUE</link></variable></h2> -<paragraph id="par_id3148502" role="paragraph" xml-lang="en-US"><ahelp hid="HID_FUNC_ZEITWERT">TIMEVALUE returns the internal time number from a text enclosed by quotes and which may show a possible time entry format.</ahelp></paragraph> -<embed href="text/scalc/01/ODFF.xhp#odff"/> -<paragraph id="par_id3150794" role="paragraph" xml-lang="en-US">The internal number indicated as a decimal is the result of the date system used under $[officename] to calculate date entries.</paragraph> -<paragraph id="par_id011920090347118" role="paragraph" xml-lang="en-US">If the text string also includes a year, month, or day, TIMEVALUE only returns the fractional part of the conversion.</paragraph> -<embed href="text/scalc/01/common_func.xhp#sectionsyntax"/> -<paragraph id="par_id3150823" role="code" xml-lang="en-US">TIMEVALUE("Text")</paragraph> -<paragraph id="par_id3152556" role="paragraph" xml-lang="en-US"><emph>Text</emph> is a valid time expression and must be entered in quotation marks.</paragraph> -<embed href="text/scalc/01/common_func.xhp#sectionexample"/> -<paragraph id="par_id3146829" role="paragraph" xml-lang="en-US"><item type="input">=TIMEVALUE("4PM")</item> returns 0.67. When formatting in time format HH:MM:SS, you then get 16:00:00.</paragraph> -<paragraph id="par_id3153632" role="paragraph" xml-lang="en-US"><item type="input">=TIMEVALUE("24:00")</item> returns 0. If you use the HH:MM:SS time format, the value is 00:00:00.</paragraph> -<section id="relatedtopics"> + <bookmark xml-lang="en-US" branch="index" id="bm_id3146755"> + <bookmark_value>TIMEVALUE function</bookmark_value> + </bookmark> + <bookmark xml-lang="en-US" branch="hid/SC_HID_FUNC_ZEITWERT" id="bm_id3146767" localize="false"/> + <h1 id="hd_id3146755"><variable id="timevalue"><link href="text/scalc/01/func_timevalue.xhp">TIMEVALUE</link></variable></h1> + <paragraph id="par_id3148502" role="paragraph" xml-lang="en-US"><ahelp hid="HID_FUNC_ZEITWERT">TIMEVALUE returns the internal time number from a text enclosed by quotes and which may show a possible time entry format.</ahelp></paragraph> + <embed href="text/scalc/01/ODFF.xhp#odff"/> + <paragraph id="par_id3150794" role="paragraph" xml-lang="en-US">The internal number indicated as a decimal is the result of the date system used under $[officename] to calculate date entries.</paragraph> + <paragraph id="par_id011920090347118" role="paragraph" xml-lang="en-US">If the text string also includes a year, month, or day, TIMEVALUE only returns the fractional part of the conversion.</paragraph> + <embed href="text/scalc/01/common_func.xhp#sectionsyntax"/> + <paragraph id="par_id3150823" role="code" xml-lang="en-US">TIMEVALUE("Text")</paragraph> + <paragraph id="par_id3152556" role="paragraph" xml-lang="en-US"><emph>Text</emph> is a valid time expression and must be entered in quotation marks.</paragraph> + <embed href="text/scalc/01/common_func.xhp#sectionexample"/> + <paragraph id="par_id3146829" role="paragraph" xml-lang="en-US"><item type="input">=TIMEVALUE("4PM")</item> returns 0.67. When formatting in time format HH:MM:SS, you then get 16:00:00.</paragraph> + <paragraph id="par_id3153632" role="paragraph" xml-lang="en-US"><item type="input">=TIMEVALUE("24:00")</item> returns 0. If you use the HH:MM:SS time format, the value is 00:00:00.</paragraph> + <section id="relatedtopics"> <embed href="text/scalc/01/04060102.xhp#datetimefunctions"/> -</section> + </section> </body> </helpdocument> diff --git a/source/text/scalc/01/func_value.xhp b/source/text/scalc/01/func_value.xhp new file mode 100644 index 0000000000..2293c1a103 --- /dev/null +++ b/source/text/scalc/01/func_value.xhp @@ -0,0 +1,47 @@ +<?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/. +* +--> + +<meta> + <topic id="calcfuncvalue" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">VALUE Function</title> + <filename>/text/scalc/01/func_value.xhp</filename> + </topic> +</meta> +<body> + <section id="func_value"> + <bookmark id="bm_id61542230672099" xml-lang="en-US" branch="hid/SC_HID_FUNC_VALUE" localize="false"/> + <bookmark xml-lang="en-US" branch="index" id="bm_id831542233029549"> + <bookmark_value>VALUE function</bookmark_value> + <bookmark_value>text functions;convert text to numeric value</bookmark_value> + </bookmark> + <h1 id="hd_id881628776094597"><variable id="Value_h1"><link href="text/scalc/01/func_value.xhp" name="function VALUE">VALUE</link></variable></h1> + <paragraph id="par_id541542230672101" role="paragraph" xml-lang="en-US"><variable id="func_value_desc"><ahelp hid=".">Converts the string representation of a number to numeric form. If the supplied string is a valid date, time, or date-time, the corresponding date-time serial number is returned.</ahelp></variable></paragraph> + </section> + <embed href="text/scalc/01/ful_func.xhp#func_head_syntax"/> + <paragraph role="paragraph" id="par_id701542231253817" xml-lang="en-US"><input>VALUE(Text)</input></paragraph> + <paragraph role="paragraph" id="par_id621542232197446" xml-lang="en-US"><emph>Text</emph>: A string (in quotation marks), a number, or a reference to a cell containing one of those types, that contains the value to be converted.</paragraph> + <note id="par_id731628787003937">If the <emph>Text</emph> argument is a string representing a date, time, currency or a numeric value with decimal and thousands separators, the string must comply with current locale settings.</note> + <embed href="text/scalc/01/ful_func.xhp#func_head_example"/> + <paragraph role="paragraph" id="par_id451628776707264"><input>=VALUE("1234")</input> returns the numeric value 1234.</paragraph> + <paragraph role="paragraph" id="par_id101628778036375"><input>=VALUE("+1,234.567")</input> returns 1234.567 (considering en-US locale). Note that the "+" sign could have been omitted.</paragraph> + <paragraph role="paragraph" id="par_id991628779914913"><input>=VALUE("$100")</input> returns 100 (considering en-US locale). Note that the currency prefix must match the current locale settings.</paragraph> + <paragraph role="paragraph" id="par_id101628780114427"><input>=VALUE("50%")</input> returns 0.5. Note that the character "%" causes the numeric part to be divided by 100.</paragraph> + <paragraph role="paragraph" id="par_id731628780240876"><input>=VALUE("07/30/2021")</input> returns 44407 (considering en-US locale) which is the date-time sequence number corresponding to the specified date.</paragraph> + <paragraph role="paragraph" id="par_id501628780340635"><input>=VALUE("09:20:25")</input> returns 0.389178240740741 which is the date-time sequence number corresponding to the specified time value.</paragraph> + <tip id="par_id801628779804928">Refer to the <link href="https://wiki.documentfoundation.org/Documentation/Calc_Functions/VALUE" name="VALUE Wiki">VALUE</link> wiki page for more details about this function.</tip> + + <section id="relatedtopics"> + <embed href="text/scalc/01/func_datevalue.xhp#datevalue"/> + <embed href="text/scalc/01/func_numbervalue.xhp#numbervalue_h1"/> + <embed href="text/scalc/01/func_timevalue.xhp#timevalue"/> + </section> +</body> +</helpdocument> |