Modify

Opened 6 years ago

Closed 6 years ago

#2466 closed Feature Request (Completed)

Proposed amendments to the 74 files

Reported by: mlipok Owned by: Jpm
Milestone: 3.3.9.22 Component: Documentation
Version: Severity: None
Keywords: Cc:

Description

libExamples
_IEFormElementSetValue[5].au3 _IEFrameGetCollection.au3

txtFunctions
FileCreateShortcut.txt
FileOpenDialog.txt
ObjCreate.txt
StringRegExp.txt

txtlibfunctions
_ArrayDelete.txt
_ArrayDisplay.txt
_ArrayFindAll.txt
_ArrayMax.txt
_ArrayMin.txt
_ArrayPop.txt
_ArrayPush.txt
_ArraySearch.txt
_ArrayToClip.txt
_ClipBoard_ChangeChain.txt
_ClipBoard_Empty.txt
_ClipBoard_GetData.txt
_ClipBoard_GetDataEx.txt
_ClipBoard_GetOpenWindow.txt
_ClipBoard_GetOwner.txt
_ClipBoard_GetSequenceNumber.txt
_ClipBoard_Open.txt
_ClipBoard_RegisterFormat.txt
_ClipBoard_SetData.txt
_ClipBoard_SetDataEx.txt
_ClipBoard_SetViewer.txt
_Crypt_DecryptData.txt
_Crypt_DeriveKey.txt
_Crypt_DestroyKey.txt
_Crypt_HashData.txt
_Crypt_Shutdown.txt
_DateAdd.txt
_DateDiff.txt
_Date_Time_GetFileTime.txt
_Date_Time_LocalFileTimeToFileTime.txt
_Date_Time_SetFileTime.txt
_Date_Time_SetLocalTime.txt
_DebugCOMError.txt
_DebugOut.txt
_DebugReport.txt
_DebugReportEx.txt
_DebugReportVar.txt
_DebugSetup.txt
_Degree.txt
_FileWriteFromArray.txt
_IEAttach.txt
_IEBodyReadHTML.txt
_IEBodyReadText.txt
_IEBodyWriteHTML.txt
_IECreate.txt
_IECreateEmbedded.txt
_IEDocGetObj.txt
_IEDocInsertHTML.txt
_IEDocInsertText.txt
_IEDocReadHTML.txt
_IEDocWriteHTML.txt
_IEErrorNotify.txt
_IEFormElementGetObjByName.txt
_IEFormElementGetValue.txt
_IEFormElementSetValue.txt
_IEFormGetObjByName.txt
_IEFormSubmit.txt
_IEFrameGetCollection.txt
_IEFrameGetObjByName.txt
_IEHeadInsertEventScript.txt
_IEIsFrameSet.txt
_IELinkClickByIndex.txt
_IELinkClickByText.txt
_IELinkGetCollection.txt
_IELoadWait.txt
_IELoadWaitTimeout.txt
_IENavigate.txt
_IEQuit.txt

Attachments (1)

CHANGE_2.ZIP (70.0 KB) - added by mlipok 6 years ago.
74 files - proposals

Download all attachments as: .zip

Change History (13)

Changed 6 years ago by mlipok

74 files - proposals

comment:1 follow-ups: Changed 6 years ago by anonymous

first checking lead me

  1. Do we want to remove the ###Related### section?

that's the induction of adding those <a href= at least fora lot of them

  1. link to the function itself is not an improvement

edited: anonymous = jpm

Last edited 6 years ago by Jpm (previous) (diff)

comment:2 Changed 6 years ago by guinness

I guess you're on the case jpm.

comment:3 Changed 6 years ago by guinness

I added the fix for declaring a variable inside a loop and 5th example for _IEFormElementSetValue(). I will leave the rest for now. Thanks.

comment:4 in reply to: ↑ 1 Changed 6 years ago by mlipok

Replying to guinness:

I added the fix for declaring a variable inside a loop and 5th example for _IEFormElementSetValue(). I will leave the rest for now. Thanks.

thanks for info
i think 5th example
was missing link of, and very often asked question on forum

Replying to jpm:

  1. Do we want to remove the ###Related### section?

no

that's the induction of adding those <a href= at least fora lot of them

poorly understood me, or at least my intentions, but I understand your point of view.

  1. link to the function itself is not an improvement

I had exactly the same approach, but it changed.

More specifically, I will try to answer your comments in a few days.
Tomorrow I have a family day.

Regards
mlipok

comment:5 Changed 6 years ago by mlipok

btw
using grepWin (RegExp)

i found in Example StringRegExp.au3

For $i = 0 To UBound($aArray) - 1
	Local $match = $aArray[$i]

please
change to that

Local $match
For $i = 0 To UBound($aArray) - 1
	$match = $aArray[$i]

comment:6 Changed 6 years ago by guinness

Done.

comment:7 in reply to: ↑ 1 Changed 6 years ago by mlipok

Replying to Jpm:

  1. link to the function itself is not an improvement

look for WinGetText documentation.
in Remarks there is a 3 times a link to the described function.

What you feel reading this documentation, and seeing this all links ?

It confuse you ?
Or you are glad ?

I am glad because thus acquires a more readable text.

comment:8 in reply to: ↑ 1 Changed 6 years ago by mlipok

Replying to jpm:

first checking lead me

  1. Do we want to remove the ###Related### section?

that's the induction of adding those <a href= at least fora lot of them

When you read a book, at the bottom you have the information for the index of the page.
You can quickly jump into an appropriate description, and quickly return to continue reading.

When you finish reading the whole book, at the end you have a summary, including a list of indexes.

The same is true, in fact it should be, with electronic documentation.

You read the documentation for a function,
I read a description of the parameters you see any reference to other features, read in this way, you allow your mind to associate that particular parameter to another function.
In this way, the reading is context sensitive.

Related section, for me is a kind of census indexes, summary, where else can you look a reminder of what is related to a particular part of the documentation.
But beware, I believe that this section is very important.

Let me put it another way.
When you learn something, but based on paper records, or simply on the basis of clear text, you use a pen or marker to mark keywords?
It is natural for you?
For me, yes.

In the documentation, the sign, there are links that stand apart from other features of the text.

comment:9 Changed 6 years ago by Jpm

@mlipok
I am OK with your view.
no probem to continue to add links in all sections when needed

comment:10 Changed 6 years ago by mlipok

thanks

by the way I do there many other change
not only links
do you check it ?

comment:11 Changed 6 years ago by Jpm

just some

comment:12 Changed 6 years ago by Jpm

  • Milestone set to 3.3.9.22
  • Owner set to Jpm
  • Resolution set to Completed
  • Status changed from new to closed

Added by revision [9032] in version: 3.3.9.22

Guidelines for posting comments:

  • You cannot re-open a ticket but you may still leave a comment if you have additional information to add.
  • In-depth discussions should take place on the forum.

For more information see the full version of the ticket guidelines here.

Add Comment

Modify Ticket

Action
as closed The owner will remain Jpm.
Author


E-mail address and user name can be saved in the Preferences.

 
Note: See TracTickets for help on using tickets.