Bug 159596 - [LOCALHELP] Add Help page for Calc function XLOOKUP
Summary: [LOCALHELP] Add Help page for Calc function XLOOKUP
Status: CLOSED 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 inReleaseNotes:24.8 tar...
Keywords:
Depends on:
Blocks: HelpGaps-NewFeatures
  Show dependency treegraph
 
Reported: 2024-02-06 13:20 UTC by Olivier Hallot
Modified: 2024-09-18 04:29 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).
Comment 3 Óvári 2024-05-16 07:43:04 UTC
In release notes:
https://wiki.documentfoundation.org/ReleaseNotes/24.8#LibreOffice_Help
Comment 4 Óvári 2024-05-18 01:26:57 UTC
1. Should `MatchType` be changed to `MatchMode`?
2. Should `-1 - Exact match` and `1 - Exact match` be changed to `-1 - Closest match` and `1 - Closest match`, respectively?

Inspiration from https://bettersolutions.com/excel/functions/xlookup-function.htm

Thank you
Comment 5 Óvári 2024-05-18 01:30:08 UTC
Should reference such as shown below be added:
```
* For the Microsoft documentation refer to [support.microsoft.com](https://support.microsoft.com/en-us/office/xlookup-function-b7fd680e-6d10-43e6-84f9-88eae8bf5929)
* For the Google documentation refer to [support.google.com](https://support.google.com/docs/answer/12405947)
```

Should the following be added:
```
To include the actual wildcard characters use a tilde prefix (~?), (~*) and (~~).
```

Inspiration from https://bettersolutions.com/excel/functions/xlookup-function.htm

Thank you
Comment 6 Óvári 2024-05-18 01:32:03 UTC
(In reply to Óvári from comment #5)
> Should the following be added:
> ```
> To include the actual wildcard characters use a tilde prefix (~?), (~*) and
> (~~).
> ```
> 
> Inspiration from
> https://bettersolutions.com/excel/functions/xlookup-function.htm
> 
> Thank you

Should this also be added at:
https://help.libreoffice.org/master/en-US/text/scalc/guide/wildcards.html
Comment 7 ady 2024-06-21 16:06:32 UTC
(In reply to ady from comment #2)
> @Olivier,

> 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).

As of tdf#127293 comment 78, the alternative support of regex for Match Mode "2" based on:
 "menu Tools > Options > Calc > Calculate > (Formulas Wildcards)" 
is canceled.

Match Mode "2" will support Wildcards, not Regex (as in Excel).

A new Match Mode "3" should support Regex, according to the proposed ODF, oasis ticket 4154.

FTR, Match Mode "3" is still not mainstream in Excel yet. This means that, in practical terms, Regex support in XLOOKUP() is still as incompatible with Excel as it was before this change; at least until Excel adds this Match Mode alternative too (if it turns out to be exactly the same as in Calc).
Comment 8 Commit Notification 2024-06-23 07:20:40 UTC
Olivier Hallot committed a patch related to this issue.
It has been pushed to "master":

https://git.libreoffice.org/help/commit/9acd72cd9faa94ec85826293f1e95da3e6175d35

tdf#159596 tdf#159771 Update XMATCH and XLOOKUP pages
Comment 9 Commit Notification 2024-07-04 14:21:03 UTC
Olivier Hallot committed a patch related to this issue.
It has been pushed to "libreoffice-24-8":

https://git.libreoffice.org/help/commit/2f68941ab30515f5ae7e1bbaa2a8e119714f7489

tdf#159596 tdf#159771 Update XMATCH and XLOOKUP pages
Comment 10 Commit Notification 2024-07-10 14:53:05 UTC
Olivier Hallot committed a patch related to this issue.
It has been pushed to "master":

https://git.libreoffice.org/help/commit/1a7045ca49e06f1e84bee74cdac6d8d6a399ddd8

tdf#159596 match XLOOKUP Help terms to UI terms
Comment 11 Commit Notification 2024-07-10 15:56:23 UTC
Olivier Hallot committed a patch related to this issue.
It has been pushed to "libreoffice-24-8":

https://git.libreoffice.org/help/commit/3e923355a8e31b6073f140ecc1b138a99236a294

tdf#159596 match XLOOKUP Help terms to UI terms
Comment 12 lyly 2024-08-22 02:46:49 UTC Comment hidden (spam)
Comment 13 angelaevans 2024-09-14 02:24:15 UTC Comment hidden (spam)
Comment 14 kalylcie 2024-09-17 08:03:48 UTC Comment hidden (spam)