WinShell 2.0. Ingo H. de Boer January 31, www:

Transcription

1 WinShell 2.0 Ingo H. de Boer January 31, www:

2 Copyright c Ingo H. de Boer. Permission to use, copy and distribute this software and its documentation for any purpose is hereby granted without fee, provided that the above copyright notice, author statement and this permission notice appear in all copies of this software and related documentation. THE SOFTWARE IS PROVIDED AS-IS AND WITHOUT WARRANTY OF ANY KIND, EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITH- OUT LIMITATION, ANY WARRANTY OF MERCHANTABILITY OR FIT- NESS FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL INGO H. DE BOER OR ANY PERSON OR IN- STITUTION RELATED TO INGO H. DE BOER BE LIABLE FOR ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFOR- MANCE OF THIS SOFTWARE.

3 Contents 1 Introduction What is WinShell? What is new? Features Installation What does it cost? What else Getting started Menus File Menu Edit Menu Run Menu Options Menu Project Menu Window Menu How to Insert a User Tool Create a User Tool Insert a User Tool into the Tool Bar Insert a Macro Create a Macro Insert a Macro into the Tool Bar Manage the Tool Bars Manage a Project Handle the Command and Environment File

4 ii Contents 4 Known Problems, Future Work and Bug Report Known Problems and Limitations Future Work Bug Report Index 23

5 1 Introduction 1.1 What is WinShell? WinShell is a graphical user interface for easy working with LATEX or TEX. It includes a Texteditor, different Toolbars and user configuration options. It is NOT a LATEX system. An additional LATEX package for Windows is needed: ftp://ftp.dante.de/pub/tex/systems/win32/ The GSviewer for the PostScript files is also recommended: ftp://ftp.dante.de/pub/tex/support/ghostscript/aladdin/ ftp://ftp.dante.de/pub/tex/support/ghostscript/rjl/ Other CTAN sites are: ftp://ftp.tex.ac.uk (England) ftp://ctan.tug.org (USA) and 1.2 What is new? supports multi-language interface: English, German, French Project-File/-Window The use of the project is like in other applications: add, remove etc. The Project-File contains relative pathnames. By double-clicking on a file it will open. By double-clicking on an entry of the Table of Contentst, the file will open at that specific position. The Table of Contentst contains: \chapter \section \subsection \subsubsection. Command-Line-Arguments: WinShell understands winshell project_file winshell current_tex_file the user-defined programs can be called with: %<p>s: Main-TEX-Document %<p>c: current TEX-Document %<p>m: the document as set in the Status Bar WinShell starts only once, e.g. for use with the inverse search option drag & drop new menu background color

6 2 Introduction 1.3 Features multi language support: English, German and French Project file one-instance-program: WinShell is started only once MDI application: multiple documents log file/project file - window user-defined programs configure Tool Bars (symbols, user-def. programs, macros) define macros choose font Unix files can be read Command-Line-Arguments: WinShell can be started with winshell -p project_file winshell -m main_tex_file winshell -c current_tex_file -l current_line winshell project_file winshell current_tex_file user data storage: Windows NT4.0 in the Profiles directory Windows 9x in the WinShell directory Syntax highlighting The commands and environments can be defined in WinShell.commands WinShell.environments distinction between Main-TEX-Document and current TEX-Document toggle wrap mode drag & drop 1.4 Installation This software comes with a setup program. It copies all the WinShell - files to a specific directory, eg C:\Program Files\WinShell. Registry entries are made for the.tex and the.wsp - files. When WinShell starts for the first time, the following files will be created: WinShell.commands WinShell.environments WinShellMacros.bmp WinShellUserTools.bmp WinShell.ini WinShell.macros

7 1.5 What does it cost? What does it cost? This software is supplied in a binary format ( as ist ) for free - the source code is not available. In the TEX catalogue it will fall under the category of nosourcet. There are many expenses I incur in maintaining the WinShell project that may not be apparent, such as web hosting costs, and the costs of new operating systems and software I have purchased specifically for writing and testing WinShell. If you desire, you may send me donations of any amount towards my efforts for keeping the WinShell project alive. Although donations received are very much appreciated, those that do make donations do not automatically receive preferential treatment over those who don t. Please contact me for further details. 1.6 What else... Additional notes: 1. There is no need to continuously save the documents/project. This is automatically done when running one of the programs like LATEX, BibTEX etc. or exiting WinShell. 2. There is a LATEX-Help included from the MiKTEX package. 3. Learning by doing! 1.7 Getting started... If a LATEX package is correctly installed on the system, the user may start right away. The different control bars (see chapter View) are hidden at the top of the main window right below the Tool Bar. They can be moved around, formed, shown or hidden. This condition will be saved, when regularly leaving the program and be restored at the next program start. The Main-TEX-Document has to be set in the Main-TEX-Document menu. The default value will be the current TEX-Document. The exe- and command-line have to be set in the Program Calls menu. Default values are also set. There, the user-defined programs can be configured.

8

9 2 Menus 2.1 File Menu New File A new TEX-Document is created in WinShell. Keys: CTRL+N Open File This command opens one or more existing documents in a new window. Keys: CTRL+O File-Types WinShell - Files (*.wsp, *.tex, *.bib, *.log) Project - Files (*.wsp) TEX - Files (*.tex) BibTEX - Files (*.bib) Log - Files (*.log) All Files (*.*) Close File Save File The active document is saved to its current name and directory. When a document is saved for the first time, WinShell displays the Save As dialog box to name the document. Keys: CTRL+S Save File as The active document is closed. WinShell automatically saves all changes made to the document. When closing an untitled document, Win- Shell displays the Save As dialog box, suggests a name and saves the document. The active document can be renamed and saved to a new directory. Win- Shell displays the Save As dialog box. The Save command can be used to save a document with its existing name and directory. Save all Files This command names and saves all active documents. When a document is saved for the first time, WinShell displays the Save As dialog box to name the document.

10 6 Menus Print The current document is printed in the raw ASCII format - NOT in DVI or PS format!! Print Preview A window pops up to show the printer output. Page Setup The header and footer of a document printout are set by this command. The command presents a Page Setup dialog box, where these two values are specified. Print Setup Define the printer here. The command presents a Print Setup dialog box, where different values can be set. Exit This command ends the WinShell session. The Close command on the application Control menu can be used as well. WinShell doesn t prompt to save documents with unsaved changes, it automatically saves the documents and the project file. Keys: ALT+F4 2.2 Edit Menu Undo This command reverses the last editing action, if possible. The name of the command changes, depending on what the last action was. The Undo command changes to Can t Undo on the menu if it is not possible to reverse the last action. Keys: CTRL+Z or ALT-BACKSPACE Cut The Cut command removes the currently selected data from the document and puts it on the clipboard. This command is unavailable if there is no data currently selected. Cutting data to the clipboard replaces the contents previously stored there. Keys: CTRL+X Copy The Copy command copies selected data onto the clipboard. This command is unavailable if there is no data currently selected.

11 2.3 Run Menu 7 Copying data to the clipboard replaces the contents previously stored there. Keys: CTRL+C Paste This command inserts a copy of the clipboard contents at the insertion point. This command is unavailable if the clipboard is empty. Keys: CTRL+V Find The Find command searches the active document for a given expression. Keys: CTRL+F Find next The Find next command searches the active document for the next given expression. Keys: F3 Replace In the active document, this command replaces one expression with another. Keys: CTRL+H 2.3 Run Menu L A TEX LATEX compiles the Main-TEX-Document as displayed in the Status Bar. The command line and the file name are set in the Options menu (usually %st for the cmd-line). Keys: F5 BibTEX This command runs BibTEX. Keys: F6 DVI Win The DVI Win command is used to view the DVI file of the Main-TEX- Document. The command line and the file name are set in the Options menu (usually %st for the cmd-line). There is one more option: run LATEX firstt. If a document is modified and not

12 8 Menus compiled with LATEX, DVI Win will show the old version of the DVI file. To avoid this, this option is marked: When modifying a document and pressing the DVI Win button, LATEX will be run first. Keys: F7 DVI PS DVI PS creates the PostScript file of the Main-TEX-Document from the DVI file. The command line and the file name are set in the Options menu (usually %st for the cmd-line). Using -D600 %st will cause a 600dpi ouput file. Keys: F8 GSview GSview shows the PostScript file of the Main-TEX-Document. The command line and the file name are set in the Options menu (usually %st for the cmd-line). There are two more options: run LATEX firstt and run DVIPS firstt. If a document is modified, not compiled with LATEX and DVIPS not executed, GostView will show the old version of the PostScript file. To avoid this both options are marked: When modifying a document and pressing the GSview button, LATEX and DVIPS will be run first. Keys: F9 2.4 Options Menu Main-TEX-Document Here, the name of the Main-TEX-Document is set. This file will be compiled! After choosing it in the Main-TEX-Document dialog, it will appear in the Status Bar. You can choose between a specific file and the current (active) document. Keys: F4 Program Calls Use this command to set the file name and command line for the different programs like LATEX, BibTEX... You can also configure userdefinied program calls. Here, it is important to add the suffix.

13 2.4 Options Menu 9 The parameters %<p>s, %<p>c and %<p>m have the following meaning: %s use the Main-TEX-Document. %ps use the Main-TEX-Document with full pathname. %c use the current TEX-Document. %pc use the current TEX-Document with full pathname. %m use the document as specified in the Status Bar. %pm use the document as specified in the Status Bar with full pathname. Example: To add a TEX button to WinShell, just fill in the name section TeXt and for the exe-file text. In the cmd-line it must be %m.text. Do not mark run LATEX firstt and run DVIPS firstt. The next step: Go to the View menu and place the button in the Tool Bar. Font Changes the current font. Syntax Highlighting Mark or unmark for syntax highlighting. Choose colors for commands, environments, braces, remarks, math mode, normal text and background. Umlaute Changes the Umlaute (only available in the german version). When pressing one of the Umlaute keys, it will appear as specified in the dialog. Macros Defines the macros. All in all there are ten macros. By pressing the keyboard or the button on the Macro Bar, the specific macro will be inserted in the text at the current cursor position. The next step: Go to the View menu and place the buttons the Macro Bar. Keyboard: Shift + F1..F10

14 10 Menus Wrap Mode Toggles the word wrap mode. A check mark appears next to the menu item, when the wrap mode is enabled. Language Changes the language. Available translations for WinShell are: English, German and French. View Customize Customizes the Tool Bar and the Macro Bar. There are seven categories. The first five categories are the standard buttons. The sixth category is for the user-defined programs and the seventh one is for the macros. The customization is simply like in other programs: Select a category. Click a button to see its description and drag it into the Tool Bar. When dragging the user defined programs on the Tool Bar or the macros on the Macro Bar, another dialog will pop up to customize the button appearance. Projectspace Displays and hides the Projectspace. A check mark appears next to the menu item when the Projectspace is displayed. The Projectspace displays information about the loaded project. For further details look at the Project chapter. Logspace Displays and hides the Logspace. A check mark appears next to the menu item when the Logspace is displayed. The Logspace displays the.log-file of the Main-TEX-Document. This field can not be edited! Tool Bar The Tool Bar is displayed across the top of the application window, below the menu bar. The Tool Bar provides quick mouse access to many tools used in WinShell. For toggling the Tool Bar, choose Tool Bar from the Options-View menu. A check mark appears next to the menu item when the Tool Bar is displayed.

15 2.5 Project Menu 11 Status Bar Displays and hides the Status Bar, which describes the action to be executed by the selected menu item or pressed Tool Bar button, and keyboard latch state. A check mark appears next to the menu item when the Status Bar is displayed. The Status Bar is displayed at the bottom of the WinShell window. To display or hide the Status Bar, use the Status Bar command in the Options-View menu. The left area of the Status Bar describes actions of menu items as you use the arrow keys to navigate through menus. The right area of the Status Bar shows the current line number and the Main- TEX-Document. Other Bars Displays and hides the different bars. A check mark appears next to the menu item when this bar is displayed. These bars represent some of the most common commands used in LATEX. Arrow Bar Accent Bar Greek Letter Bar Binary Operator Bar Relation Bar Misc Bar Macro Bar 2.5 Project Menu New Project A new project is created in WinShell. A dialog pops up to name the new project. After that the Main-TEX-Document and additional TEX-Documents have to be set (see Add to Project). The right area of the Status Bar shows the name of the Main-TEX-Document. Load Project This command opens an existing project. The files and the Table of Contentst (if available) are shown in the Projectspace. The right area of the Status Bar shows the name of the Main-TEX-Document. Close Project The active project is closed. WinShell automatically saves all changes made to the documents. Before closing an untitled document, WinShell displays the Save As dialog box, suggests a name and saves the document.

16 12 Menus Save Project The active project is saved to its current name and directory. When a document is saved for the first time, WinShell displays the Save As dialog box to name the document. WinShell uses relative pathnames. Save Project as The active project can be renamed and saved to a new name. Shell displays the Save As dialog box. Win- Add to Project The files that belong to the project have to be added here. The Main-TEX- Document is not analysed. The user has to handle the adding or deleting of the project files. Deleting a file works like this: mark the file in the Projectspace and click the right mouse button. A pop-up dialog appears which allows the user to delete the file from the project. Add a Main-TEX-Document to the Project This command adds the Main-TEX-Document to the active project. appear in the Projectspace in bold form. It will Add a TEX-Document to the Project This command adds one or more TEX-Documents to the active project. It will appear in the Projectspace. 2.6 Window Menu New Window Open another window for the active document. Cascade Window Arrange the windows so they overlap. Tile Window Arrange windows as non-overlapping tiles. Arrange Icons Arrange Icons at the bottom of the window.

17 3 How to Insert a User Tool Create a User Tool Step 1 Go to Options Program Calls user defined. Click on the Tool 1t entry in the right list. Step 2 Make the entries for the wanted program. In this example, pdflatex will be used: Name: PDFLaTeX run LaTeX first: unmark exe-file: pdflatex run DVIPS first: unmark cmd-line: %m.tex Step 3 Press the OKt button Insert a User Tool into the Tool Bar Step 1 Go to Options View Customize. Choose the category: User- Programst.

18 14 How to... Step 2 Drag the wanted tool on the Tool Bar. In this example, drag PDFLa- TeXt on the Tool Bar. Step 3 A dialog pops up. It shows how to design the corresponding button. Tool 1t is highlighted. There are different possibilities. In this example, press the Editt button. Step 4 The edit dialog pops up. Here, it is possible to change the appearance of the button. When finished, just press the OKt button.

19 3.1 Insert a User Tool 15 Step 5 The modified button appears in the image list. Again, press the OKt button. The button now appears in the Tool Bar. Step 6 To insert a separator move the mouse pointer to the GSview button and press the right mouse button. A dialog pops up: press the Groupt button. Step 7 Finish the insertion by pressing the Closet button.

20 16 How to Insert a Macro Create a Macro Step 1 Step 2 Step 3 Go to Options Macros. Choose the number of the macro from the dropdown list (F01...F10). Make your entries for your wanted program Insert a Macro into the Tool Bar Step 1 Go to Options View Customize. Choose the category: User- Macrost. Step 2 Because all macros are shown, move the mouse pointer to Macro 1t and press the right mouse button. A dialog pops up. This dialog allows the user to modify the appearance of the button. Click the Editt button.

21 3.3 Manage the Tool Bars 17 Step 3 The edit dialog pops up. Here, it is possible to change the appearance of the button. When finished, just press the OKt button. The next steps proceed like in the previous section. 3.3 Manage the Tool Bars This is how it looks, when all Tool Bars are shown. The appearance is not very user-friendly, but it is possible to move and form each Tool Bar. When quitting WinShell, these positions are stored and reloaded at the next start.

22 18 How to... Step 1 This example shows the Accents Tool Bar. Drag the gripper of the Tool Bar to any place. Step 2 By dragging at the edges of the Tool Bar it is possible to manipulate it and move the Tool Bar to its destination place. This position will be reloaded at the next start. 3.4 Manage a Project

23 3.4 Manage a Project 19 The use of a project is like in other applications: load, save etc. The project file contains relative pathnames. The Project menu contains all needed entries for loading, saving and adding the Main-TEX-Document and the TEX-Documents. There is also a Demo included in this package. Left Mouse Button By double-clicking a file, it will open (left image). By double-clicking an entry of the Table of Contentst, the file will open at that specific position (right image). The Table of Contentst contains: \chapter \section \subsection \subsubsection. Right Mouse Button By clicking a file entry (left image) a dialog pops up to add existing documents to the project or remove the marked file from the current project. By clicking

24 20 How to... a TOC entry (right image) a dialog pops up to reload the Table Of Contentst. 3.5 Handle the Command and Environment File The user data is stored at the following place: Windows NT4.0 in the Profiles directory Windows 9x in the WinShell directory The command-file WinShell.commands includes the LATEX commands which are highlighted by WinShell. The following lines show an excerpt from this file. It can be modified in a normal editor. It is possible to add or remove names. There is no leading character ( \t ) needed. %, \ - addcontentsline address addtocontents addtocounter addtolength addvspace alph alpha... The environment-file WinShell.environments includes the LATEX environments which are used with \begin and \end. array center description enumerate eqnarray equation figure flushleft flushright itemize letter list... The syntax hightligthing can be toggeld at the specific menu.

25 4 Known Problems, Future Work and Bug Report 4.1 Known Problems and Limitations At the moment it is not possible to store the positions of the Project- and Logspace. The current line number can t be transfered to other programs. When using the Wrap Mode, the line numbers may not correspond with the error line number from the log file. 4.2 Future Work The future work will deal with: BibTeX entries in the Projectspace. more projects in the Projectspace. a TableWizard for easy making tables. better syntax highlighting. 4.3 Bug Report Before sending any bug report, please download the latest version from the WinShell homepage. When sending a bug report, include the following information in your My Computer: On which system do I work? What ServivePack is installed? WinShell: Which version (plus upload date) of WinShell am I using? Bug: Description of the exact way how this error was produced! What is the exact error message? Is it reproducable? Did I try it on other machines? Did I try it on other systems?

26

27 Index B Background Color Bug Report C Command File Costs Customize Macro Bar Tool Bar E Edit Copy Cut Find Paste Replace Undo Environment File Exit F Features , 2 File Close Exit New Open Page Setup Print Print Preview Print Setup Save Save all Save as Font Future Work G Ghostscript GSview H How to Handle Command File Handle Environment File Insert Macro Insert User Tool Manage Project Manage Tool Bars I Installation K Known Problems L Language Limitations M Macros Main-TEX-Document P Program Calls userdefined Project Add TEX-Document Main-TEX-Document Close Delete Document Load New Save Save as space Usage

28 24 Index R run LATEX BibTEX DVI PS DVI Win GSview S Start Syntax Highlighting U Umlaute V View Bar Accent Bar Arrow Bar Binary Operator Bar Greek Letter Bar Macro Bar Misc Bar Relation Bar Status Bar Tool Bar Customize Logspace Projectspace W Window Arrange Icons Cascade New Tile Wrap Mode