wiki2beamer

NAME

SYNOPSIS

DESCRIPTION

FILE

the text-file(s) to be processed

-h --help

show a short usage help

--version

show version information

USAGE

wiki2beamer footalk.txt > footalk.tex

If called without any input file, wiki2beamer reads input from STDIN. If called with multiple input files, wiki2beamer reads and processes them in order with their content beeing simply concatenated.

If an error occurs, wiki2beamer returns a return code other then 0.  

SYNTAX

OVERALL STRUCTURE

MANAGING INPUT

>>>includefile<<<

Include the file named includefile at this line. Works recursively. Endless recursion will be detected and treated as an error. Including files doesn't work inside [nowiki] and [code] environments (see below).

STRUCTURING THE PRESENTATION

== sectionname ==

opens a section called sectionname

== longsectionname ==[shortname]

opens a section called longsectionname, passing the parameter shortname to latex

=== subsectname ===

opens a subsection called subsectname

=== longsubsectname ===[shortname]

opens a subsection called longsubsectname, passing the parameter shortname to latex

==== frametitle ====

opens a frame with the title frametitle

==== frametitle ====[param]

opens a frame with the title frametitle, passes frame parameters like t, fragile, verbatim etc. to latex

!==== frametitle ====[param]

the ! added in front of a frame, selects a frame for exclusive generation. It makes wiki2beamer skip all frames that are not selected. You can select multiple frames. This can speed up the edit-compile-view cycle massively.

Sectioning commands work only at the beginnig of a line.  

LISTS (BULLETS/ENUMERATIONS)

* text

create a bullet (itemize) with text

*<onslide> text

create a bullet (itemize) with text that only appears on the specified slides (onslide)

# text

create a numbered item (enumerate) with text

#<onslide> text

create a numbered item (enumerate) with text that only appears on the specified slides (onslide)

Cascaded lists, mixed ordered and unorderd items:

        * This is a crazy list.
        *# It contains different items.
        *# In different formats.
        *** On different levels.
        ***<2-> which are animated
        *<3-> Quite a lot of fun.
        **<4-> Isn't it?
        

ENVIRONMENTS

Warning

No parsing is done. The user is responsible for closing any opened environment. Environment-tags are only recognized at the beginning of a line.

SPECIAL ENVIRONMENTS

AUTOTEMPLATE

<[autotemplate]

opens the autotemplate environment

[autotemplate]>

close the autotemplate environment

key=value (inside [autotemplate])

insert a template command \keyvalue

key=value pairs are converted to \keyvalue in the output (except special keys) -- everything after = is just appended to \key.

<[autotemplate]
usepackage=[utf8]{inputenc}
[autotemplate]>

will be converted to \usepackage[utf8]{inputenc}.

There is a built-in set of options:

<[autotemplate]
documentclass={beamer}
usepackage={listings}
usepackage={wasysym}
usepackage={graphicx}
date={\today}
lstdefinestyle={basic}{....}
titleframe=True
[autotemplate]>

titleframe is a special key that tells wiki2beamer to create a title frame. To set the title, subtitle and author of the presentation use the keys title, subtitle and author. Overriding of the default options works on

*

per-key level for: documentclass, titleframe

*

per-package level for: usepackage

*

no overriding for: everything else

CODE

<[code]

open a code environment

<[code][param]

open a code environment passing parameters to the latex lstlisting environment.

[code]>

close the code environment

                        <[code][key=value,...]
                        ...
                        [code]>
                        

<[code] opens the environment, [code]> closes it, everything after <[code] is passed to the LaTeX listings package as options for this listing. Inside the code environment, [ and ] must be escaped as \[ and \]. Things between [ and ] are animations. There are two kinds of animations:

*

[<slidespec>some code] - show "some code" only on specified slides

*

[[<slidespec>some code][<slidespec>some other code]] - show "some code" on the slides in the first spec, show "some other code" on the slides in the second spec, fill up space on slides without content with spaces

Slide-specs can be of the form:

*

n - one single frame n

*

n-m - sequence of frames n to m

*

spec,spec,... - combine multiple specs into on (e.g. <1-3,5>)

NOWIKI

FRAME

TEXT FORMATTING

'''text'''

typeset text bold

''text''

typeset text italic

@text@

typeset text in typewriter type, to ignore an @, escape it as \@

!text!

alert text, to ignore and !, escape it as \!

_ color _ text _

make text appear in color

COLUMNS

<[columns]

opens the column environment

[[[ width ]]]

creates a column of width, everything below goes into this column

[columns]>

closes the column environment

GRAPHICS

<<<pathtofile>>>

include image from pathtofile

<<<pathtofile,key=value>>>

include image from pathtofile passing key=value parameters to latex

FOOTNOTES

(((text)))

create a footnote containing text

LAYOUT

--length--

when found at start of line, with nothing afterwards, insert a \vspace{length} (vertical space of length length)

--*length--

same as above, but insert a \vspace* (a forced vspace)

+<overlay>{content}

\uncover the content on the given overlay subframes. They will allready take up the space, they need to be displayed, so the geometry of the frame doesn't change when the element pops up.

-<overlay>{content}

\only show the content on the given overlay subframes. They will not take up the space they need to be displayed, so the geometry of the frame changes when the element pops up.

SUBSTITUTIONS

-->

becomes $\rightarrow$

==>

becomes $\Rightarrow$

<--

becomes $\leftarrow$

<==

becomes $\Leftarrow$

:-)

becomes \smiley (requires package wasysym)

:-(

becomes \frownie (requires package wasysym)

FRAME HEADERS/FOOTERS

@FRAMEHEADER=text

set frameheader to text

@FRAMEFOOTER=text

set framefooter to text

Leave text empty to reset frame headers and footers.  

LICENSE

DOCUMENTATION LICENSE

CODE LICENSE

Index

NAME

SYNOPSIS

DESCRIPTION

USAGE

SYNTAX

OVERALL STRUCTURE

MANAGING INPUT

STRUCTURING THE PRESENTATION

LISTS (BULLETS/ENUMERATIONS)

ENVIRONMENTS

SPECIAL ENVIRONMENTS

AUTOTEMPLATE

CODE

NOWIKI

FRAME

TEXT FORMATTING

COLUMNS

GRAPHICS

FOOTNOTES

LAYOUT

SUBSTITUTIONS

FRAME HEADERS/FOOTERS

LICENSE

DOCUMENTATION LICENSE

CODE LICENSE