Online Documentation
Copyright (c) 2007 Danilo Stélio Manhiça
ScientificAuthor is a visual LaTeX editor for mathematicians, scientists, and engineers targeting the LaTeX document preparation system. With Scientific Author structured documents can be edited and it converts them to LaTeX format files, which can later be processed by software like MiKTeX. Support for MiKTeX is built into Scientific Author. |
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Scientific Author installs automatically on Windows machines. To install Scientific Author download the setup file from www.scientificauthor.com and run it on your computer. An automatic uninstallation mechanism is also provided. When performing version upgrades first uninstall the version in use. |
For Scientific Author to work correctly on your computer certain hardware and software requirements must meet. |
|
The following operating systems are supported
For LaTeX DVI, PostScript, and PDF, it is recommended that MiKTeX system be installed. |
The ScientificAuthor graphical user interface is very similar to most Windows programs' user interfaces. The picture below illustrates the user interface components.
|
The ScientificAuthor program has the "File" menu, the "Edit" menu, the "View" menu, the "Style" menu, the "Insert" menu, the "Tools" menu, the "Window" menu, and the "Help" menu. In this sub section all the menu items and their actions are described. |
The "File" menu is illustrated in the picture below, and is used to save and load files and perform exports. The functions of the "File" menu items are explained in the table below.
|
The "Edit" menu is illustrated in the picture below and is used to undo and redo actions, copy and paste content, and perform searches and replacements. The "Edit" menu is illustrated by the picture below. The functions of the "Edit" menu items are explained in the table below.
|
The "View" menu is used to zoom, toggle toolbars, and view the document structure navigator. The "View" menu is illustrated by the picture below. The functions of the "View" menu are explained in the table below.
|
The "Style" menu is used to select content styles, to select environments, to select theorem environments, to select equation numbering styles in in the document editing process. The picture below illustrates the "Style" menu. The functions of the "Style" menu are explained in the table below.
|
The "Insert" menu is used to insert LaTeX constructs into the document. The picture below illustrates the "Insert" menu. The functions of the "Insert" menu are explained in the table below.
|
The "Table" menu is used to manipulate tables and tabulars - to expand, and delete cells. The functions of the "Table" menu are explained in the table below.
|
The "Tools" menu is used to activate the spell checker and perform the publishing operations. The picture below illustrates the "Tools" menu. The functions of the "Tools" menu are explained in the table below.
|
The "Window" menu is used to organize document windows on the screen. The picture below illustrates the "Window" menu. The functions of the "Window" menu are explained in the table below.
|
The "Help" menu is used to access the ScientificAuthor program documentation, and to perform the software license registration. The picture below illustrates the "Help" menu. The functions of the "Help" menu are explained in the table below.
|
The ScientificAuthor program has the the main toolbar, the format toolbar, the maths toolbar, and the symbols toolbar. |
The main toolbar allows main functionality like quick access to file saving and file opening, clipboard, undo and redo, search, spell checking, insert tabulars and tables, insert pictures, insert footnotes, and margin notes, group and ungroup content, LaTeX publishing tools, and help.
|
The format toolbar allows functionality like quick access to content styles; font size formatting, bold, italic and underline formatting; accents and international characters, math and text mode, superscript and subscript formatting; text alignment; bulleted and enumerated lists; and indenting.
|
The math toolbar allows functionality like access to math templates.
|
The math toolbar allows functionality like access to math templates.
|
This section looks at the features in ScientificAuthor that enable editing of LaTeX 2e documents. We will look at formatting chapters, parts, and sections; inserting footnotes and margin notes; inserting cross references; and formatting list environments, theorem environments, and equation numbering. |
To format parts, chapters and sections use the "Style" menu. If you have written a line of text which you intend it to be a Section heading like on the figure below.
Then place the caret (cursor) on the line and click on the menu item Style -> Section. The line will change its format and will be numbered automatically and you will have a document formatted like what is displayed on the figure below.
|
To apply list environments formatting to text select the text as in the figure below.
After selecting the text click on the menu item "Style -> Bulleted" and the itemized list environment will be applied to the text selection, and the text will be like on the figure below.
Alternaly place the cursor on the line that is desired to be a list environment item, and click on the menu item "Style -> Bulleted" |
To format text as paragraph select the text, and the click the menu item "Style -> Paragraph". Alternatively move the caret (cursor) to the line intended to be a paragraph and click the menu item "Style -> Paragraph" To format text as sub paragraph select the text, and the click the menu item "Style -> Sub Paragraph". Alternatively move the caret (cursor) to the line intended to be a paragraph and click the menu item "Style -> Sub Paragraph" |
To apply the quote environment to a piece of text first select the text as in the figure below.
After selecting the text, click on the menu item "Style -> Quotation" and the text will be formatted like on the figure below.
Alternatively, place the caret (cursor) on the line intended to become an Quote line, and click on the menu item "Style -> Quotation". |
To apply the abstract environment to a piece of text first select the text as in the figure below.
After selecting the text, click on the menu item "Style -> Abstract" and the text will be formatted like on the figure below.
Alternatively, place the caret (cursor) on the line intended to become an Abstract line, and click on the menu item "Style -> Abstract". |
To insert blibliography items place select the text that contains bibliography information.
After selecting the text, click on the menu item "Style -> Bibliography" and the text will be formatted like on the figure below.
A box appears at the beginning of each bibliography item where the item key can be written for use with citations. Write the bibliography item keys and you should end up with text like in the figure below:
To insert a citation go to the click the menu item "Insert -> Citation" and a citation object will be inserted in the document as shown in the figure below.
In the citation object write the bibiography item key to which it should refer. When the LaTeX document is compiled the bibliography items, and citations will be automatically numbered. |
Scientific Author has support for title, author and date content formatting through the "Style" menu. Format the text according to the desired content style, and then insert the \maketitle command through the "Insert" menu. And you should get a document like what is illustrated on the figure below.
|
To apply the theorem environment to a piece of text first select the text as in the figure below.
After selecting the text, click on the menu item "Style -> Theorem -> Theorem" and the text will be formatted like on the figure below.
Alternatively, place the caret (cursor) on the line intended to become a Theorem line, and click on the menu item "Style -> Theorem -> Theorem". All other theorem environments are applied in the same manner described in this section. |
To insert a table place the caret (cursor) in the position where you want the table to be inserted in the document. Then click the menu item "Insert -> Table" and a dialog box will appear where you may select the number of rows and the number of columns of the table as shown in the figure below.
After selecting the number of rows and columns click "OK" and a table will be inserted in the document and you may type in the table caption and in the cells of the table. The inserted table is shown in the figure below.
|
To insert figures place the caret (cursor) in the desired location for insert of figure, and click the menu item "Insert -> Picture", and an Insert Picture dialog box will appear as the figure below illustrates.
When the Insert Picture dialog box appears click the browse button to select the picture file, and select whether the figure has a caption or not. Then click the "OK" button and the figure will be inserted in the document as illustrated in the figure below.
|
To insert footnotes place the caret (cursor) in the desired location for insert of a footnote, as illustrated by the figure below.
Then click on the menu item "Insert -> Footnote" and a footnote object will be inserted in the document as shown in the figure below.
After the footnote object is inserted in the document you may type the footnote text in the footnote cell. A margin note may be inserted in the same manner through the "Insert" menu. |
Scientific Author allows cross referencing by inserting a label object, and then inserting a reference object. In the following subsections we look at how to cross reference sections, tables, figures, and equations. |
To cross reference a section we must type the section header as shown in the figure below.
Then click the menu item "Insert -> Reference -> Label" to insert a label object for the section. And a label object will be inserted in the document, and you must type the label id in the object cell as shown in the figure below.
To cross reference the section type text in the document, as shown in the figure below.
And click the "Insert -> Reference -> Cross Reference" menu item to insert the cross reference object in the document, and type the section label id in the cell of the inserted object in the document as shown in the figure below.
When the MiKTeX program is invoked to produce the DVI or PDF the label and cross reference objects will be automatically numbered. |
To cross reference a table, insert the table object, and edit the table. You should end up with a document like on the figure below.
While the caret (cursor) is in a table cell click the "Insert -> Reference -> Label" menu item, and it will insert a label object associated with the table as shown in the figure below.
Please note that when the inserted label object is being edited the associated table will have the corners marked to show the association between the current document object which is the label and the table that owns the label. Then a cross reference can be inserted as explained earlier. |
To insert an index item type the text, then select the position in the text where the index item should be inserted and click the menu item "Insert -> Index". An index object will be inserted in the document, and type the index key in the index object as shown in the figure below.
Later in the document use the "Insert -> Print Index" menu item to insert the \printindex command in the desired location of the document. When LaTeX is compiled to build DVI or PDF, the document index part will be automatically produced by the LaTeX system. |
To insert table of contents use place the caret in the desired location in the document and use the menu item "Insert -> Table of Contents" and a LaTeX \tableofcontents command will be inserted in the document. When LaTeX is compiled to produce DVI or PDF, a table of contents part will be inserted automattically into the document. |
To insert accents and international characters activate
the international character toolbar by clicking the
|
To edit equations click the
To number the equation click on the menu item "Style -> Equation -> Numbered" and an equation will be numbered as shown in the figure below.
|
This section looks at the "Tools" menu which provides spell checker and dictionary, and publishing features such as LaTeX DVI build and LaTeX PDF build. |
Scientific Author includes a dictionary and spell checker, which is accessible through the "Tools -> Spell Checker" menu item. The dictionary is a combination of American English, Canadian English and Brittish English words. When using the spell checker a dialog as the one in the figure below will be displayed:
Scientific Author will provide in a list box suggestions for miss-spelled words and by clicking on one of the available buttons the user will be able to:
|
LaTeX DVI build is available in Scientific Author through the menu item "Tools -> LaTeX". Scientific Author abstracts the MiKTeX "latex" command to compile the LaTeX source and build DVI files. Scientific Author first runs the "latex" command, then runs the "makeindex" command, and then runs the "latex" command again. This is due to cross references and indexes that could be in the document. When using the DVI build, it is recommended that images of the EPS (Encapsulated PostScript) format be used in the document. |
LaTeX PDF build is available in Scientific Author through the menu item "Tools -> PDF LaTeX". Scientific Author abstracts the MiKTeX "pdflatex" command to compile the LaTeX source and build PDF files. Scientific Author first runs the "pdflatex" command, then runs the "makeindex" command, and then runs the "pdflatex" command again. This is due to cross references and indexes that could be in the document. When using the PDF build, it is recommended that images of the GIF and JPEG format be used in the document. |
Scientific Author is shareware software. The software is not free, it may be used for a 30 day evaluation period, after which it requires license payment. Licenses are available in individual licenses, and site licenses. For payment of licenses visit the official product website at http://www.scientificauthor.com.
|
An individual license for the Scientific Author
product authorizes the individual to use the editor. |
A site license for the ScientificAuthor software
product authorizes employees at only one site in a company or organization to
use the software. A site is defined as a distinct mailing address. The software
may be installed on any computer located at the site and access may be granted
to any and all employees of the company who have offices and work out of the
licensed site. |
Scientific Author is copyrighted software, it is the dedicated work of an individual. Scientific Author is the work of Danilo Stélio Manhiça and fonts and components by other vendors were incorporated into the project. |
This computer program is protected by international law and copyright treaties. Unauthorized reproduction or distribution of this program, or any portion of it may result in severe civil and criminal penalties, and will be prosecuted to the maximum extent possible under law. |
Scientific Author uses BaKoMa TeX fonts supplied by Basil K. Malyshev. Some fonts were modified by Danilo Stélio Manhiça. |