Am 11.03.2014 10:06, schrieb Hal Lane:
For completeness and clarity you might want to add some definitions of your usage of terms at the top of your documentation -- perhaps something like:
1) ------------------------------------------------- r = Real i = Imaginary p = Parameter Left = to the left of the decimal point in the parameter value Right = to the right of the decimal point in the parameter value
Example: IP3 Left = Refers to the digits to the left of the decimal point in the Imaginary part of the third parameter, p3.
fn1=xxx[xxx] means: fn1=xxx or fn1=xxxxxx
Example: fn1=cotanh
[x] means that a letter "x" is optionally used. E.g.: xxx[xxx] can refer to: "cos", "cosh", "floor", "cotanh", etc. --------------------------------------------------
I think (at least some of) the above definitions of terms need to be stated -- because, although the Fractint documentation refers to "p3", it does *not* refer to "ip3" or "IP3". And "Right" and left are not defined in the Fractint documentation.
2) I also note that you have (throughout the document) both upper case and lower case versions of the same(?) terms. E.g.:
RP4
as well as:
rp4
One must convince oneself that these are not referring to two different items. If they were both the same case, one might not have to work to convince oneself -- or guess about this...
For consistency and ease of visual matching of terms, I would suggest using all lower case -- to match the case used in the Fractint documentation.
3 I have a minor suggestion, which may or may not work. Since the width of your fields are defined with square brackets
"A[1234]"
instead of using:
"A::"
to make a reference to the "A" field, why not use:
"A[]"
Then the syntax will be identical, and you won't have to memorize that "::" means "[]".
But having the upper case letters label the fields it a really great idea!
4) Also, instead of your:
functions first 1234 second 1234 third 1234 fourth 1234
shouldn't you use the same "fn1" syntax that the Fractint documentation uses -- perhaps something like this:
functions: fn1=xxx[xxx], fn2=xxx[xxx], fn3=xxx[xxx], fn4=xxx[xxx]
(One of the allowed functions is "cotanh" containing six letters...)
Your "1234" implies that digits should be substituted for "1234". "xxx" implies that alphabetic letters (e.g.: "tan") are to be substituted.
Thank you Hal,for your suggestions. I´ll supply a Dropbox folder which also contains some explanations. I used upper and lower case letters to avoid mixup and the double double point is an eyecatcher (it works!). I will use some of your suggestions in the next version , but the list of variables has priority. Albrecht