This is part of the AutoHotkey Script Collection.
Copyright (c) 2008 Tuncay Devecioglu
See the file ahkcollec.xml at section license for copying conditions.


---+ [ The ahkml-Language ] +--------------------------------------------------


The ahkml language is actually a full XML based valid language. It describes 
    AutoHotkey scripts with atrributes like title and category, called meta 
    information and references to source files. The document type definition 
    file (ahkml10.dtd) ensures the validation of any ahkml document and is in
    every way normative.

This documentation does not explain the file format with its all dependencies 
    between the elements and attributes. For full documentation, look at the 
    xml source and the dtd itself. This does only explain, what data is 
    expected in corresponding elements and attributes.

The description below follows this: Any token between "<" and ">" are elements 
    and the tokens below them enclosed in double quotes are their attributes.
    A bang "(!)" means, that it is a strictly required element or attribute.


---+ [ Elements and Attributes ] +---------------------------------------------


<ahkml> ........... = The root element. (!)
    "version" ..... = Marks the used version of ahkml language. Only '1.0' is 
                        allowed. (!)
    "title" ....... = Specifies a title for the whole document.
    "location" .... = An URL is expected, pointing to an available source of 
                        this document.
    "creator" ..... = Name of the author of this document.
    "pubdate" ..... = The release date to public of this document. This is not 
                        the same as last modified. Format as like '2008-02-24' 
                        is expected.

<license> ......... = Depending where this is specified, it belongs to document 
                        or to a script. The text can be additionally splitted 
                        up by <p>-elements, but it is not required.
    "url" ......... = An URL pointing to full license text is expected here.

<preface> ......... = A general introduction section. The text splitted up by 
                        <p>-elements and can additionally contain <links>.

<depot> ........... = Such a container is a summary of related scripts (only 
                        <script>-elements). (!)
    "title" ....... = Descriptive name for the depot.
    "creator" ..... = Name of the author of this depot.

<script> .......... = An AutoHotkey script entry.
    "id" .......... = GUID, used to identify the script later; It must be 
                        unique. A format like 
                        "GUID_F661A15E-4C78-4904-9E4E-06343BA84080" is 
                        expected. (!)
    "added" ....... = Date when this entry was added first time to this depot. 
                        A format like "2008-02-20" is expected. (!)
    "update" ...... = Date when this entry was edited. A format like 
                        "2008-02-22" is expected.

<source> .......... = Source code of script. The element itself can contain 
                        text describing the source, i.e. as text at links. 
                        Default is "Source". (!)
    "url" ......... = A local or online reference to scripts source code. An 
                        URL format is expected. (!)

<title> ........... = User friendly name of script. (!)

<description> ..... = Long description about what the script does and what it 
                        is good for. The description can be splitted up into 
                        several paragraphs with <p>-element, but it does not 
                        need to have. (!)

<p> ............... = Paragraph used in some elements. Some of them requires 
                        and others do not. Paragraphs can contain links without 
                        in <links>-container elemens. Every <link> can be 
                        specified in flow of text.

<links> ........... = Usually contains just a collection of <link>-elements.

<link> ............ = Links used within <p>- and <links>-elements. Like the 
                        <a>-element in HTML, these refers to other related 
                        sites or resources. The text inside is used as 
                        descriptive text of link, but if no "url" is given, 
                        then the text is the url itself.
    "url" ......... = Standard URL format is expected. If this is not 
                        specified, then link text itself is the url.
    "lang" ........ = Optionally the language of target can be given here. A 
                        standard value like in HTML is expected, i.e. "en" or 
                        "de".

<keywords> ........ = Additional keywords for searching the database later. A 
                        simple comma separated list of words is expected.

<version> ......... = Identifies the version of script. The text inside 
                        <version> could be a clue to which variant is used or 
                        the current status of development or may be also if it 
                        is a debug version. This is free text, which is version 
                        related. (!)
    "revision" .... = The version number of script. A value in format "1.0.2" 
                        is expected.
    "date" ........ = The last edited or published date of script. A value in 
                        format "2008-02016" is expected. (!)

<author> .......... = The name of the developer of script. It is possible to 
                        specify more than one author. (!)
    "role" ........ = Givs optionally a hint to what type of work the author 
                        did, in relation to this version of script.

<classify> ........ = Some attributes to categorize the script. This cannot 
                        itself contain any text. Must have element. (!)
    "type" ........ = The usage type of script. Currently only these values 
                        are allowed: "Application|Library|Other". Application 
                        means a program to start with an autoexecution section 
                        and eventually having a user interface. In contrast 
                        Library is a script containing just functions or a set 
                        of other similiar routines to call. Other is a sort of 
                        joker, if it cannot somewhat be specified. (!)
    "category" .... = Free text for categorizing the script to any subject. If 
                        possible, its recommended to use any existing standard 
                        value like "Controls" or "FileSystem". (!)

<conform> ......... = Optional conformity checks. Text directly in this element 
                        is not allowed.
    "standalone" .. = If not depends on other function, source or external file 
                        via stdlib mechanism, #Include or #FileInstall, then it 
                        is "yes" (dllcall can be used). "yes|no"
    "stdlib" ...... = If usage of script and some other aspects are designed to 
                        work with the stdlib mechanism, then it is "yes". Also 
                        global variables are not allowed.  "yes|no"

<environment> ..... = The environment under the script was developed and 
                        tested. This is an optional element. Text in this 
                        element is not allowed.
    "ahkversion" .. = The version of AutoHotkey. This does not mean any 
                        requirement, just a note. A value like "1.0.47" is
                        expected.
    "platform" .... = Non standardized form of Windows version or type.

<specific> ........ = If the script is specifically designed to any other 
                        program, then this can be here noted as free text. The
                        name of that program or a list is expected here.
    "url" ......... = An URL to a site with more information or a download of 
                        that program.

<image> ........... = Optional screenshot of that scripts GUI or other 
                        interface. Text is not allowed.
    "url" ......... = Location of that image file, standard URL format is 
                        expected. (!)
    "border" ...... = Specifies, if the image should have a border around it. 
                        Allowed values are: "yes|no". "yes" is default.

<example> ......... = Here is an example code how to use the scripts function 
                        or other related tips, like showing the syntax. The 
                        space inside are preserverd as they are. It can contain 
                        freely any <c>-element also. Multiple examples are 
                        allowed.

<c> ............... = Marks the text logically as a comment. Only allowed in an 
                        <example>-element block.


---+ [ Full Empty Template ] +-------------------------------------------------


        <script 
            id=""
            added=""
            update="">
            <source url=""></source>
            <title></title>
            <description>
                <p></p>
            </description>
            <keywords></keywords>
            <version revision="" date=""></version>
            <author></author>
            <author role=""></author>
            <license url=""></license>
            <classify type="" category="" />
            <conform standalone="" stdlib="" />
            <environment ahkversion="" platform="" />
            <specific url=""></specific>
            <links>
                <link url="" lang=""></link>
            </links>
            <image url="" border="yes" />
            <example><c></c></example>
        </script>


---+ [ Template 1 ] +----------------------------------------------------------


        <script 
            id="GUID_"
            added="2008-">
            <source url="src/" />
            <title></title>
            <description>
                <p></p>
            </description>
            <keywords></keywords>
            <version revision="" date="" />
            <author></author>
            <classify type="Application|Library" category="" />
            <conform standalone="" stdlib="" />
            <links>
                <link url="http://www.autohotkey.com/forum/viewtopic.php?t=" lang="en">Discussion</link>
            </links>
            <image url="img/" />
            <example></example>
        </script>