TEXnicle: A User's Manual
Contents
1. IFANICLE A User s Manual Martin HEWITSON Brian CANSLER Issue 1 Revision 1 Last revised March 17 2013 Contents 1 Introducing TpXnicle Li in The oal 2 ras he wa ass ASES La DONNE xicos are rason Installation Setup and Requirements User Guide 3 1 Welcome Screen 4 ie eid ee ebb ee HERES ras Oe OU See oe kw wR he Ee HEY HERDER EE RA dad The TOD a ee he Pe Pe EER ees 3 2 2 Main Editing Window 0 0 0 ce eee ee ee dls Navigators Fale cic av awh RETAS Awe 3 2 4 Integrated PDF Viewer 2 0 00 a ene Bees GA Boe eee eR eee eRe GG 3 2 6 Creating a New File 2 2 a 3 2 7 Creating a New Project srda ds Reference 4 1 Preferences AENA ALL Gencal lt lt ee ee ee eee eee Eee ee Ew wee ES Coles e one ke AG eee OE ee ERS EME HES ERE EA ES SX dlo POURS RO GOES o cw the edhe eee wR EO EERE SERA eke Templates os asas Peras OR OR hE ES SS Alo Commands sses sasssa hwo HE A SE EA Oa wR Grae A16 Palette amp LIDIA 2 ee a wR eA pera EDER A EE Es o MA creara rss air Bee GOO ce Peewee Ss ss do Spel Oheck roer AAA AAA 4 4 Creating Project Templates e 4 5 Project Management 4 6 Clippings Library arewa ri G rnat kg VE ces eee ee ee Pee ew eee eee e SG TEXNICLE A User s Manual CONTENTS CONTENTS 4 8 Bookmarks and Code Folding 0 0 0 0 0 00 058 24 4 9 The Edit Meda 25 4 9 1 Paste as mage 22s en wee eA eH EERE2. A Run bibtex N Run ps2pdf 3 Number of runs Language English Canada Figure 3 11 Project Settings in the Navigator 12 TRXNICLE A User s Manual 3 2 4 Integrated PDF Viewer Q search PDF a TEANICLE A User s Manual Martin HEWITSON Brian CANSLER Issue 1 Revision 1 Last revised August 16 2012 Live Update Page 1 of 31 a aja al Figure 3 12 The Integrated PDF Viewer 13 User Guide Quick Start The fourth important part of the TeXnicle window is on the right the In tegrated PDF Viewer This pane shows a live update of the document compiled at an interval that can be set under Typesetting of your doc ument Live updating can be turned on and off by toggling the but ton at the bottom of the viewer To update the viewer manually click the button on the toolbar or use the shortcut 8 R To typeset and view in the stand alone PDF viewer press 0 88 R The stand alone viewer has all of the same functions as the In tegrated PDF Viewer with the sole ex ception of live updating a page count of the PDF output a search function zoom capability and an option to print your document TEXNICLE A User s Manual User Guide Quick Start 3 2 5 Console Clear All Messages line char 5218 Users briancansler Documents Academia Dogon DD TeX Grammar Dog DD Grammar Preamble tex Figure 3 13 The Console in TEXNICLE The final pane is the Console
3. reinventing the wheel This is done by clicking New Project Template from within the project you want to use as a basis for your template The window in Figure 4 1 will appear Figure 4 1 Creating a Project Template Select files to include in template J fs Dog DD Grammar Project Template Name Y A Dog DD Grammar Pream Dog DD Grammar_template Ye Front Matter Y y Body Project Template Description Y 5 Dog DD Grammar Intrc Project template based on project Y t Dog DD Grammar Sket Dog DD Grammar Y A Dog DD Grammar Phor v Dog DD Grammar NPM Y t Dog DD Grammar Corr v t Dog DD Grammar NPSt Select All Select None Cancel Create Template From this window you can name the template provide a description and select which files in the existing project are ported to the new template 4 5 Project Management To create a new folder in your project click the folder icon in the bottom left corner of the Navigators pane or click Project X New Folder You will be given the option to create a Group 20 TRXNICLE A User s Manual Reference Clippings Library Folder which will appear in grey and exist only within the TeXnicle project space or a Folder on Disk which will appear in blue and exist on your hard drive Similarly you can add a new TFX document by clicking the document icon at the bottom of the Navigators pane or by clicking Project gt New TEX File The Template Selection window will appea
4. New TpXnicle Project While TEXNICLE can of course work with simple BIFX documents its true power is in its Project capabilities A project creates a work environment with all of the files you need in one place displaying them in an integrated tree view Figure 3 2 7 shows the window that 14 TRXNICLE A User s Manual User Guide Quick Start appears when creating a new template For a new empty project you may also use the keyboard shortcut 0 N aon Cy Empty Project 1 2 New Article From Template 3 A Build Project 4 Figure 3 14 Starting a new projct in TRXNICLE Welcome to TeXnicle Creates a new empty TeXnicle project ready to be populated with files Creates a new TeXnicle project with a standard article main file and folders for additional TeX files and images Create a new TeXnicle project from one of your project templates Creates a new TeXnicle project containing the files referenced by a main file Choose either a TeX file or a directory If a directory is choosen the main file used is the first file found that contains documentclass command When you opt to create a new project you have four options 1 Empty Project creates a new empty TEXNICLE project to which you can add your files or from within which you can create new files 2 New Article creates a new TEXNICLE project with a standard article main file and folders for additional files images and othe
5. TEXNICLE However Moun tain Lion has a useful feature that allows users to create custom shortcuts for individual applications To access this feature open the panel in System Preferences Navigate to Keyboard Shortcuts and select Application Shortcuts Click the button and select TEXNICLE from the list To change a shortcut double click the shortcut and hold down the new keys M Launchpad Dock v All Applications Display Show Help menu 0 ES Mission Control vw TeXnicle app Keyboard amp Text Input Typeset Project ET Screen Shots ive Services Spotlight Accessibility Application Shortcuts Figure A 1 Here the Typesetting command has been remapped And now a list of keyboard shortcuts in TRXNICLE Open the Preferences panel 38 Q Quit TEXNICLE 38 N Open a new ETEX document 1 38 N Create a new empty project 3 O Open an existing file 38 W Close the open window 28 TEXNICLE A User s Manual Keyboard Shortucts 38 S Save the document 4 38 S Save the document as 38 P Print 4 38 P Page setup 38 Z Undo O J 3 J Z Redo 3 X Cut the selected text 88 C Copy the selected text 38 V Paste the contents of the pasteboard X 38 V Paste the contents of the pasteboard as an image J V Paste the contents of the pasteboard as
6. a table 88 A Select all Q Reformat paragraph Smart complete Space Quick spell 38 F Document Find 8 F Project Find 38 J Find text selection in PDF 4 98 J Find PDF selection in source 38 G Find next G Find previous 3 E Use selection for Find JH Show spelling and grammar 38 Check spelling and grammar of document now X 38 Space Open the special characters panel NXJ 88 T Hide and show the toolbar XJ F Enter or exit full screen NX 88 1 Show Project Tree in the Navigator 29 TRXNICLE A User s Manual Keyboard Shortucts X 38 J 2 Show Symbol Palette in the Navigator XJ 3 Show Clippings Library in the Navigator XJ 4 Show Document Outline in the Navigator X 8 5 Show Project Search in the Navigator X J 38 6 Show Project Information in the Navigator X 88 7 Show Project Settings in the Navigator 38 Zoom in 38 Zoom out 0 88 N Create a new project NX J 38 N Create a new ETEX file T 8 B Show bookmarks 3 D Toggle bookmark for the current line 38 I Delete selected bookmark 9 88 B Jump to selected bookmark OD EJ P Jump to previous bookmark A 38 N Jump to next bookmark TIH LJH M Jump to main file 38 A Add existing
7. and then the key is pressed the editor will simply skip that brace rather than inserting a new one You may also choose for TEXNICLE to automatically replace opening quotation marks E E with two inverted apostrophes Line numbering and code folding for begin and end environments can be turned on and off here Line highlighting and the highlighting of matching words can also be edited TEXNICLE is happy to save a project automatically when compiling the document but if you want to turn off this feature it is located under the General tab You can also toggle whether 16 TRXNICLE A User s Manual Reference Preferences TEXNICLE restores project tabs when opening a project Finally the default file encoding can be set to any one of a number of encoding options The default is Unicode UTF 8 4 1 2 Typesetting The second tab in the Preferences window is the Typesetting pane This concerns the nuts and bolts of TEXNICLE with features like typesetting obviously syntax checking engines and the discard of auxiliary files Typesetting options include the ability to clear the consoles upon typesetting a document the number of seconds between Live Updates and a few other tweaks for the typesetting process Aside from clearing the console and the amount of time between Live Updates changes made under the Typesetting subcategory of this preference pane affect the default values of new projects rather than the existin
8. slow down your system 17 TEXNICLE A User s Manual Reference Preferences 4 1 4 Templates The Templates preference pane allows you to create edit and delete two kinds of templates file templates and project templates File templates are templates that can be used to start new BIFX documents TEXNICLE comes with many default templates installed but you may also edit these as well as define your own Project templates create new projects based on a template TEXNICLE comes with one project template preinstalled the article template After naming your template this opens a new project window with a file based on the Article file template and creates two folders amp Include for files you will include in your document through the main file and amp Images for image files you will insert into the document These can be edited at will You may also define new project templates or create new templates from existing projects 4 1 5 Commands The Commands pane is home to many of the powerful and most convenient features TEXNICLE has to offer T he categories within this pane will be discussed in detail The first tab is the Commands tab which controls command completion When you begin typing a command TEXNICLE can be set to bring up a list of default commands that match what you have typed This function can be turned on or off from within this pane When the function is turned off it will not automatically show the comp
9. 4 6 To open this Navigator pane quickly use the keyboard shortcut lt J 3 10 TEXNICLE A User s Manual User Guide Quick Start Document Outline The fourth component is the Document mA lg a El ty Outline which shows the outline of your Ds project or document based on sectioning Expand All Collapse All commands Part Chapter Section Para se graph and so on This pane makes it easy Y document to jump between sections of your entire doc Introduction ument similarly to the bar Dogon Languages at the top of the main editing window The ddl depth of the may be controlled using the ddl Multilingualism slider at the bottom Colours used in the A Note on Dialectology outline may be edited under Environment Font amp Colors Outline Colors To access the Navigator s Document Outline quickly press Figure 3 8 The Navigator s Document Outline 36 J XJ 4 Project Search The fifth component only appears in the Navigators pane for projects and not f for stand alone BIEX documents Project as i Q Search This will allow you to search all files Find in a project for a word or phrase Options to conduct case sensitive searches and to search only for whole words are available To open Project Search quickly press 8 X 5 Q Search Term _ Case Sensitive Match Whole Words Figure 3 9 Project Search in the Navigator 11 TRXNICLE A User s Ma
10. E i AE Figure 3 6 TEXNICLE s Symbol Palette TEXNICLE A User s Manual Clippings Library m Alm a A Y Categories Subdivisions Mathematics Math Text Styles Text Sizes Text Styles Lists Inserts Floats E Clip Code maa Fy O 5 ee ye YUI L y Shortcut No Selection Figure 3 7 The Clippings Library User Guide Quick Start The third component of the Navigators pane is the Clip pings Library two superimposed rectangles which in cludes code fragments that you can insert into your doc ument just like symbols from the Symbol Palette New clippings and categories of snippets may be added from this pane as well The top section of the Clippings Library lists categories of clippings TEXNICLE comes pre installed with a num ber of useful categories like sectioning commands math clips formatting codes and lists Below the categories panel is the clipping panel Here TEXNICLE will list the code clippings for a selected cat egory on the right and render previews of the output on the left To refresh a preview click the round ar row The bottom panel allows you to edit codes copy the text of a clipping to the pasteboard and insert clippings into your document You may also set shortcuts here To use a shortcut type a before the shortcut code in the main editor window the code will turn yellow and expand by pressing For more information on the Clippings Library see
11. art Complete above except that it does not suggest BTEX commands 4 10 The Menu The menu also holds a few less obvious TEXNICLE features This section will give a quick overview of their functions Insert Table will insert a blank a tabular environment contained within a table environment with a desired number of columns and rows Placeholders will be inserted in each cell to facilitate editing An example table with two columns and three rows is shown in Figure 4 11 Martin Does this apply to Apple Numbers too Or other spreadsheet programs What about Microsoft Word Apple Pages other Word Processor table environments 26 TRXNICLE A User s Manual 10 11 14 Reference The Editor Menu begin table htdp begin center begin tabular c c hline amp i hline E hline amp hline end tabular end center caption New Table label tab newTable end table Figure 4 11 A table inserted by TEXNICLE provides a quick shortcut to inserting math mode with a place holder in the middle More useful is the keyboard shortcut NX 3 M will allow you to jump within the open document to a particular line or character The keyboard shortcut is 88 L Line indentation comment level and jumping between placeholders is all manageable from this menu 2 Appendix A Keyboard Shortucts This chapter lists all of the keyboard shortcuts available in
12. ee ES E 25 49 2 Paste as Table 26 4 9 3 Other Edit Menu Functions a a a a a a a 26 4 10 The Editor Meda 26 A Keyboard Shortucts 28 Chapter 1 Introducing TpXnicle TEXNICLE is an editor and project manager for producing documents using IFEX and similar typesetting languages TEXNICLE has been under development since 2010 and is intended to provide a fast feature rich environment for writing BIFX documents under Mac OS X Employing all the features of modern Mac OS X applications TRXNICLE fits right at home on a Mac One of the main design drivers for TEXNICLE was to produce an editing environment similar to Xcode the development environment Apple provides for building applications on Mac OS X 1 1 In This Manual This manual is split into four chapters The first two are just to get us started This intro duction and a discussion of installation and requirements in Chapter 2 Chapter 3 is a User Guide that covers typical usage scenarios and introduces the basic concepts used throughout TEXNICLE Chapter 4 is an in depth reference guide to TEXNICLE s features 1 2 Development The developer Martin Hewitson is a British physicist who works on TeXnicle in his spare time For more information please visit his website To report bugs or request new features please send him an email The primary author of this manual is Brian L Cansler linguist by day avid TEXNICLE user by night For more information plea
13. end quote Se Co Wm A de Figure 4 9 Code folding before and after When an environment is folded the fold icon turns red Notice the jump in line numbering following a fold as well The yellow ellipsis icon between begin and end is another indicator that code has been folded One advantage to having code folding activated is that begin commands without matching end commands are marked with a red X over the code folding arrow XI begin quote If there s no end command that matches a given begin command a red X appears M A A Figure 4 10 An unmatched begin command 4 9 The Menu Beyond Undo Select All and Speech the menu has a few tricks up its sleeve that should be highlighted as they are some of TEXNICLE s most powerful features 4 9 1 After copying an image to the pasteboard you can insert it into TEXNICLE in a figure environment quickly and easily under or with the keyboard shortcut 8 V You will be asked to name the image and save it on your hard drive after that your image will be inserted in a stock Figure environment In a project the image will automatically appear under the last folder in your project tree that was selected If you want the image to be loaded into a particular folder click the folder before pasting the image If you forget to do this drag the image within the project file list to the desired folder 29 EE EEE 4 9 2 Paste as Table Similarly to pasti
14. engine on the selected document or project This will update the Integrated PDF Viewer and as expected overwrite any auxiliary and output files in the project folder The button will typeset your project using the chosen engine and then open the external PDF viewer will simply open the external PDF viewer without typesetting 3 2 2 Main Editing Window The second part is the main editing window located in the center Fonts colours syntax highlighting line break length and much more can be changed under and Preferences X Font amp Colors This is where you will write your document In project windows there is a bar of tabs above the main text window which shows all open documents in the project Below the tab bar if applicable is a bar which will allow you to jump to any section or bookmark in the open document quickly This is called the Jump Bar and its features are detailed in section 4 7 To the left of this bar is the syntax indicator green indicates that there are no syntax errors in the open document while red indicates there is at least one error Clicking the indicator will display the line numbers descriptions and samples of the offenses To edit what offenses the chktex engine looks for look under Typesetting Syntax Checking Synctex support If you are typesetting with an engine which supports synctex many of the built in engines do then you can jump from the location in the text editor to the locati
15. er Preferences X Typesetting you can set the default engine that is used for new projects and documents You can also specify default values to some of the configuration variables that are passed on to the engines Not all engines support all configuration variables 4 3 Spell Check Spell checking is a key feature of TEXNICLE Using http cocoaspell leuski net a Mac OS X implementation of Aspell TEXNICLE can check the spelling of TEX documents while ignoring BIFX commands and their arguments We suggest that you download and install cocoAspell from the developer turn on TEX ETEX awareness for your chosen dictionaries 19 TRXNICLE A User s Manual Reference Creating Project Templates and tell TEXNICLE to use your chosen cocoAspell dictionary when checking your project This setting is found under the Project Settings tab in the Navigator pane Spelling checks are conducted every five seconds in documents that have undergone changes since the last check and the results are populated under the Spelling tab of the Index part of the Navigator pane Only files marked to check spelling under will be checked 4 4 Creating a New TpXnicle Project Template After you ve laboured for weeks or months setting up your project so that it has everything you need to work from entirely within TEXNICLE you may decide to save a version of your project as a project template so you can base other projects on it in the future without
16. file X 8 A Add existing folder O XH E M Insert in line math mode JH L Go to line 88 Increase indentation 8 Decrease indentation JH Toggle comment for the current line JH EJH Increase comment level 88 Decrease comment level 88 2 Jump to next placeholder DAA Jump to previous placeholder 30 TEXNICLE A User s Manual Keyboard Shortucts R Typeset project or document 4 3 R Typeset and view project or document in stand alone PDF viewer 88 J K Trash auxiliary files 38 M Minimize window XH 8 71 Toggle Focus Editor PDF 0 38 W Close tab D X 3 WJ Close all tabs 38 Select next tab 38 Select previous tab 38 1 Select first tab 38 2 Select second tab 38 3 Select third tab 38 4 Select fourth tab 38 5 Select fifth tab NX 8 C Open the console 38 Q Quit TEXNICLE ol
17. g project This means that changing the default typesetting engine for example under this preference pane will not affect the engine used for any existing projects that option is changed in the Project Settings tab of the Navigator on a by project basis There are many options for syntax checking are possible These are done with the chtex binary from your BIFX installation The path for this may need to be re configured if you do not have a stock installation of MacTeX on your machine Syntax checking can be turned on and off from this tab under the Typesetting preference pane Typesetting engines are edited and created under the Engines tab of the Typesetting pane Everything that has to do with engines is discussed in section 4 2 The Trash tab in the Typesetting pane allows you to define which file types aux log bbl out dvi ilg ps and so on are deleted when using the Trash Aux Files feature 4 1 3 Fonts amp Colors This section allows you to change the colours used to highlight EIEX syntax the colours used in the editor window and the fonts used in the editor window and the console Three levels of differentiation in comments using the symbol and three levels of markup text that should be edited later marked with lt and gt are possible Note There is an option to colour multi line arguments under this tab While this function may be desirable please note that it is very taxing for TEXNICLE and may
18. hs to scripts use for creating preview images for the palette and library code clippings Default paths are set up based on a standard MacTeX installation but these may need to be rewritten if your system has a different installation 4 1 7 File Types This preference pane includes a list of files that TEXNICLE will recognize as TFX files You can toggle which documents have syntax highlighting enabled and which files are spell checked for more on spell checking see section 4 3 By default the following file types are included tex bib sty cls bst 4 2 Engines TEXNICLE has configurable engines If you don t need any specialized compiling capabilities you can simply use the engines supplied by TEXNICLE by default If you need more indi vidualized engines however you can create your own TEXNICLE engines are simple scripts which reside in Library Application Support TeXnicle gt engines A number of variables are passed to these script files from TEXNICLE If you create a new engine the template is preconfigured with the necessary variable set To start making a new template click New under Typesetting Engines Note You can only edit engines that you have created yourself Every time TEXNICLE opens it rewrites the default engine files to their former unchanged version To customize a built in engine use the button under Typesetting X Engines You can then edit the engine script and save it as a new engine Und
19. king the button two options are given New clip and New from pasteboard The former will open a new clipping in the list double click to edit The latter will automatically create a clipping based on copied text Once your clip has been created it s a good idea to set a command for the clip for easy access This is done in the third panel of the clipping library To use a clipping by invoking the command type command shortcut into the editor window For example to insert a table into your document quickly and easily type tttb1 in the editor window where you want a new table to appear If the shortcut command is valid it will be highlighted in yellow as in Figure 4 3 Note When you create your own commands the symbol should be excluded from the Command input field For example to create a shortcut that will work by typing shortcut you should input only shortcut in the Command field of the clipping editor 2i TRXNICLE A User s Manual Reference Clippings Library m Almi A o Categories Mathematics Math Text Styles Text Sizes Text Styles Lists Inserts Floats Examples ENA 38 Clip Code paragraph p paragraph subparagraph subparagraph section sect 1 section subsection 0 1 subsection e 8 Command No Selection Figure 4 2 The Clippings Library pane 3 4 This is where want to insert a table tbl The tab
20. l allow you to search your system for a file you wish to open 4 New BTFX File will create a new TFX document A menu will appear with template options or you may opt to open a blank document See section 3 2 6 3 2 Quick Start eeo Toolbar CIMA jalm 2 Bo RE EB search ror JHE it Integrated Me j PP PDF Viewer Navigators Mal n Ed IT ng Window Console Figure 3 2 A new window in TEXNICLE The TEXNICLE window is divided into five major panes which are described below The Navigators pane the Integrated PDF Viewer and the Console may all be hidden and shown from the menu Window menu for the Console at the top of the screen 3 2 1 The Toolbar Figure 3 3 shows the standard toolbar in TRXNICLE The toolbar includes quick access to functions that will allow you to typeset your project and open them using the built in PDF viewer In the center it has a console window with status updates on the compilation of your document or project Auxiliary files are trashed TEXNICLE A User s Manual User Guide Quick Start 600 1 Texnicle User Manual texnicle La i Completed build of Users _ anual Texnicle User Manual So F Typeset Build amp View View Trash Aux Files Figure 3 3 TEXNICLE s toolbar with the button on the right If the current document is not included in a project there will also be a button in the toolbar to add that file to an existing project The button or 38 R will run your chosen
21. le will appear s in this location as soon as press the enter key after the code 6 Figure 4 3 A valid clip from the library will turn yellow Once the shortcut command turns yellow press to insert the clip The ben command shortcut for an enumerate environment will yield the something like Figure in the editor Some clippings like that in Figure 4 4 have placeholders that can be replaced by the user These look like the bubbles item1 and item2 in the figure In clippings you define yourself include placeholder text by enclosing the text in symbols For example to create a shortcut for text in small caps the smallcaps command we will create a new clipping that contains textsc smallcaps When the clipping is used perhaps with a command we define such as sc the word smallcaps will appear in a placeholder as in Figure below 22 TRXNICLE A User s Manual Reference Jump Bar This is what ben produces item 3 4 5 6 beginfenumerate 7 i 3 Vitem 9 end enumerate 11 Notice the item placeholders Figure 4 4 An expansion of the code for an enumerate environment 3 4 When type sd and press enter this is what appears in the editor 5 6 textsc 8 can now click the placeholder and easily replace the argument 9 Figure 4 5 After defining a placeholder this is the output 4 7 Jump Bar The Jump Bar is located at the top of the editing window between
22. letion list however the completion list may still be viewed by clicking or by pressing The Commands tab is also where you can define custom commands that will appear in this menu The second tab controls citation completion When any citation command either a default command like cite citet etc or a custom command like cites is typed TEXNICLE will show a list of possible citations that match the key you have typed between the braces based on the bibliography files referenced in your document As with command completion this function can be turned on and off at will The third tab References does the same thing for label and ref commands When typing ref or a similar referencing command defined by the user and added to this list a list of labels within the document or project matching what you have typed will be displayed This can be turned off The File tab does the same thing for input and include commands which can be turned off The tex file extension is left off as expected Finally the Begin tab controls an autocomplete list for beginfenvironment commands Default environments are included but you may add to or delete from this list as you wish You can also ask TEXNICLE to auto insert an end environment command when you input a carriage return after beginning an environment 18 TEXNICLE A User s Manual Reference Engines 4 1 6 Palette amp Library This section controls the pat
23. ng as an image TEXNICLE can convert copied Microsoft Excel cells on the pasteboard as a HEX table by choosing keyboard shortcut X 88 V You will be asked to select the delimiting character It is important to remember that while this feature correctly formats the table itself it does not format the text Any text formatting such as correcting Unicode accents replacing special characters and editing punctuation will need to be done by hand Note Choosing the tab delimiter will correctly paste the table from Apple Numbers and Microsoft Excel but other programs and formats may require other delimiters If your table doesn t paste correctly try pasting with a different delimiter 4 9 3 Other Menu Functions A few other goodies are included in under that should be briefly mentioned keyboard shortcut 2 Q is useful when lines are set to hard wrap rather than soft wrap under Preferences General Reformat Paragraph deletes hard wrap editor line breaks to typeset the entire selection on a single editor line Lines in the editor still wrap as expected at the set number of characters will attempt to complete the word or command you have started typing It s easily found by pressing 9 Edit X Quick Spell also accessible with the keyboard shortcut A Space will pull up a list of words that TEXNICLE thinks you may be typing based on the characters you have al ready typed This is similar to Sm
24. nual Project Information mo A m 2 B0 8 mA Dile Y gt Expand All Collapse All vw Dog DD Grammar Anaphora tex 5 chap anaphora ana refl 3sg refl obj ana emph ana recip ama lantar Figure 3 10 Project Information The final component is the Project Settings tab which appears for all documents and projects It allows you to choose the engine used to compile your document whether to run bibtex and ps2pdf how many times to run latex and more The settings chosen in this panel will stay the same for a project or document regardless of any changes made in the Preferences pane Changes in the Navi gator govern the open document or project whereas changes in Preferences govern new documents and projects User Guide Quick Start The sixth component is the Project Infor mation tab represented by a lowercase let ter i This tab appears for both projects and for stand alone BIFX documents This contains many important features a list of coding errors a list of misspelled words a list of labels a citation list and a list of new commands that have been declared in each document using newcommand and renewcommand In a stand alone document this shows everything for the open file for a project this shows information for every document in the project Projects also in clude a tab within this section for project bookmarks Project Settings mA hf Q Hie Engine latex Open console
25. oaded here Chapter 3 User Guide This chapter focuses on how to use TEXNICLE for common tasks It will start with the basics and move through the most important features A more comprehensive description of all the bells and whistles can be found in chapter 4 3 1 Welcome Screen The welcome screen is shown in Figure 3 1 Welcome to TeXnicle Recent Files 1 New Project Dog DD Grammar texnicle Texnicle User Manual texnicle ApplekeyTest tex Dog DD Grammar Focus nterrogation tex Resume 17 Jul 2012 tex Starbucks Superisor Cover Letter tex EM New LaTeX File A gt Open Exist pen Sting BiNas ACAL43 Proceedings tex Last Opened 25 7 12 9 07 AM Users briancansler Documents LaleX Te ser Manual Texnicle User Manual texnicle Figure 3 1 TEXNICLE s welcome screen TEXNICLE A User s Manual User Guide Quick Start When opening TEXNICLE for the first time or when opening the application without loading an existing document the welcome screen will be displayed It has four major components 1 Recent Files on the left displays a list of the files most recently opened with TRXNICLE These files can be opened by selecting the file and clicking at the bottom or by double clicking the file name 2 New Project on the right will open a panel to walk the user through creating a new project This is described in section 3 2 7 3 Open Existing will open the familiar Mac OS X dialogue box that wil
26. on in the PDF viewer by doing 38 left mouse click in the editor Similarly you can jump from the current PDF location to the position in the editor by doing 38 left mouse click in the PDF viewer TRXNICLE A User s Manual mjali Q A 4 User Guide Quick Start Alm H o Figure 3 4 Icons in the Navigators pane projects on the left stand alone ITEX documents on the right 3 2 3 Navigators Pane To the left of the window is the Navigators pane which includes seven subcomponents five in non project windows These are shown in Figure 3 4 Project Tree mai A hf Qh 9 Dog DD Grammar Master tex Fs gt Dog DD Grammar Preamble tex Front Matter Body Dog DD Grammar Introductior Dog DD Grammar Sketch tex Dog DD Grammar Phonology t Dog DD Grammar NPMorpholc Dog DD Grammar Compounds Dog DD Grammar NP5tructure Dog DD Grammar Coordinatio b p m P Br bip ip ip Dog DD Grammar Postpositior Figure 3 5 The Project Tree in the Navigator The first icon a folder is the Project Tree It shows the tree view of your project and so it does not appear in non project windows All of the project s components files pictures bibliographies folder organization etc are listed here The main file of the project is in bold and it is this file that will be com piled when compiling your project Compo nent files are listed in unbolded black and files with unsaved changes are greyed ou
27. pane which appears at the bottom of the screen When typesetting your document this pane will show the output of the compilation commands You can choose whether to show all messages from the console errors only or TEXNICLE messages only Just as the Integrated PDF Viewer has a stand alone version you can set the Console to appear in a separate window upon typesetting under the Project Settings tab of the Navigator 3 2 6 Creating a New BT F X File Whether a new T X file is created from the welcome screen from New Standalone ATEX File or by pressing se J N a new window will appear with a template selection dialogue box Select one of the pre existing templates from the list shown if you choose you may also edit the code before opening the document using the preview window below the list Alterna tively you may create a new template by clicking the icon below the list similarly the icon deletes templates The templates included are Empty contains no code It s a blank slate Section a document for a new section Custom a blank template in which you may create a custom template Article creates a document with a useful preamble for the Article class Book creates a document formatted for the Book class Report creates a new document in the Report class Beamer creates a new Beamer presentation Once you have chosen a template enter a name for the new document and click Select 3 2 7 Creating a
28. r Note will create a new file but you must specify its extension This function will not create a TFX file unless you add the extension manually a J A will allow you to search your computer for an existing file to add to your project You will be given the option to copy the file to the project folder or simply to reference it from afar Similarly X A will allow you to add an existing folder These functions are also available in the menu or by clicking the gear in the bottom right corner of the Navigators pane Changing the main document of your project can be done through the menu or by clicking the document in the Project Tree that you want to set clicking a file in the Project Tree view will also allow you to rename remove or reveal the file 4 6 The Clippings Library The clippings library is one of TEXNICLE s most economical features Becoming familiar with clippings and customizing your library is a great way to save time and effort while preparing your document Recall the Clippings Library window in the Navigators pane To add a category of clippings click the button under Categories For example the category Examples in Figure 4 2 was a custom addition To add a clipping to an existing category click the button under the list of clippings To edit a clipping double click the code Adding clippings is as easy as writing the code and then pasting it into a new clipping After clic
29. r resources From Tempate creates a new TEXNICLE project from an existing project template 4 Build Project creates a new TEXNICLE project containing the files referenced by a main file using input and include commands You may choose either a TEX file or a directory If a directory is chosen the main file used is the first file found with a documentclass command TEXNICLE will then create the project based on your selection 15 Chapter 4 Reference This chapter will take an in depth look at most of the bells and whistles of TEXNICLE 4 1 Preferences Access the preference pane just like in any other Mac application or if you prefer keyboard shortcuts amp will open the window There are seven preference categories General Typesetting Fonts amp Colors Templates Commands Palette amp Library and File Types 4 1 1 General Several important features are included under the General pane You can set the number of characters per line at which point the line will wrap Alternatively you can turn wrapping off When pressing the Tab key a tab is inserted into the document this behaviour can be changed from the General tab to insert any number of spaces instead TEXNICLE can insert closing braces automatically when an opening brace is typed if you so choose You can also opt to skip closing braces which means that when the cursor is set immediately before a closing brace
30. se visit his website To report inaccuracies or suggest changes please send him an email Chapter 2 Installation Setup and Requirements TEXNICLE is designed to run on 64 bit machines running Mac OS X 10 6 8 Snow Leopard 10 7 Lion or 10 8 Mountain Lion There are currently no plans to support previous ver sions of Mac OS X or to support Windows operating systems TEXNICLE is a free application and will remain so TEXNICLE expects you to have an installed BIFX typesetting system on your machine By default TEXNICLE is set up to work with installations of MacTeX located on the hard drive of your computer If you have an alternative TRX installation you may need to set up some new paths In particular you may need to copy and edit one or more of the built in engines that TRXNICLE uses to typeset documents this is described in section 4 2 Note Computers that run BTFX from a central source on a network like those found in many academic institutions may also require tweaking of certain paths As each network is set up differently please contact your network administrator for instructions on how to do this In addition to the engines described above TEXNICLE uses some commands for typesetting code snippet previews These are set under Palette amp Library and are discussed further in section 4 1 6 132 bit machines are no longer supported by TEXNICLE Beta versions of TEXNICLE that did support older machines can be downl
31. t Group folders groupings of files that appear in TEXNICLE but not on the disc are grey as in Figure 3 5 disc folders folders that do exist on the disc are in blue Folders may be collapsed and expanded as needed To move items into out of and between fold ers simply drag and drop 38 Lelick any file to set it as the main file remove it from the project rename it or reveal it in the finder 88 Lclick a folder for the same options and a few others like adding existing files Use the shortcut 38 NX 1 to access the Project Tree quickly Symbol Palette Setting defaults for files that should be trashed is done through Preferences Y Typesetting Trash Note that a project may only have one main file at a time so setting a new main file will set it as the only main file TRXNICLE A User s Manual The second icon is a delta symbol A which opens the Symbol Palette The category of symbols shown may be changed using the drop down menu at the top and the sym bol may be dragged into the open document double clicked or inserted using at the bottom Categories include common foreign symbols accents greek letters arrows and a number of various mathematical subgroups The slider at the bottom changes the size of the symbols The Symbol Palette can be opened quickly using 88 X 2 User Guide Quick Start QQ H amp Foreign mi Al TE a F LE joe laa i i r r
32. the Navigators pane the first sub tab will display all bookmarks in the project grouped by file Double click a bookmark to jump to that part of the document At the top of the editor window the Jump to Section drop down menu will show the bookmarks in the current document in relation to labeled sectioning commands in the open document Both locations are shown in Figure 4 8 A iv Section 1 Development line 10 Here s bookmarked text section Section label Label Here s sample text section Development Mi Here s bookmarked text Figure 4 8 Bookmarks in TEXNICLE shown in the Navigator pane on the left and the Jump to Section menu at the top of the editor window Note that this feature marks the line number not the text For example if you add five lines before a bookmark on line 20 the bookmark will remain at line 20 while the text that used to be marked will now be located at line 25 Bookmarks work better if line numbering is turned on this is controlled under General Another useful feature of TEXNICLE is code folding Environments enclosed by begin and end commands may be collapsed using the arrow buttons between line numbering if it s turned on and the editor window as in Figure 4 9 24 TRXNICLE A User s Manual Reference The Edit Menu begin quote This section will be collapsed in the next figure allowing you to see the change in line numbering end quote D A B Co begin quote
33. the syntax indicator on the left and two buttons and unfold all This bar allows you to jump to any labelled section in the visible document from part to subparagraph Furthermore the button to the right allows you to instantly mark up text with commented notes that appear in the Jump Bar section tex introductio conclusion MyArticle_ bspline eps citations bi A Y Jump to section unfo line 21 tithe Brief Article E some two My Section 34 paragraph two 36 input introduction 38 AAMARK My Section Figure 4 6 The Jump Bar The following options are given to mark up text for the Jump Bar to find This is a powerful feature of TEXNICLE that can save you valuable time and energy hunting for particular lines 23 TRXNICLE A User s Manual Reference Bookmarks and Code Folding bspline eps citations bib gt oa Qs FIGURE TABLE LIST EQUATION Figure 4 7 Jump Bar markup 4 8 Bookmarks and Code Folding Two of TEXNICLE s features are found along the left side of the editor window Bookmarks are a useful feature of TEXNICLE that allow you to jump between different parts of your project quickly and easily Click the line number of the line you want to bookmark and a blue arrow will appear Click it again to delete the bookmark Alternatively the keyboard shortcut 38 D will toggle the bookmark on a line Under the Information tab of
Download Pdf Manuals
Related Search