Help file - Poll

[AZJIO]

I think the best option is to make the compiler as a program that provides a range of compilation mode. Then every advanced user would choose a set that match your preferences. And vote for standard option would be already on a real choice.

Edited August 17, 2013 by AZJIO

[mLipok]

I copied the source code, pasted it into Word and I got this:

www.autoitscript.com/autoit3/mvps/functions/InetGetInfo.htm CTRL + click to follow link

 

Please make an example, as it is described below

copy text as you copy it

paste it into three different editors

WORD

WordPad

SciTE

save these three documents, and make a ZIP archive

and put it to this thread as an attachment

 

EDIT:

Then we will see clearly what You mean.

Edited August 17, 2013 by mlipok

[Melba23]

mlipok,

Why do you need a zip? I get the links if I copy and paste from the Help page to which the first post link into a "link-aware" app such as WordPad or the "WYSIWYG" forum editor - I do not get the links when I paste into SciTE, NotePad or the basic forum editor. It is as simple as that.

M23

[mLipok]

in post #18

JohnOne post an example

 

The sample script ends at

EndFunc; ==> Example

Try clicking on the keyword "EndFunc"

What's going on? Browser goes to the relevant documentation.

 

 

 

another explantation:

in this part of the script

MsgBox ($ MB_SYSTEMMODAL, "", "The total download size:" & $ iBytesSize & @ CRLF & _
             "The total filesize:" & $ iFileSize)

Try clicking the function "MsgBox"

What's going on? Browser goes to the relevant documentation.

 

 

I think that's what he meant @ guinness

moreover, as I am, in one of the posts to the thread

 

http://www.autoitscript.com/forum/topic/152648-report-help-file-issues-here-part2/page-22#entry1107647

 

http://www.autoitscript.com/forum/topic/152648-report-help-file-issues-here-part2/page-22#entry1107649

 

 

EDIT1:

In addition, I tried to explain that the idea is to EDIT2: stoswne appropriate links between its records, were used in HelpFile (CHM)

EDIT3:

?do=embed' frameborder='0' data-embedContent>'?do=embed' frameborder='0' data-embedContent>>?do=embed' frameborder='0' data-embedContent>/page-22#entry1107647

?do=embed' frameborder='0' data-embedContent>'?do=embed' frameborder='0' data-embedContent>>?do=embed' frameborder='0' data-embedContent>/page-22#entry1107649

Edited August 17, 2013 by mlipok

[czardas]

@mlipok that's not English. stoswne is not English. I can't understand what you mean.

[mLipok]

mlipok,

Why do you need a zip? I get the links if I copy and paste from the Help page to which the first post link into a "link-aware" app such as WordPad or the "WYSIWYG" forum editor - I do not get the links when I paste into SciTE, NotePad or the basic forum editor. It is as simple as that.

M23

 

Perhaps I misunderstood all the statements of the participants of the conversation.

Therefore, I ask one question to @czardas

I think that explains it all clearly - at least for me.

 

QUESTION: to @czardas 

When You wrote post #3 if You mean the line number 14 the following example.

#include <InetConstants.au3>
#include <MsgBoxConstants.au3>

; Download a file in the background.
; Wait for the download to complete.

Example()

Func Example()
    ; Save the downloaded file to the temporary folder.
    Local $sFilePath = @TempDir & "\update.dat"

    ; Download the file in the background with the selected option of 'force a reload from the remote site.'
    Local $hDownload = InetGet("http://www.autoitscript.com/autoit3/files/beta/update.dat", @TempDir & "\update.dat", $INET_FORCERELOAD, $INET_DOWNLOADBACKGROUND)

    ; Wait for the download to complete by monitoring when the 2nd index value of InetGetInfo returns True.
    Do
        Sleep(250)
    Until InetGetInfo($hDownload, $INET_DOWNLOADCOMPLETE)

    ; Retrieve the number of total bytes received and the filesize.
    Local $iBytesSize = InetGetInfo($hDownload, $INET_DOWNLOADREAD)
    Local $iFileSize = FileGetSize($sFilePath)

    ; Close the handle returned by InetGet.
    InetClose($hDownload)

    ; Display details about the total number of bytes read and the filesize.
    MsgBox($MB_SYSTEMMODAL, "", "The total download size: " & $iBytesSize & @CRLF & _
            "The total filesize: " & $iFileSize)

    ; Delete the file.
    FileDelete($sFilePath)
EndFunc   ;==>Example

If the answer to my question is positive

Then the final explanation of the problem about which wrote @czardas is in post #16

 

If the answer to my question is negative

then I think that the idea of packing it taking three sample documents in three other editors is a good idea.

[czardas]

QUESTION: to @czardas 

When You wrote post #3 if You mean the line number 14 the following example.

 

No not that.

If the answer to my question is negative

then I think that the idea of packing it taking three sample documents in three other editors is a good idea.

 

The behaviour is both expected and understood. Further confirmation is not required.

Edited August 17, 2013 by czardas

[mLipok]

ok

[Ascend4nt]

czardas and others,

Any time you copy from HTML in Windows, you will get multiple formats of the data placed onto the clipboard.  One of these will be of type HTML, and there will always be a plain-Text variant (ansi and/or unicode).  You'll also most likely see Rich Text format as well.

As it stands now, the current Help file may not contain links, but it contains a lot of HTML formatting information as well as links to stylesheets and the source of the HTML, which is only picked up by an HTML-aware editor (the links are invalid in this case).  Forum code that is copied also pulls over all the url links and formatting data.

Basically, any concerns about embedded data being transferred over is pointless. Nobody programs in an editor that uses rich text formatting or embedded links..  unless they have a few screws loose.  Which is why a 'paste' operation in any code editor will pull the plain-text variant of the clipboard data, and ignore the HTML format.

[guinness]

I consider testing in chm format needs to be done before this can be accepted as a yes. At least prove beyond doubt that that it works for everyone.

 

Agree, the autolink in examples is neat but should not create any other issues or else things should remain as they are.

Jos

What kind of help file developer would I be if I didn't test before. -_0

It works in chm. Also using the copy to clipboard feature doesn't copy the links as some people thought it would, even when pasting to into Word.

So now what do people think?

[Jos]

What kind of help file developer would I be if I didn't test before. -_0

Rhetorical or do you actually want an answer?

It works in chm. Also using the copy to clipboard feature doesn't copy the links as some people thought it would, even when pasting to into Word.

 

So now what do people think?

 

I still believe it is a neat option and think we have a good exchange of opinions going on here.

My current conclusion would be that I haven't seen any real reason not to do it.

Jos

[guinness]

Rhetorical or do you actually want an answer?

It was rhetorical on this occasion.

I still believe it is a neat option and think we have a good exchange of opinions going on here.

My current conclusion would be that I haven't seen any real reason not to do it.

Same.

Since no additional votes have come in I will look at adding to the next beta, so people can get a feel for it. No promises though.

[Jos]

Since no additional votes have come in I will look at adding to the next beta, so people can get a feel for it. No promises though.

 

I can do the update if you want, generate a test helpfile and make that available, so people can do some actual testing with it.

Let me know when you want me to look at it.

Jos

[guinness]

I'll let you know. Thanks Jos.

[Melba23]

guinness,

 

It works in chm. Also using the copy to clipboard feature doesn't copy the links as some people thought it would, even when pasting to into Word.

You might think it does, but when I copy links from the current Help file (i.e. the ones under "Related") these links are still there when I paste into Word or any other "link-aware" app unless I use "Paste Special" or some other option. Will the links in the examples be different in any way?

And rather than waiting until the next Beta, can you not compile a stand-alone Help file with these additional links for people to check.

M23

Edit: I see my phone call interruption has made this suggestion a little late.

Edited August 18, 2013 by Melba23

[guinness]

guinness,

 

You might think it does, but when I copy links from the current Help file (i.e. the ones under "Related") these links are still there when I paste into Word or any other "link-aware" app unless I use "Paste Special" or some other option. Will the links in the examples be different in any way?

Of course if you highlight the example, then copy and paste it's exactly the same as the help file. But users should be copying code using the 'Copy to Clipboard' link, which doesn't copy the links.

[Melba23]

guinness,

 

But users should be copying code using the 'Copy to Clipboard' link

Until you pointed it out I never even realised that there even was such a link!

I very rarely use anything but "mouse highlight and Ctrl-C" when copying - and I am sure many others are the same. But, as I cannot imagine that I would ever post example code into a "link-aware" editor, retaining my usual copy mode is unlikely to cause me any problems.

However trying out a modified Help file before the final decision is an excellent idea.

M23

[guinness]

Until you pointed it out I never even realised that there even was such a link!

It's a new feature of the beta help file. I think added back v3.3.9.5?!

[czardas]

Any time you copy from HTML in Windows, you will get multiple formats of the data placed onto the clipboard.  One of these will be of type HTML, and there will always be a plain-Text variant (ansi and/or unicode).  You'll also most likely see Rich Text format as well.

 

@Ascend4nt - I know, and it's one of the most annoying things about copying text from the internet. I added features to my own editor to strip out any unwanted formatting and characters which string along for the ride. For me it's more of an annoyance factor than anything else. Why does computing have to be so complicated for people?

@Everyone Else - If you think it's for the best then go for it. I know most people will love this feature, unless perhaps you have to maintain it yourself in the future.

Edit

I also think about things like all the trouble Jon had with the forum code boxes over the years due mainly to the complexity factor (because people keep changing stuff - like me with this post). I have nothing against progress at all. The forum code boxes still have issues, some of which are not at all pleasant to have to deal with.

Edited August 18, 2013 by czardas

[JohnOne]

I voted yes, but unless a poll got an overwhelming yes, I don't think it should be considered.

The way I see it is there are sometimes many functions used in an example to demonstrate one function, a simple click to hop to any of them would benefit beginners.