AFL Library

This is read-only version of AFL library entry. Ability to add user formulas and comment is only available from members-only area.

Details:

DISCLAIMER: Most formulas present in AFL on-line library are submitted by the users and are provided here on an "as is" and "as available" basis. AmiBroker.com makes no representations or warranties of any kind to the contents or the operation of material presented here. We do not maintain nor provide technical support for 3rd party formulas.
Description:

Release#5 Template and string functions

Put this database text file ( AFL_Glossary_1.afl ) into a folder called AFL_Glossary in your main AmiBroker Folder. This data is used by the AFL_Glossary_Converter program.

This is just an experiment for now.

Formula:

Template sample for Glossary Database entry --20081011

File Names:
   This database file should be named AFL_Glossary_1.txt or AFL_Glossary_1.afl.
   The database converter will look for .afl only if a .txt version is not
found.
   Files downloaded from the AFL Library will have the .afl extension.
   Files you make should have the .txt extension so they will override the .afl
    if they are an edited version, and so they will default to a text editor.

Font used: 
   Courier Regular 12 point fixed width UniCode UTF-8

Notes about template:
1. Text is ignored if it is not between Begin_entry: and End_entry: keywords.
   This allows Keyword: in comment lines outside the structure or the whole
entry
   to be ignored as shown below.
2. Text is ignored if the line does not start with a data item Keyword:
   This allows comment lines inside a structure.
   However, I would recommend starting a comment with "//" to be more clear.
3. The order of some items is important.
   A "*" below indicates an item that must follow the previous item.
4. Some items can be repeated as many time as needed.
   A "+" below indicated these items.
5. A group list file is used to determine where this entry belongs.
   The Tag_group: would have an entry for every level above this entry.
   An entry can also be a member of more than one group,
   for instance, a string function might also be a date or time function.
   The Tag_group: data are also treated as search tags.
6. A synonym could have an entry that simply references another entry.
7. The Version_AB: is 2 higher than the AFL version listed in functions doc.
   This is earliest version function name is added, but functionality may have
   been expanded at a later version.
8. Data type codes: s=string, n=number, b=boolean, c=color, d=dateTime. Caps if
Array allowed.

General Template:

//Begin_entry:  Starts an entry (// forces ignore this entry)
Name_entry:     Entry Text
Name_long:      Expanded Name
Description:    Short description of entry

Return_type:    Return Value type ( n, N, s, b, B, c, C, d, D)
Return_name:    Optional Descriptive Name of Return Value

Left_type:      Left Operand Value type ( n, N, s, b, B, c, C, d, D)
Left_name:      Optional Descriptive Name of Left Operand Value

Right_type:      Right Operand Value type ( n, N, s, b, B, c, C, d, D)
Right_name:      Optional Descriptive Name of Right Operand Value
Right_close:     Optional Text to close Right Operand or Argument

Arg_type:       +Argument Value type ( n, N, s, b, B, c, C, d, D)
Arg_name:       +*Optional Descriptive Name of Argument Value
Arg_default:    +*Optional Default Argument Value

Link_ABdoc:     Link url to AB manual document
Link_video:     Link url to AB video help
Link_tutorial:  Link url to AB tutorial doc
Link_KBdoc:     Link url to AB knowledge base
Link_UKBdoc:    Link url to Users knowledge base
Link_url:       +Link url to any useful page
Link_name:      +*Optional Name text for any Link above

Version_AB:     Earliest AB version to support feature (x.x)
Tag_group:      +Group term from group hierarchy list
Tag_search:     +Search term

Related_entry:  +Related Glossary entry
End_entry:      Ends this entry


// String manipulation functions:

Begin_entry:
Name_entry:     Asc()
Name_long:      get ASCII code of character
Description:    Returns the ASCII code number for a text character
Return_type:    n
Return_name:    ASCII_code
Arg_type:       s
Arg_name:       String
Arg_type:       n
Arg_name:       CharacterPosition
Arg_default:    0
Link_ABdoc:     http://www.amibroker.com/f?asc
Link_url:       http://en.wikipedia.org/wiki/ASCII
Link_name:      ASCII Defined
Link_url:       http://www.asciitable.com
Link_name:      ASCII Table
Version_AB:     4.8
Tag_group:      AFL
Tag_group:      Functions
Tag_group:      String manipulation
Tag_group:      Type Conversions
Tag_search:     ASCII
Tag_search:     character
Tag_search:     convert
Tag_search:     code
Related_entry:  
End_entry:


Begin_entry:
Name_entry:     StrToDateTime()
Name_long:      convert string to datetime
Description:    Returns datetime number from a text representation of the
Date/Time
Return_type:    d
Return_name:    DateTime
Arg_type:       s
Arg_name:       DateTimeText
Link_ABdoc:     http://www.amibroker.com/f?StrToDateTime
Version_AB:     4.8
Tag_group:      AFL
Tag_group:      Functions
Tag_group:      String manipulation
Tag_group:      Type Conversions
Tag_group:      Date and Time
Tag_search:     datetime
Tag_search:     date
Tag_search:     time
Tag_search:     convert
Related_entry:  DateTimeToStr()
Related_entry:  Now()
Related_entry:  DateTime()
Related_entry:  TimeNum()
Related_entry:  Date()
End_entry:


Begin_entry:
Name_entry:     DateTimeToStr()
Name_long:      convert datetime to string
Description:    Returns a text representation of the datetime number
Return_type:    s
Return_name:    DateTimeText
Arg_type:       d
Arg_name:       DateTime
Link_ABdoc:     http://www.amibroker.com/f?DateTimeToStr
Version_AB:     4.8
Tag_group:      AFL
Tag_group:      Functions
Tag_group:      String manipulation
Tag_group:      Type Conversions
Tag_group:      Date and Time
Tag_search:     datetime
Tag_search:     date
Tag_search:     time
Tag_search:     convert
Related_entry:  StrToDateTime()
Related_entry:  Now()
Related_entry:  DateTime()
Related_entry:  TimeNum()
Related_entry:  Date()
End_entry:


Begin_entry:
Name_entry:     StrToNum()
Name_long:      convert string to number
Description:    Returns a number from a text representation of a number
Return_type:    n
Return_name:    number
Arg_type:       s
Arg_name:       numberStr
Link_ABdoc:     http://www.amibroker.com/f?StrToNum
Version_AB:     4.5
Tag_group:      AFL
Tag_group:      Functions
Tag_group:      String manipulation
Tag_group:      Type Conversions
Tag_search:     convert
Tag_search:     number
Related_entry:  StrToDateTime()
Related_entry:  WriteVal()
End_entry:


Begin_entry:
Name_entry:     NumToStr()
Name_long:      convert number to string
Description:    Returns a text representation of a number or one element of an
array
Return_type:    s
Return_name:    NumberStr
Arg_type:       N
Arg_name:       NumArray
Arg_type:       n
Arg_name:       Format
Arg_default:    1.3
Arg_type:       b
Arg_name:       Separator
Arg_default:    True
Link_ABdoc:     http://www.amibroker.com/f?NumToStr
Version_AB:     4.5
Tag_group:      AFL
Tag_group:      Functions
Tag_group:      String manipulation
Tag_group:      Type Conversions
Tag_group:      Date and Time
Tag_search:     datetime
Tag_search:     date
Tag_search:     time
Tag_search:     convert
Tag_search:     format
Related_entry:  StrToDateTime()
Related_entry:  Now()
Related_entry:  DateTime()
Related_entry:  TimeNum()
Related_entry:  Date()
Related_entry:  StrToNum()
Related_entry:  WriteVal()
End_entry:


Begin_entry:
Name_entry:     WriteVal()
Name_long:      convert array or number to string --Synonym
Description:    Synonym for NumToStr()
Return_type:    s
Return_name:    NumberText
Arg_type:       N
Arg_name:       NumArray
Arg_type:       n
Arg_name:       Format
Arg_default:    1.3
Arg_type:       b
Arg_name:       Separator
Arg_default:    True
Link_ABdoc:     http://www.amibroker.com/f?WriteVal
Version_AB:     x.x
Tag_group:      AFL
Tag_group:      Functions
Tag_group:      String manipulation
Tag_group:      Type Conversions
Tag_group:      Date and Time
// excluded search tags, because want searches to hit NumToStr()
Related_entry:  NumToStr()
End_entry:


Begin_entry:
Name_entry:     StrFormat()
Name_long:      write formatted output to string
Description:    Returns a formatted string from format and optional values
Return_type:    s
Return_name:    Formatted String
Arg_type:       s
Arg_name:       formatString
// Number of additional arguments is determined by formatString
// Need one Arg for each format spec in formatString
// No way to specify a variable number of arguments, so I fake it
Arg_type:       N
Arg_name:       OptionalValue
Arg_type:       N
Arg_name:       ...
Link_ABdoc:     http://www.amibroker.com/f?StrFormat
Link_url:       http://en.wikipedia.org/wiki/Printf
Link_name:      Printf Defined
Link_url:       http://www.cplusplus.com/reference/clibrary/cstdio/printf.html
Link_name:      C++ Format String Spec
// Badly need a real AFL spec doc --perhaps a UKB article
Version_AB:     4.5
Tag_group:      AFL
Tag_group:      Functions
Tag_group:      String manipulation
Tag_group:      Type Conversions
Tag_search:     convert
Tag_search:     format
Related_entry:  printf()
End_entry:


Begin_entry:
Name_entry:     printf()
Name_long:      print formatted output
Description:    write formatted output to commentary or interpretation window
Arg_type:       s
Arg_name:       formatString
// Number of additional arguments is determined by formatString
// Need one Arg for each format spec in formatString
// No way to specify a variable number of arguments, so I fake it
Arg_type:       N
Arg_name:       OptionalValue
Arg_type:       N
Arg_name:       ...
Link_ABdoc:     http://www.amibroker.com/f?StrFormat
Link_url:       http://en.wikipedia.org/wiki/Printf
Link_name:      Printf Defined
Link_url:       http://www.cplusplus.com/reference/clibrary/cstdio/printf.html
Link_name:      C++ Format String Spec
// Badly need a real AFL spec doc --perhaps a UKB article
Version_AB:     4.5
Tag_group:      AFL
Tag_group:      Functions
Tag_group:      String manipulation
Tag_group:      Type Conversions
Tag_search:     convert
Tag_search:     print
Tag_search:     format
Related_entry:  StrFormat()
End_entry:


Begin_entry:
Name_entry:     StrExtract()
Name_long:      get item from CSV string
Description:    Returns one item from a comma separated list
Return_type:    s
Return_name:    itemStr
Arg_type:       s
Arg_name:       list
Arg_type:       n
Arg_name:       item
Link_ABdoc:     http://www.amibroker.com/f?StrExtract
Version_AB:     4.4
Tag_group:      AFL
Tag_group:      Functions
Tag_group:      String manipulation
Tag_search:     find
Tag_search:     extract
Tag_search:     CSV
Tag_search:     comma separated
Tag_search:     list
Tag_search:     item
Related_entry:  CategoryGetSymbols()
Related_entry:  StrMid()
End_entry:


Begin_entry:
Name_entry:     StrFind()
Name_long:      find substring in a string
Description:    Returns character index of substring in a string
Return_type:    n
Return_name:    index
Arg_type:       s
Arg_name:       string
Arg_type:       s
Arg_name:       substring
Link_ABdoc:     http://www.amibroker.com/f?StrFind
Version_AB:     4.5
Tag_group:      AFL
Tag_group:      Functions
Tag_group:      String manipulation
Tag_search:     find
Tag_search:     extract
Tag_search:     list
Tag_search:     item
Related_entry:  StrExtract()
Related_entry:  StrReplace()
Related_entry:  StrMid()
End_entry:


Begin_entry:
Name_entry:     StrReplace()
Name_long:      replaces substring in a string
Description:    Returns a string with all substrings replaced with a new
substring
Return_type:    s
Return_name:    string
Arg_type:       s
Arg_name:       oldSubstring
Arg_type:       s
Arg_name:       newSubstring
Link_ABdoc:     http://www.amibroker.com/f?StrReplace
Version_AB:     4.9
Tag_group:      AFL
Tag_group:      Functions
Tag_group:      String manipulation
Tag_search:     find
Tag_search:     replace
Tag_search:     edit
Tag_search:     change
Related_entry:  StrFind()
End_entry:


Begin_entry:
Name_entry:     StrMid()
Name_long:      extracts substring from a string
Description:    Returns a substring of a string
Return_type:    s
Return_name:    string
Arg_type:       s
Arg_name:       string
Arg_type:       n
Arg_name:       startChar
Arg_type:       n
Arg_name:       charCount
Link_ABdoc:     http://www.amibroker.com/f?StrMid
Version_AB:     4.0
Tag_group:      AFL
Tag_group:      Functions
Tag_group:      String manipulation
Tag_search:     extract
Tag_search:     middle
Tag_search:     substring
Related_entry:  StrFind()
Related_entry:  StrExtract()
Related_entry:  StrLeft()
Related_entry:  StrRight()
Related_entry:  StrLen()
Related_entry:  StrReplace()
End_entry:


Begin_entry:
Name_entry:     StrLeft()
Name_long:      extracts left part of a string
Description:    Returns the first portion of a string
Return_type:    s
Return_name:    string
Arg_type:       s
Arg_name:       string
Arg_type:       n
Arg_name:       charCount
Link_ABdoc:     http://www.amibroker.com/f?StrLeft
Version_AB:     4.0
Tag_group:      AFL
Tag_group:      Functions
Tag_group:      String manipulation
Tag_search:     extract
Tag_search:     left
Tag_search:     first
Tag_search:     substring
Related_entry:  StrFind()
Related_entry:  StrExtract()
Related_entry:  StrMid()
Related_entry:  StrRight()
Related_entry:  StrLen()
Related_entry:  StrReplace()
End_entry:


Begin_entry:
Name_entry:     StrRight()
Name_long:      extracts right part of a string
Description:    Returns the last portion of a string
Return_type:    s
Return_name:    string
Arg_type:       s
Arg_name:       string
Arg_type:       n
Arg_name:       charCount
Link_ABdoc:     http://www.amibroker.com/f?StrRight
Version_AB:     4.0
Tag_group:      AFL
Tag_group:      Functions
Tag_group:      String manipulation
Tag_search:     extract
Tag_search:     right
Tag_search:     last
Tag_search:     substring
Related_entry:  StrFind()
Related_entry:  StrExtract()
Related_entry:  StrMid()
Related_entry:  StrLeft()
Related_entry:  StrLen()
Related_entry:  StrReplace()
End_entry:


Begin_entry:
Name_entry:     StrToLower()
Name_long:      converts a string to lowercase
Description:    Returns the lowercase version of a string
Return_type:    s
Return_name:    string
Arg_type:       s
Arg_name:       string
Link_ABdoc:     http://www.amibroker.com/f?StrToLower
Version_AB:     4.8
Tag_group:      AFL
Tag_group:      Functions
Tag_group:      String manipulation
Tag_search:     convert
Tag_search:     lowercase
Tag_search:     uppercase
Related_entry:  StrToUpper()
Related_entry:  StrReplace()
End_entry:


Begin_entry:
Name_entry:     StrToUpper()
Name_long:      converts a string to uppercase
Description:    Returns the uppercase version of a string
Return_type:    s
Return_name:    string
Arg_type:       s
Arg_name:       string
Link_ABdoc:     http://www.amibroker.com/f?StrToUpper
Version_AB:     4.8
Tag_group:      AFL
Tag_group:      Functions
Tag_group:      String manipulation
Tag_search:     convert
Tag_search:     lowercase
Tag_search:     uppercase
Related_entry:  StrToLower()
Related_entry:  StrReplace()
End_entry:


Begin_entry:
Name_entry:     StrLen()
Name_long:      get string length
Description:    Returns the number of characters in a string
Return_type:    n
Return_name:    stringLength
Arg_type:       s
Arg_name:       string
Link_ABdoc:     http://www.amibroker.com/f?StrLen
Version_AB:     3.5
Tag_group:      AFL
Tag_group:      Functions
Tag_group:      String manipulation
Tag_search:     extract
Tag_search:     right
Tag_search:     last
Tag_search:     left
Tag_search:     first
Tag_search:     middle
Tag_search:     substring
Related_entry:  StrFind()
Related_entry:  StrExtract()
Related_entry:  StrMid()
Related_entry:  StrLeft()
Related_entry:  StrLen()
Related_entry:  StrReplace()
End_entry:

Comments: