\papercolumns 1
\papersides 2
\paperpagestyle default
-\tracking_changes true
+\tracking_changes false
\output_changes false
\html_math_output 0
\html_css_as_file 0
\html_be_strict false
-\author 5863344 "ef"
\end_header
\begin_body
\series default
will be loaded automatically by \SpecialChar LyX
when you use self defined table formats.
- To avoid that it being loaded twice the command
+ To avoid that it is loaded twice the command
\series bold
\backslash
\family default
.
The \SpecialChar LaTeX
--package
-\change_inserted 5863344 1497177967
-s
-\change_unchanged
-
+-packages
\series bold
listings
\series default
\end_inset
-
-\change_inserted 5863344 1497177997
-or
+ or
\series bold
minted
\series default
status collapsed
\begin_layout Plain Layout
-
-\change_inserted 5863344 1497178009
\SpecialChar LaTeX
-packages ! minted
\end_layout
\end_inset
+ provide a powerful and flexible way to insert program source code into
+ your document.
+ One can only use one of these packages in a document.
-\change_unchanged
-provide
-\change_deleted 5863344 1497178016
-s
-\change_unchanged
- a powerful and flexible way to insert program source code into your document.
+\series bold
+listings
+\series default
+ is used by default.
+\end_layout
-\change_inserted 5863344 1497178383
- You can use either one in a document, but listings is used by default.
- In order to use minted, you need to check the box
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Standard
+\begin_inset Note Note
+status open
+
+\begin_layout Plain Layout
+
+\series bold
+Note:
+\series default
+ \SpecialChar LyX
+ does NOT want to encourage users to add the
+\family typewriter
+-shell-escape
+\family default
+ option to converter definitions.
+ It works, but it is a huge security risk.
+ There is an active discussion about how to handle this.
+ Once that's been resolved, this can be updated appropriately.
+\end_layout
+
+\begin_layout Plain Layout
+=====
+\end_layout
+
+\begin_layout Plain Layout
+In order to use
+\series bold
+minted
+\series default
+, you need to select it as the syntax highlighting package in the document
+ settings under
+\family sans
+Listings
+\family default
+.
+
+\series bold
+minted
+\series default
+ requires also additionally the module
+\family sans
+pygments
+\family default
+ of the software
+\noun on
+Python
+\noun default
+
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+Under \SpecialChar LyX
+ for Windows
+\family sans
+pygments
+\family default
+ is already installed.
+\end_layout
-Use minted
-\begin_inset Quotes erd
\end_inset
- in Document\SpecialChar menuseparator
-Settings\SpecialChar menuseparator
-Listings.
- However, note that minted requires additional software (the pygments python
- module) and the
+ and the option
\family typewriter
-shell-escape
\family default
- option for the latex backend, which allows arbitrary code execution.
-\change_unchanged
+ for the \SpecialChar LaTeX
+ processor.
+ If you want for example view or export your document as the format
+\family sans
+PDF
+\begin_inset space ~
+\end_inset
+
+(pdflatex)
+\family default
+, go to the \SpecialChar LyX
+ preferences and there to the section
+\family sans
+File
+\begin_inset space ~
+\end_inset
+
+Handling\SpecialChar menuseparator
+Converters
+\family default
+.
+ There go to the entry
+\family sans
+LaTeX
+\begin_inset space ~
+\end_inset
+
+(pdflatex) -> PDF
+\begin_inset space ~
+\end_inset
+
+(pdflatex)
+\family default
+ and look at the field
+\family sans
+Converter
+\family default
+.
+ There you see by default the content
+\begin_inset Newline newline
+\end_inset
+
+
+\series bold
+pdflatex $$i
+\series default
+
+\begin_inset Newline newline
+\end_inset
+
+Now change it to
+\begin_inset Newline newline
+\end_inset
+
+
+\series bold
+pdflatex $$i -shell-escape
+\begin_inset Newline newline
+\end_inset
+
+
+\series default
+and press the
+\family sans
+Modify
+\family default
+ button and subsequently
+\family sans
+Apply
+\family default
+ or
+\family sans
+Save
+\family default
+.
+ The same can be done for the output formats
+\family sans
+PDF
+\begin_inset space ~
+\end_inset
+
+(LuaTeX)
+\family default
+ and
+\family sans
+PDF
+\begin_inset space ~
+\end_inset
+
+(XeTeX)
+\family default
+.
+\end_layout
+
+\end_inset
+
\end_layout
\family default
option in this case as also non-float listings can have captions and be
referenced.
-\change_inserted 5863344 1497179331
-
-\end_layout
-
-\begin_layout Standard
-
-\change_inserted 5863344 1497179333
-\begin_inset listings
-lstparams "language=Python"
-inline false
-status open
-
-\begin_layout Plain Layout
-
-\change_inserted 5863344 1497179333
-
-\begin_inset Caption Standard
-
-\begin_layout Plain Layout
-
-\change_inserted 5863344 1497179333
-\begin_inset CommandInset label
-LatexCommand label
-name "lst:Example-Listing"
-
-\end_inset
-
-Example Listing float
-\end_layout
-
-\end_inset
-
-# Example listing float
-\end_layout
-
-\begin_layout Plain Layout
-
-\change_inserted 5863344 1497179333
-
-def func(param):
-\end_layout
-
-\begin_layout Plain Layout
-
-\change_inserted 5863344 1497179333
-
- 'this is a python function'
-\end_layout
-
-\begin_layout Plain Layout
-
-\change_inserted 5863344 1497179333
-
- pass
-\end_layout
-
-\end_inset
-
-
-\change_unchanged
-
\end_layout
\begin_layout Standard
-You can add captions to listings with the menu
+You can add captions to listings that are not inline with the menu
\family sans
Insert\SpecialChar menuseparator
Caption
\family default
.
The list entries are the listing caption and the listing number.
-\change_inserted 5863344 1497179524
-
\end_layout
\begin_layout Standard
-
-\change_inserted 5863344 1497179494
-\begin_inset Note Greyedout
+\begin_inset listings
+lstparams "language=Python"
+inline false
status open
\begin_layout Plain Layout
-\change_inserted 5863344 1497179551
+\begin_inset Caption Standard
-\series bold
-Note:
-\series default
-The listings package places captions before the listing by default, while
- the minted package places them after the listing by default if it is floating.
- If the listing is not floating and minted is used, the place of the caption
- is determined by the position it is inserted in the inset.
- If it is inserted in the first line of the inset, the caption will be typeset
- before the listing, otherwise it will be typeset after the listing.
- If you use minted and would like to have captions before the listing even
- when it is a float, you have to add the following lines to the preamble:
+\begin_layout Plain Layout
+\begin_inset CommandInset label
+LatexCommand label
+name "lst:Example-Listing"
+
+\end_inset
+
+Example Listing float
\end_layout
-\begin_layout LyX-Code
+\end_inset
-\change_inserted 5863344 1497179494
+# Example listing float
+\end_layout
-\backslash
-usepackage{float}
+\begin_layout Plain Layout
+
+def func(param):
\end_layout
-\begin_layout LyX-Code
+\begin_layout Plain Layout
-\change_inserted 5863344 1497179494
+ 'this is a python function'
+\end_layout
-\backslash
-floatstyle{plaintop}
-\change_unchanged
+\begin_layout Plain Layout
+ pass
\end_layout
\end_inset
-\change_unchanged
-
\end_layout
\begin_layout Standard
-
-\change_deleted 5863344 1497179361
-\begin_inset listings
-lstparams "language=Python"
-inline false
+\begin_inset Note Greyedout
status open
\begin_layout Plain Layout
-\begin_inset Caption Standard
+\series bold
+Note:
+\series default
+The
+\series bold
+listings
+\series default
+ package places captions before the listing by default.
+\begin_inset Newline newline
+\end_inset
+
+The
+\series bold
+minted
+\series default
+ package places them after the listing by default if it is floating.
+ If tit is not floating caption will be typeset before the listing if it
+ is inserted to its first line, otherwise it will be typeset after the listing.
+ If you want to force the placement in avery case before the listing, you
+ have to add the following lines as last thing to the preamble:
+\begin_inset Newline newline
+\end_inset
+
+
+\series bold
+
+\backslash
+@ifundefined{newfloat}
+\begin_inset Newline newline
+\end_inset
+
+
+\begin_inset Phantom HPhantom
+status open
\begin_layout Plain Layout
-\begin_inset CommandInset label
-LatexCommand label
-name "lis:Example-Listing-old"
+\series bold
+\begin_inset space ~
\end_inset
-Example Listing float
+
\end_layout
\end_inset
-# Example listing float
-\end_layout
+{
+\backslash
+usepackage{float}}{}
+\begin_inset Newline newline
+\end_inset
-\begin_layout Plain Layout
-def func(param):
-\end_layout
+\backslash
+floatstyle{plaintop}
+\series default
+
+\begin_inset Note Note
+status collapsed
\begin_layout Plain Layout
+The package
+\series bold
+float
+\series default
+ will be loaded automatically by \SpecialChar LyX
+ when you use special document-wide float
+ placement settings.
+ To avoid that it is loaded twice the command
+\series bold
- 'this is a python function'
+\backslash
+@ifundefined
+\series default
+ is used in the above command.
\end_layout
-\begin_layout Plain Layout
+\end_inset
+
- pass
\end_layout
\end_inset
-\change_unchanged
-
\end_layout
\begin_layout Standard
\family sans
Extended character table
\family default
-
-\change_inserted 5863344 1497179749
-is only meaningful for the listings package and
-\change_unchanged
-should be used when you use national characters like the German umlauts
- in the listing.
-
-\change_inserted 5863344 1497179779
- It is not needed with minted.
-\change_unchanged
-
+ is only meaningful for the
+\series bold
+listings
+\series default
+ package and should be used when you use national characters like the German
+ umlauts in the listing.
\begin_inset Newline newline
\end_inset
\series bold
listings
\series default
-
-\change_inserted 5863344 1497179948
-and
+ and
\series bold
minted
\series default
-
-\change_unchanged
-package
-\change_inserted 5863344 1497179951
-s
-\change_unchanged
-, we refer to
-\change_deleted 5863344 1497179970
-its
-\change_inserted 5863344 1497179971
-their
-\change_unchanged
- documentation
+ packages, we refer to their documentation
\begin_inset CommandInset citation
LatexCommand cite
key "listings,minted"
\end_inset
-\change_inserted 5863344 1497180016
-
\end_layout
\begin_layout Bibliography
-
-\change_inserted 5863344 1497180069
\begin_inset CommandInset bibitem
LatexCommand bibitem
key "minted"
status collapsed
\begin_layout Plain Layout
-
-\change_inserted 5863344 1497180164
\SpecialChar LaTeX
-packages ! minted
\end_layout
\end_inset
-\change_unchanged
-
\end_layout
\begin_layout Bibliography
projects / lyx.git / blobdiff