Website and Help Typos

Things you’d like to miss in the future...
jupe
Posts: 2757
Joined: 20 Oct 2017 21:14
Location: Win10 22H2 120dpi

Re: Website and Help Typos

Post by jupe »

I noticed that for SC tagcheck the 1, 2 and 4 flags aren't doc'd, although the examples make their function deducible, but even then the 8 is listed as SafeSave but the example seems to indicate it as correct capitalization instead, I think this whole section was accidentally copy+pasted from SC tagsave.

Also, not sure if it matters, but using the command doesn't seem to mark the tags as dirty.

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

Re: Website and Help Typos

Post by admin »

Damn. Totally right! :tup:

PeterH
Posts: 2776
Joined: 21 Nov 2005 20:39
Location: Germany

Re: Website and Help Typos

Post by PeterH »

Just happened to see: in Help, ScriptgCmds end

2 times the var <br> is shown as "<br>", when no need for it.

That's not wrong - but people might think it must be that way.
(And it's longer :roll: )
W7(x64) SP1 German
( +WXP SP3 )

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

Re: Website and Help Typos

Post by admin »

next level pedantry :titter:

PeterH
Posts: 2776
Joined: 21 Nov 2005 20:39
Location: Germany

Re: Website and Help Typos

Post by PeterH »

A bit more of a real world problem:
Command load's 3rd operand is named [resource type], i.e. 2 words.

A person reading it often just doesn't notice that.
But a parser trying to "understand" commands, operands, syntax description etc does :(
(Yes: still working on that...)
And a 2-word-op-name seems to be bad syntax, doesn't it?

So could you please change it, e.g. to [resource_type], as is for many other op-names - that would help a lot!
(My parser says 'Thanks'!)
W7(x64) SP1 German
( +WXP SP3 )

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

Re: Website and Help Typos

Post by admin »

Will be corrected in the next Help.

PeterH
Posts: 2776
Joined: 21 Nov 2005 20:39
Location: Germany

Re: Website and Help Typos

Post by PeterH »

:tup:
Thanks!
W7(x64) SP1 German
( +WXP SP3 )

kiwichick
Posts: 557
Joined: 08 Aug 2012 04:14
Location: Pahiatua, New Zealand

Re: Website and Help Typos

Post by kiwichick »

Not Website or Help. Not even a typo really. Just an inconsistency issue for those pedants among us :biggrin:

In the config there is a mix of 'and' usage. Sometimes it's and, other times it's &.

For example:
Tree and List
Startup & Exit
Windows 10 Pro 22H2

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

Re: Website and Help Typos

Post by admin »

Agreed. But changing it would create an avalanche of work, and throw mountains of documentation into inconsistency with the new reality. So take it as a challenge and endure it. :)

PeterH
Posts: 2776
Joined: 21 Nov 2005 20:39
Location: Germany

Re: Website and Help Typos

Post by PeterH »

Something went wrong...
I always saw Windows-Help and .pdf-Help identical. So I didn't specify...

I need the correct description of load() operand resource_type in the pdf...
There it still contains the ' ' :cry:


By the way, to the (general) difference between Win-Help and .pdf-Help: the .pdf is less wide, and so formatting *sometimes* is quite bad.
An example is the shaded area behind "Example:" of the command inputselect, just a few lines in front of interfacecolors.
$list = <<<>>>
C:\Program Files (x86)\7-Zip\7zFM.exe
7-Zip|C:\Program Files (x86)\7-Zip\7zFM.exe
7-Zip|7-Zip Selected|C:\Program Files (x86)\7-Zip\7zFM.exe
>>>;
text inputselect("Test: Caption|Data|Icon", $list, <crlf>, 1 + 1024);
// 1st entry: Caption -> Caption, Return, Icon: C:\Program Files (x86)\7-
Zip\7zFM.exe
// 2nd entry: Caption|Data -> Caption: 7-Zip; Return, Icon: C:\Program Files
(x86)\7-Zip\7zFM.exe
// 3rd entry: Caption|Data|Icon -> Caption: 7-Zip; Return: 7-Zip Selected; Icon: C:
\Program Files (x86)\7-Zip\7zFM.exe
See the last 6 lines - that in real are only 3 lines, but rather long ones. In real:
// 1st entry: Caption -> Caption, Return, Icon: C:\Program Files (x86)\7-Zip\7zFM.exe
// 2nd entry: Caption|Data -> Caption: 7-Zip; Return, Icon: C:\Program Files(x86)\7-Zip\7zFM.exe
// 3rd entry: Caption|Data|Icon -> Caption: 7-Zip; Return: 7-Zip Selected; Icon: C:\Program Files (x86)\7-Zip\7zFM.exe
It's really hard to read this way...
W7(x64) SP1 German
( +WXP SP3 )

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

Re: Website and Help Typos

Post by admin »

Windows-Help and .pdf-Help are identical. :?

The PDF layout options are quite limited in the Help software. :|

PeterH
Posts: 2776
Joined: 21 Nov 2005 20:39
Location: Germany

Re: Website and Help Typos

Post by PeterH »

My misunderstanding?
25.7. 9:37 you reported new beta AND new help file. so about noon I downloaded the help-pdf.
25.7. 20:00 you reported the full version - then I downloaded that, too.

Seems the pdf was ready only after the info about full version?
Then * Updated the help file. might be a bit misleading. Could even mean that this beta includes the new Win-Help...

At least: a new downloaded pdf-help is OK :tup:
Thanks again!

Too bad for formatting.
Could you maybe change the reported text, so that each line is splitted where you want, eg like:
(Sorry: also for quote multi-' ' are deleted. Idea is to deeper indent the text part of every 2nd line, now shown by dots)
// 1st entry: Caption -> Caption, Return, Icon:
// . . C:\Program Files (x86)\7-Zip\7zFM.exe
// 2nd entry: Caption|Data -> Caption: 7-Zip;
// . . Return, Icon: C:\Program Files(x86)\7-Zip\7zFM.exe
// 3rd entry: Caption|Data|Icon -> Caption: 7-Zip; Return: 7-Zip Selected;
// . . Icon: C:\Program Files (x86)\7-Zip\7zFM.exe
W7(x64) SP1 German
( +WXP SP3 )

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

Re: Website and Help Typos

Post by admin »

No. :)

jupe
Posts: 2757
Joined: 20 Oct 2017 21:14
Location: Win10 22H2 120dpi

Re: Website and Help Typos

Post by jupe »

SC font still doesn't have "r" listed as one of the options for the area param, although the examples show it is valid.

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

Re: Website and Help Typos

Post by admin »

:tup:

Post Reply