The link (http://www.autohotkey.com/wiki/index.php?title=FAQ#Virus.3F in it is broken. The wiki has disappeared.AutoHotkey, AutoHotkey_L and compiled scripts often trigger false-positives with anti-virus software. For more information, see the community FAQ.
the broken link in the help
Started by
amnesiac
, Aug 22 2012 11:02 AM
13 replies to this topic
#1
amnesiac
-
- Members
- 124 posts
Posted 22 August 2012 - 11:02 AM
#2
Guests
-
- Guests
Posted 22 August 2012 - 11:13 AM
A backup copy is here <!-- m -->http://www.autohotke...faqbot/faq.html<!-- m --> (on occasion new links are added)
#3
amnesiac
-
- Members
- 124 posts
Posted 22 August 2012 - 12:56 PM
Thank you. However, why does someone remove the wiki?
#4
Guests
-
- Guests
Posted 22 August 2012 - 01:52 PM
Because P the new owner of the website didn't it was valuable enough (not used) - there were some useful pages in there scripts, faq, and a few tutorials but also a lot of incomplete repetitive material from the manual which wasn't being updated ... IF all goes well rumor has it that at some point the documentation pages on AutoHotkey.com will be editable by (some) users so there will be an option to add more examples and/or links to forum threads from within the online documentation.
#5
hoppfrosch
-
- Members
- 344 posts
Posted 23 August 2012 - 10:14 AM
... IF all goes well rumor has it that at some point the documentation pages on AutoHotkey.com will be editable by (some) users so there will be an option to add more examples and/or links to forum threads from within the online documentation.
Current AHK_L documentation is already editable through github. Feel free to participate in enhancing the documentation ...
I think the possibility to edit has to be restricted to some users (also in future) to ensure the consistency and high quality of the documentation, My personal opinion is that it isn't a good idea to link to forum threads, since those threads do have very seldom the quality to serve as documentation (unless the contain valueabel information). If threads contain valueable information to be linked in documentation, I think it is better to duplicate the info into documentation.
#6
Guests
-
- Guests
Posted 23 August 2012 - 10:42 AM
Yes, I know about github, but I find it not suitable for this purpose as many don't know how to use it where as many people will be able to edit a page or wiki for example. (Please don't start a GIT rules and GitHub "is so easy my grandmother could use it" discussion - I have no interest in setting up a git/hub account just for the sake of contributing a few lines to the documentation - I doubt many people will)
Just like we currently have a tutorial section on the forum which could be linked to from the documentation, there might be at some point be a LIB section of the forum. To take an example from a recent Ask for Help question: How to sort an Array? I see no need to post the code to sort an array in the documentation, but if there is a library (there is one actually) that provides sorting, merging, whatever-additional-functionality to arrays, a note + link in the documentation could suffice.
This (editable docs) has been discussed a number of times, and another point some users wanted to make is that it allows for more (extensive) examples. Some of the current examples in the documentation are pretty spartan, the Gui commands for instance. Of course there has to be some form of edit control but I leave that to the site owner(s) to figure out.
Just like we currently have a tutorial section on the forum which could be linked to from the documentation, there might be at some point be a LIB section of the forum. To take an example from a recent Ask for Help question: How to sort an Array? I see no need to post the code to sort an array in the documentation, but if there is a library (there is one actually) that provides sorting, merging, whatever-additional-functionality to arrays, a note + link in the documentation could suffice.
This (editable docs) has been discussed a number of times, and another point some users wanted to make is that it allows for more (extensive) examples. Some of the current examples in the documentation are pretty spartan, the Gui commands for instance. Of course there has to be some form of edit control but I leave that to the site owner(s) to figure out.
#7
hoppfrosch
-
- Members
- 344 posts
Posted 23 August 2012 - 11:57 AM
Definitely not ...Please don't start a GIT rules and GitHub "is so easy my grandmother could use it" discussion
Agree on more extensive examples As I'm currently doing some contributions to AHK_L documentation (simple enhancements and homgenization tasks), I realize that it is a "difficult process" to fulfill all the desired standards (Formatting, Code quality, ...) to ensure high quality and consistent documentation. Being an editor on a possibly free editable docs now seems to be a huge task in my eyes (if you take it serious). The old way using a Wiki as additional documentation was a good way - but the lack of participation is disillusioning.This (editable docs) has been discussed a number of times, and another point some users wanted to make is that it allows for more (extensive) examples. Some of the current examples in the documentation are pretty spartan, the Gui commands for instance. Of course there has to be some form of edit control but I leave that to the site owner(s) to figure out.
#8
Guests
-
- Guests
Posted 23 August 2012 - 12:11 PM
Regarding the wiki I agree - but that was partly because the wiki was separated from the docs so there was no link. I can imagine something like the official documentation being kept as is e.g. as help file and on github, but the online docs for the commands & functions here <!-- m -->http://www.autohotke...cs/commands.htm<!-- m --> having an editable component (trusted forum members or something) append or iframed to the bottom of the page(s).
I think the php documentation is partly community based info (if I remember the other discussions correctly they mentioned php as an example or even (parts of) MSDN) so it possible.
I think the php documentation is partly community based info (if I remember the other discussions correctly they mentioned php as an example or even (parts of) MSDN) so it possible.
#9
hoppfrosch
-
- Members
- 344 posts
Posted 23 August 2012 - 12:48 PM
You're right: you refer to Vanilla AHK - Online Documentation, while I refer to github sources for AHK_L offline and online help.
Let's see what future brings on this topic (AHK vs. AHK_L). We already have a discussion board on trello, where we try to coordinate changes to AHK_L documentation (that's at least my personal goal). Current work is based on github (which is gracefully denied by you), but you are welcome to participate in discussion. Feel free to pm me to get invited.
Let's see what future brings on this topic (AHK vs. AHK_L). We already have a discussion board on trello, where we try to coordinate changes to AHK_L documentation (that's at least my personal goal). Current work is based on github (which is gracefully denied by you), but you are welcome to participate in discussion. Feel free to pm me to get invited.
#10
Guests
-
- Guests
Posted 23 August 2012 - 01:25 PM
I already helped in the past for the v2 docs see here <!-- l --><a class="postlink-local" href="http://www.autohotkey.com/community/viewtopic.php?f=5&t=80611&hilit=documentation">viewtopic.php?f=5&t=80611&hilit=documentation</a><!-- l --> (personally I found it to be a pita with the diff-s and posting it but it worked to some extent)
One suggestion I still have is indivudual pages for the functions listed on the functions page:
<!-- l --><a class="postlink-local" href="http://www.autohotkey.com/community/viewtopic.php?p=502134#p502134">viewtopic.php?p=502134#p502134</a><!-- l -->
and reserve the functions page to explain, well functions ;-)
One suggestion I still have is indivudual pages for the functions listed on the functions page:
<!-- l --><a class="postlink-local" href="http://www.autohotkey.com/community/viewtopic.php?p=502134#p502134">viewtopic.php?p=502134#p502134</a><!-- l -->
and reserve the functions page to explain, well functions ;-)
#11
hoppfrosch
-
- Members
- 344 posts
Posted 23 August 2012 - 03:28 PM
One suggestion I still have is indivudual pages for the functions listed on the functions page:
<!-- l --><a class="postlink-local" href="http://www.autohotkey.com/community/viewtopic.php?p=502134#p502134">viewtopic.php?p=502134#p502134</a><!-- l -->
and reserve the functions page to explain, well functions ;-)
That's exactly what Lexikos and I already discussed on https://trello.com/#...2e040466599d/24. Lexikos already agreed with the idea (I did not know on your work mentioned above).
After taking a look at your work, I will take it as base to update AHK_L 1.1 documentation.
#12
Guests
-
- Guests
Posted 23 August 2012 - 03:40 PM
Be my guest 
As you can see the html/style is used as was the (then) default for the v2 docs so you may have to adapt it here and there. Can't help in the next few weeks but I could do the other funcs listed below my example post in a month or so, just post in this thread or in the v2 doc thread if you want me do it.
As you can see the html/style is used as was the (then) default for the v2 docs so you may have to adapt it here and there. Can't help in the next few weeks but I could do the other funcs listed below my example post in a month or so, just post in this thread or in the v2 doc thread if you want me do it.
#13
hoppfrosch
-
- Members
- 344 posts
Posted 23 August 2012 - 04:16 PM
... or join our trello board! ;-)
What a pity I missed the thread on AHK2 documentation - and nobody gave me a hint yet (beside you) ...
What a pity I missed the thread on AHK2 documentation - and nobody gave me a hint yet (beside you) ...
#14
Guests
-
- Guests
Posted 11 October 2012 - 06:57 PM
Any status update? Not much to see (publically) on GH or Trello ...... I will take it as base to update AHK_L 1.1 documentation.
