LyX wiki | Examples / IncludeExternalProgramListing

Categories: Example

<< | Page list | >>

How to include an external program listing into LyX.

Table of contents (hide)

1. Include programlistings
2. Use in figures
3. Issues
4. Contributors
5. Categories

1. Include programlistings

This automatically uses the source code, and any change in the external source code will be visible in the LyX output. The latest version is available at http://www.taljaren.se/MinLyXTutorial.pdf

Notice that you can skip the -S cpp parameter and then the highlight program will automatically select the appropriate language.

Install the program highlight that is available on http://www.andre-simon.de/
Run the program highlight on one of your sourcecode ﬁles with the command:
highlight -L -t 4 -I -S cpp -r -q KOD.cpp

Change the ﬁle name (KOD.cpp) to your ﬁle, and change language if you use something else than C++ (cpp).

Things are written in a window, copy and paste everything from the row
\usepackage{color}
to
\definecolor{bgcolor}{rgb}{1,1,1}

(but do not include this last line!) to the LaTeX Preamble window in document settings. Click the Save as Document Defaults button.

In the Preferences window you should add a new FileFormat
```
Format:cpp
GUIname:C++
Extension:cpp
Editor:nedit
```

nedit is the texteditor that I use to write program code. Change to what you want to use. Notice that the Format name must be something unique that is not used elsewhere.

In the Converters windows you should add

From: C++
To: LaTeX(pdflatex)
Converter: highlight -A -L -t 4 -I -S cpp -f -r -q $$i -o $$o

Add the same thing for conversion from C++ to LATEX(plain). Dont forget to change to reﬂect the language you are using. IMPORTANT! If you get errors with undefined command sequences and see the command \dq, then try removing the -r switch! Also make sure that you don't use any "extra parameters".

Open the file external_templates that is in the LY X directory (either the global one, or copy the ﬁle to your own personal directory and edit that one). To the ﬁle you should add the following:

Template CppCode         
GuiName "[C++ $$Basename]"         
HelpText                 
   Add C++ code
HelpTextEnd         
InputFormat cpp         
FileFilter "*.{cpp,h,hpp,c}"         
AutomaticProduction true         
Format LaTeX                 
Product "{\\small \\input{$$FPath$$Basename.tex} }"
   UpdateFormat latex                 
   UpdateResult "$$FName.tex"         
FormatEnd         
Format PDFLaTeX                 
   Product "{\\small \\input{$$FPath$$Basename.tex} }"
   UpdateFormat latex                 
   UpdateResult "$$FPath$$Basename.tex"         
FormatEnd 
TemplateEnd

Now you can use Insert , File, External Material and add your program code.

2. Use in figures

You will likely want to use your code in figures as well. The process for this is fairly simple:

Insert a new figure with a caption
Optionally, insert a box
Insert->File->External Material and insert your code file
You will likely want to change the parameters for the highlight program to include:
-J 67 -W
The -J parameter sets the number of characters per line. The -W parameter enables word wrapping.

3. Issues

There is an extra blank line between the end of a code listing and the caption. It seems that highlight ends its output with a line break. If anyone has a way around this, please put it here.

4. Contributors

5. Categories

Example