Recent changes to CreateProgramDoc

CreateProgramDoc modified by bstanly

bstanly — Mon, 26 Jun 2017 05:47:24 -0000

--- v5
+++ v6
@@ -10,7 +10,7 @@
  
  
  
-Printed on May 08, 2017
+Printed on June 25, 2017

 Copyright 2016 by Barry Stanly

@@ -81,12 +81,12 @@

 
-

 desc = "Test Report for Auto System\t\t\tWritten by:\t\t\tThe Auto Team"

+ desc = "Test Report for Auto System\t\t\tWritten by:\t\t\tThe Auto Team"

 self.doc.describeDocument(desc)
 
 
 
-Note "\t" is the Python way to specify a <TAB> character and represents a blank line in a description.
+Note "\t" is the Python way to specify a <TAB> character and represents a blank line in a description.
 

 
 # 4 Generate Results  
@@ -98,12 +98,12 @@
 ... Create table in external file

 self.doc.changeOutputFile("Table.sti")

 Caption = "Test Results"

-Header = "Test name\tResult"

+Header = "Test name\tResult"

 cspec = "|l|l|"

 self.doc.createTable(Caption, Header, cspec, Label="Tab")

  

 ... Add test data

-tab = "\t"

+tab = "\t"

 row = "Test 1" + tab + "Passed"

 self.doc.tableRow(row)

 row = "Test 2" + tab + "Passed"

@@ -129,8 +129,8 @@
 ## 5.1 Manual Formatting  
 This simple program (37 lines long) generates two files: TestReport.stf and the include file: Table.sti. To generate a PDF report, you can use a command file that is included with STF: makeDoc.bat. To use makeDoc, double click 0Dos.bat⁽¹⁾ and enter the following in the report directory:

-C:\Users\Public\Cmds\makeDoc.bat TestReport
-and TestReport.pdf and TestReport.html will be produced. If directory C:\Users\Public\Cmds was added to the path, per the installation instructions, then it is only necessary to enter:
+C:\Users\Public\Cmds\makeDoc.bat TestReport
+and TestReport.pdf and TestReport.html will be produced. If directory C:\Users\Public\Cmds was added to the path, per the installation instructions, then it is only necessary to enter:
 makeDoc TestReport. The Wiki formatted version is generated by entering:
 makeWiki TestReport

@@ -146,7 +146,7 @@
 
 

-Where it is assumed that LaTeX and STFxlate have been added to the path so it is not necessary to fully qualify file names. STFxlate.bat is a command file that provides services to STFxlate.py. To see what STFxlate.bat does, edit or type C:\Users\Public\Cmds\makeDoc.bat after installation.
+Where it is assumed that LaTeX and STFxlate have been added to the path so it is not necessary to fully qualify file names. STFxlate.bat is a command file that provides services to STFxlate.py. To see what STFxlate.bat does, edit or type C:\Users\Public\Cmds\makeDoc.bat after installation.
 The resulting table looks like Table 1.

     
![Figure 5.1-1 Table 1](https://a.fsdn.com/con/app/proj/simpletextformatter/screenshots/Results.jpg 180x120)  
@@ -156,7 +156,7 @@
 
 
 ## 5.2 GUI Formatting  
-To generate the documents the easy way, double click on TestReport.stf in the report directory and a menu will display (assuming Executor was installed per the installation instructions.) The default menu is shown in Figure 5.2-2. The defaults for Executor are stored in C:\Users\'you'\.nic\Executor and may be customized after the first execution. Since there is no contents for this document, use makeDoc; otherwise use makeDocWithIndex, etc.
+To generate the documents the easy way, double click on TestReport.stf in the report directory and a menu will display (assuming Executor was installed per the installation instructions.) The default menu is shown in Figure 5.2-2. The defaults for Executor are stored in C:\Users\'you'\.nic\Executor and may be customized after the first execution. Since there is no contents for this document, use makeDoc; otherwise use makeDocWithIndex, etc.

     ![Figure 5.2-2 GUI Menu](https://a.fsdn.com/con/app/proj/simpletextformatter/screenshots/STF_Menu.jpg 280x239)  
 Figure 5.2-2 GUI Menu

CreateProgramDoc modified by bstanly

bstanly — Mon, 08 May 2017 21:28:47 -0000

--- v4
+++ v5
@@ -10,7 +10,7 @@
  
  
  
-Printed on April 20, 2017
+Printed on May 08, 2017

 Copyright 2016 by Barry Stanly

CreateProgramDoc modified by bstanly

bstanly — Fri, 21 Apr 2017 01:13:27 -0000

--- v3
+++ v4
@@ -10,7 +10,7 @@
  
  
  
-Printed on April 06, 2017
+Printed on April 20, 2017

 Copyright 2016 by Barry Stanly

@@ -44,7 +44,7 @@
 ---
 
 # 1 Introduction  
-In reading this document, Familiarity with the [STF Syntax Summary](https://sourceforge.net/p/simpletextformatter/wiki/STFXLateSummary) is assumed.
+In reading this document, Familiarity with the [STF Syntax Summary](https://sourceforge.net/p/simpletextformatter/wiki/STFXLateSummary) is assumed. ([Download document PDF](https://sourceforge.net/projects/simpletextformatter/files/CreateProgramDoc.pdf))

 This document shows how to create a document using the STF Python API. A simple test report was chosen for the example:

CreateProgramDoc modified by bstanly

bstanly — Sun, 09 Apr 2017 09:23:42 -0000

--- v2
+++ v3
@@ -10,7 +10,7 @@
  
  
  
-Printed on December 05, 2016
+Printed on April 06, 2017

 Copyright 2016 by Barry Stanly

@@ -44,7 +44,7 @@
 ---
 
 # 1 Introduction  
-In reading this document, Familiarity with the [STF Syntax Summary](https://sourceforge.net/p/simpletextformatter/wiki/STFXlate) is assumed.
+In reading this document, Familiarity with the [STF Syntax Summary](https://sourceforge.net/p/simpletextformatter/wiki/STFXLateSummary) is assumed.

 This document shows how to create a document using the STF Python API. A simple test report was chosen for the example:

CreateProgramDoc modified by bstanly

bstanly — Mon, 05 Dec 2016 20:52:15 -0000

--- v1
+++ v2
@@ -10,7 +10,7 @@
  
  
  
-Printed on November 26, 2016
+Printed on December 05, 2016

 Copyright 2016 by Barry Stanly

@@ -44,7 +44,7 @@
 ---
 
 # 1 Introduction  
-In reading this document, Familiarity with the [https://sourceforge.net/p/simpletextformatter/wiki/STFXlate](STF Syntax Summary) is assumed.
+In reading this document, Familiarity with the [STF Syntax Summary](https://sourceforge.net/p/simpletextformatter/wiki/STFXlate) is assumed.

 This document shows how to create a document using the STF Python API. A simple test report was chosen for the example:

@@ -149,9 +149,8 @@
 Where it is assumed that LaTeX and STFxlate have been added to the path so it is not necessary to fully qualify file names. STFxlate.bat is a command file that provides services to STFxlate.py. To see what STFxlate.bat does, edit or type C:\Users\Public\Cmds\makeDoc.bat after installation.
 The resulting table looks like Table 1.

-      
+    ![Figure 5.1-1 Table 1](https://a.fsdn.com/con/app/proj/simpletextformatter/screenshots/Results.jpg 180x120)  
 Figure 5.1-1 Table 1

-Figure 5.1-1

 ----
 
@@ -159,13 +158,14 @@
 ## 5.2 GUI Formatting  
 To generate the documents the easy way, double click on TestReport.stf in the report directory and a menu will display (assuming Executor was installed per the installation instructions.) The default menu is shown in Figure 5.2-2. The defaults for Executor are stored in C:\Users\'you'\.nic\Executor and may be customized after the first execution. Since there is no contents for this document, use makeDoc; otherwise use makeDocWithIndex, etc.

-      
+    ![Figure 5.2-2 GUI Menu](https://a.fsdn.com/con/app/proj/simpletextformatter/screenshots/STF_Menu.jpg 280x239)  
 Figure 5.2-2 GUI Menu

-Figure 5.2-2
+
+
+#F O O T N O T E S

 


-(1) 
-0Dos.bat is a command file that opens a command window
+(1) 0Dos.bat is a command file that opens a command window

CreateProgramDoc modified by bstanly

bstanly — Sat, 26 Nov 2016 10:26:36 -0000

Create Document Under Program Control

by

Barry Stanly

Printed on November 26, 2016

Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is available at: https://www.gnu.org/copyleft/fdl.html.

For more information, see Nuances In Computing

Hosted at https://sourceforge.net/p/simpletextformatter

C O N T E N T S

1 Introduction

2 Create the Document

3 Define Document Structure

4 Generate Results

5 Formatting
5.1 Manual Formatting
5.2 GUI Formatting

F I G U R E S

Figure 5.1-1 Table 1
Figure 5.2-2 GUI Menu

1 Introduction

In reading this document, Familiarity with the https://sourceforge.net/p/simpletextformatter/wiki/STFXlate is assumed.

This document shows how to create a document using the STF Python API. A simple test report was chosen for the example:

The document is created
The document structure is defined
A table of results is generated
The resulting document is then processed by some of the command files that come with STF to produce an HTML representation of the document, a PDF representation, and a Wiki representation.It is assumed that Python has been installed, the STF Python API has been installed and STF has been installed. See the installation section of the STF Syntax Summary for details.

2 Create the Document

from stflib import StfDoc
self.doc = StfDoc("TestReport.stf")
self.doc.createDocument("TrialReport","Test Report for Auto System")
self.doc.setStructure(HTML_Local=True, FrontMatter=False)
self.doc.setContents(Index=False)
self.doc.beginDocument()

This creates a file TestReport.stf in the current folder and creates a basic header for it. The top of page title is Test Report for Auto System

3 Define Document Structure

desc = "Test Report for Auto System\t\t\tWritten by:\t\t\tThe Auto Team"
self.doc.describeDocument(desc)

Note "\t" is the Python way to specify a <TAB> character and represents a blank line in a description.

4 Generate Results

The results are saved in a table stored in its own file. This external file is then included into the test report document. The reason for doing it this way is to allow the table to be included in other documents, such as a more formal test report.

... Create table in external file
self.doc.changeOutputFile("Table.sti")
Caption = "Test Results"
Header = "Test name\tResult"
cspec = "|l|l|"
self.doc.createTable(Caption, Header, cspec, Label="Tab")

... Add test data
tab = "\t"
row = "Test 1" + tab + "Passed"
self.doc.tableRow(row)
row = "Test 2" + tab + "Passed"
self.doc.tableRow(row)
row = "Test 3" + tab + "Passed"
self.doc.tableRow(row)

... End table and change output file back to default
self.doc.endTable()
self.doc.changeOutputFile("")

Include the table back into main document
self.doc.putVerbatim(".Include Table.sti")
self.doc.endDocument()

5 Formatting

5.1 Manual Formatting

This simple program (37 lines long) generates two files: TestReport.stf and the include file: Table.sti. To generate a PDF report, you can use a command file that is included with STF: makeDoc.bat. To use makeDoc, double click 0Dos.bat⁽¹⁾ and enter the following in the report directory:

C:\Users\Public\Cmds\makeDoc.bat TestReport
and TestReport.pdf and TestReport.html will be produced. If directory C:\Users\Public\Cmds was added to the path, per the installation instructions, then it is only necessary to enter:
makeDoc TestReport. The Wiki formatted version is generated by entering:
makeWiki TestReport

Alternately the commands may be entered by hand. First open a Dos window by double clicking 0Dos.bat, then enter the following:

STFxlate --latex -i TestReport
pdflatex -interaction=nonstopmode TestReport.tex

Where it is assumed that LaTeX and STFxlate have been added to the path so it is not necessary to fully qualify file names. STFxlate.bat is a command file that provides services to STFxlate.py. To see what STFxlate.bat does, edit or type C:\Users\Public\Cmds\makeDoc.bat after installation.
The resulting table looks like Table 1.

Figure 5.1-1 Table 1

Figure 5.1-1

5.2 GUI Formatting

To generate the documents the easy way, double click on TestReport.stf in the report directory and a menu will display (assuming Executor was installed per the installation instructions.) The default menu is shown in Figure 5.2-2. The defaults for Executor are stored in C:\Users\'you'.nic\Executor and may be customized after the first execution. Since there is no contents for this document, use makeDoc; otherwise use makeDocWithIndex, etc.

Figure 5.2-2 GUI Menu

Figure 5.2-2

(1)
0Dos.bat is a command file that opens a command window