Template
sample for Glossary Database entry --20080906
Font
used: Courier Regular 12 point fixed width UniCode UTF-8
Notes
about template:
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.
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 .
The
order of some items is important.
A
"*" below indicates an item that must follow the previous item.
Some
items can be repeated as many times as needed.
;A "+" below indicates these items.
A
group listing is used to determine to which groups 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.
A
synonym could have an entry that simply references another entry.
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 (a, n, t, an, nt)
Return_name:
Optional Descriptive Name of Return Value
Arg_type:
+Argument Value type (a, n, t, an, nt)
Arg_name:
+*Optional Descriptive Name o f Argument Value
Arg_default:
+*Optional Default Argument Value
Link_ABdoc:
Link url to AB manual document
Link_vi
deo: 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
//
The simplest synonym entry would look like this:
Begin_entry:
Name_entry:
AFL
Name_long:
AmiBroker Formula Language
Description:
Abbreviation for AmiBroker Formula Language
Tag_group:
AFL
Related_entry: AmiBroker
Formula Language
End_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:
t
Arg_name:
String
Arg_type:
n
Arg_name:
CharacterPosition
Arg_default:
0
Link_
name: ASCII Definition and table
Version_AB:
x.x
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:
DateTimeToStr()
Name_long:
convert datetime to string
Description:
Returns a text representation of the datetime number
Return_type:
t
Return_name:
DateTime Text
Arg_type:
n
Arg_name:
DateTime Number
Version_AB:
x.x
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: