|
PureBytes Links
Trading Reference Links
|
I think this strongly depends on individual taste and has no
absolute correct answer.
The returned values is of significant importance and is good it
stands out. It could also be placed right before the AB version info.
You could also borrow from the convention that units of measure
are placed in square brackets (i.e. [sec]) and use [n] or [s], [b], [A(n)], [A(b)],
[A(s)] etc… (A = Array).
I just noticed &nb! sp in your example below.
Was it there before? Is this some formatting info? Also what is the ! for?
Joseph Biran
____________________________________________
From:
amibroker@xxxxxxxxxxxxxxx [mailto:amibroker@xxxxxxxxxxxxxxx] On Behalf Of Dennis
Brown
Sent: Tuesday, September 23, 2008 6:12 PM
To: amibroker@xxxxxxxxxxxxxxx
Subject: Re: [amibroker] AmiBroker AFL Glossary project --LIFT OFF
Joseph,
I see your point. I just made up some conventions to test it
out. It could be formatted any number
of ways. In fact I am busy writing the
sorting and filtering routines. Let me
know if you have a good idea for an alternative way to format the output and I
can throw that in at the same time.
Another one is I have
"a" for array "a|n" for array or number, and "b"
for boolean. It occurs to me the I should also
have "a|b" for a boolean array or a boolean number. that would also be the result type for
things like comparison operators. Operators
will be another whole class of formats in the template.
As we expand the glossary to
more than just functions, I am sure additional considerations will have to be
made in the database template and report generation formats to accommodate these.
In some construct it is a statement
that is the parameter like in a for(initialStatement; booleanExit;
loopStatement){}.
These will take some
additional thought. We need to fill in
all the AFL functions though, and that will take a little while and is actually
the easy part because we have the AB functions list to get us started.
On Sep 23, 2008, at 8:32 PM,
J. Biran wrote:
Also, distinguishing array from number would be beneficial.
Joseph Biran
____________________________________________
Good question. I had selected a parameter to show return value types in
the sample output. The n is a number type returned by the
function. Other types are: s is a string, a is an
ar! ray, b i s Boolean number (True/False) etc., as shown in the template. I
could have selected to output a
descriptive name instead, or nothing. There
are a number of variations on a basic theme.
On Sep 23, 2008,
at 6:09 PM, J. Biran wrote:
What is the n = stand for?
Joseph Biran
____________________________________________
I have uploaded
to the AFL Library a program called AF_Glossary_Generator (yes a typo in the
name) that takes another file uploaded called AFL_Glossary_1 and generates
parameter selectable formatted
TXT or RTF files for this project. It took
me a couple of hours to make a database file for all the string manipulation functions, and forever to make the program
that spit out formatted documents. Creating the files for both forced me to
refine the database specification a bit further.
< /div>
Please download
them both and try them out. You have to create a directory called
AFL_Glossary in your main AmiBroker folder and put the file named AFL_Glossary_1.txt into it. Rename
the file to strip off the .afl and make sure it ends in .txt. The output files will be written to the same folder. On a PC, the .txt and .rtf files read fine in WordPad, but
the links don't work in that program. They do
work in Word. In the Mac, all formats w! ork fine in
TextEdit program.
Please download
the program and data and give me some feedback. Sorry
there are not a lot of instructions, but you just select parameters, and click
on the Convert Database button to get something written out. You can try out all kinds of different formats.
Next, we need
volunteers to write small sections of the database to make headway. If you make another file called AFL_Glossary_2.txt, etc., it w! ill comb ine them into one
database for outputs.
PS. here is a
sample of one possible output:
AFL -- AmiBroker Formula Language
--
Abbreviation for AmiBroker Formula Language
-- See
Also:
AmiBroker
Formula Language
n = &nb!
sp; ;
Asc( String,
CharacterPosition=0 ) [AB 4.8] -- get ASCII code of character
--
Returns the ASCII code number for a text character
--
Group Tags:
AFL,Functions,String
manipulation,Type Conversions
--
Search Tags:
ASCII,character,convert,code
n = StrToDateTime(
DateTimeText ) [AB 4.8] -- convert string to datetime
--
Returns datetime number from a text representation of the Date/Time
--
Group Tags:
AFL,Functions,String
manipulation,Type Conversions,Date and Time
! -- Search Tags: datetime,date,time,convert
-- See Also:
DateTimeToStr(),Now(),DateTime(),TimeNum(),Date()
The rtf file of the whole sample output is also attached here for
those who get individual emails:
__._,_.___
Please note that this group is for discussion between users only.
To get support from AmiBroker please send an e-mail directly to
SUPPORT {at} amibroker.com
For NEW RELEASE ANNOUNCEMENTS and other news always check DEVLOG:
http://www.amibroker.com/devlog/
For other support material please check also:
http://www.amibroker.com/support.html
![]()
__,_._,___
|
|