January 26, 2021, 02:37:20 pm

News:

Own IWBasic 2.x ? -----> Get your free upgrade to 3.x now.........


Help for Aurora in Compiled HTML

Started by John S, February 23, 2006, 03:29:56 pm

Previous topic - Next topic

0 Members and 1 Guest are viewing this topic.

John S

February 23, 2006, 03:29:56 pm Last Edit: February 23, 2006, 04:43:54 pm by John S
Here is the latest installment of a compiled HTML Help for Aurora.
This upload includes the latest string function descriptions (except the c-type functions).

  Edit: Partner Developers you will find a link to the source in the private section 

Included chapters are:

  Introduction to the Aurora Compiler
    Using Aurora's IDE
    Using the IDE's Editor
    A Few Comments about Comments
    My First Aurora Program
  Standard Functions
    Math Functions
    String Functions
  Miscellaneous Items
    ASCII Characters & Codes

If you have corrections and/or comments please post them here.  I will be updating this periodically. 

Revisions this update:
1.  added to String Functions c-type string functions
2.  revised String Function names
3.  added new subheadings in table of contents and shifted items

Planned for next update:
  describe intrinsic variable types (definitions, declarations and use)
  describe pointers ( they are variables after all )                             (edit)
  describe loops and program execution controls (for, while, if, ...)

Planned for future update(s):
  describe derived variable types (definitions, declarations and use)
  provide individual function htmls
  describe OOP (data abstraction, encapsulation, classes, etc.)
John Siino, Advanced Engineering Services and Software

LarryMc

Highlighted items are things that do not appear to be correct.

QuoteCeiling and Floor Functions - CEIL, FLOOR
ÂÃ,  otherdoubledouble = CEIL ( doublenum );
ÂÃ,  otherdoubledouble = FLOOR ( doublenum );
Description
ÂÃ,  Ceil returns the smallest whole number (integer as a double precision) that is greater than or equal to the input parameter.

ÂÃ,  Floor returns the largest whole number (integer as a double precision) that is less than or equal to the input parameter.

Parameter:
ÂÃ,  doublenum - double precision variable or number to take the absolute value of.


QuoteRandom Number Generator Functions - SEEDRND, RAND, RND
ÂÃ,  SEEDRND ( intnum );
ÂÃ,  unsigned int = RAND ( usint, optmaxi );
ÂÃ,  float = RND ( num , optmaxf );
Description
ÂÃ,  The SEEDRND function works with the RAND and RND functions. The SEEDRND function seeds the random number generator with a specific value.

ÂÃ,  The RAND function creates a pseudo random number {Maximum random range is 0 <= number <= 65535}.

ÂÃ,  The RND function creates a pseudo random number {Maximum random range is -32765.0 <= number <= 32766.0}.

Parameter:
ÂÃ,  for SEEDRND intnum shall be an integer value (int)

ÂÃ,  for RAND usint is the beginning or ending number for the range, and shall be an unsigned integer value (unsigned int),

ÂÃ,  for RAND optmaxi is an optional interger value, that if given, the random number will be between num and optmaxi. Otherwise random number will be between 0 and num.

ÂÃ,  for RND num shall be a floating point number value (float),

ÂÃ,  for RND optmaxf is an optional floating point value, that if given, the random number will be between num and optmaxf. Otherwise random number will be between 0 and num.

Return value:
ÂÃ,  There is no value returned for SEEDRND().

ÂÃ,  The pseudo random number returned for RAND() is an integer.

ÂÃ,  The pseudo random number returned for RAND() is a single precision number (float).



QuoteSine Functions - SIN, SIND, FSIN, FSIND
ÂÃ,  doublenum = SIN ( doubleradian );
ÂÃ,  doublenum = SIND ( doubledegree );
ÂÃ,  floatnum = FSIN ( singleradian );
ÂÃ,  floatnum = FSIND ( singledegree );
Description
ÂÃ,  These functions all return the sine of an angle.

ÂÃ,  ÂÃ,  SIN returns a double precision sine value of an angle in radians (double).

ÂÃ,  ÂÃ,  SIND returns a double precision sine value of an angle in radians (double).

ÂÃ,  ÂÃ,  FSIN returns a single precision (float) sine value of an angle in degrees (float).

ÂÃ,  ÂÃ,  FSIND returns a single precision (float) sine value of an angle in degrees (float).



QuoteCosine Functions - COS, COSD, FCOS, FCOSD
ÂÃ,  doublenum = COS ( doubleradian );
ÂÃ,  doublenum = COSD ( doubledegree );
ÂÃ,  floatnum = FCOS ( singleradian );
ÂÃ,  floatnum = FCOSD ( singledegree );
Description
ÂÃ,  These functions all return the cosine of an angle.

ÂÃ,  ÂÃ,  COS returns a double precision cosine value of an angle in radians (double).

ÂÃ,  ÂÃ,  COSD returns a double precision cosine value of an angle in radians (double).

ÂÃ,  ÂÃ,  FCOS returns a single precision (float) cosine value of an angle in degrees (float).

ÂÃ,  ÂÃ,  FCOSD returns a single precision (float) cosine value of an angle in degrees (float).



QuoteTangent Functions - TAN, TAND, FTAN, FTAND
ÂÃ,  doublenum = TAN ( doubleradian );
ÂÃ,  doublenum = TAND ( doubledegree );
ÂÃ,  floatnum = FTAN ( singleradian );
ÂÃ,  floatnum = FTAND ( singledegree );
Description
ÂÃ,  These functions all return the tangent of an angle.

ÂÃ,  ÂÃ,  TAN returns a double precision tangent value of an angle in radians (double).

ÂÃ,  ÂÃ,  TAND returns a double precision tangent value of an angle in radians (double).

ÂÃ,  ÂÃ,  FTAN returns a single precision (float) tangent value of an angle in degrees (float).

ÂÃ,  ÂÃ,  FTAND returns a single precision (float) tangent value of an angle in degrees (float).



QuoteArcsine Functions - ASIN, ASIND, FASIN, FASIND
ÂÃ,  doubleradian = ASIN ( doublenum );
ÂÃ,  doubledegree = ASIND ( doublenum );
ÂÃ,  singleradian = FASIN ( floatnum );
ÂÃ,  singledegree = FASIND ( floatnum );
Description
ÂÃ,  These functions all return the Arcsine of an angle.

ÂÃ,  ÂÃ,  ASIN returns a double precision Arcsine value of an angle in radians (double).

ÂÃ,  ÂÃ,  ASIND returns a double precision Arcsine value of an angle in radians (double).

ÂÃ,  ÂÃ,  FASIN returns a single precision (float) Arcsine value of an angle in degrees (float).

ÂÃ,  ÂÃ,  FASIND returns a single precision (float) Arcsine value of an angle in degrees (float).



QuoteArccosine Functions - ACOS, ACOSD,FACOS,FACOSD
ÂÃ,  doubleradian = ACOS ( doublenum );
ÂÃ,  doubledegree = ACOSD ( doublenum );
ÂÃ,  singleradian =FACOS ( floatnum );
ÂÃ,  singledegree =FACOSD ( floatnum );
Description
ÂÃ,  These functions all return the Arccosine of an angle.

ÂÃ,  ÂÃ,  ASIN returns a double precision Arccosine value of an angle in radians (double).

ÂÃ,  ÂÃ,  ASIND returns a double precision Arccosine value of an angle in radians (double).

ÂÃ,  ÂÃ,  FASIN returns a single precision (float) Arccosine value of an angle in degrees (float).

ÂÃ,  ÂÃ,  FASIND returns a single precision (float) Arccosine value of an angle in degrees (float).



QuoteArctangent Functions - ATAN, ATAND,FATAN,FATAND
ÂÃ,  doubleradian = ATAN ( doublenum );
ÂÃ,  doubledegree = ATAND ( doublenum );
ÂÃ,  singleradian =FATAN ( floatnum );
ÂÃ,  singledegree =FATAND ( floatnum );
Description
ÂÃ,  These functions all return the Arctangent of an angle.

ÂÃ,  ÂÃ,  ASIN returns a double precision Arctangent value of an angle in radians (double).

ÂÃ,  ÂÃ,  ASIND returns a double precision Arctangent value of an angle in radians (double).

ÂÃ,  ÂÃ,  FASIN returns a single precision (float) Arctangent value of an angle in degrees (float).

ÂÃ,  ÂÃ,  FASIND returns a single precision (float) Arctangent value of an angle in degrees (float).



QuoteExponential Function (e^x) - EXP
ÂÃ,  otherdoublenum = EXP ( doublenum );
Description
ÂÃ,  ÂÃ,  Calculates a positive double precision number (double) equal to e raised to the doublenum power (e^doublenum).

ÂÃ,  ÂÃ,  Note: e = 2.71828182845904523536028747135266249775724709369996...

Parameters:
ÂÃ,  doublenum is a double precision number (double) must be greater than zero.

Return values:
ÂÃ,  otherdoublenum - double precision variable or number.

Usage:
ÂÃ,  //ÂÃ,  exp.src
ÂÃ,  global sub main()
ÂÃ,  { writeln("e^2 = " + str$( EXP( 2.0 ), 4) + "\n");
ÂÃ,  ÂÃ,  while (GetKey() = "");
ÂÃ,  ÂÃ,  return;
ÂÃ,  }

Remarks:
ÂÃ,  In the examples above,ÂÃ,  ÂÃ, EXP(2.0) = 7.3891

ÂÃ,  The logarithm of a number unless the number is less than or equal to zero. If the input is less than zero then the result is indefinite (undefined). If the input is equal to zero then the result is infinite (undefined) and cannot be represented.



QuoteNumToStr - Number to String Conversion Function
ÂÃ,  somestring = NumToStr ( somenumber );
ÂÃ,  somestring = NumToStr ( somenumber, optnum );
Description
ÂÃ,  Converts a double precision Returns the string equivalent of an integer value. If the (optional) number of decimals is not specified, the returned string will be rounded to the nearest whole number.

Parameter:
ÂÃ,  somenumber - as a double precision number (double)

ÂÃ,  optnum - an integer specifying the number of digits to include in the string.

Return value:
ÂÃ,  A string value (string).



QuoteStrLower - Convert all Characters in a String to Lower Case
StrUpper - Convert all Characters in a String to Upper Case
ÂÃ,  somenewstring = StrLower ( somestring );
ÂÃ,  somenewstring = StrUpper ( somestring );
Description
ÂÃ,  StrLower Convert all characters in a string to Lower Case ("ABC" to "abc")

ÂÃ,  StrUpper Convert all characters in a string to Upper Case ("abc" to "ABC")

Parameter:
ÂÃ,  somestring - a string variable of constant



Quote
FormatDate - Returns System Date as a String
ÂÃ,  datestring = FormatDate ( );
ÂÃ,  datestring = FormatDate ( OptString );
Description
ÂÃ,  Returns system time as a string.

Parameter:
ÂÃ,  OptString - Optional date formatting string. Default format is DD/MM/YYYY. Formatting specifiers:

ÂÃ,  ÂÃ,  ÂÃ,  d Day of month as digits with no leading zero for single-digit days.

ÂÃ,  ÂÃ,  ÂÃ,  dd Day of month as digits with leading zero for single-digit days.

ÂÃ,  ÂÃ,  ÂÃ,  ddd Day of week as a three-letter abbreviation.

ÂÃ,  ÂÃ,  ÂÃ,  dddd Day of week as its full name.

ÂÃ,  ÂÃ,  ÂÃ,  M Month as digits with no leading zero for single-digit months.

ÂÃ,  ÂÃ,  ÂÃ,  MM Month as digits with leading zero for single-digit months.

ÂÃ,  ÂÃ,  ÂÃ,  MMM Month as a three-letter abbreviation.

ÂÃ,  ÂÃ,  ÂÃ,  MMMM Month as its full name.

ÂÃ,  ÂÃ,  ÂÃ,  y Year as last two digits, but with no leading zero for years less than 10.

ÂÃ,  ÂÃ,  ÂÃ,  yy Year as last two digits, but with leading zero for years less than 10.

ÂÃ,  ÂÃ,  ÂÃ,  yyyy Year represented by full four digits.



Highlighted items above shold be consistent and also need example with 'ddd' with or without 'DD'

QuoteTrimLeft - Trims white space(s) off of the leftmost end of a string
ÂÃ,  RemainingString = TrimLeft ( StartString );
Description
ÂÃ,  Trims white space characters off of left (leading) end of a string.

Parameters:
ÂÃ,  StartString is a string value or variable which is the parent string.

Return value:
ÂÃ,  RemainingString is a string value (string) which is left over (not trimmed).

Usage:
ÂÃ,  //ÂÃ,  TrimLeft.src
ÂÃ,  global sub main()
ÂÃ,  {
ÂÃ,  ÂÃ,  string parent = "ÂÃ,  ÂÃ,  ÂÃ,  ÂÃ,  ÂÃ,  ÂÃ,  ÂÃ,  ÂÃ,  ÂÃ,  white spaces used to lead this text";
ÂÃ,  ÂÃ,  writeln("ÂÃ,  " + TrimLeft (parent) + ".\n");
ÂÃ,  ÂÃ,  while (GetKey() = "");
ÂÃ,  ÂÃ,  return;
ÂÃ,  }

Remarks:
ÂÃ,  The example above prints to the console: " white spaces used to follow this text."



QuoteStrFind - finds a string within a string
ÂÃ,  location = StrFind ( SubjectString, SearchString );
ÂÃ,  location = StrFind ( SubjectString, SearchString, Start );
Description
ÂÃ,  Locates (finds) a string within a string and returns position.

Parameters:
ÂÃ,  SubjectString is a string value or variable which is the subject of the search.

ÂÃ,  SearchString is a string value or variable which is the searched for.

ÂÃ,  Start is an unsigned integer value or variable which identifiies where (position) to start the search in the SubjectString.

Return value:
ÂÃ,  location is an unsigned integer value (uint) which is identifies the position of the found string.



QuoteStrSpace - returns a string filled with multiples of the space character
ÂÃ,  manySpaces = StrSpace ( somenum );
Description
ÂÃ,  Creates a string with a number of blank spaces (ASCII character 032).

Parameters:
ÂÃ,  somenum is an integer value or variable which is the number (quantity) of spaces to create.

Return value:
ÂÃ,  manySpaces is a string value or variable which is filled with blank spaces.

Usage:
ÂÃ,  //ÂÃ,  StrSpace.src
ÂÃ,  global sub main()
ÂÃ,  {
ÂÃ,  ÂÃ,  writeln("ÂÃ,  put spaces here >" + StrSpaces(6) + "< \n");
ÂÃ,  ÂÃ,  while (GetKey() = "");
ÂÃ,  ÂÃ,  return;
ÂÃ,  }

Remarks:
ÂÃ,  The example above prints to the console: " put spaces here > < "


I know the preceeding lack of 6 spaces between the >< is an html issue it still needs to be fudged; i.e '>ÂÃ,  ÂÃ,  ÂÃ,  <'



StringÂÃ,  functions do not have all optional parameters identified.

IMO...
it would be better to have the actual declarations (from the .inc files) listed for each function.ÂÃ,  That will make the description of datatypes more uniform.
In the long run if each function/class/method had it's own html file(yes, like IBPro and many others) and the name of the file and the title within the file be the function/class/method that (when implemented) the index and search mechanisim will work much better from a users point of view.
I also believe it will make updating of syntax/examples/quirks easier to locate and modify. IMO
LarryMc
Larry McCaughn :)
Author of IWB+, Custom Button Designer library, Custom Chart Designer library, Snippet Manager, IWGrid control library, LM_Image control library

John S

February 26, 2006, 12:18:35 am #2 Last Edit: February 26, 2006, 12:24:09 am by John S
Larry,
Thanks for the review and comments.  I was grouping the functions together to make it a little easier for me to get the bulk formatting and typing done.  I do plan on breaking them apart in the future.

I was not able to read/see any highlights on your post so I'm not sure how or what you were getting at.  (edit) I will print out your comments and look at them this week.

(edit) Please feel free to edit/correct the specific html file, zip it and post it I can re-fold it/them into the system of files.  Announce which file you are editting so that there is no duplication of effort or confusion.  If you do not have access to the source files I can post or email what you need.  Your help is greatly appreciated.

I have updated the Aurora_Help.css file (style sheet) in response to Pauls comments regarding headings.  I am working on describing the basic intrinsic variables now.
John Siino, Advanced Engineering Services and Software

LarryMc

February 26, 2006, 12:34:34 am #3 Last Edit: February 26, 2006, 12:41:25 am by tlmccaughn
Can you see strike throughs?
QuoteThis is a test

Can you see underlines?
QuoteThis is a test


Can you send me the css file and a html it has been used with?
LarryMc
Larry McCaughn :)
Author of IWB+, Custom Button Designer library, Custom Chart Designer library, Snippet Manager, IWGrid control library, LM_Image control library

John S

I was able to see both the strike through and the underline.
yes I am sending you the files you need via email.
John Siino, Advanced Engineering Services and Software