Recent changes to WorkingWithTheGUI

WorkingWithTheGUI modified by bstanly

bstanly — Mon, 23 Jul 2018 05:19:37 -0000

--- v8
+++ v9
@@ -6,7 +6,7 @@
  
 Barry Stanly

-Printed on June 25, 2017
+Printed on July 08, 2017

 Copyright 2016 by Barry Stanly

WorkingWithTheGUI modified by bstanly

bstanly — Mon, 26 Jun 2017 05:56:25 -0000

--- v7
+++ v8
@@ -6,7 +6,7 @@
  
 Barry Stanly

-Printed on May 13, 2017
+Printed on June 25, 2017

 Copyright 2016 by Barry Stanly

@@ -53,8 +53,8 @@
 
 
 # 2 Creating Menus  
-The first time Executor is invoked, it copies its default menus to C:\Users\'Owner'\.nic\Executor, where owner is your login name. The default menu is shown in Table Tab-3-I. The commands specified in the table must be on the current path⁽³⁾; or be a fully qualified path enclosed in quotation marks. Commands are invoked using Windows batch processor, cmd.exe, which comes with Windows, unless the command is preceded with "(PS)", in which case it is invoked using the power shell⁽⁴⁾, which also comes with windows. The operands, shown in table Tab-2-I, may be intermixed with constant text to define the command that is to operate on files of the specified extension. Feel free to customize the Executor menu as desired.
-    Table 2-I Executor Operands
+The first time Executor is invoked, it copies its default menus to C:\Users\'Owner'\.nic\Executor, where owner is your login name. The default menu is shown in Table Tab-3-I. The commands specified in the table must be on the current path⁽³⁾; or be a fully qualified path enclosed in quotation marks. Commands are invoked using Windows batch processor, cmd.exe, which comes with Windows, unless the command is preceded with "(PS)", in which case it is invoked using the power shell⁽⁴⁾, which also comes with windows. The operands, shown in table Tab-2-I, may be intermixed with constant text to define the command that is to operate on files of the specified extension. Feel free to customize the Executor menu as desired.
+     Table 2-I Executor Operands

 

@@ -66,7 +66,7 @@
 
-
+
@@ -76,7 +76,7 @@
 
-
+
@@ -96,7 +96,7 @@
 
 %p
 Full path to the file c:\dir\file.ext c:\dir\file.ext
 
 
 %d

 %r
 Root \dir\ \dir\
 
 
 %f

-Using the operands the full path to a file is: %p = %d%r%f.%e = c:\root\filename.ext
+Using the operands the full path to a file is: %p = %d%r%f.%e = c:\root\filename.ext

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

@@ -104,7 +104,7 @@
 
 # 3 Default Menu  
 The Executor's default menu references commands supported in NIC. Not all of these commands are installed by default by the STF installer. The "NIC" column indicates if the command is installed along with NIC, the "STF" column indicates if the command is installed along with STF. Commands not included in STF may be self installed.
-    Table 3-I Executor Default Menus
+     Table 3-I Executor Default Menus

 

@@ -332,17 +332,17 @@
 

-During the STF installation process⁽⁵⁾, Executor is copied to C:\Users\Public\Cmds. Executor is invoked from batch file ExecutorDrvr.bat also located in C:\Users\Public\Cmds.
+During the STF installation process⁽⁵⁾, Executor is copied to C:\Users\Public\Cmds. Executor is invoked from batch file ExecutorDrvr.bat also located in C:\Users\Public\Cmds.
 
 
 # 4 Adding Menu Entries  
 The format of the Executor initialization file is:
 Extension \*- command \*- operands
-The initialization file is named: C:\Users\"owner"\.nic\Executor\Executor.ini, where "owner" is your login name.
+The initialization file is named: C:\Users\"owner"\.nic\Executor\Executor.ini, where "owner" is your login name.
 
 
 # 5 Activating Menus  
-C:\Users\Public\Cmds\ExecutorDrvr.bat must be associated with each file extension specified in Executor.ini in order for a menu to be displayed when a file of that extension is doubleclicked. The process of associating ExecutorDrvr with file extensions is discussed under installation in the STF Syntax Summary.
+C:\Users\Public\Cmds\ExecutorDrvr.bat must be associated with each file extension specified in Executor.ini in order for a menu to be displayed when a file of that extension is doubleclicked. The process of associating ExecutorDrvr with file extensions is discussed under installation in the STF Syntax Summary.
 
 
 # 6 Usage

WorkingWithTheGUI modified by bstanly

bstanly — Sat, 13 May 2017 19:52:15 -0000

--- v6
+++ v7
@@ -6,7 +6,7 @@
  
 Barry Stanly

-Printed on May 08, 2017
+Printed on May 13, 2017

 Copyright 2016 by Barry Stanly

@@ -365,7 +365,7 @@

 (3) Discussed in the STF Syntax Summary

-(4) Windows has recently reduced support for cme.exe, so the Power Shell is recommended
+(4) Windows has recently reduced support for cmd.exe, so the Power Shell is recommended

 (5) See the STF Syntax Summary.

WorkingWithTheGUI modified by bstanly

bstanly — Sat, 13 May 2017 19:48:30 -0000

--- v5
+++ v6
@@ -6,7 +6,7 @@
  
 Barry Stanly

-Printed on April 20, 2017
+Printed on May 08, 2017

 Copyright 2016 by Barry Stanly

@@ -31,6 +31,8 @@
 [5 Activating Menus](#L5)  

 [6 Usage](#L6)  
+
+[7 UNIX/Linux Implementation](#L7)  
 # T A B L E S

 [Table 2-I Executor Operands](#Tab-2-I)  
@@ -51,7 +53,7 @@
 
 
 # 2 Creating Menus  
-The first time Executor is invoked, it copies its default menus to C:\Users\'Owner'\.nic\Executor, where owner is your login name. The default menu is shown in Table Tab-3-I. The commands specified in the table must be on the current path⁽³⁾. Commands are invoked using Windows batch processor, cmd.exe, which comes with Windows, unless the command is preceded with "(PS)", in which case it is invoked using the power shell, which also comes with windows. The operands, shown in table Tab-2-I, may be intermixed with constant text to define the command that is to operate on files of the specified extension. Feel free to customize the Executor menu as desired.
+The first time Executor is invoked, it copies its default menus to C:\Users\'Owner'\.nic\Executor, where owner is your login name. The default menu is shown in Table Tab-3-I. The commands specified in the table must be on the current path⁽³⁾; or be a fully qualified path enclosed in quotation marks. Commands are invoked using Windows batch processor, cmd.exe, which comes with Windows, unless the command is preceded with "(PS)", in which case it is invoked using the power shell⁽⁴⁾, which also comes with windows. The operands, shown in table Tab-2-I, may be intermixed with constant text to define the command that is to operate on files of the specified extension. Feel free to customize the Executor menu as desired.
     Table 2-I Executor Operands

 
@@ -141,7 +143,7 @@
 
-
+
@@ -149,20 +151,12 @@
 
-
+
-
-
-
-
-
-
-
-
@@ -190,7 +184,7 @@
 
-
+
@@ -198,7 +192,7 @@
 
-
+
@@ -206,7 +200,7 @@
 
-
+
@@ -214,7 +208,7 @@
 
-
+
@@ -222,7 +216,7 @@
 
-
+
@@ -239,7 +233,7 @@
 
-
+
@@ -247,7 +241,7 @@
 
-
+
@@ -255,7 +249,7 @@
 
-
+
@@ -263,7 +257,7 @@
 
-
+
@@ -271,7 +265,7 @@
 
-
+
@@ -279,7 +273,7 @@
 
-
+
@@ -287,7 +281,7 @@
 
-
+
@@ -295,7 +289,7 @@
 
-
+
@@ -320,17 +314,9 @@
 
-
+
-
-
-
-
-
-
-
-
@@ -343,18 +329,10 @@
 
-
-
-
-
-
-
-
-
 
 txt filemgr (PS)filemgr
 "%p"
 File Manager
 Y
 
 txt NewSTF (PS)NewSTF
 "%f"
 Creates a sample STF input file
 Y
 Y
 
txt ECrypt "%f" "%e" Encrypts the file Y N
 STI
 
 sti
 
 sti filemgr (PS)filemgr
 "%p"
 File Manager
 Y
 
 sti ViewSubDoc (PS)ViewSubDoc
 "%p"
 Formats an include file for viewing
 Y
 
 sti SuperCleanSTF (PS)SuperCleanSTF
  
 Removes all the junk files
 Y
 
 sti SuperCleanLatex (PS)SuperCleanLatex
  
 Removes all the junk files, except for .tex
 Y
 
 sti NewSTF (PS)NewSTF
 "%f"
 Creates a model STF file
 Y
 
 stf makeDoc (PS)makeDoc
 "%f"
 Formats an STF file without a contents
 Y
 
 stf makeDocWithIndex (PS)makeDocWithIndex
 "%f"
 Formats file with a contents and index
 Y
 
 stf makeRTFDoc (PS)makeRTFDoc
 "%f"
 Formats an STF file to RTF format
 Y
 
 stf makeWiki (PS)makeWiki
 "%f"
 Formats an STF file to Wiki format
 Y
 
 stf ViewSubDoc (PS)ViewSubDoc
 "%p"
 Formats an include file for viewing
 Y
 
 stf SuperCleanSTF (PS)SuperCleanSTF
  
 Removes all the junk files
 Y
 
 stf SuperCleanLatex (PS)SuperCleanLatex
  
 Removes all the junk files, except for .tex
 Y
 
 stf NewSTF (PS)NewSTF
 "%f"
 Creates a sample STF input file
 Y
 
 pdf PdfDrvr (PS)PdfDrvr
 "%p"
 Manipulates PDF files Y N
pdf ECrypt "%f" "%e" Encrypts file
 Y
 N
 
N
 N
 
dat ECrypt "%f" "%e" Encrypts file Y N
 

-During the STF installation process⁽⁴⁾, Executor is copied to C:\Users\Public\Cmds. Executor is invoked from batch file ExecutorDrvr.bat also located in C:\Users\Public\Cmds.
+During the STF installation process⁽⁵⁾, Executor is copied to C:\Users\Public\Cmds. Executor is invoked from batch file ExecutorDrvr.bat also located in C:\Users\Public\Cmds.
 
 
 # 4 Adding Menu Entries  
@@ -369,6 +347,13 @@
 
 # 6 Usage  
 To execute an Executor command on a file, doubleclick on a file with a defined extension. The menu corresponding to that extension will be displayed. (See Figure 2-1 for the STF extension menu.) Then doubleclick the menu entry and the command will operate as specified in Executor.ini.
+
+
+# 7 UNIX/Linux Implementation  
+It requires knowledge of UNIX/Linux⁽⁶⁾ internals to associate an extension with an arbitrary program. Fortuntely there is an easier way to implement a GUI. This involves installing the GNOME desktop and using the GNOME filemanager, Nautilus. Nautilus supports add-on shell scripts. Nautilus scripts are placed in directory $HOME/.local/share/nautilus/scripts and are invoked by right-clicking on a file name in Nautilus.
+
+STF provides a collection of Nautilus shell scripts to implement the GUI menu shown in figure 2-1. It also provides a single script, named 1Menu, to invoke Executor to present the same menus as Windows. The difference between right-clicking and selecting 1Menu and selecting the explicit STF script is Executor only presents the commands tied to an explicit extension, where as Nautilus shows all scripts in the command directory. Other than that, the two approaches provide the same functionality, because they use the same scripts. For more information on UNIX installation see the installation section in the STF Syntax Summary.
+

 #F O O T N O T E S
@@ -380,7 +365,11 @@

 (3) Discussed in the STF Syntax Summary

-(4) See the STF Syntax Summary.
-
-
-
+(4) Windows has recently reduced support for cme.exe, so the Power Shell is recommended
+
+(5) See the STF Syntax Summary.
+
+(6) Hereinafter referred to as UNIX.
+
+
+

WorkingWithTheGUI modified by bstanly

bstanly — Fri, 21 Apr 2017 01:20:45 -0000

--- v4
+++ v5
@@ -6,7 +6,7 @@
  
 Barry Stanly

-Printed on April 06, 2017
+Printed on April 20, 2017

 Copyright 2016 by Barry Stanly

@@ -42,7 +42,8 @@
 ---
 
 # 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/WorkingWithTheGUI.pdf))
+

 One of the tools imported from Nuances In Computing (NIC) is Executor.py, or just Executor. Executor makes it easy to attach a GUI⁽¹⁾ menu to any file extension. Once the GUI has been attached to an extension⁽²⁾, doubleclicking the extension causes Executor to display a menu of commands to be invoked. This approach can make it easier to implement a process, such as document preparation. See Figure 2-1 for the file associations menu for extension STF.

WorkingWithTheGUI modified by bstanly

bstanly — Sun, 09 Apr 2017 09:28:33 -0000

--- v3
+++ v4
@@ -6,7 +6,7 @@
  
 Barry Stanly

-Printed on December 05, 2016
+Printed on April 06, 2017

 Copyright 2016 by Barry Stanly

@@ -42,7 +42,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.

 One of the tools imported from Nuances In Computing (NIC) is Executor.py, or just Executor. Executor makes it easy to attach a GUI⁽¹⁾ menu to any file extension. Once the GUI has been attached to an extension⁽²⁾, doubleclicking the extension causes Executor to display a menu of commands to be invoked. This approach can make it easier to implement a process, such as document preparation. See Figure 2-1 for the file associations menu for extension STF.

WorkingWithTheGUI modified by bstanly

bstanly — Mon, 05 Dec 2016 21:05:13 -0000

--- v2
+++ v3
@@ -1,10 +1,12 @@
-Working with Images
-
-Written by
-
+
+Working with the NIC GUI
+
+by
+ 
+ 
 Barry Stanly

-Printed on November 26, 2016
+Printed on December 05, 2016

 Copyright 2016 by Barry Stanly

@@ -20,352 +22,364 @@

 [1 Introduction](#L1)  

-[2 Inserting Images in Documents](#L2)  
-
-[3 Manually Adjusting Image Sizes](#L3)  
-
-[4 Adding Images to Tables](#L4)  
-
-[5 Setting the Image Size in Tables](#L5)  
-
-[6 Using Auto Image Size](#L6)  
-
-[7 Linking to Images](#L7)  
+[2 Creating Menus](#L2)  
+
+[3 Default Menu](#L3)  
+
+[4 Adding Menu Entries](#L4)  
+
+[5 Activating Menus](#L5)  
+
+[6 Usage](#L6)  
 # T A B L E S

-[Table 4-I Table title](#Tab-4-I)  
-[Table 6-I AutoImageSize Example](#Tab-6-I)  
+[Table 2-I Executor Operands](#Tab-2-I)  
+[Table 3-I Executor Default Menus](#Tab-3-I)  
 # F I G U R E S

-[Figure 2-1 Documentation Process](#Fig-0001)  
-[Figure 3-2 1/3 Page size](#Fig-0002)  
-[Figure 3-3 1/2 Page size](#Fig-0003)  
-[Figure 4-a Neat pic, eh](#Figure 4-a Neat pic, eh)  
+[Figure 2-1 STF File Associations Menu](#Fig-0001)  

 ---
 
 # 1 Introduction  
-This document expands on the information available in the [STF Syntax Summary](https://sourceforge.net/p/simpletextformatter/wiki/STFXlate). Familiarity with the syntax summary is assumed.
-
-Automating the integration of images into a document can be tricky. This is because multiple images can be of different sizes so that just including the images can require hand tuning to make them look uniform. STF supports individually setting the display size of each image and also setting the display size for a set of images and letting STFXlate automatically adjust the magnification to make the image fit in that size.
-
-The image size is specified as the dimensions of a box (Width x Height). LaTeX and RTF are set to automatically scale images to fill the box without distortion, HTML and Wiki are set to stretch the image to fill the box, which can lead to distortion.
-
-STF supports calculating, for HTML and Wiki, what scale to use to fill the box without distortion. The way this works is a file is read containing each image's size in pixels and, using that information, STFXlate calculates what is the best way to scale the image to best fill the box and keep the image aspect ratio.
-
-This leaves the problem of how to get the file of image pixel sizes. It turns out that the ImageMagick program has this capability. ImageMagick is native to Linux/UNIX and downloadable for Windows⁽¹⁾. The AutoImageSize command informs SFTXlate to read the file of image sizes and perform the necessary scaling adjustment when an image file is included. This only applies to HTML and Wiki image files, LaTeX and RTF have no problem automatically scaling images.
+In reading this document, Familiarity with the [STF Syntax Summary](https://sourceforge.net/p/simpletextformatter/wiki/STFXlate) is assumed.
+
+One of the tools imported from Nuances In Computing (NIC) is Executor.py, or just Executor. Executor makes it easy to attach a GUI⁽¹⁾ menu to any file extension. Once the GUI has been attached to an extension⁽²⁾, doubleclicking the extension causes Executor to display a menu of commands to be invoked. This approach can make it easier to implement a process, such as document preparation. See Figure 2-1 for the file associations menu for extension STF.
+
+This discussion is Windows centric, however the commands are also supported by UNIX/Linux.
 
 
-# 2 Inserting Images in Documents  
-Images are inserted into documents via the .IE Image-path, [label], Caption -- Alias: .Figure command, where
-  
-
-1. Image-path is the path to the image file. For example MyPic.jpg is a typical file name and extension.  
-
-2. Label is an optional label that can be used to refer to the illustration, as in See Figure \ref{label}.  
-
-3. Caption is an optional caption. If specified the caption is included in the list of figures in the contents. If the caption is omitted, the image is treated as an anonymous image and remains unlabeled.
-----
-An example is:
-
-
-
-
-
-
-
+# 2 Creating Menus  
+The first time Executor is invoked, it copies its default menus to C:\Users\'Owner'\.nic\Executor, where owner is your login name. The default menu is shown in Table Tab-3-I. The commands specified in the table must be on the current path⁽³⁾. Commands are invoked using Windows batch processor, cmd.exe, which comes with Windows, unless the command is preceded with "(PS)", in which case it is invoked using the power shell, which also comes with windows. The operands, shown in table Tab-2-I, may be intermixed with constant text to define the command that is to operate on files of the specified extension. Feel free to customize the Executor menu as desired.
+   Table 2-I Executor Operands
+
+.sf H,400x500

-.Figure Process.jpg,Example1,Documentation Process
 
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Operand Meaning Example
%p Full path to the file c:\dir\file.ext
%d Drive c:
%r Root \dir\
%f File name file
%e File extension ext
%[prompt] Prompt for keyboard input input replaces operand
 
-
-This looks like Figure 2-1.
-      
-Figure 2-1 Documentation Process

-Figure 2-1
+
+
+Using the operands the full path to a file is: %p = %d%r%f.%e = c:\root\filename.ext
+
+    ![Figure 2-1 STF File Associations Menu](https://a.fsdn.com/con/app/proj/simpletextformatter/screenshots/STF_Menu.jpg 280x239)  
+Figure 2-1 STF File Associations Menu

 
 
-# 3 Manually Adjusting Image Sizes  
-The size of images is set geometrically by specifying the dimensions of a box in which to place the image. When targeting to LaTeX or RTF, the image is automatically scaled so as to fit within the box without distortion. When targeting to HTML or Wiki, the image is stretched to fill the box, unless AutoImageSize is in use. When AutoImageSize is active, HTML/Wiki images are also scaled to fit within the box without distortion.
-
-The .sf (Alias .SetFigureSize) command is used to explicitly set the box size. The Syntax is:
-.sf Code,specification, where the codes and specifications are as follows:
-  
-
-1. Code D -- Latex Document, default specification = 
-width=\linewidth/2,height=\textheight/2,keepaspectratio=true,scale=5
-  
-
-2. Code H -- HTML document, specification=WxH. Where "W" is the width in pixels and "H" is the height also in pixels, default: 400x500This scaling stays in effect until changed.
-
-The LaTeX configuration string is interpreted as follows:
-  
-
-* width=\linewidth/2 -- This sets the maximum image width to half of the current document line width.  
-
-* height=\textheight/2 -- This sets the maximum image height to half of the current document vertical height.  
-
-* keepaspectratio=true -- This says to keep the image aspect ratio intact, i.e. do not stretch the image so as to distort it.  
-
-* scale=5 -- This says to scale the image times 5. However, the scaling stops when the width or height hits a boundary because to scale further would violate the command to keep the aspect ratio intact. The result is to maximally fill the space without distortion.
-The macro processor can be used to advantage if it is necessary to switch between several preset sizes. an example is:
-
-
-
-
-
- 
-
-
+# 3 Default Menu  
+The Executor's default menu references commands supported in NIC. Not all of these commands are installed by default by the STF installer. The "NIC" column indicates if the command is installed along with NIC, the "STF" column indicates if the command is installed along with STF. Commands not included in STF may be self installed.
+   Table 3-I Executor Default Menus
+
+.se Third,[\*^]=^^.sf D,width=\linewidth/2,height=\textheight/3,keepaspectratio=true,\

-scale=5^.sf H,300x300

- 

-.se Half,[\*^]=^^.sf D,width=\linewidth/2,height=\textheight/2,keepaspectratio=true,\

-scale=5^.sf H,600x600

-.SM Third

-.SM Half
 
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Ext Command Operand Comments NIC STF
TXT
txt (PS)Wordpad "%p" Editor N N
txt (PS)Notepad "%p Editor N N
txt (PS)xemacs "%p" Editor N N
txt filemgr "%p" File Manager Y N
txt NewSTF "%f" Creates a sample STF input file Y Y
txt ECrypt "%f" "%e" Encrypts the file Y N
STI
sti (PS)Wordpad "%p" Editor N N
sti (PS)Notepad "%p" Editor N N
sti (PS)xemacs "%p" Editor N N
sti filemgr "%p" File Manager Y N
sti ViewSubDoc "%p" Formats an include file for viewing Y Y
sti SuperCleanSTF   Removes all the junk files Y Y
sti SuperCleanLatex   Removes all the junk files, except for .tex Y Y
sti NewSTF "%f" Creates a model STF file Y Y
STF
stf (PS)Wordpad "%f.%e" Editor N N
stf makeDoc "%f" Formats an STF file without a contents Y Y
stf makeDocWithIndex "%f" Formats file with a contents and index Y Y
stf makeRTFDoc "%f" Formats an STF file to RTF format Y Y
stf makeWiki "%f" Formats an STF file to Wiki format Y Y
stf ViewSubDoc "%p" Formats an include file for viewing Y Y
stf SuperCleanSTF   Removes all the junk files Y Y
stf SuperCleanLatex   Removes all the junk files, except for .tex Y Y
stf NewSTF "%f" Creates a sample STF input file Y Y
stf (PS)xemacs "%p" Editor N N
PDF
pdf (PS)AcroRd32 "%p" Views file using Acrord32 N N
pdf PdfDrvr "%p" Manipulates PDF files Y N
pdf ECrypt "%f" "%e" Encrypts file Y N
DAT
dat (PS)xemacs "%p" Editor N N
dat ECrypt "%f" "%e" Encrypts file Y N
 
-
-
-This defines two macros "Third" and "Half" which set the image size to a third and a half of a page respectively. An example is shown in Figure 3-2 and Figure 3-3 for one third and one half the screen size. (To use the macros enter them on a line, as in: \Third{}. This sets the scaling to 1/3 page.)
-
-Macros are described in the STF Syntax Summary. An analysis of the Half macro is as follows:
-  
-
-1. .se Half, -- define an escape variable named "Half".  
-
-2. [\*^] -- make it a keyword macro.  
-
-3. = -- start macro definition.  
-
-4. ^ -- define the caret ('^') as the line separator.  
-
-5. ^ -- initial line defined by the macro is empty, so it is ignored.  
-
-6. .sf D,width=\linewidth/2,height=\textheight/2,keepaspectratio=true, -- define LaTeX figure scale  
-
-7. \ -- concatenate next line  
-
-8. scale=5 -- complete figure scale  
-
-9. ^ -- next line  
-
-10. .sf H,600x600 -- define HTML figure scale
-      
-Figure 3-2 1/3 Page size

-Figure 3-2
-
-      
-Figure 3-3 1/2 Page size

-Figure 3-3
+
+
+During the STF installation process⁽⁴⁾, Executor is copied to C:\Users\Public\Cmds. Executor is invoked from batch file ExecutorDrvr.bat also located in C:\Users\Public\Cmds.
 
 
-# 4 Adding Images to Tables  
-Sometimes it is desirable to display an image or set of images in a table. This is done by using the \fig in-line command. The syntax is as follows:
-\fig{Image-path[,label],Caption}Title, where
-  
-
-1. Image-path is the path to the image, as before.  
-
-2. Label is an optional escape variable to hold the assigned figure number. The image must have a caption (or it is not a figure), and the label may be referenced after it is defined by \esc{label}.  
-
-3. Caption is the caption to be used if the image is a Figure. The caption appears in the list of figures in the contents.  
-
-4. Title is the below image title and is used if the caption is omitted. Do not use both the caption and the title. If both the caption and the title are omitted, the image is untitled.Example:
-
-
-
-
-
-.include mysymbols.sti

-The figure number was \esc{Example2}

-.sf H,300x400

-.sf T,200x300

-.Caption Table title

-.Table |c|c|

-Column 1 title<tab>Column 2 title

-\fig{Pic1.jpg,Example2,Neat pic, eh}<tab>\fig{Pic2.jpg}This one is not a figure

-\endtable{}

- 

-The figure number was \esc{Example2}

- 

-.saveVariables mysymbols.sti
-
-The example is shown below:
-The figure number was 4-a
-
-----
-  Table 4-I Table title
-
-
-
-
-
-
-
-
- 
-
-
-Image 1 Image 2
 
- 
-
Fig. 4-a: Neat pic, eh 
-
-
This one is not a figure
-
-The figure number was 4-a
-
-Notes:
-  
-
-* Notice in the HTML/Wiki representation that Image 2 is stretched out of shape. The actual image is roughly square, not rectangular. This is fixed in the next section on using Auto Image Size.  
-
-* Notice the use of .saveVariables placed at the end of the document to save the document generated symbols in a file. This saves the figure number in file mysymbols.sti, which is then included at the beginning of the document by .include mysymbols.sti. This allows the figure number to be referenced before it is created. This makes the figure number available the second and subsequent times the document is generated.  
-
-* Notice that Image 1 is a figure because the title is inside of the \fig command; while Image 2 is not a figure because the title is after the \fig command.
+# 4 Adding Menu Entries  
+The format of the Executor initialization file is:
+Extension \*- command \*- operands
+The initialization file is named: C:\Users\"owner"\.nic\Executor\Executor.ini, where "owner" is your login name.
+
 
-# 5 Setting the Image Size in Tables  
-The .sf command is also used to scale LaTeX document images defined inside of tables. The syntax is as follows:
-
-
-
-
-
-Code T -- The specification is for the dimensions of a box: WxH, where "W" is the box width in pixels and "H" is the box height in pixels. All cells containing figures in the table will be scaled to these dimensions.

-Code C -- Rows,Columns[,Pad]. STF will scale the images so as to fit the largest possible images in the specified table.
-
-Examples:
-
-
-
-
-
-.sf T, 400x600 -- define table cell size as 400 by 600 pixels (72 pixels per inch)

-.sf C, 3,3,20 -- define 3 by 3 table array of images. Reserve 20 pixels for additional titles
+# 5 Activating Menus  
+C:\Users\Public\Cmds\ExecutorDrvr.bat must be associated with each file extension specified in Executor.ini in order for a menu to be displayed when a file of that extension is doubleclicked. The process of associating ExecutorDrvr with file extensions is discussed under installation in the STF Syntax Summary.
 
 
-# 6 Using Auto Image Size  
-As mentioned previously AutoImageSize is used to read the file of image descriptionsprovide automatic scaling for HTML/Wiki images. AutoImageSize may be specified multiple times. The files are merged and the latest values override older ones. The syntax is:
-.AI file-path, Size -- alias: .AutoImageSize, where
-  
-
-1. File-path is the location of file containing image size information.  
-
-2. Size is the desired image size in pixels. Width x Height. If the image size has not been specified, a default of 512x 384 is used.
-The image size file should contain one line for each image being used in a .Figure command.
-The file format is:
-Image-name image-tag WxH ...
-One image name per line. The image tag is usually the same as the image file extension and is ignored.
-"WxH" is the image width and height of the figure in pixels. When a .Figure command is evaluated, the
-auto-image-size file will be searched for the image name. If found, the image will be adjusted to fit within
-the default window size.
-Examples:
-
-
-
-
-
-.AutoImageSize MyImageSize.txt, 640x480

-MyImageSize.txt will be loaded and the Auto Image Size window size set to 640x480.

- 

-.AI , 640x480

-The Auto Image Size window size will be set to 640x480.
-
-Notes:
-  
-
-1. The identify command⁽²⁾ may be used to automatically generate autoimagesize.txt.  
-
-2. Identify is native to UNIX and downloadable for Windows.  
-
-3. ImageMagick may be downloaded from: [http://www.ImageMagick.org/script/binary-releases.php.](http://www.ImageMagick.org/script/binary-releases.php.)There are multiple distributions on this site, so scroll down to the Windows Binary
-Release.
-  
-
-4. ImageMagick recommends installing GhostScript first, this may be found at:[http://sourceforge.net/projects/ghostscript/?source=dlp.](http://sourceforge.net/projects/ghostscript/?source=dlp.)
-For example, identify \*.jp\*>autoImageSize.txt will generate the file for JPEG images. You can concatenate other extensions as in identify \*.gif>>autoImageSize.txt. This will add the image data for gif files to autoImageSize.txt.
-
-Example: Setup a 3x3 table array of images -- see table Tab-6-I:
-
-
-
-
-
-.AutoImageSize AutoImageSize.txt,300x400

-.sf C,3,3,20

-.Caption AutoImageSize Example

-.table |c|c|c|,Auto

-.row Image<tab>Image<tab>Image

-\fig{Image1.jpg}1,1<tab>\fig{Image2.jpg}1,2<tab>\fig{Image1.jpg}1,3

-\fig{Image2.jpg}2,1<tab>\fig{Image1.jpg}2,2<tab>\fig{Image2.jpg}2,3

-\fig{Image1.jpg}3,1<tab>\fig{Image2.jpg}3,2<tab>\fig{Image1.jpg}3,3

-\endtable{}
-    Table 6-I AutoImageSize Example
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Image Image Image

-
-
1,1 
-
-
1,2 
-
-
1,3

-
-
2,1 
-
-
2,2 
-
-
2,3

-
-
3,1 
-
-
3,2 
-
-
3,3
-
-
-
-# 7 Linking to Images  
-STF supports internally linking to tables and figures. This capability is the same for LaTeX, HTML, RTF, and Wiki formats. Internal links are supported via the \ref and \dref inline commands. \ref is used for linking to tables, figures, paragraphs, and lists; while \dref and \dpage are used to link to figures embedded in tables via the \fig command and also to link to arbitrary spots in a document that are specified via the \dlink command.
-
-The reason for this dichotomy is the standard way of specifying figures in LaTeX allows LaTeX to automatically move the figures around in the document to minimize extra white space. This paradigm is in conflict with the table paradigm which specifies that whatever is placed inside of a table cell is stuck there. So to support figures inside of tables in LaTeX, it was necessary to use different LaTeX commands than the usual ones. HTML has no concept of pages, so it is not a problem putting figures inside of tables when targeting to HTML or Wiki formats, however the commands are honored under HTML and Wiki processing to make the command structure symmetric between the LaTeX, RTF, HTML and Wiki formats.
-
-Examples, of how to reference the previously defined figures:
-
-
-
-
-
-Normal figure: See Figure \ref{Example1, page}.\nl{}

-Embedded figure:  See Figure \dref{Example2, \esc{Example2\}}\dpage{Example2, ~on page~}.
-
-Normal figure: See Figure 2-1.
-Embedded figure:  See Figure  4-a.
+# 6 Usage  
+To execute an Executor command on a file, doubleclick on a file with a defined extension. The menu corresponding to that extension will be displayed. (See Figure 2-1 for the STF extension menu.) Then doubleclick the menu entry and the command will operate as specified in Executor.ini.
+
+
+#F O O T N O T E S

 


-(1) 
-See the STF Syntax Summary for details.
-
-(2) 
-Part of ImageMagick
-
-
-
+(1) Graphical User Interface
+
+(2) Built-in extensions, such as exe and bat are excluded.
+
+(3) Discussed in the STF Syntax Summary
+
+(4) See the STF Syntax Summary.
+
+
+

Ext	Command	Operand	Comments	NIC	STF
TXT
txt	(PS)Wordpad	"%p"	Editor	N	N
txt	(PS)Notepad	"%p	Editor	N	N
txt	(PS)xemacs	"%p"	Editor	N	N
txt	filemgr	"%p"	File Manager	Y	N
txt	NewSTF	"%f"	Creates a sample STF input file	Y	Y
txt	ECrypt	"%f" "%e"	Encrypts the file	Y	N
STI
sti	(PS)Wordpad	"%p"	Editor	N	N
sti	(PS)Notepad	"%p"	Editor	N	N
sti	(PS)xemacs	"%p"	Editor	N	N
sti	filemgr	"%p"	File Manager	Y	N
sti	ViewSubDoc	"%p"	Formats an include file for viewing	Y	Y
sti	SuperCleanSTF		Removes all the junk files	Y	Y
sti	SuperCleanLatex		Removes all the junk files, except for .tex	Y	Y
sti	NewSTF	"%f"	Creates a model STF file	Y	Y
STF
stf	(PS)Wordpad	"%f.%e"	Editor	N	N
stf	makeDoc	"%f"	Formats an STF file without a contents	Y	Y
stf	makeDocWithIndex	"%f"	Formats file with a contents and index	Y	Y
stf	makeRTFDoc	"%f"	Formats an STF file to RTF format	Y	Y
stf	makeWiki	"%f"	Formats an STF file to Wiki format	Y	Y
stf	ViewSubDoc	"%p"	Formats an include file for viewing	Y	Y
stf	SuperCleanSTF		Removes all the junk files	Y	Y
stf	SuperCleanLatex		Removes all the junk files, except for .tex	Y	Y
stf	NewSTF	"%f"	Creates a sample STF input file	Y	Y
stf	(PS)xemacs	"%p"	Editor	N	N
PDF
pdf	(PS)AcroRd32	"%p"	Views file using Acrord32	N	N
pdf	PdfDrvr	"%p"	Manipulates PDF files	Y	N
pdf	ECrypt	"%f" "%e"	Encrypts file	Y	N
DAT
dat	(PS)xemacs	"%p"	Editor	N	N
dat	ECrypt	"%f" "%e"	Encrypts file	Y	N

Image 1	Image 2
- - Fig. 4-a: Neat pic, eh	- - This one is not a figure

Image	Image	Image
- - 1,1	- - 1,2	- - 1,3
- - 2,1	- - 2,2	- - 2,3
- - 3,1	- - 3,2	- - 3,3

WorkingWithTheGUI modified by bstanly

bstanly — Sun, 27 Nov 2016 04:04:05 -0000

--- v1
+++ v2
@@ -1,9 +1,7 @@
-
-Working with the NIC GUI
-
-by
- 
- 
+Working with Images
+
+Written by
+
 Barry Stanly

 Printed on November 26, 2016
@@ -22,366 +20,352 @@

 [1 Introduction](#L1)  

-[2 Creating Menus](#L2)  
-
-[3 Default Menu](#L3)  
-
-[4 Adding Menu Entries](#L4)  
-
-[5 Activating Menus](#L5)  
-
-[6 Usage](#L6)  
+[2 Inserting Images in Documents](#L2)  
+
+[3 Manually Adjusting Image Sizes](#L3)  
+
+[4 Adding Images to Tables](#L4)  
+
+[5 Setting the Image Size in Tables](#L5)  
+
+[6 Using Auto Image Size](#L6)  
+
+[7 Linking to Images](#L7)  
 # T A B L E S

-[Table 2-I Executor Operands](#Tab-2-I)  
-[Table 3-I Executor Default Menus](#Tab-3-I)  
+[Table 4-I Table title](#Tab-4-I)  
+[Table 6-I AutoImageSize Example](#Tab-6-I)  
 # F I G U R E S

-[Figure 2-1 STF File Associations Menu](#Fig-0001)  
+[Figure 2-1 Documentation Process](#Fig-0001)  
+[Figure 3-2 1/3 Page size](#Fig-0002)  
+[Figure 3-3 1/2 Page size](#Fig-0003)  
+[Figure 4-a Neat pic, eh](#Figure 4-a Neat pic, eh)  

 ---
 
 # 1 Introduction  
-In reading this document, Familiarity with the [https://sourceforge.net/p/simpletextformatter/wiki/STFXlate](STF Syntax Summary) is assumed.
-
-One of the tools imported from Nuances In Computing (NIC) is Executor.py, or just Executor. Executor makes it easy to attach a GUI⁽¹⁾ menu to any file extension. Once the GUI has been attached to an extension⁽²⁾, doubleclicking the extension causes Executor to display a menu of commands to be invoked. This approach can make it easier to implement a process, such as document preparation. See Figure 2-1 for the file associations menu for extension STF.
-
-This discussion is Windows centric, however the commands are also supported by UNIX/Linux.
+This document expands on the information available in the [STF Syntax Summary](https://sourceforge.net/p/simpletextformatter/wiki/STFXlate). Familiarity with the syntax summary is assumed.
+
+Automating the integration of images into a document can be tricky. This is because multiple images can be of different sizes so that just including the images can require hand tuning to make them look uniform. STF supports individually setting the display size of each image and also setting the display size for a set of images and letting STFXlate automatically adjust the magnification to make the image fit in that size.
+
+The image size is specified as the dimensions of a box (Width x Height). LaTeX and RTF are set to automatically scale images to fill the box without distortion, HTML and Wiki are set to stretch the image to fill the box, which can lead to distortion.
+
+STF supports calculating, for HTML and Wiki, what scale to use to fill the box without distortion. The way this works is a file is read containing each image's size in pixels and, using that information, STFXlate calculates what is the best way to scale the image to best fill the box and keep the image aspect ratio.
+
+This leaves the problem of how to get the file of image pixel sizes. It turns out that the ImageMagick program has this capability. ImageMagick is native to Linux/UNIX and downloadable for Windows⁽¹⁾. The AutoImageSize command informs SFTXlate to read the file of image sizes and perform the necessary scaling adjustment when an image file is included. This only applies to HTML and Wiki image files, LaTeX and RTF have no problem automatically scaling images.
 
 
-# 2 Creating Menus  
-The first time Executor is invoked, it copies its default menus to C:\Users\'Owner'\.nic\Executor, where owner is your login name. The default menu is shown in Table Tab-3-I. The commands specified in the table must be on the current path⁽³⁾. Commands are invoked using Windows batch processor, cmd.exe, which comes with Windows, unless the command is preceded with "(PS)", in which case it is invoked using the power shell, which also comes with windows. The operands, shown in table Tab-2-I, may be intermixed with constant text to define the command that is to operate on files of the specified extension. Feel free to customize the Executor menu as desired.
-    Table 2-I Executor Operands
+# 2 Inserting Images in Documents  
+Images are inserted into documents via the .IE Image-path, [label], Caption -- Alias: .Figure command, where
+  
+
+1. Image-path is the path to the image file. For example MyPic.jpg is a typical file name and extension.  
+
+2. Label is an optional label that can be used to refer to the illustration, as in See Figure \ref{label}.  
+
+3. Caption is an optional caption. If specified the caption is included in the list of figures in the contents. If the caption is omitted, the image is treated as an anonymous image and remains unlabeled.
+----
+An example is:
+
+
+
+
+
+
+
+.sf H,400x500

+.Figure Process.jpg,Example1,Documentation Process
+
+This looks like Figure 2-1.
+      
+Figure 2-1 Documentation Process

+Figure 2-1
+
+
+# 3 Manually Adjusting Image Sizes  
+The size of images is set geometrically by specifying the dimensions of a box in which to place the image. When targeting to LaTeX or RTF, the image is automatically scaled so as to fit within the box without distortion. When targeting to HTML or Wiki, the image is stretched to fill the box, unless AutoImageSize is in use. When AutoImageSize is active, HTML/Wiki images are also scaled to fit within the box without distortion.
+
+The .sf (Alias .SetFigureSize) command is used to explicitly set the box size. The Syntax is:
+.sf Code,specification, where the codes and specifications are as follows:
+  
+
+1. Code D -- Latex Document, default specification = 
+width=\linewidth/2,height=\textheight/2,keepaspectratio=true,scale=5
+  
+
+2. Code H -- HTML document, specification=WxH. Where "W" is the width in pixels and "H" is the height also in pixels, default: 400x500This scaling stays in effect until changed.
+
+The LaTeX configuration string is interpreted as follows:
+  
+
+* width=\linewidth/2 -- This sets the maximum image width to half of the current document line width.  
+
+* height=\textheight/2 -- This sets the maximum image height to half of the current document vertical height.  
+
+* keepaspectratio=true -- This says to keep the image aspect ratio intact, i.e. do not stretch the image so as to distort it.  
+
+* scale=5 -- This says to scale the image times 5. However, the scaling stops when the width or height hits a boundary because to scale further would violate the command to keep the aspect ratio intact. The result is to maximally fill the space without distortion.
+The macro processor can be used to advantage if it is necessary to switch between several preset sizes. an example is:
+
+
+
+
+
+ 
+
+
+.se Third,[\*^]=^^.sf D,width=\linewidth/2,height=\textheight/3,keepaspectratio=true,\

+scale=5^.sf H,300x300

+ 

+.se Half,[\*^]=^^.sf D,width=\linewidth/2,height=\textheight/2,keepaspectratio=true,\

+scale=5^.sf H,600x600

+.SM Third

+.SM Half
+
+
+This defines two macros "Third" and "Half" which set the image size to a third and a half of a page respectively. An example is shown in Figure 3-2 and Figure 3-3 for one third and one half the screen size. (To use the macros enter them on a line, as in: \Third{}. This sets the scaling to 1/3 page.)
+
+Macros are described in the STF Syntax Summary. An analysis of the Half macro is as follows:
+  
+
+1. .se Half, -- define an escape variable named "Half".  
+
+2. [\*^] -- make it a keyword macro.  
+
+3. = -- start macro definition.  
+
+4. ^ -- define the caret ('^') as the line separator.  
+
+5. ^ -- initial line defined by the macro is empty, so it is ignored.  
+
+6. .sf D,width=\linewidth/2,height=\textheight/2,keepaspectratio=true, -- define LaTeX figure scale  
+
+7. \ -- concatenate next line  
+
+8. scale=5 -- complete figure scale  
+
+9. ^ -- next line  
+
+10. .sf H,600x600 -- define HTML figure scale
+      
+Figure 3-2 1/3 Page size

+Figure 3-2
+
+      
+Figure 3-3 1/2 Page size

+Figure 3-3
+
+
+# 4 Adding Images to Tables  
+Sometimes it is desirable to display an image or set of images in a table. This is done by using the \fig in-line command. The syntax is as follows:
+\fig{Image-path[,label],Caption}Title, where
+  
+
+1. Image-path is the path to the image, as before.  
+
+2. Label is an optional escape variable to hold the assigned figure number. The image must have a caption (or it is not a figure), and the label may be referenced after it is defined by \esc{label}.  
+
+3. Caption is the caption to be used if the image is a Figure. The caption appears in the list of figures in the contents.  
+
+4. Title is the below image title and is used if the caption is omitted. Do not use both the caption and the title. If both the caption and the title are omitted, the image is untitled.Example:
+
+
+
+
+
+.include mysymbols.sti

+The figure number was \esc{Example2}

+.sf H,300x400

+.sf T,200x300

+.Caption Table title

+.Table |c|c|

+Column 1 title<tab>Column 2 title

+\fig{Pic1.jpg,Example2,Neat pic, eh}<tab>\fig{Pic2.jpg}This one is not a figure

+\endtable{}

+ 

+The figure number was \esc{Example2}

+ 

+.saveVariables mysymbols.sti
+
+The example is shown below:
+The figure number was 4-a
+
+----
+  Table 4-I Table title

 
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

 Operand Meaning Example
%p Full path to the file c:\dir\file.ext
%d Drive c:
%r Root \dir\
%f File name file
%e File extension ext
%[prompt] Prompt for keyboard input input replaces operand
-
-
-Using the operands the full path to a file is: %p = %d%r%f.%e = c:\root\filename.ext
-
-      
-Figure 2-1 STF File Associations Menu

-Figure 2-1
-
-
-# 3 Default Menu  
-The Executor's default menu references commands supported in NIC. Not all of these commands are installed by default by the STF installer. The "NIC" column indicates if the command is installed along with NIC, the "STF" column indicates if the command is installed along with STF. Commands not included in STF may be self installed.
-    Table 3-I Executor Default Menus
+Image 1
+Image 2
+
+
+  
+ 
+
Fig. 4-a: Neat pic, eh
+
+
+
This one is not a figure
+
+
+
+The figure number was 4-a
+
+Notes:
+  
+
+* Notice in the HTML/Wiki representation that Image 2 is stretched out of shape. The actual image is roughly square, not rectangular. This is fixed in the next section on using Auto Image Size.  
+
+* Notice the use of .saveVariables placed at the end of the document to save the document generated symbols in a file. This saves the figure number in file mysymbols.sti, which is then included at the beginning of the document by .include mysymbols.sti. This allows the figure number to be referenced before it is created. This makes the figure number available the second and subsequent times the document is generated.  
+
+* Notice that Image 1 is a figure because the title is inside of the \fig command; while Image 2 is not a figure because the title is after the \fig command.
+
+# 5 Setting the Image Size in Tables  
+The .sf command is also used to scale LaTeX document images defined inside of tables. The syntax is as follows:
+
+
+
+
+
+Code T -- The specification is for the dimensions of a box: WxH, where "W" is the box width in pixels and "H" is the box height in pixels. All cells containing figures in the table will be scaled to these dimensions.

+Code C -- Rows,Columns[,Pad]. STF will scale the images so as to fit the largest possible images in the specified table.
+
+Examples:
+
+
+
+
+
+.sf T, 400x600 -- define table cell size as 400 by 600 pixels (72 pixels per inch)

+.sf C, 3,3,20 -- define 3 by 3 table array of images. Reserve 20 pixels for additional titles
+
+
+# 6 Using Auto Image Size  
+As mentioned previously AutoImageSize is used to read the file of image descriptionsprovide automatic scaling for HTML/Wiki images. AutoImageSize may be specified multiple times. The files are merged and the latest values override older ones. The syntax is:
+.AI file-path, Size -- alias: .AutoImageSize, where
+  
+
+1. File-path is the location of file containing image size information.  
+
+2. Size is the desired image size in pixels. Width x Height. If the image size has not been specified, a default of 512x 384 is used.
+The image size file should contain one line for each image being used in a .Figure command.
+The file format is:
+Image-name image-tag WxH ...
+One image name per line. The image tag is usually the same as the image file extension and is ignored.
+"WxH" is the image width and height of the figure in pixels. When a .Figure command is evaluated, the
+auto-image-size file will be searched for the image name. If found, the image will be adjusted to fit within
+the default window size.
+Examples:
+
+
+
+
+
+.AutoImageSize MyImageSize.txt, 640x480

+MyImageSize.txt will be loaded and the Auto Image Size window size set to 640x480.

+ 

+.AI , 640x480

+The Auto Image Size window size will be set to 640x480.
+
+Notes:
+  
+
+1. The identify command⁽²⁾ may be used to automatically generate autoimagesize.txt.  
+
+2. Identify is native to UNIX and downloadable for Windows.  
+
+3. ImageMagick may be downloaded from: [http://www.ImageMagick.org/script/binary-releases.php.](http://www.ImageMagick.org/script/binary-releases.php.)There are multiple distributions on this site, so scroll down to the Windows Binary
+Release.
+  
+
+4. ImageMagick recommends installing GhostScript first, this may be found at:[http://sourceforge.net/projects/ghostscript/?source=dlp.](http://sourceforge.net/projects/ghostscript/?source=dlp.)
+For example, identify \*.jp\*>autoImageSize.txt will generate the file for JPEG images. You can concatenate other extensions as in identify \*.gif>>autoImageSize.txt. This will add the image data for gif files to autoImageSize.txt.
+
+Example: Setup a 3x3 table array of images -- see table Tab-6-I:
+
+
+
+
+
+.AutoImageSize AutoImageSize.txt,300x400

+.sf C,3,3,20

+.Caption AutoImageSize Example

+.table |c|c|c|,Auto

+.row Image<tab>Image<tab>Image

+\fig{Image1.jpg}1,1<tab>\fig{Image2.jpg}1,2<tab>\fig{Image1.jpg}1,3

+\fig{Image2.jpg}2,1<tab>\fig{Image1.jpg}2,2<tab>\fig{Image2.jpg}2,3

+\fig{Image1.jpg}3,1<tab>\fig{Image2.jpg}3,2<tab>\fig{Image1.jpg}3,3

+\endtable{}
+    Table 6-I AutoImageSize Example

 
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

 Ext Command Operand Comments NIC STF
TXT
txt (PS)Wordpad "%p" Editor N N
txt (PS)Notepad "%p Editor N N
txt (PS)xemacs "%p" Editor N N
txt filemgr "%p" File Manager Y N
txt NewSTF "%f" Creates a sample STF input file Y Y
txt ECrypt "%f" "%e" Encrypts the file Y N
STI
sti (PS)Wordpad "%p" Editor N N
sti (PS)Notepad "%p" Editor N N
sti (PS)xemacs "%p" Editor N N
sti filemgr "%p" File Manager Y N
sti ViewSubDoc "%p" Formats an include file for viewing Y Y
sti SuperCleanSTF   Removes all the junk files Y Y
sti SuperCleanLatex   Removes all the junk files, except for .tex Y Y
sti NewSTF "%f" Creates a model STF file Y Y
STF
stf (PS)Wordpad "%f.%e" Editor N N
stf makeDoc "%f" Formats an STF file without a contents Y Y
stf makeDocWithIndex "%f" Formats file with a contents and index Y Y
stf makeRTFDoc "%f" Formats an STF file to RTF format Y Y
stf makeWiki "%f" Formats an STF file to Wiki format Y Y
stf ViewSubDoc "%p" Formats an include file for viewing Y Y
stf SuperCleanSTF   Removes all the junk files Y Y
stf SuperCleanLatex   Removes all the junk files, except for .tex Y Y
stf NewSTF "%f" Creates a sample STF input file Y Y
stf (PS)xemacs "%p" Editor N N
PDF
pdf (PS)AcroRd32 "%p" Views file using Acrord32 N N
pdf PdfDrvr "%p" Manipulates PDF files Y N
pdf ECrypt "%f" "%e" Encrypts file Y N
DAT
dat (PS)xemacs "%p" Editor N N
dat ECrypt "%f" "%e" Encrypts file Y N
-
-
-During the STF installation process⁽⁴⁾, Executor is copied to C:\Users\Public\Cmds. Executor is invoked from batch file ExecutorDrvr.bat also located in C:\Users\Public\Cmds.
-
-
-# 4 Adding Menu Entries  
-The format of the Executor initialization file is:
-Extension \*- command \*- operands
-The initialization file is named: C:\Users\"owner"\.nic\Executor\Executor.ini, where "owner" is your login name.
-
-
-# 5 Activating Menus  
-C:\Users\Public\Cmds\ExecutorDrvr.bat must be associated with each file extension specified in Executor.ini in order for a menu to be displayed when a file of that extension is doubleclicked. The process of associating ExecutorDrvr with file extensions is discussed under installation in the STF Syntax Summary.
-
-
-# 6 Usage  
-To execute an Executor command on a file, doubleclick on a file with a defined extension. The menu corresponding to that extension will be displayed. (See Figure 2-1 for the STF extension menu.) Then doubleclick the menu entry and the command will operate as specified in Executor.ini.
+Image
+Image
+Image
+
+
+
+
+
1,1
+
+
+
1,2
+
+
+
1,3
+
+
+
+
+
2,1
+
+
+
2,2
+
+
+
2,3
+
+
+
+
+
3,1
+
+
+
3,2
+
+
+
3,3
+
+
+
+
+
+# 7 Linking to Images  
+STF supports internally linking to tables and figures. This capability is the same for LaTeX, HTML, RTF, and Wiki formats. Internal links are supported via the \ref and \dref inline commands. \ref is used for linking to tables, figures, paragraphs, and lists; while \dref and \dpage are used to link to figures embedded in tables via the \fig command and also to link to arbitrary spots in a document that are specified via the \dlink command.
+
+The reason for this dichotomy is the standard way of specifying figures in LaTeX allows LaTeX to automatically move the figures around in the document to minimize extra white space. This paradigm is in conflict with the table paradigm which specifies that whatever is placed inside of a table cell is stuck there. So to support figures inside of tables in LaTeX, it was necessary to use different LaTeX commands than the usual ones. HTML has no concept of pages, so it is not a problem putting figures inside of tables when targeting to HTML or Wiki formats, however the commands are honored under HTML and Wiki processing to make the command structure symmetric between the LaTeX, RTF, HTML and Wiki formats.
+
+Examples, of how to reference the previously defined figures:
+
+
+
+
+
+Normal figure: See Figure \ref{Example1, page}.\nl{}

+Embedded figure:  See Figure \dref{Example2, \esc{Example2\}}\dpage{Example2, ~on page~}.
+
+Normal figure: See Figure 2-1.
+Embedded figure:  See Figure  4-a.

 


 (1) 
-Graphical User Interface
+See the STF Syntax Summary for details.

 (2) 
-Built-in extensions, such as exe and bat are excluded.
-
-(3) 
-Discussed in the STF Syntax Summary
-
-(4) 
-See the STF Syntax Summary.
-
-
-
+Part of ImageMagick
+
+
+

Ext	Command	Operand	Comments	NIC	STF
TXT
txt	(PS)Wordpad	"%p"	Editor	N	N
txt	(PS)Notepad	"%p	Editor	N	N
txt	(PS)xemacs	"%p"	Editor	N	N
txt	filemgr	"%p"	File Manager	Y	N
txt	NewSTF	"%f"	Creates a sample STF input file	Y	Y
txt	ECrypt	"%f" "%e"	Encrypts the file	Y	N
STI
sti	(PS)Wordpad	"%p"	Editor	N	N
sti	(PS)Notepad	"%p"	Editor	N	N
sti	(PS)xemacs	"%p"	Editor	N	N
sti	filemgr	"%p"	File Manager	Y	N
sti	ViewSubDoc	"%p"	Formats an include file for viewing	Y	Y
sti	SuperCleanSTF		Removes all the junk files	Y	Y
sti	SuperCleanLatex		Removes all the junk files, except for .tex	Y	Y
sti	NewSTF	"%f"	Creates a model STF file	Y	Y
STF
stf	(PS)Wordpad	"%f.%e"	Editor	N	N
stf	makeDoc	"%f"	Formats an STF file without a contents	Y	Y
stf	makeDocWithIndex	"%f"	Formats file with a contents and index	Y	Y
stf	makeRTFDoc	"%f"	Formats an STF file to RTF format	Y	Y
stf	makeWiki	"%f"	Formats an STF file to Wiki format	Y	Y
stf	ViewSubDoc	"%p"	Formats an include file for viewing	Y	Y
stf	SuperCleanSTF		Removes all the junk files	Y	Y
stf	SuperCleanLatex		Removes all the junk files, except for .tex	Y	Y
stf	NewSTF	"%f"	Creates a sample STF input file	Y	Y
stf	(PS)xemacs	"%p"	Editor	N	N
PDF
pdf	(PS)AcroRd32	"%p"	Views file using Acrord32	N	N
pdf	PdfDrvr	"%p"	Manipulates PDF files	Y	N
pdf	ECrypt	"%f" "%e"	Encrypts file	Y	N
DAT
dat	(PS)xemacs	"%p"	Editor	N	N
dat	ECrypt	"%f" "%e"	Encrypts file	Y	N

WorkingWithTheGUI modified by bstanly

bstanly — Sat, 26 Nov 2016 10:27:59 -0000

Working with the NIC GUI

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 Creating Menus

3 Default Menu

4 Adding Menu Entries

5 Activating Menus

6 Usage

T A B L E S

Table 2-I Executor Operands
Table 3-I Executor Default Menus

F I G U R E S

Figure 2-1 STF File Associations Menu

1 Introduction

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

One of the tools imported from Nuances In Computing (NIC) is Executor.py, or just Executor. Executor makes it easy to attach a GUI⁽¹⁾ menu to any file extension. Once the GUI has been attached to an extension⁽²⁾, doubleclicking the extension causes Executor to display a menu of commands to be invoked. This approach can make it easier to implement a process, such as document preparation. See Figure 2-1 for the file associations menu for extension STF.

This discussion is Windows centric, however the commands are also supported by UNIX/Linux.

2 Creating Menus

The first time Executor is invoked, it copies its default menus to C:\Users\'Owner'.nic\Executor, where owner is your login name. The default menu is shown in Table Tab-3-I. The commands specified in the table must be on the current path⁽³⁾. Commands are invoked using Windows batch processor, cmd.exe, which comes with Windows, unless the command is preceded with "(PS)", in which case it is invoked using the power shell, which also comes with windows. The operands, shown in table Tab-2-I, may be intermixed with constant text to define the command that is to operate on files of the specified extension. Feel free to customize the Executor menu as desired.
Table 2-I Executor Operands

Operand	Meaning	Example
%p	Full path to the file	c:\dir\file.ext
%d	Drive	c:
%r	Root	\dir\
%f	File name	file
%e	File extension	ext
%[prompt]	Prompt for keyboard input	input replaces operand

Using the operands the full path to a file is: %p = %d%r%f.%e = c:\root\filename.ext

Figure 2-1 STF File Associations Menu

Figure 2-1

The Executor's default menu references commands supported in NIC. Not all of these commands are installed by default by the STF installer. The "NIC" column indicates if the command is installed along with NIC, the "STF" column indicates if the command is installed along with STF. Commands not included in STF may be self installed.
Table 3-I Executor Default Menus

Ext	Command	Operand	Comments	NIC	STF
TXT
txt	(PS)Wordpad	"%p"	Editor	N	N
txt	(PS)Notepad	"%p	Editor	N	N
txt	(PS)xemacs	"%p"	Editor	N	N
txt	filemgr	"%p"	File Manager	Y	N
txt	NewSTF	"%f"	Creates a sample STF input file	Y	Y
txt	ECrypt	"%f" "%e"	Encrypts the file	Y	N
STI
sti	(PS)Wordpad	"%p"	Editor	N	N
sti	(PS)Notepad	"%p"	Editor	N	N
sti	(PS)xemacs	"%p"	Editor	N	N
sti	filemgr	"%p"	File Manager	Y	N
sti	ViewSubDoc	"%p"	Formats an include file for viewing	Y	Y
sti	SuperCleanSTF		Removes all the junk files	Y	Y
sti	SuperCleanLatex		Removes all the junk files, except for .tex	Y	Y
sti	NewSTF	"%f"	Creates a model STF file	Y	Y
STF
stf	(PS)Wordpad	"%f.%e"	Editor	N	N
stf	makeDoc	"%f"	Formats an STF file without a contents	Y	Y
stf	makeDocWithIndex	"%f"	Formats file with a contents and index	Y	Y
stf	makeRTFDoc	"%f"	Formats an STF file to RTF format	Y	Y
stf	makeWiki	"%f"	Formats an STF file to Wiki format	Y	Y
stf	ViewSubDoc	"%p"	Formats an include file for viewing	Y	Y
stf	SuperCleanSTF		Removes all the junk files	Y	Y
stf	SuperCleanLatex		Removes all the junk files, except for .tex	Y	Y
stf	NewSTF	"%f"	Creates a sample STF input file	Y	Y
stf	(PS)xemacs	"%p"	Editor	N	N
PDF
pdf	(PS)AcroRd32	"%p"	Views file using Acrord32	N	N
pdf	PdfDrvr	"%p"	Manipulates PDF files	Y	N
pdf	ECrypt	"%f" "%e"	Encrypts file	Y	N
DAT
dat	(PS)xemacs	"%p"	Editor	N	N
dat	ECrypt	"%f" "%e"	Encrypts file	Y	N

During the STF installation process⁽⁴⁾, Executor is copied to C:\Users\Public\Cmds. Executor is invoked from batch file ExecutorDrvr.bat also located in C:\Users\Public\Cmds.

The format of the Executor initialization file is:
Extension *- command *- operands
The initialization file is named: C:\Users\"owner".nic\Executor\Executor.ini, where "owner" is your login name.

5 Activating Menus

C:\Users\Public\Cmds\ExecutorDrvr.bat must be associated with each file extension specified in Executor.ini in order for a menu to be displayed when a file of that extension is doubleclicked. The process of associating ExecutorDrvr with file extensions is discussed under installation in the STF Syntax Summary.

6 Usage

To execute an Executor command on a file, doubleclick on a file with a defined extension. The menu corresponding to that extension will be displayed. (See Figure 2-1 for the STF extension menu.) Then doubleclick the menu entry and the command will operate as specified in Executor.ini.

(1)
Graphical User Interface

(2)
Built-in extensions, such as exe and bat are excluded.

(3)
Discussed in the STF Syntax Summary

(4)
See the STF Syntax Summary.

txt	filemgr	(PS)filemgr	"%p"	File Manager	Y
txt	NewSTF	(PS)NewSTF	"%f"	Creates a sample STF input file	Y	Y
txt	ECrypt	"%f" "%e"	Encrypts the file	Y	N
STI
sti
sti	filemgr	(PS)filemgr	"%p"	File Manager	Y
sti	ViewSubDoc	(PS)ViewSubDoc	"%p"	Formats an include file for viewing	Y
sti	SuperCleanSTF	(PS)SuperCleanSTF		Removes all the junk files	Y
sti	SuperCleanLatex	(PS)SuperCleanLatex		Removes all the junk files, except for .tex	Y
sti	NewSTF	(PS)NewSTF	"%f"	Creates a model STF file	Y
stf	makeDoc	(PS)makeDoc	"%f"	Formats an STF file without a contents	Y
stf	makeDocWithIndex	(PS)makeDocWithIndex	"%f"	Formats file with a contents and index	Y
stf	makeRTFDoc	(PS)makeRTFDoc	"%f"	Formats an STF file to RTF format	Y
stf	makeWiki	(PS)makeWiki	"%f"	Formats an STF file to Wiki format	Y
stf	ViewSubDoc	(PS)ViewSubDoc	"%p"	Formats an include file for viewing	Y
stf	SuperCleanSTF	(PS)SuperCleanSTF		Removes all the junk files	Y
stf	SuperCleanLatex	(PS)SuperCleanLatex		Removes all the junk files, except for .tex	Y
stf	NewSTF	(PS)NewSTF	"%f"	Creates a sample STF input file	Y
pdf	PdfDrvr	(PS)PdfDrvr	"%p"	Manipulates PDF files	Y	N
pdf	ECrypt	"%f" "%e"	Encrypts file	Y	N
N	N
dat	ECrypt	"%f" "%e"	Encrypts file	Y	N