jspdf-dynamo 1.0.1 → 1.0.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (52) hide show
  1. package/dist/index.cjs +90 -30
  2. package/dist/index.d.cts +18 -6
  3. package/dist/index.d.ts +18 -6
  4. package/dist/index.js +90 -30
  5. package/documentation/3. Variables/Introduction.txt +15 -12
  6. package/documentation/3. Variables/SystemMaintained.txt +47 -63
  7. package/documentation/4. Commands/AddBookmark.txt +4 -4
  8. package/documentation/4. Commands/AddPage.txt +6 -4
  9. package/documentation/4. Commands/CheckPage.txt +3 -3
  10. package/documentation/4. Commands/Commands.txt +7 -0
  11. package/documentation/4. Commands/CopyVar.txt +3 -3
  12. package/documentation/4. Commands/DivVar.txt +67 -0
  13. package/documentation/4. Commands/Do.txt +3 -3
  14. package/documentation/4. Commands/DoRepeat.txt +3 -3
  15. package/documentation/4. Commands/DrawBox.txt +3 -3
  16. package/documentation/4. Commands/DrawDebugGrid.txt +3 -3
  17. package/documentation/4. Commands/DrawImage.txt +4 -4
  18. package/documentation/4. Commands/DrawLine.txt +3 -3
  19. package/documentation/4. Commands/DrawTextBox.txt +1 -1
  20. package/documentation/4. Commands/DrawTextWrapped.txt +40 -17
  21. package/documentation/4. Commands/ForEachPage.txt +4 -4
  22. package/documentation/4. Commands/GetEnvVar.txt +2 -2
  23. package/documentation/4. Commands/IfEq.txt +53 -0
  24. package/documentation/4. Commands/IfGt.txt +1 -1
  25. package/documentation/4. Commands/IfNotBlank.txt +3 -3
  26. package/documentation/4. Commands/IncCurrentX.txt +1 -1
  27. package/documentation/4. Commands/IncCurrentY.txt +1 -1
  28. package/documentation/4. Commands/IncVar.txt +8 -8
  29. package/documentation/4. Commands/Include.txt +8 -8
  30. package/documentation/4. Commands/IncludeUrl.txt +43 -1
  31. package/documentation/4. Commands/{AddImageFromFile.txt → LoadImageFromFile.txt } +6 -6
  32. package/documentation/4. Commands/{AddImageFromUrl.txt → LoadImageFromUrl.txt } +6 -6
  33. package/documentation/4. Commands/MultVar.txt +11 -14
  34. package/documentation/4. Commands/SavePdf.txt +6 -0
  35. package/documentation/4. Commands/SelectPage.txt +6 -0
  36. package/documentation/4. Commands/SetCurrentX.txt +5 -5
  37. package/documentation/4. Commands/SetCurrentY.txt +3 -3
  38. package/documentation/4. Commands/SetDocumentInfo.txt +3 -3
  39. package/documentation/4. Commands/SetFillColour.txt +8 -25
  40. package/documentation/4. Commands/SetFontName.txt +3 -1
  41. package/documentation/4. Commands/SetFontSize.txt +2 -0
  42. package/documentation/4. Commands/SetLineColour.txt +8 -26
  43. package/documentation/4. Commands/SetLineWidth.txt +7 -7
  44. package/documentation/4. Commands/SetLogLevel.txt +6 -0
  45. package/documentation/4. Commands/SetMargin.txt +11 -14
  46. package/documentation/4. Commands/SetTextColour.txt +43 -0
  47. package/documentation/4. Commands/SetVar.txt +9 -10
  48. package/documentation/4. Commands/WriteLog.txt +56 -0
  49. package/documentation/Documentation.pdf +3430 -2703
  50. package/documentation/documentation.txt +13 -12
  51. package/package.json +2 -2
  52. package/documentation/4. Commands/SetPageOrientation.txt +0 -42
@@ -1,7 +1,7 @@
1
1
  .SetVar CommandName ForEachPage
2
2
  .Do CommandHeading
3
3
  .DrawText 0 %_CurrentY% Run one or more groups of commands for each page that has been created so far. This
4
- .SetVar CommandLine1 can be used for several purposes, including: to run at the end of the report to .
4
+ .SetVar CommandLine1 can be used at the end of the document generation to:
5
5
  .Do CommandLine
6
6
  .incCurrentY %halfLineGap%
7
7
  .SetVar CommandLine1 * Printing a footer "Page 1 of 4" on each page.
@@ -12,7 +12,7 @@
12
12
 
13
13
  .SetVar CommandSubHeading Syntax
14
14
  .Do CommandSubHeading
15
- .SetVar CommandLine1 .ForEachPage Group1, Group2...etc
15
+ .SetVar CommandLine1 .ForEachPage Group1, Group2...etc
16
16
  .Do CommandLine2
17
17
 
18
18
  .SetVar CommandSubHeading Parameters
@@ -31,14 +31,14 @@
31
31
  .SetVar CommandLine1 Execute the commands in the 'footer' group on each page:
32
32
  .Do CommandLine
33
33
  .incCurrentY %halfLineGap%
34
- .SetVar CommandLine1 .ForEachPage Footer
34
+ .SetVar CommandLine1 .ForEachPage Footer
35
35
  .Do CommandLine2
36
36
 
37
37
  .incCurrentY %_FontHeight%
38
38
  .SetVar CommandLine1 Print a debug grid on each page (which is specified in the group called 'DrawDebug'):
39
39
  .Do CommandLine
40
40
  .incCurrentY %halfLineGap%
41
- .SetVar CommandLine1 .ForEachPage DrawDebug
41
+ .SetVar CommandLine1 .ForEachPage DrawDebug
42
42
  .Do CommandLine2
43
43
 
44
44
  .incCurrentY %_FontHeight%
@@ -43,14 +43,14 @@
43
43
  .SetVar CommandLine1 Set the variable 'UserTemp' to the value of the current user's temporary directory:
44
44
  .Do CommandLine
45
45
  .incCurrentY %halfLineGap%
46
- .SetVar CommandLine1 .GetEnvVar UserTemp Temp User
46
+ .SetVar CommandLine1 .GetEnvVar UserTemp Temp User
47
47
  .Do CommandLine2
48
48
  .incCurrentY %_FontHeight%
49
49
 
50
50
  .SetVar CommandLine1 Set the variable 'MachineTemp' to the value of the machine's temporary directory:
51
51
  .Do CommandLine
52
52
  .incCurrentY %halfLineGap%
53
- .SetVar CommandLine1 .GetEnvVar MachineTemp Temp Machine
53
+ .SetVar CommandLine1 .GetEnvVar MachineTemp Temp Machine
54
54
  .Do CommandLine2
55
55
 
56
56
  .incCurrentY %_FontHeight%
@@ -0,0 +1,53 @@
1
+ .SetVar CommandName IfEq
2
+ .Do CommandHeading
3
+ .SetVar text Compares two variables and if the first one is equal to the second then process a given command. This can be used
4
+ .SetVar text %text% to process one or more groups of commands using the 'do' command or perform some other action, such
5
+ .SetVar text %text% as setting the value of a variable. If either of the variables are not numbers then a string comparison is made.
6
+ .DrawTextWrapped 0 %_CurrentY% %_PageWidth% CommandCheckPage %text%
7
+
8
+ .SetVar CommandSubHeading Syntax
9
+ .Do CommandSubHeading
10
+ .SetVar CommandLine1 .IfEq Value1 Value2 Command
11
+ .Do CommandLine2
12
+
13
+ .SetVar CommandSubHeading Parameters
14
+ .Do CommandSubHeading
15
+ .SetVar CommandLine1 Value1,
16
+ .SetVar CommandLine2 The values to compare. These can either be constants or values of
17
+ .Do CommandLine2
18
+ .SetVar CommandLine1 Value2
19
+ .SetVar CommandLine2 variables using substitution.
20
+ .Do CommandLine2
21
+ .SetVar CommandLine1 Command
22
+ .SetVar CommandLine2 The command to execute if the first value is greater than the second.
23
+ .Do CommandLine2
24
+
25
+ .SetVar CommandSubHeading Other
26
+ .Do CommandSubHeading
27
+ .SetVar text The variable _LastResult is set to '0' if the first variable is not equal to the second, otherwise
28
+ .SetVar text %text% _LastResult is set to the result of the last command processed by this command.
29
+ .DrawTextWrapped 0 %_CurrentY% %_PageWidth% CommandCheckPage %text%
30
+ .incCurrentY %HalfFontHeight%
31
+ .SetVar text Comparison of string values is case sensitive.
32
+ .DrawTextWrapped 0 %_CurrentY% %_PageWidth% CommandCheckPage %text%
33
+
34
+ .SetVar CommandSubHeading Examples
35
+ .Do CommandSubHeading
36
+ .SetVar text Set the value of variable 'finished' to 'true' when the values of variables 'counter' and 'maxCounter' are equal.
37
+ .DrawTextWrapped 0 %_CurrentY% %_PageWidth% CommandCheckPage %text%
38
+ .Do CommandLine2
39
+ .SetVar CommandLine1 .IfEq %%%%counter%%%% %%%%maxCounter%%%% .SetVar finished true
40
+ .Do CommandLine2
41
+
42
+ .incCurrentY %_FontHeight%
43
+ .SetVar LongText Process the groups 'OutputTotals' and 'EndDocument' if the value of the variable 'finished' is 'true'.
44
+ .DrawTextWrapped 0 %_CurrentY% %_PageWidth% CommandCheckPage %LongText%
45
+ .incCurrentY %halfLineGap%
46
+ .SetVar CommandLine1 .IfEq %%%%finished%%%% true .Do OutputTotals EndDocument
47
+ .Do CommandLine2
48
+
49
+ .SetVar CommandSubHeading See Also
50
+ .Do CommandSubHeading
51
+ .SetVar CommandLine1 IfBlank, IfGt, IfNotBlank
52
+ .Do CommandLine2
53
+ .incCurrentY %_FontHeight%
@@ -53,6 +53,6 @@
53
53
 
54
54
  .SetVar CommandSubHeading See Also
55
55
  .Do CommandSubHeading
56
- .SetVar CommandLine1 IfBlank, IfNotBlank
56
+ .SetVar CommandLine1 IfBlank, IfEq, IfNotBlank
57
57
  .Do CommandLine2
58
58
  .incCurrentY %_FontHeight%
@@ -34,14 +34,14 @@
34
34
  .SetVar CommandLine1 Print text stored in the variable called 'MyHeading' if it is not blank:
35
35
  .Do CommandLine
36
36
  .incCurrentY %halfLineGap%
37
- .SetVar CommandLine1 .IfNotBlank MyHeading .DrawText 0 %%%%_CurrentY%%%% %%%%MyHeading%%%%
37
+ .SetVar CommandLine1 .IfNotBlank MyHeading .DrawText 0 %%%%_CurrentY%%%% %%%%MyHeading%%%%
38
38
  .Do CommandLine2
39
39
  .incCurrentY %_FontHeight%
40
40
 
41
41
  .SetVar CommandLine1 Process the groups 'continued' and 'AddPage' if the variable called 'more' is not blank:
42
42
  .Do CommandLine
43
43
  .incCurrentY %halfLineGap%
44
- .SetVar CommandLine1 .IfNotBlank MORE .Do continued AddPage
44
+ .SetVar CommandLine1 .IfNotBlank MORE .Do continued AddPage
45
45
  .Do CommandLine2
46
46
  .incCurrentY %_FontHeight%
47
47
 
@@ -50,7 +50,7 @@
50
50
  .SetVar CommandLine1 variable named 'varname' is not blank:
51
51
  .Do CommandLine
52
52
  .incCurrentY %halfLineGap%
53
- .SetVar CommandLine1 .IfNotBlank %%%%VarName%%%% .Do continued AddPage
53
+ .SetVar CommandLine1 .IfNotBlank %%%%VarName%%%% .Do continued AddPage
54
54
  .Do CommandLine2
55
55
 
56
56
  .SetVar CommandSubHeading See Also
@@ -5,7 +5,7 @@
5
5
 
6
6
  .SetVar CommandSubHeading Syntax
7
7
  .Do CommandSubHeading
8
- .SetVar CommandLine1 .incCurrentX Value Value (etc)
8
+ .SetVar CommandLine1 .incCurrentX Value Value (etc)
9
9
  .Do CommandLine2
10
10
 
11
11
  .SetVar CommandSubHeading Parameters
@@ -5,7 +5,7 @@
5
5
 
6
6
  .SetVar CommandSubHeading Syntax
7
7
  .Do CommandSubHeading
8
- .SetVar CommandLine1 .incCurrentY Value Value (etc)
8
+ .SetVar CommandLine1 .incCurrentY Value Value (etc)
9
9
  .Do CommandLine2
10
10
 
11
11
  .SetVar CommandSubHeading Parameters
@@ -4,7 +4,7 @@
4
4
 
5
5
  .SetVar CommandSubHeading Syntax
6
6
  .Do CommandSubHeading
7
- .SetVar CommandLine1 .IncVar Variable Value Value (etc)
7
+ .SetVar CommandLine1 .IncVar Variable Value Value (etc)
8
8
  .Do CommandLine2
9
9
 
10
10
  .SetVar CommandSubHeading Parameters
@@ -40,27 +40,27 @@
40
40
  .SetVar CommandLine1 Increase the value of the variable 'LineNo' from '3' to '4':
41
41
  .Do CommandLine
42
42
  .incCurrentY %halfLineGap%
43
- .SetVar CommandLine1 .SetVar LineNo 3
43
+ .SetVar CommandLine1 .SetVar LineNo 3
44
44
  .Do CommandLine2
45
- .SetVar CommandLine1 .IncVar LineNo 1
45
+ .SetVar CommandLine1 .IncVar LineNo 1
46
46
  .Do CommandLine2
47
47
  .incCurrentY %_FontHeight%
48
48
 
49
49
  .SetVar CommandLine1 Decrease the value of 'Weight3' from '78.6' to '77.2':
50
50
  .Do CommandLine
51
51
  .incCurrentY %halfLineGap%
52
- .SetVar CommandLine1 .SetVar index 3
52
+ .SetVar CommandLine1 .SetVar index 3
53
53
  .Do CommandLine2
54
- .SetVar CommandLine1 .SetVar Weight%%%%index%%%% 78.6
54
+ .SetVar CommandLine1 .SetVar Weight%%%%index%%%% 78.6
55
55
  .Do CommandLine2
56
- .SetVar CommandLine1 .IncVar Weight%%%%index%%%% -1.4
56
+ .SetVar CommandLine1 .IncVar Weight%%%%index%%%% -1.4
57
57
  .Do CommandLine2
58
58
  .incCurrentY %_FontHeight%
59
59
 
60
60
  .SetVar CommandLine1 Multiple values can be used to increase value of 'total' from 0 to 4.55
61
61
  .Do CommandLine
62
62
  .incCurrentY %halfLineGap%
63
- .SetVar CommandLine1 .SetVar Total 0
63
+ .SetVar CommandLine1 .SetVar Total 0
64
64
  .Do CommandLine2
65
65
  .SetVar CommandLine1 .IncVar Total 5 -2.5 2.05
66
66
  .Do CommandLine2
@@ -68,6 +68,6 @@
68
68
 
69
69
  .SetVar CommandSubHeading See Also
70
70
  .Do CommandSubHeading
71
- .SetVar CommandLine1 CopyVar, MultVar, SetVar
71
+ .SetVar CommandLine1 CopyVar, DivVar, MultVar, SetVar
72
72
  .Do CommandLine2
73
73
  .incCurrentY %_FontHeight%
@@ -1,26 +1,26 @@
1
1
  .SetVar CommandName Include (NodeJs Only)
2
2
  .Do CommandHeading
3
3
  .SetVar CommandLine1 Load commands from a text file in the file system. The loaded commands may also load other commands.
4
- .SetVar CommandLine1 %CommandLine1% The text file may contain individual commands or groups of commands.
4
+ .SetVar CommandLine1 %CommandLine1% The text file may contain individual commands or groups of commands.
5
5
  .SetVar CommandLine1 %CommandLine1% Commands not within a group will be executed.
6
6
  .Do CommandLine
7
7
 
8
8
  .SetVar CommandSubHeading Syntax
9
9
  .Do CommandSubHeading
10
- .SetVar CommandLine1 .Include FileName
10
+ .SetVar CommandLine1 .Include FileName
11
11
  .Do CommandLine2
12
12
 
13
13
  .SetVar CommandSubHeading Parameters
14
14
  .Do CommandSubHeading
15
15
  .SetVar CommandLine1 FileName
16
- .SetVar CommandLine2 The path and name of the file to be included.
16
+ .SetVar CommandLine2 The path and name of the file from which the commands will be loaded.
17
17
  .Do CommandLine2
18
18
 
19
19
  .SetVar CommandSubHeading Other
20
20
  .Do CommandSubHeading
21
- .SetVar CommandLine1 The variable _LastResult is set to '1' if the file is found or '0' if the file could not be found or opened.
22
- .SetVar CommandLine1 %CommandLine1% opened. Note that the _LastResult of any commands run by the include are not available and
23
- .SetVar CommandLine1 %CommandLine1% should be saved to variables within the included file if required.
21
+ .SetVar CommandLine1 The variable _LastResult is set to '1' if the file is found or '0' if the file could not be found or
22
+ .SetVar CommandLine1 %CommandLine1% opened. Note that the _LastResult of any commands run by the include are not available
23
+ .SetVar CommandLine1 %CommandLine1% and should be saved to variables within the included file if required.
24
24
  .Do CommandLine
25
25
 
26
26
  .SetVar CommandSubHeading Examples
@@ -28,13 +28,13 @@
28
28
  .SetVar CommandLine1 Include the template file StdReportLayout.txt:
29
29
  .Do CommandLine
30
30
  .incCurrentY %halfLineGap%
31
- .SetVar CommandLine1 .Include ./StdReportLayout.txt
31
+ .SetVar CommandLine1 .Include ./StdReportLayout.txt
32
32
  .Do CommandLine2
33
33
  .incCurrentY %_FontHeight%
34
34
  .SetVar CommandLine1 Include the template file specified in the 'ReportType' variable:
35
35
  .Do CommandLine
36
36
  .incCurrentY %halfLineGap%
37
- .SetVar CommandLine1 .Include /tmplates/%%%%ReportType%%%%
37
+ .SetVar CommandLine1 .Include /tmplates/%%%%ReportType%%%%
38
38
  .Do CommandLine2
39
39
 
40
40
  .SetVar CommandSubHeading See Also
@@ -1,7 +1,49 @@
1
1
  .SetVar CommandName IncludeUrl (Browser Only)
2
2
  .Do CommandHeading
3
- .SetVar CommandLine1 To be documented.
3
+
4
+ .SetVar CommandLine1 Load commands from a document fetched over http. The loaded commands may also load other
5
+ .SetVar CommandLine1 %CommandLine1% commands. The document should be a text file containing individual commands
6
+ .SetVar CommandLine1 %CommandLine1% or groups of commands. Commands not within a group will be executed.
7
+ .Do CommandLine
8
+
9
+ .SetVar CommandSubHeading Syntax
10
+ .Do CommandSubHeading
11
+ .SetVar CommandLine1 .IncludeUrl Url
12
+ .Do CommandLine2
13
+
14
+ .SetVar CommandSubHeading Parameters
15
+ .Do CommandSubHeading
16
+ .SetVar CommandLine1 Url
17
+ .SetVar CommandLine2 The URL from which the commands are to be loaded.
18
+ .Do CommandLine2
19
+
20
+ .SetVar CommandSubHeading Other
21
+ .Do CommandSubHeading
22
+ .SetVar CommandLine1 The variable _LastResult is set to '1' if the commands are loaded from the URL, or '0'
23
+ .SetVar CommandLine1 %CommandLine1% if the document at the URL could not be retrieved. Note that the
24
+ .SetVar CommandLine1 %CommandLine1% _LastResult of any commands run by the include are not available and
25
+ .SetVar CommandLine1 %CommandLine1% should be saved to variables within the included document if required.
26
+ .Do CommandLine
27
+ .incCurrentY %halfLineGap%
28
+ .SetVar CommandLine1 The document is attempted to be retrieved using a 'GET' call of the JavaScript 'fetch' method.
29
+ .SetVar CommandLine1 %CommandLine1% If there are any special requirements to retrieve the document, for example to meet
30
+ .SetVar CommandLine1 %CommandLine1% proxy or security requirements, then these are best handled by the calling program.
31
+ .Do CommandLine
32
+
33
+ .SetVar CommandSubHeading Examples
34
+ .Do CommandSubHeading
35
+ .SetVar CommandLine1 Retrieve and load the invoice template from the current applications templates directory:
36
+ .Do CommandLine
37
+ .incCurrentY %halfLineGap%
38
+ .SetVar CommandLine1 .IncludeUrl /templates/invoice.txt
39
+ .Do CommandLine2
40
+ .incCurrentY %_FontHeight%
41
+
42
+ .SetVar CommandLine1 Retrieve and load the template file specified in the 'DocumentType' variable:
4
43
  .Do CommandLine
44
+ .incCurrentY %halfLineGap%
45
+ .SetVar CommandLine1 .Include /templates/%%%%DocumentType%%%%
46
+ .Do CommandLine2
5
47
 
6
48
  .SetVar CommandSubHeading See Also
7
49
  .Do CommandSubHeading
@@ -1,4 +1,4 @@
1
- .SetVar CommandName AddImageFromFile (NodeJs Only)
1
+ .SetVar CommandName LoadImageFromFile (NodeJs Only)
2
2
  .Do CommandHeading
3
3
  .SetVar text Reads an image from the file system and stores it for later output. JsPdfDynamo can use all image types
4
4
  .SetVar text %text% that jsPDF supports, including: BMP, GIF, JPEG, PNG, TIFF and WEBP
@@ -7,7 +7,7 @@
7
7
 
8
8
  .SetVar CommandSubHeading Syntax
9
9
  .Do CommandSubHeading
10
- .SetVar CommandLine1 .AddImageFromFile FileName
10
+ .SetVar CommandLine1 .LoadImageFromFile FileName
11
11
  .Do CommandLine2
12
12
 
13
13
  .SetVar CommandSubHeading Parameters
@@ -44,16 +44,16 @@
44
44
  .SetVar CommandLine1 Read a logo from an image and add it to the top left of the current page.
45
45
  .Do CommandLine
46
46
  .incCurrentY %halfLineGap%
47
- .SetVar CommandLine1 .AddImageFromFile ../images/myLogo.jpg
47
+ .SetVar CommandLine1 .LoadImageFromFile ../images/myLogo.jpg
48
48
  .Do CommandLine2
49
- .SetVar CommandLine1 .SetVar IdLogo %%%%_LastImageAdded%%%%
49
+ .SetVar CommandLine1 .SetVar IdLogo %%%%_LastImageAdded%%%%
50
50
  .Do CommandLine2
51
- .SetVar CommandLine1 .DrawImage %%%%IdLogo%%%% 0 0 1
51
+ .SetVar CommandLine1 .DrawImage %%%%IdLogo%%%% 0 0 1
52
52
  .Do CommandLine2
53
53
  .incCurrentY %_FontHeight%
54
54
 
55
55
  .SetVar CommandSubHeading See Also
56
56
  .Do CommandSubHeading
57
- .SetVar CommandLine1 AddImageFromUrl, DrawImage
57
+ .SetVar CommandLine1 DrawImage, LoadImageFromUrl
58
58
  .Do CommandLine2
59
59
  .incCurrentY %_FontHeight%
@@ -1,4 +1,4 @@
1
- .SetVar CommandName AddImageFromUrl (Browser Only)
1
+ .SetVar CommandName LoadImageFromUrl (Browser Only)
2
2
  .Do CommandHeading
3
3
  .SetVar text Reads an image from the given URL and stores it for later output. JsPdfDynamo can use all image types
4
4
  .SetVar text %text% that jsPDF supports, including: BMP, GIF, JPEG, PNG, TIFF and WEBP
@@ -7,7 +7,7 @@
7
7
 
8
8
  .SetVar CommandSubHeading Syntax
9
9
  .Do CommandSubHeading
10
- .SetVar CommandLine1 .AddImageFromUrl URL
10
+ .SetVar CommandLine1 .LoadImageFromUrl URL
11
11
  .Do CommandLine2
12
12
 
13
13
  .SetVar CommandSubHeading Parameters
@@ -44,17 +44,17 @@
44
44
  .SetVar CommandLine1 Read a logo from an image and add it to the top left of the current page.
45
45
  .Do CommandLine
46
46
  .incCurrentY %halfLineGap%
47
- .SetVar CommandLine1 .AddImageFromUrl /images/logo.png
47
+ .SetVar CommandLine1 .LoadImageFromUrl /images/logo.png
48
48
  .Do CommandLine2
49
- .SetVar CommandLine1 .SetVar IdLogo %%%%_LastImageAdded%%%%
49
+ .SetVar CommandLine1 .SetVar IdLogo %%%%_LastImageAdded%%%%
50
50
  .Do CommandLine2
51
- .SetVar CommandLine1 .DrawImage %%%%IdLogo%%%% 0 0 1
51
+ .SetVar CommandLine1 .DrawImage %%%%IdLogo%%%% 0 0 1
52
52
  .Do CommandLine2
53
53
  .incCurrentY %_FontHeight%
54
54
 
55
55
  .SetVar CommandSubHeading See Also
56
56
  .Do CommandSubHeading
57
- .SetVar CommandLine1 AddImageFromFile, DrawImage
57
+ .SetVar CommandLine1 DrawImage, LoadImageFromFile
58
58
  .Do CommandLine2
59
59
 
60
60
  .incCurrentY %_FontHeight%
@@ -4,20 +4,17 @@
4
4
 
5
5
  .SetVar CommandSubHeading Syntax
6
6
  .Do CommandSubHeading
7
- .SetVar CommandLine1 .MultVar Variable Value Value (etc)
7
+ .SetVar CommandLine1 .MultVar Variable Value Value (etc)
8
8
  .Do CommandLine2
9
9
 
10
10
  .SetVar CommandSubHeading Parameters
11
11
  .Do CommandSubHeading
12
12
  .SetVar CommandLine1 Variable
13
13
  .SetVar CommandLine2 The name of the variable to update. This is not usually a substitution variable,
14
- .Do CommandLine2
15
- .SetVar CommandLine2 but it can be, or contain substitution variables. The variable must exist.
14
+ .SetVar CommandLine2 %CommandLine2% but it can be, or contain substitution variables. The variable must exist.
16
15
  .Do CommandLine2
17
16
  .SetVar CommandLine1 Value
18
- .SetVar CommandLine2 One or more values to multiple the variable by. These can be constants or
19
- .Do CommandLine2
20
- .SetVar CommandLine2 substitution variables.
17
+ .SetVar CommandLine2 One or more values to multiple the variable by. These can be constants or substitution variables.
21
18
  .Do CommandLine2
22
19
 
23
20
  .SetVar CommandSubHeading Other
@@ -37,34 +34,34 @@
37
34
  .SetVar CommandLine1 Multiple the value of the variable 'Total' by '4':
38
35
  .Do CommandLine
39
36
  .incCurrentY %halfLineGap%
40
- .SetVar CommandLine1 .SetVar Total 3
37
+ .SetVar CommandLine1 .SetVar Total 3
41
38
  .Do CommandLine2
42
- .SetVar CommandLine1 .MultVar Total 4
39
+ .SetVar CommandLine1 .MultVar Total 4
43
40
  .Do CommandLine2
44
41
  .incCurrentY %_FontHeight%
45
42
 
46
43
  .SetVar CommandLine1 Decrease the value of 'Weight6' by half from '78.6' to '39.3':
47
44
  .Do CommandLine
48
45
  .incCurrentY %halfLineGap%
49
- .SetVar CommandLine1 .SetVar index 6
46
+ .SetVar CommandLine1 .SetVar index 6
50
47
  .Do CommandLine2
51
- .SetVar CommandLine1 .SetVar Weight%%%%index%%%% 78.6
48
+ .SetVar CommandLine1 .SetVar Weight%%%%index%%%% 78.6
52
49
  .Do CommandLine2
53
- .SetVar CommandLine1 .MultVar Weight%%%%index%%%% 0.5
50
+ .SetVar CommandLine1 .MultVar Weight%%%%index%%%% 0.5
54
51
  .Do CommandLine2
55
52
  .incCurrentY %_FontHeight%
56
53
 
57
54
  .SetVar CommandLine1 Multiple values can be used to increase value of 'total' from 1 to 5
58
55
  .Do CommandLine
59
56
  .incCurrentY %halfLineGap%
60
- .SetVar CommandLine1 .SetVar Total 1
57
+ .SetVar CommandLine1 .SetVar Total 1
61
58
  .Do CommandLine2
62
- .SetVar CommandLine1 .MultVar Total 10 -0.5 -1
59
+ .SetVar CommandLine1 .MultVar Total 10 -0.5 -1
63
60
  .Do CommandLine2
64
61
  .incCurrentY %_FontHeight%
65
62
 
66
63
  .SetVar CommandSubHeading See Also
67
64
  .Do CommandSubHeading
68
- .SetVar CommandLine1 CopyVar, IncVar, SetVar
65
+ .SetVar CommandLine1 CopyVar, DivVar, IncVar, SetVar
69
66
  .Do CommandLine2
70
67
  .incCurrentY %_FontHeight%
@@ -0,0 +1,6 @@
1
+ .SetVar CommandName SavePdf
2
+ .Do CommandHeading
3
+ .SetVar CommandLine1 To be documented.
4
+ .Do CommandLine
5
+
6
+ .incCurrentY %_FontHeight%
@@ -0,0 +1,6 @@
1
+ .SetVar CommandName SelectPage
2
+ .Do CommandHeading
3
+ .SetVar CommandLine1 To be documented.
4
+ .Do CommandLine
5
+
6
+ .incCurrentY %_FontHeight%
@@ -6,28 +6,28 @@
6
6
 
7
7
  .SetVar CommandSubHeading Syntax
8
8
  .Do CommandSubHeading
9
- .SetVar CommandLine1 .setCurrentX Value
9
+ .SetVar CommandLine1 .setCurrentX Value
10
10
  .Do CommandLine2
11
11
 
12
12
  .SetVar CommandSubHeading Parameters
13
13
  .Do CommandSubHeading
14
14
  .SetVar CommandLine1 Value
15
- .SetVar CommandLine2 The value to assign to the current left position, expressed in millimeters.
15
+ .SetVar CommandLine2 The value to assign to the current left position.
16
16
  .Do CommandLine2
17
17
 
18
18
  .SetVar CommandSubHeading Examples
19
19
  .Do CommandSubHeading
20
- .SetVar CommandLine1 Set the current left position :
20
+ .SetVar CommandLine1 Set the current left position:
21
21
  .Do CommandLine
22
22
  .incCurrentY %halfLineGap%
23
- .SetVar CommandLine1 .setCurrentX 15
23
+ .SetVar CommandLine1 .setCurrentX 15
24
24
  .Do CommandLine2
25
25
  .incCurrentY %_FontHeight%
26
26
 
27
27
  .SetVar CommandLine1 Use a substitution variable to set the current left position:
28
28
  .Do CommandLine
29
29
  .incCurrentY %halfLineGap%
30
- .SetVar CommandLine1 .setCurrentX %%%%myIndent%%%%
30
+ .SetVar CommandLine1 .setCurrentX %%%%myIndent%%%%
31
31
  .Do CommandLine2
32
32
 
33
33
  .SetVar CommandSubHeading See Also
@@ -6,18 +6,18 @@
6
6
 
7
7
  .SetVar CommandSubHeading Syntax
8
8
  .Do CommandSubHeading
9
- .SetVar CommandLine1 .setCurrentY Value
9
+ .SetVar CommandLine1 .setCurrentY Value
10
10
  .Do CommandLine2
11
11
 
12
12
  .SetVar CommandSubHeading Parameters
13
13
  .Do CommandSubHeading
14
14
  .SetVar CommandLine1 Value
15
- .SetVar CommandLine2 The value to assign to the current top position, expressed in millimeters.
15
+ .SetVar CommandLine2 The value to assign to the current top position.
16
16
  .Do CommandLine2
17
17
 
18
18
  .SetVar CommandSubHeading Examples
19
19
  .Do CommandSubHeading
20
- .SetVar CommandLine1 Set the current top position :
20
+ .SetVar CommandLine1 Set the current top position:
21
21
  .Do CommandLine
22
22
  .incCurrentY %halfLineGap%
23
23
  .SetVar CommandLine1 .setCurrentY 14
@@ -4,7 +4,7 @@
4
4
 
5
5
  .SetVar CommandSubHeading Syntax
6
6
  .Do CommandSubHeading
7
- .SetVar CommandLine1 .SetDocumentInfo Property Value
7
+ .SetVar CommandLine1 .SetDocumentInfo Property Value
8
8
  .Do CommandLine2
9
9
 
10
10
  .SetVar CommandSubHeading Parameters
@@ -27,9 +27,9 @@
27
27
 
28
28
  .SetVar CommandSubHeading Examples
29
29
  .Do CommandSubHeading
30
- .SetVar CommandLine1 .SetDocumentInfo Author 12th Level
30
+ .SetVar CommandLine1 .SetDocumentInfo Author ACME Automation Inc.
31
31
  .Do CommandLine2
32
32
  .incCurrentY %halfLineGap%
33
- .SetVar CommandLine1 .SetDocumentInfo Title Weekly Status Report %%%%ReportDate%%%%
33
+ .SetVar CommandLine1 .SetDocumentInfo Title Weekly Status Report %%%%ReportDate%%%%
34
34
  .Do CommandLine2
35
35
  .incCurrentY %_FontHeight%
@@ -4,55 +4,38 @@
4
4
 
5
5
  .SetVar CommandSubHeading Syntax
6
6
  .Do CommandSubHeading
7
- .SetVar CommandLine1 .SetFillColor Red Green Blue
7
+ .SetVar CommandLine1 .SetFillColor Colour
8
8
  .Do CommandLine2
9
9
 
10
10
  .SetVar CommandSubHeading Parameters
11
11
  .Do CommandSubHeading
12
- .SetVar CommandLine1 Red
13
- .SetVar CommandLine2 The amount of red in the colour, represented as a number in the range
14
- .Do CommandLine2
15
- .SetVar CommandLine2 of 0 to 255
16
- .Do CommandLine2
17
- .SetVar CommandLine1 Green
18
- .SetVar CommandLine2 The amount of green in the colour, represented as a number in the range
19
- .Do CommandLine2
20
- .SetVar CommandLine2 of 0 to 255
21
- .Do CommandLine2
22
- .SetVar CommandLine1 Blue
23
- .SetVar CommandLine2 The amount of blue in the colour, represented as a number in the range
24
- .Do CommandLine2
25
- .SetVar CommandLine2 of 0 to 255
12
+ .SetVar CommandLine1 Colour
13
+ .SetVar CommandLine2 Either a CSS named colour or a hexadecimal RGB colour.
26
14
  .Do CommandLine2
27
15
 
28
16
  .SetVar CommandSubHeading Other
29
17
  .Do CommandSubHeading
30
- .SetVar CommandLine1 Colours are specified in the RGB style using three numbers in the range of 0 to 255,
31
- .Do CommandLine
32
- .SetVar CommandLine1 representing the amount of red, green and blue in the final colour.
33
- .Do CommandLine
34
- .incCurrentY %halfLineGap%
35
18
  .SetVar CommandLine1 The variable _LastResult is set to '1' by this command.
36
19
  .Do CommandLine
37
20
 
38
21
  .SetVar CommandSubHeading Examples
39
22
  .Do CommandSubHeading
40
- .SetVar CommandLine1 Set the colour of subsequent filled boxes to be grey:
23
+ .SetVar CommandLine1 Set the colour of subsequent filled boxes to be a light blue:
41
24
  .Do CommandLine
42
25
  .incCurrentY %halfLineGap%
43
- .SetVar CommandLine1 .SetLineColour 200 200 200
26
+ .SetVar CommandLine1 .SetFillColour LightSkyBlue
44
27
  .Do CommandLine2
45
28
 
46
29
  .incCurrentY %_FontHeight%
47
- .SetVar CommandLine1 Set the colour of subsequent filled boxes to be green:
30
+ .SetVar CommandLine1 Set the colour of subsequent filled boxes to be lime green:
48
31
  .Do CommandLine
49
32
  .incCurrentY %halfLineGap%
50
- .SetVar CommandLine1 .SetLineColour 0 180 0
33
+ .SetVar CommandLine1 .SetFillColour #32cd32
51
34
  .Do CommandLine2
52
35
 
53
36
  .SetVar CommandSubHeading See Also
54
37
  .Do CommandSubHeading
55
- .SetVar CommandLine1 DrawBox, SetLineColour
38
+ .SetVar CommandLine1 DrawBox, SetLineColour, SetTextColour
56
39
  .Do CommandLine
57
40
 
58
41
  .incCurrentY %_FontHeight%
@@ -1,4 +1,6 @@
1
1
  .SetVar CommandName SetFontName
2
2
  .Do CommandHeading
3
3
  .SetVar CommandLine1 To be documented.
4
- .Do CommandLine
4
+ .Do CommandLine
5
+
6
+ .incCurrentY %_FontHeight%
@@ -2,3 +2,5 @@
2
2
  .Do CommandHeading
3
3
  .SetVar CommandLine1 To be documented.
4
4
  .Do CommandLine
5
+
6
+ .incCurrentY %_FontHeight%