Website and Help Typos

Things you’d like to miss in the future...
Forum rules
When reporting a bug, please include the following information: your XYplorer version (e.g., v27.90.0047), your Windows version (e.g., Win 11), and your screen scaling percentage (e.g., 125%). We recommend adding your Windows version and screen scaling percentage to your profile or signature. This will make debugging much easier for us.
Post Reply
admin
Site Admin
Posts: 64838
Joined: 22 May 2004 16:48
Location: Win8.1, Win10, Win11, all @100%
Contact:

Re: Website and Help Typos

Post by admin »

That decision is taking a rest, too.

admin
Site Admin
Posts: 64838
Joined: 22 May 2004 16:48
Location: Win8.1, Win10, Win11, all @100%
Contact:

Re: Website and Help Typos

Post by admin »

SammaySarkar wrote:::help 'idh_scripting_comref.htm#idh_sc_confirm';

"Pops message box with OK/Cancel, returns result." -- is no longer true. Perhaps: "Pops message box with specified buttons, returns an integer identifying pressed button."

"return 1 on OK, 0 on Cancel; exceptions see Buttons above." -- is redundant now. Perhaps just: "return See Buttons above."

Also: ~ "Default button index of initially focused button, counting from left/1: [Default] First button/2: Second button, and so on."
Thanks. :tup:

zer0
Posts: 2676
Joined: 19 Jan 2009 20:11

Re: Website and Help Typos

Post by zer0 »

admin wrote:That decision is taking a rest, too.
That does not fill me with a great deal of optimism, if I am honest.

BTW, the image in 15.40 copy file size section of release notes (http://www.xyplorer.com/release_15.40.php) is a broken link: http://www.xyplorer.com/images/whatsnew ... leSize.png
Reporting a bug? Have a wish? Got a question? Use search - View roadmap - FAQs: Forum + XY site
Windows 7/10
Always using the latest stable two-decimal build

admin
Site Admin
Posts: 64838
Joined: 22 May 2004 16:48
Location: Win8.1, Win10, Win11, all @100%
Contact:

Re: Website and Help Typos

Post by admin »

Oh, thanks.

bdeshi
Posts: 4256
Joined: 12 Mar 2014 17:27
Location: Asteroid B-612
Contact:

Re: Website and Help Typos

Post by bdeshi »

::help 'idh_variables.htm';
To have the CameraModel of the current file on the status bar, use this tweak:

Code: Select all

::StatusBar3OnFile="<curname>, Camera: <prop CameraModel>"
^^ shouldn't be here, this is not a script.
:: help 'idh_scripting.htm#idh_scripting_udf';
• The first line of user function declarations can to be left-bound
[...]
• If no default value is set a missing arguments is initialized to "".
all codeblocks in the new UDF and INCLUDE sections have extra one space indentation, unlike previous documentation which are not indented so unless necessary.
Usually not-wrong syntax, but this breaks the INCLUDE example [ ::html 'idh_scripting.htm#idh_scripting_include'; ]
Icon Names | Onyx | Undocumented Commands | xypcre
[ this user is asleep ]

admin
Site Admin
Posts: 64838
Joined: 22 May 2004 16:48
Location: Win8.1, Win10, Win11, all @100%
Contact:

Re: Website and Help Typos

Post by admin »

Thanks!

Papoulka
Posts: 455
Joined: 13 Jul 2013 23:41

Renameitem Help is confusing

Post by Papoulka »

I am working in a folder which is known to have one and only one subfolder. I want to change the name of that subfolder from whatever it is to "John".

I was led astray for quite a while by the Help, which says that

Code: Select all

renameitem("John");
will "Rename current folder to" John "in current folder"

My script was

Code: Select all

sel f;
  sel i;
  renameitem("John");
but this fails on "Missing source item".

I realize now that

Code: Select all

sel f;
  sel i;
  rename b, 'John';
works.

But I suggest rewriting that part of the Help for "renameitem" to be more clear, maybe also being more specific about what "current folder" means.

Thanks

highend
Posts: 14566
Joined: 06 Feb 2011 00:33
Location: Win Server 2022 @100%

Re: Renameitem Help is confusing

Post by highend »

I'd do that in a different way (less error prone):

Code: Select all

    $folder = listpane(, , 2);
    if (gettoken($folder, "count", "|") == 1) {
        rename "b", "John", , $folder;
    }
Doesn't invoke any error messages and works even if you're in a wrong folder (which has less | more than one subfolder)
One of my scripts helped you out? Please donate via Paypal

Papoulka
Posts: 455
Joined: 13 Jul 2013 23:41

Re: Website and Help Typos

Post by Papoulka »

Thanks, highend. That's a good tip towards listpane, too, which I have never considered.

highend
Posts: 14566
Joined: 06 Feb 2011 00:33
Location: Win Server 2022 @100%

Re: Website and Help Typos

Post by highend »

Examples

echo tagitems(); //set Label of the focused item
value Tag value, which (depending on field) can be label name or ID, tag(s), comment, or data.
Empty string ('') is treated similar to "Remove Data".
If omitted, field is retrieved but not set.
In the example the value is omitted, so the field is retrieved but not set...
so the comment should be:
//Retrieve Label of the focused item
One of my scripts helped you out? Please donate via Paypal

admin
Site Admin
Posts: 64838
Joined: 22 May 2004 16:48
Location: Win8.1, Win10, Win11, all @100%
Contact:

Re: Website and Help Typos

Post by admin »

Oh, thanks. Those examples were really wrong and poor. Must have been a bad day when I wrote that... :whistle:

Here are some hopefully better examples:

Code: Select all

tagitems(, 1);     //set Label of all selected items to 1
tagitems(, "Red"); //set Label of all selected items to "Red" (that Label has to exist, of course)
echo tagitems();   //retrieve Label of the focused item
tagitems(, "");    //remove any Labels of all selected items
tagitems("tag", "Rock,Disco");  //set Tags of all selected items to "Disco" and "Rock"
echo tagitems("tag");     //retrieve Tags of the focused item
tagitems("tag", "");  //remove any Tags of all selected items
tagitems("cmt", "Done."); //set Comment of all selected items to "Done."
tagitems("cmt", "Done.", "E:\Test\Test.txt"); //set Comment of "E:\Test\Test.txt" to "Done."
echo tagitems("cmt");     //retrieve Comment of the focused item
echo tagitems("cmt", , "E:\Test\Test.txt");     //retrieve Comment of "E:\Test\Test.txt"
tagitems("cmt", "");  //remove any Comments of all selected items

highend
Posts: 14566
Joined: 06 Feb 2011 00:33
Location: Win Server 2022 @100%

Re: Website and Help Typos

Post by highend »

:appl: :appl:
One of my scripts helped you out? Please donate via Paypal

admin
Site Admin
Posts: 64838
Joined: 22 May 2004 16:48
Location: Win8.1, Win10, Win11, all @100%
Contact:

Re: Website and Help Typos

Post by admin »

Actually, now I think "tags" should be the preferred choice ("tag" will still be supported):

Code: Select all

tagitems("tags", "Rock,Disco");  //set Tags of all selected items to "Disco" and "Rock"
echo tagitems("tags");     //retrieve Tags of the focused item
tagitems("tags", "");  //remove any Tags of all selected items
"tags" is also used as prefix in Find Files, and will be used in Visual Filter...

Papoulka
Posts: 455
Joined: 13 Jul 2013 23:41

Re: Website and Help Typos

Post by Papoulka »

The Help for SC 'openwith' now has this general description:
  • Opens the currently selected List item(s) with the specified application.
So I thought at first that it was limited to List pane selections. But in fact it can alternatively operate on a list of items, which is very useful. So I suggest changing the general description to something like:
  • Opens the currently selected (or list-defined) items with the specified application.
Last edited by Papoulka on 10 Sep 2015 17:07, edited 1 time in total.

Papoulka
Posts: 455
Joined: 13 Jul 2013 23:41

Re: Website and Help Typos

Post by Papoulka »

The Help for SC 'replacelist' has a tiny typo. In the Notes it says the string is walked "on time". Should be "one time".

Post Reply