1WIKI2BEAMER(1)                    WIKI2BEAMER                   WIKI2BEAMER(1)
2
3
4

NAME

6       wiki2beamer - convert wiki-formatted text to latex-beamer code
7

SYNOPSIS

9       wiki2beamer [OPTION...] [FILE...]
10

DESCRIPTION

12       FILE
13           the text-file(s) to be processed
14
15       -h, --help
16           show a short usage help
17
18       --version
19           show version information
20
21       -o,--output  FILE
22           write output to FILE instead of stdout
23

USAGE

25       Usually you want to pipe the output of wiki2beamer into a file:
26
27       wiki2beamer footalk.txt > footalk.tex
28
29       If called with multiple input files, wiki2beamer processes them in
30       order with their content being simply concatenated. If called without
31       any input file, wiki2beamer will attempt to read input from STDIN. If
32       no input files are supplied and nothing is available on STDIN,
33       wiki2beamer prints its usage message and exits.
34
35       If an error occurs, wiki2beamer returns a return code other then 0.
36

SYNTAX

38       Wiki2beamer has it’s own wiki-syntax which (evolved without much of a
39       concept ;) and) is described below. Everything that is unknown to
40       wiki2beamer will be passed through to the LaTeX output (unless inside
41       special environments).
42
43   Overall Structure
44       A wiki2beamer txt file can consist of two sections: the head and the
45       body. The head is optional and is an autotemplate environment. The body
46       contains the content of the document. If the head (autotemplate) is not
47       given, then only the code for the body will be generated and can be
48       included into a manually crafted LaTeX template file.
49
50   Managing Input
51       You can split input to wiki2beamer into multiple files. This helps to
52       keep things apart and avoids conflicts. There are two ways to split
53       input. The first is to use multiple input files which wiki2beamer will
54       read and process in order as if they were one concatenated file. The
55       second is to use the >>>include<<< syntax.
56
57       >>>includefile<<<
58           Include the file named includefile at this line. Works recursively.
59           Endless recursion will be detected and treated as an error.
60           Including files doesn’t work inside [nowiki] and [code]
61           environments (see below).
62
63   Structuring the Presentation
64       == sectionname ==
65           opens a section called sectionname
66
67       == longsectionname ==[shortname]
68           opens a section called longsectionname, passing the parameter
69           shortname to latex
70
71       === subsectname ===
72           opens a subsection called subsectname
73
74       === longsubsectname ===[shortname]
75           opens a subsection called longsubsectname, passing the parameter
76           shortname to latex
77
78       ==== frametitle ====_
79           opens a frame with the title frametitle
80
81       ==== frametitle ====[param]
82           opens a frame with the title frametitle, passes frame parameters
83           like t, fragile, verbatim etc. to latex
84
85       !==== frametitle ====[param]
86           the ! added in front of a frame, selects a frame for exclusive
87           generation. It makes wiki2beamer skip all frames that are not
88           selected. You can select multiple frames. This can speed up the
89           edit-compile-view cycle massively.
90
91       Sectioning commands work only at the beginning of a line.
92
93   Lists (Bullets/Enumerations)
94       * text
95           create a bullet (itemize) with text
96
97       *<onslide> text
98           create a bullet (itemize) with text that only appears on the
99           specified slides (onslide)
100
101       # text
102           create a numbered item (enumerate) with text
103
104       #<onslide> text
105           create a numbered item (enumerate) with text that only appears on
106           the specified slides (onslide)
107
108       Cascaded lists, mixed ordered and unordered items:
109
110            * This is a crazy list.
111            *# It contains different items.
112            *# In different formats.
113            *** On different levels.
114            ***<2-> which are animated
115            *<3-> Quite a lot of fun.
116            **<4-> Isn't it?
117
118   Environments
119       LaTeX knows many environments, some of which are as simple as
120       \begin{center} \end{center}, others are more complicated. To use these
121       in a more wiki-like fashion, use <[name] to open and [name]> to close
122       environments. It will be simply converted to \begin{name} and
123       end{name}.
124
125       Warning
126
127       No parsing is done. The user is responsible for closing any opened
128       environment. Environment-tags are only recognized at the beginning of a
129       line.
130
131   Special Environments
132       Unlike standard environments, some environment names are recognized by
133       wiki2beamer. These are: nowiki, code, autotemplate and frame. If
134       wiki2beamer detects one of these it will do some advanced parsing,
135       which can even fail with a syntax error.
136
137   Autotemplate
138       Autotemplate can be used at the beginning of a beamer .txt file. It
139       will create the required LaTeX headers to compile the content.
140
141       <[autotemplate]
142           opens the autotemplate environment
143
144       [autotemplate]>
145           close the autotemplate environment
146
147       key=value (inside [autotemplate])_
148           insert a template command \keyvalue
149
150       key=value pairs are converted to \keyvalue in the output (except
151       special keys) — everything after = is just appended to \key.
152
153           <[autotemplate]
154           usepackage=[utf8]{inputenc}
155           [autotemplate]>
156
157       will be converted to \usepackage[utf8]{inputenc}.
158
159       There is a built-in set of options:
160
161           <[autotemplate]
162           documentclass={beamer}
163           usepackage={listings}
164           usepackage={wasysym}
165           usepackage={graphicx}
166           date={\today}
167           lstdefinestyle={basic}{....}
168           titleframe=True
169           [autotemplate]>
170
171       titleframe is a special key that tells wiki2beamer to create a title
172       frame. To set the title, subtitle and author of the presentation use
173       the keys title, subtitle and author. Overriding of the default options
174       works on:
175
176       •   per-key level for: documentclass, titleframe
177
178       •   per-package level for: usepackage
179
180       •   no overriding for: everything else
181
182   Code
183       Use code-environments to display animated code listings.
184
185       <[code]
186           open a code environment
187
188       <[code][param]
189           open a code environment passing parameters to the latex lstlisting
190           environment.
191
192       [code]>
193           close the code environment
194
195               <[code][key=value,...]
196               ...
197               [code]>
198
199       <[code] opens the environment, [code]> closes it, everything after
200       <[code] is passed to the LaTeX listings package as options for this
201       listing. Inside the code environment, [ and ] must be escaped as \[ and
202       \]. Things between [ and ] are animations. There are two kinds of
203       animations:
204
205       •   [<slidespec>some code] - show "some code" only on specified slides
206
207       •   [[<slidespec>some code][<slidespec>some other code]] - show "some
208           code" on the slides in the first spec, show "some other code" on
209           the slides in the second spec, fill up space on slides without
210           content with spaces
211
212       Slide-specs can be of the form:
213
214       •   n - one single frame n
215
216       •   n-m - sequence of frames n to m
217
218       •   spec,spec,... - combine multiple specs into on (e.g. <1-3,5>)
219
220   Nowiki
221       Nowiki-Environments completely escape from wiki2beamer replacements.
222       <[nowiki] opens the environment, [nowiki]> closes it.
223
224   Frame
225       The LaTeX-frame environment is where the content of a slide goes. You
226       can manually close a frame-environment which was opened with ====
227       Frametitle ==== with [frame]>. Wiki2beamer is then aware that the last
228       frame is already closed and doesn’t try to close it again.
229
230   Text Formatting
231       '''text'''
232           typeset text bold
233
234       ''text''
235           typeset text italic
236
237       @text@
238           typeset text in typewriter type, to ignore an @, escape it as \@
239
240       !text!
241           alert text, to ignore an !, escape it as \!
242
243       _ color _ text _
244           make text appear in color
245
246   Columns
247       <[columns]
248           opens the column environment
249
250       [[[ width ]]]
251           creates a column of width, everything below goes into this column
252
253       [columns]>
254           closes the column environment
255
256   Graphics
257       <<<pathtofile>>>
258           include image from pathtofile
259
260       <<<pathtofile,_key=value_>>>
261           include image from pathtofile passing key=value parameters to latex
262
263   Footnotes
264           create a footnote containing text
265
266   Layout
267       --length--
268           when found at start of line, with nothing afterwards, insert a
269           \vspace{length} (vertical space of length length)
270
271       --*length--
272           same as above, but insert a \vspace* (a forced vspace)
273
274       +<_overlay_>{content}
275           \uncover the content on the given overlay subframes. They will
276           already take up the space, they need to be displayed, so the
277           geometry of the frame doesn’t change when the element pops up.
278
279       -<_overlay_>{content}
280           \only show the content on the given overlay subframes. They will
281           not take up the space they need to be displayed, so the geometry of
282           the frame changes when the element pops up.
283
284   Substitutions
285       -->
286           becomes $\rightarrow$
287
288       ==>
289           becomes $\Rightarrow$
290
291       <--
292           becomes $\leftarrow$
293
294       <==
295           becomes $\Leftarrow$
296
297       :-)
298           becomes \smiley (requires package wasysym)
299
300       :-(
301           becomes \frownie (requires package wasysym)
302
303   Frame Headers/Footers
304       There are two variables, FRAMEHEADER and FRAMEFOOTER. The content of
305       these will be inserted at the beginning/end of all following slides.
306
307       @FRAMEHEADER=text
308           set frameheader to text
309
310       @FRAMEFOOTER=text
311           set framefooter to text
312
313       Leave text empty to reset frame headers and footers.
314

LICENSE

316       Copyright © 2009 Kai Dietrich, Michael Rentzsch and others.
317
318   Documentation License
319       Permission is granted to copy, distribute and/or modify this document
320       under the terms of the GNU Free Documentation License, Version 1.3 or
321       any later version published by the Free Software Foundation;
322
323   Code License
324       wiki2beamer is free software: you can redistribute it and/or modify it
325       under the terms of the GNU General Public License as published by the
326       Free Software Foundation, either version 2 of the License, or (at your
327       option) any later version.
328

AUTHOR

330       wiki2beamer developers
331
332
333
334WIKI2BEAMER                       2023-01-21                    WIKI2BEAMER(1)
Impressum