jspdf-dynamo 1.0.5 → 1.0.7

package/dist/index.js

@@ -46,19 +46,19 @@ var AppLogger = class {
       this._logger = console;
     }
   }
-  trace(message, ...args) {
+  trace(message, args) {
     this.canLog(0) ? this._logger.trace(message, args) : null;
   }
-  debug(message, ...args) {
+  debug(message, args) {
     this.canLog(1) ? this._logger.debug(message, args) : null;
   }
-  info(message, ...args) {
+  info(message, args) {
     this.canLog(2) ? this._logger.info(message, args) : null;
   }
-  warn(message, ...args) {
+  warn(message, args) {
     this.canLog(3) ? this._logger.warn(message, args) : null;
   }
-  error(message, ...args) {
+  error(message, args) {
     this.canLog(4) ? this._logger.error(message, args) : null;
   }
   logLevel(newLevel) {
@@ -235,6 +235,8 @@ function isValidFontStyle(fontStyle) {
 // src/models/jsPdfOptions.ts
 var JsPdfOptions = class {
   constructor(options = {}) {
+    this.compress = true;
+    this.putOnlyUsedFonts = true;
     var _a, _b, _c;
     this.pageSize = ((_a = options.pageSize) == null ? void 0 : _a.toLocaleLowerCase()) || "a4";
     this.orientation = ((_b = options.orientation) == null ? void 0 : _b.toLocaleLowerCase()) || "portrait";
@@ -314,15 +316,32 @@ var JsPdfProcessor = class {
     this.pageOrientation = optn.orientation;
     this.currentUom = optn.unit;
     this._pdfDocument.setLineHeightFactor(1);
+    const now = /* @__PURE__ */ new Date();
     this._variables.set(
       "_TIMEHM",
-      (/* @__PURE__ */ new Date()).toLocaleTimeString("en-US", {
+      now.toLocaleTimeString(void 0, {
         hour12: false,
         hour: "2-digit",
         minute: "2-digit"
       })
     );
-    this._variables.set("_DATEDMY", (/* @__PURE__ */ new Date()).toLocaleDateString("en-GB"));
+    this._variables.set(
+      "_DATEDDMMYYYY",
+      now.toLocaleDateString("en-GB", {
+        day: "2-digit",
+        month: "2-digit",
+        year: "numeric"
+      })
+    );
+    this._variables.set(
+      "_DATEMMDDYYYY",
+      now.toLocaleDateString("en-US", {
+        day: "2-digit",
+        month: "2-digit",
+        year: "numeric"
+      })
+    );
+    this._variables.set("_DATEISO", now.toISOString().substring(0, 10));
     this._variables.set("_IMAGEASPECT", "1");
     this._variables.set("_IMAGEHEIGHT", "0");
     this._variables.set("_IMAGEHEIGHTPX", "0");
@@ -794,6 +813,16 @@ var JsPdfProcessor = class {
     if (!this.checkPosition(left, top)) {
       return;
     }
+    if (isNaN(width)) {
+      this.lastError = `The width of the box is not a number`;
+      this.lastResult = "0";
+      return;
+    }
+    if (isNaN(height)) {
+      this.lastError = `The height of the box is not a number`;
+      this.lastResult = "0";
+      return;
+    }
     this.posnX = left;
     this.posnY = top;
     let lineWidthAdjustment = this._lineWidth;
@@ -814,6 +843,10 @@ var JsPdfProcessor = class {
         style = "FD";
         this._pdfDocument.setFillColor(this.fillColour);
         break;
+      default:
+        this.lastError = `The box style option '${boxType}' is not valid. It must be '0', '1' or '2'`;
+        this.lastResult = "0";
+        return;
     }
     this._pdfDocument.rect(x, y, w, h, style);
     this.posnX = this.posnX + width + this.spaceHoz;
@@ -822,10 +855,57 @@ var JsPdfProcessor = class {
     this.lastObjectWidth = width;
     this.lastResult = "1";
   }
+  drawCircle(input) {
+    const subs = this.logAndParseCommand(".drawCircle", input);
+    const { first: left, rest: rest1 } = getNextNumber(subs);
+    const { first: top, rest: rest2 } = getNextNumber(rest1);
+    const { first: radius, rest: rest3 } = getNextNumber(rest2);
+    const { first: option } = getNextNumber(rest3);
+    if (!this.checkPosition(left, top)) {
+      return;
+    }
+    if (isNaN(radius)) {
+      this.lastError = `The radius of the circle is not a number`;
+      this.lastResult = "0";
+      return;
+    }
+    this.posnX = left;
+    this.posnY = top;
+    const x = this.posnX + this._marginLeft;
+    const y = this.posnY + this._marginTop;
+    let r = radius;
+    let style = "S";
+    switch (option) {
+      case 0:
+        r -= this._lineWidth * 0.5;
+        break;
+      case 1:
+        style = "F";
+        this._pdfDocument.setFillColor(this.fillColour);
+        break;
+      case 2:
+        style = "FD";
+        this._pdfDocument.setFillColor(this.fillColour);
+        r -= this._lineWidth * 0.5;
+        break;
+      default:
+        this.lastError = `The circle style option '${option}' is not valid. It must be '0', '1' or '2'`;
+        this.lastResult = "0";
+        return;
+    }
+    this._pdfDocument.circle(x, y, r, style);
+    this.lastObjectHeight = radius * 2;
+    this.lastObjectWidth = this.lastObjectHeight;
+    this.posnX = this.posnX + radius + this.spaceHoz;
+    this.posnY = this.posnY + radius + this.spaceVert;
+    this.lastResult = "1";
+  }
   drawDebugGrid(input) {
     const subs = this.logAndParseCommand(".drawDebugGrid", input);
     const savedLineColour = this.lineColour;
     const savedLineWidth = this.lineWidth;
+    const savedX = this.posnX;
+    const savedY = this.posnY;
     const mm = 0.1;
     const pts = mmToPoints(mm);
     const lineWidth = this.pointsToUom(pts);
@@ -882,6 +962,62 @@ var JsPdfProcessor = class {
     }
     this.lineColour = savedLineColour;
     this.lineWidth = savedLineWidth;
+    this.posnX = savedX;
+    this.posnY = savedY;
+  }
+  drawEllipse(input) {
+    const subs = this.logAndParseCommand(".drawEllipse", input);
+    const { first: left, rest: rest1 } = getNextNumber(subs);
+    const { first: top, rest: rest2 } = getNextNumber(rest1);
+    const { first: radiusX, rest: rest3 } = getNextNumber(rest2);
+    const { first: radiusY, rest: rest4 } = getNextNumber(rest3);
+    const { first: option } = getNextNumber(rest4);
+    if (!this.checkPosition(left, top)) {
+      return;
+    }
+    if (isNaN(radiusX)) {
+      this.lastError = `The horizontal radius of the ellipse is not a number`;
+      this.lastResult = "0";
+      return;
+    }
+    if (isNaN(radiusY)) {
+      this.lastError = `The vertical radius of the ellipse is not a number`;
+      this.lastResult = "0";
+      return;
+    }
+    this.posnX = left;
+    this.posnY = top;
+    const x = this.posnX + this._marginLeft;
+    const y = this.posnY + this._marginTop;
+    let rx = radiusX;
+    let ry = radiusY;
+    let style = "S";
+    switch (option) {
+      case 0:
+        rx -= this._lineWidth * 0.5;
+        ry -= this._lineWidth * 0.5;
+        break;
+      case 1:
+        style = "F";
+        this._pdfDocument.setFillColor(this.fillColour);
+        break;
+      case 2:
+        style = "FD";
+        this._pdfDocument.setFillColor(this.fillColour);
+        rx -= this._lineWidth * 0.5;
+        ry -= this._lineWidth * 0.5;
+        break;
+      default:
+        this.lastError = `The circle style option '${option}' is not valid. It must be '0', '1' or '2'`;
+        this.lastResult = "0";
+        return;
+    }
+    this._pdfDocument.ellipse(x, y, rx, ry, style);
+    this.lastObjectHeight = radiusY * 2;
+    this.lastObjectWidth = radiusX * 2;
+    this.posnX = this.posnX + radiusX + this.spaceHoz;
+    this.posnY = this.posnY + radiusY + this.spaceVert;
+    this.lastResult = "1";
   }
   drawLine(input) {
     const subs = this.logAndParseCommand(".drawLine", input);
@@ -921,7 +1057,7 @@ var JsPdfProcessor = class {
       return;
     }
     if (isNaN(imageNo) || imageNo < 0 || imageNo > this._images.length - 1) {
-      this.lastError = this._images.length ? "The image number must be in the range of 0 to " + (this._images.length - 1).toString() : "Only one image has been loaded, the image number can only be 0";
+      this.lastError = this._images.length > 1 ? `The image number ${imageNo} must be in the range of 0 to ${(this._images.length - 1).toString()}` : "Only one image has been loaded, the image number can only be 0";
       this.lastResult = "0";
       return;
     }
@@ -972,7 +1108,6 @@ var JsPdfProcessor = class {
     this.lastResult = "1";
   }
   drawText(input) {
-    var _a;
     const subs = this.logAndParseCommand(".drawText", input);
     const { first: left, rest: rest1 } = getNextNumber(subs);
     const { first: top, rest: rest2 } = getNextNumber(rest1);
@@ -984,7 +1119,7 @@ var JsPdfProcessor = class {
     this.lastObjectWidth = 0;
     this.lastResult = "1";
     if (lines.length > 1) {
-      this.lastError = `Text was truncated to fit within the available width (${(_a = lines[0]) == null ? void 0 : _a.substring(0, 20)}...)`;
+      this.lastError = `Text was truncated to fit within the available width (${rest2.substring(0, 20)}...) on page ${this._currentPageNumber}.`;
       this.lastResult = "0";
       if (lines[0]) {
         if (this._pdfDocument.getTextWidth(lines[0]) < maxWidth) {
@@ -1290,10 +1425,11 @@ var JsPdfProcessor = class {
   }
   ifNotBlank(jsPdfDynamo, input) {
     return __async(this, null, function* () {
-      let { first: variable, rest } = getNextString(input);
+      let { first: value1, rest } = getNextString(input);
       const subs = this.substitute(rest.trim());
-      this._logger.debug(".ifNotBlank " + variable + " " + subs);
-      let value = this._variables.get(variable.toLocaleUpperCase()) || "";
+      this._logger.debug(".ifNotBlank " + value1 + " " + subs);
+      const variable1 = this.substitute(value1);
+      let value = this._variables.get(variable1.toLocaleUpperCase()) || "";
       this.lastResult = "-1";
       if (value.trim() !== "") {
         yield jsPdfDynamo.processDot(this, rest);
@@ -1547,9 +1683,14 @@ var JsPdfProcessor = class {
     }
   }
   setFillColour(input) {
-    let subs = this.substitute(input);
-    this._logger.debug(".setFillColour " + subs);
-    this.fillColour = subs;
+    const subs = this.logAndParseCommand(".setFillColour", input);
+    const { first: fillColour } = getNextString(subs);
+    if (fillColour === "") {
+      this.lastResult = "0";
+      this.lastError = "A fill colour must be specified";
+      return;
+    }
+    this.fillColour = fillColour;
     this.lastResult = "1";
   }
   setFontName(input) {
@@ -1565,14 +1706,25 @@ var JsPdfProcessor = class {
   }
   setFontSize(input) {
     const subs = this.logAndParseCommand(".setFontSize", input);
-    let { first: size } = getNextNumber(subs);
-    if (size > 0) {
-      this.fontPointSize = size;
-      this.lastResult = "1";
-    } else {
+    if (subs === "") {
       this.lastResult = "0";
-      this.lastError = "Invalid font size " + size;
+      this.lastError = "A font size must be specified";
+      return;
     }
+    let { first: sizeAlpha } = getNextNumber(subs);
+    const size = Number(sizeAlpha);
+    if (Number.isNaN(size)) {
+      this.lastResult = "0";
+      this.lastError = `A font size must be a number. '${sizeAlpha}' is not a number.`;
+      return;
+    }
+    if (size <= 0) {
+      this.lastResult = "0";
+      this.lastError = "A font size must be greater than 0";
+      return;
+    }
+    this.fontPointSize = size;
+    this.lastResult = "1";
   }
   setFontStyle(input) {
     const subs = this.logAndParseCommand(".setFontStyle", input);
@@ -1591,9 +1743,14 @@ var JsPdfProcessor = class {
     this.lastResult = "1";
   }
   setLineColour(input) {
-    let subs = this.substitute(input);
-    this._logger.debug(".setLineColour " + subs);
-    this.lineColour = subs;
+    const subs = this.logAndParseCommand(".setFontStyle", input);
+    const { first: lineColour } = getNextString(subs);
+    if (lineColour === "") {
+      this.lastResult = "0";
+      this.lastError = "A line colour must be specified";
+      return;
+    }
+    this.lineColour = lineColour;
     this.lastResult = "1";
   }
   setLineWidth(input) {
@@ -1699,7 +1856,13 @@ var JsPdfProcessor = class {
   }
   setTextColour(input) {
     const subs = this.logAndParseCommand(".setTextColour", input);
-    this.textColour = subs;
+    const { first: textColour } = getNextString(subs);
+    if (textColour === "") {
+      this.lastResult = "0";
+      this.lastError = "A text colour must be specified";
+      return;
+    }
+    this.textColour = textColour;
     this.lastResult = "1";
   }
   copyVar(input) {
@@ -1913,10 +2076,6 @@ var JsPdfDynamo = class {
         if (currLine.startsWith("[")) {
           if (inGroupLoading) {
             inGroupLoading = false;
-            __privateGet(this, _appLogger).debug(
-              `Finished loading group ${grpName}   (${currLine})
-`
-            );
           } else {
             if (currLine.length === 1) continue;
             grpName = currLine.substring(1);
@@ -1926,8 +2085,7 @@ var JsPdfDynamo = class {
             }
             grpName = grpName.trim().toLocaleUpperCase();
             inGroupLoading = true;
-            __privateGet(this, _appLogger).debug(`Loading group ${grpName}   (${currLine})
-`);
+            __privateGet(this, _appLogger).debug(`Loading group ${grpName}`);
             currGroup = [];
             __privateGet(this, _groups)[grpName] = currGroup;
           }
@@ -1978,9 +2136,15 @@ var JsPdfDynamo = class {
         case "DrawBox".toLowerCase():
           processor.drawBox(parameters);
           return;
+        case "DrawCircle".toLowerCase():
+          processor.drawCircle(parameters);
+          return;
         case "DrawDebugGrid".toLowerCase():
           processor.drawDebugGrid(parameters);
           return;
+        case "DrawEllipse".toLowerCase():
+          processor.drawEllipse(parameters);
+          return;
         case "DrawImage".toLowerCase():
           processor.drawImage(parameters);
           return;
@@ -2111,9 +2275,11 @@ var JsPdfDynamo = class {
         let { first: group, rest } = getNextString(subs);
         subs = rest;
         __privateGet(this, _appLogger).debug(`
-[${group}]`);
+[${group} - Enter]`);
         if (__privateGet(this, _groups)[group]) {
           yield this.processTemplate(processor, __privateGet(this, _groups)[group]);
+          __privateGet(this, _appLogger).debug(`[${group} - Exit]
+`);
         } else {
           __privateGet(this, _appLogger).warn(`Group ${group} was not found.`);
           processor.lastResult = "0";

package/documentation/1. Introduction/Introduction.txt

@@ -42,7 +42,7 @@
 
 .SetVar top %_CurrentY%
 .DrawText 5 %top% -
-.SetVar text The initial page size, orientation and units of measure are set when the
+.SetVar text The initial page size, orientation and unit of measure are set when the
 .SetVar text %text% JsPdfDynamo instance is instantiated.
 .DrawTextWrapped 10 %top% %width% *None %text%
 

package/documentation/3. Variables/Introduction.txt

@@ -10,30 +10,31 @@
 .incCurrentY %halfLineGap%
 .DrawText 0 %_CurrentY% Commands are described in a following chapter.
 
-.incCurrentY %_FontHeight%
+.incCurrentY %halfLineGap%
 .SetVar CommandLine1 Variables are referenced by enclosing them in percentage symbols. For example, to write some
 .SetVar CommandLine1 %CommandLine1% text at the current position on the page the following DrawText command can be used:
-.Do CommandLine1
-.incCurrentY %_FontHeight%
+.Do CommandLine
+.incCurrentY %halfLineGap%
 .SetVar CommandLine1 .DrawText %%%%_CurrentX%%%% %%%%_CurrentY%%%% Hello World!
 .Do CommandLine2
-.incCurrentY %_FontHeight%
+.incCurrentY %halfLineGap%
 .SetVar CommandLine1 Variables (and commands) are not case sensitive and the above command could also be given as:
-.Do CommandLine1 
-.incCurrentY %_FontHeight%
+.Do CommandLine
+.incCurrentY %halfLineGap%
 .SetVar CommandLine1 .drawTEXT %%%%_currentX%%%% %%%%_CURRENTy%%%% Hello World!
 .Do CommandLine2 
-.incCurrentY %_FontHeight%
+.incCurrentY %halfLineGap%
 
 .SetVar CommandLine1 Variables are stored as strings though there is a limited capability to perform arithmetic on
 .SetVar CommandLine1 %CommandLine1% variables. For example, the .IncVar command can be used to add or subtract a number from
 .SetVar CommandLine1 %CommandLine1% a variable.
-.Do CommandLine1
-.incCurrentY %_FontHeight%
+.Do CommandLine
+.incCurrentY %halfLineGap%
 
-.DrawText 0 %_CurrentY% Variables do not have to be assigned a value before being used. 
+.DrawText 0 %_CurrentY% Variables do not have to be assigned a value before being used.
+.incCurrentY %halfLineGap%
 .DrawText 0 %_CurrentY% The value of a variable referenced before being assigned a value is an empty string.
-.incCurrentY %_FontHeight%
+.incCurrentY %halfLineGap%
 .SetVar CommandLine1 All variables are global, there is no scoping of variables within a group. A variable
 .SetVar CommandLine1 %CommandLine1% defined within a group is available to commands run after that group.
-.Do CommandLine1
+.Do CommandLine

package/documentation/3. Variables/SystemMaintained.txt

@@ -31,6 +31,26 @@
 .SetVar CommandLine2 The last page orientation specified:  'portrait' or 'landscape'
 .Do VariableLineWide
 
+.incCurrentY %halfLineGap%
+.SetVar CommandLine1 _DateDdMmYyyy
+.SetVar CommandLine2 The current date, formatted as DD/MM/YYYY.
+.Do VariableLineWrapped
+
+.incCurrentY %halfLineGap%
+.SetVar CommandLine1 _DateMmDdYyyy
+.SetVar CommandLine2 The current date, formatted as MM/DD/YYYY.
+.Do VariableLineWrapped
+
+.incCurrentY %halfLineGap%
+.SetVar CommandLine1 _DateISO
+.SetVar CommandLine2 The current date, formatted as YYYY-MM-DD.
+.Do VariableLineWrapped
+
+.incCurrentY %halfLineGap%
+.SetVar CommandLine1 _FillColour
+.SetVar CommandLine2 The colour that will be used when rendering any following filled boxes.
+.Do VariableLineWide
+
 .incCurrentY %halfLineGap%
 .SetVar CommandLine1 _FontHeight
 .SetVar CommandLine2 The height of the current font. This can be used to create a space between
@@ -115,6 +135,16 @@
 .SetVar CommandLine2 %CommandLine2% will contain the number of the added page.
 .Do VariableLineWrapped
 
+.incCurrentY %halfLineGap%
+.SetVar CommandLine1 _LineColour
+.SetVar CommandLine2 The colour that will be used to render any following lines.
+.Do VariableLineWide
+
+.incCurrentY %halfLineGap%
+.SetVar CommandLine1 _LineWidth
+.SetVar CommandLine2 The width that any following lines will be drawn.
+.Do VariableLine
+
 .incCurrentY %halfLineGap%
 .SetVar CommandLine1 _MarginBottom
 .SetVar CommandLine2 The current margin from the bottom edge of the page.
@@ -170,5 +200,15 @@
 .SetVar CommandLine2 %CommandLine2% from the height of the object plus the current vertical spacing, which can 
 .SetVar CommandLine2 %CommandLine2% be set with the SetSpaceVert command. 
 .Do VariableLineWrapped
+
+.incCurrentY %halfLineGap%
+.SetVar CommandLine1 _TextColour
+.SetVar CommandLine2 The colour that will be used when rendering any following text.
+.Do VariableLineWrapped
+
+.incCurrentY %halfLineGap%
+.SetVar CommandLine1 _TimeHhMm
+.SetVar CommandLine2 The current time, formatted as HH:MM.
+.Do VariableLineWrapped
 .incCurrentY %_SPACEVERT%
 .Do SetMargins 

package/documentation/4. Commands/DrawBox.txt

@@ -10,10 +10,10 @@
 .SetVar CommandSubHeading Parameters
 .Do CommandSubHeading
 .SetVar CommandLine1 Left
-.SetVar CommandLine2 The horizontal starting position of the box, measured from the left margin.
+.SetVar CommandLine2 The horizontal top left corner of the box, measured from the left margin.
 .Do CommandLine2
 .SetVar CommandLine1 Top
-.SetVar CommandLine2 The vertical starting position of the box, measured from the top margin.
+.SetVar CommandLine2 The vertical top left corner of the box, measured from the top margin.
 .Do CommandLine2
 .SetVar CommandLine1 Width
 .SetVar CommandLine2 The width of the box.
@@ -25,15 +25,12 @@
 .SetVar CommandLine2 Specifies how the box is drawn:
 .Do CommandLine2
 .incCurrentY %halfLineGap%
-.SetVar CommandLine3 0 - An outline of the box is drawn
+.SetVar CommandLine3 0 - An outline of the box is drawn using the current line width
 .Do CommandLine2
-.SetVar CommandLine3 1 - A filled box, without an outline is drawn
+.SetVar CommandLine3 1 - A box filled with the current fill colour, without an outline is drawn
 .Do CommandLine2
-.SetVar CommandLine3 2 - A filled box, with an outline is drawn
+.SetVar CommandLine3 2 - A box filled with the current fill colour, with an outline is drawn using the current line width
 .Do CommandLine2
-.incCurrentY %halfLineGap%
-.SetVar CommandLine1 All measurements are in the unit of measure specified when the JsPdfDynamo object was created.
-.Do CommandLine
 
 .SetVar CommandSubHeading Other
 .Do CommandSubHeading
@@ -62,6 +59,6 @@
 
 .SetVar CommandSubHeading See Also
 .Do CommandSubHeading
-.SetVar CommandLine1 SetFillColour, SetLineColour, SetLineWidth
+.SetVar CommandLine1 DrawCircle, DrawEllipse, DrawLine, SetFillColour, SetLineColour, SetLineWidth
 .Do CommandLine2
 .incCurrentY %_FontHeight%

package/documentation/4. Commands/DrawCircle.txt

@@ -0,0 +1,71 @@
+.SetVar CommandName DrawCircle
+.Do CommandHeading
+.SetVar CommandLine1 Draw a circle, centered at the given point using the current fill colour, 
+.SetVar CommandLine1 %CommandLine1% line colour and line width.
+.Do CommandLine
+
+.SetVar CommandSubHeading Syntax
+.Do CommandSubHeading
+.SetVar CommandLine1 .DrawCircle  Left  Top  Radius  Option
+.Do CommandLine2
+
+.SetVar CommandSubHeading Parameters
+.Do CommandSubHeading
+.SetVar CommandLine1 Left
+.SetVar CommandLine2 The horizontal center of the circle, measured from the left margin.
+.Do CommandLine2
+.SetVar CommandLine1 Top
+.SetVar CommandLine2 The vertical center of the circle, measured from the top margin.
+.Do CommandLine2
+.SetVar CommandLine1 Radius
+.SetVar CommandLine2 The radius of the circle, including the width of any outline.
+.Do CommandLine2
+.SetVar CommandLine1 Option
+.SetVar CommandLine2 Specifies how the circle is drawn:
+.Do CommandLine2
+.incCurrentY %halfLineGap%
+.SetVar CommandLine3 0 - An outline of the circle is drawn using the current line width
+.Do CommandLine2
+.SetVar CommandLine3 1 - A circle filled with the current fill colour, without an outline is drawn
+.Do CommandLine2
+.SetVar CommandLine3 2 - A circle filled with the current fill colour, with an outline is drawn using the current line width
+.Do CommandLine2
+
+.SetVar CommandSubHeading Other
+.Do CommandSubHeading
+.SetVar CommandLine1 The variable _LastResult is set to '0' if there were any issues with the parameters
+.SetVar CommandLine1 %CommandLine1% provided, otherwise it is set to '1'.
+.Do CommandLine
+.incCurrentY %_FontHeight%
+.SetVar CommandLine1 Unlike most other commands, the top and left positions specify the
+.SetVar CommandLine1 %CommandLine1% center point of the circle, not the left-most and top-most points.
+.Do CommandLine
+
+.SetVar CommandSubHeading Examples
+.Do CommandSubHeading
+.SetVar CommandLine1 Assuming that the unit of measure is millimeters, 
+.SetVar CommandLine1 %CommandLine1% a circle outline is drawn that is 5 millimeters high
+.SetVar CommandLine1 %CommandLine1% and is centered at the current position on the page.
+.Do CommandLine
+.incCurrentY %halfLineGap%
+.SetVar CommandLine1 .DrawCircle  %%%%_CurrentX%%%%  %%%%_CurrentY%%%%  5  0
+.Do CommandLine2
+
+.incCurrentY %_FontHeight%
+.SetVar CommandLine1 Assuming that the unit of measure is inches, 
+.SetVar CommandLine1 %CommandLine1% an outlined and filled circle is drawn at the center 
+.SetVar CommandLine1 %CommandLine1% of the page, touching the top margin and is ½ inch high.
+.Do CommandLine
+.incCurrentY %halfLineGap%
+.SetVar CommandLine1 .SetVar  center  %%%%_PageWidth%%%%
+.Do CommandLine2
+.SetVar CommandLine1 .MultVar  center  0.5
+.Do CommandLine2
+.SetVar CommandLine1 .DrawCircle  0.5  %%%%center%%%%  0.5  2
+.Do CommandLine2
+
+.SetVar CommandSubHeading See Also
+.Do CommandSubHeading
+.SetVar CommandLine1 DrawBox, DrawEllipse, DrawLine, SetFillColour, SetLineColour, SetLineWidth
+.Do CommandLine2
+.incCurrentY %_FontHeight%

package/documentation/4. Commands/DrawEllipse.txt

@@ -0,0 +1,75 @@
+.SetVar CommandName DrawEllipse
+.Do CommandHeading
+.SetVar CommandLine1 Draw an ellipse, centered at the given point using the current fill colour, 
+.SetVar CommandLine1 %CommandLine1% line colour and line width.
+.Do CommandLine
+
+.SetVar CommandSubHeading Syntax
+.Do CommandSubHeading
+.SetVar CommandLine1 .DrawEllipse  Left  Top  RadiusX  RadiusY  Option
+.Do CommandLine2
+
+.SetVar CommandSubHeading Parameters
+.Do CommandSubHeading
+.SetVar CommandLine1 Left
+.SetVar CommandLine2 The horizontal center of the ellipse, measured from the left margin.
+.Do CommandLine2
+.SetVar CommandLine1 Top
+.SetVar CommandLine2 The vertical center of the ellipse, measured from the top margin.
+.Do CommandLine2
+.SetVar CommandLine1 RadiusX
+.SetVar CommandLine2 The horizontal radius of the ellipse, including the width of any outline.
+.Do CommandLine2
+.Do CommandLine2
+.SetVar CommandLine1 RadiusY
+.SetVar CommandLine2 The vertical radius of the ellipse, including the width of any outline.
+.Do CommandLine2
+.SetVar CommandLine1 Option
+.SetVar CommandLine2 Specifies how the ellipse is drawn:
+.Do CommandLine2
+.incCurrentY %halfLineGap%
+.SetVar CommandLine3 0 - An outline of the ellipse is drawn using the current line width
+.Do CommandLine2
+.SetVar CommandLine3 1 - An ellipse filled with the current fill colour, without an outline is drawn
+.Do CommandLine2
+.SetVar CommandLine3 2 - An ellipse filled with the current fill colour, with an outline is drawn using the current line width
+.Do CommandLine2
+
+.SetVar CommandSubHeading Other
+.Do CommandSubHeading
+.SetVar CommandLine1 The variable _LastResult is set to '0' if there were any issues with the parameters
+.SetVar CommandLine1 %CommandLine1% provided, otherwise it is set to '1'.
+.Do CommandLine
+.incCurrentY %_FontHeight%
+.SetVar CommandLine1 Unlike most other commands, the top and left positions specify the
+.SetVar CommandLine1 %CommandLine1% center point of the ellipse, not the left-most and top-most points.
+.Do CommandLine
+
+.SetVar CommandSubHeading Examples
+.Do CommandSubHeading
+.SetVar CommandLine1 Assuming that the unit of measure is millimeters, 
+.SetVar CommandLine1 %CommandLine1% an outline of an ellipse is drawn that is 4.5 millimeters high,
+.SetVar CommandLine1 %CommandLine1% 8.5 millimeters wide, and is centered at the current position on the page.
+.Do CommandLine
+.incCurrentY %halfLineGap%
+.SetVar CommandLine1 .DrawEllipse  %%%%_CurrentX%%%%  %%%%_CurrentY%%%%  8.5  4.5  0
+.Do CommandLine2
+
+.incCurrentY %_FontHeight%
+.SetVar CommandLine1 Assuming that the unit of measure is inches, an outlined and filled
+.SetVar CommandLine1 %CommandLine1% ellipse is drawn at the center of the page, touching the
+.SetVar CommandLine1 %CommandLine1% top margin and is ½ inch high and 1 inch wide.
+.Do CommandLine
+.incCurrentY %halfLineGap%
+.SetVar CommandLine1 .SetVar  center  %%%%_PageWidth%%%%
+.Do CommandLine2
+.SetVar CommandLine1 .MultVar  center  0.5
+.Do CommandLine2
+.SetVar CommandLine1 .DrawEllipse  0.5  %%%%center%%%%  1  0.5  2
+.Do CommandLine2
+
+.SetVar CommandSubHeading See Also
+.Do CommandSubHeading
+.SetVar CommandLine1 DrawBox, DrawCircle, DrawLine, SetFillColour, SetLineColour, SetLineWidth
+.Do CommandLine2
+.incCurrentY %_FontHeight%