-#LyX 2.1 created this file. For more info see http://www.lyx.org/
-\lyxformat 474
+#LyX 2.3 created this file. For more info see http://www.lyx.org/
+\lyxformat 544
\begin_document
\begin_header
+\save_transient_properties true
+\origin /systemlyxdir/examples/
\textclass article
\begin_preamble
%
\language_package default
\inputencoding default
\fontencoding global
-\font_roman default
-\font_sans default
-\font_typewriter default
-\font_math auto
+\font_roman "default" "default"
+\font_sans "default" "default"
+\font_typewriter "default" "default"
+\font_math "auto" "auto"
\font_default_family default
\use_non_tex_fonts false
\font_sc false
\font_osf false
-\font_sf_scale 100
-\font_tt_scale 100
+\font_sf_scale 100 100
+\font_tt_scale 100 100
+\use_microtype false
+\use_dash_ligatures false
\graphics default
\default_output_format default
\output_sync 0
\use_hyperref false
\papersize default
\use_geometry false
-\use_package amsmath 0
-\use_package amssymb 0
-\use_package cancel 0
-\use_package esint 0
+\use_package amsmath 1
+\use_package amssymb 1
+\use_package cancel 1
+\use_package esint 1
\use_package mathdots 1
-\use_package mathtools 0
+\use_package mathtools 1
\use_package mhchem 1
-\use_package stackrel 0
-\use_package stmaryrd 0
-\use_package undertilde 0
+\use_package stackrel 1
+\use_package stmaryrd 1
+\use_package undertilde 1
\cite_engine basic
\cite_engine_type default
\biblio_style plain
\suppress_date false
\justification true
\use_refstyle 0
+\use_minted 0
\index Index
\shortcut idx
\color #008000
\tocdepth 3
\paragraph_separation indent
\paragraph_indentation default
-\quotes_language english
+\is_math_indent 0
+\math_numbering_side default
+\quotes_style english
+\dynamic_quotes 0
\papercolumns 1
\papersides 1
\paperpagestyle default
\begin_layout Abstract
This document describes and implements a perl script for importing noweb
- files into LyX
+ files into \SpecialChar LyX
+
\end_layout
\begin_layout Standard
\end_layout
\begin_layout Standard
-Since version 1.0.1, LyX now supports Literate Programming using
+Since version 1.0.1, \SpecialChar LyX
+ now supports Literate Programming using
\noun on
noweb
\noun default
.
- This addition to LyX made it very pleasant to write programs in the literate
+ This addition to \SpecialChar LyX
+ made it very pleasant to write programs in the literate
style (like this one).
In addition to being able to write new literate programs, it would be quite
useful if old
\noun on
noweb
\noun default
- code could be imported into LyX in some fashion.
+ code could be imported into \SpecialChar LyX
+ in some fashion.
That's where this program comes in.
\end_layout
\noun on
noweb
\noun default
- file to LyX.
+ file to \SpecialChar LyX
+.
\end_layout
\begin_layout Standard
status open
\begin_layout Plain Layout
+
noweb2lyx.in
\end_layout
\end_layout
\begin_layout Standard
-When first tackling this problem, I spoke with members of the LyX team that
- knew about the literate programming extensions and reLyX (the LaTeX importing
- code).
+When first tackling this problem, I spoke with members of the \SpecialChar LyX
+ team that
+ knew about the literate programming extensions and re\SpecialChar LyX
+ (the \SpecialChar LaTeX
+ importing code).
\end_layout
\begin_layout Standard
-One of the first ideas was to extend the reLyX code to understand the
+One of the first ideas was to extend the re\SpecialChar LyX
+ code to understand the
\noun on
noweb
\noun default
\end_inset
.
- On the other hand, it turns out that reLyX contains a very useful literal
+ On the other hand, it turns out that re\SpecialChar LyX
+ contains a very useful literal
quoting mechanism.
If the input file contains the construct
\end_layout
\begin_layout LyX-Code
\backslash
-begin{reLyXskip}
+begin{re\SpecialChar LyX
+skip}
\begin_inset Newline newline
\end_inset
{...
- LaTeX stuff ...}
+ \SpecialChar LaTeX
+ stuff ...}
\begin_inset Newline newline
\end_inset
\backslash
-end{reLyXskip}
+end{re\SpecialChar LyX
+skip}
\end_layout
\begin_layout Standard
-then reLyX will copy the surrounded code to the output file verbatim.
+then re\SpecialChar LyX
+ will copy the surrounded code to the output file verbatim.
Given this, the first part of the translation is easy; we simply have to
copy the code chunks into an intermediate file that surrounds them with
\family typewriter
\backslash
-begin{reLyXskip}
+begin{re\SpecialChar LyX
+skip}
\family default
and
\family typewriter
\backslash
-end{reLyXskip}
+end{re\SpecialChar LyX
+skip}
\family default
.
\end_layout
\begin_layout Standard
-Once reLyX is done with the input file, the problem is reduced to changing
- the code chunks from LyX's LaTeX layout to the Chunk layout.
+Once re\SpecialChar LyX
+ is done with the input file, the problem is reduced to changing
+ the code chunks from \SpecialChar LyX
+'s \SpecialChar LaTeX
+ layout to the Chunk layout.
\end_layout
\begin_layout Standard
\noun default
.
We want to be able to run it as a simple pre-processor and post-processor
- from within reLyX.
+ from within re\SpecialChar LyX
+.
We can accomplish this by setting the flags
\family roman
\series medium
status open
\begin_layout Plain Layout
-Convert noweb to LyX
+
+Convert noweb to \SpecialChar LyX
+
\end_layout
\end_inset
\end_layout
\begin_layout Section
-Making a file that reLyX can process
+Making a file that re\SpecialChar LyX
+ can process
\end_layout
\begin_layout Standard
In this section, we present the code that performs the task of creating
- the intermediate file that reLyX can process, using the algorithm that
- we just outlined.
+ the intermediate file that re\SpecialChar LyX
+ can process, using the algorithm that we
+ just outlined.
This algorithm is outlined in the code that follows:
\end_layout
\begin_layout Standard
In the code above, we do some pre-processing of the noweb ``[[...]]'' construct.
- This avoids some problems with reLyX confusing lists composed of ``[[...]]''
+ This avoids some problems with re\SpecialChar LyX
+ confusing lists composed of ``[[...]]''
constructs.
\end_layout
\noun on
noweb
\noun default
- code chunk, we transform it into a form that is usable by reLyX.
+ code chunk, we transform it into a form that is usable by re\SpecialChar LyX
+.
\end_layout
\begin_layout Standard
status open
\begin_layout Plain Layout
+
Read in and output the noweb code chunk
\end_layout
\color inherit
to read and write files.
In the code fragment above, we need to read from the input file and write
- to a file that will be later transformed by reLyX.
+ to a file that will be later transformed by re\SpecialChar LyX
+.
If we are being called only to pre-process the input file, then there is
no need to create a temporary file.
\end_layout
status open
\begin_layout Plain Layout
+
Setup INPUT and OUTPUT
\end_layout
status open
\begin_layout Plain Layout
+
Save the beginning of the chunk to savedchunk
\end_layout
status open
\begin_layout Plain Layout
-print out the chunk in a reLyXskip block
+
+print out the chunk in a re\SpecialChar LyX
+skip block
\end_layout
\end_inset
status open
\begin_layout Plain Layout
+
Close INPUT and OUTPUT
\end_layout
\end_layout
\begin_layout Section
-Running reLyX
+Running re\SpecialChar LyX
+
\end_layout
\begin_layout Standard
-In this section, we describe and implement the code that runs reLyX on the
+In this section, we describe and implement the code that runs re\SpecialChar LyX
+ on the
intermediate file
\family roman
\series medium
\end_layout
\begin_layout Standard
-In order to run reLyX, we need to know the article class of the input document
+In order to run re\SpecialChar LyX
+, we need to know the article class of the input document
(to choose the corresponding literate document layout).
For this, we need to parse the intermediate file.
\end_layout
status open
\begin_layout Plain Layout
-Run reLyX on intermediate file
+
+Run re\SpecialChar LyX
+ on intermediate file
\end_layout
\end_inset
\emph on
noweb2lyx.nw
\emph default
- file that is generated by LyX
+ file that is generated by \SpecialChar LyX
+
\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-reLyX searches for
+re\SpecialChar LyX
+ searches for
\backslash
\backslash
\noun on
noweb2lyx
\noun default
- on itself and a produce a quite reasonable LyX file.
+ on itself and a produce a quite reasonable \SpecialChar LyX
+ file.
\end_layout
\begin_layout Standard
status open
\begin_layout Plain Layout
+
Parse for document class
\end_layout
\end_layout
\begin_layout Subsection
-Running reLyX with the corresponding literate document layout
+Running re\SpecialChar LyX
+ with the corresponding literate document layout
\end_layout
\begin_layout Standard
\end_layout
\begin_layout Standard
-reLyX performs the main bulk of the translation work.
+re\SpecialChar LyX
+ performs the main bulk of the translation work.
Note that if the ``literate-
\emph on
class
\emph default
-'' document layout is not found, then reLyX will fail with an error.
+'' document layout is not found, then re\SpecialChar LyX
+ will fail with an error.
In that case, you may need to modify your
\noun on
noweb
\end_layout
\begin_layout Section
-Fixing the reLyX output
+Fixing the re\SpecialChar LyX
+ output
\end_layout
\begin_layout Standard
-We need to perform some post-processing of what reLyX produces in order
- to have the best output for our literate document.
+We need to perform some post-processing of what re\SpecialChar LyX
+ produces in order to
+ have the best output for our literate document.
The outline of the post-processing steps are:
\end_layout
status open
\begin_layout Plain Layout
-Fix up LyX file
+
+Fix up \SpecialChar LyX
+ file
\end_layout
\end_inset
\color inherit
is sufficient to restart the loop.
We can use this construct to do some relatively complex parsing of the
- reLyX generated file.
+ re\SpecialChar LyX
+ generated file.
\end_layout
\begin_layout Subsection
status open
\begin_layout Plain Layout
+
Setup INPUT and OUTPUT for the final output
\end_layout
\begin_layout Standard
Now, as we outlined before, the final step is transforming the code-chunks
- which have been put into a LaTeX layout by LyX into the Chunk layout.
+ which have been put into a \SpecialChar LaTeX
+ layout by \SpecialChar LyX
+ into the Chunk layout.
\end_layout
\begin_layout Standard
status open
\begin_layout Plain Layout
+
Fix code chunks in latex layout
\end_layout
status open
\begin_layout Plain Layout
+
Slurp up to the end of the latex layout
\end_layout
\noun on
noweb
\noun default
- syntax means putting the ``[[quoted-code]]'' in a LaTeX layout in the LyX
+ syntax means putting the ``[[quoted-code]]'' in a \SpecialChar LaTeX
+ layout in the \SpecialChar LyX
file.
- Otherwise, LyX will backslash-quote the brackets, creating ugly output.
+ Otherwise, \SpecialChar LyX
+ will backslash-quote the brackets, creating ugly output.
The quoted-code is transformed by
\noun on
noweb
\noun default
- when it generates the final LaTeX code.
+ when it generates the final \SpecialChar LaTeX
+ code.
\end_layout
\begin_layout Standard
status open
\begin_layout Plain Layout
+
Fix [[var]] noweb construct
\end_layout
status open
\begin_layout Plain Layout
+
Clean up
\end_layout
noweb2lyx
\noun default
script understands two arguments, input-file and output-file.
- It is also set up to be used internally by reLyX to pre-process or postprocess
+ It is also set up to be used internally by re\SpecialChar LyX
+ to pre-process or postprocess
files in the import pipeline.
\end_layout
\end_layout
\begin_layout Standard
-The noweb2lyx script can be tangled from LyX if you set
+The noweb2lyx script can be tangled from \SpecialChar LyX
+ if you set
\family typewriter
\backslash
status open
\begin_layout Plain Layout
+
build-script
\end_layout
projects / lyx.git / blobdiff