Documentation: Difference between revisions

From AutoIt Wiki
Jump to navigation Jump to search
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
There is extensive AutoIt documentation available and this documentation is your recommended reference. If you have AutoIt installed then you can find it in the SciTE editor if you press F1, or in the start menu under AutoIt > AutoIt Help File. Many developers keep the documentation or ''AutoIt Help File'', as it is better known, constantly open to look up functions and keywords.
There is extensive AutoIt documentation available and this documentation is your recommended reference. Many developers keep the documentation or ''AutoIt Help File'', as it is better known, constantly open to look up functions and keywords.


=Offline=
= Using the help file =
An offline copy of the help file is available for download on the official AutoIt home page. You download the [[AutoIt Full Installation]] or the [[AutoIt Self Extracting Archive]] which both contain the AutoIt help file.


==Using the help file==
[[File:Using-helpfile.png|300x226px|frame|Help file showing index]]
[[File:Using-helpfile.png|300x226px|frame|Help file showing index]]
If you have AutoIt installed then you can find it in the SciTE editor if you press [F1], or in the start menu under AutoIt > AutoIt Help File.
There are three common methods of using the help file. You can use the Contents tab to browse the help file by category, which allows you to quickly find the resource you're after based on the type of script you're writing. Alternatively, you can use the Index tab to search for a resource page by title; this is practical if you know the name of the function you're after. Finally, by using the Search tab you can search all documents for a word or phrase. This is helpful when looking for words that may appear in multiple resource pages.
As another alternative, if you are not finding the resource you're after, you can use Google to search in the online documentation.


There are three common methods of using the help file. You can use either the categories to browse the help file, use the index to search for document titles and use the search function to look in the entire page.
When in doubt, if you cannot find the answer to your problem, use the [[forums]].


Either one method is good and works well for a variety of situations. As an alternative to the search method, you can use Google to search in the online documentation which generally works better.
= Offline =


Still can not find an answer to your problem? Use the [[forums]].
An offline copy of the help file is available for download on the official AutoIt home page. You download the [[AutoIt Full Installation]] or the [[AutoIt Self Extracting Archive]] which both contain the AutoIt help file.
 
== Source ==


==Source==
The source code for the help file is available to anyone so that they can expand, modify or translate the original. After editing, the help file source code can be submitted to the development team.
The source code for the help file is available to anyone so that they can expand, modify or translate the original. After editing, the help file source code can be submitted to the development team.


<br clear="both" /> <!-- clears the image above -->
= Online =
=Online=
 
There is also online documentation available if you do not have or want to download the offline version. This is less convenient to use for regular development since some features that the offline help file offers are not supported.
There is also online documentation available if you do not have or want to download the offline version. This is less convenient to use for regular development since some features that the offline help file offers are not supported.


The online copy can be found here: [http://www.autoitscript.com/autoit3/docs/ Online documentation]
The online copy can be found here: [http://www.autoitscript.com/autoit3/docs/ Online documentation]


If you like to try AutoIt Online in your Webbrowser you can use [http://www.script-example.com/themen/AutoIT-Online-Compiler.php script-example.com free AutoIt Web Compiler]
If you'd like to try AutoIt Online in your Webbrowser you can use [http://www.script-example.com/themen/AutoIT-Online-Compiler.php script-example.com free AutoIt Web Compiler]
 
== Searching ==


==Searching==
Similar to the forums, you can use Google or your search engine of choice as a valuable searching tool. You start your query with ''site:http://www.autoitscript.com/autoit3/docs/'' and then your search query.
Similar to the forums, you can use Google or your search engine of choice as a valuable searching tool. You start your query with ''site:http://www.autoitscript.com/autoit3/docs/'' and then your search query.


Line 32: Line 37:
</syntaxhighlight>
</syntaxhighlight>


==Function list==
= Other languages =
Additionally, a list of all the functions exists on this Wiki. It is not maintained as regularly, and is redundant to the previously mentioned methods. You can find it on the [[Function list]] page.


=Other languages=
The AutoIt help file is available in a few other languages beside English.
The AutoIt help file is available in a few other languages beside English. Almost constantly translations in other languages are being written.  


You can find these help files here:  
You can find these help files here:  
[http://www.autoitscript.com/autoit3/docs.shtml Non-english documentation]
[http://www.autoitscript.com/autoit3/docs.shtml Non-english documentation]

Latest revision as of 20:24, 27 October 2014

There is extensive AutoIt documentation available and this documentation is your recommended reference. Many developers keep the documentation or AutoIt Help File, as it is better known, constantly open to look up functions and keywords.

Using the help file

Help file showing index

If you have AutoIt installed then you can find it in the SciTE editor if you press [F1], or in the start menu under AutoIt > AutoIt Help File.

There are three common methods of using the help file. You can use the Contents tab to browse the help file by category, which allows you to quickly find the resource you're after based on the type of script you're writing. Alternatively, you can use the Index tab to search for a resource page by title; this is practical if you know the name of the function you're after. Finally, by using the Search tab you can search all documents for a word or phrase. This is helpful when looking for words that may appear in multiple resource pages.

As another alternative, if you are not finding the resource you're after, you can use Google to search in the online documentation.

When in doubt, if you cannot find the answer to your problem, use the forums.

Offline

An offline copy of the help file is available for download on the official AutoIt home page. You download the AutoIt Full Installation or the AutoIt Self Extracting Archive which both contain the AutoIt help file.

Source

The source code for the help file is available to anyone so that they can expand, modify or translate the original. After editing, the help file source code can be submitted to the development team.

Online

There is also online documentation available if you do not have or want to download the offline version. This is less convenient to use for regular development since some features that the offline help file offers are not supported.

The online copy can be found here: Online documentation

If you'd like to try AutoIt Online in your Webbrowser you can use script-example.com free AutoIt Web Compiler

Searching

Similar to the forums, you can use Google or your search engine of choice as a valuable searching tool. You start your query with site:http://www.autoitscript.com/autoit3/docs/ and then your search query.

A finished query may look like: 

site:http://www.autoitscript.com/autoit3/docs/ GUICtrlCreateButton

Other languages

The AutoIt help file is available in a few other languages beside English.

You can find these help files here: Non-english documentation

Retrieved from "https://www.autoitscript.com/w/index.php?title=Documentation&oldid=12682"