Bug 159596 - [LOCALHELP] Add Help page for Calc function XLOOKUP
Summary: [LOCALHELP] Add Help page for Calc function XLOOKUP
Status: RESOLVED FIXED
Alias: None
Product: LibreOffice
Classification: Unclassified
Component: Documentation (show other bugs)
Version:
(earliest affected)
unspecified
Hardware: All All
: medium normal
Assignee: Olivier Hallot
URL:
Whiteboard: target:24.8.0
Keywords:
Depends on:
Blocks: HelpGaps-NewFeatures
  Show dependency treegraph
 
Reported: 2024-02-06 13:20 UTC by Olivier Hallot
Modified: 2024-04-15 16:58 UTC (History)
1 user (show)

See Also:
Crash report or crash signature:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Olivier Hallot 2024-02-06 13:20:28 UTC
Following resolution of bug#127293, write the help page of the function.

Tasks
1) Create the file source/tex/scalc/01/func_xlookup.xhp
2) add it to git
3) add entry in makefile in AllLangHelp_scalc.mk
4) fill XHP contents.

Source 
https://bugs.documentfoundation.org/show_bug.cgi?id=127293

https://blog.documentfoundation.org/blog/2022/09/23/lox365-extension-xlookup-and-more-for-libreoffice-calc/

Other spreadsheet product in the industry but contents shall not be coied and must be written in own words.

VLOOKUP
https://help.libreoffice.org/master/en-US/text/scalc/01/04060109.html?DbPAR=CALC#bm_id3153152

HLOOKUP
https://help.libreoffice.org/master/en-US/text/scalc/01/04060109.html?DbPAR=CALC#bm_id3151001

LOOKUP
https://help.libreoffice.org/master/en-US/text/scalc/01/04060109.html?DbPAR=CALC#bm_id3159273

5) Test
6) submit patch
Comment 1 Commit Notification 2024-02-19 20:12:09 UTC
Olivier Hallot committed a patch related to this issue.
It has been pushed to "master":

https://git.libreoffice.org/help/commit/33a703440353008f3cb62855329e427ac41deedc

tdf#159596 Help page for XLOOKUP function
Comment 2 ady 2024-04-15 16:58:19 UTC
@Olivier,

As of today, 2024-04-15, the Help content for XLOOKUP (and at least XMATCH, if not also for other new Calc functions added for LO 24.8) mentions "wildcard"(s) (twice).

Please be aware that since 2024-04-13, XLOOKUP() in LO 24.8 (alpha ATM) supports either wildcards or regex (or neither), depending on the setting in menu Tools > Options > Calc > Calculate > (Formulas Wildcards).

This means that the current mentions of wildcards should probably be modified to include the regex alternative in the Help content of these new Calc functions.

For example, quoting from the current Help content for XLOOKUP():
"
XLOOKUP supports approximate and exact matching, wildcards (* ?) for partial matches...
"

The mention of "partial matches" (in the above quote) is no longer limited to wildcards in LO Calc.

As usual, using regex is not directly compatible with Excel's XLOOKUP().

Among those modifications, when the "MatchType" argument is 2, it is not just a "wildcard match" but rather a "Partial match" (in LO Calc), which would imply either wildcards or regex (or neither), depending on the aforementioned setting.

At any rate, the other possible values of "MatchType" are not affected. Those other MatchType values parse all characters as-is (with no special meaning), and are still considered either an Exact match (0), or an Exact/approximate match (1 and -1), respectively.

These modifications should be relevant at least for XMATCH() too (tdf#159771).

ATM the usage of regex in XLOOKUP and XMATCH has been barely tested in its most basic form only. The modifications (to the Help content) I am mentioning here are as they are meant to be, so if anything happens to behave differently, it should be reported as a bug for the relevant Calc function(s).