Difference between revisions of "Working with latex frames"

From Scribus Wiki
Jump to: navigation, search
m (Added image)
Line 1: Line 1:
 
{{HOWTO Index}}
 
{{HOWTO Index}}
  
This article is intended to be a compilation of operations pertaining to LaTeX frames.
+
This article is intended to be a compilation of operations pertaining to LaTeX frames. The incorporation of LaTeX is a work in progress, in other words, not completely implemented, and also is available only in the development versions of Scribus (1.3.5svn).
 
{{Working_with_toc}}
 
{{Working_with_toc}}
  
 
== Configuration ==
 
== Configuration ==
First you have to configure the path to your latex executable. Go to File -> Preferences -> External Tools and set the pathes for the latex executable and your editor. The easiest way to do this is to click on "Rescan" and all required values are filled in automatically.
+
First you have to configure the path to your LaTeX executable. Go to File -> Preferences -> External Tools and set the paths for the LaTeX executable and your editor. The easiest way to do this is to click on "Rescan" and all required values are filled in automatically.
  
 
=== Manual configuration ===
 
=== Manual configuration ===
 
'''Note:''' Manual configuration is only required if something goes wrong or you want to do something special. First try the autoconfiguration by clicking "Rescan"!
 
'''Note:''' Manual configuration is only required if something goes wrong or you want to do something special. First try the autoconfiguration by clicking "Rescan"!
 
If you want to manually configure an other LaTeX executable type in the path, but make sure that the following requirement is met:
 
If you want to manually configure an other LaTeX executable type in the path, but make sure that the following requirement is met:
* The output must be in a format that scribus can display in an image frame. (for example PNG, JPEG, PostScript, PDF) This means that you can't use plain LaTeX, because it produces DVI output.
+
* The output must be in a format that Scribus can display in an image frame. (for example PNG, JPEG, PostScript, PDF) This means that you can't use plain LaTeX, because it produces DVI output.
  
 
You can use the following placeholder in your commandline:
 
You can use the following placeholder in your commandline:
Line 18: Line 18:
  
 
=== Preamble ===
 
=== Preamble ===
All latex documents are automatically prefixed with an preamble which you also can configure in this dialog. Normaly the predefined text should work, but you can input any valid latex source. If you want one frame not to use the globaly defined preamble then you don't have to delete it, but you can disable it on a per frame basis. (see section "Specials" for details)
+
All LaTeX documents are automatically prefixed with an preamble which you also can configure in this dialog. Normally the predefined text should work, but you can input any valid LaTeX source. If you want one frame not to use the globaly defined preamble then you don't have to delete it, but you can disable it on a per frame basis. (see section "Specials" for details)
  
== Placing latex frames ==
+
== Placing LaTeX frames ==
Select the [[Image:Latex-button.png]] item from the toolbar and then draw a frame where you want your formula to be placed. After some seconds a default latex file should be rendered. This contains some sample code to make the process of creating your own code more easy. Now you can right-click your frame and select "Edit Latex Source". Depending on your settings either the programm you specified as the external editor or the internal one are started.
+
Select the [[Image:Latex-button.png]] item from the toolbar and then draw a frame where you want your formula to be placed. After some seconds a default latex file should be rendered. This contains some sample code to make the process of creating your own code more easy. Now you can right-click your frame and select "Edit Latex Source". Depending on your settings either the program you specified as the external editor or the internal one are started.
  
 
=== External editor ===
 
=== External editor ===
Just type your latex code, but remember: The preamble and the end is added automatically during processing. So only add the parts between
+
Just type your LaTeX code, but remember: The preamble and the end is added automatically during processing. So only add the parts between
<pre>\begin{document}</pre> and <pre>\end{docoument}</pre>See the Section "Latex Documentation" for details about the latex syntax.  
+
<pre>\begin{document}</pre> and <pre>\end{docoument}</pre>See the Section "Latex Documentation" for details about the LaTeX syntax.  
  
 
=== Internal editor ===
 
=== Internal editor ===
Line 31: Line 31:
  
 
== Specials ==
 
== Specials ==
There are some specialcodes to access scribus values from your latex document. They all look like this: '''$scribus_XXX$'''
+
There are some special codes to access Scribus values from your LaTeX document. They all look like this: '''$scribus_XXX$'''
  
 
The following variables are available:
 
The following variables are available:
Line 46: Line 46:
  
  
== Latex Documentation ==
+
== LaTeX Documentation ==
 
* http://www.ctan.org/tex-archive/info/lshort/
 
* http://www.ctan.org/tex-archive/info/lshort/
 
* http://www.maths.tcd.ie/~dwilkins/LaTeXPrimer/GSWLaTeX.pdf
 
* http://www.maths.tcd.ie/~dwilkins/LaTeXPrimer/GSWLaTeX.pdf

Revision as of 13:51, 21 February 2008

This article is part of the HOWTOs series.
Installation Usage PDF issues Imposition Other

This article is intended to be a compilation of operations pertaining to LaTeX frames. The incorporation of LaTeX is a work in progress, in other words, not completely implemented, and also is available only in the development versions of Scribus (1.3.5svn).

All Working with pages:

Working with text frames
Working with Story Editor
Working with image frames
Working with Master Pages
Working with Scribus: How to begin

Configuration

First you have to configure the path to your LaTeX executable. Go to File -> Preferences -> External Tools and set the paths for the LaTeX executable and your editor. The easiest way to do this is to click on "Rescan" and all required values are filled in automatically.

Manual configuration

Note: Manual configuration is only required if something goes wrong or you want to do something special. First try the autoconfiguration by clicking "Rescan"! If you want to manually configure an other LaTeX executable type in the path, but make sure that the following requirement is met:

  • The output must be in a format that Scribus can display in an image frame. (for example PNG, JPEG, PostScript, PDF) This means that you can't use plain LaTeX, because it produces DVI output.

You can use the following placeholder in your commandline:

  •  %dir Temporary directory ( = the directory of the input file)
  •  %dpi Current dpi setting
  •  %file The input file (if this placeholder is not used the last parameter will automatically be the filename)

Preamble

All LaTeX documents are automatically prefixed with an preamble which you also can configure in this dialog. Normally the predefined text should work, but you can input any valid LaTeX source. If you want one frame not to use the globaly defined preamble then you don't have to delete it, but you can disable it on a per frame basis. (see section "Specials" for details)

Placing LaTeX frames

Select the Latex-button.png item from the toolbar and then draw a frame where you want your formula to be placed. After some seconds a default latex file should be rendered. This contains some sample code to make the process of creating your own code more easy. Now you can right-click your frame and select "Edit Latex Source". Depending on your settings either the program you specified as the external editor or the internal one are started.

External editor

Just type your LaTeX code, but remember: The preamble and the end is added automatically during processing. So only add the parts between

\begin{document}
and
\end{docoument}
See the Section "Latex Documentation" for details about the LaTeX syntax.

Internal editor

TODO: Write this section when the new editor is in SVN.

Specials

There are some special codes to access Scribus values from your LaTeX document. They all look like this: $scribus_XXX$

The following variables are available:

  • $scribus_noprepost$ Disable the preamble (Note: This variable is not replaced by anything so it's a good idea to place it on a comment line!)
  • $scribus_width$ Frame width in pt
  • $scribus_height$ Frame height in pt
  • $scribus_realwidth$ Effective frame width after removing left border and applying scale in pt
  • $scribus_realheight$ Effective frame height after removing top border and applying scale in pt
  • $scribus_offsetX$ Left border in pt
  • $scribus_offsetY$ Top border in pt
  • $scribus_scaleX$ Scale factor in horizontal direction (e.g. 0.5 = 50%, 1.0 = 100%, 2.0 = 200%)
  • $scribus_scaleY$ Scale factor in vertical direction
  • $scribus_dpi$ The DPI setting for this frame. Only valid when the frame is processed as raster graphics (i.e. currently always)


LaTeX Documentation

(please add any useful links you have here)


(C) 2007 Hermann Kraus. This document is licensed under the Open Documentation License with the same elected options as in the Scribus documentation.