Update documentation for RC 1.0

Co-Authored-By: RoccoLox Programs <roccoloxprograms2018@gmail.com>

Author: TIny-Hacker

CelticCE.pdf

@@ -284,7 +284,7 @@ Documentation
 
 ------------
 
-.. function:: ErrorHandle: det(45); Ans = program to run
+.. function:: ErrorHandle: det(45, get_offset); Ans = program to run
 
     Executes BASIC code with an error handler installed. That means the code you execute can do anything it wants including divide by zero, and it will simply end the execution but an obvious system error will not trigger. Instead, this command will return with a value that indicates the error condition. This command has two different modes. If ``Ans`` contains a program name (beginning with the ``prgm`` token), it will run that program. If ``Ans`` contains program code, it will execute that code instead. This will also work with programs beginning with the ``Asm84CEPrgm`` token.
 
@@ -294,9 +294,11 @@ Documentation
 
     Parameters:
      * ``Ans``: The name of the program to run, or TI-BASIC code to be executed
+     * ``get_offset``: If ``get_offset`` is 1, ErrorHandle will return the byte offset the error occured at in ``Ans``. If it is 0, it will not. This only works with running programs, not strings.
 
     Returns:
      * ``Theta``: Contains the error code returned by the program, or 0 if no error occured.
+     * ``Ans``: Contains the byte offset the error occured at, if ``get_offset`` 1 and an error occured. Otherwise ``Ans`` is not modified.
 
     Errors:
      * ``..NULLVAR`` if the program is empty.

docs/celticiiifunctions.rst

@@ -24,9 +24,9 @@
 author = 'RoccoLox Programs, TIny_Hacker'
 
 # The short X.Y version
-version = 'b1.3'
+version = '1.0-rc.1'
 # The full version, including alpha/beta/rc tags
-release = 'Beta 1.3'
+release = 'Release Candidate 1.0'
 
 
 # -- General configuration ---------------------------------------------------

docs/conf.py

@@ -94,4 +94,10 @@ Value Error
 49    ArchFull
 50    Variable
 51    Duplicate
+52    Date
+53    UnknownCmd
+54    OverLimit
+55    Disabled
+56    Xmit
+57    MemFull
 ===== ===========

docs/errorcodes.rst

@@ -35,6 +35,11 @@ If your program uses Celtic, it is recommended that it makes sure Celtic is inst
 
 ``det([[20]])`` will equal 90 if Celtic CE is installed. If the program aims to be compatible with Celtic 2 CSE, you may wish to refer to the `list of version codes <https://dcs.cemetech.net/index.php?title=Third-Party_BASIC_Libraries_(Color)>`__ on the DCS Wiki as well.
 
+prgmAINSTALL
+~~~~~~~~~~~~
+
+You'll notice that along with the CelticCE installer binary, Celtic also comes with a program called **AINSTALL**. This program can be used to install CelticCE's hooks (The part of the installation done after the app has been installed) by running it instead of needing to open the app. Like the **AINSTALL** program in Celtic III, this can be used if you wish to install CelticCE from a TI-BASIC program, by simply running **prgmAINSTALL** in it. Keep in mind that **prgmAINSTALL** will only work if the CelticCE app is present and installed on your calculator.
+
 Argument Types
 ~~~~~~~~~~~~~~
 
@@ -51,6 +56,8 @@ When using ``Str0`` as a program name, simply store the name of the program into
     :"rowSwap(FOO" -> Str0      //AppVar FOO
     :"*row(FOO" ->              //group FOO
 
+The system programs ``prgm#`` and ``prgm!`` are not supported, so if you attempt to use a Celtic command on them, the command will simply exit.
+
 If a string is used, it must be in the RAM when the function is called.
 
 .. warning:: In almost all cases, Celtic will detect if you passed invalid arguments and return an error instead. However, in the (extremely) rare case that you tried to pass a string with the length of 0, it will not handle this. Don't worry, there shouldn't be any reason this would happen without you trying to make it happen.

docs/gensyntax.rst

@@ -239,9 +239,9 @@ Documentation
 
 ------------
 
-.. function:: ScrollScreen: det(58, direction, amount)
+.. function:: ShiftScreen: det(58, direction, amount, x, y, width, height)
 
-    Moves the screen a specified amount of pixels in a specified direction. The following directions and corresponding values are below:
+    Shifts the pixels within a user-specified region of the screen a specified amount of pixels in a specified direction. The following directions and corresponding values are below:
 
     ===== =========
     Value Direction
@@ -255,6 +255,13 @@ Documentation
     Parameters:
      * ``direction``: Direction to move the screen in, as seen in the table above.
      * ``amount``: The amount of pixels to move the screen.
+     * ``x``: Starting X position of the region of the screen to shift.
+     * ``y``: Starting Y position of the region of the screen to shift.
+     * ``width``: Width of the region of the screen to shift.
+     * ``height``: Height of the region of the screen to shift.
+
+    Alternative method: ``det(58, direction, amount)``
+        This alternative method acts as a shorthand way to shift the entire screen, rather than a specified region.
 
     Returns:
      * Moves the screen in the specified direction.
@@ -409,3 +416,108 @@ Documentation
 
     Returns:
      * ``Ans``: 0 if the rectangles do not intersect, and 1 if they do.
+
+------------
+
+.. function:: PutChar: det(66, font, fg_low, fg_high, bg_low, bg_high, x, y, char)
+
+    Displays a character specified by the user at ``x``, ``y``, with a user-specified background color as well. ``char`` can range from 0 - 255. In order to figure out the ``char`` value for your preferred character, you can use the handy images below. Simply take the X and Y values on the chart and add them together.
+
+    .. figure:: images/fontMapSmall.png
+        :alt: Chart for determining the code of a specific character (Small font)
+        :align: center
+
+        Small Font
+
+    .. figure:: images/fontMapLarge.png
+        :alt: Chart for determining the code of a specific character (Large font)
+        :align: center
+
+        Large Font
+
+    Parameters:
+     * ``font``: Whether to use the OS large or small font. 0 for the small font and 1 for the large font.
+     * ``fg_low``: Low byte of the foreground color.
+     * ``fg_high``: High byte of the foreground color.
+     * ``bg_low``: Low byte of the background color.
+     * ``bg_high``: High byte of the background color.
+     * ``x``: X coordinate to display the character at.
+     * ``y``: Y coordinate to display the character at.
+     * ``char``: The numeric code associated with the character to display. See images above for more info.
+
+    Alternative method: ``det(66, font, fg_os, bg_os, x, y, char)``
+     * ``fg_os``: Foreground color from TI-OS Colors menu, like RED or BLUE or NAVY.
+     * ``bg_os``: Background color from TI-OS Colors menu, like RED or BLUE or NAVY.
+
+    Colors:
+     * A list of colors can be found `here <colors.html>`__.
+
+    Returns:
+     * Displays the specified character.
+
+------------
+
+.. function:: PutTransChar: det(67, font, low, high, x, y, char)
+
+    Displays a character specified by the user at ``x``, ``y``, with a transparent background. See the above command for information on character codes.
+
+    Parameters:
+     * ``font``: Whether to use the OS large or small font. 0 for the small font and 1 for the large font.
+     * ``low``: Low byte of the color.
+     * ``high``: High byte of the color.
+     * ``x``: X coordinate to display the character at.
+     * ``y``: Y coordinate to display the character at.
+     * ``char``: The numeric code associated with the character to display. See images above for more info.
+
+    Alternative method: ``det(67, font, os_color, x, y, char)``
+     * ``os_color``: Color from TI-OS Colors menu, like RED or BLUE or NAVY.
+
+    Colors:
+     * A list of colors can be found `here <colors.html>`__.
+
+    Returns:
+     * Displays the specified character.
+
+------------
+
+.. function:: HorizLine: det(68, low, high, x, y, length)
+
+    Draws a horizontal line beginning at ``x``, ``y``, with a length of ``length``.
+
+    Parameters:
+     * ``low``: Low byte of the color.
+     * ``high``: High byte of the color.
+     * ``x``: X coordinate to begin drawing the line at.
+     * ``y``: Y coordinate to begin drawing the line at.
+     * ``length``: The length of the horizontal line.
+
+    Alternative method: ``det(68, os_color, x, y, length)``
+     * ``os_color``: Color from TI-OS Colors menu, like RED or BLUE or NAVY.
+
+    Colors:
+     * A list of colors can be found `here <colors.html>`__.
+
+    Returns:
+     * Draws a horizontal line ``length`` pixels long, beginning at ``x``, ``y``.
+
+------------
+
+.. function:: VertLine: det(69, low, high, x, y, length)
+
+    Draws a vertical line beginning at ``x``, ``y``, with a length of ``length``.
+
+    Parameters:
+     * ``low``: Low byte of the color.
+     * ``high``: High byte of the color.
+     * ``x``: X coordinate to begin drawing the line at.
+     * ``y``: Y coordinate to begin drawing the line at.
+     * ``length``: The length of the vertical line.
+
+    Alternative method: ``det(69, os_color, x, y, length)``
+     * ``os_color``: Color from TI-OS Colors menu, like RED or BLUE or NAVY.
+
+    Colors:
+     * A list of colors can be found `here <colors.html>`__.
+
+    Returns:
+     * Draws a vertical line ``length`` pixels long, beginning at ``x``, ``y``.