summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/gridslides/README.md
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
committerNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
commite0c6872cf40896c7be36b11dcc744620f10adf1d (patch)
tree60335e10d2f4354b0674ec22d7b53f0f8abee672 /macros/latex/contrib/gridslides/README.md
Initial commit
Diffstat (limited to 'macros/latex/contrib/gridslides/README.md')
-rw-r--r--macros/latex/contrib/gridslides/README.md85
1 files changed, 85 insertions, 0 deletions
diff --git a/macros/latex/contrib/gridslides/README.md b/macros/latex/contrib/gridslides/README.md
new file mode 100644
index 0000000000..5b286c44e2
--- /dev/null
+++ b/macros/latex/contrib/gridslides/README.md
@@ -0,0 +1,85 @@
+# gridslides: LaTeX package to create free form slides with blocks placed on a grid
+
+This package allows to create free form slides with blocks placed on a grid.
+The blocks can be filled with text, equations, figures etc.
+This allows more flexible slides similar compared to LaTeX beamer.
+Sequential unconvering of elements is supported.
+A compiler script is provided which compiles each slide separately, avoiding long compile times this way.
+
+## Example
+
+See the file `example.tex` and `example.pdf`. Each slide is compiled separately using `compile.pl example.tex`.
+
+## Supported commands
+
+This package provides only a handful of commands, which
+allow to create slides and with blocks at fixed positions.
+
+### Slides/Pages
+
+```latex
+\begin{slide}{Slide title}
+ Slide content
+\end{slide}
+
+\begin{rawslide}
+ Raw slide without title and style
+\end{rawslide}
+
+\begin{style}
+ Define style which underlies all slides.
+ Best used together with \bg{filename}!
+\end{style}
+
+\begin{style}
+ \bg{figure-filename}
+\end{style}
+```
+
+### Slide content blocks
+
+The slide is divided in a 32x24 grid.
+
+```latex
+\bg{figure-filename}
+\txt(x,y){Text content}
+\block(x,y,w){Arbitrary content}
+\fig(x,y,w){figure-filename}
+\eq(x,y){a^2 + b^2 = c^2}
+```
+
+### Sequential uncovering
+
+Each slide can be split in multiple steps by defining blocks with `<n-m>` annotations.
+
+```latex
+\txt<1->(x,y){On slide step 1 to n}
+\block<2>(x,y,w){Only on step 2}
+\only<2-3>{
+ \block(x,y){Block content}
+}
+```
+
+### Metadata
+
+```latex
+\author{Author} defines \theauthor
+\title{Presentation Title} defines \thetitle
+\date{Date} defines \thedate
+\institute{Institute} defines \theinstitute
+\theheadline defined by slide title
+\theslide defined by slide number
+```
+
+## Alternatives
+
+* beamer
+* ffslides
+* prosper
+* pure tikz or pstricks
+
+## License
+
+Copyright (c) 2017 Daniel Mendler. The package is dual-licensed
+under the GNU General Public License, version 2 and
+the LaTeX Project Public License 1.3 at your option.