Jump to content

Links in the Examples.  

21 members have voted

  1. 1. Should there be links to functions and macros in the examples?

    • Yes
      17
    • No
      4


Recommended Posts

Posted

I think it changed once I confirmed chm wouldn't be affected/broken.

UDF List:

  Reveal hidden contents

Updated: 22/04/2018

Posted
  On 8/18/2013 at 8:26 PM, czardas said:

It wasn't me. :unsure:

Ha, obvious what your vote was Dr No.

UDF List:

  Reveal hidden contents

Updated: 22/04/2018

Posted (edited)
  On 8/18/2013 at 9:10 PM, AZJIO said:

99% is used offline help. Then the idea makes no sense.

 

I don''t think the intention is to link to the online version, just (offline links) within the chm itself. There should be some links to online resources such as MSDN of course.


BTW - I added some additional considerations to >#77.

Edited by czardas
Posted (edited)
  On 8/18/2013 at 9:10 PM, AZJIO said:

99% is used offline help. Then the idea makes no sense.

 

lets try a step by step example, 

open  HelpFile form AutoIT 3.3.8.1 instalation 

search and open documentation for "If...ElseIf...Else...EndIf"

do You see HelpFile this example:

Local $var = ""
If $var > 0 Then
    MsgBox(4096, "", "Value is positive.")
ElseIf $var < 0 Then
    MsgBox(4096, "", "Value is negative.")
Else
    If StringIsXDigit($var) Then
        MsgBox(4096, "", "Value might be hexadecimal!")
    Else
        MsgBox(4096, "", "Value is a string.")
    EndIf
EndIf

try to click (Left Mouse Button)

MsgBox which is in 3 line

do this online

do this off line in CHM

Now the question:

in CHM = offline version, when someone clicks on any function located within the example, Why HelpFile simply does not go to the relevant parts of the documentation, describing how the MsgBox function  works.

 

Conclusion:

This thread is trying to gather opinions on:
Does HelpFile (offline, CHM) so easy passes, from the functions used in the example, to a proper description of the function (EDIT: inside the HelpFile not on the internet) , is a feature that will be useful.
 
 
That is my opinion on this thread.
 
EDIT2:
and that is why from the beginning I vote for that.
Edited by mlipok

Signature beginning:
Please remember: "AutoIt"..... *  Wondering who uses AutoIt and what it can be used for ? * Forum Rules *
ADO.au3 UDF * POP3.au3 UDF * XML.au3 UDF * IE on Windows 11 * How to ask ChatGPT for AutoIt Codefor other useful stuff click the following button:

  Reveal hidden contents

Signature last update: 2023-04-24

Posted

AZJIO's help file pretty much demonstrates what I was about to upload, though I had removed the message box alert.

UDF List:

  Reveal hidden contents

Updated: 22/04/2018

Posted

Strange, I still don't see any buttons (win XP SP3). It highlights the code in a weird way. It looks as if brackets are not being highlighted although they do get copied. The links work fine.

Posted
  On 8/18/2013 at 10:18 PM, czardas said:

Strange, I still don't see any buttons (win XP SP3). It highlights the code in a weird way. It looks as if brackets are not being highlighted although they do get copied. The links work fine.

No issue on Windows 7.

UDF List:

  Reveal hidden contents

Updated: 22/04/2018

Posted (edited)

Well maybe I just have to update my software. Compairing this to an older version, I have to say I've made my mind up which I prefer. The reasons are unrelated to the missing buttons. It's starting to behave more and more like a web page. Not to say I don't appreciate your efforts.

Edited by czardas
Posted
  On 8/18/2013 at 10:25 PM, guinness said:

No issue on Windows 7.

I confirm

but I want to emphasize that from what I see I would not call them buttons
 
Visually, it is rather the text,
one is in the upper left corner of the frame surrounding the example
second in the top right corner of the frame.

Signature beginning:
Please remember: "AutoIt"..... *  Wondering who uses AutoIt and what it can be used for ? * Forum Rules *
ADO.au3 UDF * POP3.au3 UDF * XML.au3 UDF * IE on Windows 11 * How to ask ChatGPT for AutoIt Codefor other useful stuff click the following button:

  Reveal hidden contents

Signature last update: 2023-04-24

Posted

They're text links to javascript functions.

UDF List:

  Reveal hidden contents

Updated: 22/04/2018

Posted (edited)

Yeah, it's unrelated to the other html effects. Mouse selecton highlighting suffers.

html is just weird and always has been. Inconsistancy in rendering between browsers being the main issue.

Edited by czardas
Posted

czardas,

Have your fears been confirmed?

UDF List:

  Reveal hidden contents

Updated: 22/04/2018

Posted (edited)

Well they were not so much fears, but rather an opinion. It has great advantages in the short term if you don't mind quirky web type behaviour. That's the trade-off.

Did you read the modifications to my post >#77?

Edited by czardas
Guest
This topic is now closed to further replies.
×
×
  • Create New...